@dsqlbase/core 0.1.6 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/CHANGELOG.md +195 -0
  2. package/LICENSE +21 -0
  3. package/README.md +4 -0
  4. package/dist/definition/base.d.ts +50 -3
  5. package/dist/definition/base.d.ts.map +1 -1
  6. package/dist/definition/base.js +34 -1
  7. package/dist/definition/base.js.map +1 -1
  8. package/dist/definition/column.d.ts +87 -14
  9. package/dist/definition/column.d.ts.map +1 -1
  10. package/dist/definition/column.js +99 -5
  11. package/dist/definition/column.js.map +1 -1
  12. package/dist/definition/constraint.d.ts +16 -15
  13. package/dist/definition/constraint.d.ts.map +1 -1
  14. package/dist/definition/constraint.js +4 -1
  15. package/dist/definition/constraint.js.map +1 -1
  16. package/dist/definition/domain.d.ts +12 -8
  17. package/dist/definition/domain.d.ts.map +1 -1
  18. package/dist/definition/domain.js +10 -2
  19. package/dist/definition/domain.js.map +1 -1
  20. package/dist/definition/embedded.d.ts +131 -0
  21. package/dist/definition/embedded.d.ts.map +1 -0
  22. package/dist/definition/embedded.js +133 -0
  23. package/dist/definition/embedded.js.map +1 -0
  24. package/dist/definition/index.d.ts +7 -4
  25. package/dist/definition/index.d.ts.map +1 -1
  26. package/dist/definition/index.js +4 -1
  27. package/dist/definition/index.js.map +1 -1
  28. package/dist/definition/indexes.d.ts +49 -19
  29. package/dist/definition/indexes.d.ts.map +1 -1
  30. package/dist/definition/indexes.js +38 -9
  31. package/dist/definition/indexes.js.map +1 -1
  32. package/dist/definition/namespace.d.ts +2 -2
  33. package/dist/definition/namespace.d.ts.map +1 -1
  34. package/dist/definition/namespace.js.map +1 -1
  35. package/dist/definition/relations.d.ts +47 -15
  36. package/dist/definition/relations.d.ts.map +1 -1
  37. package/dist/definition/relations.js +17 -12
  38. package/dist/definition/relations.js.map +1 -1
  39. package/dist/definition/sequence.d.ts +4 -4
  40. package/dist/definition/sequence.d.ts.map +1 -1
  41. package/dist/definition/sequence.js.map +1 -1
  42. package/dist/definition/table.d.ts +118 -13
  43. package/dist/definition/table.d.ts.map +1 -1
  44. package/dist/definition/table.js +137 -4
  45. package/dist/definition/table.js.map +1 -1
  46. package/dist/definition/tenant.d.ts +50 -0
  47. package/dist/definition/tenant.d.ts.map +1 -0
  48. package/dist/definition/tenant.js +73 -0
  49. package/dist/definition/tenant.js.map +1 -0
  50. package/dist/definition/union.d.ts +84 -0
  51. package/dist/definition/union.d.ts.map +1 -0
  52. package/dist/definition/union.js +89 -0
  53. package/dist/definition/union.js.map +1 -0
  54. package/dist/definition/view.js.map +1 -1
  55. package/dist/index.d.ts +3 -3
  56. package/dist/index.d.ts.map +1 -1
  57. package/dist/index.js +2 -2
  58. package/dist/index.js.map +1 -1
  59. package/dist/runtime/base.d.ts +22 -4
  60. package/dist/runtime/base.d.ts.map +1 -1
  61. package/dist/runtime/base.js.map +1 -1
  62. package/dist/runtime/column.d.ts +54 -3
  63. package/dist/runtime/column.d.ts.map +1 -1
  64. package/dist/runtime/column.js +75 -7
  65. package/dist/runtime/column.js.map +1 -1
  66. package/dist/runtime/context.d.ts +30 -2
  67. package/dist/runtime/context.d.ts.map +1 -1
  68. package/dist/runtime/context.js +6 -0
  69. package/dist/runtime/context.js.map +1 -1
  70. package/dist/runtime/errors.d.ts +14 -0
  71. package/dist/runtime/errors.d.ts.map +1 -0
  72. package/dist/runtime/errors.js +19 -0
  73. package/dist/runtime/errors.js.map +1 -0
  74. package/dist/runtime/executor.d.ts +29 -1
  75. package/dist/runtime/executor.d.ts.map +1 -1
  76. package/dist/runtime/executor.js +23 -0
  77. package/dist/runtime/executor.js.map +1 -1
  78. package/dist/runtime/group.d.ts +54 -0
  79. package/dist/runtime/group.d.ts.map +1 -0
  80. package/dist/runtime/group.js +96 -0
  81. package/dist/runtime/group.js.map +1 -0
  82. package/dist/runtime/index.d.ts +9 -6
  83. package/dist/runtime/index.d.ts.map +1 -1
  84. package/dist/runtime/index.js +6 -3
  85. package/dist/runtime/index.js.map +1 -1
  86. package/dist/runtime/operation.d.ts +227 -29
  87. package/dist/runtime/operation.d.ts.map +1 -1
  88. package/dist/runtime/operation.js +525 -49
  89. package/dist/runtime/operation.js.map +1 -1
  90. package/dist/runtime/query.d.ts +102 -34
  91. package/dist/runtime/query.d.ts.map +1 -1
  92. package/dist/runtime/query.js +140 -31
  93. package/dist/runtime/query.js.map +1 -1
  94. package/dist/runtime/registry.d.ts +114 -4
  95. package/dist/runtime/registry.d.ts.map +1 -1
  96. package/dist/runtime/registry.js +366 -9
  97. package/dist/runtime/registry.js.map +1 -1
  98. package/dist/runtime/session.d.ts +10 -4
  99. package/dist/runtime/session.d.ts.map +1 -1
  100. package/dist/runtime/session.js.map +1 -1
  101. package/dist/runtime/table.d.ts +87 -8
  102. package/dist/runtime/table.d.ts.map +1 -1
  103. package/dist/runtime/table.js +142 -5
  104. package/dist/runtime/table.js.map +1 -1
  105. package/dist/runtime/union.d.ts +33 -0
  106. package/dist/runtime/union.d.ts.map +1 -0
  107. package/dist/runtime/union.js +69 -0
  108. package/dist/runtime/union.js.map +1 -0
  109. package/dist/sql/index.d.ts +1 -1
  110. package/dist/sql/index.d.ts.map +1 -1
  111. package/dist/sql/index.js.map +1 -1
  112. package/dist/sql/nodes.d.ts +33 -6
  113. package/dist/sql/nodes.d.ts.map +1 -1
  114. package/dist/sql/nodes.js +25 -0
  115. package/dist/sql/nodes.js.map +1 -1
  116. package/dist/sql/tag.d.ts +17 -0
  117. package/dist/sql/tag.d.ts.map +1 -1
  118. package/dist/sql/tag.js +95 -0
  119. package/dist/sql/tag.js.map +1 -1
  120. package/dist/sql/utils.d.ts +2 -2
  121. package/dist/sql/utils.d.ts.map +1 -1
  122. package/dist/sql/utils.js.map +1 -1
  123. package/dist/utils/index.d.ts +1 -1
  124. package/dist/utils/index.d.ts.map +1 -1
  125. package/dist/utils/index.js.map +1 -1
  126. package/dist/utils/thenable.js.map +1 -1
  127. package/dist/utils/types.d.ts +50 -2
  128. package/dist/utils/types.d.ts.map +1 -1
  129. package/dist/utils/types.js.map +1 -1
  130. package/package.json +27 -22
  131. package/dist/sql/expressions.d.ts +0 -25
  132. package/dist/sql/expressions.d.ts.map +0 -1
  133. package/dist/sql/expressions.js +0 -79
  134. package/dist/sql/expressions.js.map +0 -1
