kysely 0.28.14 → 0.28.16

package/dist/esm/query-builder/update-query-builder.js

@@ -1,4 +1,5 @@
 /// <reference types="./update-query-builder.d.ts" />
+var _a;
 import { parseJoin, } from '../parser/join-parser.js';
 import { parseTableExpressionOrList, } from '../parser/table-parser.js';
 import { parseSelectArg, parseSelectAll, } from '../parser/select-parser.js';
@@ -19,19 +20,19 @@ export class UpdateQueryBuilder {
         this.#props = freeze(props);
     }
     where(...args) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseValueBinaryOperationOrExpression(args)),
         });
     }
     whereRef(lhs, op, rhs) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithWhere(this.#props.queryNode, parseReferentialBinaryOperation(lhs, op, rhs)),
         });
     }
     clearWhere() {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithoutWhere(this.#props.queryNode),
         });
@@ -76,13 +77,13 @@ export class UpdateQueryBuilder {
      * ```
      */
     top(expression, modifiers) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithTop(this.#props.queryNode, parseTop(expression, modifiers)),
         });
     }
     from(from) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: UpdateQueryNode.cloneWithFromItems(this.#props.queryNode, parseTableExpressionOrList(from)),
         });
@@ -100,19 +101,19 @@ export class UpdateQueryBuilder {
         return this.#join('FullJoin', args);
     }
     #join(joinType, args) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithJoin(this.#props.queryNode, parseJoin(joinType, args)),
         });
     }
     orderBy(...args) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithOrderByItems(this.#props.queryNode, parseOrderBy(args)),
         });
     }
     clearOrderBy() {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithoutOrderBy(this.#props.queryNode),
         });
@@ -139,37 +140,37 @@ export class UpdateQueryBuilder {
      * ```
      */
     limit(limit) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: UpdateQueryNode.cloneWithLimit(this.#props.queryNode, LimitNode.create(parseValueExpression(limit))),
         });
     }
     set(...args) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: UpdateQueryNode.cloneWithUpdates(this.#props.queryNode, parseUpdate(...args)),
         });
     }
     returning(selection) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithReturning(this.#props.queryNode, parseSelectArg(selection)),
         });
     }
     returningAll(table) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithReturning(this.#props.queryNode, parseSelectAll(table)),
         });
     }
     output(args) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithOutput(this.#props.queryNode, parseSelectArg(args)),
         });
     }
     outputAll(table) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithOutput(this.#props.queryNode, parseSelectAll(table)),
         });
@@ -198,7 +199,7 @@ export class UpdateQueryBuilder {
      * ```
      */
     modifyEnd(modifier) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithEndModifier(this.#props.queryNode, modifier.toOperationNode()),
         });
@@ -223,7 +224,7 @@ export class UpdateQueryBuilder {
      * ```
      */
     clearReturning() {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithoutReturning(this.#props.queryNode),
         });
@@ -303,7 +304,7 @@ export class UpdateQueryBuilder {
         if (condition) {
             return func(this);
         }
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
         });
     }
