Skip to content

PluginContext

Defined in: core.ts:68

The main plugin context object passed to activate(context).

Provides access to all 43 API namespaces plus read-only metadata about the plugin and host environment. Mirrors the host’s PluginContextExport (Swift JSExport — ground truth).

readonly pluginId: string

Defined in: core.ts:70

Unique plugin identifier (e.g., “com.example.my-plugin”).


readonly pluginVersion: string

Defined in: core.ts:72

Semantic version of this plugin (from plugin.json).


readonly hostVersion: string

Defined in: core.ts:74

Semantic version of the host application.


readonly lifecycle: LifecycleAPI

Defined in: core.ts:77

Lifecycle hooks (dependency notifications).


readonly commands: CommandsAPI

Defined in: core.ts:79

Command registration and execution.


readonly fileOps: FileOpsAPI

Defined in: core.ts:81

File system operations.


readonly ui: UIAPI

Defined in: core.ts:83

UI contribution methods.


readonly storage: StorageAPI

Defined in: core.ts:85

Scoped key-value storage.


readonly settings: SettingsAPI

Defined in: core.ts:87

Plugin settings from manifest.


readonly extensionPoints: ExtensionPointsAPI

Defined in: core.ts:89

Extension point declaration and contribution.


readonly dataContracts: DataContractsAPI

Defined in: core.ts:91

Data contract exposure and querying.


readonly interPluginEvents: InterPluginEventsAPI

Defined in: core.ts:93

Inter-plugin event channels.


readonly smartFolders: SmartFoldersAPI

Defined in: core.ts:95

Smart folder filter type registration and evaluation.


readonly preview: PreviewAPI

Defined in: core.ts:97

File preview registry queries and programmatic preview triggering.


readonly events: EventsAPI

Defined in: core.ts:99

Host event subscriptions.


readonly network: NetworkAPI

Defined in: core.ts:101

Network fetch and download. Requires network.outbound or network.unrestricted.


readonly shell: ShellAPI

Defined in: core.ts:103

Shell command execution. Requires shell.execute.


readonly clipboard: ClipboardAPI

Defined in: core.ts:105

System clipboard read/write. Requires clipboard.read / clipboard.write.


readonly shortcuts: ShortcutsAPI

Defined in: core.ts:107

Keyboard shortcut registration. Requires ui.shortcuts.


readonly themes: ThemesAPI

Defined in: core.ts:109

Theme registration and activation. Requires ui.themes for mutations.


readonly workspaces: WorkspacesAPI

Defined in: core.ts:111

Workspace template management (fn-40). Requires workspaces.


readonly cache: CacheAPI

Defined in: core.ts:113

Plugin cache with memory + disk tiers and TTL (fn-41). Requires cache.


readonly feedback: FeedbackAPI

Defined in: core.ts:115

Toast, HUD, confirmation, and progress feedback (fn-41). Requires feedback.


readonly oauth: OAuthAPI

Defined in: core.ts:117

OAuth 2.0 + PKCE authorization (fn-41). Requires oauth.


readonly menubar: MenubarAPI

Defined in: core.ts:119

Menu bar NSStatusItem management (fn-41). Requires menubar.


readonly store: StoreAPI

Defined in: core.ts:123

Durable Promise-shaped document/KV store (fn-71). Requires store.*.


readonly vault: VaultAPI

Defined in: core.ts:125

Credential vault (fn-72). Requires vault.*.


readonly actions: ActionsAPI

Defined in: core.ts:127

Public Action Fabric (fn-89). Requires actions.*.


readonly palette: PaletteAPI

Defined in: core.ts:129

Command palette integration for public actions (fn-89).


readonly scheduler: SchedulerAPI

Defined in: core.ts:131

Job scheduling engine (fn-90). Requires scheduler.job.own.


readonly resources: ResourcesAPI

Defined in: core.ts:133

URI-addressable resource read plane (fn-92). Requires resources.*.


readonly tokens: TokensAPI

Defined in: core.ts:135

Dotted-path token providers + template resolution (fn-92).


readonly bundles: BundlesAPI

Defined in: core.ts:140

ContextBundle composition (fn-92). Requires context.compose. NOTE: distinct from clipboard.bundles (fn-91).


readonly entities: EntitiesAPI

Defined in: core.ts:142

Entity resolution plane (fn-93). Requires entities.*.


readonly fields: FieldsAPI

Defined in: core.ts:144

Plugin-attached entity fields (fn-93). Requires entities.*.


readonly ledger: LedgerAPI

Defined in: core.ts:146

Execution / approval ledger reads (fn-94). Requires ledger.read.*.


readonly views: ViewsAPI

Defined in: core.ts:148

Host-rendered Saved Views (fn-95). Requires views.*.


readonly surfaces: SurfacesAPI

Defined in: core.ts:150

Surface contributions (fn-95). Runtime methods reject in v1 — use manifest extensions[].


readonly protocols: ProtocolsAPI

Defined in: core.ts:152

Protocol sidecar subprocesses (fn-96). Requires sidecars.*.


readonly notifications: NotificationsAPI

Defined in: core.ts:154

Outbound notifications (fn-97). Requires notifications.*.


readonly input: InputAPI

Defined in: core.ts:156

Inbound input channels (fn-98). Requires input.*.


readonly webhook: WebhookAPI

Defined in: core.ts:158

Bidirectional webhook gateway (fn-99/fn-118). Requires webhook.*.


readonly llm: LLMAPI

Defined in: core.ts:160

LLM provider verbs + contributor registries (fn-100). Requires llm.*.


readonly recipes: RecipesAPI

Defined in: core.ts:162

Recipe definitions + runs (fn-101). Requires recipes.*.


readonly sequences: SequencesAPI

Defined in: core.ts:164

Sequence definitions + runs (fn-101). Requires sequences.*.


readonly fileSystem: FileSystemAPI

Defined in: core.ts:166

Filesystem/transfer-strategy provider stub — core-swift only; throws for JS plugins.