@sequenceholdings/agent-spec 0.1.1 → 0.1.3

package/dist/agent-definition.d.ts

@@ -0,0 +1,616 @@
+import { z } from 'zod';
+export { canonicalJson } from './canonical-json.js';
+export { voiceDeclarationSchema } from './voice-authoring.js';
+export type { VoiceDeclaration, VoiceDeclarationInput } from './voice-authoring.js';
+export type UnsupportedConstraint = {
+    path: string;
+    type: string;
+    keyword: string;
+};
+export declare function collectUnsupportedConstraints({ schema, path, }: {
+    schema: unknown;
+    path?: string;
+}): UnsupportedConstraint[];
+export declare const AGENT_PERMISSION_ROLES: readonly ["owner", "editor", "invoker", "outputs_viewer"];
+export type AgentPermissionRole = (typeof AGENT_PERMISSION_ROLES)[number];
+export declare const AGENT_REFERENCE_KINDS: readonly ["mcp_server", "skill", "subagent", "managed_function"];
+export type AgentReferenceKind = (typeof AGENT_REFERENCE_KINDS)[number];
+export declare const agentReferenceSchema: z.ZodObject<{
+    kind: z.ZodEnum<{
+        mcp_server: "mcp_server";
+        skill: "skill";
+        subagent: "subagent";
+        managed_function: "managed_function";
+    }>;
+    id: z.ZodString;
+}, z.core.$strict>;
+export type AgentReference = z.infer<typeof agentReferenceSchema>;
+export declare const textAgentDefinitionSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    framework: z.ZodOptional<z.ZodEnum<{
+        vercel: "vercel";
+        "claude-agent": "claude-agent";
+    }>>;
+    vmBackend: z.ZodOptional<z.ZodEnum<{
+        gce: "gce";
+        e2b: "e2b";
+    }>>;
+    idleTimeoutSeconds: z.ZodOptional<z.ZodNumber>;
+    agentCapabilities: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    claudeToolSearch: z.ZodOptional<z.ZodEnum<{
+        enabled: "enabled";
+        disabled: "disabled";
+        auto: "auto";
+    }>>;
+    claudeBuiltInTools: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    openaiCodeInterpreter: z.ZodOptional<z.ZodNullable<z.ZodPreprocess<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        containerId: z.ZodOptional<z.ZodString>;
+        fileIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>>>;
+    model: z.ZodDefault<z.ZodObject<{
+        provider: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strip>>;
+    thinking: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    temperature: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    systemPrompt: z.ZodOptional<z.ZodString>;
+    tools: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    mcpServers: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    requiredMcpServers: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    requiredReferences: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        kind: z.ZodEnum<{
+            mcp_server: "mcp_server";
+            skill: "skill";
+            subagent: "subagent";
+            managed_function: "managed_function";
+        }>;
+        id: z.ZodString;
+    }, z.core.$strict>>>;
+    managedFunctions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    excludedMcpTools: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    hideIntermediateText: z.ZodOptional<z.ZodBoolean>;
+    middleware: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    subagents: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        forkContext: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>]>>>;
+    skills: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    contextFileIds: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    structuredOutput: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    inputSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodEnum<{
+                string: "string";
+                number: "number";
+                boolean: "boolean";
+                text: "text";
+                enum: "enum";
+            }>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            placeholder: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    promptTemplate: z.ZodOptional<z.ZodString>;
+    webhooks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    mcpServerConfigs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    stubConfig: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    maxTtlSeconds: z.ZodOptional<z.ZodNumber>;
+    agentPermissions: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    apiPermissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    managedBy: z.ZodOptional<z.ZodNullable<z.ZodLiteral<"automation">>>;
+    isPublic: z.ZodOptional<z.ZodBoolean>;
+    publicOutputs: z.ZodOptional<z.ZodBoolean>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            user: "user";
+            group: "group";
+        }>;
+        id: z.ZodString;
+        role: z.ZodEnum<{
+            owner: "owner";
+            editor: "editor";
+            invoker: "invoker";
+            outputs_viewer: "outputs_viewer";
+        }>;
+    }, z.core.$strip>>>;
+    mode: z.ZodOptional<z.ZodLiteral<"text">>;
+    voice: z.ZodOptional<z.ZodNever>;
+}, z.core.$strict>;
+export declare const voiceAgentDefinitionSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            user: "user";
+            group: "group";
+        }>;
+        id: z.ZodString;
+        role: z.ZodEnum<{
+            owner: "owner";
+            editor: "editor";
+            invoker: "invoker";
+            outputs_viewer: "outputs_viewer";
+        }>;
+    }, z.core.$strip>>>;
+    mode: z.ZodLiteral<"voice">;
+    model: z.ZodObject<{
+        provider: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strict>;
+    systemPrompt: z.ZodString;
+    skills: z.ZodPipe<z.ZodDefault<z.ZodArray<z.ZodString>>, z.ZodTransform<string[], string[]>>;
+    voice: z.ZodPipe<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1">;
+        voice: z.ZodString;
+        language: z.ZodString;
+        firstMessage: z.ZodString;
+        procedures: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
+            key: z.ZodString;
+            name: z.ZodString;
+            instructions: z.ZodString;
+            activationDescription: z.ZodString;
+            source: z.ZodObject<{
+                skillId: z.ZodString;
+                contentHash: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            toolAliases: z.ZodDefault<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+            subprocedures: z.ZodDefault<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+        }, z.core.$strict>, z.ZodTransform<{
+            source: {
+                skillId: string;
+                contentHash: string;
+            };
+            key: string;
+            name: string;
+            instructions: string;
+            activationDescription: string;
+            toolAliases: string[];
+            subprocedures: string[];
+        }, {
+            key: string;
+            name: string;
+            instructions: string;
+            activationDescription: string;
+            source: {
+                skillId: string;
+                contentHash?: string | undefined;
+            };
+            toolAliases: string[];
+            subprocedures: string[];
+        }>>>>;
+        tools: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
+            alias: z.ZodString;
+            description: z.ZodString;
+            managedFunction: z.ZodObject<{
+                ref: z.ZodString;
+                operation: z.ZodString;
+            }, z.core.$strict>;
+            inputMappings: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                argument: z.ZodString;
+                parameter: z.ZodString;
+            }, z.core.$strict>>>;
+            outputMappings: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                field: z.ZodString;
+                result: z.ZodString;
+            }, z.core.$strict>>>;
+        }, z.core.$strict>, z.ZodTransform<{
+            inputMappings: {
+                argument: string;
+                parameter: string;
+            }[];
+            outputMappings: {
+                field: string;
+                result: string;
+            }[];
+            alias: string;
+            description: string;
+            managedFunction: {
+                ref: string;
+                operation: string;
+            };
+        }, {
+            alias: string;
+            description: string;
+            managedFunction: {
+                ref: string;
+                operation: string;
+            };
+            inputMappings: {
+                argument: string;
+                parameter: string;
+            }[];
+            outputMappings: {
+                field: string;
+                result: string;
+            }[];
+        }>>>>;
+    }, z.core.$strict>, z.ZodTransform<{
+        procedures: {
+            source: {
+                skillId: string;
+                contentHash: string;
+            };
+            key: string;
+            name: string;
+            instructions: string;
+            activationDescription: string;
+            toolAliases: string[];
+            subprocedures: string[];
+        }[];
+        tools: {
+            inputMappings: {
+                argument: string;
+                parameter: string;
+            }[];
+            outputMappings: {
+                field: string;
+                result: string;
+            }[];
+            alias: string;
+            description: string;
+            managedFunction: {
+                ref: string;
+                operation: string;
+            };
+        }[];
+        schemaVersion: "1";
+        voice: string;
+        language: string;
+        firstMessage: string;
+    }, {
+        schemaVersion: "1";
+        voice: string;
+        language: string;
+        firstMessage: string;
+        procedures: {
+            source: {
+                skillId: string;
+                contentHash: string;
+            };
+            key: string;
+            name: string;
+            instructions: string;
+            activationDescription: string;
+            toolAliases: string[];
+            subprocedures: string[];
+        }[];
+        tools: {
+            inputMappings: {
+                argument: string;
+                parameter: string;
+            }[];
+            outputMappings: {
+                field: string;
+                result: string;
+            }[];
+            alias: string;
+            description: string;
+            managedFunction: {
+                ref: string;
+                operation: string;
+            };
+        }[];
+    }>>;
+    isPublic: z.ZodOptional<z.ZodLiteral<false>>;
+    publicOutputs: z.ZodOptional<z.ZodLiteral<false>>;
+}, z.core.$strict>;
+export declare const agentDefinitionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    framework: z.ZodOptional<z.ZodEnum<{
+        vercel: "vercel";
+        "claude-agent": "claude-agent";
+    }>>;
+    vmBackend: z.ZodOptional<z.ZodEnum<{
+        gce: "gce";
+        e2b: "e2b";
+    }>>;
+    idleTimeoutSeconds: z.ZodOptional<z.ZodNumber>;
+    agentCapabilities: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    claudeToolSearch: z.ZodOptional<z.ZodEnum<{
+        enabled: "enabled";
+        disabled: "disabled";
+        auto: "auto";
+    }>>;
+    claudeBuiltInTools: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    openaiCodeInterpreter: z.ZodOptional<z.ZodNullable<z.ZodPreprocess<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        containerId: z.ZodOptional<z.ZodString>;
+        fileIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>>>;
+    model: z.ZodDefault<z.ZodObject<{
+        provider: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strip>>;
+    thinking: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    temperature: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    systemPrompt: z.ZodOptional<z.ZodString>;
+    tools: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    mcpServers: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    requiredMcpServers: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    requiredReferences: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        kind: z.ZodEnum<{
+            mcp_server: "mcp_server";
+            skill: "skill";
+            subagent: "subagent";
+            managed_function: "managed_function";
+        }>;
+        id: z.ZodString;
+    }, z.core.$strict>>>;
+    managedFunctions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    excludedMcpTools: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    hideIntermediateText: z.ZodOptional<z.ZodBoolean>;
+    middleware: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    subagents: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        forkContext: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>]>>>;
+    skills: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    contextFileIds: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    structuredOutput: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    inputSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            label: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodEnum<{
+                string: "string";
+                number: "number";
+                boolean: "boolean";
+                text: "text";
+                enum: "enum";
+            }>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            enum: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            placeholder: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    promptTemplate: z.ZodOptional<z.ZodString>;
+    webhooks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    mcpServerConfigs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    stubConfig: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    maxTtlSeconds: z.ZodOptional<z.ZodNumber>;
+    agentPermissions: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+    apiPermissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    managedBy: z.ZodOptional<z.ZodNullable<z.ZodLiteral<"automation">>>;
+    isPublic: z.ZodOptional<z.ZodBoolean>;
+    publicOutputs: z.ZodOptional<z.ZodBoolean>;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            user: "user";
+            group: "group";
+        }>;
+        id: z.ZodString;
+        role: z.ZodEnum<{
+            owner: "owner";
+            editor: "editor";
+            invoker: "invoker";
+            outputs_viewer: "outputs_viewer";
+        }>;
+    }, z.core.$strip>>>;
+    mode: z.ZodOptional<z.ZodLiteral<"text">>;
+    voice: z.ZodOptional<z.ZodNever>;
+}, z.core.$strict>, z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    permissions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            user: "user";
+            group: "group";
+        }>;
+        id: z.ZodString;
+        role: z.ZodEnum<{
+            owner: "owner";
+            editor: "editor";
+            invoker: "invoker";
+            outputs_viewer: "outputs_viewer";
+        }>;
+    }, z.core.$strip>>>;
+    mode: z.ZodLiteral<"voice">;
+    model: z.ZodObject<{
+        provider: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strict>;
+    systemPrompt: z.ZodString;
+    skills: z.ZodPipe<z.ZodDefault<z.ZodArray<z.ZodString>>, z.ZodTransform<string[], string[]>>;
+    voice: z.ZodPipe<z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1">;
+        voice: z.ZodString;
+        language: z.ZodString;
+        firstMessage: z.ZodString;
+        procedures: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
+            key: z.ZodString;
+            name: z.ZodString;
+            instructions: z.ZodString;
+            activationDescription: z.ZodString;
+            source: z.ZodObject<{
+                skillId: z.ZodString;
+                contentHash: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+            toolAliases: z.ZodDefault<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+            subprocedures: z.ZodDefault<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<string[], string[]>>>;
+        }, z.core.$strict>, z.ZodTransform<{
+            source: {
+                skillId: string;
+                contentHash: string;
+            };
+            key: string;
+            name: string;
+            instructions: string;
+            activationDescription: string;
+            toolAliases: string[];
+            subprocedures: string[];
+        }, {
+            key: string;
+            name: string;
+            instructions: string;
+            activationDescription: string;
+            source: {
+                skillId: string;
+                contentHash?: string | undefined;
+            };
+            toolAliases: string[];
+            subprocedures: string[];
+        }>>>>;
+        tools: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodObject<{
+            alias: z.ZodString;
+            description: z.ZodString;
+            managedFunction: z.ZodObject<{
+                ref: z.ZodString;
+                operation: z.ZodString;
+            }, z.core.$strict>;
+            inputMappings: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                argument: z.ZodString;
+                parameter: z.ZodString;
+            }, z.core.$strict>>>;
+            outputMappings: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                field: z.ZodString;
+                result: z.ZodString;
+            }, z.core.$strict>>>;
+        }, z.core.$strict>, z.ZodTransform<{
+            inputMappings: {
+                argument: string;
+                parameter: string;
+            }[];
+            outputMappings: {
+                field: string;
+                result: string;
+            }[];
+            alias: string;
+            description: string;
+            managedFunction: {
+                ref: string;
+                operation: string;
+            };
+        }, {
+            alias: string;
+            description: string;
+            managedFunction: {
+                ref: string;
+                operation: string;
+            };
+            inputMappings: {
+                argument: string;
+                parameter: string;
+            }[];
+            outputMappings: {
+                field: string;
+                result: string;
+            }[];
+        }>>>>;
+    }, z.core.$strict>, z.ZodTransform<{
+        procedures: {
+            source: {
+                skillId: string;
+                contentHash: string;
+            };
+            key: string;
+            name: string;
+            instructions: string;
+            activationDescription: string;
+            toolAliases: string[];
+            subprocedures: string[];
+        }[];
+        tools: {
+            inputMappings: {
+                argument: string;
+                parameter: string;
+            }[];
+            outputMappings: {
+                field: string;
+                result: string;
+            }[];
+            alias: string;
+            description: string;
+            managedFunction: {
+                ref: string;
+                operation: string;
+            };
+        }[];
+        schemaVersion: "1";
+        voice: string;
+        language: string;
+        firstMessage: string;
+    }, {
+        schemaVersion: "1";
+        voice: string;
+        language: string;
+        firstMessage: string;
+        procedures: {
+            source: {
+                skillId: string;
+                contentHash: string;
+            };
+            key: string;
+            name: string;
+            instructions: string;
+            activationDescription: string;
+            toolAliases: string[];
+            subprocedures: string[];
+        }[];
+        tools: {
+            inputMappings: {
+                argument: string;
+                parameter: string;
+            }[];
+            outputMappings: {
+                field: string;
+                result: string;
+            }[];
+            alias: string;
+            description: string;
+            managedFunction: {
+                ref: string;
+                operation: string;
+            };
+        }[];
+    }>>;
+    isPublic: z.ZodOptional<z.ZodLiteral<false>>;
+    publicOutputs: z.ZodOptional<z.ZodLiteral<false>>;
+}, z.core.$strict>], "mode">;
+export type AgentDefinition = z.infer<typeof agentDefinitionSchema>;
+export type AgentDefinitionInput = z.input<typeof agentDefinitionSchema>;
+export type TextAgentDefinition = z.infer<typeof textAgentDefinitionSchema>;
+export type VoiceAgentDefinition = z.infer<typeof voiceAgentDefinitionSchema>;
+export type AgentMode = 'text' | 'voice';
+export declare function defineAgent(input: z.input<typeof textAgentDefinitionSchema>): TextAgentDefinition;
+export declare function defineAgent(input: z.input<typeof voiceAgentDefinitionSchema>): VoiceAgentDefinition;
+export declare function defineAgent(input: AgentDefinitionInput): AgentDefinition;
+export declare function getAgentMode({ definition }: {
+    definition: {
+        mode?: AgentMode;
+    };
+}): AgentMode;
+export declare function validateAgentModeUpdate({ existing, incoming }: {
+    existing: {
+        id: string;
+        mode?: AgentMode;
+    };
+    incoming: unknown;
+}): AgentDefinition;
+export declare function canonicalAgentJson(definition: AgentDefinition): string;
+export declare function hashAgentBundle({ definitions, }: {
+    definitions: AgentDefinition[];
+}): string;
+export declare function formatAgentSource({ definition, exportName, }: {
+    definition: unknown;
+    exportName?: string;
+}): string;
+export declare function generateAgentSource({ definition, exportName, }: {
+    definition: AgentDefinition;
+    exportName?: string;
+}): string;