BREAKING: Move all internal types from snaps-types to snaps-utils

packages/examples/examples/browserify/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snaps-monorepo.git"
   },
   "source": {
-    "shasum": "c8hLUTgqFJnm0GgK1XcEW1RbqBxukctXTYqe2av7khk=",
+    "shasum": "lcCxQquYyEkQGnVdLJZTtXoEGI20tENIG9TRTsLwEmI=",
     "location": {
       "npm": {
         "filePath": "dist/snap.js",

packages/examples/examples/browserify/src/snap.ts

@@ -17,7 +17,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({
 }) => {
   switch (request.method) {
     case 'inApp':
-      return snap.request({
+      return await snap.request({
         method: 'snap_notify',
         params: [
           {
@@ -27,7 +27,7 @@ export const onRpcRequest: OnRpcRequestHandler = async ({
         ],
       });
     case 'native':
-      return snap.request({
+      return await snap.request({
         method: 'snap_notify',
         params: [
           {

packages/examples/examples/browserify/tsconfig.json

@@ -3,6 +3,5 @@
   "compilerOptions": {
     "resolveJsonModule": true
   },
-  "files": ["../../../snaps-types/global.d.ts"],
   "include": ["src", "gulpfile.ts", "babel.config.json"]
 }

packages/examples/examples/insights/README.md

@@ -6,9 +6,3 @@ This Snap demonstrates how to use the transaction insights feature.
 
 - Babel is used for transpiling TypeScript to JavaScript, so when building with the CLI,
   `transpilationMode` must be set to `localOnly` (default) or `localAndDeps`.
-- For the global `wallet` type to work, you have to add the following to your `tsconfig.json`:
-  ```json
-  {
-    "files": ["./node_modules/@metamask/snaps-types/global.d.ts"]
-  }
-  ```

packages/examples/examples/insights/tsconfig.json

@@ -3,6 +3,5 @@
   "compilerOptions": {
     "typeRoots": ["../../../../node_modules/@types"]
   },
-  "files": ["../../../snaps-types/global.d.ts"],
   "include": ["src"]
 }

packages/examples/examples/rollup/tsconfig.json

@@ -5,6 +5,5 @@
     "declaration": false,
     "typeRoots": ["../../../../node_modules/@types"]
   },
-  "files": ["../../../snaps-types/global.d.ts"],
   "include": ["src"]
 }

packages/examples/examples/typescript/README.md

@@ -6,9 +6,3 @@ This Snap demonstrates how to develop a Snap with TypeScript.
 
 - Babel is used for transpiling TypeScript to JavaScript, so when building with the CLI,
   `transpilationMode` must be set to `localOnly` (default) or `localAndDeps`.
-- For the global `wallet` type to work, you have to add the following to your `tsconfig.json`:
-  ```json
-  {
-    "files": ["./node_modules/@metamask/snaps-types/global.d.ts"]
-  }
-  ```

packages/examples/examples/typescript/tsconfig.json

@@ -3,6 +3,5 @@
   "compilerOptions": {
     "typeRoots": ["../../../../node_modules/@types"]
   },
-  "files": ["../../../snaps-types/global.d.ts"],
   "include": ["src"]
 }

packages/examples/examples/wasm/tsconfig.json

@@ -5,6 +5,5 @@
     "declaration": false,
     "typeRoots": ["../../../../node_modules/@types"]
   },
-  "files": ["../../../snaps-types/global.d.ts"],
   "include": ["assembly"]
 }

packages/examples/examples/webpack/tsconfig.json

@@ -3,6 +3,5 @@
   "compilerOptions": {
     "typeRoots": ["../../../../node_modules/@types"]
   },
-  "files": ["../../../snaps-types/global.d.ts"],
   "include": ["src", "webpack.config.ts"]
 }

packages/snaps-controllers/package.json

@@ -39,7 +39,6 @@
     "@metamask/post-message-stream": "^6.0.0",
     "@metamask/rpc-methods": "^0.26.2",
     "@metamask/snaps-execution-environments": "^0.26.2",
-    "@metamask/snaps-types": "^0.26.2",
     "@metamask/snaps-utils": "^0.26.2",
     "@metamask/subject-metadata-controller": "^1.0.1",
     "@metamask/utils": "^3.3.1",

packages/snaps-controllers/src/multichain/MultiChainController.ts

@@ -9,8 +9,8 @@ import {
   HasPermission,
   PermissionConstraint,
 } from '@metamask/permission-controller';
-import { SnapKeyring } from '@metamask/snaps-types';
 import {
+  SnapKeyring,
   parseAccountId,
   AccountId,
   parseChainId,

packages/snaps-execution-environments/package.json

@@ -35,7 +35,6 @@
     "@metamask/object-multiplex": "^1.2.0",
     "@metamask/post-message-stream": "^6.0.0",
     "@metamask/providers": "^10.2.0",
-    "@metamask/snaps-types": "^0.26.2",
     "@metamask/snaps-utils": "^0.26.2",
     "@metamask/utils": "^3.3.1",
     "eth-rpc-errors": "^4.0.3",

packages/snaps-execution-environments/src/common/BaseSnapExecutor.ts

@@ -2,8 +2,9 @@
 /// <reference path="../../../../node_modules/ses/index.d.ts" />
 import { StreamProvider } from '@metamask/providers';
 import { RequestArguments } from '@metamask/providers/dist/BaseProvider';
-import { SnapExports, SnapsGlobalObject } from '@metamask/snaps-types';
 import {
+  SnapExports,
+  SnapsGlobalObject,
   HandlerType,
   SnapExportsParameters,
   SNAP_EXPORT_NAMES,

packages/snaps-execution-environments/src/common/endowments/index.ts

@@ -1,5 +1,5 @@
 import { StreamProvider } from '@metamask/providers';
-import { SnapsGlobalObject } from '@metamask/snaps-types';
+import { SnapsGlobalObject } from '@metamask/snaps-utils';
 import { hasProperty } from '@metamask/utils';
 
 import { rootRealmGlobal } from '../globalObject';

packages/snaps-execution-environments/src/common/keyring.ts

@@ -1,4 +1,4 @@
-import { SnapKeyring } from '@metamask/snaps-types';
+import { SnapKeyring } from '@metamask/snaps-utils';
 import {
   assert,
   isValidJson,

packages/snaps-execution-environments/src/common/validation.ts

@@ -1,5 +1,4 @@
-import { SnapKeyring } from '@metamask/snaps-types';
-import { ChainIdStruct, HandlerType } from '@metamask/snaps-utils';
+import { SnapKeyring, ChainIdStruct, HandlerType } from '@metamask/snaps-utils';
 import {
   assertStruct,
   Json,

packages/snaps-types/package.json

@@ -6,24 +6,27 @@
     "type": "git",
     "url": "https://github.com/MetaMask/snaps-monorepo.git"
   },
-  "main": "src/index.d.ts",
-  "types": "src/index.d.ts",
+  "main": "dist/index.d.ts",
+  "types": "dist/index.d.ts",
   "files": [
-    "src",
-    "global.d.ts"
+    "dist"
   ],
   "scripts": {
     "lint:eslint": "eslint . --cache --ext js,ts",
     "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' --ignore-path ../../.gitignore",
     "lint": "yarn lint:eslint && yarn lint:misc --check",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "lint:changelog": "yarn auto-changelog validate",
+    "build:tsc": "tsc --project tsconfig.build.json",
+    "build": "yarn build:tsc",
+    "build:clean": "yarn clean && yarn build",
+    "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
     "publish:package": "../../scripts/publish-package.sh"
   },
   "dependencies": {
     "@metamask/providers": "^10.2.0",
     "@metamask/snaps-utils": "^0.26.2",
-    "@metamask/types": "^1.1.0"
+    "@metamask/utils": "^3.3.1"
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^2.0.3",

packages/snaps-types/global.d.ts → packages/snaps-types/src/global.ts

@@ -1,7 +1,7 @@
 import { MetaMaskInpageProvider } from '@metamask/providers';
-import { SnapsGlobalObject } from './src';
+import { SnapsGlobalObject } from '@metamask/snaps-utils';
 
-// Types that should be available globally within a Snap
+// Types that should be available globally within a snap.
 declare global {
   const ethereum: MetaMaskInpageProvider;
   const snap: SnapsGlobalObject;

packages/snaps-types/src/index.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line import/no-unassigned-import
+import './global';
+
+export * from './types';

packages/snaps-types/src/types.ts

@@ -0,0 +1,22 @@
+import { StreamProvider } from '@metamask/providers';
+
+/**
+ * The type of `window.ethereum`.
+ */
+export type Ethereum = StreamProvider;
+
+// Exported again for convenience.
+export type { Json, JsonRpcRequest } from '@metamask/utils';
+export type {
+  AccountId,
+  ChainId,
+  KeyringEvent,
+  KeyringRequest,
+  OnCronjobHandler,
+  OnRpcRequestHandler,
+  OnTransactionHandler,
+  OnTransactionResponse,
+  RequestArguments,
+  SnapKeyring,
+  SnapsGlobalObject,
+} from '@metamask/snaps-utils';

packages/snaps-types/tsconfig.build.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.packages.build.json",
+  "compilerOptions": {
+    "baseUrl": "./",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "emitDeclarationOnly": true
+  },
+  "include": ["./src"],
+  "references": [
+    {
+      "path": "../snaps-utils/tsconfig.build.json"
+    }
+  ]
+}

packages/snaps-types/tsconfig.json

@@ -3,5 +3,10 @@
   "compilerOptions": {
     "baseUrl": "./"
   },
-  "include": ["./src"]
+  "include": ["./src"],
+  "references": [
+    {
+      "path": "../snaps-utils"
+    }
+  ]
 }

packages/snaps-utils/jest.config.js

@@ -18,10 +18,10 @@ module.exports = deepmerge(baseConfig, {
   ],
   coverageThreshold: {
     global: {
-      branches: 94.6,
-      functions: 98.92,
-      lines: 98.99,
-      statements: 98.99,
+      branches: 94.42,
+      functions: 97.95,
+      lines: 95.11,
+      statements: 95.11,
     },
   },
   testTimeout: 2500,

packages/snaps-utils/package.json

@@ -52,7 +52,7 @@
   "dependencies": {
     "@babel/core": "^7.18.6",
     "@babel/types": "^7.18.7",
-    "@metamask/snaps-types": "^0.26.2",
+    "@metamask/providers": "^10.2.1",
     "@metamask/utils": "^3.3.1",
     "@noble/hashes": "^1.1.3",
     "@scure/base": "^1.1.1",