@metamask/snaps-utils 3.0.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/CHANGELOG.md +15 -1
  2. package/dist/cjs/auxiliary-files.js +40 -0
  3. package/dist/cjs/auxiliary-files.js.map +1 -0
  4. package/dist/cjs/errors.js +353 -3
  5. package/dist/cjs/errors.js.map +1 -1
  6. package/dist/cjs/eval-worker.js +2 -2
  7. package/dist/cjs/eval-worker.js.map +1 -1
  8. package/dist/cjs/handler-types.js +31 -0
  9. package/dist/cjs/handler-types.js.map +1 -0
  10. package/dist/cjs/handlers.js +24 -27
  11. package/dist/cjs/handlers.js.map +1 -1
  12. package/dist/cjs/index.browser.js +2 -0
  13. package/dist/cjs/index.browser.js.map +1 -1
  14. package/dist/cjs/index.executionenv.js +2 -0
  15. package/dist/cjs/index.executionenv.js.map +1 -1
  16. package/dist/cjs/index.js +9 -0
  17. package/dist/cjs/index.js.map +1 -1
  18. package/dist/cjs/manifest/manifest.js +25 -5
  19. package/dist/cjs/manifest/manifest.js.map +1 -1
  20. package/dist/cjs/manifest/validation.js +6 -1
  21. package/dist/cjs/manifest/validation.js.map +1 -1
  22. package/dist/cjs/npm.js +5 -3
  23. package/dist/cjs/npm.js.map +1 -1
  24. package/dist/cjs/snaps.js +3 -2
  25. package/dist/cjs/snaps.js.map +1 -1
  26. package/dist/cjs/types.js +0 -5
  27. package/dist/cjs/types.js.map +1 -1
  28. package/dist/cjs/validation.js.map +1 -1
  29. package/dist/cjs/virtual-file/VirtualFile.js +6 -0
  30. package/dist/cjs/virtual-file/VirtualFile.js.map +1 -1
  31. package/dist/esm/auxiliary-files.js +28 -0
  32. package/dist/esm/auxiliary-files.js.map +1 -0
  33. package/dist/esm/errors.js +350 -1
  34. package/dist/esm/errors.js.map +1 -1
  35. package/dist/esm/eval-worker.js +1 -1
  36. package/dist/esm/eval-worker.js.map +1 -1
  37. package/dist/esm/handler-types.js +13 -0
  38. package/dist/esm/handler-types.js.map +1 -0
  39. package/dist/esm/handlers.js +7 -10
  40. package/dist/esm/handlers.js.map +1 -1
  41. package/dist/esm/index.browser.js +2 -0
  42. package/dist/esm/index.browser.js.map +1 -1
  43. package/dist/esm/index.executionenv.js +2 -0
  44. package/dist/esm/index.executionenv.js.map +1 -1
  45. package/dist/esm/index.js +3 -0
  46. package/dist/esm/index.js.map +1 -1
  47. package/dist/esm/manifest/manifest.js +30 -5
  48. package/dist/esm/manifest/manifest.js.map +1 -1
  49. package/dist/esm/manifest/validation.js +3 -1
  50. package/dist/esm/manifest/validation.js.map +1 -1
  51. package/dist/esm/npm.js +5 -3
  52. package/dist/esm/npm.js.map +1 -1
  53. package/dist/esm/snaps.js +3 -2
  54. package/dist/esm/snaps.js.map +1 -1
  55. package/dist/esm/types.js +0 -2
  56. package/dist/esm/types.js.map +1 -1
  57. package/dist/esm/validation.js.map +1 -1
  58. package/dist/esm/virtual-file/VirtualFile.js +7 -1
  59. package/dist/esm/virtual-file/VirtualFile.js.map +1 -1
  60. package/dist/types/auxiliary-files.d.ts +13 -0
  61. package/dist/types/errors.d.ts +182 -0
  62. package/dist/types/handler-types.d.ts +31 -0
  63. package/dist/types/handlers.d.ts +49 -36
  64. package/dist/types/index.browser.d.ts +2 -0
  65. package/dist/types/index.d.ts +3 -0
  66. package/dist/types/index.executionenv.d.ts +2 -0
  67. package/dist/types/manifest/manifest.d.ts +11 -1
  68. package/dist/types/manifest/validation.d.ts +6 -2
  69. package/dist/types/snaps.d.ts +13 -6
  70. package/dist/types/types.d.ts +8 -9
  71. package/dist/types/validation.d.ts +2 -2
  72. package/package.json +17 -18
