@vibeorm/dsl 4.1.0 → 4.3.0

package/README.md

@@ -63,13 +63,13 @@ To go to the IR yourself: `dsl.toIR({ schema })` returns a `SchemaIR`, optionall
 
 `dsl.enum` has two forms: with a `name` it creates a reusable enum whose `.field()` yields a column, without one it creates an inline single-use enum column.
 
-Id strategies are `dsl.id({ type: "ulid" | "uuid" | "cuid" | "nanoid" | "autoincrement" | "none" })`. The default is `"ulid"`, a `String` column generated in the app; `"autoincrement"` makes it an `Int`.
+Id strategies are `dsl.id({ type: "ulid" | "uuid" | "cuid" | "nanoid" | "autoincrement" | "none" })`. The default is `"ulid"`, a `String` column generated in the app; `"autoincrement"` makes it an `Int`. A key the database mints takes `type: "none"` with a database default: `dsl.id({ type: "none" }).uuid().dbgenerated("uuidv7()")` is Prisma's `String @id @db.Uuid @default(dbgenerated("uuidv7()"))`.
 
 ## Chainable modifiers
 
 On every column: `.optional()`, `.unique()`, `.index()`, `.array()`, `.default(value)`, `.map("db_col")`, `.dbgenerated("expr")`, `.comment("...")`.
 
-Kind-specific: `.maxLength(n)` and `.text()` on strings, `.precision(p, s)` on decimals, `.defaultNow()`, `.updatedAt()` and `.tz()` on datetimes. `.tz({ precision: 3 })` declares `@db.Timestamptz(3)`: it stores exactly what a JavaScript `Date` holds, so a database-written time reads back unchanged and `findPage` can order by the column without an assertion.
+Kind-specific: `.maxLength(n)`, `.text()` and `.uuid()` on strings (`.uuid()` also on ids), `.precision(p, s)` on decimals, `.defaultNow()`, `.updatedAt()` and `.tz()` on datetimes. `.tz({ precision: 3 })` declares `@db.Timestamptz(3)`: it stores exactly what a JavaScript `Date` holds, so a database-written time reads back unchanged and `findPage` can order by the column without an assertion. `.uuid()` declares `@db.Uuid`: PostgreSQL's native uuid type (the value stays a `string`); SQLite stores it as `TEXT`; MySQL has no uuid type and refuses the schema with `VIBE_UNSUPPORTED_CAPABILITY`.
 
 ### Database defaults
 

package/dist/column.d.ts

@@ -8,8 +8,8 @@
  * dsl.int().default(42)
  * dsl.string({ optional: true })
  */
-import type { EnumStorage, JsonSchemaRefIR } from "@vibeorm/schema";
-import type { BaseColumnConfig, BigIntColumnConfig, BooleanColumnConfig, BytesColumnConfig, ColumnDef, ColumnType, DatetimeColumnConfig, DecimalColumnConfig, ExtensionTypeConfig, FloatColumnConfig, IdColumnConfig, IdGeneratorType, InlineEnumConfig, IntColumnConfig, JsonColumnConfig, StringColumnConfig } from "./types.ts";
+import type { EnumStorage, GeneratedColumnOptions, JsonSchemaRefIR, ValidatorRefIR } from "@vibeorm/schema";
+import type { BaseColumnConfig, BigIntColumnConfig, BooleanColumnConfig, BytesColumnConfig, CheckRuleOptions, ColumnCheckShape, ColumnDef, ColumnType, DatetimeColumnConfig, DecimalColumnConfig, ExtensionTypeConfig, FloatColumnConfig, IdColumnConfig, IdGeneratorType, InlineEnumConfig, IntColumnConfig, JsonColumnConfig, LocalDateColumnConfig, StringColumnConfig } from "./types.ts";
 /**
  * Shallow-clones a column definition with a fresh `__config`, so columns
  * spread from a template are never shared between models.
@@ -19,6 +19,7 @@ export declare function cloneColumnDef(params: {
 }): ColumnDef;
 type ColumnDefaultValues = {
     string: string;
+    localDate: string;
     int: number;
     bigint: bigint | number;
     float: number;
@@ -55,8 +56,56 @@ export declare class ChainableColumn<T extends ColumnType = ColumnType> implemen
     map(dbColumnName: string): this;
     /** `@default(dbgenerated("expression"))` — database-native default. */
     dbgenerated(expression: string): this;
