@kya-os/contracts 1.5.1 → 1.5.2-canary.1

package/dist/consent/schemas.d.ts

@@ -0,0 +1,738 @@
+/**
+ * Consent Schemas
+ *
+ * Zod schemas for runtime validation of consent-related data structures.
+ * All types are derived from these schemas using z.infer.
+ *
+ * Related Spec: MCP-I Phase 0 Implementation Plan
+ */
+import { z } from 'zod';
+/**
+ * Consent Branding Schema
+ */
+export declare const consentBrandingSchema: z.ZodObject<{
+    primaryColor: z.ZodOptional<z.ZodString>;
+    logoUrl: z.ZodOptional<z.ZodString>;
+    companyName: z.ZodOptional<z.ZodString>;
+    theme: z.ZodOptional<z.ZodEnum<["light", "dark", "auto"]>>;
+}, "strip", z.ZodTypeAny, {
+    primaryColor?: string | undefined;
+    logoUrl?: string | undefined;
+    companyName?: string | undefined;
+    theme?: "light" | "dark" | "auto" | undefined;
+}, {
+    primaryColor?: string | undefined;
+    logoUrl?: string | undefined;
+    companyName?: string | undefined;
+    theme?: "light" | "dark" | "auto" | undefined;
+}>;
+export type ConsentBranding = z.infer<typeof consentBrandingSchema>;
+/**
+ * Consent Terms Schema
+ */
+export declare const consentTermsSchema: z.ZodObject<{
+    text: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+    version: z.ZodOptional<z.ZodString>;
+    required: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    required: boolean;
+    text?: string | undefined;
+    url?: string | undefined;
+    version?: string | undefined;
+}, {
+    text?: string | undefined;
+    url?: string | undefined;
+    version?: string | undefined;
+    required?: boolean | undefined;
+}>;
+export type ConsentTerms = z.infer<typeof consentTermsSchema>;
+/**
+ * Consent Custom Field Option Schema
+ */
+export declare const consentCustomFieldOptionSchema: z.ZodObject<{
+    value: z.ZodString;
+    label: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    label: string;
+}, {
+    value: string;
+    label: string;
+}>;
+/**
+ * Consent Custom Field Schema
+ */
+export declare const consentCustomFieldSchema: z.ZodEffects<z.ZodObject<{
+    name: z.ZodString;
+    label: z.ZodString;
+    type: z.ZodEnum<["text", "textarea", "checkbox", "select"]>;
+    required: z.ZodBoolean;
+    placeholder: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        label: string;
+    }, {
+        value: string;
+        label: string;
+    }>, "many">>;
+    pattern: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "text" | "textarea" | "checkbox" | "select";
+    required: boolean;
+    label: string;
+    name: string;
+    options?: {
+        value: string;
+        label: string;
+    }[] | undefined;
+    placeholder?: string | undefined;
+    pattern?: string | undefined;
+}, {
+    type: "text" | "textarea" | "checkbox" | "select";
+    required: boolean;
+    label: string;
+    name: string;
+    options?: {
+        value: string;
+        label: string;
+    }[] | undefined;
+    placeholder?: string | undefined;
+    pattern?: string | undefined;
+}>, {
+    type: "text" | "textarea" | "checkbox" | "select";
+    required: boolean;
+    label: string;
+    name: string;
+    options?: {
+        value: string;
+        label: string;
+    }[] | undefined;
+    placeholder?: string | undefined;
+    pattern?: string | undefined;
+}, {
+    type: "text" | "textarea" | "checkbox" | "select";
+    required: boolean;
+    label: string;
+    name: string;
+    options?: {
+        value: string;
+        label: string;
+    }[] | undefined;
+    placeholder?: string | undefined;
+    pattern?: string | undefined;
+}>;
+export type ConsentCustomField = z.infer<typeof consentCustomFieldSchema>;
+/**
+ * Consent Page Config Schema
+ */
+export declare const consentPageConfigSchema: z.ZodObject<{
+    tool: z.ZodString;
+    toolDescription: z.ZodString;
+    scopes: z.ZodArray<z.ZodString, "many">;
+    agentDid: z.ZodString;
+    sessionId: z.ZodString;
+    projectId: z.ZodString;
+    branding: z.ZodOptional<z.ZodObject<{
+        primaryColor: z.ZodOptional<z.ZodString>;
+        logoUrl: z.ZodOptional<z.ZodString>;
+        companyName: z.ZodOptional<z.ZodString>;
+        theme: z.ZodOptional<z.ZodEnum<["light", "dark", "auto"]>>;
+    }, "strip", z.ZodTypeAny, {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    }, {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    }>>;
+    terms: z.ZodOptional<z.ZodObject<{
+        text: z.ZodOptional<z.ZodString>;
+        url: z.ZodOptional<z.ZodString>;
+        version: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        required: boolean;
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+    }, {
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+        required?: boolean | undefined;
+    }>>;
+    customFields: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
+        name: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<["text", "textarea", "checkbox", "select"]>;
+        required: z.ZodBoolean;
+        placeholder: z.ZodOptional<z.ZodString>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            label: string;
+        }, {
+            value: string;
+            label: string;
+        }>, "many">>;
+        pattern: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }, {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }>, {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }, {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }>, "many">>;
+    serverUrl: z.ZodString;
+    autoClose: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    tool: string;
+    toolDescription: string;
+    scopes: string[];
+    agentDid: string;
+    sessionId: string;
+    projectId: string;
+    serverUrl: string;
+    branding?: {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    } | undefined;
+    terms?: {
+        required: boolean;
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+    } | undefined;
+    customFields?: {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }[] | undefined;
+    autoClose?: boolean | undefined;
+}, {
+    tool: string;
+    toolDescription: string;
+    scopes: string[];
+    agentDid: string;
+    sessionId: string;
+    projectId: string;
+    serverUrl: string;
+    branding?: {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    } | undefined;
+    terms?: {
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+        required?: boolean | undefined;
+    } | undefined;
+    customFields?: {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }[] | undefined;
+    autoClose?: boolean | undefined;
+}>;
+export type ConsentPageConfig = z.infer<typeof consentPageConfigSchema>;
+/**
+ * Consent Approval Request Schema
+ *
+ * Note: Uses snake_case for API compatibility (agent_did, session_id, project_id)
+ */
+export declare const consentApprovalRequestSchema: z.ZodObject<{
+    tool: z.ZodString;
+    scopes: z.ZodArray<z.ZodString, "many">;
+    agent_did: z.ZodString;
+    session_id: z.ZodString;
+    project_id: z.ZodString;
+    termsAccepted: z.ZodBoolean;
+    termsVersion: z.ZodOptional<z.ZodString>;
+    customFields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodBoolean]>>>;
+}, "strip", z.ZodTypeAny, {
+    tool: string;
+    scopes: string[];
+    agent_did: string;
+    session_id: string;
+    project_id: string;
+    termsAccepted: boolean;
+    customFields?: Record<string, string | boolean> | undefined;
+    termsVersion?: string | undefined;
+}, {
+    tool: string;
+    scopes: string[];
+    agent_did: string;
+    session_id: string;
+    project_id: string;
+    termsAccepted: boolean;
+    customFields?: Record<string, string | boolean> | undefined;
+    termsVersion?: string | undefined;
+}>;
+export type ConsentApprovalRequest = z.infer<typeof consentApprovalRequestSchema>;
+/**
+ * Consent Approval Response Schema
+ */
+export declare const consentApprovalResponseSchema: z.ZodEffects<z.ZodObject<{
+    success: z.ZodBoolean;
+    delegation_id: z.ZodOptional<z.ZodString>;
+    delegation_token: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+    error_code: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    success: boolean;
+    delegation_id?: string | undefined;
+    delegation_token?: string | undefined;
+    error?: string | undefined;
+    error_code?: string | undefined;
+}, {
+    success: boolean;
+    delegation_id?: string | undefined;
+    delegation_token?: string | undefined;
+    error?: string | undefined;
+    error_code?: string | undefined;
+}>, {
+    success: boolean;
+    delegation_id?: string | undefined;
+    delegation_token?: string | undefined;
+    error?: string | undefined;
+    error_code?: string | undefined;
+}, {
+    success: boolean;
+    delegation_id?: string | undefined;
+    delegation_token?: string | undefined;
+    error?: string | undefined;
+    error_code?: string | undefined;
+}>;
+export type ConsentApprovalResponse = z.infer<typeof consentApprovalResponseSchema>;
+/**
+ * Consent Config Schema
+ */
+export declare const consentConfigSchema: z.ZodObject<{
+    branding: z.ZodOptional<z.ZodObject<{
+        primaryColor: z.ZodOptional<z.ZodString>;
+        logoUrl: z.ZodOptional<z.ZodString>;
+        companyName: z.ZodOptional<z.ZodString>;
+        theme: z.ZodOptional<z.ZodEnum<["light", "dark", "auto"]>>;
+    }, "strip", z.ZodTypeAny, {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    }, {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    }>>;
+    terms: z.ZodOptional<z.ZodObject<{
+        text: z.ZodOptional<z.ZodString>;
+        url: z.ZodOptional<z.ZodString>;
+        version: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        required: boolean;
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+    }, {
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+        required?: boolean | undefined;
+    }>>;
+    customFields: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodObject<{
+        name: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<["text", "textarea", "checkbox", "select"]>;
+        required: z.ZodBoolean;
+        placeholder: z.ZodOptional<z.ZodString>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodString;
+            label: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            label: string;
+        }, {
+            value: string;
+            label: string;
+        }>, "many">>;
+        pattern: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }, {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }>, {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }, {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }>, "many">>;
+    ui: z.ZodOptional<z.ZodObject<{
+        theme: z.ZodOptional<z.ZodEnum<["light", "dark", "auto"]>>;
+        popupEnabled: z.ZodOptional<z.ZodBoolean>;
+        autoClose: z.ZodOptional<z.ZodBoolean>;
+        autoCloseDelay: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        theme?: "light" | "dark" | "auto" | undefined;
+        autoClose?: boolean | undefined;
+        popupEnabled?: boolean | undefined;
+        autoCloseDelay?: number | undefined;
+    }, {
+        theme?: "light" | "dark" | "auto" | undefined;
+        autoClose?: boolean | undefined;
+        popupEnabled?: boolean | undefined;
+        autoCloseDelay?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    branding?: {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    } | undefined;
+    terms?: {
+        required: boolean;
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+    } | undefined;
+    customFields?: {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }[] | undefined;
+    ui?: {
+        theme?: "light" | "dark" | "auto" | undefined;
+        autoClose?: boolean | undefined;
+        popupEnabled?: boolean | undefined;
+        autoCloseDelay?: number | undefined;
+    } | undefined;
+}, {
+    branding?: {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    } | undefined;
+    terms?: {
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+        required?: boolean | undefined;
+    } | undefined;
+    customFields?: {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }[] | undefined;
+    ui?: {
+        theme?: "light" | "dark" | "auto" | undefined;
+        autoClose?: boolean | undefined;
+        popupEnabled?: boolean | undefined;
+        autoCloseDelay?: number | undefined;
+    } | undefined;
+}>;
+export type ConsentConfig = z.infer<typeof consentConfigSchema>;
+/**
+ * Validation Helpers
+ */
+/**
+ * Validate a consent page config
+ *
+ * @param config - The config to validate
+ * @returns Validation result
+ */
+export declare function validateConsentPageConfig(config: unknown): z.SafeParseReturnType<{
+    tool: string;
+    toolDescription: string;
+    scopes: string[];
+    agentDid: string;
+    sessionId: string;
+    projectId: string;
+    serverUrl: string;
+    branding?: {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    } | undefined;
+    terms?: {
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+        required?: boolean | undefined;
+    } | undefined;
+    customFields?: {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }[] | undefined;
+    autoClose?: boolean | undefined;
+}, {
+    tool: string;
+    toolDescription: string;
+    scopes: string[];
+    agentDid: string;
+    sessionId: string;
+    projectId: string;
+    serverUrl: string;
+    branding?: {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    } | undefined;
+    terms?: {
+        required: boolean;
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+    } | undefined;
+    customFields?: {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }[] | undefined;
+    autoClose?: boolean | undefined;
+}>;
+/**
+ * Validate a consent approval request
+ *
+ * @param request - The request to validate
+ * @returns Validation result
+ */
+export declare function validateConsentApprovalRequest(request: unknown): z.SafeParseReturnType<{
+    tool: string;
+    scopes: string[];
+    agent_did: string;
+    session_id: string;
+    project_id: string;
+    termsAccepted: boolean;
+    customFields?: Record<string, string | boolean> | undefined;
+    termsVersion?: string | undefined;
+}, {
+    tool: string;
+    scopes: string[];
+    agent_did: string;
+    session_id: string;
+    project_id: string;
+    termsAccepted: boolean;
+    customFields?: Record<string, string | boolean> | undefined;
+    termsVersion?: string | undefined;
+}>;
+/**
+ * Validate a consent approval response
+ *
+ * @param response - The response to validate
+ * @returns Validation result
+ */
+export declare function validateConsentApprovalResponse(response: unknown): z.SafeParseReturnType<{
+    success: boolean;
+    delegation_id?: string | undefined;
+    delegation_token?: string | undefined;
+    error?: string | undefined;
+    error_code?: string | undefined;
+}, {
+    success: boolean;
+    delegation_id?: string | undefined;
+    delegation_token?: string | undefined;
+    error?: string | undefined;
+    error_code?: string | undefined;
+}>;
+/**
+ * Validate a consent config
+ *
+ * @param config - The config to validate
+ * @returns Validation result
+ */
+export declare function validateConsentConfig(config: unknown): z.SafeParseReturnType<{
+    branding?: {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    } | undefined;
+    terms?: {
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+        required?: boolean | undefined;
+    } | undefined;
+    customFields?: {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }[] | undefined;
+    ui?: {
+        theme?: "light" | "dark" | "auto" | undefined;
+        autoClose?: boolean | undefined;
+        popupEnabled?: boolean | undefined;
+        autoCloseDelay?: number | undefined;
+    } | undefined;
+}, {
+    branding?: {
+        primaryColor?: string | undefined;
+        logoUrl?: string | undefined;
+        companyName?: string | undefined;
+        theme?: "light" | "dark" | "auto" | undefined;
+    } | undefined;
+    terms?: {
+        required: boolean;
+        text?: string | undefined;
+        url?: string | undefined;
+        version?: string | undefined;
+    } | undefined;
+    customFields?: {
+        type: "text" | "textarea" | "checkbox" | "select";
+        required: boolean;
+        label: string;
+        name: string;
+        options?: {
+            value: string;
+            label: string;
+        }[] | undefined;
+        placeholder?: string | undefined;
+        pattern?: string | undefined;
+    }[] | undefined;
+    ui?: {
+        theme?: "light" | "dark" | "auto" | undefined;
+        autoClose?: boolean | undefined;
+        popupEnabled?: boolean | undefined;
+        autoCloseDelay?: number | undefined;
+    } | undefined;
+}>;