@@ -0,0 +1,131 @@
1
+ import { HasDefault } from "../utils/index.js";
2
+ import { DefinitionNode, NodeRef } from "./base.js";
3
+ import { AnyColumnDefinition } from "./column.js";
4
+ export type AnyColumnGroupDefinition = ColumnGroupDefinition<string, any, any>;
5
+ /**
6
+ * Matches a column group by its `kind` rather than by class: comparing a column against the
7
+ * class structurally is costly enough, across a schema's tables, to exhaust the checker.
8
+ */
9
+ export type GroupOf<TColumns extends TableColumnDefinitions> = {
10
+ readonly kind: "COLUMN_GROUP";
11
+ readonly columns: Readonly<TColumns>;
12
+ };
13
+ /** What a table's `columns` — and an embedded object's — hold: a column, or a group of them. */
14
+ export type AnyTableColumnDefinition = AnyColumnDefinition | AnyColumnGroupDefinition;
15
+ export type TableColumnDefinitions = Record<string, AnyTableColumnDefinition>;
16
+ /**
17
+ * Column refs for a table's — or a group's — columns, as the `check`, `unique`, `primaryKey`
18
+ * and `index` callbacks receive them: a column is a ref, a group the refs of its own columns,
19
+ * so a member reads `c.netValue.amount`.
20
+ */
21
+ export type ColumnRefs<TColumns extends TableColumnDefinitions> = {
22
+ readonly [K in keyof TColumns]: TColumns[K] extends GroupOf<infer TGroupColumns> ? ColumnRefs<TGroupColumns> : NodeRef<TColumns[K]>;
23
+ };
24
+ /** Any one column ref in {@link ColumnRefs}, however deep. */
25
+ export type ColumnRefOf<TColumns extends TableColumnDefinitions> = {
26
+ [K in keyof TColumns]: TColumns[K] extends GroupOf<infer TGroupColumns> ? ColumnRefOf<TGroupColumns> : NodeRef<TColumns[K]>;
27
+ }[keyof TColumns];
28
+ type MemberDefaultOf<TMember> = TMember extends GroupOf<infer TColumns> ? GroupDefaultOf<TColumns> : TMember extends {
29
+ __type: {
30
+ inputType: infer TInput;
31
+ };
32
+ } ? TInput : never;
33
+ /** What `.default()` on a group takes: a value for any of its members, nested groups included. */
34
+ export type GroupDefaultOf<TColumns extends TableColumnDefinitions> = {
35
+ [K in keyof TColumns]?: MemberDefaultOf<TColumns[K]>;
36
+ };
37
+ export type ColumnGroupConfig<TColumns extends TableColumnDefinitions, THasDefault extends boolean> = {
38
+ columns: TColumns;
39
+ hasDefault: THasDefault;
40
+ };
41
+ /**
42
+ * A reusable set of columns — a value object such as `Money` or `Address` — that a table embeds
43
+ * as real columns through {@link EmbeddedObjectDefinition.column}.
44
+ *
45
+ * The object itself is never placed in a table and produces no DDL. Its members are templates:
46
+ * each `.column()` copies them under a prefixed name, so one object placed twice, on one table
47
+ * or several, never shares a definition.
48
+ */
49
+ export declare class EmbeddedObjectDefinition<TColumns extends TableColumnDefinitions> extends DefinitionNode<"embedded", {
50
+ columns: TColumns;
51
+ }> {
52
+ readonly kind: "EMBEDDED_OBJECT";
53
+ readonly columns: Readonly<TColumns>;
54
+ constructor(columns: TColumns);
55
+ /**
56
+ * Embeds this object in a table as the group `name`: one real column per member, named
57
+ * `<name>_<member>` — `money.column("net_value")` gives `net_value_amount` and
58
+ * `net_value_currency`. A nested group chains the prefix: `billing_geo_lat`.
59
+ */
60
+ column<TName extends string>(name: TName): ColumnGroupDefinition<TName, TColumns, false>;
61
+ }
62
+ export type AnyEmbeddedObjectDefinition = EmbeddedObjectDefinition<any>;
63
+ /**
64
+ * An embedded object placed in a table: its own copies of the object's members, named with the
65
+ * group's prefix. A table's `columns` may hold one wherever it holds a column.
66
+ *
67
+ * A group has no nullability of its own. Each member keeps its own `.notNull()` as its column's
68
+ * `NOT NULL`; a group whose members are all nullable can be absent, which it is when all of
69
+ * them are `NULL`.
70
+ */
71
+ export declare class ColumnGroupDefinition<TName extends string, TColumns extends TableColumnDefinitions, THasDefault extends boolean = false> extends DefinitionNode<TName, ColumnGroupConfig<TColumns, THasDefault>> {
72
+ readonly kind: "COLUMN_GROUP";
73
+ readonly object: EmbeddedObjectDefinition<TColumns>;
74
+ readonly columns: Readonly<TColumns>;
75
+ protected _default?: GroupDefaultOf<TColumns>;
76
+ constructor(name: TName, object: EmbeddedObjectDefinition<TColumns>);
77
+ /**
78
+ * Defaults for the group's members — `address.column("billing").default({ city: "-" })` is
79
+ * `.default("-")` on `billing_city`. Members not named keep their own default, if any.
80
+ */
81
+ default(value: GroupDefaultOf<TColumns>): HasDefault<ColumnGroupDefinition<TName, TColumns, true>>;
82
+ toJSON(): {
83
+ kind: "COLUMN_GROUP";
84
+ name: TName;
85
+ columns: {
86
+ readonly kind: "COLUMN";
87
+ readonly name: string;
88
+ readonly dataType: string;
89
+ readonly notNull: boolean;
90
+ readonly primaryKey: boolean;
91
+ readonly unique: boolean;
92
+ readonly defaultValue: string | null;
93
+ readonly check: {
94
+ readonly kind: "CHECK_CONSTRAINT";
95
+ readonly name: string;
96
+ readonly expression: string;
97
+ readonly validated: boolean;
98
+ } | null;
99
+ readonly domain: string | null;
100
+ readonly generated: {
101
+ type: "ALWAYS";
102
+ expression: string;
103
+ mode: "STORED";
104
+ } | null;
105
+ readonly identity: {
106
+ type: import("./column.js").ColumnGeneratedType;
107
+ sequenceName: string | undefined;
108
+ options: {
109
+ dataType: string | undefined;
110
+ cache: number | undefined;
111
+ cycle: boolean | undefined;
112
+ increment: number | undefined;
113
+ minValue: number | undefined;
114
+ maxValue: number | undefined;
115
+ startValue: number | undefined;
116
+ ownedBy: string | undefined;
117
+ } | null;
118
+ } | null;
119
+ readonly deprecated: boolean;
120
+ readonly renamedFrom: string | null;
121
+ }[];
122
+ };
123
+ }
124
+ /**
125
+ * Every real column under `columns`, groups walked depth first, each with its field path —
126
+ * `["netValue", "amount"]`. What reaches the database: DDL, the duplicate-name check, tenant
127
+ * claims.
128
+ */
129
+ export declare function columnEntries(columns: Readonly<TableColumnDefinitions>, path?: string[]): [path: string[], column: AnyColumnDefinition][];
130
+ export {};
131
+ //# sourceMappingURL=embedded.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"embedded.d.ts","sourceRoot":"","sources":["../../src/definition/embedded.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAQ,OAAO,EAAwB,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAoB,MAAM,aAAa,CAAC;AAGpE,MAAM,MAAM,wBAAwB,GAAG,qBAAqB,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,QAAQ,SAAS,sBAAsB,IAAI;IAC7D,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;CACtC,CAAC;AAEF,gGAAgG;AAChG,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG,wBAAwB,CAAC;AAEtF,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,QAAQ,SAAS,sBAAsB,IAAI;IAChE,QAAQ,EAAE,CAAC,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,aAAa,CAAC,GAC5E,UAAU,CAAC,aAAa,CAAC,GACzB,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CACzB,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,WAAW,CAAC,QAAQ,SAAS,sBAAsB,IAAI;KAChE,CAAC,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,aAAa,CAAC,GACnE,WAAW,CAAC,aAAa,CAAC,GAC1B,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CACzB,CAAC,MAAM,QAAQ,CAAC,CAAC;AAElB,KAAK,eAAe,CAAC,OAAO,IAC1B,OAAO,SAAS,OAAO,CAAC,MAAM,QAAQ,CAAC,GACnC,cAAc,CAAC,QAAQ,CAAC,GACxB,OAAO,SAAS;IAAE,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,MAAM,CAAA;KAAE,CAAA;CAAE,GACrD,MAAM,GACN,KAAK,CAAC;AAEd,kGAAkG;AAClG,MAAM,MAAM,cAAc,CAAC,QAAQ,SAAS,sBAAsB,IAAI;KACnE,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CACrD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC3B,QAAQ,SAAS,sBAAsB,EACvC,WAAW,SAAS,OAAO,IACzB;IACF,OAAO,EAAE,QAAQ,CAAC;IAClB,UAAU,EAAE,WAAW,CAAC;CACzB,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,wBAAwB,CACnC,QAAQ,SAAS,sBAAsB,CACvC,SAAQ,cAAc,CAAC,UAAU,EAAE;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC;IACzD,QAAQ,CAAC,IAAI,oBAAwB;IAErC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAEzB,OAAO,EAAE,QAAQ;IAqC7B;;;;OAIG;IACI,MAAM,CAAC,KAAK,SAAS,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,qBAAqB,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC;CAGhG;AAGD,MAAM,MAAM,2BAA2B,GAAG,wBAAwB,CAAC,GAAG,CAAC,CAAC;AAExE;;;;;;;GAOG;AACH,qBAAa,qBAAqB,CAChC,KAAK,SAAS,MAAM,EACpB,QAAQ,SAAS,sBAAsB,EACvC,WAAW,SAAS,OAAO,GAAG,KAAK,CACnC,SAAQ,cAAc,CAAC,KAAK,EAAE,iBAAiB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvE,QAAQ,CAAC,IAAI,iBAAqB;IAElC,QAAQ,CAAC,MAAM,EAAE,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IACpD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAErC,SAAS,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;gBAElC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,wBAAwB,CAAC,QAAQ,CAAC;IAiBnE;;;OAGG;IACI,OAAO,CACZ,KAAK,EAAE,cAAc,CAAC,QAAQ,CAAC,GAC9B,UAAU,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IAkDpD,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOd;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,QAAQ,CAAC,sBAAsB,CAAC,EACzC,IAAI,GAAE,MAAM,EAAO,GAClB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,CAMjD"}
@@ -0,0 +1,133 @@
1
+ import { DefinitionNode, Kind, NodeRef, RESERVED_FIELD_NAMES } from "./base.js";
2
+ import { ColumnDefinition } from "./column.js";
3
+ /**
4
+ * A reusable set of columns — a value object such as `Money` or `Address` — that a table embeds
5
+ * as real columns through {@link EmbeddedObjectDefinition.column}.
6
+ *
7
+ * The object itself is never placed in a table and produces no DDL. Its members are templates:
8
+ * each `.column()` copies them under a prefixed name, so one object placed twice, on one table
9
+ * or several, never shares a definition.
10
+ */
11
+ export class EmbeddedObjectDefinition extends DefinitionNode {
12
+ kind = Kind.EMBEDDED_OBJECT;
13
+ columns;
14
+ constructor(columns) {
15
+ super("embedded");
16
+ for (const [field, member] of Object.entries(columns)) {
17
+ if (RESERVED_FIELD_NAMES.includes(field)) {
18
+ throw new Error(`An embedded object declares a member named "${field}", which is reserved. ` +
19
+ `The runtime writes ${RESERVED_FIELD_NAMES.join(" and ")} onto every result row.`);
20
+ }
21
+ if (member instanceof ColumnGroupDefinition) {
22
+ continue;
23
+ }
24
+ if (!(member instanceof ColumnDefinition)) {
25
+ throw new Error(`Embedded object member "${field}" is neither a column nor a group.`);
26
+ }
27
+ if (member["_primaryKey"]) {
28
+ throw new Error(`Embedded object member "${field}" is a primary key. A key belongs to the table, ` +
29
+ `not to an object that may be embedded several times.`);
30
+ }
31
+ if (member["_tenantKey"]) {
32
+ throw new Error(`Embedded object member "${field}" is a tenant claim. A claim column belongs to the ` +
33
+ `table's tenant scope, not to an embedded object.`);
34
+ }
35
+ }
36
+ this.columns = Object.freeze({ ...columns });
37
+ }
38
+ /**
39
+ * Embeds this object in a table as the group `name`: one real column per member, named
40
+ * `<name>_<member>` — `money.column("net_value")` gives `net_value_amount` and
41
+ * `net_value_currency`. A nested group chains the prefix: `billing_geo_lat`.
42
+ */
43
+ column(name) {
44
+ return new ColumnGroupDefinition(name, this);
45
+ }
46
+ }
47
+ /**
48
+ * An embedded object placed in a table: its own copies of the object's members, named with the
49
+ * group's prefix. A table's `columns` may hold one wherever it holds a column.
50
+ *
51
+ * A group has no nullability of its own. Each member keeps its own `.notNull()` as its column's
52
+ * `NOT NULL`; a group whose members are all nullable can be absent, which it is when all of
53
+ * them are `NULL`.
54
+ */
55
+ export class ColumnGroupDefinition extends DefinitionNode {
56
+ kind = Kind.COLUMN_GROUP;
57
+ object;
58
+ columns;
59
+ _default;
60
+ constructor(name, object) {
61
+ super(name);
62
+ this.object = object;
63
+ const columns = {};
64
+ for (const [field, member] of Object.entries(object.columns)) {
65
+ columns[field] =
66
+ member instanceof ColumnGroupDefinition
67
+ ? member._renamed(`${name}_${member.name}`)
68
+ : member._renamed(`${name}_${member.name}`, name);
69
+ }
70
+ this.columns = Object.freeze(columns);
71
+ }
72
+ /**
73
+ * Defaults for the group's members — `address.column("billing").default({ city: "-" })` is
74
+ * `.default("-")` on `billing_city`. Members not named keep their own default, if any.
75
+ */
76
+ default(value) {
77
+ for (const [field, memberValue] of Object.entries(value)) {
78
+ const member = this.columns[field];
79
+ if (!member) {
80
+ throw new Error(`Group "${this.name}" has no member "${field}" to default.`);
81
+ }
82
+ if (memberValue === undefined) {
83
+ continue;
84
+ }
85
+ if (member instanceof ColumnGroupDefinition) {
86
+ member.default(memberValue);
87
+ }
88
+ else {
89
+ member.default(memberValue);
90
+ }
91
+ }
92
+ this._default = { ...this._default, ...value };
93
+ return this;
94
+ }
95
+ /**
96
+ * A copy of this group under another name, defaults included — a group nested in an
97
+ * embedded object, placed in a table under its parent's prefix.
98
+ *
99
+ * @internal
100
+ */
101
+ _renamed(name) {
102
+ const copy = new ColumnGroupDefinition(name, this.object);
103
+ if (this._default) {
104
+ copy.default(this._default);
105
+ }
106
+ return copy;
107
+ }
108
+ /** @internal */
109
+ _getColumnRefs() {
110
+ return Object.fromEntries(Object.entries(this.columns).map(([field, member]) => [
111
+ field,
112
+ member instanceof ColumnGroupDefinition ? member._getColumnRefs() : new NodeRef(member),
113
+ ]));
114
+ }
115
+ toJSON() {
116
+ return {
117
+ kind: this.kind,
118
+ name: this.name,
119
+ columns: columnEntries(this.columns).map(([, column]) => column.toJSON()),
120
+ };
121
+ }
122
+ }
123
+ /**
124
+ * Every real column under `columns`, groups walked depth first, each with its field path —
125
+ * `["netValue", "amount"]`. What reaches the database: DDL, the duplicate-name check, tenant
126
+ * claims.
127
+ */
128
+ export function columnEntries(columns, path = []) {
129
+ return Object.entries(columns).flatMap(([field, member]) => member instanceof ColumnGroupDefinition
130
+ ? columnEntries(member.columns, [...path, field])
131
+ : [[[...path, field], member]]);
132
+ }
133
+ //# sourceMappingURL=embedded.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"embedded.js","sourceRoot":"","sources":["../../src/definition/embedded.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAuB,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAyDpE;;;;;;;GAOG;AACH,MAAM,OAAO,wBAEX,SAAQ,cAAiD;IAChD,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC;IAE5B,OAAO,CAAqB;IAErC,YAAY,OAAiB;QAC3B,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACtD,IAAI,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CACb,+CAA+C,KAAK,wBAAwB;oBAC1E,sBAAsB,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,yBAAyB,CACpF,CAAC;YACJ,CAAC;YAED,IAAI,MAAM,YAAY,qBAAqB,EAAE,CAAC;gBAC5C,SAAS;YACX,CAAC;YAED,IAAI,CAAC,CAAC,MAAM,YAAY,gBAAgB,CAAC,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,oCAAoC,CAAC,CAAC;YACxF,CAAC;YAED,IAAI,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CACb,2BAA2B,KAAK,kDAAkD;oBAChF,sDAAsD,CACzD,CAAC;YACJ,CAAC;YAED,IAAI,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CACb,2BAA2B,KAAK,qDAAqD;oBACnF,kDAAkD,CACrD,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAuB,IAAW;QAC7C,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;CACF;AAKD;;;;;;;GAOG;AACH,MAAM,OAAO,qBAIX,SAAQ,cAA+D;IAC9D,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC;IAEzB,MAAM,CAAqC;IAC3C,OAAO,CAAqB;IAE3B,QAAQ,CAA4B;IAE9C,YAAY,IAAW,EAAE,MAA0C;QACjE,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,MAAM,OAAO,GAA6C,EAAE,CAAC;QAE7D,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAA2B,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YACvF,OAAO,CAAC,KAAK,CAAC;gBACZ,MAAM,YAAY,qBAAqB;oBACrC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;oBAC3C,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAuB,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,OAAO,CACZ,KAA+B;QAE/B,KAAK,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,MAAM,MAAM,GAAI,IAAI,CAAC,OAAkC,CAAC,KAAK,CAAC,CAAC;YAE/D,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,CAAC,IAAI,oBAAoB,KAAK,eAAe,CAAC,CAAC;YAC/E,CAAC;YAED,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,SAAS;YACX,CAAC;YAED,IAAI,MAAM,YAAY,qBAAqB,EAAE,CAAC;gBAC5C,MAAM,CAAC,OAAO,CAAC,WAAqD,CAAC,CAAC;YACxE,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,KAAK,EAAE,CAAC;QAE/C,OAAO,IAA2E,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,IAAY;QAC1B,MAAM,IAAI,GAAG,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1D,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,IAAuB,CAAC;IACjC,CAAC;IAED,gBAAgB;IAChB,cAAc;QACZ,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAA2B,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;YAC9E,KAAK;YACL,MAAM,YAAY,qBAAqB,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC;SACxF,CAAC,CACqB,CAAC;IAC5B,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;SAC1E,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAC3B,OAAyC,EACzC,OAAiB,EAAE;IAEnB,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CACzD,MAAM,YAAY,qBAAqB;QACrC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,EAAE,MAA6B,CAAC,CAAC,CACxD,CAAC;AACJ,CAAC","sourcesContent":["import { HasDefault } from \"../utils/index.js\";\nimport { DefinitionNode, Kind, NodeRef, RESERVED_FIELD_NAMES } from \"./base.js\";\nimport { AnyColumnDefinition, ColumnDefinition } from \"./column.js\";\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type AnyColumnGroupDefinition = ColumnGroupDefinition<string, any, any>;\n\n/**\n * Matches a column group by its `kind` rather than by class: comparing a column against the\n * class structurally is costly enough, across a schema's tables, to exhaust the checker.\n */\nexport type GroupOf<TColumns extends TableColumnDefinitions> = {\n readonly kind: \"COLUMN_GROUP\";\n readonly columns: Readonly<TColumns>;\n};\n\n/** What a table's `columns` — and an embedded object's — hold: a column, or a group of them. */\nexport type AnyTableColumnDefinition = AnyColumnDefinition | AnyColumnGroupDefinition;\n\nexport type TableColumnDefinitions = Record<string, AnyTableColumnDefinition>;\n\n/**\n * Column refs for a table's — or a group's — columns, as the `check`, `unique`, `primaryKey`\n * and `index` callbacks receive them: a column is a ref, a group the refs of its own columns,\n * so a member reads `c.netValue.amount`.\n */\nexport type ColumnRefs<TColumns extends TableColumnDefinitions> = {\n readonly [K in keyof TColumns]: TColumns[K] extends GroupOf<infer TGroupColumns>\n ? ColumnRefs<TGroupColumns>\n : NodeRef<TColumns[K]>;\n};\n\n/** Any one column ref in {@link ColumnRefs}, however deep. */\nexport type ColumnRefOf<TColumns extends TableColumnDefinitions> = {\n [K in keyof TColumns]: TColumns[K] extends GroupOf<infer TGroupColumns>\n ? ColumnRefOf<TGroupColumns>\n : NodeRef<TColumns[K]>;\n}[keyof TColumns];\n\ntype MemberDefaultOf<TMember> =\n TMember extends GroupOf<infer TColumns>\n ? GroupDefaultOf<TColumns>\n : TMember extends { __type: { inputType: infer TInput } }\n ? TInput\n : never;\n\n/** What `.default()` on a group takes: a value for any of its members, nested groups included. */\nexport type GroupDefaultOf<TColumns extends TableColumnDefinitions> = {\n [K in keyof TColumns]?: MemberDefaultOf<TColumns[K]>;\n};\n\nexport type ColumnGroupConfig<\n TColumns extends TableColumnDefinitions,\n THasDefault extends boolean,\n> = {\n columns: TColumns;\n hasDefault: THasDefault;\n};\n\n/**\n * A reusable set of columns — a value object such as `Money` or `Address` — that a table embeds\n * as real columns through {@link EmbeddedObjectDefinition.column}.\n *\n * The object itself is never placed in a table and produces no DDL. Its members are templates:\n * each `.column()` copies them under a prefixed name, so one object placed twice, on one table\n * or several, never shares a definition.\n */\nexport class EmbeddedObjectDefinition<\n TColumns extends TableColumnDefinitions,\n> extends DefinitionNode<\"embedded\", { columns: TColumns }> {\n readonly kind = Kind.EMBEDDED_OBJECT;\n\n readonly columns: Readonly<TColumns>;\n\n constructor(columns: TColumns) {\n super(\"embedded\");\n\n for (const [field, member] of Object.entries(columns)) {\n if (RESERVED_FIELD_NAMES.includes(field)) {\n throw new Error(\n `An embedded object declares a member named \"${field}\", which is reserved. ` +\n `The runtime writes ${RESERVED_FIELD_NAMES.join(\" and \")} onto every result row.`\n );\n }\n\n if (member instanceof ColumnGroupDefinition) {\n continue;\n }\n\n if (!(member instanceof ColumnDefinition)) {\n throw new Error(`Embedded object member \"${field}\" is neither a column nor a group.`);\n }\n\n if (member[\"_primaryKey\"]) {\n throw new Error(\n `Embedded object member \"${field}\" is a primary key. A key belongs to the table, ` +\n `not to an object that may be embedded several times.`\n );\n }\n\n if (member[\"_tenantKey\"]) {\n throw new Error(\n `Embedded object member \"${field}\" is a tenant claim. A claim column belongs to the ` +\n `table's tenant scope, not to an embedded object.`\n );\n }\n }\n\n this.columns = Object.freeze({ ...columns });\n }\n\n /**\n * Embeds this object in a table as the group `name`: one real column per member, named\n * `<name>_<member>` — `money.column(\"net_value\")` gives `net_value_amount` and\n * `net_value_currency`. A nested group chains the prefix: `billing_geo_lat`.\n */\n public column<TName extends string>(name: TName): ColumnGroupDefinition<TName, TColumns, false> {\n return new ColumnGroupDefinition(name, this);\n }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type AnyEmbeddedObjectDefinition = EmbeddedObjectDefinition<any>;\n\n/**\n * An embedded object placed in a table: its own copies of the object's members, named with the\n * group's prefix. A table's `columns` may hold one wherever it holds a column.\n *\n * A group has no nullability of its own. Each member keeps its own `.notNull()` as its column's\n * `NOT NULL`; a group whose members are all nullable can be absent, which it is when all of\n * them are `NULL`.\n */\nexport class ColumnGroupDefinition<\n TName extends string,\n TColumns extends TableColumnDefinitions,\n THasDefault extends boolean = false,\n> extends DefinitionNode<TName, ColumnGroupConfig<TColumns, THasDefault>> {\n readonly kind = Kind.COLUMN_GROUP;\n\n readonly object: EmbeddedObjectDefinition<TColumns>;\n readonly columns: Readonly<TColumns>;\n\n protected _default?: GroupDefaultOf<TColumns>;\n\n constructor(name: TName, object: EmbeddedObjectDefinition<TColumns>) {\n super(name);\n\n this.object = object;\n\n const columns: Record<string, AnyTableColumnDefinition> = {};\n\n for (const [field, member] of Object.entries<AnyTableColumnDefinition>(object.columns)) {\n columns[field] =\n member instanceof ColumnGroupDefinition\n ? member._renamed(`${name}_${member.name}`)\n : member._renamed(`${name}_${member.name}`, name);\n }\n\n this.columns = Object.freeze(columns) as Readonly<TColumns>;\n }\n\n /**\n * Defaults for the group's members — `address.column(\"billing\").default({ city: \"-\" })` is\n * `.default(\"-\")` on `billing_city`. Members not named keep their own default, if any.\n */\n public default(\n value: GroupDefaultOf<TColumns>\n ): HasDefault<ColumnGroupDefinition<TName, TColumns, true>> {\n for (const [field, memberValue] of Object.entries(value)) {\n const member = (this.columns as TableColumnDefinitions)[field];\n\n if (!member) {\n throw new Error(`Group \"${this.name}\" has no member \"${field}\" to default.`);\n }\n\n if (memberValue === undefined) {\n continue;\n }\n\n if (member instanceof ColumnGroupDefinition) {\n member.default(memberValue as GroupDefaultOf<TableColumnDefinitions>);\n } else {\n member.default(memberValue);\n }\n }\n\n this._default = { ...this._default, ...value };\n\n return this as unknown as HasDefault<ColumnGroupDefinition<TName, TColumns, true>>;\n }\n\n /**\n * A copy of this group under another name, defaults included — a group nested in an\n * embedded object, placed in a table under its parent's prefix.\n *\n * @internal\n */\n public _renamed(name: string): this {\n const copy = new ColumnGroupDefinition(name, this.object);\n\n if (this._default) {\n copy.default(this._default);\n }\n\n return copy as unknown as this;\n }\n\n /** @internal */\n _getColumnRefs(): ColumnRefs<TColumns> {\n return Object.fromEntries(\n Object.entries<AnyTableColumnDefinition>(this.columns).map(([field, member]) => [\n field,\n member instanceof ColumnGroupDefinition ? member._getColumnRefs() : new NodeRef(member),\n ])\n ) as ColumnRefs<TColumns>;\n }\n\n public toJSON() {\n return {\n kind: this.kind,\n name: this.name,\n columns: columnEntries(this.columns).map(([, column]) => column.toJSON()),\n };\n }\n}\n\n/**\n * Every real column under `columns`, groups walked depth first, each with its field path —\n * `[\"netValue\", \"amount\"]`. What reaches the database: DDL, the duplicate-name check, tenant\n * claims.\n */\nexport function columnEntries(\n columns: Readonly<TableColumnDefinitions>,\n path: string[] = []\n): [path: string[], column: AnyColumnDefinition][] {\n return Object.entries(columns).flatMap(([field, member]) =>\n member instanceof ColumnGroupDefinition\n ? columnEntries(member.columns, [...path, field])\n : [[[...path, field], member as AnyColumnDefinition]]\n );\n}\n"]}
@@ -1,11 +1,14 @@
1
- export { DefinitionNode, NodeRef, Kind, Relation, defaultCodec, type NodeKind, type RelationType, type ColumnCodec, type DefinitionSchema, } from "./base.js";
2
- export { ColumnDefinition, type ColumnConfig, type AnyColumnDefinition, type UpdateGuard, type ColumnGeneratedConfig, type ColumnGeneratedType, type ColumnIdentityConfig, } from "./column.js";
1
+ export { DefinitionNode, NodeRef, Kind, META_FIELD, KEY_FIELD, RESERVED_FIELD_NAMES, Relation, defaultCodec, type NodeKind, type RelationType, type ColumnCodec, type ColumnValidator, type DefinitionSchema, } from "./base.js";
2
+ export { ColumnDefinition, type ColumnConfig, type ColumnRuntimeType, type AnyColumnDefinition, type TypeArgOf, type UpdateGuard, type ColumnGeneratedConfig, type ColumnGeneratedType, type ColumnIdentityConfig, } from "./column.js";
3
3
  export { DomainDefinition, type DomainConfig, type AnyDomainDefinition } from "./domain.js";
