Skip to main content

Interface: IPluginPermissions

Defined in: src/types/interfaces/plugin.interface.ts:169

Plugin permissions (declared capabilities).

Remarks​

Plugins must declare permissions for:

  • Network access (which domains)
  • Storage quota (max size)
  • Event hooks (which events to subscribe)

Permissions are intended to be enforced by the plugin sandbox (isolated-vm). That enforcement is not wired up; see the status note at the top of this file.

Since​

0.1.0

Properties​

hooks?​

readonly optional hooks: readonly string[]

Defined in: src/types/interfaces/plugin.interface.ts:201

Event hook subscriptions.

network?​

readonly optional network: object

Defined in: src/types/interfaces/plugin.interface.ts:173

Network access permissions.

allowedDomains​

readonly allowedDomains: readonly string[]

Allowed domains for HTTP requests.

Remarks​

Plugins can only make requests to these domains.

Example​
["api.github.com", "orcid.org"]

storage?​

readonly optional storage: object

Defined in: src/types/interfaces/plugin.interface.ts:188

Storage permissions.

maxSize​

readonly maxSize: number

Maximum storage size in bytes.

Remarks​

Plugins have isolated key-value storage. This limits total size.