kysely 0.19.9 → 0.19.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/README.md +56 -7
  2. package/dist/cjs/dialect/mysql/mysql-dialect-config.d.ts +10 -0
  3. package/dist/cjs/dialect/mysql/mysql-driver.d.ts +1 -0
  4. package/dist/cjs/dialect/mysql/mysql-driver.js +25 -0
  5. package/dist/cjs/dialect/postgres/postgres-dialect-config.d.ts +29 -0
  6. package/dist/cjs/dialect/postgres/postgres-driver.d.ts +6 -2
  7. package/dist/cjs/dialect/postgres/postgres-driver.js +24 -2
  8. package/dist/cjs/dialect/sqlite/sqlite-driver.js +3 -0
  9. package/dist/cjs/driver/database-connection.d.ts +1 -0
  10. package/dist/cjs/driver/dummy-driver.js +3 -0
  11. package/dist/cjs/index.d.ts +4 -0
  12. package/dist/cjs/index.js +4 -0
  13. package/dist/cjs/operation-node/create-table-node.d.ts +3 -1
  14. package/dist/cjs/operation-node/create-table-node.js +2 -1
  15. package/dist/cjs/operation-node/create-type-node.d.ts +17 -0
  16. package/dist/cjs/operation-node/create-type-node.js +27 -0
  17. package/dist/cjs/operation-node/data-type-node.d.ts +1 -1
  18. package/dist/cjs/operation-node/drop-type-node.d.ts +16 -0
  19. package/dist/cjs/operation-node/drop-type-node.js +25 -0
  20. package/dist/cjs/operation-node/foreign-key-constraint-node.d.ts +2 -2
  21. package/dist/cjs/operation-node/insert-query-node.d.ts +2 -1
  22. package/dist/cjs/operation-node/insert-query-node.js +2 -1
  23. package/dist/cjs/operation-node/operation-node-transformer.d.ts +4 -0
  24. package/dist/cjs/operation-node/operation-node-transformer.js +17 -0
  25. package/dist/cjs/operation-node/operation-node-visitor.d.ts +4 -0
  26. package/dist/cjs/operation-node/operation-node-visitor.js +2 -0
  27. package/dist/cjs/operation-node/operation-node.d.ts +1 -1
  28. package/dist/cjs/operation-node/references-node.d.ts +3 -1
  29. package/dist/cjs/operation-node/references-node.js +8 -1
  30. package/dist/cjs/parser/on-commit-action-parse.d.ts +2 -0
  31. package/dist/cjs/parser/on-commit-action-parse.js +11 -0
  32. package/dist/cjs/parser/on-modify-action-parser.d.ts +2 -0
  33. package/dist/cjs/parser/on-modify-action-parser.js +11 -0
  34. package/dist/cjs/plugin/with-schema/with-schema-transformer.d.ts +4 -0
  35. package/dist/cjs/plugin/with-schema/with-schema-transformer.js +6 -0
  36. package/dist/cjs/query-builder/insert-query-builder.d.ts +1 -1
  37. package/dist/cjs/query-builder/select-query-builder.d.ts +27 -0
  38. package/dist/cjs/query-builder/select-query-builder.js +34 -2
  39. package/dist/cjs/query-compiler/default-query-compiler.d.ts +5 -0
  40. package/dist/cjs/query-compiler/default-query-compiler.js +35 -2
  41. package/dist/cjs/query-compiler/query-compiler.d.ts +3 -1
  42. package/dist/cjs/query-creator.d.ts +27 -0
  43. package/dist/cjs/query-creator.js +33 -0
  44. package/dist/cjs/query-executor/query-executor-base.d.ts +6 -0
  45. package/dist/cjs/query-executor/query-executor-base.js +19 -0
  46. package/dist/cjs/query-executor/query-executor.d.ts +11 -0
  47. package/dist/cjs/schema/column-definition-builder.js +3 -2
  48. package/dist/cjs/schema/create-table-builder.d.ts +6 -6
  49. package/dist/cjs/schema/create-table-builder.js +8 -7
  50. package/dist/cjs/schema/create-type-builder.d.ts +28 -0
  51. package/dist/cjs/schema/create-type-builder.js +38 -0
  52. package/dist/cjs/schema/drop-type-builder.d.ts +19 -0
  53. package/dist/cjs/schema/drop-type-builder.js +31 -0
  54. package/dist/cjs/schema/foreign-key-constraint-builder.js +3 -2
  55. package/dist/cjs/schema/schema.d.ts +32 -0
  56. package/dist/cjs/schema/schema.js +46 -0
  57. package/dist/cjs/util/deferred.d.ts +7 -0
  58. package/dist/cjs/util/deferred.js +28 -0
  59. package/dist/esm/dialect/mysql/mysql-dialect-config.d.ts +10 -0
  60. package/dist/esm/dialect/mysql/mysql-driver.d.ts +1 -0
  61. package/dist/esm/dialect/mysql/mysql-driver.js +25 -0
  62. package/dist/esm/dialect/postgres/postgres-dialect-config.d.ts +29 -0
  63. package/dist/esm/dialect/postgres/postgres-driver.d.ts +6 -2
  64. package/dist/esm/dialect/postgres/postgres-driver.js +24 -2
  65. package/dist/esm/dialect/sqlite/sqlite-driver.js +3 -0
  66. package/dist/esm/driver/database-connection.d.ts +1 -0
  67. package/dist/esm/driver/dummy-driver.js +3 -0
  68. package/dist/esm/index.d.ts +4 -0
  69. package/dist/esm/index.js +4 -0
  70. package/dist/esm/operation-node/create-table-node.d.ts +3 -1
  71. package/dist/esm/operation-node/create-table-node.js +1 -0
  72. package/dist/esm/operation-node/create-type-node.d.ts +17 -0
  73. package/dist/esm/operation-node/create-type-node.js +25 -0
  74. package/dist/esm/operation-node/data-type-node.d.ts +1 -1
  75. package/dist/esm/operation-node/drop-type-node.d.ts +16 -0
  76. package/dist/esm/operation-node/drop-type-node.js +23 -0
  77. package/dist/esm/operation-node/foreign-key-constraint-node.d.ts +2 -2
  78. package/dist/esm/operation-node/insert-query-node.d.ts +2 -1
  79. package/dist/esm/operation-node/insert-query-node.js +2 -1
  80. package/dist/esm/operation-node/operation-node-transformer.d.ts +4 -0
  81. package/dist/esm/operation-node/operation-node-transformer.js +17 -0
  82. package/dist/esm/operation-node/operation-node-visitor.d.ts +4 -0
  83. package/dist/esm/operation-node/operation-node-visitor.js +2 -0
  84. package/dist/esm/operation-node/operation-node.d.ts +1 -1
  85. package/dist/esm/operation-node/references-node.d.ts +3 -1
  86. package/dist/esm/operation-node/references-node.js +7 -0
  87. package/dist/esm/parser/on-commit-action-parse.d.ts +2 -0
  88. package/dist/esm/parser/on-commit-action-parse.js +8 -0
  89. package/dist/esm/parser/on-modify-action-parser.d.ts +2 -0
  90. package/dist/esm/parser/on-modify-action-parser.js +8 -0
  91. package/dist/esm/plugin/with-schema/with-schema-transformer.d.ts +4 -0
  92. package/dist/esm/plugin/with-schema/with-schema-transformer.js +6 -0
  93. package/dist/esm/query-builder/insert-query-builder.d.ts +1 -1
  94. package/dist/esm/query-builder/select-query-builder.d.ts +27 -0
  95. package/dist/esm/query-builder/select-query-builder.js +34 -2
  96. package/dist/esm/query-compiler/default-query-compiler.d.ts +5 -0
  97. package/dist/esm/query-compiler/default-query-compiler.js +35 -2
  98. package/dist/esm/query-compiler/query-compiler.d.ts +3 -1
  99. package/dist/esm/query-creator.d.ts +27 -0
  100. package/dist/esm/query-creator.js +33 -0
  101. package/dist/esm/query-executor/query-executor-base.d.ts +6 -0
  102. package/dist/esm/query-executor/query-executor-base.js +19 -0
  103. package/dist/esm/query-executor/query-executor.d.ts +11 -0
  104. package/dist/esm/schema/column-definition-builder.js +3 -2
  105. package/dist/esm/schema/create-table-builder.d.ts +6 -6
  106. package/dist/esm/schema/create-table-builder.js +8 -7
  107. package/dist/esm/schema/create-type-builder.d.ts +28 -0
  108. package/dist/esm/schema/create-type-builder.js +35 -0
  109. package/dist/esm/schema/drop-type-builder.d.ts +19 -0
  110. package/dist/esm/schema/drop-type-builder.js +28 -0
  111. package/dist/esm/schema/foreign-key-constraint-builder.js +3 -2
  112. package/dist/esm/schema/schema.d.ts +32 -0
  113. package/dist/esm/schema/schema.js +46 -0
  114. package/dist/esm/util/deferred.d.ts +7 -0
  115. package/dist/esm/util/deferred.js +25 -0
  116. package/package.json +5 -2
