clinkx 0.2.0 → 0.2.2

package/clinkx-workflows/dist/schema.d.ts

@@ -0,0 +1,609 @@
+/**
+ * Zod schemas for workflow definitions (clinkx-workflows).
+ *
+ * This is separate from the parent ClinkX schema.ts — these schemas define
+ * workflow definition structure, not MCP tool input.
+ *
+ * Tasks: 2-1a, 2-2a, 2-3a, 2-4a, 2-5a
+ */
+import { z } from "zod";
+/**
+ * ID grammar: [A-Za-z0-9_-]+
+ * Dots are forbidden because "stage.call" is the reference syntax for context_from.
+ */
+declare const ID_PATTERN: RegExp;
+export declare const IdSchema: z.ZodString;
+export declare const VariableTypeSchema: z.ZodEnum<["string", "number", "boolean", "string[]"]>;
+export declare const VariableSchema: z.ZodObject<{
+    type: z.ZodEnum<["string", "number", "boolean", "string[]"]>;
+    required: z.ZodBoolean;
+    default: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "string" | "number" | "boolean" | "string[]";
+    required: boolean;
+    default?: string | number | boolean | string[] | undefined;
+    description?: string | undefined;
+}, {
+    type: "string" | "number" | "boolean" | "string[]";
+    required: boolean;
+    default?: string | number | boolean | string[] | undefined;
+    description?: string | undefined;
+}>;
+export type Variable = z.infer<typeof VariableSchema>;
+export declare const RetryConfigSchema: z.ZodObject<{
+    mode: z.ZodDefault<z.ZodEnum<["transport_only", "all"]>>;
+    max_retries: z.ZodDefault<z.ZodNumber>;
+    backoff_seconds: z.ZodDefault<z.ZodNumber>;
+    max_backoff_seconds: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    mode: "transport_only" | "all";
+    max_retries: number;
+    backoff_seconds: number;
+    max_backoff_seconds: number;
+}, {
+    mode?: "transport_only" | "all" | undefined;
+    max_retries?: number | undefined;
+    backoff_seconds?: number | undefined;
+    max_backoff_seconds?: number | undefined;
+}>;
+export type RetryConfig = z.infer<typeof RetryConfigSchema>;
+/**
+ * CallSchema: exactly ONE of `prompt` or `prompt_template` (XOR).
+ * Uses zod refine for XOR enforcement.
+ */
+export declare const CallSchema: z.ZodEffects<z.ZodObject<{
+    id: z.ZodString;
+    cli_name: z.ZodString;
+    role: z.ZodString;
+    reducer: z.ZodOptional<z.ZodString>;
+    anonymize_context: z.ZodOptional<z.ZodBoolean>;
+    timeout_seconds: z.ZodOptional<z.ZodNumber>;
+    absolute_file_paths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    absolute_file_paths_from: z.ZodOptional<z.ZodString>;
+    images: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    images_from: z.ZodOptional<z.ZodString>;
+    context_from: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, string[], string | string[]>>;
+    validator_schema_id: z.ZodOptional<z.ZodString>;
+    max_response_chars: z.ZodOptional<z.ZodNumber>;
+    response_contract: z.ZodOptional<z.ZodEnum<["json"]>>;
+} & {
+    prompt: z.ZodOptional<z.ZodString>;
+    prompt_template: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    cli_name: string;
+    role: string;
+    reducer?: string | undefined;
+    anonymize_context?: boolean | undefined;
+    timeout_seconds?: number | undefined;
+    absolute_file_paths?: string[] | undefined;
+    absolute_file_paths_from?: string | undefined;
+    images?: string[] | undefined;
+    images_from?: string | undefined;
+    context_from?: string[] | undefined;
+    validator_schema_id?: string | undefined;
+    max_response_chars?: number | undefined;
+    response_contract?: "json" | undefined;
+    prompt?: string | undefined;
+    prompt_template?: string | undefined;
+}, {
+    id: string;
+    cli_name: string;
+    role: string;
+    reducer?: string | undefined;
+    anonymize_context?: boolean | undefined;
+    timeout_seconds?: number | undefined;
+    absolute_file_paths?: string[] | undefined;
+    absolute_file_paths_from?: string | undefined;
+    images?: string[] | undefined;
+    images_from?: string | undefined;
+    context_from?: string | string[] | undefined;
+    validator_schema_id?: string | undefined;
+    max_response_chars?: number | undefined;
+    response_contract?: "json" | undefined;
+    prompt?: string | undefined;
+    prompt_template?: string | undefined;
+}>, {
+    id: string;
+    cli_name: string;
+    role: string;
+    reducer?: string | undefined;
+    anonymize_context?: boolean | undefined;
+    timeout_seconds?: number | undefined;
+    absolute_file_paths?: string[] | undefined;
+    absolute_file_paths_from?: string | undefined;
+    images?: string[] | undefined;
+    images_from?: string | undefined;
+    context_from?: string[] | undefined;
+    validator_schema_id?: string | undefined;
+    max_response_chars?: number | undefined;
+    response_contract?: "json" | undefined;
+    prompt?: string | undefined;
+    prompt_template?: string | undefined;
+}, {
+    id: string;
+    cli_name: string;
+    role: string;
+    reducer?: string | undefined;
+    anonymize_context?: boolean | undefined;
+    timeout_seconds?: number | undefined;
+    absolute_file_paths?: string[] | undefined;
+    absolute_file_paths_from?: string | undefined;
+    images?: string[] | undefined;
+    images_from?: string | undefined;
+    context_from?: string | string[] | undefined;
+    validator_schema_id?: string | undefined;
+    max_response_chars?: number | undefined;
+    response_contract?: "json" | undefined;
+    prompt?: string | undefined;
+    prompt_template?: string | undefined;
+}>;
+export type Call = z.infer<typeof CallSchema>;
+export declare const StageSchema: z.ZodObject<{
+    id: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    parallel: z.ZodDefault<z.ZodBoolean>;
+    retry: z.ZodDefault<z.ZodObject<{
+        mode: z.ZodDefault<z.ZodEnum<["transport_only", "all"]>>;
+        max_retries: z.ZodDefault<z.ZodNumber>;
+        backoff_seconds: z.ZodDefault<z.ZodNumber>;
+        max_backoff_seconds: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        mode: "transport_only" | "all";
+        max_retries: number;
+        backoff_seconds: number;
+        max_backoff_seconds: number;
+    }, {
+        mode?: "transport_only" | "all" | undefined;
+        max_retries?: number | undefined;
+        backoff_seconds?: number | undefined;
+        max_backoff_seconds?: number | undefined;
+    }>>;
+    on_failure: z.ZodDefault<z.ZodEnum<["abort", "continue"]>>;
+    calls: z.ZodArray<z.ZodEffects<z.ZodObject<{
+        id: z.ZodString;
+        cli_name: z.ZodString;
+        role: z.ZodString;
+        reducer: z.ZodOptional<z.ZodString>;
+        anonymize_context: z.ZodOptional<z.ZodBoolean>;
+        timeout_seconds: z.ZodOptional<z.ZodNumber>;
+        absolute_file_paths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        absolute_file_paths_from: z.ZodOptional<z.ZodString>;
+        images: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        images_from: z.ZodOptional<z.ZodString>;
+        context_from: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, string[], string | string[]>>;
+        validator_schema_id: z.ZodOptional<z.ZodString>;
+        max_response_chars: z.ZodOptional<z.ZodNumber>;
+        response_contract: z.ZodOptional<z.ZodEnum<["json"]>>;
+    } & {
+        prompt: z.ZodOptional<z.ZodString>;
+        prompt_template: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        cli_name: string;
+        role: string;
+        reducer?: string | undefined;
+        anonymize_context?: boolean | undefined;
+        timeout_seconds?: number | undefined;
+        absolute_file_paths?: string[] | undefined;
+        absolute_file_paths_from?: string | undefined;
+        images?: string[] | undefined;
+        images_from?: string | undefined;
+        context_from?: string[] | undefined;
+        validator_schema_id?: string | undefined;
+        max_response_chars?: number | undefined;
+        response_contract?: "json" | undefined;
+        prompt?: string | undefined;
+        prompt_template?: string | undefined;
+    }, {
+        id: string;
+        cli_name: string;
+        role: string;
+        reducer?: string | undefined;
+        anonymize_context?: boolean | undefined;
+        timeout_seconds?: number | undefined;
+        absolute_file_paths?: string[] | undefined;
+        absolute_file_paths_from?: string | undefined;
+        images?: string[] | undefined;
+        images_from?: string | undefined;
+        context_from?: string | string[] | undefined;
+        validator_schema_id?: string | undefined;
+        max_response_chars?: number | undefined;
+        response_contract?: "json" | undefined;
+        prompt?: string | undefined;
+        prompt_template?: string | undefined;
+    }>, {
+        id: string;
+        cli_name: string;
+        role: string;
+        reducer?: string | undefined;
+        anonymize_context?: boolean | undefined;
+        timeout_seconds?: number | undefined;
+        absolute_file_paths?: string[] | undefined;
+        absolute_file_paths_from?: string | undefined;
+        images?: string[] | undefined;
+        images_from?: string | undefined;
+        context_from?: string[] | undefined;
+        validator_schema_id?: string | undefined;
+        max_response_chars?: number | undefined;
+        response_contract?: "json" | undefined;
+        prompt?: string | undefined;
+        prompt_template?: string | undefined;
+    }, {
+        id: string;
+        cli_name: string;
+        role: string;
+        reducer?: string | undefined;
+        anonymize_context?: boolean | undefined;
+        timeout_seconds?: number | undefined;
+        absolute_file_paths?: string[] | undefined;
+        absolute_file_paths_from?: string | undefined;
+        images?: string[] | undefined;
+        images_from?: string | undefined;
+        context_from?: string | string[] | undefined;
+        validator_schema_id?: string | undefined;
+        max_response_chars?: number | undefined;
+        response_contract?: "json" | undefined;
+        prompt?: string | undefined;
+        prompt_template?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    parallel: boolean;
+    retry: {
+        mode: "transport_only" | "all";
+        max_retries: number;
+        backoff_seconds: number;
+        max_backoff_seconds: number;
+    };
+    on_failure: "abort" | "continue";
+    calls: {
+        id: string;
+        cli_name: string;
+        role: string;
+        reducer?: string | undefined;
+        anonymize_context?: boolean | undefined;
+        timeout_seconds?: number | undefined;
+        absolute_file_paths?: string[] | undefined;
+        absolute_file_paths_from?: string | undefined;
+        images?: string[] | undefined;
+        images_from?: string | undefined;
+        context_from?: string[] | undefined;
+        validator_schema_id?: string | undefined;
+        max_response_chars?: number | undefined;
+        response_contract?: "json" | undefined;
+        prompt?: string | undefined;
+        prompt_template?: string | undefined;
+    }[];
+    description?: string | undefined;
+}, {
+    id: string;
+    calls: {
+        id: string;
+        cli_name: string;
+        role: string;
+        reducer?: string | undefined;
+        anonymize_context?: boolean | undefined;
+        timeout_seconds?: number | undefined;
+        absolute_file_paths?: string[] | undefined;
+        absolute_file_paths_from?: string | undefined;
+        images?: string[] | undefined;
+        images_from?: string | undefined;
+        context_from?: string | string[] | undefined;
+        validator_schema_id?: string | undefined;
+        max_response_chars?: number | undefined;
+        response_contract?: "json" | undefined;
+        prompt?: string | undefined;
+        prompt_template?: string | undefined;
+    }[];
+    description?: string | undefined;
+    parallel?: boolean | undefined;
+    retry?: {
+        mode?: "transport_only" | "all" | undefined;
+        max_retries?: number | undefined;
+        backoff_seconds?: number | undefined;
+        max_backoff_seconds?: number | undefined;
+    } | undefined;
+    on_failure?: "abort" | "continue" | undefined;
+}>;
+export type Stage = z.infer<typeof StageSchema>;
+export declare const WorkflowSettingsSchema: z.ZodObject<{
+    timeout_seconds: z.ZodDefault<z.ZodNumber>;
+    max_retries: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    max_retries: number;
+    timeout_seconds: number;
+}, {
+    max_retries?: number | undefined;
+    timeout_seconds?: number | undefined;
+}>;
+export type WorkflowSettings = z.infer<typeof WorkflowSettingsSchema>;
+export declare const WorkflowDefinitionSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodString;
+    version: z.ZodString;
+    stages: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        parallel: z.ZodDefault<z.ZodBoolean>;
+        retry: z.ZodDefault<z.ZodObject<{
+            mode: z.ZodDefault<z.ZodEnum<["transport_only", "all"]>>;
+            max_retries: z.ZodDefault<z.ZodNumber>;
+            backoff_seconds: z.ZodDefault<z.ZodNumber>;
+            max_backoff_seconds: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            mode: "transport_only" | "all";
+            max_retries: number;
+            backoff_seconds: number;
+            max_backoff_seconds: number;
+        }, {
+            mode?: "transport_only" | "all" | undefined;
+            max_retries?: number | undefined;
+            backoff_seconds?: number | undefined;
+            max_backoff_seconds?: number | undefined;
+        }>>;
+        on_failure: z.ZodDefault<z.ZodEnum<["abort", "continue"]>>;
+        calls: z.ZodArray<z.ZodEffects<z.ZodObject<{
+            id: z.ZodString;
+            cli_name: z.ZodString;
+            role: z.ZodString;
+            reducer: z.ZodOptional<z.ZodString>;
+            anonymize_context: z.ZodOptional<z.ZodBoolean>;
+            timeout_seconds: z.ZodOptional<z.ZodNumber>;
+            absolute_file_paths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            absolute_file_paths_from: z.ZodOptional<z.ZodString>;
+            images: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            images_from: z.ZodOptional<z.ZodString>;
+            context_from: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, string[], string | string[]>>;
+            validator_schema_id: z.ZodOptional<z.ZodString>;
+            max_response_chars: z.ZodOptional<z.ZodNumber>;
+            response_contract: z.ZodOptional<z.ZodEnum<["json"]>>;
+        } & {
+            prompt: z.ZodOptional<z.ZodString>;
+            prompt_template: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            cli_name: string;
+            role: string;
+            reducer?: string | undefined;
+            anonymize_context?: boolean | undefined;
+            timeout_seconds?: number | undefined;
+            absolute_file_paths?: string[] | undefined;
+            absolute_file_paths_from?: string | undefined;
+            images?: string[] | undefined;
+            images_from?: string | undefined;
+            context_from?: string[] | undefined;
+            validator_schema_id?: string | undefined;
+            max_response_chars?: number | undefined;
+            response_contract?: "json" | undefined;
+            prompt?: string | undefined;
+            prompt_template?: string | undefined;
+        }, {
+            id: string;
+            cli_name: string;
+            role: string;
+            reducer?: string | undefined;
+            anonymize_context?: boolean | undefined;
+            timeout_seconds?: number | undefined;
+            absolute_file_paths?: string[] | undefined;
+            absolute_file_paths_from?: string | undefined;
+            images?: string[] | undefined;
+            images_from?: string | undefined;
+            context_from?: string | string[] | undefined;
+            validator_schema_id?: string | undefined;
+            max_response_chars?: number | undefined;
+            response_contract?: "json" | undefined;
+            prompt?: string | undefined;
+            prompt_template?: string | undefined;
+        }>, {
+            id: string;
+            cli_name: string;
+            role: string;
+            reducer?: string | undefined;
+            anonymize_context?: boolean | undefined;
+            timeout_seconds?: number | undefined;
+            absolute_file_paths?: string[] | undefined;
+            absolute_file_paths_from?: string | undefined;
+            images?: string[] | undefined;
+            images_from?: string | undefined;
+            context_from?: string[] | undefined;
+            validator_schema_id?: string | undefined;
+            max_response_chars?: number | undefined;
+            response_contract?: "json" | undefined;
+            prompt?: string | undefined;
+            prompt_template?: string | undefined;
+        }, {
+            id: string;
+            cli_name: string;
+            role: string;
+            reducer?: string | undefined;
+            anonymize_context?: boolean | undefined;
+            timeout_seconds?: number | undefined;
+            absolute_file_paths?: string[] | undefined;
+            absolute_file_paths_from?: string | undefined;
+            images?: string[] | undefined;
+            images_from?: string | undefined;
+            context_from?: string | string[] | undefined;
+            validator_schema_id?: string | undefined;
+            max_response_chars?: number | undefined;
+            response_contract?: "json" | undefined;
+            prompt?: string | undefined;
+            prompt_template?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        parallel: boolean;
+        retry: {
+            mode: "transport_only" | "all";
+            max_retries: number;
+            backoff_seconds: number;
+            max_backoff_seconds: number;
+        };
+        on_failure: "abort" | "continue";
+        calls: {
+            id: string;
+            cli_name: string;
+            role: string;
+            reducer?: string | undefined;
+            anonymize_context?: boolean | undefined;
+            timeout_seconds?: number | undefined;
+            absolute_file_paths?: string[] | undefined;
+            absolute_file_paths_from?: string | undefined;
+            images?: string[] | undefined;
+            images_from?: string | undefined;
+            context_from?: string[] | undefined;
+            validator_schema_id?: string | undefined;
+            max_response_chars?: number | undefined;
+            response_contract?: "json" | undefined;
+            prompt?: string | undefined;
+            prompt_template?: string | undefined;
+        }[];
+        description?: string | undefined;
+    }, {
+        id: string;
+        calls: {
+            id: string;
+            cli_name: string;
+            role: string;
+            reducer?: string | undefined;
+            anonymize_context?: boolean | undefined;
+            timeout_seconds?: number | undefined;
+            absolute_file_paths?: string[] | undefined;
+            absolute_file_paths_from?: string | undefined;
+            images?: string[] | undefined;
+            images_from?: string | undefined;
+            context_from?: string | string[] | undefined;
+            validator_schema_id?: string | undefined;
+            max_response_chars?: number | undefined;
+            response_contract?: "json" | undefined;
+            prompt?: string | undefined;
+            prompt_template?: string | undefined;
+        }[];
+        description?: string | undefined;
+        parallel?: boolean | undefined;
+        retry?: {
+            mode?: "transport_only" | "all" | undefined;
+            max_retries?: number | undefined;
+            backoff_seconds?: number | undefined;
+            max_backoff_seconds?: number | undefined;
+        } | undefined;
+        on_failure?: "abort" | "continue" | undefined;
+    }>, "many">;
+    variables: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        type: z.ZodEnum<["string", "number", "boolean", "string[]"]>;
+        required: z.ZodBoolean;
+        default: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "string" | "number" | "boolean" | "string[]";
+        required: boolean;
+        default?: string | number | boolean | string[] | undefined;
+        description?: string | undefined;
+    }, {
+        type: "string" | "number" | "boolean" | "string[]";
+        required: boolean;
+        default?: string | number | boolean | string[] | undefined;
+        description?: string | undefined;
+    }>>>;
+    settings: z.ZodDefault<z.ZodObject<{
+        timeout_seconds: z.ZodDefault<z.ZodNumber>;
+        max_retries: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        max_retries: number;
+        timeout_seconds: number;
+    }, {
+        max_retries?: number | undefined;
+        timeout_seconds?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    description: string;
+    name: string;
+    version: string;
+    stages: {
+        id: string;
+        parallel: boolean;
+        retry: {
+            mode: "transport_only" | "all";
+            max_retries: number;
+            backoff_seconds: number;
+            max_backoff_seconds: number;
+        };
+        on_failure: "abort" | "continue";
+        calls: {
+            id: string;
+            cli_name: string;
+            role: string;
+            reducer?: string | undefined;
+            anonymize_context?: boolean | undefined;
+            timeout_seconds?: number | undefined;
+            absolute_file_paths?: string[] | undefined;
+            absolute_file_paths_from?: string | undefined;
+            images?: string[] | undefined;
+            images_from?: string | undefined;
+            context_from?: string[] | undefined;
+            validator_schema_id?: string | undefined;
+            max_response_chars?: number | undefined;
+            response_contract?: "json" | undefined;
+            prompt?: string | undefined;
+            prompt_template?: string | undefined;
+        }[];
+        description?: string | undefined;
+    }[];
+    variables: Record<string, {
+        type: "string" | "number" | "boolean" | "string[]";
+        required: boolean;
+        default?: string | number | boolean | string[] | undefined;
+        description?: string | undefined;
+    }>;
+    settings: {
+        max_retries: number;
+        timeout_seconds: number;
+    };
+}, {
+    description: string;
+    name: string;
+    version: string;
+    stages: {
+        id: string;
+        calls: {
+            id: string;
+            cli_name: string;
+            role: string;
+            reducer?: string | undefined;
+            anonymize_context?: boolean | undefined;
+            timeout_seconds?: number | undefined;
+            absolute_file_paths?: string[] | undefined;
+            absolute_file_paths_from?: string | undefined;
+            images?: string[] | undefined;
+            images_from?: string | undefined;
+            context_from?: string | string[] | undefined;
+            validator_schema_id?: string | undefined;
+            max_response_chars?: number | undefined;
+            response_contract?: "json" | undefined;
+            prompt?: string | undefined;
+            prompt_template?: string | undefined;
+        }[];
+        description?: string | undefined;
+        parallel?: boolean | undefined;
+        retry?: {
+            mode?: "transport_only" | "all" | undefined;
+            max_retries?: number | undefined;
+            backoff_seconds?: number | undefined;
+            max_backoff_seconds?: number | undefined;
+        } | undefined;
+        on_failure?: "abort" | "continue" | undefined;
+    }[];
+    variables?: Record<string, {
+        type: "string" | "number" | "boolean" | "string[]";
+        required: boolean;
+        default?: string | number | boolean | string[] | undefined;
+        description?: string | undefined;
+    }> | undefined;
+    settings?: {
+        max_retries?: number | undefined;
+        timeout_seconds?: number | undefined;
+    } | undefined;
+}>;
+export type WorkflowDefinition = z.infer<typeof WorkflowDefinitionSchema>;
+export { ID_PATTERN };