add ReadonlyKysely<DB> helper. (#218)

Author: igalklebanov

.gitignore

@@ -1,6 +1,7 @@
 dist
 /helpers
 migration.*
+/readonly.*
 /test/browser/bundle.js
 node_modules
 .vscode

deno.check.json

@@ -12,6 +12,7 @@
     "kysely/helpers/postgres": "./dist/esm/helpers/postgres.js",
     "kysely/helpers/sqlite": "./dist/esm/helpers/sqlite.js",
     "kysely/migration": "./dist/esm/migration",
+    "kysely/readonly": "./dist/esm/readonly",
     "lodash/snakeCase": "npm:lodash/snakeCase",
     "mysql2": "npm:mysql2",
     "pg": "npm:pg",

jsr.json

@@ -9,13 +9,10 @@
     "./helpers/mssql": "./src/helpers/mssql.ts",
     "./helpers/postgres": "./src/helpers/postgres.ts",
     "./helpers/sqlite": "./src/helpers/sqlite.ts",
-    "./migration": "./src/migration/index.ts"
+    "./migration": "./src/migration/index.ts",
+    "./readonly": "./src/readonly/index.ts"
   },
   "publish": {
-    "include": [
-      "LICENSE",
-      "README.md",
-      "src/**/*.ts"
-    ]
+    "include": ["LICENSE", "README.md", "src/**/*.ts"]
   }
 }

package.json

@@ -42,7 +42,9 @@
     "helpers",
     "migration.d.ts",
     "migration.js",
-    "outdated-typescript.d.ts"
+    "outdated-typescript.d.ts",
+    "readonly.d.ts",
+    "readonly.js"
   ],
   "exports": {
     ".": {
@@ -75,6 +77,11 @@
       "import": "./dist/esm/migration/index.js",
       "require": "./dist/cjs/migration/index.js",
       "default": "./dist/cjs/migration/index.js"
+    },
+    "./readonly": {
+      "import": "./dist/esm/readonly/index.js",
+      "require": "./dist/cjs/readonly/index.js",
+      "default": "./dist/cjs/readonly/index.js"
     }
   },
   "sideEffects": false,

scripts/module-fixup.cjs

@@ -9,7 +9,7 @@
 
 const fs = require('fs')
 const path = require('path')
-const package = require('../package.json')
+const packageJSON = require('../package.json')
 
 const ROOT_PATH = path.join(__dirname, '..')
 const DIST_PATH = path.join(ROOT_PATH, 'dist')
@@ -24,15 +24,15 @@ for (const [folder, type] of [
   )
 }
 
-for (const ex of Object.keys(package.exports)) {
+for (const ex of Object.keys(packageJSON.exports)) {
   if (ex === '.') {
     continue
   }
 
   const [, ...folders] = ex.split('/')
   const fileName = folders.pop()
 
-  const [, ...targetFolders] = package.exports[ex].require.split('/')
+  const [, ...targetFolders] = packageJSON.exports[ex].require.split('/')
   const targetFileName = targetFolders.pop()
   const target = path.posix.relative(
     path.posix.join(ROOT_PATH, ...folders),
@@ -45,11 +45,11 @@ for (const ex of Object.keys(package.exports)) {
 
   fs.writeFileSync(
     path.join(ROOT_PATH, ...folders, fileName + '.js'),
-    `module.exports = require('${target}')`,
+    `module.exports = require('./${target}')`,
   )
 
   fs.writeFileSync(
     path.join(ROOT_PATH, ...folders, fileName + '.d.ts'),
-    `export * from '${target}'`,
+    `export * from './${target}'`,
   )
 }

src/dialect/mysql/mysql-driver.ts

@@ -238,19 +238,18 @@ class MysqlConnection implements DatabaseConnection {
           rows: [row],
         }
       }
-    } catch (ex) {
+    } catch (error: unknown) {
       if (
-        ex &&
-        typeof ex === 'object' &&
-        'code' in ex &&
+        isObject(error) &&
+        'code' in error &&
         // @ts-ignore
-        ex.code === 'ERR_STREAM_PREMATURE_CLOSE'
+        error.code === 'ERR_STREAM_PREMATURE_CLOSE'
       ) {
         // Most likely because of https://github.com/mysqljs/mysql/blob/master/lib/protocol/sequences/Query.js#L220
         return
       }
 
-      throw ex
+      throw error
     }
   }
 

src/index.ts

@@ -15,11 +15,11 @@ export {
 } from './expression/expression-builder.js'
 export * from './expression/expression-wrapper.js'
 
-export * from './query-builder/where-interface.js'
-export * from './query-builder/returning-interface.js'
-export * from './query-builder/output-interface.js'
-export * from './query-builder/having-interface.js'
-export * from './query-builder/order-by-interface.js'
+export type * from './query-builder/where-interface.js'
+export type * from './query-builder/returning-interface.js'
+export type * from './query-builder/output-interface.js'
+export type * from './query-builder/having-interface.js'
+export type * from './query-builder/order-by-interface.js'
 export * from './query-builder/select-query-builder.js'
 export * from './query-builder/insert-query-builder.js'
 export * from './query-builder/update-query-builder.js'
@@ -41,10 +41,10 @@ export * from './query-builder/order-by-item-builder.js'
 export * from './raw-builder/raw-builder.js'
 export * from './raw-builder/sql.js'
 
-export * from './query-executor/query-executor.js'
+export type * from './query-executor/query-executor.js'
 export * from './query-executor/default-query-executor.js'
 export * from './query-executor/noop-query-executor.js'
