effect-qb 0.13.0 → 0.15.0

package/src/internal/column-state.ts

@@ -1,8 +1,10 @@
+import type * as Brand from "effect/Brand"
 import { pipeArguments, type Pipeable } from "effect/Pipeable"
 import * as Schema from "effect/Schema"
 
-import * as Expression from "./expression.js"
+import * as Expression from "./scalar.js"
 import * as ExpressionAst from "./expression-ast.js"
+import type * as SchemaExpression from "./schema-expression.js"
 
 /** Symbol used to attach column-definition metadata. */
 export const ColumnTypeId: unique symbol = Symbol.for("effect-qb/Column")
@@ -12,9 +14,36 @@ export const BoundColumnTypeId: unique symbol = Symbol.for("effect-qb/BoundColum
 export type ColumnTypeId = typeof ColumnTypeId
 export type BoundColumnTypeId = typeof BoundColumnTypeId
 
+export type DdlExpression = Expression.Any | SchemaExpression.Any
+
 /** Lazy reference to another bound column. */
 export interface ColumnReference<Target = unknown> {
   readonly target: () => Target
+  readonly name?: string
+  readonly onUpdate?: "noAction" | "restrict" | "cascade" | "setNull" | "setDefault"
+  readonly onDelete?: "noAction" | "restrict" | "cascade" | "setNull" | "setDefault"
+  readonly deferrable?: boolean
+  readonly initiallyDeferred?: boolean
+}
+
+/** Inline single-column index metadata. */
+export interface ColumnIndexOptions {
+  readonly name?: string
+  readonly method?: string
+  readonly include?: readonly string[]
+  readonly predicate?: DdlExpression
+  readonly order?: "asc" | "desc"
+  readonly nulls?: "first" | "last"
+  readonly operatorClass?: string
+  readonly collation?: string
+}
+
+/** Inline single-column unique-constraint metadata. */
+export interface ColumnUniqueOptions {
+  readonly name?: string
+  readonly nullsNotDistinct?: boolean
+  readonly deferrable?: boolean
+  readonly initiallyDeferred?: boolean
 }
 
 /** Complete static state tracked for a column definition. */
@@ -29,8 +58,7 @@ export interface ColumnState<
   PrimaryKey extends boolean,
   Unique extends boolean,
   Ref,
-  Source = never,
-  Dependencies extends Expression.SourceDependencies = {}
+  Dependencies extends Expression.BindingId = never
 > {
   readonly select: Select
   readonly insert: Insert
@@ -42,10 +70,21 @@ export interface ColumnState<
   readonly primaryKey: PrimaryKey
   readonly unique: Unique
   readonly references: Ref
-  readonly defaultValue?: Expression.Any
-  readonly generatedValue?: Expression.Any
-  readonly source: Source
-  readonly dependencies: Dependencies
+  readonly brand?: true
+  readonly index?: ColumnIndexOptions
+  readonly uniqueConstraint?: ColumnUniqueOptions
+  readonly defaultValue?: DdlExpression
+  readonly generatedValue?: DdlExpression
+  readonly ddlType?: string
+  readonly identity?: {
+    readonly generation: "always" | "byDefault"
+  }
+  readonly enum?: {
+    readonly name: string
+    readonly schemaName?: string
+    readonly values: readonly [string, ...string[]]
+  }
+  readonly dependencies?: Dependencies
 }
 
 /** Unbound column definition produced by the `Column` DSL. */
@@ -60,15 +99,13 @@ export interface ColumnDefinition<
   PrimaryKey extends boolean,
   Unique extends boolean,
   Ref,
-  Source = never,
-  Dependencies extends Expression.SourceDependencies = {}
-> extends Pipeable, Expression.Expression<
+  Dependencies extends Expression.BindingId = never
+> extends Pipeable, Expression.Scalar<
     Select,
     Db,
     Nullable extends true ? "maybe" : "never",
     Db["dialect"],
     "scalar",
-    Source,
     Dependencies
   > {
   readonly pipe: Pipeable["pipe"]
@@ -83,7 +120,6 @@ export interface ColumnDefinition<
     PrimaryKey,
     Unique,
     Ref,
-    Source,
     Dependencies
   >
   readonly schema: Schema.Schema<NonNullable<Select>, any, any>
@@ -95,8 +131,20 @@ export interface ColumnDefinition<
     readonly primaryKey: PrimaryKey
     readonly unique: Unique
     readonly references: Ref
-    readonly defaultValue?: Expression.Any
-    readonly generatedValue?: Expression.Any
+    readonly brand?: true
+    readonly index?: ColumnIndexOptions
+    readonly uniqueConstraint?: ColumnUniqueOptions
+    readonly defaultValue?: DdlExpression
+    readonly generatedValue?: DdlExpression
+    readonly ddlType?: string
+    readonly identity?: {
+      readonly generation: "always" | "byDefault"
+    }
+    readonly enum?: {
+      readonly name: string
+      readonly schemaName?: string
+      readonly values: readonly [string, ...string[]]
+    }
   }
 }
 
