BREAKING: Synchronise package with module template to fix ESM build (M…

…etaMask#124)

* Synchronise package with module template to fix ESM build

* Dedupe dependencies

constraints.pro

@@ -67,12 +67,17 @@ gen_enforced_field(WorkspaceCwd, 'license').
 
 % The type definitions entrypoint the package must be `./dist/types/index.d.ts`.
 gen_enforced_field(WorkspaceCwd, 'types', './dist/types/index.d.ts').
+gen_enforced_field(WorkspaceCwd, 'exports["."].types', './dist/types/index.d.ts').
 
 % The entrypoint for the package must be `./dist/cjs/index.js`.
 gen_enforced_field(WorkspaceCwd, 'main', './dist/cjs/index.js').
+gen_enforced_field(WorkspaceCwd, 'exports["."].require', './dist/cjs/index.js').
 
 % The module entrypoint for the package must be `./dist/esm/index.js`.
 gen_enforced_field(WorkspaceCwd, 'module', './dist/esm/index.js').
+gen_enforced_field(WorkspaceCwd, 'exports["."].import', './dist/esm/index.js').
+
+gen_enforced_field(WorkspaceCwd, 'exports["./package.json"]', './package.json').
 
 % The list of files included in the package must only include files generated
 % during the build step.

package.json

@@ -11,6 +11,14 @@
     "url": "https://github.com/MetaMask/utils.git"
   },
   "license": "ISC",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./package.json": "./package.json"
+  },
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -24,7 +32,8 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file .swcrc.build.json --config module.type=commonjs",
     "build:clean": "rimraf dist && yarn build",
     "build:docs": "typedoc",
-    "build:esm": "swc src --out-dir dist/esm --config-file .swcrc.build.json --config module.type=es6",
+    "build:esm": "swc src --out-dir dist/esm --config-file .swcrc.build.json --config module.type=es6 && yarn build:esm:package",
+    "build:esm:package": "echo >dist/esm/package.json \"{\\\"type\\\":\\\"module\\\"}\"",
     "build:source": "yarn build:esm && yarn build:cjs",
     "build:types": "tsc --project tsconfig.build.json",
     "lint": "yarn lint:eslint && yarn lint:constraints && yarn lint:misc --check && yarn lint:dependencies --check && yarn lint:changelog",
@@ -55,24 +64,25 @@
     "@lavamoat/allow-scripts": "^2.3.1",
     "@lavamoat/preinstall-always-fail": "^1.0.0",
     "@metamask/auto-changelog": "^3.1.0",
-    "@metamask/eslint-config": "^11.0.1",
-    "@metamask/eslint-config-jest": "^11.0.0",
-    "@metamask/eslint-config-nodejs": "^11.0.1",
-    "@metamask/eslint-config-typescript": "^11.0.0",
+    "@metamask/eslint-config": "^12.0.0",
+    "@metamask/eslint-config-jest": "^12.0.0",
+    "@metamask/eslint-config-nodejs": "^12.0.0",
+    "@metamask/eslint-config-typescript": "^12.0.0",
     "@swc/cli": "^0.1.62",
     "@swc/core": "^1.3.66",
     "@types/jest": "^28.1.7",
     "@types/node": "^17.0.23",
     "@typescript-eslint/eslint-plugin": "^5.43.0",
     "@typescript-eslint/parser": "^5.43.0",
     "depcheck": "^1.4.3",
-    "eslint": "^8.27.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.1.5",
-    "eslint-plugin-jsdoc": "^39.6.2",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint": "^8.44.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.2",
+    "eslint-plugin-jsdoc": "^39.9.1",
+    "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.2.2",
     "jest-it-up": "^2.0.2",
     "prettier": "^2.7.1",

src/assert.ts

@@ -1,4 +1,5 @@
-import { assert as assertSuperstruct, Struct } from 'superstruct';
+import type { Struct } from 'superstruct';
+import { assert as assertSuperstruct } from 'superstruct';
 
 export type AssertionErrorConstructor =
   | (new (args: { message: string }) => Error)
