feat: typescript esm export map support (#930)

* feat: support TypeScript node module resolution * chore: add changeset * chore: use Node 16 in tests
n1ru4l · Jun 27, 2022 · f585fb3 · f585fb3
1 parent 93239dc
commit f585fb3
Show file tree

Hide file tree

Showing 77 changed files with 1,283 additions and 568 deletions.
diff --git a/.changeset/warm-moles-remember.md b/.changeset/warm-moles-remember.md
@@ -0,0 +1,12 @@
+---
+"@n1ru4l/graphql-live-query": minor
+"@n1ru4l/graphql-live-query-patch": minor
+"@n1ru4l/graphql-live-query-patch-jsondiffpatch": minor
+"@n1ru4l/graphql-live-query-patch-json-patch": minor
+"@n1ru4l/in-memory-live-query-store": minor
+"@n1ru4l/json-patch-plus": minor
+"@n1ru4l/socket-io-graphql-client": minor
+"@n1ru4l/socket-io-graphql-server": minor
+---
+
+Support TypeScript ESM module resolution. More information on https://devblogs.microsoft.com/typescript/announcing-typescript-4-7/#ecmascript-module-support-in-node-js
diff --git a/.github/workflows/ci-todo-example.yml b/.github/workflows/ci-todo-example.yml
@@ -15,13 +15,13 @@ jobs:
           # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
           fetch-depth: 0
 
-      - name: Setup Node.js 14.x
+      - name: Setup Node.js 16.x
         uses: actions/setup-node@master
         with:
-          node-version: 14.x
+          node-version: 16.x
 
       - name: Install Dependencies
-        run: yarn
+        run: yarn install
 
       - name: Build Packages
         run: yarn build

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,10 +15,10 @@ jobs:
           # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
           fetch-depth: 0
 
-      - name: Setup Node.js 14.x
+      - name: Setup Node.js 16.x
         uses: actions/setup-node@master
         with:
-          node-version: 14.x
+          node-version: 16.x
 
       - name: Install Dependencies
         run: yarn
@@ -29,5 +29,5 @@ jobs:
       - name: "Test Packages"
         run: yarn test
 
-      - name: "Test ESM Support"
-        run: node scripts/test-esm.mjs
+      - name: "Test ESM & CJS integrity"
+        run: yarn bob check
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -16,10 +16,10 @@ jobs:
           # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
           fetch-depth: 0
 
-      - name: Setup Node.js 14.x
+      - name: Setup Node.js 16.x
         uses: actions/setup-node@master
         with:
-          node-version: 14.x
+          node-version: 16.x
 
       - name: Install Dependencies
         run: yarn

diff --git a/jest.config.js b/jest.config.js
@@ -11,11 +11,18 @@ module.exports = {
   rootDir: ROOT_DIR,
   restoreMocks: true,
   reporters: ["default"],
-  modulePathIgnorePatterns: ["dist", "test-assets", "test-files", "fixtures"],
+  modulePathIgnorePatterns: [
+    "dist",
+    "test-assets",
+    "test-files",
+    "fixtures",
+    ".bob",
+  ],
   testPathIgnorePatterns: ["packages/todo-example/end2end-tests"],
   moduleNameMapper: pathsToModuleNameMapper(tsconfig.compilerOptions.paths, {
     prefix: `${ROOT_DIR}/`,
   }),
   collectCoverage: false,
   cacheDirectory: resolve(ROOT_DIR, `${CI ? "" : "node_modules/"}.cache/jest`),
+  resolver: "bob-the-bundler/jest-resolver.js",
 };
diff --git a/jest.end2end.config.js b/jest.end2end.config.js
@@ -11,7 +11,13 @@ module.exports = {
   rootDir: ROOT_DIR,
   restoreMocks: true,
   reporters: ["default"],
-  modulePathIgnorePatterns: ["dist", "test-assets", "test-files", "fixtures"],
+  modulePathIgnorePatterns: [
+    "dist",
+    "test-assets",
+    "test-files",
+    "fixtures",
+    ".bob",
+  ],
   testMatch: ["**/packages/todo-example/end2end-tests/**/*.spec.ts"],
   moduleNameMapper: pathsToModuleNameMapper(tsconfig.compilerOptions.paths, {
     prefix: `${ROOT_DIR}/`,
@@ -21,4 +27,5 @@ module.exports = {
     ROOT_DIR,
     `${CI ? "" : "node_modules/"}.cache/jest-end2end`
   ),
+  resolver: "bob-the-bundler/jest-resolver.js",
 };
diff --git a/jest.project.js b/jest.project.js
diff --git a/package.json b/package.json
@@ -16,7 +16,7 @@
     "@changesets/cli": "2.21.1",
     "@types/jest": "27.5.1",
     "babel-jest": "27.5.1",
-    "bob-the-bundler": "1.5.1",
+    "bob-the-bundler": "2.0.0",
     "chalk": "4.1.2",
     "globby": "12.2.0",
     "husky": "7.0.4",
@@ -33,11 +33,10 @@
     "graphql": "16.0.0-experimental-stream-defer.5"
   },
   "scripts": {
-    "build": "yarn ts:transpile && bob build",
-    "watch-build": "tsc-watch --project tsconfig.build.json --onSuccess \"bob build\"",
+    "build": "bob build",
+    "watch-build": "tsc-watch --onSuccess \"bob build\"",
     "test": "jest --no-watchman",
     "test:end2end": "jest --no-watchman --config jest.end2end.config.js",
-    "ts:transpile": "tsc --project tsconfig.build.json",
     "prerelease": "yarn build",
     "release": "changeset publish",
     "postinstall": "patch-package",

diff --git a/packages/graphql-live-query-patch-json-diff/package.json b/packages/graphql-live-query-patch-json-diff/package.json
@@ -30,21 +30,28 @@
   "peerDependencies": {
     "graphql": "^15.4.0 || ^16.0.0"
   },
-  "main": "dist/index.js",
+  "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {
     ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/esm/index.js"
+      "require": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "import": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "default": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
     },
-    "./*": {
-      "require": "./dist/*.js",
-      "import": "./dist/esm/*.js"
-    }
+    "./package.json": "./package.json"
   },
-  "typings": "dist/index.d.ts",
+  "typings": "dist/typings/index.d.ts",
   "typescript": {
-    "definition": "dist/index.d.ts"
+    "definition": "dist/typings/index.d.ts"
   },
   "scripts": {
     "test": "jest",
@@ -56,5 +63,6 @@
   "publishConfig": {
     "directory": "dist",
     "access": "public"
-  }
+  },
+  "type": "module"
 }