+    /** Declare a stored database expression, distinct from a default and never client-writable. */
+    generated(options: GeneratedColumnOptions): this;
+    /** Bind synchronous write validation without changing the column's public scalar type. */
+    validate(reference: T extends "json" | "unsupported" ? never : ValidatorRefIR): this;
     /** Emits a `///` doc comment above the column. */
     comment(text: string): this;
+    /**
+     * Record a one-column CHECK rule. Copy-on-write: `cloneColumnDef` copies the
+     * config shallowly, so a pushed array would leak into every model built from
+     * the same template column.
+     */
+    protected addCheckRule(params: {
+        rule: string;
+        check: ColumnCheckShape;
+        options: CheckRuleOptions | undefined;
+    }): this;
+}
+/** Column kinds that take numeric check rules. */
+export type NumericColumnType = "int" | "bigint" | "float" | "decimal";
+/**
+ * The literal a numeric rule takes, per column kind. Decimal takes exact
+ * decimal TEXT (`"19.99"`): a JavaScript number cannot carry an exact decimal.
+ */
+export type NumericRuleLiteral = {
+    readonly int: number;
+    readonly bigint: bigint | number;
+    readonly float: number;
+    readonly decimal: string;
+};
+/**
+ * A numeric column with one-column CHECK rules. Each rule becomes a named CHECK
+ * `<Table>_<column>_<rule>_check`; `{ name }` replaces the name. A comparison
+ * passes on NULL, so on an optional column the rule holds the values that are set.
+ */
+export declare class ChainableNumericColumn<T extends NumericColumnType> extends ChainableColumn<T> {
+    /** The zero literal of this column kind. */
+    private zero;
+    /** `CHECK ("col" >= 0)`, rule word `nonNegative`. */
+    nonNegative(options?: CheckRuleOptions): this;
+    /** `CHECK ("col" > 0)`, rule word `positive`. */
+    positive(options?: CheckRuleOptions): this;
+    /** `CHECK ("col" >= value)`, rule word `atLeast`. */
+    atLeast(value: NumericRuleLiteral[T], options?: CheckRuleOptions): this;
+    /** `CHECK ("col" <= value)`, rule word `atMost`. */
+    atMost(value: NumericRuleLiteral[T], options?: CheckRuleOptions): this;
+    /** `CHECK ("col" >= min AND "col" <= max)`, rule word `range`. Both bounds are included. */
+    range(range: CheckRuleOptions & {
+        readonly min: NumericRuleLiteral[T];
+        readonly max: NumericRuleLiteral[T];
+    }): this;
 }
 /** String column with database-level type annotations. */
 export declare class ChainableStringColumn extends ChainableColumn<"string"> {
@@ -65,11 +114,24 @@ export declare class ChainableStringColumn extends ChainableColumn<"string"> {
     maxLength(n: number): this;
     /** `@db.Text` */
     text(): this;
+    /**
+     * `@db.Uuid` — PostgreSQL's native 128-bit uuid column; values stay strings.
+     * SQLite stores the string as TEXT; MySQL has no uuid type and refuses it.
+     */
+    uuid(): this;
     /** `@collation("...")` — explicit column collation (mysql-rendered; inert on postgres/sqlite). */
     collation(name: string): this;
+    /** `CHECK ("col" IN (values))`, rule word `allowed`. */
+    oneOf(values: readonly string[], options?: CheckRuleOptions): this;
+    /**
+     * `CHECK (length("col") <= max)`, rule word `length` — a CHECK on any text
+     * column, PostgreSQL/PGlite only. `.maxLength(n)` instead changes the column
+     * TYPE to `VarChar(n)` and works on every dialect.
+     */
+    lengthAtMost(max: number, options?: CheckRuleOptions): this;
 }
 /** Decimal column carrying precision/scale. */
-export declare class ChainableDecimalColumn extends ChainableColumn<"decimal"> {
+export declare class ChainableDecimalColumn extends ChainableNumericColumn<"decimal"> {
     constructor(config?: DecimalColumnConfig);
     /** `@db.Decimal(precision, scale)` */
     precision(p: number, s?: number): this;
@@ -96,6 +158,12 @@ export declare class ChainableIdColumn extends ChainableColumn<"id"> {
     constructor(config?: IdColumnConfig);
     /** Sets the id generator strategy (default `"ulid"`). */
     type(idType: IdGeneratorType): this;
+    /**
+     * `@db.Uuid` — store a String id in PostgreSQL's native uuid column. Pair it
+     * with an app-side strategy (`type: "uuid"`), or with `type: "none"` and a
+     * database default: `dsl.id({ type: "none" }).uuid().dbgenerated("uuidv7()")`.
+     */
+    uuid(): this;
 }
 /** Enum column whose `default()` is constrained to the declared options. */
 export declare class ChainableEnumColumn<T extends readonly string[] = readonly string[]> extends ChainableColumn<"enum"> {
@@ -105,8 +173,12 @@ export declare class ChainableEnumColumn<T extends readonly string[] = readonly
         enumName?: string;
         storage?: EnumStorage;
     });
+    /** The declared members, typed as the option tuple (presence tables read it). */
+    __enumValues?: T;
     /** Sets the default to one of the declared options. */
     default(value: T[number] | readonly T[number][]): this;
+    /** `CHECK ("col" IN (members))` — a subset of the enum's members, rule word `allowed`. */
+    oneOf(values: readonly T[number][], options?: CheckRuleOptions): this;
 }
 /**
  * String column.
@@ -118,14 +190,20 @@ export declare class ChainableEnumColumn<T extends readonly string[] = readonly
  */
 export declare function string(config?: StringColumnConfig): ChainableStringColumn;
 /** Integer column with database-generated values independent of primary-key membership. */
-export declare class ChainableIntegerColumn<T extends "int" | "bigint"> extends ChainableColumn<T> {
+export declare class ChainableIntegerColumn<T extends "int" | "bigint"> extends ChainableNumericColumn<T> {
     /** Assign values from the database sequence; does not imply a key or uniqueness. */
     autoincrement(): this;
 }
+/** A Gregorian calendar day as canonical YYYY-MM-DD text, not a JavaScript Date. */
+export declare function localDate({ ...config }?: LocalDateColumnConfig): ChainableColumn<"localDate">;
 /** Int column. */
 export declare function int(config?: IntColumnConfig): ChainableIntegerColumn<"int">;
+/** Float column with numeric check rules. */
+export declare class ChainableFloatColumn extends ChainableNumericColumn<"float"> {
+    constructor(config?: FloatColumnConfig);
+}
 /** Float column. */
-export declare function float(config?: FloatColumnConfig): ChainableColumn<"float">;
+export declare function float(config?: FloatColumnConfig): ChainableFloatColumn;
 /** Decimal column. */
 export declare function decimal(config?: DecimalColumnConfig): ChainableDecimalColumn;
 /** Boolean column. */
@@ -165,6 +243,7 @@ export declare function json(config?: JsonColumnConfig): ChainableJsonColumn;
  * dsl.id()                  // String @id @default(ulid())
  * dsl.id({ type: "uuid" })  // String @id @default(uuid())
  * dsl.id().type("autoincrement")  // Int @id @default(autoincrement())
+ * dsl.id({ type: "none" }).uuid().dbgenerated("uuidv7()")  // String @id @db.Uuid @default(dbgenerated("uuidv7()"))
  */
 export declare function id(config?: IdColumnConfig): ChainableIdColumn;
 /** Bytes column. */

package/dist/index.d.ts

@@ -33,19 +33,23 @@
  * const prisma = dsl.generate.prisma(schema);    // .prisma text
  */
 import type { ExtensionRegistry, Provider, SchemaIR } from "@vibeorm/schema";
-import type { ChainableColumn, ChainableDatetimeColumn, ChainableDecimalColumn, ChainableEnumColumn, ChainableIdColumn, ChainableIntegerColumn, ChainableJsonColumn, ChainableStringColumn } from "./column.ts";
+import type { ChainableColumn, ChainableDatetimeColumn, ChainableDecimalColumn, ChainableEnumColumn, ChainableFloatColumn, ChainableIdColumn, ChainableIntegerColumn, ChainableJsonColumn, ChainableStringColumn } from "./column.ts";
 import type { StandaloneEnumConfig } from "./enum.ts";
 import { defineRelations, defineRelationsPart, mergeRelations } from "./relations.ts";
 import { defineRls } from "./schema.ts";
 import type { SchemaOptions } from "./schema.ts";
 import type { TemplatesApi } from "./templates.ts";
 import type { ValidationError } from "./validate.ts";
-import type { BigIntColumnConfig, BooleanColumnConfig, BytesColumnConfig, CreateModelConfig, DatetimeColumnConfig, DecimalColumnConfig, EnumDef, ExtensionTypeConfig, FloatColumnConfig, GeneratorOutput, IdColumnConfig, InlineEnumConfig, IntColumnConfig, JsonColumnConfig, ModelDef, PrismaGeneratorConfig, SchemaDef, SchemaDefinition, SchemaInput, StringColumnConfig } from "./types.ts";
-export { ChainableColumn, ChainableDatetimeColumn, ChainableDecimalColumn, ChainableEnumColumn, ChainableIdColumn, ChainableIntegerColumn, ChainableJsonColumn, ChainableStringColumn, cloneColumnDef, } from "./column.ts";
+import type { BigIntColumnConfig, BooleanColumnConfig, BytesColumnConfig, CreateModelConfig, DatetimeColumnConfig, DecimalColumnConfig, EnumDef, ExtensionTypeConfig, FloatColumnConfig, GeneratorOutput, IdColumnConfig, InlineEnumConfig, IntColumnConfig, JsonColumnConfig, LocalDateColumnConfig, ModelDef, PrismaGeneratorConfig, SchemaDef, SchemaDefinition, SchemaInput, StringColumnConfig } from "./types.ts";
+export { ChainableColumn, ChainableDatetimeColumn, ChainableDecimalColumn, ChainableEnumColumn, ChainableFloatColumn, ChainableIdColumn, ChainableIntegerColumn, ChainableJsonColumn, ChainableNumericColumn, ChainableStringColumn, cloneColumnDef, } from "./column.ts";
+export type { NumericColumnType, NumericRuleLiteral } from "./column.ts";
+export { localDate } from "./column.ts";
 export { createEnum } from "./enum.ts";
 export { generatePrisma } from "./generator/prisma.ts";
 export { create, createIndexBuilder, evaluateIndexes, getColumnNames } from "./model.ts";
-export { compileChecks, compileIndexPredicate, createPredicateBuilder, evaluateChecks } from "./predicate.ts";
+export { createRowRuleBuilder, compileRowRules } from "./row-rules.ts";
+export type { RowRuleBuilder, RowRuleDeclaration } from "./row-rules.ts";
+export { compileChecks, compileIndexPredicate, compileModelChecks, createChecksBuilder, createPredicateBuilder, evaluateChecks } from "./predicate.ts";
 export { children, createChildrenBuilder } from "./relation.ts";
 export { detectOneToOnePairs, planSchema, resolveRelationType } from "./relation-plan.ts";
 export { defineRelations, defineRelationsPart, mergeRelations } from "./relations.ts";
@@ -53,13 +57,14 @@ export { defineRls, domain, schema } from "./schema.ts";
 export { base, baseWithWorkspace, fields, templates, withActive, withAudit, withExternalId, withMetadata, withNameDescription, } from "./templates.ts";
 export { toIR } from "./to-ir.ts";
 export { validateSchema } from "./validate.ts";
+export type { GeneratedColumnOptions, ValidatorRefIR } from "@vibeorm/schema";
 export type { StandaloneEnumConfig } from "./enum.ts";
-export type { EvaluatedCheck, PredicateModel } from "./predicate.ts";
+export type { CheckModelContext, EvaluatedCheck, PredicateModel } from "./predicate.ts";
 export type { MergedOneToOneSide, PlannedIndex, PlannedRelation, PlannedRelationKind, SchemaPlan, } from "./relation-plan.ts";
 export type { SchemaOptions } from "./schema.ts";
 export type { ActiveTemplate, AuditTemplate, BaseTemplate, BaseWithWorkspaceTemplate, ExternalIdTemplate, FieldsTemplate, MetadataTemplate, NameDescriptionTemplate, TemplatesApi, } from "./templates.ts";
 export type { ValidationError } from "./validate.ts";
-export type { DefineRlsOptions, MergedRelations, RlsColumnKind, RlsContextRef, RlsContextRefs, RlsDef, RlsPolicies, BaseColumnConfig, BigIntColumnConfig, BooleanColumnConfig, BytesColumnConfig, CascadeAction, ChildrenBuilder, ChildrenDef, ChildrenRelationConfig, ChildrenSchemaCallback, ColumnDef, ColumnKeys, ColumnRef, ColumnRefKind, ColumnRefKindOf, ColumnType, CreateModelConfig, DatetimeColumnConfig, DecimalColumnConfig, EnumDef, EnumFieldConfig, EnumStorage, EnumValues, ExtensionAttributeUse, ExtensionTypeConfig, FloatColumnConfig, GeneratorOutput, IdColumnConfig, IdGeneratorType, IndexBuilder, IndexCallback, IndexDef, IndexOptions, ChecksCallback, ModelCheckConfig, ModelPolicyConfig, NamedCheckDef, PartialIndexDef, PredicateBuilder, PredicateExpr, PredicateFieldExpr, UniqueIndexOptions, IndexType, InlineEnumConfig, IntColumnConfig, JsonColumnConfig, ManyRelationDefConfig, ModelColumnRefs, ModelDef, OneRelationDefConfig, PrismaGeneratorConfig, RelationRefInput, RelationTarget, RelationsBuilder, RelationsMap, RelationsOutput, SchemaColumnNames, SchemaDef, SchemaDefinition, SchemaInput, StoredRelationDef, StringColumnConfig, ThroughRef, UnsupportedColumnConfig, } from "./types.ts";
+export type { DefineRlsOptions, MergedRelations, RlsColumnKind, RlsContextRef, RlsContextRefs, RlsDef, RlsPolicies, BaseColumnConfig, BigIntColumnConfig, BooleanColumnConfig, BytesColumnConfig, CascadeAction, ChildrenBuilder, ChildrenDef, ChildrenRelationConfig, ChildrenSchemaCallback, ColumnDef, ColumnKeys, ColumnRef, ColumnRefKind, ColumnRefKindOf, ColumnType, CreateModelConfig, DatetimeColumnConfig, DecimalColumnConfig, EnumDef, EnumFieldConfig, EnumStorage, EnumValues, ExtensionAttributeUse, ExtensionTypeConfig, FloatColumnConfig, GeneratorOutput, IdColumnConfig, IdGeneratorType, IndexBuilder, IndexCallback, IndexDef, IndexKey, UnsortedIndexKey, SortedIndexKey, RawIndexExpression, IndexOptions, ChecksBuilder, ChecksCallback, CheckRuleOptions, ColumnCheckRule, ColumnCheckShape, OrderCheckOptions, PresenceCheckConfig, PresenceState, ModelCheckConfig, ModelPolicyConfig, NamedCheckDef, PartialIndexDef, PredicateBuilder, PredicateExpr, PredicateFieldExpr, PredicateNumericKind, PredicateNumericLiteral, PredicateNumericOperand, UniqueIndexOptions, IndexType, InlineEnumConfig, IntColumnConfig, JsonColumnConfig, LocalDateColumnConfig, ManyRelationDefConfig, ModelColumnRefs, ModelDef, OneRelationDefConfig, PrismaGeneratorConfig, RelationRefInput, RelationTarget, RelationsBuilder, RelationsMap, RelationsOutput, SchemaColumnNames, SchemaDef, SchemaDefinition, SchemaInput, StoredRelationDef, StringColumnConfig, ThroughRef, UnsupportedColumnConfig, } from "./types.ts";
 /**
  * Creates an enum: standalone (reusable, has a `name`) or inline (one-off).
  *
@@ -82,9 +87,10 @@ export type GenerateApi = {
  */
 export type DslApi = {
     readonly string: (config?: StringColumnConfig) => ChainableStringColumn;
+    readonly localDate: (config?: LocalDateColumnConfig) => ChainableColumn<"localDate">;
     readonly int: (config?: IntColumnConfig) => ChainableIntegerColumn<"int">;
     readonly bigint: (config?: BigIntColumnConfig) => ChainableIntegerColumn<"bigint">;
-    readonly float: (config?: FloatColumnConfig) => ChainableColumn<"float">;
+    readonly float: (config?: FloatColumnConfig) => ChainableFloatColumn;
     readonly decimal: (config?: DecimalColumnConfig) => ChainableDecimalColumn;
     readonly boolean: (config?: BooleanColumnConfig) => ChainableColumn<"boolean">;
     readonly datetime: (config?: DatetimeColumnConfig) => ChainableDatetimeColumn;