4
- export { IndexDefinition, IndexColumnDefinition, type IndexConfig, type AnyIndexDefinition, type ColumnConfigRefs, type ColumnConfigType, } from "./indexes.js";
4
+ export { IndexDefinition, IndexColumnDefinition, type IndexConfig, type AnyIndexDefinition, type ColumnConfigRefs, type ColumnConfigType, type IndexColumnRefs, } from "./indexes.js";
5
5
  export { NamespaceDefinition, type AnyNamespaceDefinition } from "./namespace.js";
6
6
  export { SequenceDefinition, type SequenceConfig, type AnySequenceDefinition } from "./sequence.js";
7
+ export { TenantScopeDefinition, type AnyTenantScopeDefinition, type TenantClaimColumns, type TenantScopeConfig, type WithClaims, } from "./tenant.js";
7
8
  export { TableDefinition, type TableConfig, type AnyTableDefinition, type ColumnRefs, } from "./table.js";
9
+ export { EmbeddedObjectDefinition, ColumnGroupDefinition, columnEntries, type AnyColumnGroupDefinition, type AnyEmbeddedObjectDefinition, type AnyTableColumnDefinition, type ColumnGroupConfig, type ColumnRefOf, type GroupDefaultOf, type TableColumnDefinitions, } from "./embedded.js";
8
10
  export { ViewDefinition } from "./view.js";
