@opentabs-dev/plugin-sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+import type { z } from 'zod';
+export { NAME_REGEX, RESERVED_NAMES, validatePluginName, validateUrlPattern } from '@opentabs-dev/shared';
+export type { ManifestTool, PluginManifest as Manifest } from '@opentabs-dev/shared';
+export interface ToolDefinition<TInput extends z.ZodObject<z.ZodRawShape> = z.ZodObject<z.ZodRawShape>, TOutput extends z.ZodType = z.ZodType> {
+    /** Tool name — auto-prefixed with plugin name (e.g., 'send_message' → 'slack_send_message') */
+    name: string;
+    /** Human-readable description shown to MCP clients / AI agents */
+    description: string;
+    /** Zod schema — used for MCP registration + server-side input validation */
+    input: TInput;
+    /** Zod schema describing the tool output shape. Used for manifest generation and MCP tool registration. */
+    output: TOutput;
+    /** Execute the tool. Runs in the browser page context. Input is pre-validated. */
+    handle(params: z.infer<TInput>): Promise<z.infer<TOutput>>;
+}
+/** Type-safe factory — identity function that provides generic inference */
+export declare const defineTool: <TInput extends z.ZodObject<z.ZodRawShape>, TOutput extends z.ZodType>(config: ToolDefinition<TInput, TOutput>) => ToolDefinition<TInput, TOutput>;
+/**
+ * Abstract base class for all OpenTabs plugins.
+ * Plugin authors extend this and export an instance.
+ */
+export declare abstract class OpenTabsPlugin {
+    /** Unique identifier (lowercase alphanumeric + hyphens) */
+    abstract readonly name: string;
+    /** Semver version string */
+    abstract readonly version: string;
+    /** Brief description of the plugin's purpose */
+    abstract readonly description: string;
+    /**
+     * Chrome match patterns — determines which tabs get the adapter injected.
+     * @see https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns
+     */
+    abstract readonly urlPatterns: string[];
+    /** All tool definitions for this plugin */
+    abstract readonly tools: ToolDefinition[];
+    /**
+     * Readiness probe (Kubernetes convention).
+     * Called by the extension to determine if the service in the current
+     * tab is ready to accept tool requests. Runs in the page context.
+     *
+     * Tab state mapping:
+     *   - No matching tab exists     → 'closed'
+     *   - Tab exists, isReady=false  → 'unavailable'
+     *   - Tab exists, isReady=true   → 'ready'
+     *
+     * @returns true if the user is authenticated and the service is operational
+     */
+    abstract isReady(): Promise<boolean>;
+    /** Human-readable display name. Defaults to `name` if not set. */
+    displayName?: string;
+    /**
+     * Called by the platform before re-injection (plugin.update) to allow
+     * cleanup of event listeners, timers, or global state set up by the
+     * previous adapter version. Optional — plugins that do not set up
+     * persistent side effects can omit this.
+     */
+    teardown?(): void;
+}
+/**
+ * Typed error for tool handlers — the platform catches these
+ * and returns structured MCP error responses.
+ */
+export declare class ToolError extends Error {
+    /** Machine-readable error code (e.g., 'CHANNEL_NOT_FOUND') */
+    readonly code: string;
+    constructor(message: string, 
+    /** Machine-readable error code (e.g., 'CHANNEL_NOT_FOUND') */
+    code: string);
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,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;AAMrF,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,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;IACd,2GAA2G;IAC3G,MAAM,EAAE,OAAO,CAAC;IAChB,kFAAkF;IAClF,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;CAC5D;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,4BAA4B;IAC5B,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAClC,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,kEAAkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,IAAI;CAClB;AAED;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAGhC,8DAA8D;aAC9C,IAAI,EAAE,MAAM;gBAF5B,OAAO,EAAE,MAAM;IACf,8DAA8D;IAC9C,IAAI,EAAE,MAAM;CAK/B"}

package/dist/index.js

@@ -0,0 +1,29 @@
+// ---------------------------------------------------------------------------
+// Re-exports from @opentabs-dev/shared (single source of truth)
+// ---------------------------------------------------------------------------
+export { NAME_REGEX, RESERVED_NAMES, validatePluginName, validateUrlPattern } from '@opentabs-dev/shared';
+/** Type-safe factory — identity function that provides generic inference */
+export const defineTool = (config) => config;
+/**
+ * Abstract base class for all OpenTabs plugins.
+ * Plugin authors extend this and export an instance.
+ */
+export class OpenTabsPlugin {
+    /** Human-readable display name. Defaults to `name` if not set. */
+    displayName;
+}
+/**
+ * Typed error for tool handlers — the platform catches these
+ * and returns structured MCP error responses.
+ */
+export class ToolError extends Error {
+    code;
+    constructor(message, 
+    /** Machine-readable error code (e.g., 'CHANNEL_NOT_FOUND') */
+    code) {
+        super(message);
+        this.code = code;
+        this.name = 'ToolError';
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,8EAA8E;AAC9E,gEAAgE;AAChE,8EAA8E;AAE9E,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAuB1G,4EAA4E;AAC5E,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,MAAuC,EACN,EAAE,CAAC,MAAM,CAAC;AAE7C;;;GAGG;AACH,MAAM,OAAgB,cAAc;IA2BlC,kEAAkE;IAClE,WAAW,CAAU;CAQtB;AAED;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAIhB;IAHlB,YACE,OAAe;IACf,8DAA8D;IAC9C,IAAY;QAE5B,KAAK,CAAC,OAAO,CAAC,CAAC;QAFC,SAAI,GAAJ,IAAI,CAAQ;QAG5B,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC1B,CAAC;CACF"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@opentabs-dev/plugin-sdk",
+  "version": "0.0.1",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "scripts": {
+    "build": "tsc --build"
+  },
+  "dependencies": {
+    "@opentabs-dev/shared": "^0.0.1"
+  },
+  "peerDependencies": {
+    "zod": "^3.0.0"
+  },
+  "devDependencies": {
+    "bun-types": "^1.3.9"
+  }
+}