@metamask/snaps-utils 3.0.0 → 3.1.0

package/dist/types/snaps.d.ts

@@ -1,10 +1,9 @@
 import type { SubjectPermissions, PermissionConstraint } from '@metamask/permission-controller';
 import type { BlockReason } from '@metamask/snaps-registry';
-import type { Json, SemVerVersion, Opaque } from '@metamask/utils';
-import type { SerializedEthereumRpcError } from 'eth-rpc-errors/dist/classes';
+import type { Json, JsonRpcError, Opaque, SemVerVersion } from '@metamask/utils';
 import type { Struct } from 'superstruct';
 import type { SnapManifest, SnapPermissions } from './manifest/validation';
-import type { SnapFiles, SnapId, SnapsPermissionRequest } from './types';
+import type { FetchedSnapFiles, SnapId, SnapsPermissionRequest } from './types';
 import { SnapIdPrefixes, SnapValidationFailureReason } from './types';
 export declare const PROPOSED_NAME_REGEX: RegExp;
 /**
@@ -44,6 +43,10 @@ export declare type VersionHistory = {
     version: string;
     date: number;
 };
+export declare type SnapAuxilaryFile = {
+    path: string;
+    value: string;
+};
 export declare type PersistedSnap = Snap;
 /**
  * A Snap as it exists in {@link SnapController} state.
@@ -91,6 +94,10 @@ export declare type Snap = {
      * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.
      */
     versionHistory: VersionHistory[];
+    /**
+     * Static auxiliary files that can be loaded at runtime.
+     */
+    auxiliaryFiles?: SnapAuxilaryFile[];
 };
 export declare type TruncatedSnapFields = 'id' | 'initialPermissions' | 'version' | 'enabled' | 'blocked';
 /**
@@ -99,7 +106,7 @@ export declare type TruncatedSnapFields = 'id' | 'initialPermissions' | 'version
  */
 export declare type TruncatedSnap = Pick<Snap, TruncatedSnapFields>;
 export declare type ProcessSnapResult = TruncatedSnap | {
-    error: SerializedEthereumRpcError;
+    error: JsonRpcError;
 };
 export declare type InstallSnapsResult = Record<SnapId, ProcessSnapResult>;
 /**
@@ -116,7 +123,7 @@ export declare class ProgrammaticallyFixableSnapError extends Error {
  * @param files - All required Snap files to be included in the checksum.
  * @returns The Base64-encoded SHA-256 digest of the source code.
  */