-export * from './query-executor/query-executor-provider.js'
+export type * from './query-executor/query-executor-provider.js'
 
 export * from './query-compiler/default-query-compiler.js'
 export * from './query-compiler/compiled-query.js'
@@ -71,40 +71,40 @@ export * from './dynamic/dynamic-reference-builder.js'
 export * from './dynamic/dynamic-table-builder.js'
 
 export * from './driver/driver.js'
-export * from './driver/database-connection.js'
-export * from './driver/connection-provider.js'
+export type * from './driver/database-connection.js'
+export type * from './driver/connection-provider.js'
 export * from './driver/default-connection-provider.js'
 export * from './driver/single-connection-provider.js'
 export * from './driver/dummy-driver.js'
 
-export * from './dialect/dialect.js'
-export * from './dialect/dialect-adapter.js'
+export type * from './dialect/dialect.js'
+export type * from './dialect/dialect-adapter.js'
 export * from './dialect/dialect-adapter-base.js'
-export * from './dialect/database-introspector.js'
+export type * from './dialect/database-introspector.js'
 
 export * from './dialect/sqlite/sqlite-dialect.js'
-export * from './dialect/sqlite/sqlite-dialect-config.js'
+export type * from './dialect/sqlite/sqlite-dialect-config.js'
 export * from './dialect/sqlite/sqlite-driver.js'
 export * from './dialect/sqlite/sqlite-query-compiler.js'
 export * from './dialect/sqlite/sqlite-introspector.js'
 export * from './dialect/sqlite/sqlite-adapter.js'
 
 export * from './dialect/mysql/mysql-dialect.js'
-export * from './dialect/mysql/mysql-dialect-config.js'
+export type * from './dialect/mysql/mysql-dialect-config.js'
 export * from './dialect/mysql/mysql-driver.js'
 export * from './dialect/mysql/mysql-query-compiler.js'
 export * from './dialect/mysql/mysql-introspector.js'
 export * from './dialect/mysql/mysql-adapter.js'
 
 export * from './dialect/postgres/postgres-driver.js'
-export * from './dialect/postgres/postgres-dialect-config.js'
+export type * from './dialect/postgres/postgres-dialect-config.js'
 export * from './dialect/postgres/postgres-dialect.js'
 export * from './dialect/postgres/postgres-query-compiler.js'
 export * from './dialect/postgres/postgres-introspector.js'
 export * from './dialect/postgres/postgres-adapter.js'
 
 export * from './dialect/mssql/mssql-adapter.js'
-export * from './dialect/mssql/mssql-dialect-config.js'
+export type * from './dialect/mssql/mssql-dialect-config.js'
 export * from './dialect/mssql/mssql-dialect.js'
 export * from './dialect/mssql/mssql-driver.js'
 export * from './dialect/mssql/mssql-introspector.js'
@@ -113,12 +113,12 @@ export * from './dialect/mssql/mssql-query-compiler.js'
 export * from './dialect/pglite/pglite-adapter.js'
 export * from './dialect/pglite/pglite-driver.js'
 export * from './dialect/pglite/pglite-dialect.js'
-export * from './dialect/pglite/pglite-dialect-config.js'
+export type * from './dialect/pglite/pglite-dialect-config.js'
 
 export * from './query-compiler/default-query-compiler.js'
-export * from './query-compiler/query-compiler.js'
+export type * from './query-compiler/query-compiler.js'
 
-export * from './plugin/kysely-plugin.js'
+export type * from './plugin/kysely-plugin.js'
 export * from './plugin/camel-case/camel-case-plugin.js'
 export * from './plugin/deduplicate-joins/deduplicate-joins-plugin.js'
 export * from './plugin/with-schema/with-schema-plugin.js'
@@ -191,7 +191,10 @@ export * from './operation-node/on-node.js'
 export * from './operation-node/operation-node-source.js'
 export * from './operation-node/operation-node-transformer.js'
 export * from './operation-node/operation-node-visitor.js'
-export * from './operation-node/operation-node.js'
+export type {
+  OperationNode,
+  OperationNodeKind,
+} from './operation-node/operation-node.js'
 export * from './operation-node/operator-node.js'
 export * from './operation-node/or-action-node.js'
 export * from './operation-node/or-node.js'
@@ -211,6 +214,7 @@ export * from './operation-node/references-node.js'
 export * from './operation-node/rename-column-node.js'
 export * from './operation-node/rename-constraint-node.js'
 export * from './operation-node/returning-node.js'
+export type { RootOperationNode } from './operation-node/root-operation-node.js'
 export * from './operation-node/schemable-identifier-node.js'
 export * from './operation-node/select-all-node.js'
 export * from './operation-node/select-modifier-node.js'
@@ -232,10 +236,10 @@ export * from './operation-node/when-node.js'
 export * from './operation-node/where-node.js'
 export * from './operation-node/with-node.js'
 
-export * from './util/column-type.js'
+export type * from './util/column-type.js'
 export * from './util/compilable.js'
-export * from './util/explainable.js'
-export * from './util/streamable.js'
+export type * from './util/explainable.js'
+export type * from './util/streamable.js'
 export * from './util/log.js'
 export type {
   AnyAliasedColumn,
@@ -260,7 +264,7 @@ export type {
   StringsWhenDataTypeNotAvailable,
   UnknownRow,
 } from './util/type-utils.js'
-export * from './util/infer-result.js'
+export type * from './util/infer-result.js'
 export { logOnce } from './util/log-once.js'
 export { createQueryId, type QueryId } from './util/query-id.js'
 export type { KyselyTypeError } from './util/type-error.js'