Publish ESM+CJS and harden exports (#469)

Switch to `ts-bridge` so that we can publish this package in both ES
module format and CommonJS module format, and add `exports` to
`package.json` to instruct bundlers which format they should choose.
(Note that this is a breaking change as consumers will no longer be
allowed to import subpaths.) The exports are double-checked with
`@arethetypeswrong/cli` to ensure that they work correctly.

Author: mcmire

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- This package can now be used in ESM environments as well as CommonJS ([#469](https://github.com/MetaMask/smart-transactions-controller/pull/469))
+
+### Changed
+
+- **BREAKING:** Disallow subpath exports ([#469](https://github.com/MetaMask/smart-transactions-controller/pull/469))
+
 ## [18.1.0]
 
 ### Added

jest.config.js

@@ -6,7 +6,7 @@ module.exports = {
   coverageReporters: ['text', 'html'],
   coverageThreshold: {
     global: {
-      branches: 75.52,
+      branches: 74.65,
       functions: 92.5,
       lines: 92.52,
       statements: 92.51,

package.json

@@ -7,22 +7,35 @@
     "url": "https://github.com/MetaMask/smart-transactions-controller.git"
   },
   "license": "SEE LICENSE IN LICENSE",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
   "files": [
-    "dist/"
+    "dist"
   ],
   "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "build:clean": "rm -rf dist && yarn build",
-    "build:link": "yarn build && cd dist && yarn link && rm -rf node_modules && cd ..",
+    "build": "ts-bridge --project tsconfig.build.json --clean",
     "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog",
     "lint:changelog": "auto-changelog validate --prettier",
     "lint:eslint": "eslint . --cache --ext js,ts",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write && yarn lint:changelog",
     "lint:misc": "prettier '**/*.json' '**/*.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "prepack": "./scripts/prepack.sh",
-    "test": "jest",
+    "test": "jest && attw --pack",
     "test:watch": "jest --watchAll"
   },
   "dependencies": {
@@ -42,6 +55,7 @@
     "lodash": "^4.17.21"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
     "@lavamoat/allow-scripts": "^3.2.1",
     "@lavamoat/preinstall-always-fail": "^2.1.0",
     "@metamask/auto-changelog": "^3.1.0",
@@ -53,6 +67,7 @@
     "@metamask/json-rpc-engine": "^10.0.1",
     "@metamask/network-controller": "^24.0.0",
     "@metamask/transaction-controller": "^42.0.0",
+    "@ts-bridge/cli": "^0.6.3",
     "@types/jest": "^26.0.24",
     "@types/lodash": "^4.14.194",
     "@types/node": "^18.19.17",

scripts/prepack.sh

@@ -9,4 +9,4 @@ if [[ -n $SKIP_PREPACK ]]; then
   exit 0
 fi
 
-yarn build:clean
+yarn build

tsconfig.build.json

@@ -2,6 +2,8 @@
   "extends": "./tsconfig.json",
   "compilerOptions": {
     "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
     "inlineSources": true,
     "noEmit": false,
     "outDir": "dist",

tsconfig.json

@@ -5,6 +5,7 @@
     "module": "CommonJS",
     "moduleResolution": "node",
     "noEmit": true,
+    "noErrorTruncation": true,
     "resolveJsonModule": true,
     "skipLibCheck": true,
     "strict": true,