@@ -314,7 +315,7 @@ export class UpdateQueryBuilder {
      * returns a copy of this `UpdateQueryBuilder` with a new output type.
      */
     $castTo() {
-        return new UpdateQueryBuilder(this.#props);
+        return new _a(this.#props);
     }
     /**
      * Narrows (parts of) the output type of the query.
@@ -375,7 +376,7 @@ export class UpdateQueryBuilder {
      * ```
      */
     $narrowType() {
-        return new UpdateQueryBuilder(this.#props);
+        return new _a(this.#props);
     }
     /**
      * Asserts that query's output row type equals the given type `T`.
@@ -432,13 +433,13 @@ export class UpdateQueryBuilder {
      * ```
      */
     $assertType() {
-        return new UpdateQueryBuilder(this.#props);
+        return new _a(this.#props);
     }
     /**
      * Returns a copy of this UpdateQueryBuilder instance with the given plugin installed.
      */
     withPlugin(plugin) {
-        return new UpdateQueryBuilder({
+        return new _a({
             ...this.#props,
             executor: this.#props.executor.withPlugin(plugin),
         });
@@ -501,10 +502,11 @@ export class UpdateQueryBuilder {
         }
     }
     async explain(format, options) {
-        const builder = new UpdateQueryBuilder({
+        const builder = new _a({
             ...this.#props,
             queryNode: QueryNode.cloneWithExplain(this.#props.queryNode, format, options),
         });
         return await builder.execute();
     }
 }
+_a = UpdateQueryBuilder;

package/dist/esm/util/column-type.d.ts

@@ -172,4 +172,58 @@ export type Insertable<R> = DrainOuterGeneric<object & {
 export type Updateable<R> = DrainOuterGeneric<{
     [K in UpdateKeys<R>]?: UpdateType<R[K]>;
 }>;
+/**
+ * Wrap your column type to opt-out from dehydration by {@link ShallowDehydrateValue},
+ * when used by JSON functions, such as the ones used by the relational helpers.
+ *
+ * Why need this?
+ *
+ * An edge case surfaced in issues where a numeric string column type was actually
+ * not a numeric data type column, but text - and thus shouldn't be dehydrated
+ * to `number`.
+ *
+ * Another use case would be, when someone finds a way to keep nested columns hydrated
+ * at runtime, e.g. via a plugin, and wants to prevent dehydration of such columns
+ * at the type level.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * import type { NonDehydrateable } from 'kysely'
+ * import { jsonArrayFrom } from 'kysely/helpers/postgres'
+ *
+ * const result = await db
+ *   .withTables<{
+ *     my_table: {
+ *       a_column: '1' | '2' | '3',
+ *       another_column: NonDehydrateable<'1' | '2' | '3'>,
+ *       column_too: NonDehydrateable<ColumnType<'1' | '2' | '3'>>
+ *     }
+ *   }>()
+ *   .selectFrom('person')
+ *   .select((eb) => [
+ *     'id',
+ *     jsonArrayFrom(
+ *       eb.selectFrom('my_table')
+ *         .select(['a_column', 'another_column', 'column_too'])
+ *     ).as('related')
+ *   ])
+ *   .execute()
+ * ```
+ *
+ * In the example above, "a_column" will be dehydrated to `number`
+ * given it is a numeric string - which is normally a numeric data type column
+ * that gets output as a string by underlying database drivers to avoid
+ * precision loss or overflow.
+ *
+ * "another_column" and "column_too" will remain as `'1' | '2' | '3'`, given they're
+ * wrapped in `NonDehydrateable`, which prevents their dehydration.
+ */
+export type NonDehydrateable<T> = [T] extends [
+    ColumnType<infer S, infer I, infer U>
+] ? ColumnType<S & {
+    __kysely_dehydrate__?: false;
+}, I, U> : T & {
+    __kysely_dehydrate__?: false;
+};
 export {};

package/dist/esm/util/type-utils.d.ts

@@ -183,7 +183,7 @@ export type ShallowDehydrateObject<O> = {
  * For now, we catch anything in {@link StringsWhenDataTypeNotAvailable} and convert it to `string`,
  * and anything in {@link NumbersWhenDataTypeNotAvailable} and convert it to `number`.
  */
-export type ShallowDehydrateValue<T> = T extends null | undefined ? T : T extends (infer U)[] | null | undefined ? Array<ShallowDehydrateValue<U>> | Extract<T, null | undefined> : Exclude<T, StringsWhenDataTypeNotAvailable | NumbersWhenDataTypeNotAvailable> | ([Extract<T, NumbersWhenDataTypeNotAvailable>] extends [never] ? never : number) | ([Extract<T, StringsWhenDataTypeNotAvailable>] extends [never] ? never : string);
+export type ShallowDehydrateValue<T> = T extends null | undefined ? T : '__kysely_dehydrate__' extends keyof NonNullable<T> ? T : T extends (infer U)[] | null | undefined ? Array<ShallowDehydrateValue<U>> | Extract<T, null | undefined> : Exclude<T, StringsWhenDataTypeNotAvailable | NumbersWhenDataTypeNotAvailable> | ([Extract<T, NumbersWhenDataTypeNotAvailable>] extends [never] ? never : number) | ([Extract<T, StringsWhenDataTypeNotAvailable>] extends [never] ? never : string);
 export type StringsWhenDataTypeNotAvailable = Date | Uint8Array;
 export type NumbersWhenDataTypeNotAvailable = bigint | NumericString;
 export type NumericString = `${number}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.28.14",
+  "version": "0.28.16",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",
@@ -27,6 +27,7 @@
   "engines": {
     "node": ">=20.0.0"
   },
+  "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "typesVersions": {
@@ -76,38 +77,38 @@
     "Igal Klebanov <igalklebanov@gmail.com>"
   ],
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.18.2",
-    "@ark/attest": "^0.56.0",
-    "@types/better-sqlite3": "^7.6.13",
-    "@types/chai": "^5.2.3",
-    "@types/chai-as-promised": "^8.0.2",
-    "@types/mocha": "^10.0.10",
-    "@types/node": "^25.5.0",
-    "@types/pg": "^8.18.0",
-    "@types/pg-cursor": "^2.7.2",
-    "@types/semver": "^7.7.1",
-    "@types/sinon": "^21.0.0",
-    "better-sqlite3": "^12.8.0",
-    "chai": "^6.2.2",
-    "chai-as-promised": "^8.0.2",
-    "esbuild": "^0.27.4",
-    "jsr": "^0.14.3",
-    "lodash": "^4.17.23",
-    "mocha": "^11.7.5",
-    "mysql2": "^3.20.0",
-    "pathe": "^2.0.3",
-    "pg": "^8.20.0",
-    "pg-cursor": "^2.19.0",
-    "pkg-types": "^2.3.0",
-    "playwright": "^1.58.2",
-    "prettier": "^3.8.1",
-    "semver": "^7.7.4",
-    "sinon": "^21.0.3",
-    "std-env": "^4.0.0",
-    "tarn": "^3.0.2",
-    "tedious": "^19.2.1",
-    "tsd": "^0.33.0",
-    "typescript": "~5.9.3"
+    "@arethetypeswrong/cli": "0.18.2",
+    "@ark/attest": "0.56.0",
+    "@types/better-sqlite3": "7.6.13",
+    "@types/chai": "5.2.3",
+    "@types/chai-as-promised": "8.0.2",
+    "@types/mocha": "10.0.10",
+    "@types/node": "25.5.2",
+    "@types/pg": "8.20.0",
+    "@types/pg-cursor": "2.7.2",
+    "@types/semver": "7.7.1",
+    "@types/sinon": "21.0.1",
+    "better-sqlite3": "12.8.0",
+    "chai": "6.2.2",
+    "chai-as-promised": "8.0.2",
+    "esbuild": "0.28.0",
+    "jsr": "0.14.3",
+    "lodash": "4.18.1",
+    "mocha": "11.7.5",
+    "mysql2": "3.21.0",
+    "pathe": "2.0.3",
+    "pg": "8.20.0",
+    "pg-cursor": "2.19.0",
+    "pkg-types": "2.3.0",
+    "playwright": "1.59.1",
+    "prettier": "3.8.1",
+    "semver": "7.7.4",
+    "sinon": "21.0.3",
+    "std-env": "4.0.0",
+    "tarn": "3.0.2",
+    "tedious": "19.2.1",
+    "tsd": "0.33.0",
+    "typescript": "6.0.2"
   },
   "scripts": {
     "clean": "rm -rf dist & rm -rf test/node/dist & rm -rf test/browser/bundle.js & rm -rf helpers",
@@ -120,11 +121,11 @@
     "test:browser": "pnpm build && pnpm test:browser:build && node test/browser/test.js",
     "test:bun": "pnpm build && bun link && cd test/bun && bun install && bun run test",
     "test:cloudflare-workers": "pnpm build && pnpm -r test --filter kysely-cloudflare-workers-test",
-    "test:deno": "deno run --allow-env --allow-read --allow-net --no-lock test/deno/local.test.ts && deno run --allow-env --allow-read --allow-net --no-lock test/deno/cdn.test.ts",
+    "test:deno": "deno run --allow-env --allow-read --allow-net --no-lock test/deno/test.ts",
     "test:typings": "tsd test/typings",
-    "test:esmimports": "node scripts/check-esm-imports.js",
+    "test:esmimports": "node scripts/check-esm-imports.cjs",
     "test:esbuild": "esbuild --bundle --platform=node --external:pg-native dist/esm/index.js --outfile=/dev/null",
-    "test:exports": "attw --pack . && node scripts/check-exports.js",
+    "test:exports": "attw --pack . && node scripts/check-exports.cjs",
     "test:jsdocs": "deno check --doc-only --no-lock --unstable-sloppy-imports --config=\"deno.check.json\" ./src",
     "test:outdatedts": "pnpm build && cd test/outdated-ts && pnpm i && pnpm test",
     "lint:deno": "deno lint --config=\"deno.lint.json\" ./src",
@@ -132,11 +133,11 @@
     "build": "pnpm clean && (pnpm build:esm & pnpm build:cjs) && pnpm script:module-fixup && pnpm script:copy-interface-doc",
     "build:esm": "tsc -p tsconfig.json && pnpm script:add-deno-type-references",
     "build:cjs": "tsc -p tsconfig-cjs.json",
-    "script:module-fixup": "node scripts/module-fixup.js",
-    "script:copy-interface-doc": "node scripts/copy-interface-documentation.js",
-    "script:add-deno-type-references": "node scripts/add-deno-type-references.js",
+    "script:module-fixup": "node scripts/module-fixup.cjs",
+    "script:copy-interface-doc": "node scripts/copy-interface-documentation.cjs",
+    "script:add-deno-type-references": "node scripts/add-deno-type-references.cjs",
     "script:align-versions": "node --experimental-strip-types scripts/align-versions.mts",
-    "script:generate-site-examples": "node scripts/generate-site-examples.js",
+    "script:generate-site-examples": "node scripts/generate-site-examples.cjs",
     "script:exclude-test-files-for-backwards-compat": "node --experimental-strip-types scripts/exclude-test-files-for-backwards-compat.mts",
     "script:remove-global-augmentations": "node --experimental-strip-types scripts/remove-global-augmentations.mts",
     "version": "pnpm script:align-versions && git add ."