dsqlbase 0.2.0 → 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 +42 -0
- package/README.md +41 -60
- package/dist/client/clients/base.d.ts +20 -0
- package/dist/client/clients/base.d.ts.map +1 -0
- package/dist/client/clients/base.js +52 -0
- package/dist/client/clients/base.js.map +1 -0
- package/dist/client/clients/dsql.d.ts +24 -0
- package/dist/client/clients/dsql.d.ts.map +1 -0
- package/dist/client/clients/dsql.js +31 -0
- package/dist/client/clients/dsql.js.map +1 -0
- package/dist/client/clients/index.d.ts +6 -0
- package/dist/client/clients/index.d.ts.map +1 -0
- package/dist/client/clients/index.js +6 -0
- package/dist/client/clients/index.js.map +1 -0
- package/dist/client/clients/model.d.ts +169 -0
- package/dist/client/clients/model.d.ts.map +1 -0
- package/dist/client/{model/client.js → clients/model.js} +82 -53
- package/dist/client/clients/model.js.map +1 -0
- package/dist/client/clients/transaction.d.ts +9 -0
- package/dist/client/clients/transaction.d.ts.map +1 -0
- package/dist/client/{transaction/transaction-client.js → clients/transaction.js} +7 -7
- package/dist/client/clients/transaction.js.map +1 -0
- package/dist/client/clients/union.d.ts +39 -0
- package/dist/client/clients/union.d.ts.map +1 -0
- package/dist/client/clients/union.js +54 -0
- package/dist/client/clients/union.js.map +1 -0
- package/dist/client/create.d.ts +15 -18
- package/dist/client/create.d.ts.map +1 -1
- package/dist/client/create.js +10 -27
- package/dist/client/create.js.map +1 -1
- package/dist/client/index.d.ts +4 -8
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +3 -6
- package/dist/client/index.js.map +1 -1
- package/dist/client/normalizers/base.d.ts +467 -0
- package/dist/client/normalizers/base.d.ts.map +1 -0
- package/dist/client/normalizers/base.js.map +1 -0
- package/dist/client/normalizers/context.d.ts +14 -0
- package/dist/client/normalizers/context.d.ts.map +1 -0
- package/dist/client/normalizers/context.js +16 -0
- package/dist/client/normalizers/context.js.map +1 -0
- package/dist/client/normalizers/index.d.ts +8 -0
- package/dist/client/normalizers/index.d.ts.map +1 -0
- package/dist/client/normalizers/index.js +8 -0
- package/dist/client/normalizers/index.js.map +1 -0
- package/dist/client/normalizers/pagination.d.ts +87 -0
- package/dist/client/normalizers/pagination.d.ts.map +1 -0
- package/dist/client/normalizers/pagination.js +245 -0
- package/dist/client/normalizers/pagination.js.map +1 -0
- package/dist/client/normalizers/request.d.ts +41 -0
- package/dist/client/normalizers/request.d.ts.map +1 -0
- package/dist/client/normalizers/request.js +346 -0
- package/dist/client/normalizers/request.js.map +1 -0
- package/dist/client/normalizers/rules.d.ts +132 -0
- package/dist/client/normalizers/rules.d.ts.map +1 -0
- package/dist/client/normalizers/rules.js +82 -0
- package/dist/client/normalizers/rules.js.map +1 -0
- package/dist/client/normalizers/utils.d.ts +6 -0
- package/dist/client/normalizers/utils.d.ts.map +1 -0
- package/dist/client/normalizers/utils.js +18 -0
- package/dist/client/normalizers/utils.js.map +1 -0
- package/dist/client/normalizers/where.d.ts +39 -0
- package/dist/client/normalizers/where.d.ts.map +1 -0
- package/dist/client/normalizers/where.js +230 -0
- package/dist/client/normalizers/where.js.map +1 -0
- package/dist/client/utils/occ-retry.d.ts.map +1 -0
- package/dist/client/utils/occ-retry.js.map +1 -0
- package/dist/index.d.ts +2 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -3
- package/dist/index.js.map +1 -1
- package/dist/schema/columns/guid.d.ts +21 -21
- package/dist/schema/columns/guid.d.ts.map +1 -1
- package/dist/schema/columns/guid.js +24 -25
- package/dist/schema/columns/guid.js.map +1 -1
- package/dist/schema/columns/numeric.d.ts +43 -2
- package/dist/schema/columns/numeric.d.ts.map +1 -1
- package/dist/schema/columns/numeric.js +42 -12
- package/dist/schema/columns/numeric.js.map +1 -1
- package/dist/schema/index.d.ts +1 -2
- package/dist/schema/index.d.ts.map +1 -1
- package/dist/schema/index.js +0 -2
- package/dist/schema/index.js.map +1 -1
- package/dist/schema/relations.d.ts +22 -13
- package/dist/schema/relations.d.ts.map +1 -1
- package/dist/schema/relations.js +9 -1
- package/dist/schema/relations.js.map +1 -1
- package/dist/schema/table.d.ts +2 -2
- package/dist/schema/table.d.ts.map +1 -1
- package/dist/schema/table.js.map +1 -1
- package/dist/schema/union.d.ts +13 -8
- package/dist/schema/union.d.ts.map +1 -1
- package/dist/schema/union.js +14 -9
- package/dist/schema/union.js.map +1 -1
- package/dist/schema/utils/global-id.d.ts +3 -3
- package/dist/schema/utils/global-id.js +3 -3
- package/dist/schema/utils/global-id.js.map +1 -1
- package/dist/schema/utils/guid-hooks.d.ts +49 -0
- package/dist/schema/utils/guid-hooks.d.ts.map +1 -0
- package/dist/schema/utils/guid-hooks.js +155 -0
- package/dist/schema/utils/guid-hooks.js.map +1 -0
- package/package.json +8 -6
- package/dist/client/database/base.d.ts +0 -99
- package/dist/client/database/base.d.ts.map +0 -1
- package/dist/client/database/base.js +0 -216
- package/dist/client/database/base.js.map +0 -1
- package/dist/client/database/client.d.ts +0 -26
- package/dist/client/database/client.d.ts.map +0 -1
- package/dist/client/database/client.js +0 -47
- package/dist/client/database/client.js.map +0 -1
- package/dist/client/database/index.d.ts +0 -65
- package/dist/client/database/index.d.ts.map +0 -1
- package/dist/client/database/index.js +0 -3
- package/dist/client/database/index.js.map +0 -1
- package/dist/client/model/base.d.ts +0 -747
- package/dist/client/model/base.d.ts.map +0 -1
- package/dist/client/model/base.js.map +0 -1
- package/dist/client/model/client.d.ts +0 -139
- package/dist/client/model/client.d.ts.map +0 -1
- package/dist/client/model/client.js.map +0 -1
- package/dist/client/model/filters.d.ts +0 -276
- package/dist/client/model/filters.d.ts.map +0 -1
- package/dist/client/model/filters.js +0 -470
- package/dist/client/model/filters.js.map +0 -1
- package/dist/client/model/normalizer.d.ts +0 -143
- package/dist/client/model/normalizer.d.ts.map +0 -1
- package/dist/client/model/normalizer.js +0 -641
- package/dist/client/model/normalizer.js.map +0 -1
- package/dist/client/nodes.d.ts +0 -62
- package/dist/client/nodes.d.ts.map +0 -1
- package/dist/client/nodes.js +0 -378
- package/dist/client/nodes.js.map +0 -1
- package/dist/client/pagination/cursor.d.ts +0 -40
- package/dist/client/pagination/cursor.d.ts.map +0 -1
- package/dist/client/pagination/cursor.js +0 -79
- package/dist/client/pagination/cursor.js.map +0 -1
- package/dist/client/pagination/page.d.ts +0 -23
- package/dist/client/pagination/page.d.ts.map +0 -1
- package/dist/client/pagination/page.js +0 -37
- package/dist/client/pagination/page.js.map +0 -1
- package/dist/client/transaction/index.d.ts +0 -2
- package/dist/client/transaction/index.d.ts.map +0 -1
- package/dist/client/transaction/index.js +0 -2
- package/dist/client/transaction/index.js.map +0 -1
- package/dist/client/transaction/occ-retry.d.ts.map +0 -1
- package/dist/client/transaction/occ-retry.js.map +0 -1
- package/dist/client/transaction/transaction-client.d.ts +0 -9
- package/dist/client/transaction/transaction-client.d.ts.map +0 -1
- package/dist/client/transaction/transaction-client.js.map +0 -1
- package/dist/client/union/client.d.ts +0 -55
- package/dist/client/union/client.d.ts.map +0 -1
- package/dist/client/union/client.js +0 -74
- package/dist/client/union/client.js.map +0 -1
- package/dist/schema/embedded.d.ts +0 -31
- package/dist/schema/embedded.d.ts.map +0 -1
- package/dist/schema/embedded.js +0 -33
- package/dist/schema/embedded.js.map +0 -1
- package/dist/schema/tenant.d.ts +0 -31
- package/dist/schema/tenant.d.ts.map +0 -1
- package/dist/schema/tenant.js +0 -33
- package/dist/schema/tenant.js.map +0 -1
- /package/dist/client/{model → normalizers}/base.js +0 -0
- /package/dist/client/{transaction → utils}/occ-retry.d.ts +0 -0
- /package/dist/client/{transaction → utils}/occ-retry.js +0 -0
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { DefinitionSchema, Executable, Schema } from "@dsqlbase/core";
|
|
2
|
-
import { BaseClient } from "./base.js";
|
|
3
|
-
import { TxClient } from "../transaction/transaction-client.js";
|
|
4
|
-
import { ClaimsOf, IdentityClient } from "./index.js";
|
|
5
|
-
export declare class DatabaseClient<TDefinition extends DefinitionSchema, TClaims = never, TEnforce extends boolean = true> extends BaseClient<TDefinition> {
|
|
6
|
-
/**
|
|
7
|
-
* A client scoped to `claims`, for the life of one request. Scope first, then open a
|
|
8
|
-
* transaction on the result: a transaction client cannot be scoped, so there is one order.
|
|
9
|
-
*
|
|
10
|
-
* The claims are picked from the argument by name, so `{ ...jwt.claims }` may carry anything
|
|
11
|
-
* else it likes; only what the schema declares is kept. A claim the schema declares but the
|
|
12
|
-
* argument leaves out is allowed — the tables needing it simply are not on the result — but a
|
|
13
|
-
* claim given as `null` or `undefined` throws, because that is a mapping bug rather than a
|
|
14
|
-
* narrower scope. A misspelled claim inside a spread is not caught here, since there is
|
|
15
|
-
* nothing to compare it against, and surfaces at the first tenant table it cannot scope.
|
|
16
|
-
*
|
|
17
|
-
* Derives rather than mutates: the client this was called on stays usable, and a query's SQL
|
|
18
|
-
* is fixed by whichever client built it.
|
|
19
|
-
*/
|
|
20
|
-
$identityClaims<TNewClaims extends Partial<ClaimsOf<Schema<TDefinition>>>>(claims: TNewClaims): IdentityClient<TDefinition, TNewClaims>;
|
|
21
|
-
$transaction<const TQueries extends Executable<unknown>[]>(queries: TQueries): Promise<{
|
|
22
|
-
-readonly [K in keyof TQueries]: TQueries[K] extends Executable<infer TResult> ? TResult : never;
|
|
23
|
-
}>;
|
|
24
|
-
$transaction<TReturn = unknown>(callback: (tx: TxClient<TDefinition, TClaims, TEnforce>) => Promise<TReturn>): Promise<TReturn>;
|
|
25
|
-
}
|
|
26
|
-
//# sourceMappingURL=client.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/client/database/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,UAAU,EAEV,MAAM,EAEP,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAgB,UAAU,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAA2B,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AACzF,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEtD,qBAAa,cAAc,CACzB,WAAW,SAAS,gBAAgB,EACpC,OAAO,GAAG,KAAK,EACf,QAAQ,SAAS,OAAO,GAAG,IAAI,CAC/B,SAAQ,UAAU,CAAC,WAAW,CAAC;IAC/B;;;;;;;;;;;;;OAaG;IACI,eAAe,CAAC,UAAU,SAAS,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAC9E,MAAM,EAAE,UAAU,GACjB,cAAc,CAAC,WAAW,EAAE,UAAU,CAAC;IAsC7B,YAAY,CAAC,KAAK,CAAC,QAAQ,SAAS,UAAU,CAAC,OAAO,CAAC,EAAE,EACpE,OAAO,EAAE,QAAQ,GAChB,OAAO,CAAC;QACT,CAAC,UAAU,CAAC,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,MAAM,OAAO,CAAC,GAC1E,OAAO,GACP,KAAK;KACV,CAAC;IACW,YAAY,CAAC,OAAO,GAAG,OAAO,EACzC,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,GAC3E,OAAO,CAAC,OAAO,CAAC;CASpB"}
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
import { ExecutionContext, TenancyError, } from "@dsqlbase/core";
|
|
2
|
-
import { attachModels, BaseClient } from "./base.js";
|
|
3
|
-
import { createTransactionRunner } from "../transaction/transaction-client.js";
|
|
4
|
-
export class DatabaseClient extends BaseClient {
|
|
5
|
-
/**
|
|
6
|
-
* A client scoped to `claims`, for the life of one request. Scope first, then open a
|
|
7
|
-
* transaction on the result: a transaction client cannot be scoped, so there is one order.
|
|
8
|
-
*
|
|
9
|
-
* The claims are picked from the argument by name, so `{ ...jwt.claims }` may carry anything
|
|
10
|
-
* else it likes; only what the schema declares is kept. A claim the schema declares but the
|
|
11
|
-
* argument leaves out is allowed — the tables needing it simply are not on the result — but a
|
|
12
|
-
* claim given as `null` or `undefined` throws, because that is a mapping bug rather than a
|
|
13
|
-
* narrower scope. A misspelled claim inside a spread is not caught here, since there is
|
|
14
|
-
* nothing to compare it against, and surfaces at the first tenant table it cannot scope.
|
|
15
|
-
*
|
|
16
|
-
* Derives rather than mutates: the client this was called on stays usable, and a query's SQL
|
|
17
|
-
* is fixed by whichever client built it.
|
|
18
|
-
*/
|
|
19
|
-
$identityClaims(claims) {
|
|
20
|
-
if (this._ctx.identity) {
|
|
21
|
-
throw new TenancyError("This client is already scoped to an identity. Claims are set in exactly one place; " +
|
|
22
|
-
"derive from the base client instead.");
|
|
23
|
-
}
|
|
24
|
-
const identity = {};
|
|
25
|
-
const given = claims;
|
|
26
|
-
for (const claim of this._ctx.schema.claimKeys.keys()) {
|
|
27
|
-
if (!Object.hasOwn(given, claim)) {
|
|
28
|
-
continue;
|
|
29
|
-
}
|
|
30
|
-
const value = given[claim];
|
|
31
|
-
if (value === undefined || value === null) {
|
|
32
|
-
throw new TenancyError(`Claim "${claim}" was given as ${String(value)}. Leave a claim out to narrow what ` +
|
|
33
|
-
`the client can reach; an empty one scopes nothing.`, undefined, claim);
|
|
34
|
-
}
|
|
35
|
-
identity[claim] = value;
|
|
36
|
-
}
|
|
37
|
-
const ctx = new ExecutionContext({ ...this._ctx, identity });
|
|
38
|
-
const client = new DatabaseClient(ctx);
|
|
39
|
-
attachModels(client, ctx);
|
|
40
|
-
return client;
|
|
41
|
-
}
|
|
42
|
-
async $transaction(arg) {
|
|
43
|
-
const runner = await createTransactionRunner(this._ctx);
|
|
44
|
-
return runner(arg);
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
//# sourceMappingURL=client.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/client/database/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,gBAAgB,EAEhB,YAAY,GACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAY,MAAM,sCAAsC,CAAC;AAGzF,MAAM,OAAO,cAIX,SAAQ,UAAuB;IAC/B;;;;;;;;;;;;;OAaG;IACI,eAAe,CACpB,MAAkB;QAElB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACvB,MAAM,IAAI,YAAY,CACpB,qFAAqF;gBACnF,sCAAsC,CACzC,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAA4B,EAAE,CAAC;QAC7C,MAAM,KAAK,GAAG,MAAiC,CAAC;QAEhD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;gBACjC,SAAS;YACX,CAAC;YAED,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;YAE3B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,MAAM,IAAI,YAAY,CACpB,UAAU,KAAK,kBAAkB,MAAM,CAAC,KAAK,CAAC,qCAAqC;oBACjF,oDAAoD,EACtD,SAAS,EACT,KAAK,CACN,CAAC;YACJ,CAAC;YAED,QAAQ,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;QAC1B,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,gBAAgB,CAAc,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,IAAI,cAAc,CAAoC,GAAG,CAAC,CAAC;QAE1E,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE1B,OAAO,MAA4D,CAAC;IACtE,CAAC;IAYM,KAAK,CAAC,YAAY,CACvB,GAE4E;QAE5E,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAiC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxF,OAAO,MAAM,CAAU,GAAG,CAAC,CAAC;IAC9B,CAAC;CACF","sourcesContent":["import {\n DefinitionSchema,\n Executable,\n ExecutionContext,\n Schema,\n TenancyError,\n} from \"@dsqlbase/core\";\nimport { attachModels, BaseClient } from \"./base.js\";\nimport { createTransactionRunner, TxClient } from \"../transaction/transaction-client.js\";\nimport { ClaimsOf, IdentityClient } from \"./index.js\";\n\nexport class DatabaseClient<\n TDefinition extends DefinitionSchema,\n TClaims = never,\n TEnforce extends boolean = true,\n> extends BaseClient<TDefinition> {\n /**\n * A client scoped to `claims`, for the life of one request. Scope first, then open a\n * transaction on the result: a transaction client cannot be scoped, so there is one order.\n *\n * The claims are picked from the argument by name, so `{ ...jwt.claims }` may carry anything\n * else it likes; only what the schema declares is kept. A claim the schema declares but the\n * argument leaves out is allowed — the tables needing it simply are not on the result — but a\n * claim given as `null` or `undefined` throws, because that is a mapping bug rather than a\n * narrower scope. A misspelled claim inside a spread is not caught here, since there is\n * nothing to compare it against, and surfaces at the first tenant table it cannot scope.\n *\n * Derives rather than mutates: the client this was called on stays usable, and a query's SQL\n * is fixed by whichever client built it.\n */\n public $identityClaims<TNewClaims extends Partial<ClaimsOf<Schema<TDefinition>>>>(\n claims: TNewClaims\n ): IdentityClient<TDefinition, TNewClaims> {\n if (this._ctx.identity) {\n throw new TenancyError(\n \"This client is already scoped to an identity. Claims are set in exactly one place; \" +\n \"derive from the base client instead.\"\n );\n }\n\n const identity: Record<string, unknown> = {};\n const given = claims as Record<string, unknown>;\n\n for (const claim of this._ctx.schema.claimKeys.keys()) {\n if (!Object.hasOwn(given, claim)) {\n continue;\n }\n\n const value = given[claim];\n\n if (value === undefined || value === null) {\n throw new TenancyError(\n `Claim \"${claim}\" was given as ${String(value)}. Leave a claim out to narrow what ` +\n `the client can reach; an empty one scopes nothing.`,\n undefined,\n claim\n );\n }\n\n identity[claim] = value;\n }\n\n const ctx = new ExecutionContext<TDefinition>({ ...this._ctx, identity });\n const client = new DatabaseClient<TDefinition, TNewClaims, TEnforce>(ctx);\n\n attachModels(client, ctx);\n\n return client as unknown as IdentityClient<TDefinition, TNewClaims>;\n }\n\n public async $transaction<const TQueries extends Executable<unknown>[]>(\n queries: TQueries\n ): Promise<{\n -readonly [K in keyof TQueries]: TQueries[K] extends Executable<infer TResult>\n ? TResult\n : never;\n }>;\n public async $transaction<TReturn = unknown>(\n callback: (tx: TxClient<TDefinition, TClaims, TEnforce>) => Promise<TReturn>\n ): Promise<TReturn>;\n public async $transaction<TReturn = unknown>(\n arg:\n | Executable<unknown>[]\n | ((client: TxClient<TDefinition, TClaims, TEnforce>) => Promise<TReturn>)\n ): Promise<TReturn> {\n const runner = await createTransactionRunner<TDefinition, TClaims, TEnforce>(this._ctx);\n return runner<TReturn>(arg);\n }\n}\n"]}
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
import { AnyTable, AnySchema, DefinitionSchema, RuntimeTables, Schema } from "@dsqlbase/core";
|
|
2
|
-
import { TableByAlias } from "@dsqlbase/core/runtime";
|
|
3
|
-
import { UnionToIntersection } from "@dsqlbase/core/utils";
|
|
4
|
-
import { ModelClient } from "../model/client.js";
|
|
5
|
-
import { ColumnTypeOf, TenantKeysOf, UnionMembersOf, ValueTypeOf } from "../model/base.js";
|
|
6
|
-
import { UnionClient } from "../union/client.js";
|
|
7
|
-
import { DatabaseClient } from "./client.js";
|
|
8
|
-
/** Every union alias in a schema. */
|
|
9
|
-
export type UnionAliases<T extends DefinitionSchema> = keyof Schema<T>["unions"] & string;
|
|
10
|
-
/**
|
|
11
|
-
* Every alias in a schema the client addresses a model by: each table, and each union.
|
|
12
|
-
*/
|
|
13
|
-
export type Aliases<T extends DefinitionSchema> = keyof RuntimeTables<Schema<T>> | UnionAliases<T>;
|
|
14
|
-
/**
|
|
15
|
-
* The claims a schema declares, as one object.
|
|
16
|
-
*
|
|
17
|
-
* Gathered across tables rather than per table, because that is how an identity is given: one
|
|
18
|
-
* object for the whole client. A claim declared twice with different value types collapses to
|
|
19
|
-
* `never` here, mirroring the registry's data-type check at runtime.
|
|
20
|
-
*/
|
|
21
|
-
export type ClaimsOf<TSchema extends AnySchema> = UnionToIntersection<{
|
|
22
|
-
[A in keyof RuntimeTables<TSchema> & string]: {
|
|
23
|
-
[C in TenantKeysOf<TableByAlias<TSchema, A>>]: ValueTypeOf<ColumnTypeOf<TableByAlias<TSchema, A>, C>>;
|
|
24
|
-
};
|
|
25
|
-
}[keyof RuntimeTables<TSchema> & string]>;
|
|
26
|
-
/**
|
|
27
|
-
* The aliases a client holding `TClaims` may address: every global table, plus every tenant
|
|
28
|
-
* table whose claims the identity carries in full. A table needing a claim that is not there is
|
|
29
|
-
* not hidden to be tidy — it is hidden because reaching it would throw.
|
|
30
|
-
*/
|
|
31
|
-
export type VisibleAliases<TSchema extends AnySchema, TClaims> = VisibleTableAliases<TSchema, TClaims> | VisibleUnionAliases<TSchema, TClaims>;
|
|
32
|
-
type VisibleTableAliases<TSchema extends AnySchema, TClaims> = {
|
|
33
|
-
[A in keyof RuntimeTables<TSchema> & string]: [
|
|
34
|
-
TenantKeysOf<TableByAlias<TSchema, A>>
|
|
35
|
-
] extends [keyof TClaims] ? A : never;
|
|
36
|
-
}[keyof RuntimeTables<TSchema> & string];
|
|
37
|
-
/**
|
|
38
|
-
* A union is visible only when every member is: each read runs a branch per member, and one
|
|
39
|
-
* branch a client cannot reach makes the whole read throw.
|
|
40
|
-
*/
|
|
41
|
-
type VisibleUnionAliases<TSchema extends AnySchema, TClaims> = {
|
|
42
|
-
[U in keyof TSchema["unions"] & string]: [
|
|
43
|
-
Exclude<keyof UnionMembersOf<TSchema["unions"][U]>, VisibleTableAliases<TSchema, TClaims>>
|
|
44
|
-
] extends [never] ? U : never;
|
|
45
|
-
}[keyof TSchema["unions"] & string];
|
|
46
|
-
/**
|
|
47
|
-
* Which aliases a client shows, given its claims and whether it enforces.
|
|
48
|
-
*
|
|
49
|
-
* An unscoped client sees everything when enforcement is off, and only the global tables when
|
|
50
|
-
* it is on — the same rule the runtime applies, so the type never promises a table that would
|
|
51
|
-
* throw.
|
|
52
|
-
*/
|
|
53
|
-
export type VisibleFor<T extends DefinitionSchema, TClaims, TEnforce extends boolean> = [TClaims] extends [never] ? TEnforce extends false ? Aliases<T> : VisibleAliases<Schema<T>, object> : VisibleAliases<Schema<T>, TClaims>;
|
|
54
|
-
export type Models<T extends DefinitionSchema, TVisible extends Aliases<T> = Aliases<T>> = {
|
|
55
|
-
readonly [K in TVisible]: K extends keyof RuntimeTables<Schema<T>> ? RuntimeTables<Schema<T>>[K] extends infer TTable ? TTable extends AnyTable ? ModelClient<TTable, T> : never : never : K extends UnionAliases<T> ? UnionClient<UnionMembersOf<Schema<T>["unions"][K]>, T> : never;
|
|
56
|
-
};
|
|
57
|
-
export type QueryClient<T extends DefinitionSchema, TEnforce extends boolean = true> = DatabaseClient<T, never, TEnforce> & Models<T, VisibleFor<T, never, TEnforce>>;
|
|
58
|
-
/**
|
|
59
|
-
* A client scoped to an identity. It has no raw-SQL methods: `$query` on a scoped client would
|
|
60
|
-
* look tenant-safe and would not be, so it is removed rather than guarded only at runtime. It
|
|
61
|
-
* cannot be re-scoped either — claims are set in exactly one place.
|
|
62
|
-
*/
|
|
63
|
-
export type IdentityClient<T extends DefinitionSchema, TClaims> = Omit<DatabaseClient<T, TClaims>, "$query" | "$execute" | "$identityClaims"> & Models<T, VisibleFor<T, TClaims, true>>;
|
|
64
|
-
export { DatabaseClient };
|
|
65
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/database/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC9F,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC3F,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,qCAAqC;AACrC,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,gBAAgB,IAAI,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;AAE1F;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,gBAAgB,IAAI,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;AAEnG;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,CAAC,OAAO,SAAS,SAAS,IAAI,mBAAmB,CACnE;KACG,CAAC,IAAI,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG;SAC3C,CAAC,IAAI,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,GAAG,WAAW,CACxD,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAC1C;KACF;CACF,CAAC,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CACzC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,SAAS,SAAS,EAAE,OAAO,IACzD,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,GACrC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAE1C,KAAK,mBAAmB,CAAC,OAAO,SAAS,SAAS,EAAE,OAAO,IAAI;KAC5D,CAAC,IAAI,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG;QAC5C,YAAY,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;KACvC,SAAS,CAAC,MAAM,OAAO,CAAC,GACrB,CAAC,GACD,KAAK;CACV,CAAC,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC;AAEzC;;;GAGG;AACH,KAAK,mBAAmB,CAAC,OAAO,SAAS,SAAS,EAAE,OAAO,IAAI;KAC5D,CAAC,IAAI,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,MAAM,GAAG;QACvC,OAAO,CAAC,MAAM,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;KAC3F,SAAS,CAAC,KAAK,CAAC,GACb,CAAC,GACD,KAAK;CACV,CAAC,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CACpB,CAAC,SAAS,gBAAgB,EAC1B,OAAO,EACP,QAAQ,SAAS,OAAO,IACtB,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,GACzB,QAAQ,SAAS,KAAK,GACpB,OAAO,CAAC,CAAC,CAAC,GACV,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GACnC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AAEvC,MAAM,MAAM,MAAM,CAChB,CAAC,SAAS,gBAAgB,EAC1B,QAAQ,SAAS,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,IACtC;IACF,QAAQ,EAAE,CAAC,IAAI,QAAQ,GAAG,CAAC,SAAS,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAC9D,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,MAAM,GAC9C,MAAM,SAAS,QAAQ,GACrB,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GACtB,KAAK,GACP,KAAK,GACP,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,GACvB,WAAW,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GACtD,KAAK;CACZ,CAAC;AAEF,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,gBAAgB,EAC1B,QAAQ,SAAS,OAAO,GAAG,IAAI,IAC7B,cAAc,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;AAEnF;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,gBAAgB,EAAE,OAAO,IAAI,IAAI,CACpE,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,EAC1B,QAAQ,GAAG,UAAU,GAAG,iBAAiB,CAC1C,GACC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;AAE1C,OAAO,EAAE,cAAc,EAAE,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/database/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAwG7C,OAAO,EAAE,cAAc,EAAE,CAAC","sourcesContent":["import { AnyTable, AnySchema, DefinitionSchema, RuntimeTables, Schema } from \"@dsqlbase/core\";\nimport { TableByAlias } from \"@dsqlbase/core/runtime\";\nimport { UnionToIntersection } from \"@dsqlbase/core/utils\";\nimport { ModelClient } from \"../model/client.js\";\nimport { ColumnTypeOf, TenantKeysOf, UnionMembersOf, ValueTypeOf } from \"../model/base.js\";\nimport { UnionClient } from \"../union/client.js\";\nimport { DatabaseClient } from \"./client.js\";\n\n/** Every union alias in a schema. */\nexport type UnionAliases<T extends DefinitionSchema> = keyof Schema<T>[\"unions\"] & string;\n\n/**\n * Every alias in a schema the client addresses a model by: each table, and each union.\n */\nexport type Aliases<T extends DefinitionSchema> = keyof RuntimeTables<Schema<T>> | UnionAliases<T>;\n\n/**\n * The claims a schema declares, as one object.\n *\n * Gathered across tables rather than per table, because that is how an identity is given: one\n * object for the whole client. A claim declared twice with different value types collapses to\n * `never` here, mirroring the registry's data-type check at runtime.\n */\nexport type ClaimsOf<TSchema extends AnySchema> = UnionToIntersection<\n {\n [A in keyof RuntimeTables<TSchema> & string]: {\n [C in TenantKeysOf<TableByAlias<TSchema, A>>]: ValueTypeOf<\n ColumnTypeOf<TableByAlias<TSchema, A>, C>\n >;\n };\n }[keyof RuntimeTables<TSchema> & string]\n>;\n\n/**\n * The aliases a client holding `TClaims` may address: every global table, plus every tenant\n * table whose claims the identity carries in full. A table needing a claim that is not there is\n * not hidden to be tidy — it is hidden because reaching it would throw.\n */\nexport type VisibleAliases<TSchema extends AnySchema, TClaims> =\n | VisibleTableAliases<TSchema, TClaims>\n | VisibleUnionAliases<TSchema, TClaims>;\n\ntype VisibleTableAliases<TSchema extends AnySchema, TClaims> = {\n [A in keyof RuntimeTables<TSchema> & string]: [\n TenantKeysOf<TableByAlias<TSchema, A>>,\n ] extends [keyof TClaims]\n ? A\n : never;\n}[keyof RuntimeTables<TSchema> & string];\n\n/**\n * A union is visible only when every member is: each read runs a branch per member, and one\n * branch a client cannot reach makes the whole read throw.\n */\ntype VisibleUnionAliases<TSchema extends AnySchema, TClaims> = {\n [U in keyof TSchema[\"unions\"] & string]: [\n Exclude<keyof UnionMembersOf<TSchema[\"unions\"][U]>, VisibleTableAliases<TSchema, TClaims>>,\n ] extends [never]\n ? U\n : never;\n}[keyof TSchema[\"unions\"] & string];\n\n/**\n * Which aliases a client shows, given its claims and whether it enforces.\n *\n * An unscoped client sees everything when enforcement is off, and only the global tables when\n * it is on — the same rule the runtime applies, so the type never promises a table that would\n * throw.\n */\nexport type VisibleFor<\n T extends DefinitionSchema,\n TClaims,\n TEnforce extends boolean,\n> = [TClaims] extends [never]\n ? TEnforce extends false\n ? Aliases<T>\n : VisibleAliases<Schema<T>, object>\n : VisibleAliases<Schema<T>, TClaims>;\n\nexport type Models<\n T extends DefinitionSchema,\n TVisible extends Aliases<T> = Aliases<T>,\n> = {\n readonly [K in TVisible]: K extends keyof RuntimeTables<Schema<T>>\n ? RuntimeTables<Schema<T>>[K] extends infer TTable\n ? TTable extends AnyTable\n ? ModelClient<TTable, T>\n : never\n : never\n : K extends UnionAliases<T>\n ? UnionClient<UnionMembersOf<Schema<T>[\"unions\"][K]>, T>\n : never;\n};\n\nexport type QueryClient<\n T extends DefinitionSchema,\n TEnforce extends boolean = true,\n> = DatabaseClient<T, never, TEnforce> & Models<T, VisibleFor<T, never, TEnforce>>;\n\n/**\n * A client scoped to an identity. It has no raw-SQL methods: `$query` on a scoped client would\n * look tenant-safe and would not be, so it is removed rather than guarded only at runtime. It\n * cannot be re-scoped either — claims are set in exactly one place.\n */\nexport type IdentityClient<T extends DefinitionSchema, TClaims> = Omit<\n DatabaseClient<T, TClaims>,\n \"$query\" | \"$execute\" | \"$identityClaims\"\n> &\n Models<T, VisibleFor<T, TClaims, true>>;\n\nexport { DatabaseClient };\n"]}
|