dsqlbase 0.1.6 → 0.2.1
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 +211 -0
- package/LICENSE +21 -0
- package/README.md +206 -2
- package/dist/client/create.d.ts +24 -4
- package/dist/client/create.d.ts.map +1 -1
- package/dist/client/create.js +21 -9
- package/dist/client/create.js.map +1 -1
- package/dist/client/database/base.d.ts +92 -1
- package/dist/client/database/base.d.ts.map +1 -1
- package/dist/client/database/base.js +196 -1
- package/dist/client/database/base.js.map +1 -1
- package/dist/client/database/client.d.ts +21 -5
- package/dist/client/database/client.d.ts.map +1 -1
- package/dist/client/database/client.js +39 -1
- package/dist/client/database/client.js.map +1 -1
- package/dist/client/database/index.d.ts +60 -4
- package/dist/client/database/index.d.ts.map +1 -1
- package/dist/client/database/index.js.map +1 -1
- package/dist/client/index.d.ts +4 -2
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +4 -2
- package/dist/client/index.js.map +1 -1
- package/dist/client/model/base.d.ts +553 -136
- package/dist/client/model/base.d.ts.map +1 -1
- package/dist/client/model/base.js +1 -6
- package/dist/client/model/base.js.map +1 -1
- package/dist/client/model/client.d.ts +45 -8
- package/dist/client/model/client.d.ts.map +1 -1
- package/dist/client/model/client.js +58 -2
- package/dist/client/model/client.js.map +1 -1
- package/dist/client/model/filters.d.ts +276 -0
- package/dist/client/model/filters.d.ts.map +1 -0
- package/dist/client/model/filters.js +470 -0
- package/dist/client/model/filters.js.map +1 -0
- package/dist/client/model/normalizer.d.ts +127 -3
- package/dist/client/model/normalizer.d.ts.map +1 -1
- package/dist/client/model/normalizer.js +526 -106
- package/dist/client/model/normalizer.js.map +1 -1
- package/dist/client/nodes.d.ts +62 -0
- package/dist/client/nodes.d.ts.map +1 -0
- package/dist/client/nodes.js +378 -0
- package/dist/client/nodes.js.map +1 -0
- package/dist/client/pagination/cursor.d.ts +40 -0
- package/dist/client/pagination/cursor.d.ts.map +1 -0
- package/dist/client/pagination/cursor.js +79 -0
- package/dist/client/pagination/cursor.js.map +1 -0
- package/dist/client/pagination/page.d.ts +23 -0
- package/dist/client/pagination/page.d.ts.map +1 -0
- package/dist/client/pagination/page.js +37 -0
- package/dist/client/pagination/page.js.map +1 -0
- package/dist/client/transaction/index.js.map +1 -1
- package/dist/client/transaction/occ-retry.d.ts +2 -2
- package/dist/client/transaction/occ-retry.d.ts.map +1 -1
- package/dist/client/transaction/occ-retry.js.map +1 -1
- package/dist/client/transaction/transaction-client.d.ts +4 -6
- package/dist/client/transaction/transaction-client.d.ts.map +1 -1
- package/dist/client/transaction/transaction-client.js +7 -18
- package/dist/client/transaction/transaction-client.js.map +1 -1
- package/dist/client/union/client.d.ts +55 -0
- package/dist/client/union/client.d.ts.map +1 -0
- package/dist/client/union/client.js +74 -0
- package/dist/client/union/client.js.map +1 -0
- package/dist/index.d.ts +5 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -2
- package/dist/index.js.map +1 -1
- package/dist/pg/index.d.ts +13 -1
- package/dist/pg/index.d.ts.map +1 -1
- package/dist/pg/index.js +52 -5
- package/dist/pg/index.js.map +1 -1
- package/dist/pglite/index.d.ts +7 -6
- package/dist/pglite/index.d.ts.map +1 -1
- package/dist/pglite/index.js +18 -4
- package/dist/pglite/index.js.map +1 -1
- package/dist/schema/columns/array.d.ts +12 -8
- package/dist/schema/columns/array.d.ts.map +1 -1
- package/dist/schema/columns/array.js +11 -14
- package/dist/schema/columns/array.js.map +1 -1
- package/dist/schema/columns/bigint.d.ts +1 -1
- package/dist/schema/columns/bigint.d.ts.map +1 -1
- package/dist/schema/columns/bigint.js +1 -0
- package/dist/schema/columns/bigint.js.map +1 -1
- package/dist/schema/columns/boolean.d.ts +1 -1
- package/dist/schema/columns/boolean.d.ts.map +1 -1
- package/dist/schema/columns/boolean.js +1 -0
- package/dist/schema/columns/boolean.js.map +1 -1
- package/dist/schema/columns/bytea.d.ts +1 -1
- package/dist/schema/columns/bytea.d.ts.map +1 -1
- package/dist/schema/columns/bytea.js +1 -0
- package/dist/schema/columns/bytea.js.map +1 -1
- package/dist/schema/columns/char.d.ts +1 -1
- package/dist/schema/columns/char.d.ts.map +1 -1
- package/dist/schema/columns/char.js +1 -0
- package/dist/schema/columns/char.js.map +1 -1
- package/dist/schema/columns/date.d.ts +3 -3
- package/dist/schema/columns/date.d.ts.map +1 -1
- package/dist/schema/columns/date.js +1 -0
- package/dist/schema/columns/date.js.map +1 -1
- package/dist/schema/columns/double.d.ts +1 -1
- package/dist/schema/columns/double.d.ts.map +1 -1
- package/dist/schema/columns/double.js +1 -0
- package/dist/schema/columns/double.js.map +1 -1
- package/dist/schema/columns/guid.d.ts +57 -0
- package/dist/schema/columns/guid.d.ts.map +1 -0
- package/dist/schema/columns/guid.js +53 -0
- package/dist/schema/columns/guid.js.map +1 -0
- package/dist/schema/columns/identity.d.ts +6 -6
- package/dist/schema/columns/identity.d.ts.map +1 -1
- package/dist/schema/columns/identity.js +2 -0
- package/dist/schema/columns/identity.js.map +1 -1
- package/dist/schema/columns/int.d.ts +1 -1
- package/dist/schema/columns/int.d.ts.map +1 -1
- package/dist/schema/columns/int.js +1 -0
- package/dist/schema/columns/int.js.map +1 -1
- package/dist/schema/columns/interval.d.ts +4 -3
- package/dist/schema/columns/interval.d.ts.map +1 -1
- package/dist/schema/columns/interval.js +1 -0
- package/dist/schema/columns/interval.js.map +1 -1
- package/dist/schema/columns/json.d.ts +79 -2
- package/dist/schema/columns/json.d.ts.map +1 -1
- package/dist/schema/columns/json.js +158 -8
- package/dist/schema/columns/json.js.map +1 -1
- package/dist/schema/columns/numeric.d.ts +61 -3
- package/dist/schema/columns/numeric.d.ts.map +1 -1
- package/dist/schema/columns/numeric.js +92 -6
- package/dist/schema/columns/numeric.js.map +1 -1
- package/dist/schema/columns/real.d.ts +1 -1
- package/dist/schema/columns/real.d.ts.map +1 -1
- package/dist/schema/columns/real.js +1 -0
- package/dist/schema/columns/real.js.map +1 -1
- package/dist/schema/columns/record.d.ts +20 -0
- package/dist/schema/columns/record.d.ts.map +1 -0
- package/dist/schema/columns/record.js +21 -0
- package/dist/schema/columns/record.js.map +1 -0
- package/dist/schema/columns/smallint.d.ts +1 -1
- package/dist/schema/columns/smallint.d.ts.map +1 -1
- package/dist/schema/columns/smallint.js +1 -0
- package/dist/schema/columns/smallint.js.map +1 -1
- package/dist/schema/columns/text.d.ts +1 -1
- package/dist/schema/columns/text.d.ts.map +1 -1
- package/dist/schema/columns/text.js +1 -0
- package/dist/schema/columns/text.js.map +1 -1
- package/dist/schema/columns/time.d.ts +3 -3
- package/dist/schema/columns/time.d.ts.map +1 -1
- package/dist/schema/columns/time.js +1 -0
- package/dist/schema/columns/time.js.map +1 -1
- package/dist/schema/columns/timestamp.d.ts +6 -6
- package/dist/schema/columns/timestamp.d.ts.map +1 -1
- package/dist/schema/columns/timestamp.js +1 -0
- package/dist/schema/columns/timestamp.js.map +1 -1
- package/dist/schema/columns/uuid.d.ts +1 -1
- package/dist/schema/columns/uuid.d.ts.map +1 -1
- package/dist/schema/columns/uuid.js +1 -0
- package/dist/schema/columns/uuid.js.map +1 -1
- package/dist/schema/columns/varchar.d.ts +1 -1
- package/dist/schema/columns/varchar.d.ts.map +1 -1
- package/dist/schema/columns/varchar.js +1 -0
- package/dist/schema/columns/varchar.js.map +1 -1
- package/dist/schema/domain.d.ts +2 -2
- package/dist/schema/domain.d.ts.map +1 -1
- package/dist/schema/domain.js +2 -0
- package/dist/schema/domain.js.map +1 -1
- package/dist/schema/embedded.d.ts +31 -0
- package/dist/schema/embedded.d.ts.map +1 -0
- package/dist/schema/embedded.js +33 -0
- package/dist/schema/embedded.js.map +1 -0
- package/dist/schema/index.d.ts +9 -1
- package/dist/schema/index.d.ts.map +1 -1
- package/dist/schema/index.js +6 -1
- package/dist/schema/index.js.map +1 -1
- package/dist/schema/namespace.js.map +1 -1
- package/dist/schema/relations.d.ts +17 -5
- package/dist/schema/relations.d.ts.map +1 -1
- package/dist/schema/relations.js +9 -0
- package/dist/schema/relations.js.map +1 -1
- package/dist/schema/sequence.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/tenant.d.ts +31 -0
- package/dist/schema/tenant.d.ts.map +1 -0
- package/dist/schema/tenant.js +33 -0
- package/dist/schema/tenant.js.map +1 -0
- package/dist/schema/union.d.ts +25 -0
- package/dist/schema/union.d.ts.map +1 -0
- package/dist/schema/union.js +27 -0
- package/dist/schema/union.js.map +1 -0
- package/dist/schema/utils/column-validation.d.ts +19 -0
- package/dist/schema/utils/column-validation.d.ts.map +1 -0
- package/dist/schema/utils/column-validation.js +37 -0
- package/dist/schema/utils/column-validation.js.map +1 -0
- package/dist/schema/utils/date.js.map +1 -1
- package/dist/schema/utils/duration.d.ts +2 -2
- package/dist/schema/utils/duration.d.ts.map +1 -1
- package/dist/schema/utils/duration.js.map +1 -1
- package/dist/schema/utils/global-id.d.ts +67 -0
- package/dist/schema/utils/global-id.d.ts.map +1 -0
- package/dist/schema/utils/global-id.js +99 -0
- package/dist/schema/utils/global-id.js.map +1 -0
- package/dist/schema/utils/standard-schema.d.ts +30 -0
- package/dist/schema/utils/standard-schema.d.ts.map +1 -0
- package/dist/schema/utils/standard-schema.js +2 -0
- package/dist/schema/utils/standard-schema.js.map +1 -0
- package/package.json +21 -16
- package/dist/schema/utils/json.d.ts +0 -2
- package/dist/schema/utils/json.d.ts.map +0 -1
- package/dist/schema/utils/json.js +0 -12
- package/dist/schema/utils/json.js.map +0 -1
|
@@ -0,0 +1,276 @@
|
|
|
1
|
+
import type { AnyColumnDefinition, ColumnConfig, ColumnRuntimeType } from "@dsqlbase/core/definition";
|
|
2
|
+
import { AnyColumn, AnyTable, SQLNode, SQLValue, Union } from "@dsqlbase/core";
|
|
3
|
+
import type { Prettify } from "@dsqlbase/core/utils";
|
|
4
|
+
import type { ColumnTypeOf, ColumnFieldNamesOf, GroupFieldNamesOf, GroupOf, ValueTypeOf } from "./base.js";
|
|
5
|
+
/**
|
|
6
|
+
* The `where` language: what a column of each runtime type can be filtered and ordered by, the
|
|
7
|
+
* filter types written from that table, and {@link WhereBuilder}, which enforces it while
|
|
8
|
+
* turning a `where` object into SQL. An operator the types refuse is also refused at runtime —
|
|
9
|
+
* before any SQL is built.
|
|
10
|
+
*/
|
|
11
|
+
declare const COMPARISON: readonly ["eq", "neq", "in", "gt", "gte", "lt", "lte", "between", "exists"];
|
|
12
|
+
declare const PATTERN: readonly ["beginsWith", "endsWith", "contains"];
|
|
13
|
+
declare const KEYED: readonly ["hasKey"];
|
|
14
|
+
export type FilterOperator = (typeof COMPARISON)[number] | (typeof PATTERN)[number] | (typeof KEYED)[number];
|
|
15
|
+
export type RuntimeTypeRules = {
|
|
16
|
+
/** The operators a filter on the column may use. */
|
|
17
|
+
operators: readonly FilterOperator[];
|
|
18
|
+
/** Whether a bare value stands for `{ eq: value }`. */
|
|
19
|
+
shorthand: boolean;
|
|
20
|
+
/** Whether the column can be an `orderBy` key. */
|
|
21
|
+
orderable: boolean;
|
|
22
|
+
/** Whether the database can compare two values for equality, which `distinct` needs. */
|
|
23
|
+
distinct: boolean;
|
|
24
|
+
};
|
|
25
|
+
export declare const RUNTIME_TYPE_RULES: Readonly<Record<ColumnRuntimeType, RuntimeTypeRules>>;
|
|
26
|
+
/** Every operator any runtime type accepts — what tells an operator object from a value. */
|
|
27
|
+
export declare const FILTER_OPERATORS: ReadonlySet<string>;
|
|
28
|
+
/**
|
|
29
|
+
* Inside a column's filter, `where` is reserved for filtering into the column's value — a
|
|
30
|
+
* document's keys, later an embedded object's members. Reserved so that no operator takes the
|
|
31
|
+
* name; not supported yet.
|
|
32
|
+
*/
|
|
33
|
+
export declare const NESTED_FILTER = "where";
|
|
34
|
+
/** The runtime types stored as `jsonb`, where `contains` is containment (`@>`). */
|
|
35
|
+
export declare const JSONB_RUNTIME_TYPES: ReadonlySet<ColumnRuntimeType>;
|
|
36
|
+
export declare function rulesOf(column: AnyColumn): RuntimeTypeRules;
|
|
37
|
+
/** The operators a runtime type accepts. Mirrors {@link RUNTIME_TYPE_RULES}. */
|
|
38
|
+
export type OperatorsOf<R extends ColumnRuntimeType> = R extends "string" ? (typeof COMPARISON)[number] | (typeof PATTERN)[number] : R extends "uuid" | "number" | "bigint" | "date" | "interval" ? (typeof COMPARISON)[number] : R extends "boolean" ? "eq" | "neq" | "exists" : R extends "object" ? "eq" | "neq" | "contains" | "hasKey" | "exists" : R extends JsonbRuntimeType ? "eq" | "neq" | "contains" | "exists" : "exists";
|
|
39
|
+
/** The runtime types stored as `jsonb`. Mirrors {@link JSONB_RUNTIME_TYPES}. */
|
|
40
|
+
export type JsonbRuntimeType = "jsonb" | "array" | "object";
|
|
41
|
+
/**
|
|
42
|
+
* What `contains` takes on runtime type `R` holding `V`: a substring on `string`, a fragment of
|
|
43
|
+
* the document on a `jsonb` type — never `null`, and anything on an untyped document. On `array`
|
|
44
|
+
* the fragment is itself an array, of item fragments.
|
|
45
|
+
*/
|
|
46
|
+
export type ContainsValueOf<R extends ColumnRuntimeType, V> = R extends "string" ? string : R extends JsonbRuntimeType ? unknown extends V ? unknown : JsonFragment<NonNullable<V>> : never;
|
|
47
|
+
/**
|
|
48
|
+
* A part of a JSON value, as `@>` matches it: any object member may be left out, at any depth,
|
|
49
|
+
* and an array lists some of its items.
|
|
50
|
+
*/
|
|
51
|
+
export type JsonFragment<T> = T extends Date ? T : T extends readonly (infer I)[] ? JsonFragment<I>[] : T extends object ? {
|
|
52
|
+
[K in keyof T]?: JsonFragment<T[K]>;
|
|
53
|
+
} : T;
|
|
54
|
+
/** The runtime types where a bare value stands for `{ eq: value }`. */
|
|
55
|
+
export type ShorthandRuntimeType = "string" | "uuid" | "number" | "bigint" | "date" | "interval" | "boolean";
|
|
56
|
+
/** The runtime types a column can be ordered by. */
|
|
57
|
+
export type OrderableRuntimeType = ShorthandRuntimeType;
|
|
58
|
+
export type FilterCondition<Value = unknown> = {
|
|
59
|
+
/**
|
|
60
|
+
* Equality condition - matches records where the field is equal to the specified value.
|
|
61
|
+
*
|
|
62
|
+
* ```sql
|
|
63
|
+
* "table"."column" = value
|
|
64
|
+
* ```
|
|
65
|
+
*/
|
|
66
|
+
eq?: Value;
|
|
67
|
+
/**
|
|
68
|
+
* Inequality condition - matches records where the field is not equal to the specified value.
|
|
69
|
+
*
|
|
70
|
+
* ```sql
|
|
71
|
+
* "table"."column" <> value
|
|
72
|
+
* ```
|
|
73
|
+
*/
|
|
74
|
+
neq?: Value;
|
|
75
|
+
/**
|
|
76
|
+
* Greater than condition - matches records where the field is greater than the specified value.
|
|
77
|
+
*
|
|
78
|
+
* ```sql
|
|
79
|
+
* "table"."column" > value
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
gt?: Value;
|
|
83
|
+
/**
|
|
84
|
+
* Greater than or equal condition - matches records where the field is greater than or equal to the specified value.
|
|
85
|
+
*
|
|
86
|
+
* ```sql
|
|
87
|
+
* "table"."column" >= value
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
gte?: Value;
|
|
91
|
+
/**
|
|
92
|
+
* Less than condition - matches records where the field is less than the specified value.
|
|
93
|
+
*
|
|
94
|
+
* ```sql
|
|
95
|
+
* "table"."column" < value
|
|
96
|
+
* ```
|
|
97
|
+
*/
|
|
98
|
+
lt?: Value;
|
|
99
|
+
/**
|
|
100
|
+
* Less than or equal condition - matches records where the field is less than or equal to the specified value.
|
|
101
|
+
*
|
|
102
|
+
* ```sql
|
|
103
|
+
* "table"."column" <= value
|
|
104
|
+
* ```
|
|
105
|
+
*/
|
|
106
|
+
lte?: Value;
|
|
107
|
+
/**
|
|
108
|
+
* In condition - matches records where the field is equal to any of the values in the specified array.
|
|
109
|
+
*
|
|
110
|
+
* ```sql
|
|
111
|
+
* "table"."column" IN (value1, value2, ...)
|
|
112
|
+
* ```
|
|
113
|
+
*/
|
|
114
|
+
in?: Value[];
|
|
115
|
+
/**
|
|
116
|
+
* Between condition - matches records where the field is between the two specified values (inclusive).
|
|
117
|
+
*
|
|
118
|
+
* ```sql
|
|
119
|
+
* "table"."column" BETWEEN value1 AND value2
|
|
120
|
+
* ```
|
|
121
|
+
*/
|
|
122
|
+
between?: [Value, Value];
|
|
123
|
+
/**
|
|
124
|
+
* Exists condition - matches records where the field exists (is not null).
|
|
125
|
+
*
|
|
126
|
+
* ```sql
|
|
127
|
+
* "table"."column" IS NOT NULL
|
|
128
|
+
* ```
|
|
129
|
+
*/
|
|
130
|
+
exists?: boolean;
|
|
131
|
+
/**
|
|
132
|
+
* Begins with condition - matches records where the field starts with the specified string.
|
|
133
|
+
*
|
|
134
|
+
* ```sql
|
|
135
|
+
* "table"."column" LIKE 'value%'
|
|
136
|
+
* ```
|
|
137
|
+
*/
|
|
138
|
+
beginsWith?: string;
|
|
139
|
+
/**
|
|
140
|
+
* Ends with condition - matches records where the field ends with the specified string.
|
|
141
|
+
*
|
|
142
|
+
* ```sql
|
|
143
|
+
* "table"."column" LIKE '%value'
|
|
144
|
+
* ```
|
|
145
|
+
*/
|
|
146
|
+
endsWith?: string;
|
|
147
|
+
/**
|
|
148
|
+
* Contains condition. On a string column, matches records where the field contains the
|
|
149
|
+
* specified string; on a `jsonb` column, where the document contains the specified fragment
|
|
150
|
+
* (see {@link ContainsValueOf}).
|
|
151
|
+
*
|
|
152
|
+
* ```sql
|
|
153
|
+
* "table"."column" LIKE '%value%'
|
|
154
|
+
* "table"."column" @> '{"fragment":true}'
|
|
155
|
+
* ```
|
|
156
|
+
*/
|
|
157
|
+
contains?: string;
|
|
158
|
+
/**
|
|
159
|
+
* Key condition, on a `record()` column - matches records whose object has the key at its top
|
|
160
|
+
* level.
|
|
161
|
+
*
|
|
162
|
+
* ```sql
|
|
163
|
+
* "table"."column" ? 'key'
|
|
164
|
+
* ```
|
|
165
|
+
*/
|
|
166
|
+
hasKey?: string;
|
|
167
|
+
};
|
|
168
|
+
/**
|
|
169
|
+
* A filter on a value of runtime type `R` holding `V`: the operators the runtime type allows,
|
|
170
|
+
* and, where it allows one, a bare value meaning `{ eq: value }`. Mirrors
|
|
171
|
+
* {@link RUNTIME_TYPE_RULES}, which {@link WhereBuilder} enforces.
|
|
172
|
+
*/
|
|
173
|
+
export type FilterOf<R extends ColumnRuntimeType, V> = Prettify<Pick<FilterCondition<V>, Exclude<OperatorsOf<R>, "contains">> & ("contains" extends OperatorsOf<R> ? {
|
|
174
|
+
contains?: ContainsValueOf<R, V>;
|
|
175
|
+
} : unknown)> | (R extends ShorthandRuntimeType ? V : never);
|
|
176
|
+
/** The filter a column accepts. */
|
|
177
|
+
export type ColumnFilterOf<C extends ColumnConfig> = FilterOf<C["runtimeType"], ValueTypeOf<C>>;
|
|
178
|
+
export type WhereExpressionOf<T extends AnyTable> = {
|
|
179
|
+
[K in ColumnFieldNamesOf<T>]?: T["__type"]["columns"][K] extends AnyColumnDefinition ? ColumnFilterOf<ColumnTypeOf<T, K>> : never;
|
|
180
|
+
} & {
|
|
181
|
+
and?: WhereExpressionOf<T>[];
|
|
182
|
+
or?: WhereExpressionOf<T>[];
|
|
183
|
+
not?: WhereExpressionOf<T>;
|
|
184
|
+
} & ([GroupFieldNamesOf<T>] extends [never] ? unknown : {
|
|
185
|
+
[K in GroupFieldNamesOf<T>]?: T["__type"]["columns"][K] extends GroupOf<infer C> ? GroupFilterOf<C> : never;
|
|
186
|
+
});
|
|
187
|
+
/**
|
|
188
|
+
* A column group's filter: whether it is present, and a nested `where` over its members. Members
|
|
189
|
+
* are named only inside `where`, never beside `exists`.
|
|
190
|
+
*/
|
|
191
|
+
export type GroupFilterOf<C> = {
|
|
192
|
+
exists?: boolean;
|
|
193
|
+
where?: MembersWhereOf<C>;
|
|
194
|
+
};
|
|
195
|
+
/** A nested `where` over a group's members: the same language as a table's. */
|
|
196
|
+
export type MembersWhereOf<C> = {
|
|
197
|
+
-readonly [K in keyof C]?: C[K] extends GroupOf<infer GC> ? GroupFilterOf<GC> : C[K] extends {
|
|
198
|
+
__type: infer TConfig extends ColumnConfig;
|
|
199
|
+
} ? ColumnFilterOf<TConfig> : never;
|
|
200
|
+
} & {
|
|
201
|
+
and?: MembersWhereOf<C>[];
|
|
202
|
+
or?: MembersWhereOf<C>[];
|
|
203
|
+
not?: MembersWhereOf<C>;
|
|
204
|
+
};
|
|
205
|
+
export declare function isFilterType<T extends keyof FilterCondition>(value: unknown, type: T): value is Required<Pick<FilterCondition<SQLValue>, T>>;
|
|
206
|
+
/**
|
|
207
|
+
* Turns a `where` object into one SQL node, checking every operator against the column's runtime
|
|
208
|
+
* type, encoding every value through the column's codec, and — across a union — checking shared
|
|
209
|
+
* fields and deciding `$$key` per member.
|
|
210
|
+
*/
|
|
211
|
+
export declare class WhereBuilder {
|
|
212
|
+
build<TTable extends AnyTable>(table: TTable, where: WhereExpressionOf<TTable> | null | undefined): SQLNode | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* A `where` over the fields of `table`, or — inside a group's nested `where` — over the members
|
|
215
|
+
* of `group`. The same language at every level: fields, `and` / `or` / `not`.
|
|
216
|
+
*/
|
|
217
|
+
private _build;
|
|
218
|
+
/**
|
|
219
|
+
* One column's filter, as its runtime type allows ({@link RUNTIME_TYPE_RULES}): a bare value means
|
|
220
|
+
* `{ eq: value }` where the type takes one, and every operator in an object adds a condition,
|
|
221
|
+
* AND-ed with the rest. Anything the type does not allow throws before SQL is built.
|
|
222
|
+
*/
|
|
223
|
+
private _getColumnFilter;
|
|
224
|
+
/**
|
|
225
|
+
* A column group's filter: `exists` — whether the group is present, by the rule it is read
|
|
226
|
+
* `null` by — and the nested `where` over its members. Members are only ever named inside
|
|
227
|
+
* `where`, so a member called `exists` cannot be mistaken for the operator.
|
|
228
|
+
*/
|
|
229
|
+
private _getGroupFilter;
|
|
230
|
+
/**
|
|
231
|
+
* Whether a column's filter is an object of operators rather than a value: a plain object
|
|
232
|
+
* naming at least one. A value can itself be a plain object — an `interval` read as a
|
|
233
|
+
* `Duration`, a JSON document — so one that names no operator is a value.
|
|
234
|
+
*/
|
|
235
|
+
private _isOperatorObject;
|
|
236
|
+
private _getOperatorFilter;
|
|
237
|
+
/**
|
|
238
|
+
* The `where` of an operation that requires one — `findOne`, `update`, `delete` — refusing a
|
|
239
|
+
* filter that selects nothing in particular. `{}` means "every row" everywhere else; here it
|
|
240
|
+
* would pick an arbitrary row to read, or every row to change.
|
|
241
|
+
*/
|
|
242
|
+
buildRequired<TTable extends AnyTable>(table: TTable, where: WhereExpressionOf<TTable> | null | undefined, operation: string): SQLNode;
|
|
243
|
+
/**
|
|
244
|
+
* Refuses a field the members of `union` do not all share, anywhere in a shared `where` —
|
|
245
|
+
* inside `and` / `or` / `not` included. Checked on the union rather than per member, so the
|
|
246
|
+
* error names the union instead of whichever member happened to lack the field.
|
|
247
|
+
*/
|
|
248
|
+
assertShared(union: Union, where: Record<string, unknown> | null | undefined): void;
|
|
249
|
+
/**
|
|
250
|
+
* A `$$key` condition as a test on a member alias. `$$key` accepts `eq`, `neq`, `in` and the
|
|
251
|
+
* bare-value shorthand, each naming member aliases; anything else — another operator, a
|
|
252
|
+
* value that is not a member — is refused, since it could only ever be a typo.
|
|
253
|
+
*/
|
|
254
|
+
private _getKeyCondition;
|
|
255
|
+
/**
|
|
256
|
+
* A shared `where` as seen from one member, with every `$$key` condition decided.
|
|
257
|
+
*
|
|
258
|
+
* Inside a branch the member alias is a constant, so a `$$key` condition is simply true or
|
|
259
|
+
* false there. Folding it away here, rather than rendering `'photos' = 'videos'` into SQL,
|
|
260
|
+
* lets a member that can never match be pruned before a branch is built at all:
|
|
261
|
+
*
|
|
262
|
+
* - `false` — no row of this member can match; the member produces no branch;
|
|
263
|
+
* - otherwise the `where` that is left, with every decided condition removed. An `or` holding
|
|
264
|
+
* a true child is dropped whole; a `not` flips its child.
|
|
265
|
+
*/
|
|
266
|
+
foldKey(union: Union, where: Record<string, unknown>, alias: string): Record<string, unknown> | false;
|
|
267
|
+
/**
|
|
268
|
+
* A filter on a polymorphic id. A global id names a member as well as a key, and two members
|
|
269
|
+
* may hold the same key, so matching it takes both: `(discriminator = key AND id = pk)`. `in`
|
|
270
|
+
* becomes an `OR` of such groups, raw uuids among them compared on the id alone. `undefined`
|
|
271
|
+
* for any other operator, or a filter with no global id in it — the ordinary path handles those.
|
|
272
|
+
*/
|
|
273
|
+
private _getPolymorphicFilter;
|
|
274
|
+
}
|
|
275
|
+
export {};
|
|
276
|
+
//# sourceMappingURL=filters.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/client/model/filters.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACZ,iBAAiB,EAClB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,SAAS,EAET,QAAQ,EAIR,OAAO,EACP,QAAQ,EACR,KAAK,EACN,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGrD,OAAO,KAAK,EACV,YAAY,EACZ,kBAAkB,EAClB,iBAAiB,EACjB,OAAO,EACP,WAAW,EACZ,MAAM,WAAW,CAAC;AAEnB;;;;;GAKG;AAEH,QAAA,MAAM,UAAU,6EAA8E,CAAC;AAC/F,QAAA,MAAM,OAAO,iDAAkD,CAAC;AAChE,QAAA,MAAM,KAAK,qBAAsB,CAAC;AAElC,MAAM,MAAM,cAAc,GACtB,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,GAC3B,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,GACxB,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3B,MAAM,MAAM,gBAAgB,GAAG;IAC7B,oDAAoD;IACpD,SAAS,EAAE,SAAS,cAAc,EAAE,CAAC;IACrC,uDAAuD;IACvD,SAAS,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,SAAS,EAAE,OAAO,CAAC;IACnB,wFAAwF;IACxF,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAwBF,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAcpF,CAAC;AAEF,4FAA4F;AAC5F,eAAO,MAAM,gBAAgB,EAAE,WAAW,CAAC,MAAM,CAI/C,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,aAAa,UAAU,CAAC;AAErC,mFAAmF;AACnF,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAAC,iBAAiB,CAI7D,CAAC;AAwBH,wBAAgB,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,gBAAgB,CAE3D;AAMD,gFAAgF;AAChF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,iBAAiB,IAAI,CAAC,SAAS,QAAQ,GACrE,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,GACtD,CAAC,SAAS,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,GAC1D,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,GAC3B,CAAC,SAAS,SAAS,GACjB,IAAI,GAAG,KAAK,GAAG,QAAQ,GACvB,CAAC,SAAS,QAAQ,GAChB,IAAI,GAAG,KAAK,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAC/C,CAAC,SAAS,gBAAgB,GACxB,IAAI,GAAG,KAAK,GAAG,UAAU,GAAG,QAAQ,GACpC,QAAQ,CAAC;AAErB,gFAAgF;AAChF,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,iBAAiB,EAAE,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC5E,MAAM,GACN,CAAC,SAAS,gBAAgB,GACxB,OAAO,SAAS,CAAC,GACf,OAAO,GACP,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAC9B,KAAK,CAAC;AAEZ;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,GACxC,CAAC,GACD,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAC5B,YAAY,CAAC,CAAC,CAAC,EAAE,GACjB,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACvC,CAAC,CAAC;AAEV,uEAAuE;AACvE,MAAM,MAAM,oBAAoB,GAC5B,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,UAAU,GACV,SAAS,CAAC;AAEd,oDAAoD;AACpD,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AAMxD,MAAM,MAAM,eAAe,CAAC,KAAK,GAAG,OAAO,IAAI;IAC7C;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC;IAEX;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC;IAEZ;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC;IAEX;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC;IAEZ;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC;IAEX;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC;IAEZ;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC;IAEb;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAEzB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,iBAAiB,EAAE,CAAC,IAC/C,QAAQ,CACN,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,GAC3D,CAAC,UAAU,SAAS,WAAW,CAAC,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CAAE,GAAG,OAAO,CAAC,CACvF,GACD,CAAC,CAAC,SAAS,oBAAoB,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;AAEjD,mCAAmC;AACnC,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,YAAY,IAAI,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhG,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,QAAQ,IAAI;KACjD,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,mBAAmB,GAChF,cAAc,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAClC,KAAK;CACV,GAAG;IACF,GAAG,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7B,EAAE,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5B,GAAG,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAC5B,GAAG,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACrC,OAAO,GACP;KACG,CAAC,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAC5E,aAAa,CAAC,CAAC,CAAC,GAChB,KAAK;CACV,CAAC,CAAC;AAET;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;IAC7B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;CAC3B,CAAC;AAEF,+EAA+E;AAC/E,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,EAAE,CAAC,GACrD,aAAa,CAAC,EAAE,CAAC,GACjB,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,MAAM,EAAE,MAAM,OAAO,SAAS,YAAY,CAAA;KAAE,GACzD,cAAc,CAAC,OAAO,CAAC,GACvB,KAAK;CACZ,GAAG;IACF,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;IACzB,GAAG,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;CACzB,CAAC;AAEF,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,eAAe,EAC1D,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,CAAC,GACN,KAAK,IAAI,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAOvD;AAMD;;;;GAIG;AACH,qBAAa,YAAY;IAChB,KAAK,CAAC,MAAM,SAAS,QAAQ,EAClC,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,GAClD,OAAO,GAAG,SAAS;IAItB;;;OAGG;IACH,OAAO,CAAC,MAAM;IAgEd;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAyDxB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAgDvB;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAczB,OAAO,CAAC,kBAAkB;IA+D1B;;;;OAIG;IACI,aAAa,CAAC,MAAM,SAAS,QAAQ,EAC1C,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,EACnD,SAAS,EAAE,MAAM,GAChB,OAAO;IAaV;;;;OAIG;IACI,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS;IA6BnF;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAwCxB;;;;;;;;;;OAUG;IACI,OAAO,CACZ,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,KAAK,EAAE,MAAM,GACZ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK;IAwElC;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;CAqD9B"}
|