@@ -0,0 +1,35 @@
1
+ /// <reference types="./create-type-builder.d.ts" />
2
+ import { preventAwait } from '../util/prevent-await.js';
3
+ import { freeze } from '../util/object-utils.js';
4
+ import { CreateTypeNode } from '../operation-node/create-type-node.js';
5
+ export class CreateTypeBuilder {
6
+ #props;
7
+ constructor(props) {
8
+ this.#props = freeze(props);
9
+ }
10
+ toOperationNode() {
11
+ return this.#props.executor.transformQuery(this.#props.createTypeNode, this.#props.queryId);
12
+ }
13
+ /**
14
+ * Creates an anum type.
15
+ *
16
+ * ### Examples
17
+ *
18
+ * ```ts
19
+ * db.schema.createType('species').asEnum(['cat', 'dog', 'frog'])
20
+ * ```
21
+ */
22
+ asEnum(values) {
23
+ return new CreateTypeBuilder({
24
+ ...this.#props,
25
+ createTypeNode: CreateTypeNode.cloneWithEnum(this.#props.createTypeNode, values),
26
+ });
27
+ }
28
+ compile() {
29
+ return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
30
+ }
31
+ async execute() {
32
+ await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
33
+ }
34
+ }
35
+ preventAwait(CreateTypeBuilder, "don't await CreateTypeBuilder instances directly. To execute the query you need to call `execute`");
@@ -0,0 +1,19 @@
1
+ import { DropTypeNode } from '../operation-node/drop-type-node.js';
2
+ import { OperationNodeSource } from '../operation-node/operation-node-source.js';
3
+ import { CompiledQuery } from '../query-compiler/compiled-query.js';
4
+ import { Compilable } from '../util/compilable.js';
5
+ import { QueryExecutor } from '../query-executor/query-executor.js';
6
+ import { QueryId } from '../util/query-id.js';
7
+ export declare class DropTypeBuilder implements OperationNodeSource, Compilable {
8
+ #private;
9
+ constructor(props: DropTypeBuilderProps);
10
+ ifExists(): DropTypeBuilder;
11
+ toOperationNode(): DropTypeNode;
12
+ compile(): CompiledQuery;
13
+ execute(): Promise<void>;
14
+ }
15
+ export interface DropTypeBuilderProps {
16
+ readonly queryId: QueryId;
17
+ readonly executor: QueryExecutor;
18
+ readonly dropTypeNode: DropTypeNode;
19
+ }
@@ -0,0 +1,28 @@
1
+ /// <reference types="./drop-type-builder.d.ts" />
2
+ import { DropTypeNode } from '../operation-node/drop-type-node.js';
3
+ import { preventAwait } from '../util/prevent-await.js';
4
+ import { freeze } from '../util/object-utils.js';
5
+ export class DropTypeBuilder {
6
+ #props;
7
+ constructor(props) {
8
+ this.#props = freeze(props);
9
+ }
10
+ ifExists() {
11
+ return new DropTypeBuilder({
12
+ ...this.#props,
13
+ dropTypeNode: DropTypeNode.cloneWith(this.#props.dropTypeNode, {
14
+ ifExists: true,
15
+ }),
16
+ });
17
+ }
18
+ toOperationNode() {
19
+ return this.#props.executor.transformQuery(this.#props.dropTypeNode, this.#props.queryId);
20
+ }
21
+ compile() {
22
+ return this.#props.executor.compileQuery(this.toOperationNode(), this.#props.queryId);
23
+ }
24
+ async execute() {
25
+ await this.#props.executor.executeQuery(this.compile(), this.#props.queryId);
26
+ }
27
+ }
28
+ preventAwait(DropTypeBuilder, "don't await DropTypeBuilder instances directly. To execute the query you need to call `execute`");
@@ -1,5 +1,6 @@
1
1
  /// <reference types="./foreign-key-constraint-builder.d.ts" />
