@this-npm-test-org/sql-driver-sdk 0.1.0

package/dist/src/sql-connection-schemas.d.ts

@@ -0,0 +1,509 @@
+/**
+ * @license
+ * Copyright 2026 Amodal Labs, Inc.
+ * SPDX-License-Identifier: MIT
+ */
+/**
+ * Zod schemas validating connection config files for `protocol: 'sql'`
+ * connections. The inferred TS types match the type-level shapes in
+ * `@amodalai/types/sql-connection-types`; we don't redeclare them here
+ * — the schemas are the single source of truth for runtime validation,
+ * and the type-level contracts are the source for compile-time use.
+ */
+import { z } from 'zod';
+export declare const SqlConnectionConfigSchema: z.ZodEffects<z.ZodObject<{
+    protocol: z.ZodLiteral<"sql">;
+    dialect: z.ZodString;
+    driver: z.ZodString;
+    parser: z.ZodOptional<z.ZodString>;
+    connection: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        ssl: z.ZodOptional<z.ZodEnum<["require", "disable", "prefer"]>>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        ssl?: "require" | "disable" | "prefer" | undefined;
+    }, {
+        url: string;
+        ssl?: "require" | "disable" | "prefer" | undefined;
+    }>>;
+    mcp: z.ZodOptional<z.ZodObject<{
+        transport: z.ZodEnum<["stdio", "sse", "http"]>;
+        command: z.ZodOptional<z.ZodString>;
+        args: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        url: z.ZodOptional<z.ZodString>;
+        queryTool: z.ZodDefault<z.ZodString>;
+        schemaIntrospection: z.ZodOptional<z.ZodEnum<["resources", "informationSchema"]>>;
+    }, "strip", z.ZodTypeAny, {
+        transport: "stdio" | "sse" | "http";
+        queryTool: string;
+        url?: string | undefined;
+        command?: string | undefined;
+        args?: string[] | undefined;
+        schemaIntrospection?: "resources" | "informationSchema" | undefined;
+    }, {
+        transport: "stdio" | "sse" | "http";
+        url?: string | undefined;
+        command?: string | undefined;
+        args?: string[] | undefined;
+        queryTool?: string | undefined;
+        schemaIntrospection?: "resources" | "informationSchema" | undefined;
+    }>>;
+    pool: z.ZodOptional<z.ZodObject<{
+        max: z.ZodOptional<z.ZodNumber>;
+        idleTimeoutMs: z.ZodOptional<z.ZodNumber>;
+        statementTimeoutMs: z.ZodOptional<z.ZodNumber>;
+        acquireTimeoutMs: z.ZodOptional<z.ZodNumber>;
+        eagerInit: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        max?: number | undefined;
+        idleTimeoutMs?: number | undefined;
+        statementTimeoutMs?: number | undefined;
+        acquireTimeoutMs?: number | undefined;
+        eagerInit?: boolean | undefined;
+    }, {
+        max?: number | undefined;
+        idleTimeoutMs?: number | undefined;
+        statementTimeoutMs?: number | undefined;
+        acquireTimeoutMs?: number | undefined;
+        eagerInit?: boolean | undefined;
+    }>>;
+    scoping: z.ZodOptional<z.ZodObject<{
+        enforcement: z.ZodEnum<["verify", "rls", "inject"]>;
+        contextVars: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        enforcement: "verify" | "rls" | "inject";
+        contextVars: Record<string, string>;
+    }, {
+        enforcement: "verify" | "rls" | "inject";
+        contextVars: Record<string, string>;
+    }>>;
+    queryConstraints: z.ZodOptional<z.ZodObject<{
+        maxRows: z.ZodOptional<z.ZodNumber>;
+        forbidSelectStar: z.ZodOptional<z.ZodBoolean>;
+        forbidUnknownTables: z.ZodOptional<z.ZodBoolean>;
+        forbidUnknownColumns: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        maxRows?: number | undefined;
+        forbidSelectStar?: boolean | undefined;
+        forbidUnknownTables?: boolean | undefined;
+        forbidUnknownColumns?: boolean | undefined;
+    }, {
+        maxRows?: number | undefined;
+        forbidSelectStar?: boolean | undefined;
+        forbidUnknownTables?: boolean | undefined;
+        forbidUnknownColumns?: boolean | undefined;
+    }>>;
+    guidedQueries: z.ZodOptional<z.ZodString>;
+    audit: z.ZodOptional<z.ZodObject<{
+        logQueryText: z.ZodOptional<z.ZodBoolean>;
+        logRowCounts: z.ZodOptional<z.ZodBoolean>;
+        synchronousFlush: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        logQueryText?: boolean | undefined;
+        logRowCounts?: boolean | undefined;
+        synchronousFlush?: boolean | undefined;
+    }, {
+        logQueryText?: boolean | undefined;
+        logRowCounts?: boolean | undefined;
+        synchronousFlush?: boolean | undefined;
+    }>>;
+    schemaDriftPolicy: z.ZodOptional<z.ZodObject<{
+        addedColumnsOnPiiTables: z.ZodOptional<z.ZodEnum<["failLoad", "warn", "ignore"]>>;
+        addedColumnsOnNonPiiTables: z.ZodOptional<z.ZodEnum<["failLoad", "warn", "ignore"]>>;
+        removedColumnsReferencedInPolicy: z.ZodOptional<z.ZodEnum<["failLoad", "warn", "ignore"]>>;
+    }, "strip", z.ZodTypeAny, {
+        addedColumnsOnPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        addedColumnsOnNonPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        removedColumnsReferencedInPolicy?: "failLoad" | "warn" | "ignore" | undefined;
+    }, {
+        addedColumnsOnPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        addedColumnsOnNonPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        removedColumnsReferencedInPolicy?: "failLoad" | "warn" | "ignore" | undefined;
+    }>>;
+    weakerThresholdsAccepted: z.ZodOptional<z.ZodBoolean>;
+    schemaPath: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    driver: string;
+    protocol: "sql";
+    dialect: string;
+    schemaPath: string;
+    parser?: string | undefined;
+    connection?: {
+        url: string;
+        ssl?: "require" | "disable" | "prefer" | undefined;
+    } | undefined;
+    mcp?: {
+        transport: "stdio" | "sse" | "http";
+        queryTool: string;
+        url?: string | undefined;
+        command?: string | undefined;
+        args?: string[] | undefined;
+        schemaIntrospection?: "resources" | "informationSchema" | undefined;
+    } | undefined;
+    pool?: {
+        max?: number | undefined;
+        idleTimeoutMs?: number | undefined;
+        statementTimeoutMs?: number | undefined;
+        acquireTimeoutMs?: number | undefined;
+        eagerInit?: boolean | undefined;
+    } | undefined;
+    scoping?: {
+        enforcement: "verify" | "rls" | "inject";
+        contextVars: Record<string, string>;
+    } | undefined;
+    queryConstraints?: {
+        maxRows?: number | undefined;
+        forbidSelectStar?: boolean | undefined;
+        forbidUnknownTables?: boolean | undefined;
+        forbidUnknownColumns?: boolean | undefined;
+    } | undefined;
+    guidedQueries?: string | undefined;
+    audit?: {
+        logQueryText?: boolean | undefined;
+        logRowCounts?: boolean | undefined;
+        synchronousFlush?: boolean | undefined;
+    } | undefined;
+    schemaDriftPolicy?: {
+        addedColumnsOnPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        addedColumnsOnNonPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        removedColumnsReferencedInPolicy?: "failLoad" | "warn" | "ignore" | undefined;
+    } | undefined;
+    weakerThresholdsAccepted?: boolean | undefined;
+}, {
+    driver: string;
+    protocol: "sql";
+    dialect: string;
+    schemaPath: string;
+    parser?: string | undefined;
+    connection?: {
+        url: string;
+        ssl?: "require" | "disable" | "prefer" | undefined;
+    } | undefined;
+    mcp?: {
+        transport: "stdio" | "sse" | "http";
+        url?: string | undefined;
+        command?: string | undefined;
+        args?: string[] | undefined;
+        queryTool?: string | undefined;
+        schemaIntrospection?: "resources" | "informationSchema" | undefined;
+    } | undefined;
+    pool?: {
+        max?: number | undefined;
+        idleTimeoutMs?: number | undefined;
+        statementTimeoutMs?: number | undefined;
+        acquireTimeoutMs?: number | undefined;
+        eagerInit?: boolean | undefined;
+    } | undefined;
+    scoping?: {
+        enforcement: "verify" | "rls" | "inject";
+        contextVars: Record<string, string>;
+    } | undefined;
+    queryConstraints?: {
+        maxRows?: number | undefined;
+        forbidSelectStar?: boolean | undefined;
+        forbidUnknownTables?: boolean | undefined;
+        forbidUnknownColumns?: boolean | undefined;
+    } | undefined;
+    guidedQueries?: string | undefined;
+    audit?: {
+        logQueryText?: boolean | undefined;
+        logRowCounts?: boolean | undefined;
+        synchronousFlush?: boolean | undefined;
+    } | undefined;
+    schemaDriftPolicy?: {
+        addedColumnsOnPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        addedColumnsOnNonPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        removedColumnsReferencedInPolicy?: "failLoad" | "warn" | "ignore" | undefined;
+    } | undefined;
+    weakerThresholdsAccepted?: boolean | undefined;
+}>, {
+    driver: string;
+    protocol: "sql";
+    dialect: string;
+    schemaPath: string;
+    parser?: string | undefined;
+    connection?: {
+        url: string;
+        ssl?: "require" | "disable" | "prefer" | undefined;
+    } | undefined;
+    mcp?: {
+        transport: "stdio" | "sse" | "http";
+        queryTool: string;
+        url?: string | undefined;
+        command?: string | undefined;
+        args?: string[] | undefined;
+        schemaIntrospection?: "resources" | "informationSchema" | undefined;
+    } | undefined;
+    pool?: {
+        max?: number | undefined;
+        idleTimeoutMs?: number | undefined;
+        statementTimeoutMs?: number | undefined;
+        acquireTimeoutMs?: number | undefined;
+        eagerInit?: boolean | undefined;
+    } | undefined;
+    scoping?: {
+        enforcement: "verify" | "rls" | "inject";
+        contextVars: Record<string, string>;
+    } | undefined;
+    queryConstraints?: {
+        maxRows?: number | undefined;
+        forbidSelectStar?: boolean | undefined;
+        forbidUnknownTables?: boolean | undefined;
+        forbidUnknownColumns?: boolean | undefined;
+    } | undefined;
+    guidedQueries?: string | undefined;
+    audit?: {
+        logQueryText?: boolean | undefined;
+        logRowCounts?: boolean | undefined;
+        synchronousFlush?: boolean | undefined;
+    } | undefined;
+    schemaDriftPolicy?: {
+        addedColumnsOnPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        addedColumnsOnNonPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        removedColumnsReferencedInPolicy?: "failLoad" | "warn" | "ignore" | undefined;
+    } | undefined;
+    weakerThresholdsAccepted?: boolean | undefined;
+}, {
+    driver: string;
+    protocol: "sql";
+    dialect: string;
+    schemaPath: string;
+    parser?: string | undefined;
+    connection?: {
+        url: string;
+        ssl?: "require" | "disable" | "prefer" | undefined;
+    } | undefined;
+    mcp?: {
+        transport: "stdio" | "sse" | "http";
+        url?: string | undefined;
+        command?: string | undefined;
+        args?: string[] | undefined;
+        queryTool?: string | undefined;
+        schemaIntrospection?: "resources" | "informationSchema" | undefined;
+    } | undefined;
+    pool?: {
+        max?: number | undefined;
+        idleTimeoutMs?: number | undefined;
+        statementTimeoutMs?: number | undefined;
+        acquireTimeoutMs?: number | undefined;
+        eagerInit?: boolean | undefined;
+    } | undefined;
+    scoping?: {
+        enforcement: "verify" | "rls" | "inject";
+        contextVars: Record<string, string>;
+    } | undefined;
+    queryConstraints?: {
+        maxRows?: number | undefined;
+        forbidSelectStar?: boolean | undefined;
+        forbidUnknownTables?: boolean | undefined;
+        forbidUnknownColumns?: boolean | undefined;
+    } | undefined;
+    guidedQueries?: string | undefined;
+    audit?: {
+        logQueryText?: boolean | undefined;
+        logRowCounts?: boolean | undefined;
+        synchronousFlush?: boolean | undefined;
+    } | undefined;
+    schemaDriftPolicy?: {
+        addedColumnsOnPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        addedColumnsOnNonPiiTables?: "failLoad" | "warn" | "ignore" | undefined;
+        removedColumnsReferencedInPolicy?: "failLoad" | "warn" | "ignore" | undefined;
+    } | undefined;
+    weakerThresholdsAccepted?: boolean | undefined;
+}>;
+export type SqlConnectionConfig = z.infer<typeof SqlConnectionConfigSchema>;
+export declare const SchemaJsonSchema: z.ZodEffects<z.ZodObject<{
+    tables: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
+        access: z.ZodEnum<["read", "readWrite", "denied"]>;
+        scoping: z.ZodOptional<z.ZodObject<{
+            column: z.ZodString;
+            boundFrom: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            column: string;
+            boundFrom: string;
+        }, {
+            column: string;
+            boundFrom: string;
+        }>>;
+        sensitivity: z.ZodOptional<z.ZodEnum<["pii", "phi", "pci", "internal"]>>;
+        columns: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
+            policy: z.ZodEnum<["allow", "redact", "roleGated", "neverRetrieve"]>;
+            sensitivity: z.ZodOptional<z.ZodString>;
+            allowedRoles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }>, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }>>>;
+        writeThresholds: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            operation: z.ZodEnum<["update", "delete", "insert", "merge"]>;
+            above: z.ZodNumber;
+            escalate: z.ZodEnum<["review", "block", "never"]>;
+        }, "strip", z.ZodTypeAny, {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }, {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        access: "read" | "readWrite" | "denied";
+        scoping?: {
+            column: string;
+            boundFrom: string;
+        } | undefined;
+        sensitivity?: "pii" | "phi" | "pci" | "internal" | undefined;
+        columns?: Record<string, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }> | undefined;
+        writeThresholds?: {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }[] | undefined;
+    }, {
+        access: "read" | "readWrite" | "denied";
+        scoping?: {
+            column: string;
+            boundFrom: string;
+        } | undefined;
+        sensitivity?: "pii" | "phi" | "pci" | "internal" | undefined;
+        columns?: Record<string, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }> | undefined;
+        writeThresholds?: {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }[] | undefined;
+    }>, {
+        access: "read" | "readWrite" | "denied";
+        scoping?: {
+            column: string;
+            boundFrom: string;
+        } | undefined;
+        sensitivity?: "pii" | "phi" | "pci" | "internal" | undefined;
+        columns?: Record<string, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }> | undefined;
+        writeThresholds?: {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }[] | undefined;
+    }, {
+        access: "read" | "readWrite" | "denied";
+        scoping?: {
+            column: string;
+            boundFrom: string;
+        } | undefined;
+        sensitivity?: "pii" | "phi" | "pci" | "internal" | undefined;
+        columns?: Record<string, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }> | undefined;
+        writeThresholds?: {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }[] | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    tables: Record<string, {
+        access: "read" | "readWrite" | "denied";
+        scoping?: {
+            column: string;
+            boundFrom: string;
+        } | undefined;
+        sensitivity?: "pii" | "phi" | "pci" | "internal" | undefined;
+        columns?: Record<string, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }> | undefined;
+        writeThresholds?: {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }[] | undefined;
+    }>;
+}, {
+    tables: Record<string, {
+        access: "read" | "readWrite" | "denied";
+        scoping?: {
+            column: string;
+            boundFrom: string;
+        } | undefined;
+        sensitivity?: "pii" | "phi" | "pci" | "internal" | undefined;
+        columns?: Record<string, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }> | undefined;
+        writeThresholds?: {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }[] | undefined;
+    }>;
+}>, {
+    tables: Record<string, {
+        access: "read" | "readWrite" | "denied";
+        scoping?: {
+            column: string;
+            boundFrom: string;
+        } | undefined;
+        sensitivity?: "pii" | "phi" | "pci" | "internal" | undefined;
+        columns?: Record<string, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }> | undefined;
+        writeThresholds?: {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }[] | undefined;
+    }>;
+}, {
+    tables: Record<string, {
+        access: "read" | "readWrite" | "denied";
+        scoping?: {
+            column: string;
+            boundFrom: string;
+        } | undefined;
+        sensitivity?: "pii" | "phi" | "pci" | "internal" | undefined;
+        columns?: Record<string, {
+            policy: "allow" | "redact" | "roleGated" | "neverRetrieve";
+            sensitivity?: string | undefined;
+            allowedRoles?: string[] | undefined;
+        }> | undefined;
+        writeThresholds?: {
+            operation: "update" | "delete" | "insert" | "merge";
+            above: number;
+            escalate: "never" | "review" | "block";
+        }[] | undefined;
+    }>;
+}>;
+export type SchemaJson = z.infer<typeof SchemaJsonSchema>;