BREAKING: TS Refactor

.depcheckrc.json

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

.eslintrc.js

@@ -1,13 +1,36 @@
 module.exports = {
   root: true,
-  extends: ['@metamask/eslint-config', '@metamask/eslint-config-commonjs'],
+
+  extends: ['@metamask/eslint-config'],
+
   overrides: [
     {
-      files: ['test/**/*.js'],
+      files: ['*.ts'],
+      extends: ['@metamask/eslint-config-typescript'],
+    },
+
+    {
+      files: ['*.js'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+      extends: ['@metamask/eslint-config-nodejs'],
+    },
+
+    {
+      files: ['*.test.ts', '*.test.js'],
       extends: [
         '@metamask/eslint-config-jest',
         '@metamask/eslint-config-nodejs',
       ],
     },
   ],
+
+  ignorePatterns: [
+    '!.eslintrc.js',
+    '!.prettierrc.js',
+    'dist/',
+    'docs/',
+    '.yarn/',
+  ],
 };

.gitignore

@@ -13,3 +13,6 @@ coverage
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
+
+# distribution
+dist

.yarnrc.yml

@@ -10,6 +10,6 @@ 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"
+    spec: 'https://raw.githubusercontent.com/LavaMoat/LavaMoat/main/packages/yarn-plugin-allow-scripts/bundles/@yarnpkg/plugin-allow-scripts.js'
 
 yarnPath: .yarn/releases/yarn-3.2.4.cjs

declarations.d.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line import/unambiguous
+declare module '@metamask/eth-hd-keyring';
+declare module '@metamask/eth-simple-keyring';
+declare module 'obs-store';

jest.config.js

@@ -2,7 +2,7 @@ module.exports = {
   collectCoverage: true,
   // Ensures that we collect coverage from all source files, not just tested
   // ones.
-  collectCoverageFrom: ['./index.js'],
+  collectCoverageFrom: ['./src/*.ts'],
   coverageReporters: ['text', 'html'],
   coverageThreshold: {
     global: {
@@ -13,6 +13,7 @@ module.exports = {
     },
   },
   moduleFileExtensions: ['js', 'json', 'jsx', 'ts', 'tsx', 'node'],
+  preset: 'ts-jest',
   // "resetMocks" resets all mocks, including mocked modules, to jest.fn(),
   // between each test case.
   resetMocks: true,
@@ -21,6 +22,6 @@ module.exports = {
   // modules.
   restoreMocks: true,
   testEnvironment: 'node',
-  testMatch: ['**/test/index.js'],
+  testRegex: ['\\.test\\.(ts|js)$'],
   testTimeout: 2500,
 };

package.json

@@ -18,31 +18,42 @@
   },
   "license": "ISC",
   "author": "Dan Finlay <[email protected]>",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "index.js"
+    "dist/"
   ],
   "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "build:docs": "typedoc",
     "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "lint:dependencies": "depcheck",
     "lint:eslint": "eslint . --cache --ext js,ts",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' '!.yarnrc.yml' --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "test": "jest"
   },
   "dependencies": {
+    "@ethereumjs/tx": "^4.1.1",
     "@metamask/browser-passworder": "^4.0.2",
     "@metamask/eth-hd-keyring": "^6.0.0",
     "@metamask/eth-sig-util": "5.0.2",
     "@metamask/eth-simple-keyring": "^5.0.0",
+    "@metamask/utils": "5.0.0",
     "obs-store": "^4.0.3"
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^2.1.0",
     "@metamask/auto-changelog": "^3.0.0",
     "@metamask/eslint-config": "^11.1.0",
-    "@metamask/eslint-config-commonjs": "^11.1.0",
     "@metamask/eslint-config-jest": "^11.1.0",
     "@metamask/eslint-config-nodejs": "^11.1.0",
+    "@metamask/eslint-config-typescript": "^11.1.0",
+    "@types/jest": "^29.4.0",
+    "@types/sinon": "^10.0.13",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
+    "depcheck": "^1.4.3",
     "eslint": "^8.29.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
@@ -51,10 +62,14 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.2.1",
     "ethereumjs-wallet": "^1.0.1",
-    "jest": "^27.0.6",
+    "jest": "^29.0.0",
     "prettier": "^2.8.1",
     "prettier-plugin-packagejson": "^2.3.0",
-    "sinon": "^11.1.1"
+    "sinon": "15.0.1",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.7.0",
+    "typedoc": "^0.23.15",
+    "typescript": "~4.8.4"
   },
   "packageManager": "[email protected]",
   "engines": {