@@ -110,11 +158,11 @@ export interface BoundColumn<
   HasDefault extends boolean,
   Generated extends boolean,
   PrimaryKey extends boolean,
-    Unique extends boolean,
-    Ref,
-    TableName extends string,
-    ColumnName extends string,
-    BaseTableName extends string = TableName
+  Unique extends boolean,
+  Ref,
+  TableName extends string,
+  ColumnName extends string,
+  BaseTableName extends string = TableName
 > extends ColumnDefinition<
     Select,
     Insert,
@@ -126,8 +174,7 @@ export interface BoundColumn<
     PrimaryKey,
     Unique,
     Ref,
-    Expression.ColumnSource<TableName, ColumnName, BaseTableName>,
-    Record<TableName, true>
+    TableName
   > {
   readonly [BoundColumnTypeId]: {
     readonly tableName: TableName
@@ -141,9 +188,7 @@ export interface BoundColumn<
     Nullable extends true ? "maybe" : "never",
     Db["dialect"],
     "scalar",
-    Expression.ColumnSource<TableName, ColumnName, BaseTableName>,
-    Record<TableName, true>,
-    "propagate"
+    TableName
   >
   readonly [ExpressionAst.TypeId]: ExpressionAst.ColumnNode<TableName, ColumnName>
 }
@@ -175,6 +220,7 @@ export type AnyBoundColumn = BoundColumn<
   boolean,
   any,
   string,
+  string,
   string
 >
 
@@ -184,6 +230,17 @@ const ColumnProto = {
   }
 }
 
+const attachPipe = <Value extends object>(value: Value): Value => {
+  Object.defineProperty(value, "pipe", {
+    configurable: true,
+    writable: true,
+    value: function(this: unknown) {
+      return pipeArguments(value, arguments)
+    }
+  })
+  return value
+}
+
 /** Constructs a runtime column-definition object from schema and metadata. */
 export const makeColumnDefinition = <
   Select,
@@ -196,8 +253,7 @@ export const makeColumnDefinition = <
   PrimaryKey extends boolean,
   Unique extends boolean,
   Ref,
-  Source = never,
-  Dependencies extends Expression.SourceDependencies = {}
+  Dependencies extends Expression.BindingId = never
 >(
   schema: Schema.Schema<NonNullable<Select>, any, any>,
   metadata: ColumnDefinition<
@@ -211,7 +267,6 @@ export const makeColumnDefinition = <
     PrimaryKey,
     Unique,
     Ref,
-    Source,
     Dependencies
   >["metadata"]
 ): ColumnDefinition<
@@ -225,10 +280,9 @@ export const makeColumnDefinition = <
   PrimaryKey,
   Unique,
   Ref,
-  Source,
   Dependencies
 > => {
-  const column = Object.create(ColumnProto)
+  const column = attachPipe(Object.create(ColumnProto))
   column.schema = schema
   column.metadata = metadata
   column[Expression.TypeId] = {
@@ -237,10 +291,8 @@ export const makeColumnDefinition = <
     runtimeSchema: schema,
     nullability: (metadata.nullable ? "maybe" : "never") as Nullable extends true ? "maybe" : "never",
     dialect: metadata.dbType.dialect,
-    aggregation: "scalar",
-    source: undefined as Source,
-    sourceNullability: "propagate" as const,
-    dependencies: {} as Dependencies
+    kind: "scalar",
+    dependencies: {}
   }
   column[ColumnTypeId] = {
     select: undefined as Select,
@@ -255,8 +307,9 @@ export const makeColumnDefinition = <
     references: metadata.references,
     defaultValue: metadata.defaultValue,
     generatedValue: metadata.generatedValue,
-    source: undefined as Source,
-    dependencies: {} as Dependencies
+    ddlType: metadata.ddlType,
+    identity: metadata.identity,
+    enum: metadata.enum
   }
   return column
 }
@@ -272,8 +325,7 @@ export const remapColumnDefinition = <
   PrimaryKey extends boolean,
   Unique extends boolean,
   Ref,
