Skip to content

@oneplatform/plugin-sdk


@oneplatform/plugin-sdk / TenantContext

Interface: TenantContext

Defined in: packages/plugin-sdk/src/types/context.ts:154

Properties

config

config: Record\<string, unknown>

Defined in: packages/plugin-sdk/src/types/context.ts:166

Configuration values provided by the tenant admin at plugin enable time. Values are validated against the plugin's manifest.configSchema before being stored. Safe to read; always typed as Record.


instanceId

instanceId: string

Defined in: packages/plugin-sdk/src/types/context.ts:173

Unique ID of this specific plugin instance within the tenant. A single plugin can be enabled multiple times (e.g., two Shopify connectors pointing to different stores). Each enable creates a distinct instanceId.


tenantId

tenantId: string

Defined in: packages/plugin-sdk/src/types/context.ts:156

UUID of the tenant that owns this plugin instance.


tenantName

tenantName: string

Defined in: packages/plugin-sdk/src/types/context.ts:159

Human-readable display name for this tenant.