Synchronise package with module template (July 2023)

.depcheckrc.json

@@ -0,0 +1,11 @@
+{
+  "ignores": [
+    "@lavamoat/allow-scripts",
+    "@lavamoat/preinstall-always-fail",
+    "@metamask/auto-changelog",
+    "@types/*",
+    "prettier-plugin-packagejson",
+    "ts-node",
+    "typedoc"
+  ]
+}

.eslintrc.js

@@ -19,9 +19,18 @@ module.exports = {
 
     {
       files: ['*.test.ts', '*.test.js'],
-      extends: ['@metamask/eslint-config-jest'],
+      extends: [
+        '@metamask/eslint-config-jest',
+        '@metamask/eslint-config-nodejs',
+      ],
     },
   ],
 
-  ignorePatterns: ['!.eslintrc.js', '!.prettierrc.js', 'dist/', 'docs/'],
+  ignorePatterns: [
+    '!.eslintrc.js',
+    '!.prettierrc.js',
+    'dist/',
+    'docs/',
+    '.yarn/',
+  ],
 };

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+<!--
+Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes:
+
+* What is the current state of things and why does it need to change?
+* What is the solution your changes offer and how does it work?
+
+Are there any issues or other links reviewers should consult to understand this pull request better? For instance:
+
+* Fixes #12345
+* See: #67890
+-->

.github/workflows/build-lint-test.yml

@@ -17,14 +17,14 @@ jobs:
       - name: Install Yarn dependencies
         run: yarn --immutable
 
-  build:
-    name: Build
+  build-source:
+    name: Build source
     runs-on: ubuntu-latest
     needs:
       - prepare
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 19.x]
+        node-version: [16.x, 18.x, 20.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
@@ -33,7 +33,32 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: 'yarn'
       - run: yarn --immutable --immutable-cache
-      - run: yarn build
+      - run: yarn build:source
+      - name: Require clean working directory
+        shell: bash
+        run: |
+          if ! git diff --exit-code; then
+            echo "Working tree dirty at end of job"
+            exit 1
+          fi
+
+  build-types:
+    name: Build types
+    runs-on: ubuntu-latest
+    needs:
+      - prepare
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: yarn --immutable --immutable-cache
+      - run: yarn build:types
       - name: Require clean working directory
         shell: bash
         run: |
@@ -49,7 +74,7 @@ jobs:
       - prepare
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 19.x]
+        node-version: [16.x, 18.x, 20.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
@@ -80,7 +105,7 @@ jobs:
       - prepare
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 19.x]
+        node-version: [16.x, 18.x, 20.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/create-release-pr.yml

@@ -8,7 +8,7 @@ on:
         default: 'main'
         required: true
       release-type:
-        description: 'A SemVer version diff, i.e. major, minor, patch, prerelease etc. Mutually exclusive with "release-version".'
+        description: 'A SemVer version diff, i.e. major, minor, or patch. Mutually exclusive with "release-version".'
         required: false
       release-version:
         description: 'A specific version to bump to. Mutually exclusive with "release-type".'
@@ -33,7 +33,7 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
-      - uses: MetaMask/action-create-release-pr@v1
+      - uses: MetaMask/action-create-release-pr@v2
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.github/workflows/main.yml

@@ -74,3 +74,4 @@ jobs:
     secrets:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       PUBLISH_DOCS_TOKEN: ${{ secrets.PUBLISH_DOCS_TOKEN }}
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

.github/workflows/publish-release.yml

@@ -5,6 +5,8 @@ on:
     secrets:
       NPM_TOKEN:
         required: true
+      SLACK_WEBHOOK_URL:
+        required: true
       PUBLISH_DOCS_TOKEN:
         required: true
 
@@ -21,7 +23,7 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
-      - uses: MetaMask/action-publish-release@v2
+      - uses: MetaMask/action-publish-release@v3
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Install
@@ -52,7 +54,10 @@ jobs:
           key: ${{ github.sha }}
       - name: Dry Run Publish
         # omit npm-token token to perform dry run publish
-        uses: MetaMask/action-npm-publish@v2
+        uses: MetaMask/action-npm-publish@v4
+        with:
+          slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_URL }}
+          subteam: S042S7RE4AE # @metamask-npm-publishers
         env:
           SKIP_PREPACK: true
 