-  Source = never,
-  Dependencies extends Expression.SourceDependencies = {}
+  Dependencies extends Expression.BindingId = never
 >(
   column: ColumnDefinition<
     Select,
@@ -286,7 +338,6 @@ export const remapColumnDefinition = <
     PrimaryKey,
     Unique,
     Ref,
-    Source,
     Dependencies
   >,
   options: {
@@ -302,7 +353,6 @@ export const remapColumnDefinition = <
       PrimaryKey,
       Unique,
       Ref,
-      Source,
       Dependencies
     >["metadata"]
   } = {}
@@ -317,12 +367,11 @@ export const remapColumnDefinition = <
   PrimaryKey,
   Unique,
   Ref,
-  Source,
   Dependencies
 > => {
   const schema = options.schema ?? column.schema
   const metadata = options.metadata ?? column.metadata
-  const next = Object.create(ColumnProto)
+  const next = attachPipe(Object.create(ColumnProto))
   next.schema = schema
   next.metadata = metadata
   next[Expression.TypeId] = {
@@ -346,7 +395,10 @@ export const remapColumnDefinition = <
     unique: metadata.unique,
     references: metadata.references,
     defaultValue: metadata.defaultValue,
-    generatedValue: metadata.generatedValue
+    generatedValue: metadata.generatedValue,
+    ddlType: metadata.ddlType,
+    identity: metadata.identity,
+    enum: metadata.enum
   }
   if (ExpressionAst.TypeId in column) {
     next[ExpressionAst.TypeId] = (column as unknown as {
@@ -380,25 +432,23 @@ export const bindColumn = <
   baseTableName: BaseTableName,
   schemaName?: SchemaName
 ): BoundColumnFrom<Column, TableName, ColumnName, BaseTableName> => {
-  const bound = Object.create(ColumnProto)
-  bound.schema = column.schema
+  const brandName = `${tableName}.${columnName}`
+  const schema = column.metadata.brand === true
+    ? Schema.brand(brandName)(column.schema)
+    : column.schema
+  const bound = attachPipe(Object.create(ColumnProto))
+  bound.schema = schema
   bound.metadata = column.metadata
   bound[Expression.TypeId] = {
     runtime: undefined as SelectType<Column>,
     dbType: column.metadata.dbType,
-    runtimeSchema: column.schema,
+    runtimeSchema: schema,
     nullability: (column.metadata.nullable ? "maybe" : "never") as IsNullable<Column> extends true ? "maybe" : "never",
     dialect: column.metadata.dbType.dialect,
-    aggregation: "scalar",
-    source: {
-      tableName,
-      columnName,
-      baseTableName
-    },
-    sourceNullability: "propagate" as const,
+    kind: "scalar",
     dependencies: {
       [tableName]: true
-    } as Record<TableName, true>
+    }
   }
   bound[ExpressionAst.TypeId] = {
     kind: "column",
@@ -438,6 +488,13 @@ export type ReferencesOf<Column extends AnyColumnDefinition> = ColumnStateOf<Col
 /** Extracts the non-null select type of a column. */
 export type BaseSelectType<Column extends AnyColumnDefinition> = NonNullable<SelectType<Column>>
 
+type BrandedValue<
+  Value,
+  BrandName extends string
+> = [Extract<Value, null | undefined>] extends [never]
+  ? Value & Brand.Brand<BrandName>
+  : Exclude<Value, null | undefined> & Brand.Brand<BrandName> | Extract<Value, null | undefined>
+
 /** Rebinds a generic column definition to a specific table and key. */
 export type BoundColumnFrom<
   Column extends AnyColumnDefinition,
@@ -445,9 +502,15 @@ export type BoundColumnFrom<
   ColumnName extends string,
   BaseTableName extends string = TableName
 > = BoundColumn<
-  SelectType<Column>,
-  InsertType<Column>,
-  UpdateType<Column>,
+  Column["metadata"]["brand"] extends true
+    ? BrandedValue<SelectType<Column>, `${TableName}.${ColumnName}`>
+    : SelectType<Column>,
+  Column["metadata"]["brand"] extends true
+    ? BrandedValue<InsertType<Column>, `${TableName}.${ColumnName}`>
+    : InsertType<Column>,
+  Column["metadata"]["brand"] extends true
+    ? BrandedValue<UpdateType<Column>, `${TableName}.${ColumnName}`>
+    : UpdateType<Column>,
   ColumnStateOf<Column>["dbType"],
   IsNullable<Column>,
   HasDefault<Column>,