fix: splitting compile into separate esm and cjs dists (#111)

* fix: splitting compile into separate esm and cjs dists * chore: testing ci * chore: testing ci * refactor: addressing pr comments * chore: addressing pr comments * chore: minor tweaks * refactor: addressing pr comments * chore: minor tweaks
algorandfoundation · Aug 28, 2023 · 8867757 · 8867757
1 parent b24d298
commit 8867757
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 9 deletions.
diff --git a/.prettierrc.js → .prettierrc.cjs b/.prettierrc.js → .prettierrc.cjs
diff --git a/commitlint.config.js → commitlint.config.cjs b/commitlint.config.js → commitlint.config.cjs
diff --git a/package.json b/package.json
@@ -8,16 +8,51 @@
   "engines": {
     "node": ">=16.0"
   },
-  "main": "./index.js",
+  "type": "module",
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "types": "./types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "types/index.d.ts"
+      ],
+      "types/app": [
+        "types/types/app.d.ts"
+      ],
+      "types/app-client": [
+        "types/types/app-client.d.ts"
+      ],
+      "types/app-spec": [
+        "types/types/app-spec.d.ts"
+      ],
+      "types/transaction": [
+        "types/types/transaction.d.ts"
+      ]
+    }
+  },
   "files": [
     "**/*"
   ],
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js"
+    },
+    "./testing": {
+      "import": "./esm/testing/index.js",
+      "require": "./cjs/testing/index.js"
+    },
+    "./index.d.ts": "./types/index.d.ts",
+    "./package.json": "./package.json"
+  },
   "scripts": {
     "build": "run-s build:*",
     "build:0-clean": "rimraf dist coverage",
-    "build:1-compile": "tsc -p tsconfig.build.json",
-    "build:2-copy-pkg-json": "npx --yes @makerx/ts-toolkit@latest copy-package-json",
-    "build:3-copy-readme": "copyfiles README.md dist",
+    "build:1-compile-cjs": "tsc -p tsconfig.cjs.json",
+    "build:2-compile-esm": "tsc -p tsconfig.esm.json",
+    "build:3-copy-pkg-json": "npx --yes @makerx/ts-toolkit@latest copy-package-json --main ./cjs/index.js --types ./types/index.d.ts --custom-sections exports typesVersions module",
+    "build:4-copy-readme": "copyfiles README.md dist",
     "test": "dotenv -e .env -- jest --coverage --passWithNoTests",
     "lint": "eslint ./src/ --ext .ts",
     "lint:fix": "eslint ./src/ --ext .ts --fix",

diff --git a/src/types/app-client.spec.ts b/src/types/app-client.spec.ts
@@ -534,8 +534,8 @@ describe('application-client', () => {
     invariant(result.confirmations)
     invariant(result.confirmations[0])
     expect(result.transactions.length).toBe(1)
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     const returnValue = algokit.getABIReturn(
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       { method: client.getABIMethod('call_abi_foreign_refs')!, methodArgs: [] },
       result.confirmations[0],
     )

diff --git a/tsconfig.build.json b/tsconfig.build.json
diff --git a/tsconfig.cjs.json b/tsconfig.cjs.json
@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/cjs",
+    "target": "esnext",
+    "module": "commonjs",
+    "moduleResolution": "node"
+  },
+  "exclude": ["src/**/*.spec.ts", "tests/**/*.*"]
+}
diff --git a/tsconfig.esm.json b/tsconfig.esm.json
@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/esm",
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "declarationDir": "./dist/types"
+  },
+  "exclude": ["src/**/*.spec.ts", "tests/**/*.*"]
+}