fix: switches moduleResolution to Bundler and build .d.ts files with tsup (#1437)

Co-authored-by: Shinigami <chrissi92@hotmail.de>

Author: benkroeger

.github/workflows/ci.yml

@@ -93,12 +93,8 @@ jobs:
       - name: Install deps
         run: pnpm install
 
-      - name: Build types
-        run: pnpm run build:types
-
-      # Needed to ensure that the types after build:types are referenceable
-      - name: Run a second install
-        run: pnpm install
+      - name: Build code (that includes types)
+        run: pnpm run build
 
       - name: Check scripts
         run: pnpm run ts-check

bin/node-pg-migrate.ts

@@ -16,7 +16,9 @@ import { cwd } from 'node:process';
 import { pathToFileURL } from 'node:url';
 import { format } from 'node:util';
 import type { ClientConfig } from 'pg';
-// This needs to be imported with .js extension, otherwise it will fail in esm
+import type ConnectionParametersType from 'pg/lib/connection-parameters';
+// TODO causes tests to fail when `.js` is removed
+// @ts-expect-error type exports from @types/pg doesn't match importing
 import ConnectionParameters from 'pg/lib/connection-parameters.js';
 import yargs from 'yargs/yargs';
 import type { RunnerOption } from '../src';
@@ -274,8 +276,11 @@ if (dotenv) {
 
 let MIGRATIONS_DIR = argv[migrationsDirArg];
 let USE_GLOB = argv[useGlobArg];
-let DB_CONNECTION: string | ConnectionParameters | ClientConfig | undefined =
-  process.env[argv[databaseUrlVarArg]];
+let DB_CONNECTION:
+  | string
+  | ConnectionParametersType
+  | ClientConfig
+  | undefined = process.env[argv[databaseUrlVarArg]];
 let IGNORE_PATTERN = argv[ignorePatternArg];
 let SCHEMA: string | string[] | undefined = argv[schemaArg];
 let CREATE_SCHEMA = argv[createSchemaArg];
@@ -436,7 +441,7 @@ function readJson(json: unknown): void {
       DB_CONNECTION,
       databaseUrlVarArg,
       json,
-      (val): val is string | ConnectionParameters | ClientConfig =>
+      (val): val is string | ConnectionParametersType | ClientConfig =>
         typeof val === 'string' || typeof val === 'object'
     );
     tsconfigPath = applyIf(tsconfigPath, tsconfigArg, json, isString);
@@ -456,7 +461,7 @@ function readJson(json: unknown): void {
       };
     }
   } else {
-    DB_CONNECTION ??= json as string | ConnectionParameters | ClientConfig;
+    DB_CONNECTION ??= json as string | ConnectionParametersType | ClientConfig;
   }
 }
 
@@ -484,8 +489,7 @@ if (configFileName) {
 await readTsconfig();
 
 if (useTsx) {
-  const tsx =
-    await tryImport<typeof import('tsx/dist/esm/api/index.mjs')>('tsx/esm');
+  const tsx = await tryImport<typeof import('tsx/esm/api')>('tsx/esm');
   if (!tsx) {
     console.error("For TSX support, please install 'tsx' module");
   }

package.json

@@ -4,11 +4,7 @@
   "description": "PostgreSQL database migration management tool for node.js",
   "scripts": {
     "clean": "rimraf .eslintcache dist pnpm-lock.yaml node_modules",
-    "build:bin": "tsup-node --config tsup-bin.config.ts",
-    "build:clean": "rimraf dist",
-    "build:code": "tsup-node",
-    "build:types": "tsc --project tsconfig.build.json",
-    "build": "run-s build:clean build:code build:types build:bin",
+    "build": "tsup-node",
     "format": "prettier --cache --write .",
     "lint": "eslint --cache --cache-strategy content .",
     "ts-check": "tsc",
@@ -18,7 +14,7 @@
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs",
-    "premigrate": "run-s build:bin",
+    "premigrate": "pnpm run build",
     "migrate": "node bin/node-pg-migrate.js",
     "prepublishOnly": "pnpm run clean && pnpm install && pnpm run build",
     "preflight": "pnpm install && run-s format build lint test:update-snapshots ts-check"
@@ -64,12 +60,12 @@
       "default": "./bin/*.js"
     },
     ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
+      "types": "./dist/bundle/index.d.ts",
+      "default": "./dist/bundle/index.js"
     },
     "./*": {
-      "types": "./dist/*.d.ts",
-      "default": "./dist/*.js"
+      "types": "./dist/legacy/*.d.ts",
+      "default": "./dist/legacy/*.js"
     },
     "./package.json": "./package.json"
   },
@@ -104,6 +100,7 @@
     "cross-env": "7.0.3",
     "dotenv": "16.5.0",
     "dotenv-expand": "12.0.2",
+    "esbuild-fix-imports-plugin": "1.0.21",
     "eslint": "9.28.0",
     "eslint-config-prettier": "10.1.5",
     "eslint-gitignore": "0.1.0",

pnpm-lock.yaml

@@ -265,5 +265,5 @@ export type {
 export { PgType } from './pgType';
 export { PG_MIGRATE_LOCK_ID, runner } from './runner';
 export type { RunnerOption } from './runner';
-export { PgLiteral, isPgLiteral } from './utils';
+export { PgLiteral, escapeValue, isPgLiteral } from './utils';
 export type { PgLiteralValue } from './utils';

src/index.ts

@@ -255,6 +255,7 @@ export class Migration implements RunMigration {
         : join(
             import.meta.dirname,
             '..',
+            '..',
             'templates',
             `migration-template.${await resolveSuffix(directory, options)}`
           );

src/migration.ts

@@ -20,7 +20,16 @@ import * as tables from './operations/tables';
 import * as triggers from './operations/triggers';
 import * as types from './operations/types';
 import * as views from './operations/views';
-import { createSchemalize, PgLiteral } from './utils';
+import { createSchemalize } from './utils';
+/**
+ * Export "PgLiteral" of module "src/utils/PgLiteral.ts" was reexported through module "src/utils/index.ts"
+ * while both modules are dependencies of each other and will end up in different chunks by current Rollup settings.
+ * This scenario is not well supported at the moment as it will produce a circular dependency between chunks
+ * and will likely lead to broken execution order.
+ * Either change the import in "src/migrationBuilder.ts" to point directly to the exporting module
+ * or reconfigure "output.manualChunks" to ensure these modules end up in the same chunk.
+ */
+import { PgLiteral } from './utils/PgLiteral';
 
 /*
  * The migration builder is used to actually create a migration from instructions

src/migrationBuilder.ts

@@ -1,7 +1,7 @@
 import { resolve } from 'node:path';
 import type { Client } from 'pg';
-import type { RunnerOption } from '../../dist';
-import { runner } from '../../dist';
+import type { RunnerOption } from '../../dist/bundle';
+import { runner } from '../../dist/bundle';
 
 type TestOptions = {
   count?: number;

test/ts/customRunner.ts

@@ -1,4 +1,4 @@
-import type { ColumnDefinitions, MigrationBuilder } from '../../../dist';
+import type { ColumnDefinitions, MigrationBuilder } from '../../../dist/bundle';
 
 export const shorthands: ColumnDefinitions | undefined = undefined;
 

test/ts/migrations/1-test-migration.ts

@@ -1,4 +1,4 @@
-import type { ColumnDefinitions, MigrationBuilder } from '../../../dist';
+import type { ColumnDefinitions, MigrationBuilder } from '../../../dist/bundle';
 
 export const shorthands: ColumnDefinitions | undefined = undefined;