@sms/plugin-sdk
Interfaces
Cap
Defined in: packages/core/plugin-sdk/src/runtime.ts:6
The plugin-side runtime: builds the cap object handed to plugin code and
answers the host’s calls (‘activate’, ‘fn’). Transport-agnostic — the
executor supplies hostCall.
Methods
contribute()
contribute(point, item): Promise<void>;
Defined in: packages/core/plugin-sdk/src/runtime.ts:10
Contribute an item to an extension point. Functions in the item become callable from the host.
Parameters
| Parameter | Type |
|---|---|
point | string |
item | unknown |
Returns
Promise<void>
get()
get<T>(key): Promise<T>;
Defined in: packages/core/plugin-sdk/src/runtime.ts:12
Read a JSON snapshot of an injected key.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<T>
invoke()
invoke<T>(
key,
method,
...args
): Promise<T>;
Defined in: packages/core/plugin-sdk/src/runtime.ts:14
Call a method on an injected service.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
key | string |
method | string |
…args | unknown[] |
Returns
Promise<T>
log()
log(...args): void;
Defined in: packages/core/plugin-sdk/src/runtime.ts:15
Parameters
| Parameter | Type |
|---|---|
…args | unknown[] |
Returns
void
provide()
provide(key, value): Promise<void>;
Defined in: packages/core/plugin-sdk/src/runtime.ts:8
Provide a service. Methods on the value become callable from the host.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | unknown |
Returns
Promise<void>
Channel
Defined in: packages/core/plugin-sdk/src/channel.ts:10
Methods
call()
call(
method,
args,
timeoutMs?
): Promise<unknown>;
Defined in: packages/core/plugin-sdk/src/channel.ts:11
Parameters
| Parameter | Type |
|---|---|
method | string |
args | unknown |
timeoutMs? | number |
Returns
Promise<unknown>
close()
close(reason?): void;
Defined in: packages/core/plugin-sdk/src/channel.ts:13
Parameters
| Parameter | Type |
|---|---|
reason? | string |
Returns
void
receive()
receive(msg): void;
Defined in: packages/core/plugin-sdk/src/channel.ts:12
Parameters
| Parameter | Type |
|---|---|
msg | RpcMessage |
Returns
void
PluginModule
Defined in: packages/core/plugin-sdk/src/runtime.ts:20
Properties
activate?
optional activate?: Activate;
Defined in: packages/core/plugin-sdk/src/runtime.ts:22
default?
optional default?:
| Activate
| {
activate?: Activate;
};
Defined in: packages/core/plugin-sdk/src/runtime.ts:21
PluginRuntime
Defined in: packages/core/plugin-sdk/src/runtime.ts:25
Properties
cap
cap: Cap;
Defined in: packages/core/plugin-sdk/src/runtime.ts:26
Methods
handle()
handle(method, args): Promise<unknown>;
Defined in: packages/core/plugin-sdk/src/runtime.ts:28
Handle a call coming from the host.
Parameters
| Parameter | Type |
|---|---|
method | string |
args | unknown |
Returns
Promise<unknown>
RpcMessage
Defined in: packages/core/plugin-sdk/src/channel.ts:2
Tiny request/response multiplexer used on both sides of an Executor boundary.
Properties
args?
optional args?: unknown;
Defined in: packages/core/plugin-sdk/src/channel.ts:5
error?
optional error?: string;
Defined in: packages/core/plugin-sdk/src/channel.ts:7
id
id: number;
Defined in: packages/core/plugin-sdk/src/channel.ts:3
method?
optional method?: string;
Defined in: packages/core/plugin-sdk/src/channel.ts:4
result?
optional result?: unknown;
Defined in: packages/core/plugin-sdk/src/channel.ts:6
Type Aliases
Activate
type Activate = (cap) => void | Promise<void>;
Defined in: packages/core/plugin-sdk/src/runtime.ts:18
Parameters
| Parameter | Type |
|---|---|
cap | Cap |
Returns
void | Promise<void>
Functions
createChannel()
function createChannel(post, handle): Channel;
Defined in: packages/core/plugin-sdk/src/channel.ts:16
Parameters
| Parameter | Type |
|---|---|
post | (msg) => void |
handle | (method, args) => Promise<unknown> |
Returns
createPluginRuntime()
function createPluginRuntime(hostCall, loadModule): PluginRuntime;
Defined in: packages/core/plugin-sdk/src/runtime.ts:31
Parameters
| Parameter | Type |
|---|---|
hostCall | (method, args) => Promise<unknown> |
loadModule | () => Promise<PluginModule> |
Returns
resolveActivate()
function resolveActivate(mod): Activate | undefined;
Defined in: packages/core/plugin-sdk/src/runtime.ts:89
Parameters
| Parameter | Type |
|---|---|
mod | PluginModule |
Returns
Activate | undefined