fix: Reland ESM fix (#540)

* fix: use proper dual-packaging

Support CommonJS & ESM. Previously the ESM build (dist/module) is broken - it's
recognized as CommonJS.

For more on dual-packaging: https://nodejs.org/api/packages.html#dual-commonjses-module-packages

* Fix and add smoke tests

---------

Co-authored-by: Bobbie Soedirgo <[email protected]>

package.json

@@ -14,23 +14,27 @@
     "dist",
     "src"
   ],
-  "main": "dist/main/index.js",
-  "module": "dist/module/index.js",
-  "types": "dist/module/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/wrapper.mjs",
+  "exports": {
+    "import": "./dist/esm/wrapper.mjs",
+    "require": "./dist/cjs/index.js"
+  },
+  "types": "dist/cjs/index.d.ts",
   "repository": "supabase/postgrest-js",
   "scripts": {
     "clean": "rimraf dist docs/v2",
-    "format": "prettier --write \"{src,test}/**/*.ts\"",
+    "format": "prettier --write \"{src,test}/**/*.ts\" wrapper.mjs",
     "format:check": "prettier --check \"{src,test}/**/*.ts\"",
     "build": "run-s clean format build:*",
-    "build:main": "tsc -p tsconfig.json",
-    "build:module": "tsc -p tsconfig.module.json",
+    "build:cjs": "tsc -p tsconfig.json",
+    "build:esm": "cpy wrapper.mjs dist/esm/",
     "docs": "typedoc src/index.ts --out docs/v2",
     "docs:json": "typedoc --json docs/v2/spec.json --excludeExternals src/index.ts",
-    "test": "run-s format:check test:types db:clean db:run test:run db:clean",
+    "test": "run-s format:check test:types db:clean db:run test:run db:clean && node test/smoke.cjs && node test/smoke.mjs",
     "test:run": "jest --runInBand",
     "test:update": "run-s db:clean db:run && jest --runInBand --updateSnapshot && run-s db:clean",
-    "test:types": "run-s build:module && tsd --files test/*.test-d.ts",
+    "test:types": "run-s build && tsd --files test/*.test-d.ts",
     "db:clean": "cd test/db && docker-compose down --volumes",
     "db:run": "cd test/db && docker-compose up --detach && wait-for-localhost 3000"
   },
@@ -39,6 +43,7 @@
   },
   "devDependencies": {
     "@types/jest": "^27.5.1",
+    "cpy-cli": "^5.0.0",
     "jest": "^28.1.0",
     "node-abort-controller": "^3.0.1",
     "npm-run-all": "^4.1.5",

src/index.ts

@@ -1,9 +1,10 @@
+// Always update wrapper.mjs when updating this file.
 export { default as PostgrestClient } from './PostgrestClient'
 export { default as PostgrestQueryBuilder } from './PostgrestQueryBuilder'
 export { default as PostgrestFilterBuilder } from './PostgrestFilterBuilder'
 export { default as PostgrestTransformBuilder } from './PostgrestTransformBuilder'
 export { default as PostgrestBuilder } from './PostgrestBuilder'
-export {
+export type {
   PostgrestResponse,
   PostgrestResponseFailure,
   PostgrestResponseSuccess,

test/smoke.cjs

@@ -0,0 +1,10 @@
+// Check that the ESM build works as expected (namely has the same exports as the CJS build when imported via ESM).
+const assert = require("node:assert");
+const postgrestjs = require("@supabase/postgrest-js");
+
+assert(typeof postgrestjs.PostgrestClient === "function");
+assert(typeof postgrestjs.PostgrestQueryBuilder === "function");
+assert(typeof postgrestjs.PostgrestFilterBuilder === "function");
+assert(typeof postgrestjs.PostgrestTransformBuilder === "function");
+assert(typeof postgrestjs.PostgrestBuilder === "function");
+assert(typeof postgrestjs.default === "undefined");

test/smoke.mjs

@@ -0,0 +1,15 @@
+// Check that the ESM build works as expected (namely has the same exports as the CJS build when imported via ESM).
+import assert from "node:assert";
+import * as postgrestjs from "@supabase/postgrest-js";
+
+assert(typeof postgrestjs.PostgrestClient === 'function');
+assert(typeof postgrestjs.PostgrestQueryBuilder === 'function');
+assert(typeof postgrestjs.PostgrestFilterBuilder === 'function');
+assert(typeof postgrestjs.PostgrestTransformBuilder === 'function');
+assert(typeof postgrestjs.PostgrestBuilder === 'function');
+assert(typeof postgrestjs.default === 'object');
+assert(typeof postgrestjs.default.PostgrestClient === 'function');
+assert(typeof postgrestjs.default.PostgrestQueryBuilder === 'function');
+assert(typeof postgrestjs.default.PostgrestFilterBuilder === 'function');
+assert(typeof postgrestjs.default.PostgrestTransformBuilder === 'function');
+assert(typeof postgrestjs.default.PostgrestBuilder === 'function')

tsconfig.json

@@ -4,7 +4,7 @@
     "declaration": true,
     "declarationMap": true,
     "module": "CommonJS",
-    "outDir": "dist/main",
+    "outDir": "dist/cjs",
     "sourceMap": true,
     "target": "ES2017",
 

wrapper.mjs

@@ -0,0 +1,25 @@
+import index from '../cjs/index.js'
+const {
+  PostgrestClient,
+  PostgrestQueryBuilder,
+  PostgrestFilterBuilder,
+  PostgrestTransformBuilder,
+  PostgrestBuilder,
+} = index
+
+export {
+  PostgrestBuilder,
+  PostgrestClient,
+  PostgrestFilterBuilder,
+  PostgrestQueryBuilder,
+  PostgrestTransformBuilder,
+}
+
+// compatibility with CJS output
+export default {
+  PostgrestClient,
+  PostgrestQueryBuilder,
+  PostgrestFilterBuilder,
+  PostgrestTransformBuilder,
+  PostgrestBuilder,
+}