@executor-js/sdk 0.0.1 → 0.1.0

package/dist/core-schema.d.ts

@@ -0,0 +1,372 @@
+import type { InferDBFieldsOutput } from "@executor-js/storage-core";
+export declare const coreSchema: {
+    readonly source: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly plugin_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly kind: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly url: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly can_remove: {
+                readonly type: "boolean";
+                readonly required: true;
+                readonly defaultValue: true;
+            };
+            readonly can_refresh: {
+                readonly type: "boolean";
+                readonly required: true;
+                readonly defaultValue: false;
+            };
+            readonly can_edit: {
+                readonly type: "boolean";
+                readonly required: true;
+                readonly defaultValue: false;
+            };
+            readonly created_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+            readonly updated_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+        };
+    };
+    readonly tool: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly source_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly plugin_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly description: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly input_schema: {
+                readonly type: "json";
+                readonly required: false;
+            };
+            readonly output_schema: {
+                readonly type: "json";
+                readonly required: false;
+            };
+            readonly created_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+            readonly updated_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+        };
+    };
+    readonly definition: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly source_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly plugin_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly schema: {
+                readonly type: "json";
+                readonly required: true;
+            };
+            readonly created_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+        };
+    };
+    readonly secret: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly provider: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly owned_by_connection_id: {
+                readonly type: "string";
+                readonly required: false;
+                readonly index: true;
+            };
+            readonly created_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+        };
+    };
+    readonly connection: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            /** Routing key into `plugin.connectionProviders`. Typical shape
+             *  is `${pluginId}:${kind}` (e.g. `openapi:oauth2`, `mcp:oauth2`,
+             *  `google-discovery:google`). Mirrors `secret.provider`. */
+            readonly provider: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            /** Display label shown in the Connections UI. Usually the account
+             *  email / handle / org name the user signed in as. */
+            readonly identity_label: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            /** Stable id of the access-token secret. Always present. */
+            readonly access_token_secret_id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            /** Stable id of the refresh-token secret. Null for flows that
+             *  don't mint a refresh token (client_credentials, etc.). */
+            readonly refresh_token_secret_id: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            /** Epoch ms when the access token expires. Null if the provider
+             *  didn't declare an expiry. Used as the refresh trigger. Stored as
+             *  `bigint` because `Date.now()` overflows int32. */
+            readonly expires_at: {
+                readonly type: "number";
+                readonly required: false;
+                readonly bigint: true;
+            };
+            /** Scope string as returned by the token endpoint. */
+            readonly scope: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            /** Opaque plugin-owned JSON — token endpoint URL, scopes list,
+             *  discovery hints, etc. Never sensitive. */
+            readonly provider_state: {
+                readonly type: "json";
+                readonly required: false;
+            };
+            readonly created_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+            readonly updated_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+        };
+    };
+    readonly oauth2_session: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly plugin_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly strategy: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly connection_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly token_scope: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly redirect_url: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly payload: {
+                readonly type: "json";
+                readonly required: true;
+            };
+            readonly expires_at: {
+                readonly type: "number";
+                readonly required: true;
+                readonly bigint: true;
+            };
+            readonly created_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+        };
+    };
+    readonly tool_policy: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly pattern: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            /** "approve" | "require_approval" | "block". */
+            readonly action: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            /** Fractional-indexing key (Jira lexorank style). Lower lex order =
+             *  higher precedence. New rules default to a key generated above
+             *  the current minimum. Strings instead of numbers so we can
+             *  always lengthen the key to insert between two adjacent rows
+             *  without precision loss; see `fractional-indexing` in
+             *  `policies.ts`. */
+            readonly position: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly created_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+            readonly updated_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+        };
+    };
+};
+export type CoreSchema = typeof coreSchema;
+export type SourceRow = InferDBFieldsOutput<CoreSchema["source"]["fields"]> & Record<string, unknown>;
+export type ToolRow = InferDBFieldsOutput<CoreSchema["tool"]["fields"]> & Record<string, unknown>;
+export type DefinitionRow = InferDBFieldsOutput<CoreSchema["definition"]["fields"]> & Record<string, unknown>;
+export type SecretRow = InferDBFieldsOutput<CoreSchema["secret"]["fields"]> & Record<string, unknown>;
+export type ConnectionRow = InferDBFieldsOutput<CoreSchema["connection"]["fields"]> & Record<string, unknown>;
+export type ToolPolicyRow = InferDBFieldsOutput<CoreSchema["tool_policy"]["fields"]> & Record<string, unknown>;
+export type ToolPolicyAction = "approve" | "require_approval" | "block";
+export declare const TOOL_POLICY_ACTIONS: readonly ["approve", "require_approval", "block"];
+export declare const isToolPolicyAction: (value: unknown) => value is ToolPolicyAction;
+export interface ToolAnnotations {
+    /** If true, the executor will call the invoke-time elicitation handler
+     *  before running the tool and abort if the user declines. */
+    readonly requiresApproval?: boolean;
+    /** Free-text message shown in the approval prompt. Falls back to the
+     *  tool's id / description if unset. */
+    readonly approvalDescription?: string;
+    /** Hint for UI — tool may suspend to ask the user for input mid-invocation.
+     *  Not enforced by the executor; purely a UI signal. */
+    readonly mayElicit?: boolean;
+}
+export interface SourceInputTool {
+    readonly name: string;
+    readonly description: string;
+    readonly inputSchema?: unknown;
+    readonly outputSchema?: unknown;
+}
+export interface SourceInput {
+    readonly id: string;
+    /** Scope id this source belongs to. Must be one of the executor's
+     *  configured scopes. Callers (plugins) pick the target scope
+     *  explicitly — typically the scope the source was authored against. */
+    readonly scope: string;
+    readonly kind: string;
+    readonly name: string;
+    readonly url?: string;
+    readonly canRemove?: boolean;
+    readonly canRefresh?: boolean;
+    readonly canEdit?: boolean;
+    readonly tools: readonly SourceInputTool[];
+}
+export interface DefinitionsInput {
+    readonly sourceId: string;
+    /** Scope id these definitions belong to — should match the scope of
+     *  the source they're registered under. */
+    readonly scope: string;
+    readonly definitions: Record<string, unknown>;
+}
+//# sourceMappingURL=core-schema.d.ts.map