9
11
  export { CheckConstraintDefinition, PrimaryKeyConstraintDefinition, UniqueConstraintDefinition, type AnyConstraintDefinition, type AnyCheckConstraintDefinition, type AnyUniqueConstraintDefinition, type AnyPrimaryKeyConstraintDefinition, type CheckConstraintConfig, type UniqueConstraintConfig, type PrimaryKeyConstraintConfig, } from "./constraint.js";
10
- export { RelationsDefinition, type RelationsConfig, type AnyFieldRelation, type AnyRelationDefinition, type AnyTableRelations, type FieldRelation, } from "./relations.js";
12
+ export { RelationsDefinition, type RelationsConfig, type AnyFieldRelation, type AnyRelationDefinition, type AnyTableRelations, type AnyRelationTarget, type FieldRelation, type RelationTargetColumns, type TableDefinitionColumn, type UnionTargetColumns, } from "./relations.js";
13
+ export { UnionDefinition, UnionColumnDefinition, type AnyUnionColumnDefinition, type AnyUnionDefinition, type AnyUnionMembers, type SharedFieldsOf, type UnionColumns, type UnionConfig, } from "./union.js";
11
14
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,YAAY,EACZ,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,gBAAgB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,gBAAgB,EAChB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,WAAW,EAChB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,GAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,KAAK,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAC5F,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAE,KAAK,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EACL,eAAe,EACf,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,UAAU,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EACL,yBAAyB,EACzB,8BAA8B,EAC9B,0BAA0B,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,iCAAiC,EACtC,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,GAChC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,OAAO,EACP,IAAI,EACJ,UAAU,EACV,SAAS,EACT,oBAAoB,EACpB,QAAQ,EACR,YAAY,EACZ,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,gBAAgB,EAChB,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,GAC1B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,KAAK,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAC5F,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,eAAe,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAE,KAAK,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EACL,qBAAqB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,UAAU,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,eAAe,EACf,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,UAAU,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,wBAAwB,EACxB,qBAAqB,EACrB,aAAa,EACb,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,sBAAsB,GAC5B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EACL,yBAAyB,EACzB,8BAA8B,EAC9B,0BAA0B,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,iCAAiC,EACtC,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,GAChC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,GACxB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,KAAK,WAAW,GACjB,MAAM,YAAY,CAAC"}
@@ -1,11 +1,14 @@
1
- export { DefinitionNode, NodeRef, Kind, Relation, defaultCodec, } from "./base.js";
1
+ export { DefinitionNode, NodeRef, Kind, META_FIELD, KEY_FIELD, RESERVED_FIELD_NAMES, Relation, defaultCodec, } from "./base.js";
2
2
  export { ColumnDefinition, } from "./column.js";