@@ -1,8 +1,7 @@
1
1
  import type { Json } from '@metamask/utils';
2
2
  import type { Infer, Struct } from 'superstruct';
3
3
  import type { SnapCaveatType } from './caveats';
4
- import type { SnapFunctionExports } from './handlers';
5
- import { HandlerType } from './handlers';
4
+ import type { SnapFunctionExports, SnapRpcHookArgs } from './handlers';
6
5
  import type { SnapManifest } from './manifest';
7
6
  import type { VirtualFile } from './virtual-file';
8
7
  export declare enum NpmSnapFileNames {
@@ -13,11 +12,11 @@ export declare const NameStruct: Struct<string, null>;
13
12
  export declare const NpmSnapPackageJsonStruct: Struct<{
14
13
  name: string;
15
14
  version: import("@metamask/utils").SemVerVersion;
15
+ main?: string | undefined;
16
16
  repository?: {
17
17
  type: string;
18
18
  url: string;
19
19
  } | undefined;
20
- main?: string | undefined;
21
20
  }, {
22
21
  version: Struct<import("@metamask/utils").SemVerVersion, null>;
23
22
  name: Struct<string, null>;
@@ -53,6 +52,7 @@ export declare type UnvalidatedSnapFiles = {
53
52
  packageJson?: VirtualFile<Json>;
54
53
  sourceCode?: VirtualFile;
55
54
  svgIcon?: VirtualFile;
55
+ auxiliaryFiles: VirtualFile[];
56
56
  };
57
57
  /**
58
58
  * An object for storing the contents of Snap files that have passed JSON
@@ -63,7 +63,12 @@ export declare type SnapFiles = {
63
63
  packageJson: VirtualFile<NpmSnapPackageJson>;
64
64
  sourceCode: VirtualFile;
65
65
  svgIcon?: VirtualFile;
66
+ auxiliaryFiles: VirtualFile[];
66
67
  };
68
+ /**
69
+ * A subset of snap files extracted from a fetched snap.
70
+ */
71
+ export declare type FetchedSnapFiles = Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon' | 'auxiliaryFiles'>;
67
72
  /**
68
73
  * The possible prefixes for snap ids.
69
74
  */
@@ -86,12 +91,6 @@ export declare enum SNAP_STREAM_NAMES {
86
91
  JSON_RPC = "jsonRpc",
87
92
  COMMAND = "command"
88
93
  }
89
- export declare const SNAP_EXPORT_NAMES: HandlerType[];
90
- export declare type SnapRpcHookArgs = {
91
- origin: string;
92
- handler: HandlerType;
93
- request: Record<string, unknown>;
94
- };
95
94
  export declare type SnapRpcHook = (options: SnapRpcHookArgs) => Promise<unknown>;
96
95
  declare type ObjectParameters<Type extends Record<string, (...args: any[]) => unknown>> = Parameters<Type[keyof Type]>;
97
96
  export declare type SnapExportsParameters = ObjectParameters<SnapFunctionExports>;
@@ -1,8 +1,8 @@
1
- import type { SnapFiles } from './types';
1
+ import type { FetchedSnapFiles } from './types';
2
2
  /**
3
3
  * Validates the files contained in a fetched snap.
4
4
  *
5
5
  * @param files - All potentially included files in a fetched snap.
6
6
  * @throws If any of the files are considered invalid.
7
7
  */
8
- export declare function validateFetchedSnap(files: Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon'>): void;
8
+ export declare function validateFetchedSnap(files: FetchedSnapFiles): void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@metamask/snaps-utils",
3
- "version": "3.0.0",
3
+ "version": "3.2.0",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/MetaMask/snaps.git"
@@ -60,25 +60,24 @@
60
60
  "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
61
61
  "build:clean": "yarn clean && yarn build",
62
62
  "clean": "rimraf '*.tsbuildinfo' 'dist'",
63
- "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
64
63
  "publish:preview": "yarn npm publish --tag preview",
65
64
  "lint:ci": "yarn lint",
66
65
  "lint:dependencies": "depcheck"
67
66
  },
68
67
  "dependencies": {
69
- "@babel/core": "^7.20.12",
70
- "@babel/types": "^7.18.7",
68
+ "@babel/core": "^7.23.2",
69
+ "@babel/types": "^7.23.0",
71
70
  "@metamask/base-controller": "^3.2.0",
72
71
  "@metamask/key-tree": "^9.0.0",
73
- "@metamask/permission-controller": "^4.1.2",
74
- "@metamask/snaps-registry": "^2.0.0",
75
- "@metamask/snaps-ui": "^3.0.0",
72
+ "@metamask/permission-controller": "^5.0.0",
73
+ "@metamask/rpc-errors": "^6.1.0",
74
+ "@metamask/snaps-registry": "^2.1.0",
75
+ "@metamask/snaps-ui": "^3.1.0",
76
76
  "@metamask/utils": "^8.1.0",
77
77
  "@noble/hashes": "^1.3.1",
78
78
  "@scure/base": "^1.1.1",
79
79
  "chalk": "^4.1.2",
80
80
  "cron-parser": "^4.5.0",
81
- "eth-rpc-errors": "^4.0.3",
82
81
  "fast-deep-equal": "^3.1.3",
83
82
  "fast-json-stable-stringify": "^2.1.0",
84
83
  "is-svg": "^4.4.0",
@@ -108,15 +107,15 @@
108
107
  "@types/validate-npm-package-name": "^4.0.0",
109
108
  "@typescript-eslint/eslint-plugin": "^5.42.1",
110
109
  "@typescript-eslint/parser": "^5.42.1",
111
- "@wdio/browser-runner": "^8.15.9",
112
- "@wdio/cli": "^8.15.9",
113
- "@wdio/globals": "^8.15.9",
114
- "@wdio/mocha-framework": "^8.15.9",
115
- "@wdio/spec-reporter": "^8.15.7",
116
- "@wdio/static-server-service": "^8.15.7",
117
- "@wdio/types": "^8.15.7",
110
+ "@wdio/browser-runner": "^8.19.0",
111
+ "@wdio/cli": "^8.19.0",
112
+ "@wdio/globals": "^8.19.0",
113
+ "@wdio/mocha-framework": "^8.19.0",
114
+ "@wdio/spec-reporter": "^8.19.0",
115
+ "@wdio/static-server-service": "^8.19.0",
116
+ "@wdio/types": "^8.19.0",
118
117
  "deepmerge": "^4.2.2",
119
- "depcheck": "^1.4.5",
118
+ "depcheck": "^1.4.7",
120
119
  "esbuild": "^0.18.10",
121
120
  "eslint": "^8.27.0",
122
121
  "eslint-config-prettier": "^8.5.0",
@@ -126,7 +125,7 @@
126
125
  "eslint-plugin-n": "^15.7.0",
127
126
  "eslint-plugin-prettier": "^4.2.1",
128
127
  "eslint-plugin-promise": "^6.1.1",
129
- "expect-webdriverio": "^4.1.2",
128
+ "expect-webdriverio": "^4.4.1",
130
129
  "istanbul-lib-coverage": "^3.2.0",
131
130
  "istanbul-lib-report": "^3.0.0",
132
131
  "istanbul-reports": "^3.1.5",
@@ -141,7 +140,7 @@
141
140
  "vite-tsconfig-paths": "^4.0.5",
142
141
  "wdio-chromedriver-service": "^8.1.1",
143
142
  "wdio-geckodriver-service": "^5.0.2",
144
- "webdriverio": "^8.15.9"
143
+ "webdriverio": "^8.19.0"
145
144
  },
146
145
  "engines": {
147
146
  "node": "^18.16 || >=20"