.swcrc.build.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json.schemastore.org/swcrc",
+  "jsc": {
+    "parser": {
+      "syntax": "typescript"
+    },
+    "target": "es2020"
+  },
+  "sourceMaps": true,
+  "exclude": [
+    ".*__fixtures__.*",
+    ".*__mocks__.*",
+    ".*__snapshots__.*",
+    ".*__tests?__.*",
+    ".*\\.test\\.?.*\\.tsx?",
+    ".*\\.d\\.tsx?"
+  ]
+}

.yarn/plugins/@yarnpkg/plugin-allow-scripts.cjs

@@ -3,7 +3,7 @@
 module.exports = {
 name: "@yarnpkg/plugin-allow-scripts",
 factory: function (require) {
-var plugin=(()=>{var a=Object.create,l=Object.defineProperty;var i=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var p=Object.getPrototypeOf,c=Object.prototype.hasOwnProperty;var u=e=>l(e,"__esModule",{value:!0});var f=e=>{if(typeof require!="undefined")return require(e);throw new Error('Dynamic require of "'+e+'" is not supported')};var g=(e,o)=>{for(var r in o)l(e,r,{get:o[r],enumerable:!0})},m=(e,o,r)=>{if(o&&typeof o=="object"||typeof o=="function")for(let t of s(o))!c.call(e,t)&&t!=="default"&&l(e,t,{get:()=>o[t],enumerable:!(r=i(o,t))||r.enumerable});return e},x=e=>m(u(l(e!=null?a(p(e)):{},"default",e&&e.__esModule&&"default"in e?{get:()=>e.default,enumerable:!0}:{value:e,enumerable:!0})),e);var k={};g(k,{default:()=>d});var n=x(f("@yarnpkg/shell")),y={hooks:{afterAllInstalled:async()=>{let e=await(0,n.execute)("yarn run allow-scripts");e!==0&&process.exit(e)}}},d=y;return k;})();
+var plugin=(()=>{var l=Object.defineProperty;var s=Object.getOwnPropertyDescriptor;var a=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var p=(t=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(t,{get:(o,e)=>(typeof require<"u"?require:o)[e]}):t)(function(t){if(typeof require<"u")return require.apply(this,arguments);throw new Error('Dynamic require of "'+t+'" is not supported')});var u=(t,o)=>{for(var e in o)l(t,e,{get:o[e],enumerable:!0})},f=(t,o,e,r)=>{if(o&&typeof o=="object"||typeof o=="function")for(let i of a(o))!c.call(t,i)&&i!==e&&l(t,i,{get:()=>o[i],enumerable:!(r=s(o,i))||r.enumerable});return t};var m=t=>f(l({},"__esModule",{value:!0}),t);var g={};u(g,{default:()=>d});var n=p("@yarnpkg/shell"),x={hooks:{afterAllInstalled:async()=>{let t=await(0,n.execute)("yarn run allow-scripts");t!==0&&process.exit(t)}}},d=x;return m(g);})();
 return plugin;
 }
 };

.yarnrc.yml

@@ -1,5 +1,7 @@
 enableScripts: false
 
+enableTelemetry: 0
+
 logFilters:
   - code: YN0004
     level: discard
@@ -9,5 +11,7 @@ nodeLinker: node-modules
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-allow-scripts.cjs
     spec: "https://raw.githubusercontent.com/LavaMoat/LavaMoat/main/packages/yarn-plugin-allow-scripts/bundles/@yarnpkg/plugin-allow-scripts.js"
+  - path: .yarn/plugins/@yarnpkg/plugin-constraints.cjs
+    spec: "@yarnpkg/plugin-constraints"
 
 yarnPath: .yarn/releases/yarn-3.2.4.cjs

constraints.pro