@@ -116,13 +117,13 @@ export function assert(
  * Defaults to {@link AssertionError}.
  * @throws If the value is not valid.
  */
-export function assertStruct<T, S>(
+export function assertStruct<Type, Schema>(
   value: unknown,
-  struct: Struct<T, S>,
+  struct: Struct<Type, Schema>,
   errorPrefix = 'Assertion failed',
   // eslint-disable-next-line @typescript-eslint/naming-convention
   ErrorWrapper: AssertionErrorConstructor = AssertionError,
-): asserts value is T {
+): asserts value is Type {
   try {
     assertSuperstruct(value, struct);
   } catch (error) {

src/base64.test.ts

@@ -1,6 +1,7 @@
 import { is, size, string } from 'superstruct';
 
-import { base64, Base64Options } from './base64';
+import type { Base64Options } from './base64';
+import { base64 } from './base64';
 
 describe('base64', () => {
   it.each([

src/base64.ts

@@ -1,4 +1,5 @@
-import { pattern, Struct } from 'superstruct';
+import type { Struct } from 'superstruct';
+import { pattern } from 'superstruct';
 
 import { assert } from './assert';
 
@@ -26,8 +27,8 @@ export type Base64Options = {
  * @param options - Optional options to specialize base64 validation. See {@link Base64Options} documentation.
  * @returns A superstruct validating base64.
  */
-export const base64 = <T extends string, S>(
-  struct: Struct<T, S>,
+export const base64 = <Type extends string, Schema>(
+  struct: Struct<Type, Schema>,
   options: Base64Options = {},
 ) => {
   const paddingRequired = options.paddingRequired ?? false;

src/bytes.ts

@@ -1,5 +1,6 @@
 import { assert } from './assert';
-import { add0x, assertIsHexString, Hex, remove0x } from './hex';
+import type { Hex } from './hex';
+import { add0x, assertIsHexString, remove0x } from './hex';
 
 // '0'.charCodeAt(0) === 48
 const HEX_MINIMUM_NUMBER_CHARACTER = 48;

src/coercers.ts

@@ -1,8 +1,8 @@
+import type { Infer } from 'superstruct';
 import {
   bigint,
   coerce,
   create,
-  Infer,
   instance,
   number,
   string,
@@ -12,7 +12,8 @@ import {
 
 import { assert } from './assert';
 import { bytesToHex, hexToBytes } from './bytes';
-import { Hex, StrictHexStruct } from './hex';
+import type { Hex } from './hex';
+import { StrictHexStruct } from './hex';
 
 const NumberLikeStruct = union([number(), bigint(), string(), StrictHexStruct]);
 const NumberCoercer = coerce(number(), NumberLikeStruct, Number);

src/hex.test-d.ts

@@ -1,6 +1,6 @@
 import { expectAssignable, expectNotAssignable } from 'tsd';
 
-import { Hex } from '.';
+import type { Hex } from '.';
 
 // Valid hex strings:
 

src/hex.test.ts

@@ -1,5 +1,5 @@
+import type { Hex } from './hex';
 import {
-  Hex,
   add0x,
   assertIsHexString,
   assertIsStrictHexString,

src/hex.ts

@@ -1,5 +1,6 @@
 import { keccak_256 as keccak256 } from '@noble/hashes/sha3';
-import { is, pattern, string, Struct } from 'superstruct';
+import type { Struct } from 'superstruct';
+import { is, pattern, string } from 'superstruct';
 
 import { assert } from './assert';
 import { bytesToHex } from './bytes';

src/json.ts

@@ -1,11 +1,11 @@
+import type { Infer, Struct } from 'superstruct';
 import {
   any,
   array,
   boolean,
   coerce,
   create,
   define,
-  Infer,
   integer,
   is,
   lazy,
@@ -17,12 +17,12 @@ import {
   optional,
   record,
   string,
-  Struct,
   union,
   unknown,
 } from 'superstruct';
 
-import { AssertionErrorConstructor, assertStruct } from './assert';
+import type { AssertionErrorConstructor } from './assert';
+import { assertStruct } from './assert';
 
 /**
  * Any JSON-compatible value.

src/keyring.ts

@@ -1,8 +1,8 @@
 import type { TypedTransaction, TxData } from '@ethereumjs/tx';
 
 import type { Eip1024EncryptedData } from './encryption-types';
-import { Hex } from './hex';
-import { Json } from './json';
+import type { Hex } from './hex';
+import type { Json } from './json';
 
 /**
  * A Keyring class.

src/logging.ts

@@ -1,4 +1,5 @@
-import debug, { Debugger } from 'debug';
+import type { Debugger } from 'debug';
+import debug from 'debug';
 
 const globalLogger = debug('metamask');
 

src/misc.test-d.ts

@@ -1,11 +1,7 @@
 import { expectAssignable, expectNotAssignable, expectType } from 'tsd';
 
-import {
-  isObject,
-  hasProperty,
-  getKnownPropertyNames,
-  RuntimeObject,
-} from './misc';
+import type { RuntimeObject } from './misc';
+import { isObject, hasProperty, getKnownPropertyNames } from './misc';
 
 //=============================================================================
 // isObject

src/misc.test.ts

@@ -1,10 +1,10 @@
+import type { RuntimeObject } from '.';
 import {
   isNonEmptyArray,
   isNullOrUndefined,
   isObject,
   hasProperty,
   getKnownPropertyNames,
-  RuntimeObject,
   isPlainObject,
   calculateNumberSize,
   isASCII,

src/transaction-types.ts

@@ -1,5 +1,5 @@
-import { Bytes } from './bytes';
-import { Hex } from './hex';
+import type { Bytes } from './bytes';
+import type { Hex } from './hex';
 
 export type Transaction =
   | LegacyTransaction

src/versions.test.ts

@@ -1,3 +1,4 @@
+import type { SemVerRange, SemVerVersion } from './versions';
 import {
   assertIsSemVerRange,
   assertIsSemVerVersion,
@@ -6,8 +7,6 @@ import {
   isValidSemVerRange,
   isValidSemVerVersion,
   satisfiesVersionRange,
-  SemVerRange,
-  SemVerVersion,
 } from './versions';
 
 describe('assertIsSemVerVersion', () => {

src/versions.ts

@@ -5,10 +5,11 @@ import {
   valid as validSemVerVersion,
   validRange as validSemVerRange,
 } from 'semver';
-import { is, refine, string, Struct } from 'superstruct';
+import type { Struct } from 'superstruct';
+import { is, refine, string } from 'superstruct';
 
 import { assertStruct } from './assert';
-import { Opaque } from './opaque';
+import type { Opaque } from './opaque';
 
 /**
  * {@link https://codemix.com/opaque-types-in-javascript/ Opaque} type for SemVer ranges.