@criticalbridge/brain-client 1.0.0

package/dist/types/harvest.types.d.ts

@@ -0,0 +1,662 @@
+import { z } from 'zod';
+export declare const HarvestJobStatusSchema: z.ZodEnum<["pending", "running", "completed", "failed", "cancelled"]>;
+export type HarvestJobStatus = z.infer<typeof HarvestJobStatusSchema>;
+export declare const HarvestJobProgressSchema: z.ZodObject<{
+    bytes: z.ZodDefault<z.ZodNumber>;
+    docs: z.ZodDefault<z.ZodNumber>;
+    chunks: z.ZodDefault<z.ZodNumber>;
+    entities: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    bytes: number;
+    docs: number;
+    chunks: number;
+    entities: number;
+}, {
+    bytes?: number | undefined;
+    docs?: number | undefined;
+    chunks?: number | undefined;
+    entities?: number | undefined;
+}>;
+export type HarvestJobProgress = z.infer<typeof HarvestJobProgressSchema>;
+export declare const HarvestScopeSchema: z.ZodObject<{
+    productIds: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    jurisdictions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    wave: z.ZodString;
+    sourceFilter: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    productIds: string[];
+    jurisdictions: string[];
+    wave: string;
+    sourceFilter?: string | undefined;
+}, {
+    wave: string;
+    productIds?: string[] | undefined;
+    jurisdictions?: string[] | undefined;
+    sourceFilter?: string | undefined;
+}>;
+export type HarvestScope = z.infer<typeof HarvestScopeSchema>;
+export declare const HarvestJobSchema: z.ZodObject<{
+    id: z.ZodString;
+    entityId: z.ZodString;
+    scope: z.ZodObject<{
+        productIds: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+        jurisdictions: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+        wave: z.ZodString;
+        sourceFilter: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        productIds: string[];
+        jurisdictions: string[];
+        wave: string;
+        sourceFilter?: string | undefined;
+    }, {
+        wave: string;
+        productIds?: string[] | undefined;
+        jurisdictions?: string[] | undefined;
+        sourceFilter?: string | undefined;
+    }>;
+    status: z.ZodEnum<["pending", "running", "completed", "failed", "cancelled"]>;
+    connectorManifest: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodString;
+        version: z.ZodString;
+        type: z.ZodString;
+        secrets: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodString;
+            where: z.ZodEnum<["vault", "env", "config"]>;
+            required: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            description: string;
+            where: "vault" | "env" | "config";
+            required: boolean;
+        }, {
+            name: string;
+            description: string;
+            where: "vault" | "env" | "config";
+            required?: boolean | undefined;
+        }>, "many">>;
+        health_checks: z.ZodObject<{
+            any_of: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                description: z.ZodOptional<z.ZodString>;
+                type: z.ZodEnum<["http", "tcp", "auth", "query", "custom"]>;
+                target: z.ZodOptional<z.ZodString>;
+                timeoutMs: z.ZodDefault<z.ZodNumber>;
+                expectedStatus: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                name: string;
+                type: "custom" | "query" | "http" | "tcp" | "auth";
+                timeoutMs: number;
+                description?: string | undefined;
+                target?: string | undefined;
+                expectedStatus?: number | undefined;
+            }, {
+                id: string;
+                name: string;
+                type: "custom" | "query" | "http" | "tcp" | "auth";
+                description?: string | undefined;
+                target?: string | undefined;
+                timeoutMs?: number | undefined;
+                expectedStatus?: number | undefined;
+            }>, "many">;
+            intervalMs: z.ZodDefault<z.ZodNumber>;
+            failureThreshold: z.ZodDefault<z.ZodNumber>;
+            successThreshold: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            any_of: {
+                id: string;
+                name: string;
+                type: "custom" | "query" | "http" | "tcp" | "auth";
+                timeoutMs: number;
+                description?: string | undefined;
+                target?: string | undefined;
+                expectedStatus?: number | undefined;
+            }[];
+            intervalMs: number;
+            failureThreshold: number;
+            successThreshold: number;
+        }, {
+            any_of: {
+                id: string;
+                name: string;
+                type: "custom" | "query" | "http" | "tcp" | "auth";
+                description?: string | undefined;
+                target?: string | undefined;
+                timeoutMs?: number | undefined;
+                expectedStatus?: number | undefined;
+            }[];
+            intervalMs?: number | undefined;
+            failureThreshold?: number | undefined;
+            successThreshold?: number | undefined;
+        }>;
+        setup_time: z.ZodEffects<z.ZodObject<{
+            minMinutes: z.ZodNumber;
+            maxMinutes: z.ZodNumber;
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            minMinutes: number;
+            maxMinutes: number;
+            description?: string | undefined;
+        }, {
+            minMinutes: number;
+            maxMinutes: number;
+            description?: string | undefined;
+        }>, {
+            minMinutes: number;
+            maxMinutes: number;
+            description?: string | undefined;
+        }, {
+            minMinutes: number;
+            maxMinutes: number;
+            description?: string | undefined;
+        }>;
+        cost_estimate: z.ZodObject<{
+            tier: z.ZodEnum<["free", "low", "medium", "high", "enterprise"]>;
+            perRequestCost: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+            monthlyEstimateUsd: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            tier: "low" | "medium" | "high" | "free" | "enterprise";
+            perRequestCost: boolean;
+            description?: string | undefined;
+            monthlyEstimateUsd?: number | undefined;
+        }, {
+            tier: "low" | "medium" | "high" | "free" | "enterprise";
+            description?: string | undefined;
+            perRequestCost?: boolean | undefined;
+            monthlyEstimateUsd?: number | undefined;
+        }>;
+        baseUrl: z.ZodOptional<z.ZodString>;
+        vaultRef: z.ZodOptional<z.ZodString>;
+        oauth: z.ZodOptional<z.ZodObject<{
+            flowType: z.ZodEnum<["authorization_code", "client_credentials", "refresh_token"]>;
+            authorizationUrl: z.ZodOptional<z.ZodString>;
+            tokenUrl: z.ZodString;
+            scopes: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            pkceRequired: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            flowType: "authorization_code" | "client_credentials" | "refresh_token";
+            tokenUrl: string;
+            scopes: string[];
+            pkceRequired: boolean;
+            authorizationUrl?: string | undefined;
+        }, {
+            flowType: "authorization_code" | "client_credentials" | "refresh_token";
+            tokenUrl: string;
+            authorizationUrl?: string | undefined;
+            scopes?: string[] | undefined;
+            pkceRequired?: boolean | undefined;
+        }>>;
+        polling: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            interval: z.ZodOptional<z.ZodString>;
+            intervalMs: z.ZodOptional<z.ZodNumber>;
+            maxItemsPerPoll: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+            maxItemsPerPoll: number;
+            intervalMs?: number | undefined;
+            interval?: string | undefined;
+        }, {
+            enabled?: boolean | undefined;
+            intervalMs?: number | undefined;
+            interval?: string | undefined;
+            maxItemsPerPoll?: number | undefined;
+        }>>;
+        webhook: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            path: z.ZodOptional<z.ZodString>;
+            signatureMethod: z.ZodOptional<z.ZodEnum<["hmac-sha256", "hmac-sha1", "rsa-sha256", "none"]>>;
+            signatureHeader: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+            path?: string | undefined;
+            signatureMethod?: "none" | "hmac-sha256" | "hmac-sha1" | "rsa-sha256" | undefined;
+            signatureHeader?: string | undefined;
+        }, {
+            enabled?: boolean | undefined;
+            path?: string | undefined;
+            signatureMethod?: "none" | "hmac-sha256" | "hmac-sha1" | "rsa-sha256" | undefined;
+            signatureHeader?: string | undefined;
+        }>>;
+        entityScope: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+        supportedFormats: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+        trustTier: z.ZodDefault<z.ZodEnum<["untrusted", "verified", "trusted", "internal"]>>;
+        pii: z.ZodOptional<z.ZodObject<{
+            redact: z.ZodDefault<z.ZodBoolean>;
+            alwaysRedactFields: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+            detectionStrategy: z.ZodDefault<z.ZodEnum<["presidio", "regex", "custom", "none"]>>;
+        }, "strip", z.ZodTypeAny, {
+            redact: boolean;
+            alwaysRedactFields: string[];
+            detectionStrategy: "none" | "custom" | "presidio" | "regex";
+        }, {
+            redact?: boolean | undefined;
+            alwaysRedactFields?: string[] | undefined;
+            detectionStrategy?: "none" | "custom" | "presidio" | "regex" | undefined;
+        }>>;
+        entityId: z.ZodOptional<z.ZodString>;
+        author: z.ZodOptional<z.ZodString>;
+        documentationUrl: z.ZodOptional<z.ZodString>;
+        tags: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        createdAt: z.ZodOptional<z.ZodDate>;
+        updatedAt: z.ZodOptional<z.ZodDate>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        description: string;
+        type: string;
+        version: string;
+        tags: string[];
+        enabled: boolean;
+        secrets: {
+            name: string;
+            description: string;
+            where: "vault" | "env" | "config";
+            required: boolean;
+        }[];
+        health_checks: {
+            any_of: {
+                id: string;
+                name: string;
+                type: "custom" | "query" | "http" | "tcp" | "auth";
+                timeoutMs: number;
+                description?: string | undefined;
+                target?: string | undefined;
+                expectedStatus?: number | undefined;
+            }[];
+            intervalMs: number;
+            failureThreshold: number;
+            successThreshold: number;
+        };
+        setup_time: {
+            minMinutes: number;
+            maxMinutes: number;
+            description?: string | undefined;
+        };
+        cost_estimate: {
+            tier: "low" | "medium" | "high" | "free" | "enterprise";
+            perRequestCost: boolean;
+            description?: string | undefined;
+            monthlyEstimateUsd?: number | undefined;
+        };
+        entityScope: string[];
+        supportedFormats: string[];
+        trustTier: "internal" | "untrusted" | "verified" | "trusted";
+        entityId?: string | undefined;
+        createdAt?: Date | undefined;
+        updatedAt?: Date | undefined;
+        baseUrl?: string | undefined;
+        vaultRef?: string | undefined;
+        oauth?: {
+            flowType: "authorization_code" | "client_credentials" | "refresh_token";
+            tokenUrl: string;
+            scopes: string[];
+            pkceRequired: boolean;
+            authorizationUrl?: string | undefined;
+        } | undefined;
+        polling?: {
+            enabled: boolean;
+            maxItemsPerPoll: number;
+            intervalMs?: number | undefined;
+            interval?: string | undefined;
+        } | undefined;
+        webhook?: {
+            enabled: boolean;
+            path?: string | undefined;
+            signatureMethod?: "none" | "hmac-sha256" | "hmac-sha1" | "rsa-sha256" | undefined;
+            signatureHeader?: string | undefined;
+        } | undefined;
+        pii?: {
+            redact: boolean;
+            alwaysRedactFields: string[];
+            detectionStrategy: "none" | "custom" | "presidio" | "regex";
+        } | undefined;
+        author?: string | undefined;
+        documentationUrl?: string | undefined;
+    }, {
+        id: string;
+        name: string;
+        description: string;
+        type: string;
+        version: string;
+        health_checks: {
+            any_of: {
+                id: string;
+                name: string;
+                type: "custom" | "query" | "http" | "tcp" | "auth";
+                description?: string | undefined;
+                target?: string | undefined;
+                timeoutMs?: number | undefined;
+                expectedStatus?: number | undefined;
+            }[];
+            intervalMs?: number | undefined;
+            failureThreshold?: number | undefined;
+            successThreshold?: number | undefined;
+        };
+        setup_time: {
+            minMinutes: number;
+            maxMinutes: number;
+            description?: string | undefined;
+        };
+        cost_estimate: {
+            tier: "low" | "medium" | "high" | "free" | "enterprise";
+            description?: string | undefined;
+            perRequestCost?: boolean | undefined;
+            monthlyEstimateUsd?: number | undefined;
+        };
+        entityId?: string | undefined;
+        createdAt?: Date | undefined;
+        tags?: string[] | undefined;
+        enabled?: boolean | undefined;
+        updatedAt?: Date | undefined;
+        baseUrl?: string | undefined;
+        secrets?: {
+            name: string;
+            description: string;
+            where: "vault" | "env" | "config";
+            required?: boolean | undefined;
+        }[] | undefined;
+        vaultRef?: string | undefined;
+        oauth?: {
+            flowType: "authorization_code" | "client_credentials" | "refresh_token";
+            tokenUrl: string;
+            authorizationUrl?: string | undefined;
+            scopes?: string[] | undefined;
+            pkceRequired?: boolean | undefined;
+        } | undefined;
+        polling?: {
+            enabled?: boolean | undefined;
+            intervalMs?: number | undefined;
+            interval?: string | undefined;
+            maxItemsPerPoll?: number | undefined;
+        } | undefined;
+        webhook?: {
+            enabled?: boolean | undefined;
+            path?: string | undefined;
+            signatureMethod?: "none" | "hmac-sha256" | "hmac-sha1" | "rsa-sha256" | undefined;
+            signatureHeader?: string | undefined;
+        } | undefined;
+        entityScope?: string[] | undefined;
+        supportedFormats?: string[] | undefined;
+        trustTier?: "internal" | "untrusted" | "verified" | "trusted" | undefined;
+        pii?: {
+            redact?: boolean | undefined;
+            alwaysRedactFields?: string[] | undefined;
+            detectionStrategy?: "none" | "custom" | "presidio" | "regex" | undefined;
+        } | undefined;
+        author?: string | undefined;
+        documentationUrl?: string | undefined;
+    }>;
+    progress: z.ZodObject<{
+        bytes: z.ZodDefault<z.ZodNumber>;
+        docs: z.ZodDefault<z.ZodNumber>;
+        chunks: z.ZodDefault<z.ZodNumber>;
+        entities: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        bytes: number;
+        docs: number;
+        chunks: number;
+        entities: number;
+    }, {
+        bytes?: number | undefined;
+        docs?: number | undefined;
+        chunks?: number | undefined;
+        entities?: number | undefined;
+    }>;
+    createdAt: z.ZodDate;
+    updatedAt: z.ZodDate;
+    startedAt: z.ZodOptional<z.ZodDate>;
+    completedAt: z.ZodOptional<z.ZodDate>;
+    errorMessage: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    entityId: string;
+    createdAt: Date;
+    status: "pending" | "failed" | "running" | "completed" | "cancelled";
+    updatedAt: Date;
+    scope: {
+        productIds: string[];
+        jurisdictions: string[];
+        wave: string;
+        sourceFilter?: string | undefined;
+    };
+    connectorManifest: {
+        id: string;
+        name: string;
+        description: string;
+        type: string;
+        version: string;
+        tags: string[];
+        enabled: boolean;
+        secrets: {
+            name: string;
+            description: string;
+            where: "vault" | "env" | "config";
+            required: boolean;
+        }[];
+        health_checks: {
+            any_of: {
+                id: string;
+                name: string;
+                type: "custom" | "query" | "http" | "tcp" | "auth";
+                timeoutMs: number;
+                description?: string | undefined;
+                target?: string | undefined;
+                expectedStatus?: number | undefined;
+            }[];
+            intervalMs: number;
+            failureThreshold: number;
+            successThreshold: number;
+        };
+        setup_time: {
+            minMinutes: number;
+            maxMinutes: number;
+            description?: string | undefined;
+        };
+        cost_estimate: {
+            tier: "low" | "medium" | "high" | "free" | "enterprise";
+            perRequestCost: boolean;
+            description?: string | undefined;
+            monthlyEstimateUsd?: number | undefined;
+        };
+        entityScope: string[];
+        supportedFormats: string[];
+        trustTier: "internal" | "untrusted" | "verified" | "trusted";
+        entityId?: string | undefined;
+        createdAt?: Date | undefined;
+        updatedAt?: Date | undefined;
+        baseUrl?: string | undefined;
+        vaultRef?: string | undefined;
+        oauth?: {
+            flowType: "authorization_code" | "client_credentials" | "refresh_token";
+            tokenUrl: string;
+            scopes: string[];
+            pkceRequired: boolean;
+            authorizationUrl?: string | undefined;
+        } | undefined;
+        polling?: {
+            enabled: boolean;
+            maxItemsPerPoll: number;
+            intervalMs?: number | undefined;
+            interval?: string | undefined;
+        } | undefined;
+        webhook?: {
+            enabled: boolean;
+            path?: string | undefined;
+            signatureMethod?: "none" | "hmac-sha256" | "hmac-sha1" | "rsa-sha256" | undefined;
+            signatureHeader?: string | undefined;
+        } | undefined;
+        pii?: {
+            redact: boolean;
+            alwaysRedactFields: string[];
+            detectionStrategy: "none" | "custom" | "presidio" | "regex";
+        } | undefined;
+        author?: string | undefined;
+        documentationUrl?: string | undefined;
+    };
+    progress: {
+        bytes: number;
+        docs: number;
+        chunks: number;
+        entities: number;
+    };
+    startedAt?: Date | undefined;
+    completedAt?: Date | undefined;
+    errorMessage?: string | undefined;
+}, {
+    id: string;
+    entityId: string;
+    createdAt: Date;
+    status: "pending" | "failed" | "running" | "completed" | "cancelled";
+    updatedAt: Date;
+    scope: {
+        wave: string;
+        productIds?: string[] | undefined;
+        jurisdictions?: string[] | undefined;
+        sourceFilter?: string | undefined;
+    };
+    connectorManifest: {
+        id: string;
+        name: string;
+        description: string;
+        type: string;
+        version: string;
+        health_checks: {
+            any_of: {
+                id: string;
+                name: string;
+                type: "custom" | "query" | "http" | "tcp" | "auth";
+                description?: string | undefined;
+                target?: string | undefined;
+                timeoutMs?: number | undefined;
+                expectedStatus?: number | undefined;
+            }[];
+            intervalMs?: number | undefined;
+            failureThreshold?: number | undefined;
+            successThreshold?: number | undefined;
+        };
+        setup_time: {
+            minMinutes: number;
+            maxMinutes: number;
+            description?: string | undefined;
+        };
+        cost_estimate: {
+            tier: "low" | "medium" | "high" | "free" | "enterprise";
+            description?: string | undefined;
+            perRequestCost?: boolean | undefined;
+            monthlyEstimateUsd?: number | undefined;
+        };
+        entityId?: string | undefined;
+        createdAt?: Date | undefined;
+        tags?: string[] | undefined;
+        enabled?: boolean | undefined;
+        updatedAt?: Date | undefined;
+        baseUrl?: string | undefined;
+        secrets?: {
+            name: string;
+            description: string;
+            where: "vault" | "env" | "config";
+            required?: boolean | undefined;
+        }[] | undefined;
+        vaultRef?: string | undefined;
+        oauth?: {
+            flowType: "authorization_code" | "client_credentials" | "refresh_token";
+            tokenUrl: string;
+            authorizationUrl?: string | undefined;
+            scopes?: string[] | undefined;
+            pkceRequired?: boolean | undefined;
+        } | undefined;
+        polling?: {
+            enabled?: boolean | undefined;
+            intervalMs?: number | undefined;
+            interval?: string | undefined;
+            maxItemsPerPoll?: number | undefined;
+        } | undefined;
+        webhook?: {
+            enabled?: boolean | undefined;
+            path?: string | undefined;
+            signatureMethod?: "none" | "hmac-sha256" | "hmac-sha1" | "rsa-sha256" | undefined;
+            signatureHeader?: string | undefined;
+        } | undefined;
+        entityScope?: string[] | undefined;
+        supportedFormats?: string[] | undefined;
+        trustTier?: "internal" | "untrusted" | "verified" | "trusted" | undefined;
+        pii?: {
+            redact?: boolean | undefined;
+            alwaysRedactFields?: string[] | undefined;
+            detectionStrategy?: "none" | "custom" | "presidio" | "regex" | undefined;
+        } | undefined;
+        author?: string | undefined;
+        documentationUrl?: string | undefined;
+    };
+    progress: {
+        bytes?: number | undefined;
+        docs?: number | undefined;
+        chunks?: number | undefined;
+        entities?: number | undefined;
+    };
+    startedAt?: Date | undefined;
+    completedAt?: Date | undefined;
+    errorMessage?: string | undefined;
+}>;
+export type HarvestJob = z.infer<typeof HarvestJobSchema>;
+export declare const HarvestJobEventSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"progress">;
+    progress: z.ZodObject<{
+        bytes: z.ZodDefault<z.ZodNumber>;
+        docs: z.ZodDefault<z.ZodNumber>;
+        chunks: z.ZodDefault<z.ZodNumber>;
+        entities: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        bytes: number;
+        docs: number;
+        chunks: number;
+        entities: number;
+    }, {
+        bytes?: number | undefined;
+        docs?: number | undefined;
+        chunks?: number | undefined;
+        entities?: number | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "progress";
+    progress: {
+        bytes: number;
+        docs: number;
+        chunks: number;
+        entities: number;
+    };
+}, {
+    type: "progress";
+    progress: {
+        bytes?: number | undefined;
+        docs?: number | undefined;
+        chunks?: number | undefined;
+        entities?: number | undefined;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"status">;
+    status: z.ZodEnum<["pending", "running", "completed", "failed", "cancelled"]>;
+}, "strip", z.ZodTypeAny, {
+    type: "status";
+    status: "pending" | "failed" | "running" | "completed" | "cancelled";
+}, {
+    type: "status";
+    status: "pending" | "failed" | "running" | "completed" | "cancelled";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"error">;
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "error";
+    message: string;
+}, {
+    type: "error";
+    message: string;
+}>]>;
+export type HarvestJobEvent = z.infer<typeof HarvestJobEventSchema>;