fix: fix esm (#1148)

Author: Shinigami92

.gitignore

@@ -82,6 +82,7 @@ versions.json
 /migrations
 /bin/*.js
 /bin/*.mjs
+/bin/esm
 
 TAGS
 REVISION

bin/node-pg-migrate.ts

@@ -1,13 +1,18 @@
 #!/usr/bin/env node
 
 import type { DotenvConfigOptions } from 'dotenv';
+// Import as node-pg-migrate, so tsup does not self-reference as '../dist'
+// otherwise this could not be imported by esm
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment, @typescript-eslint/prefer-ts-expect-error
+// @ts-ignore: when a clean was made, the types are not present in the first run
+import { default as migrationRunner, Migration } from 'node-pg-migrate';
 import { readFileSync } from 'node:fs';
 import { resolve } from 'node:path';
 import { format } from 'node:util';
 import type { ClientConfig } from 'pg';
-import ConnectionParameters from 'pg/lib/connection-parameters';
+// This needs to be imported with .js extension, otherwise it will fail in esm
+import ConnectionParameters from 'pg/lib/connection-parameters.js';
 import yargs from 'yargs/yargs';
-import { default as migrationRunner, Migration } from '../dist';
 import type { RunnerOption } from '../src';
 import type { FilenameFormat } from '../src/migration';
 
@@ -461,10 +466,16 @@ if (action === 'create') {
           ignorePattern: IGNORE_PATTERN,
         }),
   })
-    .then((migrationPath) => {
-      console.log(format('Created migration -- %s', migrationPath));
-      process.exit(0);
-    })
+    .then(
+      (
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment, @typescript-eslint/prefer-ts-expect-error
+        // @ts-ignore: when a clean was made, the types are not present in the first run
+        migrationPath
+      ) => {
+        console.log(format('Created migration -- %s', migrationPath));
+        process.exit(0);
+      }
+    )
     .catch((error: unknown) => {
       console.error(error);
       process.exit(1);

package.json

@@ -4,7 +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 ./bin/node-pg-migrate.ts --clean false --out-dir ./bin",
+    "build:bin": "tsup-node --config tsup-bin.config.ts",
     "build:clean": "rimraf dist",
     "build:code": "tsup-node",
     "build:types": "tsc --project tsconfig.build.json",
@@ -28,31 +28,29 @@
   },
   "type": "commonjs",
   "main": "dist/index.js",
-  "module": "dist/index.mjs",
+  "module": "dist/esm/index.mjs",
   "types": "dist/index.d.ts",
   "exports": {
     "./dist/*": {
       "types": "./dist/*.d.ts",
       "require": "./dist/*.js",
-      "import": "./dist/*.mjs",
+      "import": "./dist/esm/*.mjs",
       "default": "./dist/*.js"
     },
-    "./bin/node-pg-migrate": {
-      "require": "./bin/node-pg-migrate.js",
-      "import": "./bin/node-pg-migrate.mjs",
-      "default": "./bin/node-pg-migrate.js"
+    "./bin/*": {
+      "require": "./bin/*.js",
+      "import": "./bin/*.mjs",
+      "default": "./bin/*.js"
     },
     ".": {
       "types": "./dist/index.d.ts",
       "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
+      "import": "./dist/esm/index.mjs",
       "default": "./dist/index.js"
     },
     "./*": {
       "types": "./dist/*.d.ts",
-      "require": "./dist/*.js",
-      "import": "./dist/*.mjs",
-      "default": "./dist/*.js"
+      "require": "./dist/*.js"
     },
     "./package.json": "./package.json"
   },
@@ -122,6 +120,7 @@
     "eslint-plugin-prettier": "5.1.3",
     "eslint-plugin-unicorn": "52.0.0",
     "json5": "2.2.3",
+    "node-pg-migrate": "file:.",
     "npm-run-all2": "6.1.2",
     "pg": "8.11.5",
     "prettier": "3.2.5",

pnpm-lock.yaml

@@ -3,14 +3,16 @@
  */
 import { inspect } from 'node:util';
 import type {
+  Client,
   ClientBase,
   ClientConfig,
   QueryArrayConfig,
   QueryArrayResult,
   QueryConfig,
   QueryResult,
 } from 'pg';
-import { Client } from 'pg';
+// This needs to be imported as `*`, otherwise it will fail in esm
+import * as pg from 'pg';
 import type { DB, Logger } from './types';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -54,7 +56,7 @@ function db(
 
   const client: Client = isExternalClient
     ? (connection as Client)
-    : new Client(connection as string | ClientConfig);
+    : new pg.Client(connection as string | ClientConfig);
 
   const beforeCloseListeners: any[] = [];
 

src/db.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+  entry: ['bin/node-pg-migrate.ts'],
+  outDir: 'bin',
+  clean: false,
+  format: ['esm', 'cjs'],
+  target: ['es2020', 'node16'],
+  dts: false,
+  minify: false,
+  sourcemap: false,
+  bundle: false,
+});

tsup-bin.config.ts

@@ -1,13 +1,29 @@
 import { defineConfig } from 'tsup';
 
-export default defineConfig({
-  entry: ['src/**/*.ts'],
-  outDir: 'dist',
-  clean: true,
-  format: ['esm', 'cjs'],
-  target: ['es2020', 'node16'],
-  dts: false,
-  minify: false,
-  splitting: true,
-  bundle: false,
-});
+export default defineConfig([
+  // src esm
+  {
+    entry: ['src/index.ts'],
+    outDir: 'dist/esm',
+    clean: true,
+    format: 'esm',
+    target: ['es2020', 'node16'],
+    dts: false,
+    minify: false,
+    sourcemap: false,
+    bundle: true,
+    outExtension: () => ({ js: '.mjs' }),
+  },
+  // src cjs
+  {
+    entry: ['src/**/*.ts'],
+    outDir: 'dist',
+    clean: false,
+    format: 'cjs',
+    target: ['es2020', 'node16'],
+    dts: false,
+    minify: false,
+    sourcemap: false,
+    bundle: false,
+  },
+]);