3
3
  export { DomainDefinition } from "./domain.js";
4
4
  export { IndexDefinition, IndexColumnDefinition, } from "./indexes.js";
5
5
  export { NamespaceDefinition } from "./namespace.js";
6
6
  export { SequenceDefinition } from "./sequence.js";
7
+ export { TenantScopeDefinition, } from "./tenant.js";
7
8
  export { TableDefinition, } from "./table.js";
9
+ export { EmbeddedObjectDefinition, ColumnGroupDefinition, columnEntries, } from "./embedded.js";
8
10
  export { ViewDefinition } from "./view.js";
9
11
  export { CheckConstraintDefinition, PrimaryKeyConstraintDefinition, UniqueConstraintDefinition, } from "./constraint.js";
10
12
  export { RelationsDefinition, } from "./relations.js";
13
+ export { UnionDefinition, UnionColumnDefinition, } from "./union.js";
11
14
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,YAAY,GAKb,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,gBAAgB,GAOjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAA+C,MAAM,aAAa,CAAC;AAC5F,OAAO,EACL,eAAe,EACf,qBAAqB,GAKtB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAA+B,MAAM,gBAAgB,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAmD,MAAM,eAAe,CAAC;AACpG,OAAO,EACL,eAAe,GAIhB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EACL,yBAAyB,EACzB,8BAA8B,EAC9B,0BAA0B,GAQ3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,GAMpB,MAAM,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/definition/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,OAAO,EACP,IAAI,EACJ,UAAU,EACV,SAAS,EACT,oBAAoB,EACpB,QAAQ,EACR,YAAY,GAMb,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,gBAAgB,GASjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAA+C,MAAM,aAAa,CAAC;AAC5F,OAAO,EACL,eAAe,EACf,qBAAqB,GAMtB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAA+B,MAAM,gBAAgB,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAmD,MAAM,eAAe,CAAC;AACpG,OAAO,EACL,qBAAqB,GAKtB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,eAAe,GAIhB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,wBAAwB,EACxB,qBAAqB,EACrB,aAAa,GAQd,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EACL,yBAAyB,EACzB,8BAA8B,EAC9B,0BAA0B,GAQ3B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,GAUpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,eAAe,EACf,qBAAqB,GAOtB,MAAM,YAAY,CAAC","sourcesContent":["export {\n DefinitionNode,\n NodeRef,\n Kind,\n META_FIELD,\n KEY_FIELD,\n RESERVED_FIELD_NAMES,\n Relation,\n defaultCodec,\n type NodeKind,\n type RelationType,\n type ColumnCodec,\n type ColumnValidator,\n type DefinitionSchema,\n} from \"./base.js\";\nexport {\n ColumnDefinition,\n type ColumnConfig,\n type ColumnRuntimeType,\n type AnyColumnDefinition,\n type TypeArgOf,\n type UpdateGuard,\n type ColumnGeneratedConfig,\n type ColumnGeneratedType,\n type ColumnIdentityConfig,\n} from \"./column.js\";\nexport { DomainDefinition, type DomainConfig, type AnyDomainDefinition } from \"./domain.js\";\nexport {\n IndexDefinition,\n IndexColumnDefinition,\n type IndexConfig,\n type AnyIndexDefinition,\n type ColumnConfigRefs,\n type ColumnConfigType,\n type IndexColumnRefs,\n} from \"./indexes.js\";\nexport { NamespaceDefinition, type AnyNamespaceDefinition } from \"./namespace.js\";\nexport { SequenceDefinition, type SequenceConfig, type AnySequenceDefinition } from \"./sequence.js\";\nexport {\n TenantScopeDefinition,\n type AnyTenantScopeDefinition,\n type TenantClaimColumns,\n type TenantScopeConfig,\n type WithClaims,\n} from \"./tenant.js\";\nexport {\n TableDefinition,\n type TableConfig,\n type AnyTableDefinition,\n type ColumnRefs,\n} from \"./table.js\";\nexport {\n EmbeddedObjectDefinition,\n ColumnGroupDefinition,\n columnEntries,\n type AnyColumnGroupDefinition,\n type AnyEmbeddedObjectDefinition,\n type AnyTableColumnDefinition,\n type ColumnGroupConfig,\n type ColumnRefOf,\n type GroupDefaultOf,\n type TableColumnDefinitions,\n} from \"./embedded.js\";\nexport { ViewDefinition } from \"./view.js\";\nexport {\n CheckConstraintDefinition,\n PrimaryKeyConstraintDefinition,\n UniqueConstraintDefinition,\n type AnyConstraintDefinition,\n type AnyCheckConstraintDefinition,\n type AnyUniqueConstraintDefinition,\n type AnyPrimaryKeyConstraintDefinition,\n type CheckConstraintConfig,\n type UniqueConstraintConfig,\n type PrimaryKeyConstraintConfig,\n} from \"./constraint.js\";\nexport {\n RelationsDefinition,\n type RelationsConfig,\n type AnyFieldRelation,\n type AnyRelationDefinition,\n type AnyTableRelations,\n type AnyRelationTarget,\n type FieldRelation,\n type RelationTargetColumns,\n type TableDefinitionColumn,\n type UnionTargetColumns,\n} from \"./relations.js\";\nexport {\n UnionDefinition,\n UnionColumnDefinition,\n type AnyUnionColumnDefinition,\n type AnyUnionDefinition,\n type AnyUnionMembers,\n type SharedFieldsOf,\n type UnionColumns,\n type UnionConfig,\n} from \"./union.js\";\n"]}
@@ -1,28 +1,46 @@
1
1
  import { Unique } from "../utils/index.js";
2
+ import { SQLContext, SQLNode, SQLStatement } from "../sql/index.js";
2
3
  import { DefinitionNode, NodeRef } from "./base.js";
