@dsqlbase/core 0.2.1 → 0.3.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.
- package/CHANGELOG.md +27 -0
- package/dist/definition/base.d.ts +3 -30
- package/dist/definition/base.d.ts.map +1 -1
- package/dist/definition/base.js +3 -14
- package/dist/definition/base.js.map +1 -1
- package/dist/definition/column.d.ts +22 -14
- package/dist/definition/column.d.ts.map +1 -1
- package/dist/definition/column.js +11 -37
- package/dist/definition/column.js.map +1 -1
- package/dist/definition/constraint.d.ts +9 -9
- package/dist/definition/constraint.d.ts.map +1 -1
- package/dist/definition/constraint.js.map +1 -1
- package/dist/definition/domain.d.ts +2 -1
- package/dist/definition/domain.d.ts.map +1 -1
- package/dist/definition/domain.js +2 -1
- package/dist/definition/domain.js.map +1 -1
- package/dist/definition/index.d.ts +5 -6
- package/dist/definition/index.d.ts.map +1 -1
- package/dist/definition/index.js +3 -4
- package/dist/definition/index.js.map +1 -1
- package/dist/definition/indexes.d.ts +9 -20
- package/dist/definition/indexes.d.ts.map +1 -1
- package/dist/definition/indexes.js +3 -6
- package/dist/definition/indexes.js.map +1 -1
- package/dist/definition/namespace.d.ts +2 -2
- package/dist/definition/namespace.d.ts.map +1 -1
- package/dist/definition/namespace.js.map +1 -1
- package/dist/definition/policy.d.ts +35 -0
- package/dist/definition/policy.d.ts.map +1 -0
- package/dist/definition/policy.js +42 -0
- package/dist/definition/policy.js.map +1 -0
- package/dist/definition/relations.d.ts +28 -33
- package/dist/definition/relations.d.ts.map +1 -1
- package/dist/definition/relations.js +1 -4
- package/dist/definition/relations.js.map +1 -1
- package/dist/definition/table.d.ts +39 -32
- package/dist/definition/table.d.ts.map +1 -1
- package/dist/definition/table.js +57 -67
- package/dist/definition/table.js.map +1 -1
- package/dist/definition/union.d.ts +18 -61
- package/dist/definition/union.d.ts.map +1 -1
- package/dist/definition/union.js +8 -69
- package/dist/definition/union.js.map +1 -1
- package/dist/index.d.ts +5 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -3
- package/dist/index.js.map +1 -1
- package/dist/resolvers/codec.d.ts +16 -0
- package/dist/resolvers/codec.d.ts.map +1 -0
- package/dist/resolvers/codec.js +9 -0
- package/dist/resolvers/codec.js.map +1 -0
- package/dist/resolvers/hooks.d.ts +39 -0
- package/dist/resolvers/hooks.d.ts.map +1 -0
- package/dist/resolvers/hooks.js +2 -0
- package/dist/resolvers/hooks.js.map +1 -0
- package/dist/resolvers/index.d.ts +5 -0
- package/dist/resolvers/index.d.ts.map +1 -0
- package/dist/resolvers/index.js +2 -0
- package/dist/resolvers/index.js.map +1 -0
- package/dist/resolvers/policy.d.ts +31 -0
- package/dist/resolvers/policy.d.ts.map +1 -0
- package/dist/resolvers/policy.js +2 -0
- package/dist/resolvers/policy.js.map +1 -0
- package/dist/resolvers/validator.d.ts +14 -0
- package/dist/resolvers/validator.d.ts.map +1 -0
- package/dist/resolvers/validator.js +2 -0
- package/dist/resolvers/validator.js.map +1 -0
- package/dist/runtime/base.d.ts +7 -4
- package/dist/runtime/base.d.ts.map +1 -1
- package/dist/runtime/base.js.map +1 -1
- package/dist/runtime/build.d.ts +22 -0
- package/dist/runtime/build.d.ts.map +1 -0
- package/dist/runtime/build.js +184 -0
- package/dist/runtime/build.js.map +1 -0
- package/dist/runtime/column.d.ts +40 -23
- package/dist/runtime/column.d.ts.map +1 -1
- package/dist/runtime/column.js +120 -28
- package/dist/runtime/column.js.map +1 -1
- package/dist/runtime/context.d.ts +17 -26
- package/dist/runtime/context.d.ts.map +1 -1
- package/dist/runtime/context.js +4 -6
- package/dist/runtime/context.js.map +1 -1
- package/dist/runtime/errors.d.ts +31 -9
- package/dist/runtime/errors.d.ts.map +1 -1
- package/dist/runtime/errors.js +54 -11
- package/dist/runtime/errors.js.map +1 -1
- package/dist/runtime/executor.d.ts.map +1 -1
- package/dist/runtime/executor.js +10 -1
- package/dist/runtime/executor.js.map +1 -1
- package/dist/runtime/index.d.ts +10 -6
- package/dist/runtime/index.d.ts.map +1 -1
- package/dist/runtime/index.js +5 -3
- package/dist/runtime/index.js.map +1 -1
- package/dist/runtime/operation.d.ts +62 -83
- package/dist/runtime/operation.d.ts.map +1 -1
- package/dist/runtime/operation.js +194 -260
- package/dist/runtime/operation.js.map +1 -1
- package/dist/runtime/policy.d.ts +35 -0
- package/dist/runtime/policy.d.ts.map +1 -0
- package/dist/runtime/policy.js +72 -0
- package/dist/runtime/policy.js.map +1 -0
- package/dist/runtime/reference.d.ts +87 -0
- package/dist/runtime/reference.d.ts.map +1 -0
- package/dist/runtime/reference.js +68 -0
- package/dist/runtime/reference.js.map +1 -0
- package/dist/runtime/registry.d.ts +26 -95
- package/dist/runtime/registry.d.ts.map +1 -1
- package/dist/runtime/registry.js +29 -408
- package/dist/runtime/registry.js.map +1 -1
- package/dist/runtime/relation.d.ts +45 -0
- package/dist/runtime/relation.d.ts.map +1 -0
- package/dist/runtime/relation.js +2 -0
- package/dist/runtime/relation.js.map +1 -0
- package/dist/runtime/table.d.ts +31 -35
- package/dist/runtime/table.d.ts.map +1 -1
- package/dist/runtime/table.js +78 -47
- package/dist/runtime/table.js.map +1 -1
- package/dist/runtime/union.d.ts +11 -4
- package/dist/runtime/union.d.ts.map +1 -1
- package/dist/runtime/union.js +18 -7
- package/dist/runtime/union.js.map +1 -1
- package/dist/sql/index.d.ts +2 -2
- package/dist/sql/index.d.ts.map +1 -1
- package/dist/sql/index.js +1 -1
- package/dist/sql/index.js.map +1 -1
- package/dist/sql/nodes.d.ts +22 -0
- package/dist/sql/nodes.d.ts.map +1 -1
- package/dist/sql/nodes.js +21 -0
- package/dist/sql/nodes.js.map +1 -1
- package/dist/sql/tag.d.ts +3 -15
- package/dist/sql/tag.d.ts.map +1 -1
- package/dist/sql/tag.js +5 -71
- package/dist/sql/tag.js.map +1 -1
- package/dist/utils/index.d.ts +1 -1
- package/dist/utils/index.d.ts.map +1 -1
- package/dist/utils/index.js.map +1 -1
- package/dist/utils/types.d.ts +2 -14
- package/dist/utils/types.d.ts.map +1 -1
- package/dist/utils/types.js.map +1 -1
- package/dist/validation/index.d.ts +2 -0
- package/dist/validation/index.d.ts.map +1 -0
- package/dist/validation/index.js +2 -0
- package/dist/validation/index.js.map +1 -0
- package/dist/validation/references.d.ts +23 -0
- package/dist/validation/references.d.ts.map +1 -0
- package/dist/validation/references.js +240 -0
- package/dist/validation/references.js.map +1 -0
- package/dist/validation/validate.d.ts +40 -0
- package/dist/validation/validate.d.ts.map +1 -0
- package/dist/validation/validate.js +354 -0
- package/dist/validation/validate.js.map +1 -0
- package/package.json +13 -4
- package/dist/definition/embedded.d.ts +0 -131
- package/dist/definition/embedded.d.ts.map +0 -1
- package/dist/definition/embedded.js +0 -133
- package/dist/definition/embedded.js.map +0 -1
- package/dist/definition/tenant.d.ts +0 -50
- package/dist/definition/tenant.d.ts.map +0 -1
- package/dist/definition/tenant.js +0 -73
- package/dist/definition/tenant.js.map +0 -1
- package/dist/runtime/group.d.ts +0 -54
- package/dist/runtime/group.d.ts.map +0 -1
- package/dist/runtime/group.js +0 -96
- package/dist/runtime/group.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,32 @@
|
|
|
1
1
|
# @dsqlbase/core
|
|
2
2
|
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 69cd317: `dsqlbase`:
|
|
8
|
+
|
|
9
|
+
- Client rewritten with a cleaner structure (breaking): `ModelClient.get({ key })` for unique reads; `update()` / `delete()` take `key: {...}`; `client.paginated()` is now `client.paginatedQuery()` and returns `{ items, hasMore, nextCursor }`; `$listByGlobalId` removed.
|
|
10
|
+
- `update` / `delete` change exactly one row; `updateMany` / `deleteMany` change every match (breaking).
|
|
11
|
+
- Row policies replace tenancy: `table.policy()`, `PolicyViolationError`, `createClient({ policies: { bypass } })`, per-request `sql.claim()` / `$withClaims()` (breaking: `tenantScope`, `$identityClaims` and the client tenancy generics are removed).
|
|
12
|
+
- `$findByGlobalId(id)` takes the id alone and resolves by any unique key (breaking).
|
|
13
|
+
- `guid()` takes only a column name; what its ids name comes from relations (breaking).
|
|
14
|
+
- `union(name, { members, columns })` declares its shared columns, and `relations()` takes a union as its source (breaking).
|
|
15
|
+
- Embedded objects removed (breaking).
|
|
16
|
+
- `guid()` columns wrap ids through column hooks.
|
|
17
|
+
|
|
18
|
+
`@dsqlbase/core`:
|
|
19
|
+
|
|
20
|
+
- `ColumnHooks` `read` / `write` / `filter` / `writeDeps`, in the new `@dsqlbase/core/resolvers` entrypoint (breaking: `ColumnRowDecoder` removed).
|
|
21
|
+
- `Column.references` and `Column.dependsOn` record what a column points at (breaking).
|
|
22
|
+
- `SchemaRegistry` is built in phases and resolves relations once (breaking: `getRelationTarget` and related helpers removed).
|
|
23
|
+
- `UnionDefinition` takes a name and declared columns; `UnionColumnDefinition` removed (breaking).
|
|
24
|
+
- `Table.uniqueKeys` lists every unique key.
|
|
25
|
+
- Tenancy and column-group APIs removed (breaking).
|
|
26
|
+
- `$onUpdate` hook receives the column itself.
|
|
27
|
+
|
|
28
|
+
Docs: docs/decisions/0025-client-rewrite.md, docs/guide/pagination.md, docs/guide/querying.md, docs/guide/global-ids.md, docs/guide/polymorphic-relations.md, docs/guide/transactions.md, docs/guide/schema.md, docs/guide/policies.md, docs/internals/runtime-pipeline.md, docs/internals/architecture.md, docs/internals/codec-boundary.md, README.md, packages/dsqlbase/README.md
|
|
29
|
+
|
|
3
30
|
## 0.2.1
|
|
4
31
|
|
|
5
32
|
No changes in this release.
|
|
@@ -15,11 +15,8 @@ export declare const Kind: Readonly<{
|
|
|
15
15
|
readonly CHECK_CONSTRAINT: "CHECK_CONSTRAINT";
|
|
16
16
|
readonly UNIQUE_CONSTRAINT: "UNIQUE_CONSTRAINT";
|
|
17
17
|
readonly PRIMARY_KEY_CONSTRAINT: "PRIMARY_KEY_CONSTRAINT";
|
|
18
|
-
readonly TENANT_SCOPE: "TENANT_SCOPE";
|
|
19
18
|
readonly UNION: "UNION";
|
|
20
|
-
readonly
|
|
21
|
-
readonly EMBEDDED_OBJECT: "EMBEDDED_OBJECT";
|
|
22
|
-
readonly COLUMN_GROUP: "COLUMN_GROUP";
|
|
19
|
+
readonly POLICY: "POLICY";
|
|
23
20
|
}>;
|
|
24
21
|
export declare const Relation: Readonly<{
|
|
25
22
|
readonly HAS_ONE: "has_one";
|
|
@@ -27,13 +24,13 @@ export declare const Relation: Readonly<{
|
|
|
27
24
|
readonly BELONGS_TO: "belongs_to";
|
|
28
25
|
}>;
|
|
29
26
|
/** The field carrying per-row table metadata on every result record. */
|
|
30
|
-
export declare const META_FIELD = "
|
|
27
|
+
export declare const META_FIELD = "__meta";
|
|
31
28
|
/**
|
|
32
29
|
* The field naming which member of a union a row came from, on every row of a union result.
|
|
33
30
|
* Top level rather than inside `$$meta`: TypeScript narrows a union on a top-level property
|
|
34
31
|
* only (`docs/decisions/0007-global-ids.md`).
|
|
35
32
|
*/
|
|
36
|
-
export declare const KEY_FIELD = "
|
|
33
|
+
export declare const KEY_FIELD = "__type";
|
|
37
34
|
/**
|
|
38
35
|
* Field names a table may use for neither a column nor a relation.
|
|
39
36
|
*
|
|
@@ -44,30 +41,6 @@ export declare const KEY_FIELD = "$$key";
|
|
|
44
41
|
export declare const RESERVED_FIELD_NAMES: readonly string[];
|
|
45
42
|
export type NodeKind = (typeof Kind)[keyof typeof Kind];
|
|
46
43
|
export type RelationType = (typeof Relation)[keyof typeof Relation];
|
|
47
|
-
/**
|
|
48
|
-
* Converts a column's values to and from what the driver sends and returns. A codec translates
|
|
49
|
-
* and nothing else: every value bound for the column passes through `encode` — writes, filters,
|
|
50
|
-
* `Column.param` — so a codec that refused values would refuse filters too. Checking a value is
|
|
51
|
-
* {@link ColumnValidator}'s job.
|
|
52
|
-
*/
|
|
53
|
-
export type ColumnCodec<TRaw, TValue> = {
|
|
54
|
-
encode(value: TValue): TRaw;
|
|
55
|
-
decode(raw: TRaw): TValue;
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* Checks a column's values on their way into and out of the database. Writes run `write` before
|
|
59
|
-
* the codec encodes; reads run `read` after it decodes. Filters run neither: a filter value is a
|
|
60
|
-
* pattern to compare with, not a value to store. Either method throws to refuse a value.
|
|
61
|
-
*
|
|
62
|
-
* `write` takes what a write accepts (`TInput`) and returns what is stored (`TValue`); they
|
|
63
|
-
* differ for a column whose writes accept more than its reads return — a JSON column validated
|
|
64
|
-
* by a schema with defaults, for one.
|
|
65
|
-
*/
|
|
66
|
-
export type ColumnValidator<TValue, TInput = TValue> = {
|
|
67
|
-
write(input: TInput): TValue;
|
|
68
|
-
read(value: TValue): TValue;
|
|
69
|
-
};
|
|
70
|
-
export declare const defaultCodec: ColumnCodec<unknown, unknown>;
|
|
71
44
|
export type DefinitionSchema = Record<string, DefinitionNode>;
|
|
72
45
|
export declare abstract class DefinitionNode<TName extends string = string, TConfig extends object = object> implements TypedObject<TConfig> {
|
|
73
46
|
abstract readonly kind: NodeKind;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/definition/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,eAAO,MAAM,IAAI
|
|
1
|
+
{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/definition/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;EAiBN,CAAC;AAEZ,eAAO,MAAM,QAAQ;;;;EAIV,CAAC;AAEZ,wEAAwE;AACxE,eAAO,MAAM,UAAU,WAAW,CAAC;AAEnC;;;;GAIG;AACH,eAAO,MAAM,SAAS,WAAW,CAAC;AAElC;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,EAAE,SAAS,MAAM,EAA2C,CAAC;AAE9F,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,OAAO,IAAI,CAAC,CAAC;AACxD,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;AAEpE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAE9D,8BAAsB,cAAc,CAClC,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,OAAO,SAAS,MAAM,GAAG,MAAM,CAC/B,YAAW,WAAW,CAAC,OAAO,CAAC;IAC/B,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAEjC,SAAiB,MAAM,EAAE,OAAO,CAAC;IAEjC,SAAgB,IAAI,EAAE,KAAK,CAAC;gBAEhB,IAAI,EAAE,KAAK;IAIhB,MAAM;;;;CAMd;AAED,qBAAa,OAAO,CAAC,KAAK,SAAS,cAAc,CAC/C,SAAQ,aACR,YAAW,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEvC,SAAgB,IAAI,cAAkB;IAEtC,SAAiB,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEzC,4EAA4E;IAC5E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEhB,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,MAAM;IAK7C;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,CAI1B;IAED,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;CAGxB"}
|
package/dist/definition/base.js
CHANGED
|
@@ -14,11 +14,8 @@ export const Kind = Object.freeze({
|
|
|
14
14
|
CHECK_CONSTRAINT: "CHECK_CONSTRAINT",
|
|
15
15
|
UNIQUE_CONSTRAINT: "UNIQUE_CONSTRAINT",
|
|
16
16
|
PRIMARY_KEY_CONSTRAINT: "PRIMARY_KEY_CONSTRAINT",
|
|
17
|
-
TENANT_SCOPE: "TENANT_SCOPE",
|
|
18
17
|
UNION: "UNION",
|
|
19
|
-
|
|
20
|
-
EMBEDDED_OBJECT: "EMBEDDED_OBJECT",
|
|
21
|
-
COLUMN_GROUP: "COLUMN_GROUP",
|
|
18
|
+
POLICY: "POLICY",
|
|
22
19
|
});
|
|
23
20
|
export const Relation = Object.freeze({
|
|
24
21
|
HAS_ONE: "has_one",
|
|
@@ -26,13 +23,13 @@ export const Relation = Object.freeze({
|
|
|
26
23
|
BELONGS_TO: "belongs_to",
|
|
27
24
|
});
|
|
28
25
|
/** The field carrying per-row table metadata on every result record. */
|
|
29
|
-
export const META_FIELD = "
|
|
26
|
+
export const META_FIELD = "__meta";
|
|
30
27
|
/**
|
|
31
28
|
* The field naming which member of a union a row came from, on every row of a union result.
|
|
32
29
|
* Top level rather than inside `$$meta`: TypeScript narrows a union on a top-level property
|
|
33
30
|
* only (`docs/decisions/0007-global-ids.md`).
|
|
34
31
|
*/
|
|
35
|
-
export const KEY_FIELD = "
|
|
32
|
+
export const KEY_FIELD = "__type";
|
|
36
33
|
/**
|
|
37
34
|
* Field names a table may use for neither a column nor a relation.
|
|
38
35
|
*
|
|
@@ -41,14 +38,6 @@ export const KEY_FIELD = "$$key";
|
|
|
41
38
|
* `docs/decisions/0004-record-meta.md`.
|
|
42
39
|
*/
|
|
43
40
|
export const RESERVED_FIELD_NAMES = Object.freeze([META_FIELD, KEY_FIELD]);
|
|
44
|
-
export const defaultCodec = {
|
|
45
|
-
encode(value) {
|
|
46
|
-
return value;
|
|
47
|
-
},
|
|
48
|
-
decode(raw) {
|
|
49
|
-
return raw;
|
|
50
|
-
},
|
|
51
|
-
};
|
|
52
41
|
export class DefinitionNode {
|
|
53
42
|
name;
|
|
54
43
|
constructor(name) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/definition/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,sBAAsB,EAAE,wBAAwB;IAChD,
|
|
1
|
+
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/definition/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,MAAM,CAAC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC;IAChC,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,sBAAsB,EAAE,wBAAwB;IAChD,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;CACR,CAAC,CAAC;AAEZ,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,UAAU,EAAE,YAAY;CAChB,CAAC,CAAC;AAEZ,wEAAwE;AACxE,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC;AAEnC;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,QAAQ,CAAC;AAElC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAsB,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;AAO9F,MAAM,OAAgB,cAAc;IAQlB,IAAI,CAAQ;IAE5B,YAAY,IAAW;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAEM,MAAM;QACX,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,OACX,SAAQ,aAAa;IAGL,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;IAItC,4EAA4E;IACnE,SAAS,CAAU;IAE5B,YAAY,MAAa,EAAE,SAAkB;QAC3C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,QAAQ;YAClD,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE;YAClC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAChB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;CACF","sourcesContent":["import { SQLIdentifier } from \"../sql/nodes.js\";\nimport { TypedObject } from \"../utils/index.js\";\n\nexport const Kind = Object.freeze({\n SCHEMA: \"SCHEMA\",\n TABLE: \"TABLE\",\n COLUMN: \"COLUMN\",\n INDEX: \"INDEX\",\n DOMAIN: \"DOMAIN\",\n SEQUENCE: \"SEQUENCE\",\n VIEW: \"VIEW\",\n FUNCTION: \"FUNCTION\",\n RELATIONS: \"RELATIONS\",\n INDEX_COLUMN: \"INDEX_COLUMN\",\n REFERENCE: \"REFERENCE\",\n CHECK_CONSTRAINT: \"CHECK_CONSTRAINT\",\n UNIQUE_CONSTRAINT: \"UNIQUE_CONSTRAINT\",\n PRIMARY_KEY_CONSTRAINT: \"PRIMARY_KEY_CONSTRAINT\",\n UNION: \"UNION\",\n POLICY: \"POLICY\",\n} as const);\n\nexport const Relation = Object.freeze({\n HAS_ONE: \"has_one\",\n HAS_MANY: \"has_many\",\n BELONGS_TO: \"belongs_to\",\n} as const);\n\n/** The field carrying per-row table metadata on every result record. */\nexport const META_FIELD = \"__meta\";\n\n/**\n * The field naming which member of a union a row came from, on every row of a union result.\n * Top level rather than inside `$$meta`: TypeScript narrows a union on a top-level property\n * only (`docs/decisions/0007-global-ids.md`).\n */\nexport const KEY_FIELD = \"__type\";\n\n/**\n * Field names a table may use for neither a column nor a relation.\n *\n * The runtime writes them onto result records itself, so a field of the same name would be\n * silently overwritten: `$$meta` on every row, `$$key` on every row of a union result. See\n * `docs/decisions/0004-record-meta.md`.\n */\nexport const RESERVED_FIELD_NAMES: readonly string[] = Object.freeze([META_FIELD, KEY_FIELD]);\n\nexport type NodeKind = (typeof Kind)[keyof typeof Kind];\nexport type RelationType = (typeof Relation)[keyof typeof Relation];\n\nexport type DefinitionSchema = Record<string, DefinitionNode>;\n\nexport abstract class DefinitionNode<\n TName extends string = string,\n TConfig extends object = object,\n> implements TypedObject<TConfig> {\n abstract readonly kind: NodeKind;\n\n declare readonly __type: TConfig;\n\n public readonly name: TName;\n\n constructor(name: TName) {\n this.name = name;\n }\n\n public toJSON() {\n return {\n kind: this.kind,\n name: this.name,\n };\n }\n}\n\nexport class NodeRef<TNode extends DefinitionNode>\n extends SQLIdentifier\n implements TypedObject<TNode[\"__type\"]>\n{\n public readonly kind = Kind.REFERENCE;\n\n declare readonly __type: TNode[\"__type\"];\n\n /** The schema the target lives in, for a target that has one (a domain). */\n readonly namespace?: string;\n\n constructor(target: TNode, namespace?: string) {\n super(target.name);\n this.namespace = namespace;\n }\n\n /**\n * How the migration planner keys the target: `namespace.name` outside `public`, the bare name\n * in it. Two objects with one name in different schemas never collide.\n */\n get qualifiedName(): string {\n return this.namespace && this.namespace !== \"public\"\n ? `${this.namespace}.${this.name}`\n : this.name;\n }\n\n toJSON(): TNode[\"name\"] {\n return this.name;\n }\n}\n"]}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { SQLIdentifier, SQLNode } from "../sql/nodes.js";
|
|
2
2
|
import { HasDefault, NotNull, PrimaryKey, ReadOnly, Deprecated, TypedObject, Unique, ValueType } from "../utils/index.js";
|
|
3
|
-
import { ColumnCodec,
|
|
3
|
+
import { ColumnCodec, ColumnHooks, ColumnValidator } from "../resolvers/index.js";
|
|
4
|
+
import { DefinitionNode, NodeRef } from "./base.js";
|
|
4
5
|
import { AnyCheckConstraintDefinition } from "./constraint.js";
|
|
5
6
|
import { AnyDomainDefinition } from "./domain.js";
|
|
6
7
|
import { SequenceOptions } from "./sequence.js";
|
|
@@ -32,7 +33,9 @@ export type ColumnIdentityConfig = {
|
|
|
32
33
|
*/
|
|
33
34
|
export type ColumnRuntimeType = "string" | "uuid" | "number" | "bigint" | "boolean" | "date" | "interval" | "bytes" | "json" | "jsonb" | "array" | "object";
|
|
34
35
|
export type ColumnConfig<TValueType = unknown, TRawType = unknown, TRuntimeType extends ColumnRuntimeType = ColumnRuntimeType, TInputType = TValueType> = {
|
|
36
|
+
/** SQL data type for the column */
|
|
35
37
|
dataType: string;
|
|
38
|
+
/** Runtime data type for the column */
|
|
36
39
|
runtimeType: TRuntimeType;
|
|
37
40
|
/** What a read returns. */
|
|
38
41
|
valueType: TValueType;
|
|
@@ -41,14 +44,19 @@ export type ColumnConfig<TValueType = unknown, TRawType = unknown, TRuntimeType
|
|
|
41
44
|
* unless set apart. Filters take the read type, since they compare with stored values.
|
|
42
45
|
*/
|
|
43
46
|
inputType: TInputType;
|
|
47
|
+
/**
|
|
48
|
+
* The raw type of the column as stored in the database.
|
|
49
|
+
* This is the type that the driver will recieve or return.
|
|
50
|
+
*/
|
|
44
51
|
rawType: TRawType;
|
|
45
52
|
notNull: boolean;
|
|
46
53
|
primaryKey: boolean;
|
|
47
54
|
unique: boolean;
|
|
48
55
|
readOnly: boolean;
|
|
49
|
-
tenantKey: boolean;
|
|
50
56
|
codec: ColumnCodec<TRawType, TValueType>;
|
|
51
57
|
validator?: ColumnValidator<TValueType, TInputType>;
|
|
58
|
+
/** Transforms around the codec that need the runtime column or row; see `ColumnHooks`. */
|
|
59
|
+
hooks?: ColumnHooks<TValueType>;
|
|
52
60
|
defaultValue?: SQLNode;
|
|
53
61
|
domain?: NodeRef<AnyDomainDefinition>;
|
|
54
62
|
generated?: ColumnGeneratedConfig;
|
|
@@ -63,23 +71,18 @@ export declare class ColumnDefinition<TName extends string, TConfig extends Colu
|
|
|
63
71
|
protected _primaryKey: boolean;
|
|
64
72
|
protected _unique: boolean;
|
|
65
73
|
protected _readOnly: boolean;
|
|
66
|
-
protected _tenantKey: boolean;
|
|
67
74
|
protected _defaultValue?: SQLNode;
|
|
68
75
|
protected _domain?: NodeRef<AnyDomainDefinition>;
|
|
69
76
|
protected _check?: AnyCheckConstraintDefinition;
|
|
70
|
-
/** What `.check()` was called with, so a renamed copy can rebuild the constraint. */
|
|
71
|
-
protected _checkSource?: {
|
|
72
|
-
build: (self: SQLIdentifier) => SQLNode;
|
|
73
|
-
name?: string;
|
|
74
|
-
};
|
|
75
77
|
protected _generated?: ColumnGeneratedConfig;
|
|
76
78
|
protected _identity?: ColumnIdentityConfig;
|
|
77
79
|
protected _deprecated: boolean;
|
|
78
80
|
protected _renamedFrom?: string;
|
|
79
81
|
protected _codec: ColumnCodec<this["__type"]["rawType"], this["__type"]["valueType"]>;
|
|
80
82
|
protected _validator?: ColumnValidator<this["__type"]["valueType"], this["__type"]["inputType"]>;
|
|
81
|
-
protected
|
|
82
|
-
protected
|
|
83
|
+
protected _hooks?: ColumnHooks<this["__type"]["valueType"]>;
|
|
84
|
+
protected _onCreate?: () => this["__type"]["inputType"] | SQLNode;
|
|
85
|
+
protected _onUpdate?: (self: SQLIdentifier) => this["__type"]["inputType"] | SQLNode;
|
|
83
86
|
constructor(name: TName, config?: Partial<TConfig>);
|
|
84
87
|
/**
|
|
85
88
|
* Marks the column as `NOT NULL`. This means that the column cannot contain null values.
|
|
@@ -112,8 +115,7 @@ export declare class ColumnDefinition<TName extends string, TConfig extends Colu
|
|
|
112
115
|
*
|
|
113
116
|
* A `ColumnDefinition` belongs to the table it is declared on: the builders mutate it in
|
|
114
117
|
* place, so one instance shared by two tables would let a later `.check()` on one reach the
|
|
115
|
-
* other. Anything that hands the same declaration to several tables
|
|
116
|
-
* is the first — copies it here instead.
|
|
118
|
+
* other. Anything that hands the same declaration to several tables copies it here instead.
|
|
117
119
|
*/
|
|
118
120
|
clone(): this;
|
|
119
121
|
default(value: this["__type"]["inputType"]): HasDefault<this>;
|
|
@@ -140,8 +142,14 @@ export declare class ColumnDefinition<TName extends string, TConfig extends Colu
|
|
|
140
142
|
* `$type<string[]>()` both give `string[]`.
|
|
141
143
|
*/
|
|
142
144
|
$type<T>(): ValueType<this, TypeArgOf<this, T>>;
|
|
143
|
-
|
|
144
|
-
|
|
145
|
+
/**
|
|
146
|
+
* Fills the column on insert when the caller gives no value. The callback may return a
|
|
147
|
+
* setting (`() => params.settings.workspaceId`): it renders from the client's settings, `NULL` when
|
|
148
|
+
* unset, encoded by the setting's own column — the target column's validator does not see it.
|
|
149
|
+
* Runtime-only: migrations never read it, so a setting-sourced column has no `DEFAULT`.
|
|
150
|
+
*/
|
|
151
|
+
$onCreate(cb: () => this["__type"]["inputType"] | SQLNode): this;
|
|
152
|
+
$onUpdate(cb: (self: SQLIdentifier) => this["__type"]["inputType"]): UpdateGuard<this>;
|
|
145
153
|
toJSON(): {
|
|
146
154
|
readonly kind: "COLUMN";
|
|
147
155
|
readonly name: TName;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"column.d.ts","sourceRoot":"","sources":["../../src/definition/column.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAsB,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EACL,UAAU,EACV,OAAO,EACP,UAAU,EACV,QAAQ,EACR,UAAU,EACV,WAAW,EACX,MAAM,EACN,SAAS,EACV,MAAM,mBAAmB,CAAC;AAC3B,OAAO,
|
|
1
|
+
{"version":3,"file":"column.d.ts","sourceRoot":"","sources":["../../src/definition/column.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAsB,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EACL,UAAU,EACV,OAAO,EACP,UAAU,EACV,QAAQ,EACR,UAAU,EACV,WAAW,EACX,MAAM,EACN,SAAS,EACV,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAgB,MAAM,uBAAuB,CAAC;AAChG,OAAO,EAAE,cAAc,EAAQ,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,4BAA4B,EAA6B,MAAM,iBAAiB,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE,GACrF,KAAK,GACL,CAAC,CAAC;AAEN,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,YAAY,CAAC;AAE1D,6FAA6F;AAC7F,MAAM,MAAM,SAAS,CAAC,OAAO,SAAS,WAAW,EAAE,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS;IAChF,WAAW,EAAE,OAAO,CAAC;CACtB,GACG,CAAC,SAAS,SAAS,OAAO,EAAE,GAC1B,CAAC,GACD,CAAC,EAAE,GACL,CAAC,CAAC;AAEN,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,OAAO,EAAE,eAAe,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,MAAM,GACN,OAAO,GACP,OAAO,GACP,QAAQ,CAAC;AAEb,MAAM,MAAM,YAAY,CACtB,UAAU,GAAG,OAAO,EACpB,QAAQ,GAAG,OAAO,EAClB,YAAY,SAAS,iBAAiB,GAAG,iBAAiB,EAC1D,UAAU,GAAG,UAAU,IACrB;IACF,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,WAAW,EAAE,YAAY,CAAC;IAC1B,2BAA2B;IAC3B,SAAS,EAAE,UAAU,CAAC;IACtB;;;OAGG;IACH,SAAS,EAAE,UAAU,CAAC;IACtB;;;OAGG;IACH,OAAO,EAAE,QAAQ,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,WAAW,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACzC,SAAS,CAAC,EAAE,eAAe,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACpD,0FAA0F;IAC1F,KAAK,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IAChC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACtC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAEzE,qBAAa,gBAAgB,CAC3B,KAAK,SAAS,MAAM,EACpB,OAAO,SAAS,YAAY,CAC5B,SAAQ,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC;IACtC,QAAQ,CAAC,IAAI,WAAe;IAE5B,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,YAAY,EAAE,iBAAiB,CAAC;IAC1C,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC;IAC7B,SAAS,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IAClC,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjD,SAAS,CAAC,MAAM,CAAC,EAAE,4BAA4B,CAAC;IAChD,SAAS,CAAC,UAAU,CAAC,EAAE,qBAAqB,CAAC;IAC7C,SAAS,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAC;IAC3C,SAAS,CAAC,WAAW,UAAS;IAC9B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAEhC,SAAS,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IACtF,SAAS,CAAC,UAAU,CAAC,EAAE,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IACjG,SAAS,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;IAClE,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;gBAEzE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAE,OAAO,CAAC,OAAO,CAAM;IAkBtD;;OAEG;IACI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxB,UAAU,IAAI,UAAU,CAAC,IAAI,CAAC;IAM9B,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC;IAK7B;;;;OAIG;IACI,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC;IAKjC;;;;;;OAMG;IACI,UAAU,IAAI,UAAU,CAAC,IAAI,CAAC;IAKrC;;;;OAIG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAK1C;;;;;;OAMG;IACI,KAAK,IAAI,IAAI;IAIb,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;IAKpE,6FAA6F;IAC7F,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC;IAInF;;;;;;;;;;;;;OAaG;IAEI,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAOvE;;;;OAIG;IACI,KAAK,CAAC,CAAC,KAAK,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAItD;;;;;OAKG;IACI,SAAS,CAAC,EAAE,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,GAAG,OAAO,GAAG,IAAI;IAKhE,SAAS,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC;IAS7F,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8CP"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { SQLIdentifier, SQLParam, SQLQuery } from "../sql/nodes.js";
|
|
2
|
-
import { defaultCodec
|
|
2
|
+
import { defaultCodec } from "../resolvers/index.js";
|
|
3
|
+
import { DefinitionNode, Kind } from "./base.js";
|
|
3
4
|
import { CheckConstraintDefinition } from "./constraint.js";
|
|
4
5
|
export class ColumnDefinition extends DefinitionNode {
|
|
5
6
|
kind = Kind.COLUMN;
|
|
@@ -9,18 +10,16 @@ export class ColumnDefinition extends DefinitionNode {
|
|
|
9
10
|
_primaryKey;
|
|
10
11
|
_unique;
|
|
11
12
|
_readOnly;
|
|
12
|
-
_tenantKey;
|
|
13
13
|
_defaultValue;
|
|
14
14
|
_domain;
|
|
15
15
|
_check;
|
|
16
|
-
/** What `.check()` was called with, so a renamed copy can rebuild the constraint. */
|
|
17
|
-
_checkSource;
|
|
18
16
|
_generated;
|
|
19
17
|
_identity;
|
|
20
18
|
_deprecated = false;
|
|
21
19
|
_renamedFrom;
|
|
22
20
|
_codec;
|
|
23
21
|
_validator;
|
|
22
|
+
_hooks;
|
|
24
23
|
_onCreate;
|
|
25
24
|
_onUpdate;
|
|
26
25
|
constructor(name, config = {}) {
|
|
@@ -31,10 +30,10 @@ export class ColumnDefinition extends DefinitionNode {
|
|
|
31
30
|
this._primaryKey = config.primaryKey ?? false;
|
|
32
31
|
this._unique = config.unique ?? false;
|
|
33
32
|
this._readOnly = config.readOnly ?? false;
|
|
34
|
-
this._tenantKey = config.tenantKey ?? false;
|
|
35
33
|
this._defaultValue = config.defaultValue;
|
|
36
34
|
this._codec = config.codec ?? defaultCodec;
|
|
37
35
|
this._validator = config.validator;
|
|
36
|
+
this._hooks = config.hooks;
|
|
38
37
|
this._domain = config.domain;
|
|
39
38
|
this._generated = config.generated;
|
|
40
39
|
this._identity = config.identity;
|
|
@@ -89,41 +88,11 @@ export class ColumnDefinition extends DefinitionNode {
|
|
|
89
88
|
*
|
|
90
89
|
* A `ColumnDefinition` belongs to the table it is declared on: the builders mutate it in
|
|
91
90
|
* place, so one instance shared by two tables would let a later `.check()` on one reach the
|
|
92
|
-
* other. Anything that hands the same declaration to several tables
|
|
93
|
-
* is the first — copies it here instead.
|
|
91
|
+
* other. Anything that hands the same declaration to several tables copies it here instead.
|
|
94
92
|
*/
|
|
95
93
|
clone() {
|
|
96
94
|
return Object.assign(Object.create(Object.getPrototypeOf(this)), this);
|
|
97
95
|
}
|
|
98
|
-
/**
|
|
99
|
-
* A copy of this definition under another database name — a member of an embedded object
|
|
100
|
-
* placed in a column group (`definition/embedded.ts`).
|
|
101
|
-
*
|
|
102
|
-
* Unlike {@link ColumnDefinition.clone}, nothing mutable is shared: the identity config is
|
|
103
|
-
* copied, and a column check is rebuilt against the new name. An explicit check name is
|
|
104
|
-
* prefixed with `prefix`, since a shape placed twice on one table would otherwise declare it
|
|
105
|
-
* twice.
|
|
106
|
-
*
|
|
107
|
-
* @internal
|
|
108
|
-
*/
|
|
109
|
-
_renamed(name, prefix) {
|
|
110
|
-
const copy = this.clone();
|
|
111
|
-
copy.name = name;
|
|
112
|
-
if (this._identity) {
|
|
113
|
-
copy._identity = {
|
|
114
|
-
...this._identity,
|
|
115
|
-
options: { ...this._identity.options },
|
|
116
|
-
};
|
|
117
|
-
}
|
|
118
|
-
if (this._checkSource) {
|
|
119
|
-
const { build, name: checkName } = this._checkSource;
|
|
120
|
-
copy.check(build, checkName === undefined ? undefined : `${prefix}_${checkName}`);
|
|
121
|
-
}
|
|
122
|
-
if (this._renamedFrom !== undefined) {
|
|
123
|
-
copy._renamedFrom = `${prefix}_${this._renamedFrom}`;
|
|
124
|
-
}
|
|
125
|
-
return copy;
|
|
126
|
-
}
|
|
127
96
|
default(value) {
|
|
128
97
|
this._defaultValue = new SQLParam(value, (input) => this._codec.encode(this._toValue(input)));
|
|
129
98
|
return this;
|
|
@@ -148,7 +117,6 @@ export class ColumnDefinition extends DefinitionNode {
|
|
|
148
117
|
*/
|
|
149
118
|
check(cb, name) {
|
|
150
119
|
const sql = new SQLQuery(cb(new SQLIdentifier(this.name)));
|
|
151
|
-
this._checkSource = { build: cb, name };
|
|
152
120
|
this._check = new CheckConstraintDefinition(name ?? `${this.name}_check`, { expression: sql });
|
|
153
121
|
return this;
|
|
154
122
|
}
|
|
@@ -160,6 +128,12 @@ export class ColumnDefinition extends DefinitionNode {
|
|
|
160
128
|
$type() {
|
|
161
129
|
return this;
|
|
162
130
|
}
|
|
131
|
+
/**
|
|
132
|
+
* Fills the column on insert when the caller gives no value. The callback may return a
|
|
133
|
+
* setting (`() => params.settings.workspaceId`): it renders from the client's settings, `NULL` when
|
|
134
|
+
* unset, encoded by the setting's own column — the target column's validator does not see it.
|
|
135
|
+
* Runtime-only: migrations never read it, so a setting-sourced column has no `DEFAULT`.
|
|
136
|
+
*/
|
|
163
137
|
$onCreate(cb) {
|
|
164
138
|
this._onCreate = cb;
|
|
165
139
|
return this;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"column.js","sourceRoot":"","sources":["../../src/definition/column.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAW,QAAQ,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAW7E,OAAO,EAGL,YAAY,EACZ,cAAc,EACd,IAAI,GAEL,MAAM,WAAW,CAAC;AACnB,OAAO,EAAgC,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAoF1F,MAAM,OAAO,gBAGX,SAAQ,cAA8B;IAC7B,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;IAElB,SAAS,CAAS;IAClB,YAAY,CAAoB;IAChC,QAAQ,CAAU;IAClB,WAAW,CAAU;IACrB,OAAO,CAAU;IACjB,SAAS,CAAU;IACnB,UAAU,CAAU;IACpB,aAAa,CAAW;IACxB,OAAO,CAAgC;IACvC,MAAM,CAAgC;IAChD,qFAAqF;IAC3E,YAAY,CAA8D;IAC1E,UAAU,CAAyB;IACnC,SAAS,CAAwB;IACjC,WAAW,GAAG,KAAK,CAAC;IACpB,YAAY,CAAU;IAEtB,MAAM,CAAsE;IAC5E,UAAU,CAA6E;IACvF,SAAS,CAAqC;IAC9C,SAAS,CAAqC;IAExD,YAAY,IAAW,EAAE,SAA2B,EAAE;QACpD,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,MAAM,CAAC;QAClE,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,IAAI,QAAQ,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,IAAI,KAAK,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,IAAI,KAAK,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,YAAY,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAEM,UAAU;QACf,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAwB,CAAC;IAClC,CAAC;IAEM,MAAM;QACX,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,OAAO,IAAoB,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,OAAO,IAAsB,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACI,UAAU;QACf,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,IAAwB,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAgB;QACjC,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,KAAK;QACV,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAW,CAAC,EAAE,IAAI,CAAS,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACI,QAAQ,CAAC,IAAY,EAAE,MAAc;QAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QACzB,IAAyB,CAAC,IAAI,GAAG,IAAI,CAAC;QAEvC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,GAAG;gBACf,GAAG,IAAI,CAAC,SAAS;gBACjB,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE;aACvC,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;YACrD,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,SAAS,EAAE,CAAC,CAAC;QACpF,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,YAAY,GAAG,GAAG,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACvD,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,OAAO,CAAC,KAAkC;QAC/C,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9F,OAAO,IAAwB,CAAC;IAClC,CAAC;IAED,6FAA6F;IACnF,QAAQ,CAAC,KAAkC;QACnD,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;OAaG;IAEI,KAAK,CAAC,EAAoC,EAAE,IAAa;QAC9D,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,YAAY,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAyB,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,QAAQ,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;QAE/F,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK;QACV,OAAO,IAA2C,CAAC;IACrD,CAAC;IAEM,SAAS,CAAC,EAAqC;QACpD,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,SAAS,CAAC,EAAqC;QACpD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,OAAO,IAAyB,CAAC;IACnC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,yFAAyF;YACzF,OAAO,EAAE,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YACvF,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,YAAY,EAAE,IAAI,CAAC,aAAa;gBAC9B,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI;gBACvE,CAAC,CAAC,IAAI;YACR,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI;YACpC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,IAAI,IAAI;YAC3C,SAAS,EAAE,IAAI,CAAC,UAAU;gBACxB,CAAC,CAAC;oBACE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;oBAC1B,UAAU,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;yBACjF,IAAI;oBACP,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;iBAC3B;gBACH,CAAC,CAAC,IAAI;YACR,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACtB,CAAC,CAAC;oBACE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;oBACzB,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY;oBACzC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO;wBAC7B,CAAC,CAAC;4BACE,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ;4BACzC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK;4BACnC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK;4BACnC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS;4BAC3C,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ;4BACzC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ;4BACzC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU;4BAC7C,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO;gCACrC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI;gCAC7D,CAAC,CAAC,SAAS;yBACd;wBACH,CAAC,CAAC,IAAI;iBACT;gBACH,CAAC,CAAC,IAAI;YACR,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;SAC9B,CAAC;IACb,CAAC;CACF","sourcesContent":["import { SQLIdentifier, SQLNode, SQLParam, SQLQuery } from \"../sql/nodes.js\";\nimport {\n HasDefault,\n NotNull,\n PrimaryKey,\n ReadOnly,\n Deprecated,\n TypedObject,\n Unique,\n ValueType,\n} from \"../utils/index.js\";\nimport {\n ColumnCodec,\n ColumnValidator,\n defaultCodec,\n DefinitionNode,\n Kind,\n NodeRef,\n} from \"./base.js\";\nimport { AnyCheckConstraintDefinition, CheckConstraintDefinition } from \"./constraint.js\";\nimport { AnyDomainDefinition } from \"./domain.js\";\nimport { SequenceOptions } from \"./sequence.js\";\n\nexport type UpdateGuard<T extends TypedObject> = T[\"__type\"] extends { primaryKey: true }\n ? never\n : T;\n\nexport type ColumnGeneratedType = \"ALWAYS\" | \"BY DEFAULT\";\n\n/** What `$type<T>()` sets: `T`, or on an `array` column `T` as an array unless it is one. */\nexport type TypeArgOf<TColumn extends TypedObject, T> = TColumn[\"__type\"] extends {\n runtimeType: \"array\";\n}\n ? T extends readonly unknown[]\n ? T\n : T[]\n : T;\n\nexport type ColumnGeneratedConfig = {\n type: \"ALWAYS\";\n expression: SQLNode;\n mode: \"STORED\";\n};\n\nexport type ColumnIdentityConfig = {\n type: ColumnGeneratedType;\n options: SequenceOptions;\n sequenceName?: string;\n};\n\n/**\n * The kind of value a column holds, for querying: it decides which filter operators apply to\n * the column, whether a bare value stands for `eq`, and whether it can be ordered. It names the\n * database value's kind, not its JavaScript form — a `date()` read as a string is still `date`.\n *\n * `json` and `jsonb` are separate because only `jsonb` has equality and containment. `array`\n * and `object` are `jsonb` columns holding an array or an object at the top level.\n */\nexport type ColumnRuntimeType =\n | \"string\"\n | \"uuid\"\n | \"number\"\n | \"bigint\"\n | \"boolean\"\n | \"date\"\n | \"interval\"\n | \"bytes\"\n | \"json\"\n | \"jsonb\"\n | \"array\"\n | \"object\";\n\nexport type ColumnConfig<\n TValueType = unknown,\n TRawType = unknown,\n TRuntimeType extends ColumnRuntimeType = ColumnRuntimeType,\n TInputType = TValueType,\n> = {\n dataType: string;\n runtimeType: TRuntimeType;\n /** What a read returns. */\n valueType: TValueType;\n /**\n * What a write — `create`, `update`, a default — accepts: the validator's input. The read type\n * unless set apart. Filters take the read type, since they compare with stored values.\n */\n inputType: TInputType;\n rawType: TRawType;\n notNull: boolean;\n primaryKey: boolean;\n unique: boolean;\n readOnly: boolean;\n tenantKey: boolean;\n codec: ColumnCodec<TRawType, TValueType>;\n validator?: ColumnValidator<TValueType, TInputType>;\n defaultValue?: SQLNode;\n domain?: NodeRef<AnyDomainDefinition>;\n generated?: ColumnGeneratedConfig;\n identity?: ColumnIdentityConfig;\n};\n\nexport type AnyColumnDefinition = ColumnDefinition<string, ColumnConfig>;\n\nexport class ColumnDefinition<\n TName extends string,\n TConfig extends ColumnConfig,\n> extends DefinitionNode<TName, TConfig> {\n readonly kind = Kind.COLUMN;\n\n protected _dataType: string;\n protected _runtimeType: ColumnRuntimeType;\n protected _notNull: boolean;\n protected _primaryKey: boolean;\n protected _unique: boolean;\n protected _readOnly: boolean;\n protected _tenantKey: boolean;\n protected _defaultValue?: SQLNode;\n protected _domain?: NodeRef<AnyDomainDefinition>;\n protected _check?: AnyCheckConstraintDefinition;\n /** What `.check()` was called with, so a renamed copy can rebuild the constraint. */\n protected _checkSource?: { build: (self: SQLIdentifier) => SQLNode; name?: string };\n protected _generated?: ColumnGeneratedConfig;\n protected _identity?: ColumnIdentityConfig;\n protected _deprecated = false;\n protected _renamedFrom?: string;\n\n protected _codec: ColumnCodec<this[\"__type\"][\"rawType\"], this[\"__type\"][\"valueType\"]>;\n protected _validator?: ColumnValidator<this[\"__type\"][\"valueType\"], this[\"__type\"][\"inputType\"]>;\n protected _onCreate?: () => this[\"__type\"][\"inputType\"];\n protected _onUpdate?: () => this[\"__type\"][\"inputType\"];\n\n constructor(name: TName, config: Partial<TConfig> = {}) {\n super(name);\n\n this._dataType = config.dataType ?? config.domain?.name ?? \"text\";\n this._runtimeType = config.runtimeType ?? \"string\";\n this._notNull = config.notNull ?? false;\n this._primaryKey = config.primaryKey ?? false;\n this._unique = config.unique ?? false;\n this._readOnly = config.readOnly ?? false;\n this._tenantKey = config.tenantKey ?? false;\n this._defaultValue = config.defaultValue;\n this._codec = config.codec ?? defaultCodec;\n this._validator = config.validator;\n this._domain = config.domain;\n this._generated = config.generated;\n this._identity = config.identity;\n }\n\n /**\n * Marks the column as `NOT NULL`. This means that the column cannot contain null values.\n */\n public notNull(): NotNull<this> {\n this._notNull = true;\n return this as NotNull<this>;\n }\n\n public primaryKey(): PrimaryKey<this> {\n this._primaryKey = true;\n this._notNull = true;\n return this as PrimaryKey<this>;\n }\n\n public unique(): Unique<this> {\n this._unique = true;\n return this as Unique<this>;\n }\n\n /**\n * Marks the column as system-managed: it is dropped from `create` and `update` inputs, both\n * in the types and at runtime, while staying fully readable — selectable, filterable and\n * orderable. Its value comes from whatever owns it, never from the caller.\n */\n public readOnly(): ReadOnly<this> {\n this._readOnly = true;\n return this as ReadOnly<this>;\n }\n\n /**\n * Marks the column for removal. It stays in the database, but leaves the client: it can't be\n * selected, filtered, ordered by or written — inserts give it its default, or `NULL`. A later\n * release removes it from the definition, and the migration then drops it as a planned,\n * lossy step instead of a destructive one: the database records the deprecation (as a column\n * comment), and a `NOT NULL` without a default is dropped so the column can be left unset.\n */\n public deprecated(): Deprecated<this> {\n this._deprecated = true;\n return this as Deprecated<this>;\n }\n\n /**\n * The column's previous name: the migration renames it (`RENAME COLUMN`) instead of dropping\n * one column and adding another, which would lose the data. Once the database has the new\n * name the hint does nothing, so it can stay for a release before it is removed.\n */\n public renamedFrom(previous: string): this {\n this._renamedFrom = previous;\n return this;\n }\n\n /**\n * A copy of this definition, of the same class, carrying the same configuration.\n *\n * A `ColumnDefinition` belongs to the table it is declared on: the builders mutate it in\n * place, so one instance shared by two tables would let a later `.check()` on one reach the\n * other. Anything that hands the same declaration to several tables — `tenantScope().columns()`\n * is the first — copies it here instead.\n */\n public clone(): this {\n return Object.assign(Object.create(Object.getPrototypeOf(this) as object), this) as this;\n }\n\n /**\n * A copy of this definition under another database name — a member of an embedded object\n * placed in a column group (`definition/embedded.ts`).\n *\n * Unlike {@link ColumnDefinition.clone}, nothing mutable is shared: the identity config is\n * copied, and a column check is rebuilt against the new name. An explicit check name is\n * prefixed with `prefix`, since a shape placed twice on one table would otherwise declare it\n * twice.\n *\n * @internal\n */\n public _renamed(name: string, prefix: string): this {\n const copy = this.clone();\n (copy as { name: string }).name = name;\n\n if (this._identity) {\n copy._identity = {\n ...this._identity,\n options: { ...this._identity.options },\n };\n }\n\n if (this._checkSource) {\n const { build, name: checkName } = this._checkSource;\n copy.check(build, checkName === undefined ? undefined : `${prefix}_${checkName}`);\n }\n\n if (this._renamedFrom !== undefined) {\n copy._renamedFrom = `${prefix}_${this._renamedFrom}`;\n }\n\n return copy;\n }\n\n public default(value: this[\"__type\"][\"inputType\"]): HasDefault<this> {\n this._defaultValue = new SQLParam(value, (input) => this._codec.encode(this._toValue(input)));\n return this as HasDefault<this>;\n }\n\n /** A value a write accepts, as it will be stored: through the validator, if there is one. */\n protected _toValue(input: this[\"__type\"][\"inputType\"]): this[\"__type\"][\"valueType\"] {\n return this._validator ? this._validator.write(input) : input;\n }\n\n /**\n * Adds a check constraint to the column.\n *\n * The callback receives the column name as a sql indetifier that can be used to build the check expression.\n *\n * @example\n * ```ts\n * column.check((col) => sql`${col} > 0`, \"positive_check\");\n * ```\n *\n * @param cb a callback that can takes the colun identifier.\n * @param name Constraint name. If not provided, it will be generated as `${columnName}_check`.\n * @returns\n */\n\n public check(cb: (self: SQLIdentifier) => SQLNode, name?: string): this {\n const sql = new SQLQuery(cb(new SQLIdentifier(this.name)));\n this._checkSource = { build: cb, name };\n this._check = new CheckConstraintDefinition(name ?? `${this.name}_check`, { expression: sql });\n\n return this;\n }\n\n /**\n * Types the column's values. Type-only: nothing checks them. On a column of runtime type\n * `array`, `T` may be the item type or the array type — `$type<string>()` and\n * `$type<string[]>()` both give `string[]`.\n */\n public $type<T>(): ValueType<this, TypeArgOf<this, T>> {\n return this as ValueType<this, TypeArgOf<this, T>>;\n }\n\n public $onCreate(cb: () => this[\"__type\"][\"inputType\"]): this {\n this._onCreate = cb;\n return this;\n }\n\n public $onUpdate(cb: () => this[\"__type\"][\"inputType\"]): UpdateGuard<this> {\n if (this._primaryKey) {\n throw new Error(\"Cannot set onUpdate callback for a primary key column.\");\n }\n\n this._onUpdate = cb;\n return this as UpdateGuard<this>;\n }\n\n toJSON() {\n return {\n kind: this.kind,\n name: this.name,\n dataType: this._dataType,\n // A deprecated column the client no longer writes can't stay NOT NULL without a default.\n notNull: this._notNull && !(this._deprecated && !this._defaultValue && !this._identity),\n primaryKey: this._primaryKey,\n unique: this._unique,\n defaultValue: this._defaultValue\n ? new SQLQuery(this._defaultValue).toQuery({ inlineParams: true }).text\n : null,\n check: this._check?.toJSON() ?? null,\n domain: this._domain?.qualifiedName ?? null,\n generated: this._generated\n ? {\n type: this._generated.type,\n expression: new SQLQuery(this._generated.expression).toQuery({ inlineParams: true })\n .text,\n mode: this._generated.mode,\n }\n : null,\n identity: this._identity\n ? {\n type: this._identity.type,\n sequenceName: this._identity.sequenceName,\n options: this._identity.options\n ? {\n dataType: this._identity.options.dataType,\n cache: this._identity.options.cache,\n cycle: this._identity.options.cycle,\n increment: this._identity.options.increment,\n minValue: this._identity.options.minValue,\n maxValue: this._identity.options.maxValue,\n startValue: this._identity.options.startValue,\n ownedBy: this._identity.options.ownedBy\n ? new SQLQuery(this._identity.options.ownedBy).toQuery().text\n : undefined,\n }\n : null,\n }\n : null,\n deprecated: this._deprecated,\n renamedFrom: this._renamedFrom ?? null,\n } as const;\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"column.js","sourceRoot":"","sources":["../../src/definition/column.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAW,QAAQ,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAW7E,OAAO,EAA6C,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChG,OAAO,EAAE,cAAc,EAAE,IAAI,EAAW,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAgC,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AA2F1F,MAAM,OAAO,gBAGX,SAAQ,cAA8B;IAC7B,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;IAElB,SAAS,CAAS;IAClB,YAAY,CAAoB;IAChC,QAAQ,CAAU;IAClB,WAAW,CAAU;IACrB,OAAO,CAAU;IACjB,SAAS,CAAU;IACnB,aAAa,CAAW;IACxB,OAAO,CAAgC;IACvC,MAAM,CAAgC;IACtC,UAAU,CAAyB;IACnC,SAAS,CAAwB;IACjC,WAAW,GAAG,KAAK,CAAC;IACpB,YAAY,CAAU;IAEtB,MAAM,CAAsE;IAC5E,UAAU,CAA6E;IACvF,MAAM,CAA4C;IAClD,SAAS,CAA+C;IACxD,SAAS,CAAkE;IAErF,YAAY,IAAW,EAAE,SAA2B,EAAE;QACpD,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,MAAM,CAAC;QAClE,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,IAAI,QAAQ,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,IAAI,KAAK,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,YAAY,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAqB,CAAC;IAC/B,CAAC;IAEM,UAAU;QACf,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAwB,CAAC;IAClC,CAAC;IAEM,MAAM;QACX,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,OAAO,IAAoB,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,OAAO,IAAsB,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACI,UAAU;QACf,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,IAAwB,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAgB;QACjC,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,KAAK;QACV,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAW,CAAC,EAAE,IAAI,CAAS,CAAC;IAC3F,CAAC;IAEM,OAAO,CAAC,KAAkC;QAC/C,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9F,OAAO,IAAwB,CAAC;IAClC,CAAC;IAED,6FAA6F;IACnF,QAAQ,CAAC,KAAkC;QACnD,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;OAaG;IAEI,KAAK,CAAC,EAAoC,EAAE,IAAa;QAC9D,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,GAAG,IAAI,yBAAyB,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,QAAQ,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;QAE/F,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK;QACV,OAAO,IAA2C,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,EAA+C;QAC9D,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,SAAS,CAAC,EAAwD;QACvE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,OAAO,IAAyB,CAAC;IACnC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,yFAAyF;YACzF,OAAO,EAAE,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YACvF,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,YAAY,EAAE,IAAI,CAAC,aAAa;gBAC9B,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI;gBACvE,CAAC,CAAC,IAAI;YACR,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,IAAI;YACpC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,IAAI,IAAI;YAC3C,SAAS,EAAE,IAAI,CAAC,UAAU;gBACxB,CAAC,CAAC;oBACE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;oBAC1B,UAAU,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;yBACjF,IAAI;oBACP,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;iBAC3B;gBACH,CAAC,CAAC,IAAI;YACR,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACtB,CAAC,CAAC;oBACE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;oBACzB,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY;oBACzC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO;wBAC7B,CAAC,CAAC;4BACE,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ;4BACzC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK;4BACnC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK;4BACnC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS;4BAC3C,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ;4BACzC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ;4BACzC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU;4BAC7C,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO;gCACrC,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI;gCAC7D,CAAC,CAAC,SAAS;yBACd;wBACH,CAAC,CAAC,IAAI;iBACT;gBACH,CAAC,CAAC,IAAI;YACR,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;SAC9B,CAAC;IACb,CAAC;CACF","sourcesContent":["import { SQLIdentifier, SQLNode, SQLParam, SQLQuery } from \"../sql/nodes.js\";\nimport {\n HasDefault,\n NotNull,\n PrimaryKey,\n ReadOnly,\n Deprecated,\n TypedObject,\n Unique,\n ValueType,\n} from \"../utils/index.js\";\nimport { ColumnCodec, ColumnHooks, ColumnValidator, defaultCodec } from \"../resolvers/index.js\";\nimport { DefinitionNode, Kind, NodeRef } from \"./base.js\";\nimport { AnyCheckConstraintDefinition, CheckConstraintDefinition } from \"./constraint.js\";\nimport { AnyDomainDefinition } from \"./domain.js\";\nimport { SequenceOptions } from \"./sequence.js\";\n\nexport type UpdateGuard<T extends TypedObject> = T[\"__type\"] extends { primaryKey: true }\n ? never\n : T;\n\nexport type ColumnGeneratedType = \"ALWAYS\" | \"BY DEFAULT\";\n\n/** What `$type<T>()` sets: `T`, or on an `array` column `T` as an array unless it is one. */\nexport type TypeArgOf<TColumn extends TypedObject, T> = TColumn[\"__type\"] extends {\n runtimeType: \"array\";\n}\n ? T extends readonly unknown[]\n ? T\n : T[]\n : T;\n\nexport type ColumnGeneratedConfig = {\n type: \"ALWAYS\";\n expression: SQLNode;\n mode: \"STORED\";\n};\n\nexport type ColumnIdentityConfig = {\n type: ColumnGeneratedType;\n options: SequenceOptions;\n sequenceName?: string;\n};\n\n/**\n * The kind of value a column holds, for querying: it decides which filter operators apply to\n * the column, whether a bare value stands for `eq`, and whether it can be ordered. It names the\n * database value's kind, not its JavaScript form — a `date()` read as a string is still `date`.\n *\n * `json` and `jsonb` are separate because only `jsonb` has equality and containment. `array`\n * and `object` are `jsonb` columns holding an array or an object at the top level.\n */\nexport type ColumnRuntimeType =\n | \"string\"\n | \"uuid\"\n | \"number\"\n | \"bigint\"\n | \"boolean\"\n | \"date\"\n | \"interval\"\n | \"bytes\"\n | \"json\"\n | \"jsonb\"\n | \"array\"\n | \"object\";\n\nexport type ColumnConfig<\n TValueType = unknown,\n TRawType = unknown,\n TRuntimeType extends ColumnRuntimeType = ColumnRuntimeType,\n TInputType = TValueType,\n> = {\n /** SQL data type for the column */\n dataType: string;\n /** Runtime data type for the column */\n runtimeType: TRuntimeType;\n /** What a read returns. */\n valueType: TValueType;\n /**\n * What a write — `create`, `update`, a default — accepts: the validator's input. The read type\n * unless set apart. Filters take the read type, since they compare with stored values.\n */\n inputType: TInputType;\n /**\n * The raw type of the column as stored in the database.\n * This is the type that the driver will recieve or return.\n */\n rawType: TRawType;\n notNull: boolean;\n primaryKey: boolean;\n unique: boolean;\n readOnly: boolean;\n codec: ColumnCodec<TRawType, TValueType>;\n validator?: ColumnValidator<TValueType, TInputType>;\n /** Transforms around the codec that need the runtime column or row; see `ColumnHooks`. */\n hooks?: ColumnHooks<TValueType>;\n defaultValue?: SQLNode;\n domain?: NodeRef<AnyDomainDefinition>;\n generated?: ColumnGeneratedConfig;\n identity?: ColumnIdentityConfig;\n};\n\nexport type AnyColumnDefinition = ColumnDefinition<string, ColumnConfig>;\n\nexport class ColumnDefinition<\n TName extends string,\n TConfig extends ColumnConfig,\n> extends DefinitionNode<TName, TConfig> {\n readonly kind = Kind.COLUMN;\n\n protected _dataType: string;\n protected _runtimeType: ColumnRuntimeType;\n protected _notNull: boolean;\n protected _primaryKey: boolean;\n protected _unique: boolean;\n protected _readOnly: boolean;\n protected _defaultValue?: SQLNode;\n protected _domain?: NodeRef<AnyDomainDefinition>;\n protected _check?: AnyCheckConstraintDefinition;\n protected _generated?: ColumnGeneratedConfig;\n protected _identity?: ColumnIdentityConfig;\n protected _deprecated = false;\n protected _renamedFrom?: string;\n\n protected _codec: ColumnCodec<this[\"__type\"][\"rawType\"], this[\"__type\"][\"valueType\"]>;\n protected _validator?: ColumnValidator<this[\"__type\"][\"valueType\"], this[\"__type\"][\"inputType\"]>;\n protected _hooks?: ColumnHooks<this[\"__type\"][\"valueType\"]>;\n protected _onCreate?: () => this[\"__type\"][\"inputType\"] | SQLNode;\n protected _onUpdate?: (self: SQLIdentifier) => this[\"__type\"][\"inputType\"] | SQLNode;\n\n constructor(name: TName, config: Partial<TConfig> = {}) {\n super(name);\n\n this._dataType = config.dataType ?? config.domain?.name ?? \"text\";\n this._runtimeType = config.runtimeType ?? \"string\";\n this._notNull = config.notNull ?? false;\n this._primaryKey = config.primaryKey ?? false;\n this._unique = config.unique ?? false;\n this._readOnly = config.readOnly ?? false;\n this._defaultValue = config.defaultValue;\n this._codec = config.codec ?? defaultCodec;\n this._validator = config.validator;\n this._hooks = config.hooks;\n this._domain = config.domain;\n this._generated = config.generated;\n this._identity = config.identity;\n }\n\n /**\n * Marks the column as `NOT NULL`. This means that the column cannot contain null values.\n */\n public notNull(): NotNull<this> {\n this._notNull = true;\n return this as NotNull<this>;\n }\n\n public primaryKey(): PrimaryKey<this> {\n this._primaryKey = true;\n this._notNull = true;\n return this as PrimaryKey<this>;\n }\n\n public unique(): Unique<this> {\n this._unique = true;\n return this as Unique<this>;\n }\n\n /**\n * Marks the column as system-managed: it is dropped from `create` and `update` inputs, both\n * in the types and at runtime, while staying fully readable — selectable, filterable and\n * orderable. Its value comes from whatever owns it, never from the caller.\n */\n public readOnly(): ReadOnly<this> {\n this._readOnly = true;\n return this as ReadOnly<this>;\n }\n\n /**\n * Marks the column for removal. It stays in the database, but leaves the client: it can't be\n * selected, filtered, ordered by or written — inserts give it its default, or `NULL`. A later\n * release removes it from the definition, and the migration then drops it as a planned,\n * lossy step instead of a destructive one: the database records the deprecation (as a column\n * comment), and a `NOT NULL` without a default is dropped so the column can be left unset.\n */\n public deprecated(): Deprecated<this> {\n this._deprecated = true;\n return this as Deprecated<this>;\n }\n\n /**\n * The column's previous name: the migration renames it (`RENAME COLUMN`) instead of dropping\n * one column and adding another, which would lose the data. Once the database has the new\n * name the hint does nothing, so it can stay for a release before it is removed.\n */\n public renamedFrom(previous: string): this {\n this._renamedFrom = previous;\n return this;\n }\n\n /**\n * A copy of this definition, of the same class, carrying the same configuration.\n *\n * A `ColumnDefinition` belongs to the table it is declared on: the builders mutate it in\n * place, so one instance shared by two tables would let a later `.check()` on one reach the\n * other. Anything that hands the same declaration to several tables copies it here instead.\n */\n public clone(): this {\n return Object.assign(Object.create(Object.getPrototypeOf(this) as object), this) as this;\n }\n\n public default(value: this[\"__type\"][\"inputType\"]): HasDefault<this> {\n this._defaultValue = new SQLParam(value, (input) => this._codec.encode(this._toValue(input)));\n return this as HasDefault<this>;\n }\n\n /** A value a write accepts, as it will be stored: through the validator, if there is one. */\n protected _toValue(input: this[\"__type\"][\"inputType\"]): this[\"__type\"][\"valueType\"] {\n return this._validator ? this._validator.write(input) : input;\n }\n\n /**\n * Adds a check constraint to the column.\n *\n * The callback receives the column name as a sql indetifier that can be used to build the check expression.\n *\n * @example\n * ```ts\n * column.check((col) => sql`${col} > 0`, \"positive_check\");\n * ```\n *\n * @param cb a callback that can takes the colun identifier.\n * @param name Constraint name. If not provided, it will be generated as `${columnName}_check`.\n * @returns\n */\n\n public check(cb: (self: SQLIdentifier) => SQLNode, name?: string): this {\n const sql = new SQLQuery(cb(new SQLIdentifier(this.name)));\n this._check = new CheckConstraintDefinition(name ?? `${this.name}_check`, { expression: sql });\n\n return this;\n }\n\n /**\n * Types the column's values. Type-only: nothing checks them. On a column of runtime type\n * `array`, `T` may be the item type or the array type — `$type<string>()` and\n * `$type<string[]>()` both give `string[]`.\n */\n public $type<T>(): ValueType<this, TypeArgOf<this, T>> {\n return this as ValueType<this, TypeArgOf<this, T>>;\n }\n\n /**\n * Fills the column on insert when the caller gives no value. The callback may return a\n * setting (`() => params.settings.workspaceId`): it renders from the client's settings, `NULL` when\n * unset, encoded by the setting's own column — the target column's validator does not see it.\n * Runtime-only: migrations never read it, so a setting-sourced column has no `DEFAULT`.\n */\n public $onCreate(cb: () => this[\"__type\"][\"inputType\"] | SQLNode): this {\n this._onCreate = cb;\n return this;\n }\n\n public $onUpdate(cb: (self: SQLIdentifier) => this[\"__type\"][\"inputType\"]): UpdateGuard<this> {\n if (this._primaryKey) {\n throw new Error(\"Cannot set onUpdate callback for a primary key column.\");\n }\n\n this._onUpdate = cb;\n return this as UpdateGuard<this>;\n }\n\n toJSON() {\n return {\n kind: this.kind,\n name: this.name,\n dataType: this._dataType,\n // A deprecated column the client no longer writes can't stay NOT NULL without a default.\n notNull: this._notNull && !(this._deprecated && !this._defaultValue && !this._identity),\n primaryKey: this._primaryKey,\n unique: this._unique,\n defaultValue: this._defaultValue\n ? new SQLQuery(this._defaultValue).toQuery({ inlineParams: true }).text\n : null,\n check: this._check?.toJSON() ?? null,\n domain: this._domain?.qualifiedName ?? null,\n generated: this._generated\n ? {\n type: this._generated.type,\n expression: new SQLQuery(this._generated.expression).toQuery({ inlineParams: true })\n .text,\n mode: this._generated.mode,\n }\n : null,\n identity: this._identity\n ? {\n type: this._identity.type,\n sequenceName: this._identity.sequenceName,\n options: this._identity.options\n ? {\n dataType: this._identity.options.dataType,\n cache: this._identity.options.cache,\n cycle: this._identity.options.cycle,\n increment: this._identity.options.increment,\n minValue: this._identity.options.minValue,\n maxValue: this._identity.options.maxValue,\n startValue: this._identity.options.startValue,\n ownedBy: this._identity.options.ownedBy\n ? new SQLQuery(this._identity.options.ownedBy).toQuery().text\n : undefined,\n }\n : null,\n }\n : null,\n deprecated: this._deprecated,\n renamedFrom: this._renamedFrom ?? null,\n } as const;\n }\n}\n"]}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { SQLQuery } from "../sql/nodes.js";
|
|
2
2
|
import { DefinitionNode, NodeRef } from "./base.js";
|
|
3
3
|
import { AnyColumnDefinition } from "./column.js";
|
|
4
|
-
import { AnyTableDefinition,
|
|
4
|
+
import { AnyTableDefinition, ColumnRefs } from "./table.js";
|
|
5
5
|
type ColumnRef = NodeRef<AnyColumnDefinition>;
|
|
6
6
|
export type JoinColumnNames<T extends ColumnRef[]> = T extends [
|
|
7
7
|
infer I extends ColumnRef,
|
|
@@ -13,11 +13,11 @@ export type CheckConstraintConfig = {
|
|
|
13
13
|
};
|
|
14
14
|
export type UniqueConstraintConfig<TTable extends AnyTableDefinition> = {
|
|
15
15
|
table: TTable;
|
|
16
|
-
columns:
|
|
16
|
+
columns: ColumnRefs<TTable["columns"]>[keyof TTable["columns"]][];
|
|
17
17
|
};
|
|
18
18
|
export type PrimaryKeyConstraintConfig<TTable extends AnyTableDefinition> = {
|
|
19
19
|
table: TTable;
|
|
20
|
-
columns:
|
|
20
|
+
columns: ColumnRefs<TTable["columns"]>[keyof TTable["columns"]][];
|
|
21
21
|
};
|
|
22
22
|
export declare const extractConstrainName: <TName extends string, TSource extends DefinitionNode, TColumns extends ColumnRef[], TSuffix extends string>(name: TName | undefined, source: NodeRef<TSource>, columns: TColumns, suffix: TSuffix) => InferConstraintName<TName, NodeRef<TSource>, TColumns, TSuffix>;
|
|
23
23
|
export type AnyCheckConstraintDefinition = CheckConstraintDefinition<string>;
|
|
@@ -42,13 +42,13 @@ export declare class UniqueConstraintDefinition<TName extends string, TTable ext
|
|
|
42
42
|
protected _include?: UniqueConstraintConfig<TTable>["columns"];
|
|
43
43
|
protected _distinctNulls?: boolean;
|
|
44
44
|
constructor(name: TName, config: UniqueConstraintConfig<TTable>);
|
|
45
|
-
include(cb: (columns: ColumnRefs<TTable["columns"]>) =>
|
|
45
|
+
include(cb: (columns: ColumnRefs<TTable["columns"]>) => ColumnRefs<TTable["columns"]>[keyof TTable["columns"]][]): this;
|
|
46
46
|
distinctNulls(distinct?: boolean): this;
|
|
47
47
|
toJSON(): {
|
|
48
48
|
readonly kind: "UNIQUE_CONSTRAINT";
|
|
49
49
|
readonly name: TName;
|
|
50
|
-
readonly columns:
|
|
51
|
-
readonly include:
|
|
50
|
+
readonly columns: TTable["columns"][keyof TTable["columns"]]["name"][];
|
|
51
|
+
readonly include: TTable["columns"][keyof TTable["columns"]]["name"][] | null;
|
|
52
52
|
readonly distinctNulls: boolean | null;
|
|
53
53
|
};
|
|
54
54
|
}
|
|
@@ -58,12 +58,12 @@ export declare class PrimaryKeyConstraintDefinition<TName extends string, TTable
|
|
|
58
58
|
protected _columns: PrimaryKeyConstraintConfig<TTable>["columns"];
|
|
59
59
|
protected _include?: PrimaryKeyConstraintConfig<TTable>["columns"];
|
|
60
60
|
constructor(name: TName, config: PrimaryKeyConstraintConfig<TTable>);
|
|
61
|
-
include(cb: (columns: ColumnRefs<TTable["columns"]>) =>
|
|
61
|
+
include(cb: (columns: ColumnRefs<TTable["columns"]>) => ColumnRefs<TTable["columns"]>[keyof TTable["columns"]][]): this;
|
|
62
62
|
toJSON(): {
|
|
63
63
|
readonly kind: "PRIMARY_KEY_CONSTRAINT";
|
|
64
64
|
readonly name: TName;
|
|
65
|
-
readonly columns:
|
|
66
|
-
readonly include:
|
|
65
|
+
readonly columns: TTable["columns"][keyof TTable["columns"]]["name"][];
|
|
66
|
+
readonly include: TTable["columns"][keyof TTable["columns"]]["name"][] | null;
|
|
67
67
|
};
|
|
68
68
|
}
|
|
69
69
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constraint.d.ts","sourceRoot":"","sources":["../../src/definition/constraint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAQ,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,
|
|
1
|
+
{"version":3,"file":"constraint.d.ts","sourceRoot":"","sources":["../../src/definition/constraint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,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,KAAK,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAE9C,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,SAAS,EAAE,IAAI,CAAC,SAAS;IAC7D,MAAM,CAAC,SAAS,SAAS;IACzB,GAAG,MAAM,CAAC,SAAS,SAAS,EAAE;CAC/B,GACG,CAAC,SAAS,EAAE,GACV,CAAC,CAAC,MAAM,CAAC,GACT,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,EAAE,GACtC,EAAE,CAAC;AAEP,MAAM,MAAM,mBAAmB,CAC7B,KAAK,SAAS,MAAM,GAAG,SAAS,EAChC,OAAO,SAAS,OAAO,CAAC,cAAc,CAAC,EACvC,QAAQ,SAAS,SAAS,EAAE,EAC5B,OAAO,SAAS,MAAM,IACpB,KAAK,SAAS,MAAM,GAAG,KAAK,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,QAAQ,CAAC,IAAI,OAAO,EAAE,CAAC;AAEhG,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE,QAAQ,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,CAAC,MAAM,SAAS,kBAAkB,IAAI;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;CACnE,CAAC;AAEF,MAAM,MAAM,0BAA0B,CAAC,MAAM,SAAS,kBAAkB,IAAI;IAC1E,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;CACnE,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,KAAK,SAAS,MAAM,EACpB,OAAO,SAAS,cAAc,EAC9B,QAAQ,SAAS,SAAS,EAAE,EAC5B,OAAO,SAAS,MAAM,EAEtB,MAAM,KAAK,GAAG,SAAS,EACvB,QAAQ,OAAO,CAAC,OAAO,CAAC,EACxB,SAAS,QAAQ,EACjB,QAAQ,OAAO,KACd,mBAAmB,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,CAchE,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAE7E,MAAM,MAAM,6BAA6B,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEpF,MAAM,MAAM,iCAAiC,GAAG,8BAA8B,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE5F,MAAM,MAAM,uBAAuB,GAC/B,4BAA4B,GAC5B,6BAA6B,GAC7B,iCAAiC,CAAC;AAEtC,qBAAa,yBAAyB,CAAC,KAAK,SAAS,MAAM,CAAE,SAAQ,cAAc,CACjF,KAAK,EACL,qBAAqB,CACtB;IACC,QAAQ,CAAC,IAAI,qBAAyB;IAEtC,SAAS,CAAC,WAAW,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC;gBAE/C,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,qBAAqB;IAMtD,MAAM;;;;4BASiB,OAAO;;CAG/B;AAED,qBAAa,0BAA0B,CACrC,KAAK,SAAS,MAAM,EACpB,MAAM,SAAS,kBAAkB,CACjC,SAAQ,cAAc,CAAC,KAAK,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAC7D,QAAQ,CAAC,IAAI,sBAA0B;IAEvC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,QAAQ,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC;IAC9D,SAAS,CAAC,QAAQ,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC;IAC/D,SAAS,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;gBAEvB,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAQxD,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;IAKA,aAAa,CAAC,QAAQ,UAAO,GAAG,IAAI;IAK3C,MAAM;;;;;;;CASP;AAED,qBAAa,8BAA8B,CACzC,KAAK,SAAS,MAAM,EACpB,MAAM,SAAS,kBAAkB,CACjC,SAAQ,cAAc,CAAC,KAAK,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACjE,QAAQ,CAAC,IAAI,2BAA+B;IAE5C,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,QAAQ,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC;IAClE,SAAS,CAAC,QAAQ,CAAC,EAAE,0BAA0B,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC;gBAEvD,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,0BAA0B,CAAC,MAAM,CAAC;IAO5D,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,MAAM;;;;;;CAQP"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constraint.js","sourceRoot":"","sources":["../../src/definition/constraint.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAW,MAAM,WAAW,CAAC;AAoC1D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAMlC,IAAuB,EACvB,MAAwB,EACxB,OAAiB,EACjB,MAAe,EACkD,EAAE;IACnE,IAAI,IAAI,EAAE,CAAC;QACT,OAAO,IAAuE,CAAC;IACjF,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;IAC/B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE7D,OAAO,GAAG,UAAU,IAAI,WAAW,IAAI,MAAM,EAK5C,CAAC;AACJ,CAAC,CAAC;AAaF,MAAM,OAAO,yBAAgD,SAAQ,cAGpE;IACU,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC;IAE5B,WAAW,CAAsC;IAE3D,YAAY,IAAW,EAAE,MAA6B;QACpD,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;IACvC,CAAC;IAED,MAAM;QACJ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAElE,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,UAAU,EAAE,IAAI;YAChB,iFAAiF;YACjF,+DAA+D;YAC/D,SAAS,EAAE,IAAe;SAClB,CAAC;IACb,CAAC;CACF;AAED,MAAM,OAAO,0BAGX,SAAQ,cAAqD;IACpD,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC;IAE7B,MAAM,CAAS;IACf,QAAQ,CAA4C;IACpD,QAAQ,CAA6C;IACrD,cAAc,CAAW;IAEnC,YAAY,IAAW,EAAE,MAAsC;QAC7D,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAe,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAEM,OAAO,CACZ,
|
|
1
|
+
{"version":3,"file":"constraint.js","sourceRoot":"","sources":["../../src/definition/constraint.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,IAAI,EAAW,MAAM,WAAW,CAAC;AAoC1D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAMlC,IAAuB,EACvB,MAAwB,EACxB,OAAiB,EACjB,MAAe,EACkD,EAAE;IACnE,IAAI,IAAI,EAAE,CAAC;QACT,OAAO,IAAuE,CAAC;IACjF,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC;IAC/B,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE7D,OAAO,GAAG,UAAU,IAAI,WAAW,IAAI,MAAM,EAK5C,CAAC;AACJ,CAAC,CAAC;AAaF,MAAM,OAAO,yBAAgD,SAAQ,cAGpE;IACU,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC;IAE5B,WAAW,CAAsC;IAE3D,YAAY,IAAW,EAAE,MAA6B;QACpD,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC;IACvC,CAAC;IAED,MAAM;QACJ,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;QAElE,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,UAAU,EAAE,IAAI;YAChB,iFAAiF;YACjF,+DAA+D;YAC/D,SAAS,EAAE,IAAe;SAClB,CAAC;IACb,CAAC;CACF;AAED,MAAM,OAAO,0BAGX,SAAQ,cAAqD;IACpD,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC;IAE7B,MAAM,CAAS;IACf,QAAQ,CAA4C;IACpD,QAAQ,CAA6C;IACrD,cAAc,CAAW;IAEnC,YAAY,IAAW,EAAE,MAAsC;QAC7D,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAe,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,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;IAEM,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,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;YACxE,aAAa,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI;SAClC,CAAC;IACb,CAAC;CACF;AAED,MAAM,OAAO,8BAGX,SAAQ,cAAyD;IACxD,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC;IAElC,MAAM,CAAS;IACf,QAAQ,CAAgD;IACxD,QAAQ,CAAiD;IAEnE,YAAY,IAAW,EAAE,MAA0C;QACjE,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAe,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC;IACjC,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,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,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","sourcesContent":["import { SQLQuery } from \"../sql/nodes.js\";\nimport { DefinitionNode, Kind, NodeRef } from \"./base.js\";\nimport { AnyColumnDefinition } from \"./column.js\";\nimport { AnyTableDefinition, ColumnRefs } from \"./table.js\";\n\ntype ColumnRef = NodeRef<AnyColumnDefinition>;\n\nexport type JoinColumnNames<T extends ColumnRef[]> = T extends [\n infer I extends ColumnRef,\n ...infer R extends ColumnRef[],\n]\n ? R extends []\n ? I[\"name\"]\n : `${I[\"name\"]}_${JoinColumnNames<R>}`\n : \"\";\n\nexport type InferConstraintName<\n TName extends string | undefined,\n TSource extends NodeRef<DefinitionNode>,\n TColumns extends ColumnRef[],\n TSuffix extends string,\n> = TName extends string ? TName : `${TSource[\"name\"]}_${JoinColumnNames<TColumns>}_${TSuffix}`;\n\nexport type CheckConstraintConfig = {\n expression: SQLQuery;\n};\n\nexport type UniqueConstraintConfig<TTable extends AnyTableDefinition> = {\n table: TTable;\n columns: ColumnRefs<TTable[\"columns\"]>[keyof TTable[\"columns\"]][];\n};\n\nexport type PrimaryKeyConstraintConfig<TTable extends AnyTableDefinition> = {\n table: TTable;\n columns: ColumnRefs<TTable[\"columns\"]>[keyof TTable[\"columns\"]][];\n};\n\nexport const extractConstrainName = <\n TName extends string,\n TSource extends DefinitionNode,\n TColumns extends ColumnRef[],\n TSuffix extends string,\n>(\n name: TName | undefined,\n source: NodeRef<TSource>,\n columns: TColumns,\n suffix: TSuffix\n): InferConstraintName<TName, NodeRef<TSource>, TColumns, TSuffix> => {\n if (name) {\n return name as InferConstraintName<TName, NodeRef<TSource>, TColumns, TSuffix>;\n }\n\n const sourceName = source.name;\n const columnNames = columns.map((col) => col.name).join(\"_\");\n\n return `${sourceName}_${columnNames}_${suffix}` as InferConstraintName<\n TName,\n NodeRef<TSource>,\n TColumns,\n TSuffix\n >;\n};\n\nexport type AnyCheckConstraintDefinition = CheckConstraintDefinition<string>;\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type AnyUniqueConstraintDefinition = UniqueConstraintDefinition<string, any>;\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type AnyPrimaryKeyConstraintDefinition = PrimaryKeyConstraintDefinition<string, any>;\n\nexport type AnyConstraintDefinition =\n | AnyCheckConstraintDefinition\n | AnyUniqueConstraintDefinition\n | AnyPrimaryKeyConstraintDefinition;\n\nexport class CheckConstraintDefinition<TName extends string> extends DefinitionNode<\n TName,\n CheckConstraintConfig\n> {\n readonly kind = Kind.CHECK_CONSTRAINT;\n\n protected _expression: CheckConstraintConfig[\"expression\"];\n\n constructor(name: TName, config: CheckConstraintConfig) {\n super(name);\n\n this._expression = config.expression;\n }\n\n toJSON() {\n const { text } = this._expression.toQuery({ inlineParams: true });\n\n return {\n kind: this.kind,\n name: this.name,\n expression: text,\n // A definition describes a constraint every row satisfies. Introspection reads a\n // constraint added `NOT VALID` and never validated as `false`.\n validated: true as boolean,\n } as const;\n }\n}\n\nexport class UniqueConstraintDefinition<\n TName extends string,\n TTable extends AnyTableDefinition,\n> extends DefinitionNode<TName, UniqueConstraintConfig<TTable>> {\n readonly kind = Kind.UNIQUE_CONSTRAINT;\n\n protected _table: TTable;\n protected _columns: UniqueConstraintConfig<TTable>[\"columns\"];\n protected _include?: UniqueConstraintConfig<TTable>[\"columns\"];\n protected _distinctNulls?: boolean;\n\n constructor(name: TName, config: UniqueConstraintConfig<TTable>) {\n super(name);\n\n this._columns = config.columns;\n this._table = config.table as TTable;\n this._distinctNulls = true;\n }\n\n public include(\n cb: (\n columns: ColumnRefs<TTable[\"columns\"]>\n ) => ColumnRefs<TTable[\"columns\"]>[keyof TTable[\"columns\"]][]\n ): this {\n this._include = cb(this._table._getColumnRefs());\n return this;\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 columns: this._columns.map((col) => col.toJSON()),\n include: this._include ? this._include.map((col) => col.toJSON()) : null,\n distinctNulls: this._distinctNulls ?? null,\n } as const;\n }\n}\n\nexport class PrimaryKeyConstraintDefinition<\n TName extends string,\n TTable extends AnyTableDefinition,\n> extends DefinitionNode<TName, PrimaryKeyConstraintConfig<TTable>> {\n readonly kind = Kind.PRIMARY_KEY_CONSTRAINT;\n\n protected _table: TTable;\n protected _columns: PrimaryKeyConstraintConfig<TTable>[\"columns\"];\n protected _include?: PrimaryKeyConstraintConfig<TTable>[\"columns\"];\n\n constructor(name: TName, config: PrimaryKeyConstraintConfig<TTable>) {\n super(name);\n\n this._table = config.table as TTable;\n this._columns = config.columns;\n }\n\n public include(\n cb: (\n columns: ColumnRefs<TTable[\"columns\"]>\n ) => ColumnRefs<TTable[\"columns\"]>[keyof TTable[\"columns\"]][]\n ): this {\n this._include = cb(this._table._getColumnRefs());\n return this;\n }\n\n toJSON() {\n return {\n kind: this.kind,\n name: this.name,\n columns: this._columns.map((col) => col.toJSON()),\n include: this._include ? this._include.map((col) => col.toJSON()) : null,\n } as const;\n }\n}\n"]}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { SQLNode, SQLQuery } from "../sql/nodes.js";
|
|
2
2
|
import { HasDefault, NotNull, WithDomain, ValueType } from "../utils/index.js";
|
|
3
|
-
import { ColumnCodec
|
|
3
|
+
import { ColumnCodec } from "../resolvers/index.js";
|
|
4
|
+
import { DefinitionNode, NodeRef } from "./base.js";
|
|
4
5
|
import { ColumnConfig, ColumnDefinition, ColumnRuntimeType } from "./column.js";
|
|
5
6
|
import { AnyCheckConstraintDefinition } from "./constraint.js";
|
|
6
7
|
import { AnyNamespaceDefinition } from "./namespace.js";
|