@@ -0,0 +1,99 @@
+%===============================================================================
+% Utility predicates
+%===============================================================================
+
+% True if RepoName can be unified with the repository name part of RepoUrl, a
+% complete URL for a repository on GitHub. This URL must include the ".git"
+% extension.
+repo_name(RepoUrl, RepoName) :-
+  Prefix = 'https://github.com/MetaMask/',
+  atom_length(Prefix, PrefixLength),
+  Suffix = '.git',
+  atom_length(Suffix, SuffixLength),
+  atom_length(RepoUrl, RepoUrlLength),
+  sub_atom(RepoUrl, 0, PrefixLength, After, Prefix),
+  sub_atom(RepoUrl, Before, SuffixLength, 0, Suffix),
+  Start is RepoUrlLength - After + 1,
+  End is Before + 1,
+  RepoNameLength is End - Start,
+  sub_atom(RepoUrl, PrefixLength, RepoNameLength, SuffixLength, RepoName).
+
+%===============================================================================
+% Constraints
+%===============================================================================
+
+% The package must have a name.
+\+ gen_enforced_field(WorkspaceCwd, 'name', null).
+
+% The package must have a description.
+\+ gen_enforced_field(WorkspaceCwd, 'description', null).
+% The description cannot end with a period.
+gen_enforced_field(WorkspaceCwd, 'description', DescriptionWithoutTrailingPeriod) :-
+  workspace_field(WorkspaceCwd, 'description', Description),
+  atom_length(Description, Length),
+  LengthLessOne is Length - 1,
+  sub_atom(Description, LengthLessOne, 1, 0, LastCharacter),
+  sub_atom(Description, 0, LengthLessOne, 1, DescriptionWithoutPossibleTrailingPeriod),
+  (
+    LastCharacter == '.' ->
+      DescriptionWithoutTrailingPeriod = DescriptionWithoutPossibleTrailingPeriod ;
+      DescriptionWithoutTrailingPeriod = Description
+  ).
+
+% The homepage of the package must match its name (which is in turn based on its
+% workspace directory name).
+gen_enforced_field(WorkspaceCwd, 'homepage', CorrectHomepageUrl) :-
+  workspace_field(WorkspaceCwd, 'repository.url', RepoUrl),
+  repo_name(RepoUrl, RepoName),
+  atomic_list_concat(['https://github.com/MetaMask/', RepoName, '#readme'], CorrectHomepageUrl).
+
+% The bugs URL of the package must point to the Issues page for the repository.
+gen_enforced_field(WorkspaceCwd, 'bugs.url', CorrectBugsUrl) :-
+  \+ workspace_field(WorkspaceCwd, 'private', true),
+  workspace_field(WorkspaceCwd, 'repository.url', RepoUrl),
+  repo_name(RepoUrl, RepoName),
+  atomic_list_concat(['https://github.com/MetaMask/', RepoName, '/issues'], CorrectBugsUrl).
+
+% The package must specify Git as the repository type.
+gen_enforced_field(WorkspaceCwd, 'repository.type', 'git').
+
+% The package must match the URL of a repo within the MetaMask organization.
+gen_enforced_field(WorkspaceCwd, 'repository.url', 'https://github.com/MetaMask/<insert repo name here>.git') :-
+  workspace_field(WorkspaceCwd, 'repository.url', RepoUrl),
+  \+ repo_name(RepoUrl, _).
+
+% The license for the package must be specified.
+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.
+gen_enforced_field(WorkspaceCwd, 'files', ['dist/cjs/**', 'dist/esm/**', 'dist/types/**']).
+
+% If a dependency is listed under "dependencies", it should not be listed under
+% "devDependencies".
+gen_enforced_dependency(WorkspaceCwd, DependencyIdent, null, DependencyType) :-
+  workspace_has_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, 'dependencies'),
+  workspace_has_dependency(WorkspaceCwd, DependencyIdent, DependencyRange, DependencyType),
+  DependencyType == 'devDependencies'.
+
+% The package must specify a minimum Node version of 16.
+gen_enforced_field(WorkspaceCwd, 'engines.node', '>=16.0.0').
+
+% The package is public.
+gen_enforced_field(WorkspaceCwd, 'publishConfig.access', 'public').
+% The package is available on the NPM registry.
+gen_enforced_field(WorkspaceCwd, 'publishConfig.registry', 'https://registry.npmjs.org/').

jest.config.js

@@ -24,8 +24,8 @@ module.exports = {
   // An array of glob patterns indicating a set of files for which coverage information should be collected
   collectCoverageFrom: [
     './src/**/*.ts',
-    '!./src/__fixtures__/**/*',
     '!./src/index.ts',
+    '!./src/__fixtures__/**',
   ],
 
   // The directory where Jest should output its coverage files
@@ -37,18 +37,18 @@ module.exports = {
   // ],
 
   // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: 'v8',
+  coverageProvider: 'babel',
 
   // A list of reporter names that Jest uses when writing coverage reports
   coverageReporters: ['html', 'json-summary', 'text'],
 
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 94.31,
-      functions: 94.11,
-      lines: 97.05,
-      statements: 97.05,
+      branches: 92.64,
+      functions: 94.44,
+      lines: 92.85,
+      statements: 92.85,
     },
   },