3
- import { AnyColumnDefinition } from "./column.js";
4
- import { AnyTableDefinition, ColumnRefs } from "./table.js";
5
- export interface IndexConfig {
4
+ import { GroupOf, TableColumnDefinitions } from "./embedded.js";
5
+ import { AnyTableDefinition, ColumnRefOf, ColumnRefs } from "./table.js";
6
+ export type IndexConfig = {
6
7
  unique?: boolean;
7
8
  table: AnyTableDefinition;
8
- }
9
+ };
9
10
  export type AnyIndexDefinition = IndexDefinition<any, any>;
10
- export type ColumnConfigRefs<TIndexName extends string, TTable extends AnyTableDefinition> = Readonly<{
11
- readonly [K in keyof TTable["columns"]]: IndexColumnDefinition<TIndexName, TTable["columns"][K]>;
11
+ /** Index columns for `columns` — a group nests its members' — as `index().columns()` gets them. */
12
+ export type IndexColumnRefs<TIndexName extends string, TColumns extends TableColumnDefinitions> = Readonly<{
13
+ readonly [K in keyof TColumns]: TColumns[K] extends GroupOf<infer TGroupColumns> ? IndexColumnRefs<TIndexName, TGroupColumns> : IndexColumnDefinition<TIndexName, TColumns[K]>;
12
14
  }>;
13
- export type ColumnConfigType<TIndexName extends string, TTable extends AnyTableDefinition> = ColumnConfigRefs<TIndexName, TTable>[keyof TTable["columns"]];
15
+ type IndexColumnOf<TIndexName extends string, TColumns extends TableColumnDefinitions> = {
16
+ [K in keyof TColumns]: TColumns[K] extends GroupOf<infer TGroupColumns> ? IndexColumnOf<TIndexName, TGroupColumns> : IndexColumnDefinition<TIndexName, TColumns[K]>;
17
+ }[keyof TColumns];
18
+ export type ColumnConfigRefs<TIndexName extends string, TTable extends AnyTableDefinition> = IndexColumnRefs<TIndexName, TTable["columns"]>;
19
+ export type ColumnConfigType<TIndexName extends string, TTable extends AnyTableDefinition> = IndexColumnOf<TIndexName, TTable["columns"]>;
14
20
  export declare class IndexDefinition<TName extends string, TTable extends AnyTableDefinition> extends DefinitionNode<TName, IndexConfig> {
15
21
  readonly kind: "INDEX";
16
22
  protected _table: TTable;
17
23
  protected _unique: boolean;
18
- protected _columns: ColumnConfigType<TName, TTable>[];
19
- protected _include?: ColumnRefs<TTable["columns"]>[keyof TTable["columns"]][];
24
+ protected _columns: (ColumnConfigType<TName, TTable> | SQLNode)[];
25
+ protected _include?: ColumnRefOf<TTable["columns"]>[];
20
26
  protected _distinctNulls?: boolean;
27
+ protected _where?: SQLNode;
21
28
  constructor(name: TName, config: IndexConfig);
22
29
  private _getColumnConfigRefs;
23
30
  unique(): Unique<this>;
24
- columns(cb: (columns: ColumnConfigRefs<TName, TTable>) => ColumnConfigType<TName, TTable>[]): this;
25
- include(cb: (columns: ColumnRefs<TTable["columns"]>) => ColumnRefs<TTable["columns"]>[keyof TTable["columns"]][]): this;
31
+ /**
32
+ * The index's keys, in order: columns, or expressions over them —
33
+ * `.columns((c) => [c.workspaceId, sql\`lower(${c.email})\`])`. An expression must be
34
+ * immutable, as DSQL requires.
35
+ */
36
+ columns(cb: (columns: ColumnConfigRefs<TName, TTable>) => (ColumnConfigType<TName, TTable> | SQLNode)[]): this;
37
+ /**
38
+ * Makes the index partial: it covers the rows the predicate holds for —
39
+ * `.where((c) => sql\`${c.deletedAt} IS NULL\`)`. The predicate must be immutable, and a query
40
+ * uses the index only when its own `WHERE` implies the predicate.
41
+ */
42
+ where(cb: (columns: ColumnRefs<TTable["columns"]>) => SQLNode): this;
43
+ include(cb: (columns: ColumnRefs<TTable["columns"]>) => ColumnRefOf<TTable["columns"]>[]): this;
26
44
  /**
27
45
  * Set nulls distinct behavior for the index.
28
46
  * `NULLS [NOT] DISTINCT` specifies whether NULL values are treated as distinct for the purposes of index uniqueness.
@@ -34,31 +52,43 @@ export declare class IndexDefinition<TName extends string, TTable extends AnyTab
34
52
  readonly name: TName;
35
53
  readonly unique: boolean;
36
54
  readonly distinctNulls: boolean | undefined;
37
- readonly columns: {
55
+ readonly columns: ({
38
56
  readonly kind: "INDEX_COLUMN";
39
57
  readonly name: `${TName}_column_${TTable["columns"][keyof TTable["columns"]]["name"]}`;
40
- readonly sortDirection: "ASC" | "DESC";
41
58
  readonly nulls: "FIRST" | "LAST";
42
59
  readonly column: TTable["columns"][keyof TTable["columns"]]["name"];
43
- }[];
44
- readonly include: TTable["columns"][keyof TTable["columns"]]["name"][] | null;
60
+ } | {
61
+ readonly kind: "INDEX_COLUMN";
62
+ readonly name: `${TName}_column_${string}`;
63
+ readonly nulls: "FIRST" | "LAST";
64
+ readonly column: string;
65
+ } | {
66
+ readonly kind: "INDEX_COLUMN";
67
+ readonly name: `${TName}_expression_${number}`;
68
+ readonly nulls: "FIRST" | "LAST";
69
+ readonly column: null;
70
+ readonly expression: string;
71
+ })[];
72
+ readonly include: (string | TTable["columns"][keyof TTable["columns"]]["name"])[] | null;
73
+ readonly where: string | null;
74
+ readonly valid: boolean;
45
75
  };
46
76
  }
47
- export declare class IndexColumnDefinition<TIdxName extends string, TColumn extends AnyColumnDefinition> extends DefinitionNode<`${TIdxName}_column_${TColumn["name"]}`> {
77
+ export declare class IndexColumnDefinition<TIdxName extends string, TColumn extends DefinitionNode> extends DefinitionNode<`${TIdxName}_column_${TColumn["name"]}`> {
48
78
  readonly kind: "INDEX_COLUMN";
49
79
  protected _column: NodeRef<TColumn>;
50
- protected _sortDirection: "ASC" | "DESC";
51
80
  protected _nulls: "FIRST" | "LAST";
52
81
  constructor(index: TIdxName, column: TColumn);
53
- sort(direction?: "ASC" | "DESC"): this;
82
+ /** The column, as an identifier: an index column can be used in an expression key. */
83
+ toSQL(ctx: SQLContext): SQLStatement;
54
84
  nullsFirst(): this;
55
85
  nullsLast(): this;
56
86
  toJSON(): {
57
87
  readonly kind: "INDEX_COLUMN";
58
88
  readonly name: `${TIdxName}_column_${TColumn["name"]}`;
59
- readonly sortDirection: "ASC" | "DESC";
60
89
  readonly nulls: "FIRST" | "LAST";
61
90
  readonly column: TColumn["name"];
62
91
  };
63
92
  }
93
+ export {};
64
94
  //# sourceMappingURL=indexes.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"indexes.d.ts","sourceRoot":"","sources":["../../src/definition/indexes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAQ,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE5D,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAGD,MAAM,MAAM,kBAAkB,GAAG,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAE3D,MAAM,MAAM,gBAAgB,CAC1B,UAAU,SAAS,MAAM,EACzB,MAAM,SAAS,kBAAkB,IAC/B,QAAQ,CAAC;IACX,QAAQ,EAAE,CAAC,IAAI,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,qBAAqB,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;CACjG,CAAC,CAAC;AAEH,MAAM,MAAM,gBAAgB,CAC1B,UAAU,SAAS,MAAM,EACzB,MAAM,SAAS,kBAAkB,IAC/B,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;AAElE,qBAAa,eAAe,CAC1B,KAAK,SAAS,MAAM,EACpB,MAAM,SAAS,kBAAkB,CACjC,SAAQ,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC;IAC1C,SAAgB,IAAI,UAAc;IAElC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAM;IAC3D,SAAS,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IAC9E,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;gBAEvB,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW;IAQ5C,OAAO,CAAC,oBAAoB;IASrB,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC;IAKtB,OAAO,CACZ,EAAE,EAAE,CAAC,OAAO,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,GAClF,IAAI;IAKA,OAAO,CACZ,EAAE,EAAE,CACF,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KACnC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,GAC5D,IAAI;IAKP;;;;OAIG;IAEI,aAAa,CAAC,QAAQ,UAAO,GAAG,IAAI;IAK3C,MAAM;;;;;;;;;;;;;;CAUP;AAED,qBAAa,qBAAqB,CAChC,QAAQ,SAAS,MAAM,EACvB,OAAO,SAAS,mBAAmB,CACnC,SAAQ,cAAc,CAAC,GAAG,QAAQ,WAAW,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IAC/D,SAAgB,IAAI,iBAAqB;IAEzC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,SAAS,CAAC,cAAc,EAAE,KAAK,GAAG,MAAM,CAAS;IACjD,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAU;gBAEhC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO;IAM5C,IAAI,CAAC,SAAS,GAAE,KAAK,GAAG,MAAc,GAAG,IAAI;IAK7C,UAAU,IAAI,IAAI;IAKlB,SAAS,IAAI,IAAI;IAKjB,MAAM;;;;;;;CASP"}
1
+ {"version":3,"file":"indexes.d.ts","sourceRoot":"","sources":["../../src/definition/indexes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAa,UAAU,EAAE,OAAO,EAAY,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACzF,OAAO,EAAE,cAAc,EAAQ,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAyB,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AACvF,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEzE,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,kBAAkB,CAAC;CAC3B,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAE3D,mGAAmG;AACnG,MAAM,MAAM,eAAe,CACzB,UAAU,SAAS,MAAM,EACzB,QAAQ,SAAS,sBAAsB,IACrC,QAAQ,CAAC;IACX,QAAQ,EAAE,CAAC,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,aAAa,CAAC,GAC5E,eAAe,CAAC,UAAU,EAAE,aAAa,CAAC,GAC1C,qBAAqB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACnD,CAAC,CAAC;AAEH,KAAK,aAAa,CAAC,UAAU,SAAS,MAAM,EAAE,QAAQ,SAAS,sBAAsB,IAAI;KACtF,CAAC,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,aAAa,CAAC,GACnE,aAAa,CAAC,UAAU,EAAE,aAAa,CAAC,GACxC,qBAAqB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACnD,CAAC,MAAM,QAAQ,CAAC,CAAC;AAElB,MAAM,MAAM,gBAAgB,CAC1B,UAAU,SAAS,MAAM,EACzB,MAAM,SAAS,kBAAkB,IAC/B,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;AAEnD,MAAM,MAAM,gBAAgB,CAC1B,UAAU,SAAS,MAAM,EACzB,MAAM,SAAS,kBAAkB,IAC/B,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;AAEjD,qBAAa,eAAe,CAC1B,KAAK,SAAS,MAAM,EACpB,MAAM,SAAS,kBAAkB,CACjC,SAAQ,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC;IAC1C,SAAgB,IAAI,UAAc;IAElC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,QAAQ,EAAE,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,CAAM;IACvE,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;IACtD,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IACnC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;gBAEf,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW;IAQ5C,OAAO,CAAC,oBAAoB;IAarB,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC;IAK7B;;;;OAIG;IACI,OAAO,CACZ,EAAE,EAAE,CAAC,OAAO,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,EAAE,GAC9F,IAAI;IAKP;;;;OAIG;IACI,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,OAAO,GAAG,IAAI;IAKpE,OAAO,CACZ,EAAE,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,GAC/E,IAAI;IAKP;;;;OAIG;IAEI,aAAa,CAAC,QAAQ,UAAO,GAAG,IAAI;IAK3C,MAAM;;;;;;;;;;;;;;;;;;4BAYuB,OAAO,GAAG,MAAM;;;;;;wBAS1B,OAAO;;CAG3B;AAED,qBAAa,qBAAqB,CAChC,QAAQ,SAAS,MAAM,EAEvB,OAAO,SAAS,cAAc,CAC9B,SAAQ,cAAc,CAAC,GAAG,QAAQ,WAAW,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;IAC/D,SAAgB,IAAI,iBAAqB;IAEzC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAU;gBAEhC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO;IAM5C,sFAAsF;IACtF,KAAK,CAAC,GAAG,EAAE,UAAU,GAAG,YAAY;IAIpC,UAAU,IAAI,IAAI;IAKlB,SAAS,IAAI,IAAI;IAKjB,MAAM;;;;;;CAQP"}
@@ -1,4 +1,6 @@
1
+ import { isSQLNode, SQLQuery } from "../sql/index.js";
1
2
  import { DefinitionNode, Kind, NodeRef } from "./base.js";
3
+ import { ColumnGroupDefinition } from "./embedded.js";
2
4
  export class IndexDefinition extends DefinitionNode {
3
5
  kind = Kind.INDEX;
4
6
  _table;
@@ -6,26 +8,43 @@ export class IndexDefinition extends DefinitionNode {
6
8
  _columns = [];
7
9
  _include;
8
10
  _distinctNulls;
11
+ _where;
9
12
  constructor(name, config) {
10
13
  super(name);
11
14
  this._table = config.table;
12
15
  this._unique = config.unique ?? false;
13
16
  this._distinctNulls = true;
14
17
  }
15
- _getColumnConfigRefs() {
16
- return Object.fromEntries(Object.entries(this._table.columns).map(([field, column]) => [
18
+ _getColumnConfigRefs(columns = this._table.columns) {
19
+ return Object.fromEntries(Object.entries(columns).map(([field, column]) => [
17
20
  field,
18
- new IndexColumnDefinition(this.name, column),
21
+ column instanceof ColumnGroupDefinition
22
+ ? this._getColumnConfigRefs(column.columns)
23
+ : new IndexColumnDefinition(this.name, column),
19
24
  ]));
20
25
  }
21
26
  unique() {
22
27
  this._unique = true;
23
28
  return this;
24
29
  }
30
+ /**
31
+ * The index's keys, in order: columns, or expressions over them —
32
+ * `.columns((c) => [c.workspaceId, sql\`lower(${c.email})\`])`. An expression must be
33
+ * immutable, as DSQL requires.
34
+ */
25
35
  columns(cb) {
26
36
  this._columns = cb(this._getColumnConfigRefs());
27
37
  return this;
28
38
  }
39
+ /**
40
+ * Makes the index partial: it covers the rows the predicate holds for —
41
+ * `.where((c) => sql\`${c.deletedAt} IS NULL\`)`. The predicate must be immutable, and a query
42
+ * uses the index only when its own `WHERE` implies the predicate.
43
+ */
44
+ where(cb) {
45
+ this._where = cb(this._table._getColumnRefs());
46
+ return this;
47
+ }
29
48
  include(cb) {
30
49
  this._include = cb(this._table._getColumnRefs());
31
50
  return this;
@@ -45,23 +64,34 @@ export class IndexDefinition extends DefinitionNode {
45
64
  name: this.name,
46
65
  unique: this._unique,
47
66
  distinctNulls: this._distinctNulls,
48
- columns: this._columns.map((col) => col.toJSON()),
67
+ columns: this._columns.map((col, position) => col instanceof IndexColumnDefinition || !isSQLNode(col)
68
+ ? col.toJSON()
69
+ : {
70
+ kind: Kind.INDEX_COLUMN,
71
+ name: `${this.name}_expression_${position}`,
72
+ nulls: "LAST",
73
+ column: null,
74
+ expression: new SQLQuery(col).toQuery({ inlineParams: true }).text,
75
+ }),
49
76
  include: this._include ? this._include.map((col) => col.toJSON()) : null,
77
+ where: this._where ? new SQLQuery(this._where).toQuery({ inlineParams: true }).text : null,
78
+ // A definition describes a usable index. Introspection reads one whose async build
79
+ // failed as `false`.
80
+ valid: true,
50
81
  };
51
82
  }
52
83
  }
53
84
  export class IndexColumnDefinition extends DefinitionNode {
54
85
  kind = Kind.INDEX_COLUMN;
55
86
  _column;
56
- _sortDirection = "ASC";
57
87
  _nulls = "LAST";
58
88
  constructor(index, column) {
59
89
  super(`${index}_column_${column.name}`);
60
90
  this._column = new NodeRef(column);
61
91
  }
62
- sort(direction = "ASC") {
63
- this._sortDirection = direction;
64
- return this;
92
+ /** The column, as an identifier: an index column can be used in an expression key. */
93
+ toSQL(ctx) {
94
+ return this._column.toSQL(ctx);
65
95
  }
66
96
  nullsFirst() {
67
97
  this._nulls = "FIRST";
@@ -75,7 +105,6 @@ export class IndexColumnDefinition extends DefinitionNode {
75
105
  return {
76
106
  kind: this.kind,
77
107
  name: this.name,
78
- sortDirection: this._sortDirection,
79
108
  nulls: this._nulls,
80
109
  column: this._column.toJSON(),
81
110
  };
@@ -1 +1 @@
1
- {"version":3,"file":"indexes.js","sourceRoot":"","sources":["../../src/definition/indexes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAwB1D,MAAM,OAAO,eAGX,SAAQ,cAAkC;IAC1B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;IAExB,MAAM,CAAS;IACf,OAAO,CAAU;IACjB,QAAQ,GAAsC,EAAE,CAAC;IACjD,QAAQ,CAA4D;IACpE,cAAc,CAAW;IAEnC,YAAY,IAAW,EAAE,MAAmB;QAC1C,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAe,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAEO,oBAAoB;QAC1B,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAsB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;YAChF,KAAK;YACL,IAAI,qBAAqB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC;SAC7C,CAAC,CACgC,CAAC;IACvC,CAAC;IAEM,MAAM;QACX,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,OAAO,IAAoB,CAAC;IAC9B,CAAC;IAEM,OAAO,CACZ,EAAmF;QAEnF,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,OAAO,CACZ,EAE6D;QAE7D,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IAEI,aAAa,CAAC,QAAQ,GAAG,IAAI;QAClC,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;YACjD,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;SAChE,CAAC;IACb,CAAC;CACF;AAED,MAAM,OAAO,qBAGX,SAAQ,cAAuD;IAC/C,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC;IAE/B,OAAO,CAAmB;IAC1B,cAAc,GAAmB,KAAK,CAAC;IACvC,MAAM,GAAqB,MAAM,CAAC;IAE5C,YAAY,KAAe,EAAE,MAAe;QAC1C,KAAK,CAAC,GAAG,KAAK,WAAW,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAExC,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,CAAC,YAA4B,KAAK;QACpC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS;QACP,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;SACrB,CAAC;IACb,CAAC;CACF"}
1
+ {"version":3,"file":"indexes.js","sourceRoot":"","sources":["../../src/definition/indexes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAuB,QAAQ,EAAgB,MAAM,iBAAiB,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAmC,MAAM,eAAe,CAAC;AAqCvF,MAAM,OAAO,eAGX,SAAQ,cAAkC;IAC1B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;IAExB,MAAM,CAAS;IACf,OAAO,CAAU;IACjB,QAAQ,GAAkD,EAAE,CAAC;IAC7D,QAAQ,CAAoC;IAC5C,cAAc,CAAW;IACzB,MAAM,CAAW;IAE3B,YAAY,IAAW,EAAE,MAAmB;QAC1C,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAe,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAEO,oBAAoB,CAC1B,UAAkC,IAAI,CAAC,MAAM,CAAC,OAAO;QAErD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;YAC/C,KAAK;YACL,MAAM,YAAY,qBAAqB;gBACrC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC3C,CAAC,CAAC,IAAI,qBAAqB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC;SACjD,CAAC,CACgC,CAAC;IACvC,CAAC;IAEM,MAAM;QACX,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,OAAO,IAAoB,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,OAAO,CACZ,EAA+F;QAE/F,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,EAAuD;QAClE,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,OAAO,CACZ,EAAgF;QAEhF,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IAEI,aAAa,CAAC,QAAQ,GAAG,IAAI;QAClC,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAC3C,GAAG,YAAY,qBAAqB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;gBACrD,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE;gBACd,CAAC,CAAE;oBACC,IAAI,EAAE,IAAI,CAAC,YAAY;oBACvB,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,eAAe,QAAQ,EAAE;oBAC3C,KAAK,EAAE,MAA0B;oBACjC,MAAM,EAAE,IAAI;oBACZ,UAAU,EAAE,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI;iBACzD,CAChB;YACD,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;YACxE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;YAC1F,mFAAmF;YACnF,qBAAqB;YACrB,KAAK,EAAE,IAAe;SACd,CAAC;IACb,CAAC;CACF;AAED,MAAM,OAAO,qBAIX,SAAQ,cAAuD;IAC/C,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC;IAE/B,OAAO,CAAmB;IAC1B,MAAM,GAAqB,MAAM,CAAC;IAE5C,YAAY,KAAe,EAAE,MAAe;QAC1C,KAAK,CAAC,GAAG,KAAK,WAAW,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAExC,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,GAAe;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAED,UAAU;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS;QACP,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;SACrB,CAAC;IACb,CAAC;CACF","sourcesContent":["import { Unique } from \"../utils/index.js\";\nimport { isSQLNode, SQLContext, SQLNode, SQLQuery, SQLStatement } from \"../sql/index.js\";\nimport { DefinitionNode, Kind, NodeRef } from \"./base.js\";\nimport { ColumnGroupDefinition, GroupOf, TableColumnDefinitions } from \"./embedded.js\";\nimport { AnyTableDefinition, ColumnRefOf, ColumnRefs } from \"./table.js\";\n\nexport type IndexConfig = {\n unique?: boolean;\n table: AnyTableDefinition;\n};\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type AnyIndexDefinition = IndexDefinition<any, any>;\n\n/** Index columns for `columns` — a group nests its members' — as `index().columns()` gets them. */\nexport type IndexColumnRefs<\n TIndexName extends string,\n TColumns extends TableColumnDefinitions,\n> = Readonly<{\n readonly [K in keyof TColumns]: TColumns[K] extends GroupOf<infer TGroupColumns>\n ? IndexColumnRefs<TIndexName, TGroupColumns>\n : IndexColumnDefinition<TIndexName, TColumns[K]>;\n}>;\n\ntype IndexColumnOf<TIndexName extends string, TColumns extends TableColumnDefinitions> = {\n [K in keyof TColumns]: TColumns[K] extends GroupOf<infer TGroupColumns>\n ? IndexColumnOf<TIndexName, TGroupColumns>\n : IndexColumnDefinition<TIndexName, TColumns[K]>;\n}[keyof TColumns];\n\nexport type ColumnConfigRefs<\n TIndexName extends string,\n TTable extends AnyTableDefinition,\n> = IndexColumnRefs<TIndexName, TTable[\"columns\"]>;\n\nexport type ColumnConfigType<\n TIndexName extends string,\n TTable extends AnyTableDefinition,\n> = IndexColumnOf<TIndexName, TTable[\"columns\"]>;\n\nexport class IndexDefinition<\n TName extends string,\n TTable extends AnyTableDefinition,\n> extends DefinitionNode<TName, IndexConfig> {\n public readonly kind = Kind.INDEX;\n\n protected _table: TTable;\n protected _unique: boolean;\n protected _columns: (ColumnConfigType<TName, TTable> | SQLNode)[] = [];\n protected _include?: ColumnRefOf<TTable[\"columns\"]>[];\n protected _distinctNulls?: boolean;\n protected _where?: SQLNode;\n\n constructor(name: TName, config: IndexConfig) {\n super(name);\n\n this._table = config.table as TTable;\n this._unique = config.unique ?? false;\n this._distinctNulls = true;\n }\n\n private _getColumnConfigRefs(\n columns: TableColumnDefinitions = this._table.columns\n ): ColumnConfigRefs<TName, TTable> {\n return Object.fromEntries(\n Object.entries(columns).map(([field, column]) => [\n field,\n column instanceof ColumnGroupDefinition\n ? this._getColumnConfigRefs(column.columns)\n : new IndexColumnDefinition(this.name, column),\n ])\n ) as ColumnConfigRefs<TName, TTable>;\n }\n\n public unique(): Unique<this> {\n this._unique = true;\n return this as Unique<this>;\n }\n\n /**\n * The index's keys, in order: columns, or expressions over them —\n * `.columns((c) => [c.workspaceId, sql\\`lower(${c.email})\\`])`. An expression must be\n * immutable, as DSQL requires.\n */\n public columns(\n cb: (columns: ColumnConfigRefs<TName, TTable>) => (ColumnConfigType<TName, TTable> | SQLNode)[]\n ): this {\n this._columns = cb(this._getColumnConfigRefs());\n return this;\n }\n\n /**\n * Makes the index partial: it covers the rows the predicate holds for —\n * `.where((c) => sql\\`${c.deletedAt} IS NULL\\`)`. The predicate must be immutable, and a query\n * uses the index only when its own `WHERE` implies the predicate.\n */\n public where(cb: (columns: ColumnRefs<TTable[\"columns\"]>) => SQLNode): this {\n this._where = cb(this._table._getColumnRefs());\n return this;\n }\n\n public include(\n cb: (columns: ColumnRefs<TTable[\"columns\"]>) => ColumnRefOf<TTable[\"columns\"]>[]\n ): this {\n this._include = cb(this._table._getColumnRefs());\n return this;\n }\n\n /**\n * Set nulls distinct behavior for the index.\n * `NULLS [NOT] DISTINCT` specifies whether NULL values are treated as distinct for the purposes of index uniqueness.\n * @default\n */\n\n public distinctNulls(distinct = true): this {\n this._distinctNulls = distinct;\n return this;\n }\n\n toJSON() {\n return {\n kind: this.kind,\n name: this.name,\n unique: this._unique,\n distinctNulls: this._distinctNulls,\n columns: this._columns.map((col, position) =>\n col instanceof IndexColumnDefinition || !isSQLNode(col)\n ? col.toJSON()\n : ({\n kind: Kind.INDEX_COLUMN,\n name: `${this.name}_expression_${position}`,\n nulls: \"LAST\" as \"FIRST\" | \"LAST\",\n column: null,\n expression: new SQLQuery(col).toQuery({ inlineParams: true }).text,\n } as const)\n ),\n include: this._include ? this._include.map((col) => col.toJSON()) : null,\n where: this._where ? new SQLQuery(this._where).toQuery({ inlineParams: true }).text : null,\n // A definition describes a usable index. Introspection reads one whose async build\n // failed as `false`.\n valid: true as boolean,\n } as const;\n }\n}\n\nexport class IndexColumnDefinition<\n TIdxName extends string,\n // A column; typed as any definition so a ref need not be checked against the column class.\n TColumn extends DefinitionNode,\n> extends DefinitionNode<`${TIdxName}_column_${TColumn[\"name\"]}`> {\n public readonly kind = Kind.INDEX_COLUMN;\n\n protected _column: NodeRef<TColumn>;\n protected _nulls: \"FIRST\" | \"LAST\" = \"LAST\";\n\n constructor(index: TIdxName, column: TColumn) {\n super(`${index}_column_${column.name}`);\n\n this._column = new NodeRef(column);\n }\n\n /** The column, as an identifier: an index column can be used in an expression key. */\n toSQL(ctx: SQLContext): SQLStatement {\n return this._column.toSQL(ctx);\n }\n\n nullsFirst(): this {\n this._nulls = \"FIRST\";\n return this;\n }\n\n nullsLast(): this {\n this._nulls = \"LAST\";\n return this;\n }\n\n toJSON() {\n return {\n kind: this.kind,\n name: this.name,\n nulls: this._nulls,\n column: this._column.toJSON(),\n } as const;\n }\n}\n"]}