@sequenceholdings/orm 0.1.1 → 0.1.2

package/dist/canonical.d.cts

@@ -0,0 +1,369 @@
+import { z } from 'zod';
+
+/**
+ * Canonical namespace definition v2 — the data-only JSON a consumer's
+ * TypeScript schema serializes to. This is v2's equivalent of the v1 YAML
+ * `NamespaceDefinition`: the CLI's jiti loader produces it, the content hash
+ * is computed over it, the server re-validates it (consumer TS never runs
+ * server-side), and the SDL generator / GraphQL compiler / migration engine
+ * all consume it.
+ *
+ * FROZEN CONTRACT (week 1): downstream tracks build against these shapes.
+ * Additive evolution only; `definition_format` discriminates on the wire.
+ */
+
+declare const CANONICAL_FORMAT: 2;
+/** Identifier grammar shared with v1 (`^[a-z][a-z0-9_]*$`, ≤63 bytes). */
+declare const IDENTIFIER_RE: RegExp;
+/** The 10 v1 column types, unchanged in v2. */
+declare const COLUMN_TYPES: readonly ["uuid", "text", "integer", "bigint", "numeric", "double", "boolean", "timestamptz", "date", "jsonb"];
+type ColumnType = (typeof COLUMN_TYPES)[number];
+/** Enum columns reference a namespace-level `defineEnum` by name. */
+declare const canonicalEnumSchema: z.ZodObject<{
+    name: z.ZodString;
+    values: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+type CanonicalEnum = z.infer<typeof canonicalEnumSchema>;
+declare const canonicalColumnSchema: z.ZodObject<{
+    name: z.ZodString;
+    columnName: z.ZodString;
+    type: z.ZodUnion<readonly [z.ZodEnum<{
+        bigint: "bigint";
+        boolean: "boolean";
+        uuid: "uuid";
+        text: "text";
+        integer: "integer";
+        numeric: "numeric";
+        double: "double";
+        timestamptz: "timestamptz";
+        date: "date";
+        jsonb: "jsonb";
+    }>, z.ZodObject<{
+        enum: z.ZodString;
+    }, z.core.$strip>]>;
+    nullable: z.ZodDefault<z.ZodBoolean>;
+    unique: z.ZodDefault<z.ZodBoolean>;
+    default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
+    defaultFn: z.ZodOptional<z.ZodEnum<{
+        "gen_random_uuid()": "gen_random_uuid()";
+        "now()": "now()";
+    }>>;
+    description: z.ZodOptional<z.ZodString>;
+    renamedFrom: z.ZodOptional<z.ZodString>;
+    cast: z.ZodOptional<z.ZodString>;
+    deprecated: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+type CanonicalColumn = z.infer<typeof canonicalColumnSchema>;
+declare const canonicalLinkSchema: z.ZodObject<{
+    name: z.ZodString;
+    kind: z.ZodEnum<{
+        toOne: "toOne";
+        toMany: "toMany";
+        toPlatformUser: "toPlatformUser";
+    }>;
+    target: z.ZodOptional<z.ZodString>;
+    on: z.ZodString;
+    references: z.ZodOptional<z.ZodString>;
+    enforce: z.ZodDefault<z.ZodBoolean>;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type CanonicalLink = z.infer<typeof canonicalLinkSchema>;
+declare const canonicalIndexSchema: z.ZodObject<{
+    columns: z.ZodArray<z.ZodString>;
+    unique: z.ZodDefault<z.ZodBoolean>;
+    name: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Policy expressions stay DSL SOURCE STRINGS in the canonical form — parsing
+ * and claim-key validation happen in both CLI and server via the shared
+ * predicate parser. Variants follow §4c permissive-union semantics.
+ */
+declare const policyVariantSchema: z.ZodObject<{
+    when: z.ZodString;
+    allow: z.ZodOptional<z.ZodLiteral<true>>;
+    policy: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const policyExpressionSchema: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+    default: z.ZodString;
+    variants: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        when: z.ZodString;
+        allow: z.ZodOptional<z.ZodLiteral<true>>;
+        policy: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>]>;
+type PolicyExpression = z.infer<typeof policyExpressionSchema>;
+declare const canonicalPoliciesSchema: z.ZodObject<{
+    read: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        default: z.ZodString;
+        variants: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            when: z.ZodString;
+            allow: z.ZodOptional<z.ZodLiteral<true>>;
+            policy: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>]>>;
+    write: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        default: z.ZodString;
+        variants: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            when: z.ZodString;
+            allow: z.ZodOptional<z.ZodLiteral<true>>;
+            policy: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>]>>;
+}, z.core.$strip>;
+/** Actions carry over from v1 as compiled named-SQL ops (plan: resolved OQ-1). */
+declare const canonicalActionSchema: z.ZodObject<{
+    name: z.ZodString;
+    requires: z.ZodOptional<z.ZodString>;
+    params: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        type: z.ZodEnum<{
+            bigint: "bigint";
+            boolean: "boolean";
+            uuid: "uuid";
+            text: "text";
+            integer: "integer";
+            numeric: "numeric";
+            double: "double";
+            timestamptz: "timestamptz";
+            date: "date";
+            jsonb: "jsonb";
+        }>;
+        nullable: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    executes: z.ZodString;
+    returns: z.ZodDefault<z.ZodEnum<{
+        rows: "rows";
+        rowsAffected: "rowsAffected";
+        scalar: "scalar";
+    }>>;
+    audit: z.ZodOptional<z.ZodObject<{
+        action: z.ZodString;
+        resource: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const canonicalTableSchema: z.ZodObject<{
+    table: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    renamedFrom: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        columnName: z.ZodString;
+        type: z.ZodUnion<readonly [z.ZodEnum<{
+            bigint: "bigint";
+            boolean: "boolean";
+            uuid: "uuid";
+            text: "text";
+            integer: "integer";
+            numeric: "numeric";
+            double: "double";
+            timestamptz: "timestamptz";
+            date: "date";
+            jsonb: "jsonb";
+        }>, z.ZodObject<{
+            enum: z.ZodString;
+        }, z.core.$strip>]>;
+        nullable: z.ZodDefault<z.ZodBoolean>;
+        unique: z.ZodDefault<z.ZodBoolean>;
+        default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
+        defaultFn: z.ZodOptional<z.ZodEnum<{
+            "gen_random_uuid()": "gen_random_uuid()";
+            "now()": "now()";
+        }>>;
+        description: z.ZodOptional<z.ZodString>;
+        renamedFrom: z.ZodOptional<z.ZodString>;
+        cast: z.ZodOptional<z.ZodString>;
+        deprecated: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>>;
+    primaryKey: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    links: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        kind: z.ZodEnum<{
+            toOne: "toOne";
+            toMany: "toMany";
+            toPlatformUser: "toPlatformUser";
+        }>;
+        target: z.ZodOptional<z.ZodString>;
+        on: z.ZodString;
+        references: z.ZodOptional<z.ZodString>;
+        enforce: z.ZodDefault<z.ZodBoolean>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    indexes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        columns: z.ZodArray<z.ZodString>;
+        unique: z.ZodDefault<z.ZodBoolean>;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    policies: z.ZodDefault<z.ZodObject<{
+        read: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            default: z.ZodString;
+            variants: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                when: z.ZodString;
+                allow: z.ZodOptional<z.ZodLiteral<true>>;
+                policy: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>]>>;
+        write: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            default: z.ZodString;
+            variants: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                when: z.ZodString;
+                allow: z.ZodOptional<z.ZodLiteral<true>>;
+                policy: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>]>>;
+    }, z.core.$strip>>;
+    actions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        requires: z.ZodOptional<z.ZodString>;
+        params: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+            type: z.ZodEnum<{
+                bigint: "bigint";
+                boolean: "boolean";
+                uuid: "uuid";
+                text: "text";
+                integer: "integer";
+                numeric: "numeric";
+                double: "double";
+                timestamptz: "timestamptz";
+                date: "date";
+                jsonb: "jsonb";
+            }>;
+            nullable: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+        executes: z.ZodString;
+        returns: z.ZodDefault<z.ZodEnum<{
+            rows: "rows";
+            rowsAffected: "rowsAffected";
+            scalar: "scalar";
+        }>>;
+        audit: z.ZodOptional<z.ZodObject<{
+            action: z.ZodString;
+            resource: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type CanonicalTable = z.infer<typeof canonicalTableSchema>;
+declare const canonicalDefinitionSchema: z.ZodObject<{
+    definition_format: z.ZodLiteral<2>;
+    namespace: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    enums: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        values: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>;
+    tables: z.ZodArray<z.ZodObject<{
+        table: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        renamedFrom: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodString>;
+        columns: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            columnName: z.ZodString;
+            type: z.ZodUnion<readonly [z.ZodEnum<{
+                bigint: "bigint";
+                boolean: "boolean";
+                uuid: "uuid";
+                text: "text";
+                integer: "integer";
+                numeric: "numeric";
+                double: "double";
+                timestamptz: "timestamptz";
+                date: "date";
+                jsonb: "jsonb";
+            }>, z.ZodObject<{
+                enum: z.ZodString;
+            }, z.core.$strip>]>;
+            nullable: z.ZodDefault<z.ZodBoolean>;
+            unique: z.ZodDefault<z.ZodBoolean>;
+            default: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
+            defaultFn: z.ZodOptional<z.ZodEnum<{
+                "gen_random_uuid()": "gen_random_uuid()";
+                "now()": "now()";
+            }>>;
+            description: z.ZodOptional<z.ZodString>;
+            renamedFrom: z.ZodOptional<z.ZodString>;
+            cast: z.ZodOptional<z.ZodString>;
+            deprecated: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>>>;
+        primaryKey: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        links: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            kind: z.ZodEnum<{
+                toOne: "toOne";
+                toMany: "toMany";
+                toPlatformUser: "toPlatformUser";
+            }>;
+            target: z.ZodOptional<z.ZodString>;
+            on: z.ZodString;
+            references: z.ZodOptional<z.ZodString>;
+            enforce: z.ZodDefault<z.ZodBoolean>;
+            description: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        indexes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            columns: z.ZodArray<z.ZodString>;
+            unique: z.ZodDefault<z.ZodBoolean>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        policies: z.ZodDefault<z.ZodObject<{
+            read: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+                default: z.ZodString;
+                variants: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                    when: z.ZodString;
+                    allow: z.ZodOptional<z.ZodLiteral<true>>;
+                    policy: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>>;
+            }, z.core.$strip>]>>;
+            write: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+                default: z.ZodString;
+                variants: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                    when: z.ZodString;
+                    allow: z.ZodOptional<z.ZodLiteral<true>>;
+                    policy: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>>;
+            }, z.core.$strip>]>>;
+        }, z.core.$strip>>;
+        actions: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            requires: z.ZodOptional<z.ZodString>;
+            params: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+                type: z.ZodEnum<{
+                    bigint: "bigint";
+                    boolean: "boolean";
+                    uuid: "uuid";
+                    text: "text";
+                    integer: "integer";
+                    numeric: "numeric";
+                    double: "double";
+                    timestamptz: "timestamptz";
+                    date: "date";
+                    jsonb: "jsonb";
+                }>;
+                nullable: z.ZodDefault<z.ZodBoolean>;
+            }, z.core.$strip>>>;
+            executes: z.ZodString;
+            returns: z.ZodDefault<z.ZodEnum<{
+                rows: "rows";
+                rowsAffected: "rowsAffected";
+                scalar: "scalar";
+            }>>;
+            audit: z.ZodOptional<z.ZodObject<{
+                action: z.ZodString;
+                resource: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    capabilities: z.ZodDefault<z.ZodObject<{
+        roles: z.ZodOptional<z.ZodUnknown>;
+        uses: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type CanonicalDefinition = z.infer<typeof canonicalDefinitionSchema>;
+/**
+ * Deterministic serialization discipline: tables sorted by name, columns in
+ * declaration order (order is meaningful for DDL), links/indexes/actions
+ * sorted by name, object keys emitted in schema order. `serializeNamespace`
+ * (authoring layer) and the server-side re-validation both normalize through
+ * this function before hashing so CLI and server hash identical bytes.
+ */
+declare function normalizeCanonical(definition: CanonicalDefinition): CanonicalDefinition;
+
+export { CANONICAL_FORMAT, COLUMN_TYPES, type CanonicalColumn, type CanonicalDefinition, type CanonicalEnum, type CanonicalLink, type CanonicalTable, type ColumnType, IDENTIFIER_RE, type PolicyExpression, canonicalActionSchema, canonicalColumnSchema, canonicalDefinitionSchema, canonicalEnumSchema, canonicalIndexSchema, canonicalLinkSchema, canonicalPoliciesSchema, canonicalTableSchema, normalizeCanonical, policyExpressionSchema, policyVariantSchema };