diff --git a/packages/graphql-live-query-patch-json-diff/src/applyLiveQueryJSONDiffPatch.spec.ts b/packages/graphql-live-query-patch-json-diff/src/applyLiveQueryJSONDiffPatch.spec.ts
@@ -1,6 +1,6 @@
 import { ExecutionResult } from "graphql";
 import { LiveExecutionResult } from "@n1ru4l/graphql-live-query";
-import { applyLiveQueryJSONDiffPatch } from "./applyLiveQueryJSONDiffPatch";
+import { applyLiveQueryJSONDiffPatch } from "./applyLiveQueryJSONDiffPatch.js";
 
 test("pass through non live query patch result", async () => {
   async function* source() {

diff --git a/packages/graphql-live-query-patch-json-diff/src/applyLiveQueryJSONDiffPatch.ts b/packages/graphql-live-query-patch-json-diff/src/applyLiveQueryJSONDiffPatch.ts
@@ -1,5 +1,5 @@
 import { createApplyLiveQueryPatch } from "@n1ru4l/graphql-live-query-patch";
-import { applyJSONDiffPatch } from "./applyJSONDiffPatch";
+import { applyJSONDiffPatch } from "./applyJSONDiffPatch.js";
 
 export const applyLiveQueryJSONDiffPatch =
   createApplyLiveQueryPatch(applyJSONDiffPatch);
diff --git a/packages/graphql-live-query-patch-json-diff/src/applyLiveQueryJSONDiffPatchGenerator.spec.ts b/packages/graphql-live-query-patch-json-diff/src/applyLiveQueryJSONDiffPatchGenerator.spec.ts
@@ -1,6 +1,6 @@
 import { ExecutionResult } from "graphql";
 import { LiveExecutionResult } from "packages/graphql-live-query/src";
-import { liveQueryJSONDiffPatchGenerator } from "./liveQueryJSONDiffPatchGenerator";
+import { liveQueryJSONDiffPatchGenerator } from "./liveQueryJSONDiffPatchGenerator.js";
 
 it("passes through non live query values", async () => {
   async function* source() {

diff --git a/packages/graphql-live-query-patch-json-diff/src/applyLiveQueryJSONDiffPatchGenerator.ts b/packages/graphql-live-query-patch-json-diff/src/applyLiveQueryJSONDiffPatchGenerator.ts
@@ -1,5 +1,5 @@
 import { createApplyLiveQueryPatchGenerator } from "@n1ru4l/graphql-live-query-patch";
-import { generateJSONDiffPatch } from "./generateJSONDiffPatch";
+import { generateJSONDiffPatch } from "./generateJSONDiffPatch.js";
 
 export const applyLiveQueryJSONDiffPatchGenerator =
   createApplyLiveQueryPatchGenerator(generateJSONDiffPatch);
diff --git a/packages/graphql-live-query-patch-json-diff/src/index.ts b/packages/graphql-live-query-patch-json-diff/src/index.ts
@@ -1,5 +1,5 @@
-export * from "./applyJSONDiffPatch";
-export * from "./applyLiveQueryJSONDiffPatch";
-export * from "./applyLiveQueryJSONDiffPatchGenerator";
-export * from "./generateJSONDiffPatch";
-export * from "./liveQueryJSONDiffPatchGenerator";
+export * from "./applyJSONDiffPatch.js";
+export * from "./applyLiveQueryJSONDiffPatch.js";
+export * from "./applyLiveQueryJSONDiffPatchGenerator.js";
+export * from "./generateJSONDiffPatch.js";
+export * from "./liveQueryJSONDiffPatchGenerator.js";
diff --git a/packages/graphql-live-query-patch-json-diff/src/liveQueryJSONDiffPatchGenerator.ts b/packages/graphql-live-query-patch-json-diff/src/liveQueryJSONDiffPatchGenerator.ts
@@ -1,5 +1,5 @@
 import { createLiveQueryPatchGenerator } from "@n1ru4l/graphql-live-query-patch";
-import { generateJSONDiffPatch } from "./generateJSONDiffPatch";
+import { generateJSONDiffPatch } from "./generateJSONDiffPatch.js";
 
 export const liveQueryJSONDiffPatchGenerator = createLiveQueryPatchGenerator(
   generateJSONDiffPatch

diff --git a/packages/graphql-live-query-patch-json-patch/package.json b/packages/graphql-live-query-patch-json-patch/package.json
@@ -30,21 +30,28 @@
   "peerDependencies": {
     "graphql": "^15.4.0 || ^16.0.0"
   },
-  "main": "dist/index.js",
+  "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "exports": {
     ".": {
-      "require": "./dist/index.js",
-      "import": "./dist/esm/index.js"
+      "require": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "import": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "default": {
+        "types": "./dist/typings/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
     },
-    "./*": {
-      "require": "./dist/*.js",
-      "import": "./dist/esm/*.js"
-    }
+    "./package.json": "./package.json"
   },
-  "typings": "dist/index.d.ts",
+  "typings": "dist/typings/index.d.ts",
   "typescript": {
-    "definition": "dist/index.d.ts"
+    "definition": "dist/typings/index.d.ts"
   },
   "scripts": {
     "test": "jest",
@@ -56,5 +63,6 @@
   "publishConfig": {
     "directory": "dist",
     "access": "public"
-  }
+  },
+  "type": "module"
 }
diff --git a/packages/graphql-live-query-patch-json-patch/src/applyLiveQueryJSONPatch.spec.ts b/packages/graphql-live-query-patch-json-patch/src/applyLiveQueryJSONPatch.spec.ts
@@ -1,6 +1,6 @@
 import { ExecutionResult } from "graphql";
 import { LiveExecutionResult } from "@n1ru4l/graphql-live-query";
-import { applyLiveQueryJSONPatch } from "./applyLiveQueryJSONPatch";
+import { applyLiveQueryJSONPatch } from "./applyLiveQueryJSONPatch.js";
 
 test("pass through non live query patch result", async () => {
   async function* source() {

diff --git a/packages/graphql-live-query-patch-json-patch/src/applyLiveQueryJSONPatch.ts b/packages/graphql-live-query-patch-json-patch/src/applyLiveQueryJSONPatch.ts
@@ -1,5 +1,5 @@
 import { createApplyLiveQueryPatch } from "@n1ru4l/graphql-live-query-patch";
-import { applyJSONPatch } from "./applyJSONPatch";
+import { applyJSONPatch } from "./applyJSONPatch.js";
 
 export const applyLiveQueryJSONPatch =
   createApplyLiveQueryPatch(applyJSONPatch);
diff --git a/packages/graphql-live-query-patch-json-patch/src/applyLiveQueryJSONPatchGenerator.spec.ts b/packages/graphql-live-query-patch-json-patch/src/applyLiveQueryJSONPatchGenerator.spec.ts
@@ -1,6 +1,6 @@
 import { ExecutionResult } from "graphql";
 import { LiveExecutionResult } from "packages/graphql-live-query/src";
-import { liveQueryJSONPatchGenerator } from "./liveQueryJSONPatchGenerator";
+import { liveQueryJSONPatchGenerator } from "./liveQueryJSONPatchGenerator.js";
 
 it("passes through non live query values", async () => {
   async function* source() {

diff --git a/packages/graphql-live-query-patch-json-patch/src/applyLiveQueryJSONPatchGenerator.ts b/packages/graphql-live-query-patch-json-patch/src/applyLiveQueryJSONPatchGenerator.ts
@@ -1,5 +1,5 @@
 import { createApplyLiveQueryPatchGenerator } from "@n1ru4l/graphql-live-query-patch";
-import { generateJSONPatch } from "./generateJSONPatch";
+import { generateJSONPatch } from "./generateJSONPatch.js";
 
 export const applyLiveQueryJSONPatchGenerator =
   createApplyLiveQueryPatchGenerator(generateJSONPatch);
diff --git a/packages/graphql-live-query-patch-json-patch/src/index.ts b/packages/graphql-live-query-patch-json-patch/src/index.ts
@@ -1,5 +1,5 @@
-export * from "./applyJSONPatch";
-export * from "./applyLiveQueryJSONPatch";
-export * from "./applyLiveQueryJSONPatchGenerator";
-export * from "./generateJSONPatch";
-export * from "./liveQueryJSONPatchGenerator";
+export * from "./applyJSONPatch.js";
+export * from "./applyLiveQueryJSONPatch.js";
+export * from "./applyLiveQueryJSONPatchGenerator.js";
+export * from "./generateJSONPatch.js";
+export * from "./liveQueryJSONPatchGenerator.js";
diff --git a/packages/graphql-live-query-patch-json-patch/src/liveQueryJSONPatchGenerator.ts b/packages/graphql-live-query-patch-json-patch/src/liveQueryJSONPatchGenerator.ts
@@ -1,5 +1,5 @@
 import { createLiveQueryPatchGenerator } from "@n1ru4l/graphql-live-query-patch";
-import { generateJSONPatch } from "./generateJSONPatch";
+import { generateJSONPatch } from "./generateJSONPatch.js";
 
 export const liveQueryJSONPatchGenerator =
   createLiveQueryPatchGenerator(generateJSONPatch);