0.29.0

.github/workflows/bench.yml

@@ -74,95 +74,52 @@ jobs:
       - name: Run benchmarks
         id: bench
         run: |
-          # Run the benchmark command and capture its exit code
-          pnpm bench:ts > /tmp/benchmark_output.txt 2>&1
+          # Run benchmarks and capture output
+          pnpm bench:ts > /tmp/bench_output.txt 2>&1
           exit_code=$?
 
-          # Process the output
-          summary_output=$(cat /tmp/benchmark_output.txt | grep -v "> " | sed '/./,$!d')
+          # Extract summary (everything from "⏱️" to end of file)
+          summary=$(grep -A999 "⏱️" /tmp/bench_output.txt || echo "✅ ⏱️  No benchmark changes detected.")
 
-          # Set a boolean output indicating if it failed with exit code 1
-          if [ $exit_code -eq 1 ]; then
-            echo "benchmark_failed=true" >> $GITHUB_OUTPUT
+          # Check if there are benchmark changes
+          if echo "$summary" | grep -q "No benchmark changes detected"; then
+            has_changes="false"
           else
-            echo "benchmark_failed=false" >> $GITHUB_OUTPUT
+            has_changes="true"
           fi
 
-          echo "full_summary<<EOF" >> $GITHUB_OUTPUT
-          echo "$summary_output" >> $GITHUB_OUTPUT
+          # Set outputs
+          echo "benchmark_failed=$([ $exit_code -eq 0 ] && echo 'false' || echo 'true')" >> $GITHUB_OUTPUT
+          echo "has_changes=$has_changes" >> $GITHUB_OUTPUT
+          echo "summary<<EOF" >> $GITHUB_OUTPUT
+          echo "$summary" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
 
-      - name: Analyze Results
-        id: analyze
-        run: |
-          full_summary="${{ steps.bench.outputs.full_summary }}"
-
-          # This powerful awk script performs two actions:
-          # 1. It finds blocks missing a Delta line and calculates it.
-          # 2. It filters for all blocks where the final delta is not zero.
-          changed_blocks=$(echo "$full_summary" | awk '
-          BEGIN { RS="" } # Process the input in blocks separated by blank lines
-          {
-            block_text = $0 # Store the original block text
-            is_changed = 0
-
-            # If a block is missing a Delta line, calculate it
-            if ($0 ~ /Baseline:/ && $0 !~ /Delta:/) {
-              # Extract numeric values for Result and Baseline
-              match($0, /Result: ([0-9.]+)/, r)
-              match($0, /Baseline: ([0-9.]+)/, b)
-
-              result_val = r[1]
-              baseline_val = b[1]
-
-              # Calculate the delta, avoiding division by zero
-              if (baseline_val > 0) {
-                delta = ((result_val / baseline_val) - 1) * 100
-                # Append the newly calculated, formatted Delta line to the block
-                block_text = sprintf("%s\n📊 Delta: %+.2f%%", block_text, delta)
-              }
-            }
-
-            # Now, check the (potentially modified) block for a non-zero delta.
-            # This works for both pre-existing deltas and the ones we just calculated.
-            if (block_text ~ /Delta:/ && block_text !~ /Delta: (\+)?0\.00%/) {
-              # Filter out any summary lines that are not part of a benchmark block
-              if (block_text ~ /🏌️/) {
-                print block_text "\n" # Print the complete, changed block
-              }
-            }
-          }')
-
-          if [ -n "$changed_blocks" ]; then
-            echo "has_changes=true" >> $GITHUB_OUTPUT
-            echo "changed_blocks<<EOF" >> $GITHUB_OUTPUT
-            echo "$changed_blocks" >> $GITHUB_OUTPUT
-            echo "EOF" >> $GITHUB_OUTPUT
-          else
-            echo "has_changes=false" >> $GITHUB_OUTPUT
-          fi
-
-      - name: PR Comment on Changes
-        if: steps.analyze.outputs.has_changes == 'true' && github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false
+      - name: Post benchmark results (with changes)
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false && steps.bench.outputs.has_changes == 'true'
         uses: thollander/actions-comment-pull-request@24bffb9b452ba05a4f3f77933840a6a841d1b32b # v3.0.1
         with:
           comment-tag: typescript-benchmarks
           message: |
             <details>
-            <summary>⏱️ <strong>Benchmark changes detected</strong> following ${{ github.event.pull_request.head.sha }}</summary>
+            <summary>⏱️ <strong>TypeScript Benchmark Results</strong></summary>
 
-            The following benchmarks have changed from the baseline:
             ```
-            ${{ steps.analyze.outputs.changed_blocks }}
+            ${{ steps.bench.outputs.summary }}
             ```
             </details>
 
-      - name: PR Comment on No Changes
-        if: steps.analyze.outputs.has_changes == 'false' && github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false
+      - name: Post benchmark results (no changes)
+        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.fork == false && steps.bench.outputs.has_changes == 'false'
         uses: thollander/actions-comment-pull-request@24bffb9b452ba05a4f3f77933840a6a841d1b32b # v3.0.1
         with:
           comment-tag: typescript-benchmarks
-          message: ✅ ⏱️ **No benchmark changes detected** following ${{ github.event.pull_request.head.sha }}.
+          message: |
+            ⏱️ **TypeScript Benchmark Results**
+
+            ```
+            ${{ steps.bench.outputs.summary }}
+            ```
 
       - name: Fail job if benchmark command failed
         if: steps.bench.outputs.benchmark_failed == 'true'

.github/workflows/publish.yml

@@ -29,20 +29,31 @@ jobs:
       - name: verify tag format and branch
         run: |
           # Validate ref_name format before assignment
-          if [[ ! "${{ github.ref_name }}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+          if [[ ! "${{ github.ref_name }}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-rc\.[0-9]+)?$ ]]; then
             echo "Error: tag does not follow semver!"
             exit 1
           fi
 
           TAG="${{ github.ref_name }}"
 