2
2
  import { ForeignKeyConstraintNode } from '../operation-node/foreign-key-constraint-node.js';
3
+ import { parseOnModifyForeignAction } from '../parser/on-modify-action-parser.js';
3
4
  import { preventAwait } from '../util/prevent-await.js';
4
5
  export class ForeignKeyConstraintBuilder {
5
6
  #node;
@@ -8,12 +9,12 @@ export class ForeignKeyConstraintBuilder {
8
9
  }
9
10
  onDelete(onDelete) {
10
11
  return new ForeignKeyConstraintBuilder(ForeignKeyConstraintNode.cloneWith(this.#node, {
11
- onDelete,
12
+ onDelete: parseOnModifyForeignAction(onDelete),
12
13
  }));
13
14
  }
14
15
  onUpdate(onUpdate) {
15
16
  return new ForeignKeyConstraintBuilder(ForeignKeyConstraintNode.cloneWith(this.#node, {
16
- onUpdate,
17
+ onUpdate: parseOnModifyForeignAction(onUpdate),
17
18
  }));
18
19
  }
19
20
  toOperationNode() {
@@ -9,6 +9,8 @@ import { DropTableBuilder } from './drop-table-builder.js';
9
9
  import { CreateViewBuilder } from './create-view-builder.js';
10
10
  import { DropViewBuilder } from './drop-view-builder.js';
11
11
  import { KyselyPlugin } from '../plugin/kysely-plugin.js';
12
+ import { CreateTypeBuilder } from './create-type-builder.js';
13
+ import { DropTypeBuilder } from './drop-type-builder.js';
12
14
  /**
13
15
  * Provides methods for building database schema.
14
16
  */
@@ -170,6 +172,36 @@ export declare class SchemaModule {
170
172
  * ```
171
173
  */
172
174
  dropView(viewName: string): DropViewBuilder;
175
+ /**
176
+ * Create a new type.
177
+ *
178
+ * Only some dialects like PostgreSQL have user-defined types.
179
+ *
180
+ * ### Examples
181
+ *
182
+ * ```ts
183
+ * await db.schema
184
+ * .createType('species')
185
+ * .asEnum(['dog', 'cat', 'frog'])
186
+ * .execute()
187
+ * ```
188
+ */
189
+ createType(viewName: string): CreateTypeBuilder;
190
+ /**
191
+ * Drop a type.
192
+ *
193
+ * Only some dialects like PostgreSQL have user-defined types.
194
+ *
195
+ * ### Examples
196
+ *
197
+ * ```ts
198
+ * await db.schema
199
+ * .dropType('species')
200
+ * .ifExists()
201
+ * .execute()
202
+ * ```
203
+ */
204
+ dropType(viewName: string): DropTypeBuilder;
173
205
  /**
174
206
  * Returns a copy of this schema module with the given plugin installed.
175
207
  */
@@ -20,6 +20,10 @@ import { CreateViewBuilder } from './create-view-builder.js';
20
20
  import { CreateViewNode } from '../operation-node/create-view-node.js';
21
21
  import { DropViewBuilder } from './drop-view-builder.js';
22
22
  import { DropViewNode } from '../operation-node/drop-view-node.js';
23
+ import { CreateTypeBuilder } from './create-type-builder.js';
24
+ import { DropTypeBuilder } from './drop-type-builder.js';
25
+ import { CreateTypeNode } from '../operation-node/create-type-node.js';
26
+ import { DropTypeNode } from '../operation-node/drop-type-node.js';
23
27
  /**
24
28
  * Provides methods for building database schema.
25
29
  */
@@ -237,6 +241,48 @@ export class SchemaModule {
237
241
  dropViewNode: DropViewNode.create(viewName),
238
242
  });
239
243
  }
244
+ /**
245
+ * Create a new type.
246
+ *
247
+ * Only some dialects like PostgreSQL have user-defined types.
248
+ *
249
+ * ### Examples
250
+ *
251
+ * ```ts
252
+ * await db.schema
253
+ * .createType('species')
254
+ * .asEnum(['dog', 'cat', 'frog'])
255
+ * .execute()
256
+ * ```
257
+ */
258
+ createType(viewName) {
259
+ return new CreateTypeBuilder({
260
+ queryId: createQueryId(),
261
+ executor: this.#executor,
262
+ createTypeNode: CreateTypeNode.create(viewName),
263
+ });
264
+ }
265
+ /**
266
+ * Drop a type.
267
+ *
268
+ * Only some dialects like PostgreSQL have user-defined types.
269
+ *
270
+ * ### Examples
271
+ *
272
+ * ```ts
273
+ * await db.schema
274
+ * .dropType('species')
275
+ * .ifExists()
276
+ * .execute()
277
+ * ```
278
+ */
279
+ dropType(viewName) {
280
+ return new DropTypeBuilder({
281
+ queryId: createQueryId(),
282
+ executor: this.#executor,
283
+ dropTypeNode: DropTypeNode.create(viewName),
284
+ });
285
+ }
240
286
  /**
241
287
  * Returns a copy of this schema module with the given plugin installed.
242
288
  */
@@ -0,0 +1,7 @@
1
+ export declare class Deferred<T> {
2
+ #private;
3
+ constructor();
4
+ get promise(): Promise<T>;
5
+ resolve: (value: T | PromiseLike<T>) => void;
6
+ reject: (reason?: any) => void;
7
+ }
@@ -0,0 +1,25 @@
1
+ /// <reference types="./deferred.d.ts" />
2
+ export class Deferred {
3
+ #promise;
4
+ #resolve;
5
+ #reject;
6
+ constructor() {
7
+ this.#promise = new Promise((resolve, reject) => {
8
+ this.#reject = reject;
9
+ this.#resolve = resolve;
10
+ });
11
+ }
12
+ get promise() {
13
+ return this.#promise;
14
+ }
15
+ resolve = (value) => {
16
+ if (this.#resolve) {
17
+ this.#resolve(value);
18
+ }
19
+ };
20
+ reject = (reason) => {
21
+ if (this.#reject) {
22
+ this.#reject(reason);
23
+ }
24
+ };
25
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kysely",
3
- "version": "0.19.9",
3
+ "version": "0.19.12",
4
4
  "description": "Type safe SQL query builder",
5
5
  "repository": {
6
6
  "type": "git",
@@ -44,20 +44,23 @@
44
44
  "devDependencies": {
45
45
  "@types/better-sqlite3": "^7.5.0",
46
46
  "@types/chai": "^4.3.1",
47
+ "@types/chai-as-promised": "^7.1.5",
47
48
  "@types/chai-subset": "^1.3.3",
48
49
  "@types/mocha": "^9.1.1",
49
50
  "@types/pg": "^8.6.5",
50
51
  "better-sqlite3": "^7.5.3",
51
52
  "chai": "^4.3.6",
53
+ "chai-as-promised": "^7.1.1",
52
54
  "chai-subset": "^1.6.0",
53
55
  "esbuild": "^0.14.47",
54
56
  "mocha": "^10.0.0",
55
57
  "mysql2": "^2.3.3",
56
58
  "pg": "^8.7.3",
59
+ "pg-cursor": "^2.7.3",
57
60
  "playwright": "^1.22.2",
58
61
  "prettier": "^2.7.1",
59
62
  "tsd": "^0.21.0",
60
- "typedoc": "^0.22.18",
63
+ "typedoc": "^0.23.6",
61
64
  "typescript": "4.7.4"
62
65
  }
63
66
  }