feat: expose migrations from 'kysely/migration'. deprecate migration exports in root. (#1618)

* ...

...

..

* ...

* ...

* ...

* ...

Author: igalklebanov

.gitignore

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

deno.check.json

@@ -11,6 +11,7 @@
     "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/migration": "./dist/esm/migration",
     "lodash/snakeCase": "npm:lodash/snakeCase",
     "mysql2": "npm:mysql2",
     "pg": "npm:pg",

jsr.json

@@ -8,7 +8,8 @@
     "./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"
   },
   "publish": {
     "include": [

package.json

@@ -39,6 +39,8 @@
   "files": [
     "dist",
     "helpers",
+    "migration.d.ts",
+    "migration.js",
     "outdated-typescript.d.ts"
   ],
   "exports": {
@@ -66,6 +68,11 @@
       "import": "./dist/esm/helpers/sqlite.js",
       "require": "./dist/cjs/helpers/sqlite.js",
       "default": "./dist/cjs/helpers/sqlite.js"
+    },
+    "./migration": {
+      "import": "./dist/esm/migration/index.js",
+      "require": "./dist/cjs/migration/index.js",
+      "default": "./dist/cjs/migration/index.js"
     }
   },
   "scripts": {

site/docs/migrations.mdx

@@ -37,6 +37,8 @@ There is also an `allowUnorderedMigrations` option. This option will allow new m
 To allow unordered migrations, pass the `allowUnorderedMigrations` option to Migrator:
 
 ```ts
+import { FileMigrationProvider, Migrator } from 'kysely/migration'
+
 const migrator = new Migrator({
   db,
   provider: new FileMigrationProvider(...),
@@ -140,6 +142,8 @@ For more information, visit https://github.com/kysely-org/kysely-ctl.
 You can then use:
 
 ```ts
+import { Migrator } from 'kysely/migration'
+
 const migrator = new Migrator(migratorConfig)
 await migrator.migrateToLatest()
 ```
@@ -152,12 +156,8 @@ You will probably want to add a simple migration script to your projects like th
 import * as path from 'path'
 import { Pool } from 'pg'
 import { promises as fs } from 'fs'
-import {
-  Kysely,
-  Migrator,
-  PostgresDialect,
-  FileMigrationProvider,
-} from 'kysely'
+import { Kysely, PostgresDialect } from 'kysely'
+import { FileMigrationProvider, Migrator } from 'kysely/migration'
 import { Database } from './types'
 
 async function migrateToLatest() {

src/index.ts

@@ -1,3 +1,5 @@
+import type { KyselyTypeError } from './util/type-error.js'
+
 export * from './kysely.js'
 export * from './query-creator.js'
 
@@ -111,9 +113,6 @@ export * from './dialect/pglite/pglite-dialect-config.js'
 export * from './query-compiler/default-query-compiler.js'
 export * from './query-compiler/query-compiler.js'
 
-export * from './migration/migrator.js'
-export * from './migration/file-migration-provider.js'
-
 export * from './plugin/kysely-plugin.js'
 export * from './plugin/camel-case/camel-case-plugin.js'
 export * from './plugin/deduplicate-joins/deduplicate-joins-plugin.js'
@@ -315,3 +314,89 @@ export type {
   RecursiveCommonTableExpression,
   QueryCreatorWithCommonTableExpression,
 } from './parser/with-parser.js'
+
+// deprecated exports
+
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export declare const DEFAULT_ALLOW_UNORDERED_MIGRATIONS: KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export declare const DEFAULT_MIGRATION_LOCK_TABLE: KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export declare const DEFAULT_MIGRATION_TABLE: KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export declare const MIGRATION_LOCK_ID: KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type MigrateOptions =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type Migration =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type MigrationInfo =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type MigrationProvider =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type MigrationResult =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type MigrationResultSet =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export declare const Migrator: KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type MigratorProps =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export declare const NO_MIGRATIONS: KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type NoMigrations =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export declare const FileMigrationProvider: KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type FileMigrationProviderFS =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type FileMigrationProviderPath =
+  KyselyTypeError<"import from 'kysely/migration' instead">
+/**
+ * @deprecated import from 'kysely/migration' instead.
+ */
+export type FileMigrationProviderProps =
+  KyselyTypeError<"import from 'kysely/migration' instead">

src/migration/index.ts

@@ -0,0 +1,2 @@
+export * from './file-migration-provider.js'
+export * from './migrator.js'

src/migration/migrator.ts

@@ -39,12 +39,8 @@ export interface Migration {
  * import { promises as fs } from 'node:fs'
  * import path from 'node:path'
  * import * as Sqlite from 'better-sqlite3'
- * import {
- *   FileMigrationProvider,
- *   Kysely,
- *   Migrator,
- *   SqliteDialect
- * } from 'kysely'
+ * import { Kysely, SqliteDialect } from 'kysely'
+ * import { FileMigrationProvider, Migrator } from 'kysely/migration'
  *
  * const db = new Kysely<any>({
  *   dialect: new SqliteDialect({
@@ -119,7 +115,7 @@ export class Migrator {
    * import { promises as fs } from 'node:fs'
    * import path from 'node:path'
    * import * as Sqlite from 'better-sqlite3'
-   * import { FileMigrationProvider, Migrator } from 'kysely'
+   * import { FileMigrationProvider, Migrator } from 'kysely/migration'
    *
    * const migrator = new Migrator({
    *   db,
@@ -163,7 +159,7 @@ export class Migrator {
    * ```ts
    * import { promises as fs } from 'node:fs'
    * import path from 'node:path'
-   * import { FileMigrationProvider, Migrator } from 'kysely'
+   * import { FileMigrationProvider, Migrator } from 'kysely/migration'
    *
    * const migrator = new Migrator({
    *   db,
@@ -186,7 +182,7 @@ export class Migrator {
    * ```ts
    * import { promises as fs } from 'node:fs'
    * import path from 'node:path'
-   * import { FileMigrationProvider, Migrator, NO_MIGRATIONS } from 'kysely'
+   * import { FileMigrationProvider, Migrator, NO_MIGRATIONS } from 'kysely/migration'
    *
    * const migrator = new Migrator({
    *   db,
@@ -264,7 +260,7 @@ export class Migrator {
    * ```ts
    * import { promises as fs } from 'node:fs'
    * import path from 'node:path'
-   * import { FileMigrationProvider, Migrator } from 'kysely'
+   * import { FileMigrationProvider, Migrator } from 'kysely/migration'
    *
    * const migrator = new Migrator({
    *   db,
@@ -296,7 +292,7 @@ export class Migrator {
    * ```ts
    * import { promises as fs } from 'node:fs'
    * import path from 'node:path'
-   * import { FileMigrationProvider, Migrator } from 'kysely'
+   * import { FileMigrationProvider, Migrator } from 'kysely/migration'
    *
    * const migrator = new Migrator({
    *   db,

test/node/src/migration.test.ts

@@ -2,6 +2,7 @@ import * as path from 'node:path'
 import { promises as fs } from 'node:fs'
 import { setTimeout } from 'node:timers/promises'
 
+import type { Kysely } from '../../../'
 import {
   FileMigrationProvider,
   type Migration,
@@ -12,8 +13,7 @@ import {
   Migrator,
   NO_MIGRATIONS,
   type MigratorProps,
-  type Kysely,
-} from '../../../'
+} from '../../../dist/cjs/migration'
 
 import {
   clearDatabase,