-          # Check if tag points to a commit that exists on master branch
+          # Route stable tags to master/latest, RC tags to next/next
+          if [[ "$TAG" =~ -rc\.[0-9]+$ ]]; then
+            BRANCH=next
+            DIST_TAG=next
+          else
+            BRANCH=master
+            DIST_TAG=latest
+          fi
+
+          # Check if tag points to a commit that exists on the expected branch
           TAG_COMMIT=$(git rev-list -n 1 "$TAG")
-          if ! git merge-base --is-ancestor "$TAG_COMMIT" origin/master; then
-            echo "Error: tag is not based on master branch"
+          if ! git merge-base --is-ancestor "$TAG_COMMIT" "origin/$BRANCH"; then
+            echo "Error: tag is not based on $BRANCH branch"
             exit 1
           fi
 
+          echo "DIST_TAG=$DIST_TAG" >> "$GITHUB_ENV"
+
       - name: Install pnpm
         uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
 
@@ -61,8 +72,8 @@ jobs:
           # Get version from package.json safely (parse as JSON, don't execute)
           PACKAGE_VERSION=$(node -p "JSON.parse(require('node:fs').readFileSync('./package.json', 'utf8')).version")
 
-          # Validate version format: must be MAJOR.MINOR.PATCH
-          if [[ ! "$PACKAGE_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+          # Validate version format: must be MAJOR.MINOR.PATCH or MAJOR.MINOR.PATCH-rc.N
+          if [[ ! "$PACKAGE_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-rc\.[0-9]+)?$ ]]; then
             echo "Error: package.json version does not follow semver!"
             exit 1
           fi
@@ -77,7 +88,7 @@ jobs:
         run: npm i -g npm@^11.5.2 && pnpm i --frozen-lockfile --prefer-offline
 
       - name: Publish
-        run: pnpm publish --no-git-checks # the workflow runs in a detached head state, so git checks fail
+        run: pnpm publish --no-git-checks --tag "$DIST_TAG" # the workflow runs in a detached head state, so git checks fail
 
   jsr:
     needs: npm

.github/workflows/test.yml

@@ -235,13 +235,6 @@ jobs:
       fail-fast: false
       matrix:
         typescript-version: [
-            ~4.6.0, # 28.2.2022 https://devblogs.microsoft.com/typescript/announcing-typescript-4-6/
-            ~4.7.0, # 24.5.2022 https://devblogs.microsoft.com/typescript/announcing-typescript-4-7/
-            ~4.8.0, # 25.8.2022 https://devblogs.microsoft.com/typescript/announcing-typescript-4-8/
-            ~4.9.0, # 15.11.2022 https://devblogs.microsoft.com/typescript/announcing-typescript-4-9/
-            ~5.0.0, # 16.3.2023 https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/
-            ~5.2.0, # 24.8.2023 https://devblogs.microsoft.com/typescript/announcing-typescript-5-1/ https://devblogs.microsoft.com/typescript/announcing-typescript-5-2/
-            ~5.3.0, # 20.11.2023 https://devblogs.microsoft.com/typescript/announcing-typescript-5-3/
             ~5.4.0, # 6.3.2024 https://devblogs.microsoft.com/typescript/announcing-typescript-5-4/
             ~5.8.0, # 28.2.2025 https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/ https://devblogs.microsoft.com/typescript/announcing-typescript-5-6/ https://devblogs.microsoft.com/typescript/announcing-typescript-5-7/ https://devblogs.microsoft.com/typescript/announcing-typescript-5-8/
             ~5.9.0, # 1.8.2025 https://devblogs.microsoft.com/typescript/announcing-typescript-5-9/
@@ -274,17 +267,17 @@ jobs:
         run: |
           TS_VERSION="${{ matrix.typescript-version }}"
           echo "TS_VERSION=$TS_VERSION" >> $GITHUB_ENV
-          TSD_VERSION=$(echo '{"~4.6.0":"0.20.0", "~4.7.0":"0.22.0", "~4.8.0":"0.24.1", "~4.9.0":"0.27.0", "~5.0.0":"0.28.1", "~5.2.0":"0.29.0", "~5.3.0":"0.30.7", "~5.4.0":"0.31.2", "~5.8.0":"0.32.0", "~5.9.0":"0.33.0"}' | jq -r --arg key "$TS_VERSION" '.[$key]')
+          TSD_VERSION=$(echo '{"~5.4.0":"0.31.2", "~5.8.0":"0.32.0", "~5.9.0":"0.33.0"}' | jq -r --arg key "$TS_VERSION" '.[$key]')
           echo "TSD_VERSION=$TSD_VERSION" >> $GITHUB_ENV
 
       - name: Install Typescript (${{ env.TS_VERSION }}) and TSD (${{ env.TSD_VERSION }})
         run: pnpm i -D typescript@${{ env.TS_VERSION }} tsd@${{ env.TSD_VERSION }}
 
-      - name: Exclude non-backward compatible tests
-        run: pnpm script:exclude-test-files-for-backwards-compat
+      - name: Make `tsconfig` backwards compatible
+        run: pnpm script:override-tsconfig-target
 
       - name: Run tests with older TypeScript version
-        run: pnpm test:typings${{ env.TS_VERSION != '~4.6.0' && env.TS_VERSION != '~4.7.0' && ' && pnpm test:node:build' || '' }}
+        run: pnpm test:typings && pnpm test:node:build
 
   jsdocs:
     name: JSDocs

.gitignore

@@ -1,7 +1,10 @@
 dist
 /helpers
+migration.*
+/readonly.*
 /test/browser/bundle.js
 node_modules
 .vscode
 .idea
 tsconfig.tsbuildinfo
+/playground.ts

README.md

@@ -1,7 +1,7 @@
 [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua)
 
 [![NPM Version](https://img.shields.io/npm/v/kysely?style=flat&label=latest)](https://github.com/kysely-org/kysely/releases/latest)
-[![Socket Badge](https://badge.socket.dev/npm/package/kysely/0.28.16)](https://socket.dev/npm/package/kysely/overview/0.28.16)
+[![Socket Badge](https://badge.socket.dev/npm/package/kysely/0.29.0-rc.0)](https://socket.dev/npm/package/kysely/overview/0.29.0-rc.0)
 [![Tests](https://github.com/kysely-org/kysely/actions/workflows/test.yml/badge.svg)](https://github.com/kysely-org/kysely)
 [![License](https://img.shields.io/github/license/kysely-org/kysely?style=flat)](https://github.com/kysely-org/kysely/blob/master/LICENSE)
 [![Issues](https://img.shields.io/github/issues-closed/kysely-org/kysely?logo=github)](https://github.com/kysely-org/kysely/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
@@ -16,10 +16,11 @@
 [![Bluesky](https://img.shields.io/badge/Bluesky-0285FF?style=flat&logo=Bluesky&logoColor=white)](https://bsky.app/profile/kysely.dev)
 
 ###### Get started
-[![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=flat&logo=postgresql&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=postgresql)
-[![MySQL](https://img.shields.io/badge/mysql-4479A1.svg?style=flat&logo=mysql&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=mysql)
-[![MicrosoftSQLServer](https://img.shields.io/badge/Microsoft%20SQL%20Server-CC2927?style=flat&logo=microsoft%20sql%20server&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=mssql)
-[![SQLite](https://img.shields.io/badge/sqlite-%2307405e.svg?style=flat&logo=sqlite&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=sqlite)
+[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-%23316192.svg?style=flat&logo=postgresql&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=postgresql)
+[![MySQL](https://img.shields.io/badge/MySQL-4479A1.svg?style=flat&logo=mysql&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=mysql)
+[![MSSQL](https://img.shields.io/badge/MSSQL-CC2927?style=flat&logo=microsoft%20sql%20server&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=mssql)
+[![SQLite](https://img.shields.io/badge/SQLite-%2307405e.svg?style=flat&logo=sqlite&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=sqlite)
+[![PGlite](https://img.shields.io/badge/PGlite-131517.svg?style=flat&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMDAiIGhlaWdodD0iMTgxIiB2aWV3Qm94PSIwIDAgMzQwIDI3MiIgZmlsbD0ibm9uZSI+CjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNMjg4IDg4LjA1MDdMMjg4IDIxNS45N0MyODggMjIwLjM5MSAyODQuNDEzIDIyMy45NzUgMjc5Ljk5MSAyMjMuOTdMMjQ3Ljk2OCAyMjMuOTMyQzI0My43MzQgMjIzLjkyNyAyNDAuMjcyIDIyMC42MzQgMjM5Ljk5NSAyMTYuNDcxQzIzOS45OTggMjE2LjMxMyAyNDAgMjE2LjE1NSAyNDAgMjE1Ljk5NkwyMzkuOTk5IDE2Ny45OThDMjM5Ljk5OSAxNTQuNzQ0IDIyOS4yMzkgMTQzLjk5OSAyMTUuOTg0IDE0My45OTlDMjAzLjEzOCAxNDMuOTk5IDE5Mi42MzYgMTMzLjkwNiAxOTIgMTIxLjIxN1Y0OC4wMDk1TDI0OC4wMyA0OC4wNTA3QzI3MC4xMDkgNDguMDY2OSAyODggNjUuOTcwOCAyODggODguMDUwN1pNMTI4IDQ3Ljk5ODNMMTI4IDEwNC4wMjNDMTI4IDExNy4yNzcgMTM4Ljc0NSAxMjguMDIzIDE1MiAxMjguMDIzSDE3NkwxNzYgMTI2LjQxNEMxNzYgMTQ0Ljk2MiAxOTEuMDM2IDE1OS45OTggMjA5LjU4NCAxNTkuOTk4QzIxNy41MzMgMTU5Ljk5OCAyMjMuOTc3IDE2Ni40NDIgMjIzLjk3NyAxNzQuMzkxTDIyMy45NzcgMjE1LjkzMkMyMjMuOTc3IDIxNi4xMjMgMjIzLjk4IDIxNi4zMTMgMjIzLjk4NCAyMTYuNTAzQzIyMy43MjIgMjIwLjY4NSAyMjAuMjQ3IDIyMy45OTYgMjE1Ljk5OSAyMjMuOTk2TDE3NS43MjYgMjIzLjk5NEwxNzYgMTY4LjAzNEMxNzYuMDIyIDE2My42MTYgMTcyLjQ1NyAxNjAuMDE3IDE2OC4wMzkgMTU5Ljk5NUMxNjMuNjIxIDE1OS45NzMgMTYwLjAyMiAxNjMuNTM4IDE2MCAxNjcuOTU2TDE1OS43MjYgMjIzLjk1OUwxNTkuNzI2IDIyMy45OTJMMTExLjkgMjIzLjk4OVYxNjcuOTk1QzExMS45IDE2My41NzcgMTA4LjMxOCAxNTkuOTk1IDEwMy45IDE1OS45OTVDOTkuNDgxNiAxNTkuOTk1IDk1Ljg5OTkgMTYzLjU3NyA5NS44OTk5IDE2Ny45OTVWMjIzLjk4OEw1NS45OTk1IDIyMy45ODZDNTEuNTgxNCAyMjMuOTg1IDQ4IDIyMC40MDQgNDggMjE1Ljk4NlY4Ny45OThDNDggNjUuOTA2NiA2NS45MDg3IDQ3Ljk5NzkgODguMDAwMiA0Ny45OThMMTI4IDQ3Ljk5ODNaTTI1Mi4wNCA5Ni4yMTUzQzI1Mi4wNCA4OS41ODc5IDI0Ni42NjcgODQuMjE1MyAyNDAuMDQgODQuMjE1M0MyMzMuNDEyIDg0LjIxNTMgMjI4LjA0IDg5LjU4NzkgMjI4LjA0IDk2LjIxNTNDMjI4LjA0IDEwMi44NDMgMjMzLjQxMiAxMDguMjE1IDI0MC4wNCAxMDguMjE1QzI0Ni42NjcgMTA4LjIxNSAyNTIuMDQgMTAyLjg0MyAyNTIuMDQgOTYuMjE1M1oiIGZpbGw9IiNGNkY5NUMiLz48L3N2Zz4=)](https://kysely.dev/docs/getting-started?dialect=pglite)
 & more!
 
 # [Kysely](https://kysely.dev)

deno.check.d.ts

@@ -7,7 +7,7 @@ import type {
   Selectable,
   SqlBool,
   Updateable,
-} from './dist/esm'
+} from './dist'
 
 export interface Database {
   audit: AuditTable

deno.check.json

@@ -4,12 +4,15 @@
     "types": ["./deno.check.d.ts"]
   },
   "imports": {
+    "@electric-sql/pglite": "npm:@electric-sql/pglite",
     "better-sqlite3": "npm:better-sqlite3",
-    "kysely": "./dist/esm",
-    "kysely/helpers/mssql": "./dist/esm/helpers/mssql.js",
-    "kysely/helpers/mysql": "./dist/esm/helpers/mysql.js",
-    "kysely/helpers/postgres": "./dist/esm/helpers/postgres.js",
-    "kysely/helpers/sqlite": "./dist/esm/helpers/sqlite.js",
+    "kysely": "./dist",
+    "kysely/helpers/mssql": "./dist/helpers/mssql.js",
+    "kysely/helpers/mysql": "./dist/helpers/mysql.js",
+    "kysely/helpers/postgres": "./dist/helpers/postgres.js",
+    "kysely/helpers/sqlite": "./dist/helpers/sqlite.js",
+    "kysely/migration": "./dist/migration",
+    "kysely/readonly": "./dist/readonly",
     "lodash/snakeCase": "npm:lodash/snakeCase",
     "mysql2": "npm:mysql2",
     "pg": "npm:pg",

jsr.json

@@ -1,14 +1,16 @@
 {
   "$schema": "https://jsr.io/schema/config-file.v1.json",
   "name": "@kysely/kysely",
-  "version": "0.28.16",
+  "version": "0.29.0-rc.0",
   "license": "MIT",
   "exports": {
     ".": "./src/index.ts",
     "./helpers/mysql": "./src/helpers/mysql.ts",
     "./helpers/mssql": "./src/helpers/mssql.ts",
     "./helpers/postgres": "./src/helpers/postgres.ts",
-    "./helpers/sqlite": "./src/helpers/sqlite.ts"
+    "./helpers/sqlite": "./src/helpers/sqlite.ts",
+    "./migration": "./src/migration/index.ts",
+    "./readonly": "./src/readonly/index.ts"
   },
   "publish": {
     "include": [

outdated-typescript.d.ts

@@ -1,5 +1,5 @@
-import type { KyselyTypeError } from './dist/cjs/util/type-error'
+import type { KyselyTypeError } from './dist/util/type-error'
 
-declare const Kysely: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 4.6 or newer.'>
-declare const RawBuilder: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 4.6 or newer.'>
-declare const sql: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 4.6 or newer.'>
+declare const Kysely: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 5.4 or newer.'>
+declare const RawBuilder: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 5.4 or newer.'>
+declare const sql: KyselyTypeError<'The installed TypeScript version is outdated and cannot guarantee type-safety with Kysely. Please upgrade to version 5.4 or newer.'>