package/dist/core-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-schema.d.ts","sourceRoot":"","sources":["../src/core-schema.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAEV,mBAAmB,EACpB,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA6GjB;;yEAE6D;;;;;;YAE7D;mEACuD;;;;;YAEvD,4DAA4D;;;;;YAE5D;yEAC6D;;;;;YAE7D;;iEAEqD;;;;;;YAErD,sDAAsD;;;;;YAEtD;yDAC6C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAyC7C,gDAAgD;;;;;YAEhD;;;;;iCAKqB;;;;;;;;;;;;;;;;CAME,CAAC;AAE9B,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC;AAO3C,MAAM,MAAM,SAAS,GAAG,mBAAmB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,GACzE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1B,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,GACrE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1B,MAAM,MAAM,aAAa,GAAG,mBAAmB,CAC7C,UAAU,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CACnC,GACC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1B,MAAM,MAAM,SAAS,GAAG,mBAAmB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,GACzE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1B,MAAM,MAAM,aAAa,GAAG,mBAAmB,CAC7C,UAAU,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CACnC,GACC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1B,MAAM,MAAM,aAAa,GAAG,mBAAmB,CAC7C,UAAU,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,CACpC,GACC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAc1B,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,kBAAkB,GAAG,OAAO,CAAC;AAExE,eAAO,MAAM,mBAAmB,mDAIgB,CAAC;AAEjD,eAAO,MAAM,kBAAkB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,gBAED,CAAC;AAkB7D,MAAM,WAAW,eAAe;IAC9B;kEAC8D;IAC9D,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IACpC;4CACwC;IACxC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IACtC;4DACwD;IACxD,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B;AAUD,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;4EAEwE;IACxE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,SAAS,eAAe,EAAE,CAAC;CAC5C;AASD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;+CAC2C;IAC3C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/C"}