@opentabs-dev/plugin-sdk 0.0.53 → 0.0.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +0 -110
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +0 -8
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -18,112 +18,6 @@ export interface ToolHandlerContext {
|
|
|
18
18
|
/** Report incremental progress during a long-running operation. Fire-and-forget. */
|
|
19
19
|
reportProgress(opts: ProgressOptions): void;
|
|
20
20
|
}
|
|
21
|
-
/** Content returned from reading a resource. Aligns with MCP ReadResourceResult.contents[n]. */
|
|
22
|
-
export interface ResourceContent {
|
|
23
|
-
/** URI identifying this resource. */
|
|
24
|
-
uri: string;
|
|
25
|
-
/** Text content (mutually exclusive with blob for a given resource). */
|
|
26
|
-
text?: string;
|
|
27
|
-
/** Base64-encoded binary content (mutually exclusive with text for a given resource). */
|
|
28
|
-
blob?: string;
|
|
29
|
-
/** MIME type of the content (e.g., 'application/json', 'text/plain'). */
|
|
30
|
-
mimeType?: string;
|
|
31
|
-
}
|
|
32
|
-
/** A plugin resource definition. The read() handler executes in the browser page context. */
|
|
33
|
-
export interface ResourceDefinition<TContent extends z.ZodType = z.ZodType> {
|
|
34
|
-
/** Resource URI (e.g., 'slack://channels'). Must be non-empty. */
|
|
35
|
-
uri: string;
|
|
36
|
-
/** Human-readable name for the resource. */
|
|
37
|
-
name: string;
|
|
38
|
-
/** Human-readable description of the resource. */
|
|
39
|
-
description?: string;
|
|
40
|
-
/** MIME type of the resource content (e.g., 'application/json'). */
|
|
41
|
-
mimeType?: string;
|
|
42
|
-
/**
|
|
43
|
-
* Optional Zod schema describing the shape of the resource content.
|
|
44
|
-
* Provides a type-level contract for documentation and autocomplete — the
|
|
45
|
-
* runtime dispatch path does not validate against this schema.
|
|
46
|
-
*
|
|
47
|
-
* Use it for documentation and to derive content types:
|
|
48
|
-
* ```ts
|
|
49
|
-
* const schema = z.object({ channels: z.array(channelSchema) });
|
|
50
|
-
* const myResource = defineResource({ schema, ... });
|
|
51
|
-
* type Content = ResourceContentType<typeof myResource>; // { channels: Channel[] }
|
|
52
|
-
* ```
|
|
53
|
-
*/
|
|
54
|
-
schema?: TContent;
|
|
55
|
-
/** Read the resource content. Runs in the browser page context. */
|
|
56
|
-
read(uri: string): Promise<ResourceContent>;
|
|
57
|
-
}
|
|
58
|
-
/** Type-safe factory — provides generic inference when `schema` is present, and plain type checking otherwise. */
|
|
59
|
-
export declare const defineResource: <TContent extends z.ZodType = z.ZodType>(config: ResourceDefinition<TContent>) => ResourceDefinition<TContent>;
|
|
60
|
-
/**
|
|
61
|
-
* Extracts the content type from a ResourceDefinition's schema.
|
|
62
|
-
* Useful for deriving typed content from resource definitions.
|
|
63
|
-
*
|
|
64
|
-
* @example
|
|
65
|
-
* const myResource = defineResource({
|
|
66
|
-
* schema: z.object({ channels: z.array(z.string()) }),
|
|
67
|
-
* // ...
|
|
68
|
-
* });
|
|
69
|
-
* type Content = ResourceContentType<typeof myResource>; // { channels: string[] }
|
|
70
|
-
*/
|
|
71
|
-
export type ResourceContentType<R extends ResourceDefinition> = R extends ResourceDefinition<infer T> ? z.infer<T> : unknown;
|
|
72
|
-
/** A single argument for a prompt. Aligns with MCP PromptArgument. */
|
|
73
|
-
export interface PromptArgument {
|
|
74
|
-
/** Argument name. */
|
|
75
|
-
name: string;
|
|
76
|
-
/** Human-readable description of the argument. */
|
|
77
|
-
description?: string;
|
|
78
|
-
/** Whether this argument is required. */
|
|
79
|
-
required?: boolean;
|
|
80
|
-
}
|
|
81
|
-
/** A single message in a prompt result. Aligns with MCP GetPromptResult.messages[n]. */
|
|
82
|
-
export interface PromptMessage {
|
|
83
|
-
/** Message role. */
|
|
84
|
-
role: 'user' | 'assistant';
|
|
85
|
-
/** Message content. */
|
|
86
|
-
content: {
|
|
87
|
-
type: 'text';
|
|
88
|
-
text: string;
|
|
89
|
-
};
|
|
90
|
-
}
|
|
91
|
-
/** A plugin prompt definition. The render() handler executes in the browser page context. */
|
|
92
|
-
export interface PromptDefinition {
|
|
93
|
-
/** Prompt name (e.g., 'compose_message'). Must be non-empty. */
|
|
94
|
-
name: string;
|
|
95
|
-
/** Human-readable description of the prompt. */
|
|
96
|
-
description?: string;
|
|
97
|
-
/**
|
|
98
|
-
* Optional Zod schema for prompt arguments. When provided and passed to
|
|
99
|
-
* `definePrompt`, the render() function receives a typed object inferred
|
|
100
|
-
* from the schema. Argument metadata is auto-generated during build when
|
|
101
|
-
* the explicit `arguments` array is not provided.
|
|
102
|
-
*/
|
|
103
|
-
args?: z.ZodObject<z.ZodRawShape>;
|
|
104
|
-
/** Arguments the prompt accepts (metadata for MCP registration). Auto-generated from `args` schema during build when not provided. */
|
|
105
|
-
arguments?: PromptArgument[];
|
|
106
|
-
/** Render the prompt messages. Runs in the browser page context. */
|
|
107
|
-
render(args: Record<string, string>): Promise<PromptMessage[]>;
|
|
108
|
-
}
|
|
109
|
-
/**
|
|
110
|
-
* Config type for definePrompt when `args` Zod schema is provided. The render
|
|
111
|
-
* function parameter is typed from the schema.
|
|
112
|
-
*/
|
|
113
|
-
export interface TypedPromptConfig<TArgs extends z.ZodObject<z.ZodRawShape>> {
|
|
114
|
-
name: string;
|
|
115
|
-
description?: string;
|
|
116
|
-
args: TArgs;
|
|
117
|
-
arguments?: PromptArgument[];
|
|
118
|
-
render(args: z.infer<TArgs>): Promise<PromptMessage[]>;
|
|
119
|
-
}
|
|
120
|
-
/** Overloaded call signature for definePrompt — typed when `args` is present, plain otherwise. */
|
|
121
|
-
export interface DefinePrompt {
|
|
122
|
-
<TArgs extends z.ZodObject<z.ZodRawShape>>(config: TypedPromptConfig<TArgs>): PromptDefinition;
|
|
123
|
-
(config: PromptDefinition): PromptDefinition;
|
|
124
|
-
}
|
|
125
|
-
/** Type-safe factory — provides generic inference when `args` schema is present, and plain type checking otherwise. */
|
|
126
|
-
export declare const definePrompt: DefinePrompt;
|
|
127
21
|
export interface ToolDefinition<TInput extends z.ZodObject<z.ZodRawShape> = z.ZodObject<z.ZodRawShape>, TOutput extends z.ZodType = z.ZodType> {
|
|
128
22
|
/** Tool name — auto-prefixed with plugin name (e.g., 'send_message' → 'slack_send_message') */
|
|
129
23
|
name: string;
|
|
@@ -158,10 +52,6 @@ export declare abstract class OpenTabsPlugin {
|
|
|
158
52
|
abstract readonly urlPatterns: string[];
|
|
159
53
|
/** All tool definitions for this plugin */
|
|
160
54
|
abstract readonly tools: ToolDefinition[];
|
|
161
|
-
/** Resource definitions for this plugin (optional). */
|
|
162
|
-
readonly resources?: ResourceDefinition[];
|
|
163
|
-
/** Prompt definitions for this plugin (optional). */
|
|
164
|
-
readonly prompts?: PromptDefinition[];
|
|
165
55
|
/**
|
|
166
56
|
* Readiness probe (Kubernetes convention).
|
|
167
57
|
* Called by the extension to determine if the service in the current
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAM7B,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1G,YAAY,EAAE,YAAY,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrF,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAM3D,sFAAsF;AACtF,MAAM,WAAW,eAAe;IAC9B,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oFAAoF;IACpF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,4EAA4E;AAC5E,MAAM,WAAW,kBAAkB;IACjC,oFAAoF;IACpF,cAAc,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI,CAAC;CAC7C;AAMD,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAM7B,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1G,YAAY,EAAE,YAAY,EAAE,cAAc,IAAI,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACrF,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAM3D,sFAAsF;AACtF,MAAM,WAAW,eAAe;IAC9B,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oFAAoF;IACpF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,4EAA4E;AAC5E,MAAM,WAAW,kBAAkB;IACjC,oFAAoF;IACpF,cAAc,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI,CAAC;CAC7C;AAMD,MAAM,WAAW,cAAc,CAC7B,MAAM,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,EACtE,OAAO,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO;IAErC,+FAA+F;IAC/F,IAAI,EAAE,MAAM,CAAC;IACb,oIAAoI;IACpI,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,8IAA8I;IAC9I,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;IACd,2GAA2G;IAC3G,MAAM,EAAE,OAAO,CAAC;IAChB,8HAA8H;IAC9H,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;CAC1F;AAED,4EAA4E;AAC5E,eAAO,MAAM,UAAU,GAAI,MAAM,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,OAAO,SAAS,CAAC,CAAC,OAAO,EAC7F,QAAQ,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,KACtC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAW,CAAC;AAE7C;;;GAGG;AACH,8BAAsB,cAAc;IAClC,2DAA2D;IAC3D,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAC/B,gDAAgD;IAChD,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IACtC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IACxC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,cAAc,EAAE,CAAC;IAC1C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IACpC,8EAA8E;IAC9E,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IACtC;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,IAAI;IACjB;;;;;OAKG;IACH,UAAU,CAAC,IAAI,IAAI;IACnB;;;;;;OAMG;IACH,YAAY,CAAC,IAAI,IAAI;IACrB;;;;;;OAMG;IACH,UAAU,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAC9B;;;;;;;OAOG;IACH,qBAAqB,CAAC,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAC9C;;;;;;;;;OASG;IACH,mBAAmB,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;CACnF;AAMD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAMnE,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACjH,YAAY,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAM1E,OAAO,EACL,aAAa,EACb,SAAS,EACT,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,SAAS,EACT,UAAU,GACX,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,oBAAoB,EACpB,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,SAAS,EACT,UAAU,GACX,MAAM,YAAY,CAAC;AAMpB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACtD,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAMhF,OAAO,EACL,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,SAAS,GACV,MAAM,cAAc,CAAC;AAMtB,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAM7E,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -3,10 +3,6 @@
|
|
|
3
3
|
// ---------------------------------------------------------------------------
|
|
4
4
|
export { NAME_REGEX, RESERVED_NAMES, validatePluginName, validateUrlPattern } from '@opentabs-dev/shared';
|
|
5
5
|
export { LUCIDE_ICON_NAMES } from './lucide-icon-names.js';
|
|
6
|
-
/** Type-safe factory — provides generic inference when `schema` is present, and plain type checking otherwise. */
|
|
7
|
-
export const defineResource = (config) => config;
|
|
8
|
-
/** Type-safe factory — provides generic inference when `args` schema is present, and plain type checking otherwise. */
|
|
9
|
-
export const definePrompt = (config) => config;
|
|
10
6
|
/** Type-safe factory — identity function that provides generic inference */
|
|
11
7
|
export const defineTool = (config) => config;
|
|
12
8
|
/**
|
|
@@ -14,10 +10,6 @@ export const defineTool = (config) => config;
|
|
|
14
10
|
* Plugin authors extend this and export an instance.
|
|
15
11
|
*/
|
|
16
12
|
export class OpenTabsPlugin {
|
|
17
|
-
/** Resource definitions for this plugin (optional). */
|
|
18
|
-
resources;
|
|
19
|
-
/** Prompt definitions for this plugin (optional). */
|
|
20
|
-
prompts;
|
|
21
13
|
}
|
|
22
14
|
// ---------------------------------------------------------------------------
|
|
23
15
|
// Errors
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,8EAA8E;AAC9E,gEAAgE;AAChE,8EAA8E;AAE9E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAG1G,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,8EAA8E;AAC9E,gEAAgE;AAChE,8EAA8E;AAE9E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAG1G,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AA8C3D,4EAA4E;AAC5E,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,MAAuC,EACN,EAAE,CAAC,MAAM,CAAC;AAE7C;;;GAGG;AACH,MAAM,OAAgB,cAAc;CA6EnC;AAED,8EAA8E;AAC9E,SAAS;AACT,8EAA8E;AAE9E,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,8EAA8E;AAC9E,sBAAsB;AACtB,8EAA8E;AAE9E,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGjH,8EAA8E;AAC9E,wBAAwB;AACxB,8EAA8E;AAE9E,OAAO,EACL,aAAa,EACb,SAAS,EACT,aAAa,EACb,qBAAqB,EACrB,iBAAiB,EACjB,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,OAAO,EACP,SAAS,EACT,UAAU,GACX,MAAM,YAAY,CAAC;AAYpB,8EAA8E;AAC9E,yBAAyB;AACzB,8EAA8E;AAE9E,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGtD,8EAA8E;AAC9E,0BAA0B;AAC1B,8EAA8E;AAE9E,OAAO,EACL,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,SAAS,GACV,MAAM,cAAc,CAAC;AAEtB,8EAA8E;AAC9E,6BAA6B;AAC7B,8EAA8E;AAE9E,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE7E,8EAA8E;AAC9E,0BAA0B;AAC1B,8EAA8E;AAE9E,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC"}
|