-export declare function getSnapChecksum(files: Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon'>): string;
+export declare function getSnapChecksum(files: FetchedSnapFiles): string;
 /**
  * Checks whether the `source.shasum` property of a Snap manifest matches the
  * shasum of the snap.
@@ -124,7 +131,7 @@ export declare function getSnapChecksum(files: Pick<SnapFiles, 'manifest' | 'sou
  * @param files - All required Snap files to be included in the checksum.
  * @param errorMessage - The error message to throw if validation fails.
  */
-export declare function validateSnapShasum(files: Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon'>, errorMessage?: string): void;
+export declare function validateSnapShasum(files: FetchedSnapFiles, errorMessage?: string): void;
 export declare const LOCALHOST_HOSTNAMES: readonly ["localhost", "127.0.0.1", "[::1]"];
 export declare const BaseSnapIdStruct: Struct<string, null>;
 export declare const LocalSnapIdStruct: Struct<string, null>;

package/dist/types/types.d.ts

@@ -53,6 +53,7 @@ export declare type UnvalidatedSnapFiles = {
     packageJson?: VirtualFile<Json>;
     sourceCode?: VirtualFile;
     svgIcon?: VirtualFile;
+    auxiliaryFiles: VirtualFile[];
 };
 /**
  * An object for storing the contents of Snap files that have passed JSON
@@ -63,7 +64,12 @@ export declare type SnapFiles = {
     packageJson: VirtualFile<NpmSnapPackageJson>;
     sourceCode: VirtualFile;
     svgIcon?: VirtualFile;
+    auxiliaryFiles: VirtualFile[];
 };
+/**
+ * A subset of snap files extracted from a fetched snap.
+ */
+export declare type FetchedSnapFiles = Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon' | 'auxiliaryFiles'>;
 /**
  * The possible prefixes for snap ids.
  */

package/dist/types/validation.d.ts

@@ -1,8 +1,8 @@
-import type { SnapFiles } from './types';
+import type { FetchedSnapFiles } from './types';
 /**
  * Validates the files contained in a fetched snap.
  *
  * @param files - All potentially included files in a fetched snap.
  * @throws If any of the files are considered invalid.
  */
-export declare function validateFetchedSnap(files: Pick<SnapFiles, 'manifest' | 'sourceCode' | 'svgIcon'>): void;
+export declare function validateFetchedSnap(files: FetchedSnapFiles): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-utils",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
@@ -60,25 +60,24 @@
     "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
     "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
-    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
     "lint:dependencies": "depcheck"
   },
   "dependencies": {
-    "@babel/core": "^7.20.12",
-    "@babel/types": "^7.18.7",
+    "@babel/core": "^7.23.2",
+    "@babel/types": "^7.23.0",
     "@metamask/base-controller": "^3.2.0",
     "@metamask/key-tree": "^9.0.0",
-    "@metamask/permission-controller": "^4.1.2",
-    "@metamask/snaps-registry": "^2.0.0",
-    "@metamask/snaps-ui": "^3.0.0",
+    "@metamask/permission-controller": "^5.0.0",
+    "@metamask/rpc-errors": "^6.1.0",
+    "@metamask/snaps-registry": "^2.1.0",
+    "@metamask/snaps-ui": "^3.0.1",
     "@metamask/utils": "^8.1.0",
     "@noble/hashes": "^1.3.1",
     "@scure/base": "^1.1.1",
     "chalk": "^4.1.2",
     "cron-parser": "^4.5.0",
-    "eth-rpc-errors": "^4.0.3",
     "fast-deep-equal": "^3.1.3",
     "fast-json-stable-stringify": "^2.1.0",
     "is-svg": "^4.4.0",
@@ -108,15 +107,15 @@
     "@types/validate-npm-package-name": "^4.0.0",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
-    "@wdio/browser-runner": "^8.15.9",
-    "@wdio/cli": "^8.15.9",
-    "@wdio/globals": "^8.15.9",
-    "@wdio/mocha-framework": "^8.15.9",
-    "@wdio/spec-reporter": "^8.15.7",
-    "@wdio/static-server-service": "^8.15.7",
-    "@wdio/types": "^8.15.7",
+    "@wdio/browser-runner": "^8.19.0",
+    "@wdio/cli": "^8.19.0",
+    "@wdio/globals": "^8.19.0",
+    "@wdio/mocha-framework": "^8.19.0",
+    "@wdio/spec-reporter": "^8.19.0",
+    "@wdio/static-server-service": "^8.19.0",
+    "@wdio/types": "^8.19.0",
     "deepmerge": "^4.2.2",
-    "depcheck": "^1.4.5",
+    "depcheck": "^1.4.7",
     "esbuild": "^0.18.10",
     "eslint": "^8.27.0",
     "eslint-config-prettier": "^8.5.0",
@@ -126,7 +125,7 @@
     "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-promise": "^6.1.1",
-    "expect-webdriverio": "^4.1.2",
+    "expect-webdriverio": "^4.4.1",
     "istanbul-lib-coverage": "^3.2.0",
     "istanbul-lib-report": "^3.0.0",
     "istanbul-reports": "^3.1.5",
@@ -141,7 +140,7 @@
     "vite-tsconfig-paths": "^4.0.5",
     "wdio-chromedriver-service": "^8.1.1",
     "wdio-geckodriver-service": "^5.0.2",
-    "webdriverio": "^8.15.9"
+    "webdriverio": "^8.19.0"
   },
   "engines": {
     "node": "^18.16 || >=20"