@metamask/snaps-controllers 9.5.0 → 9.7.0

package/dist/utils.mjs

@@ -1,23 +1,168 @@
-import {
-  delay,
-  delayWithTimer,
-  fetchSnap,
-  getSnapFiles,
-  hasTimedOut,
-  permissionsDiff,
-  setDiff,
-  withTimeout
-} from "./chunk-KRI4OKC3.mjs";
-import "./chunk-XO7KDFBY.mjs";
-import "./chunk-YRZVIDCF.mjs";
-export {
-  delay,
-  delayWithTimer,
-  fetchSnap,
-  getSnapFiles,
-  hasTimedOut,
-  permissionsDiff,
-  setDiff,
-  withTimeout
-};
+function $importDefault(module) {
+    if (module?.__esModule) {
+        return module.default;
+    }
+    return module;
+}
+import { assert, getErrorMessage } from "@metamask/snaps-sdk";
+import { MAX_FILE_SIZE, encodeBase64, getValidatedLocalizationFiles, validateAuxiliaryFiles, validateFetchedSnap } from "@metamask/snaps-utils";
+import $deepEqual from "fast-deep-equal";
+const deepEqual = $importDefault($deepEqual);
+import { Timer } from "./snaps/Timer.mjs";
+/**
+ * Takes two objects and does a Set Difference of them.
+ * Set Difference is generally defined as follows:
+ * ```
+ * 𝑥 ∈ A ∖ B ⟺ 𝑥 ∈ A ∧ 𝑥 ∉ B
+ * ```
+ * Meaning that the returned object contains all properties of A expect those that also
+ * appear in B. Notice that properties that appear in B, but not in A, have no effect.
+ *
+ * @see [Set Difference]{@link https://proofwiki.org/wiki/Definition:Set_Difference}
+ * @param objectA - The object on which the difference is being calculated.
+ * @param objectB - The object whose properties will be removed from objectA.
+ * @returns The objectA without properties from objectB.
+ */
+export function setDiff(objectA, objectB) {
+    return Object.entries(objectA).reduce((acc, [key, value]) => {
+        if (!(key in objectB)) {
+            acc[key] = value;
+        }
+        return acc;
+    }, {});
+}
+/**
+ * Calculate a difference between two permissions objects.
+ *
+ * Similar to `setDiff` except for one additional condition:
+ * Permissions in B should be removed from A if they exist in both and have differing caveats.
+ *
+ * @param permissionsA - An object containing one or more partial permissions.
+ * @param permissionsB - An object containing one or more partial permissions to be subtracted from A.
+ * @returns The permissions set A without properties from B.
+ */
+export function permissionsDiff(permissionsA, permissionsB) {
+    return Object.entries(permissionsA).reduce((acc, [key, value]) => {
+        const isIncluded = key in permissionsB;
+        if (!isIncluded ||
+            (isIncluded &&
+                !deepEqual(value.caveats ?? [], permissionsB[key].caveats ?? []))) {
+            acc[key] = value;
+        }
+        return acc;
+    }, {});
+}
+/**
+ * A Promise that delays its return for a given amount of milliseconds.
+ *
+ * @param ms - Milliseconds to delay the execution for.
+ * @param result - The result to return from the Promise after delay.
+ * @returns A promise that is void if no result provided, result otherwise.
+ * @template Result - The `result`.
+ */
+export function delay(ms, result) {
+    return delayWithTimer(new Timer(ms), result);
+}
+/**
+ * A Promise that delays it's return by using a pausable Timer.
+ *
+ * @param timer - Timer used to control the delay.
+ * @param result - The result to return from the Promise after delay.
+ * @returns A promise that is void if no result provided, result otherwise.
+ * @template Result - The `result`.
+ */
+export function delayWithTimer(timer, result) {
+    let rejectFunc;
+    const promise = new Promise((resolve, reject) => {
+        timer.start(() => {
+            result === undefined ? resolve() : resolve(result);
+        });
+        rejectFunc = reject;
+    });
+    promise.cancel = () => {
+        if (timer.status !== 'finished') {
+            timer.cancel();
+            rejectFunc(new Error('The delay has been canceled.'));
+        }
+    };
+    return promise;
+}
+/*
+ * We use a Symbol instead of rejecting the promise so that Errors thrown
+ * by the main promise will propagate.
+ */
+export const hasTimedOut = Symbol('Used to check if the requested promise has timeout (see withTimeout)');
+/**
+ * Executes the given Promise, if the Timer expires before the Promise settles, we return earlier.
+ *
+ * NOTE:** The given Promise is not cancelled or interrupted, and will continue to execute uninterrupted. We will just discard its result if it does not complete before the timeout.
+ *
+ * @param promise - The promise that you want to execute.
+ * @param timerOrMs - The timer controlling the timeout or a ms value.
+ * @returns The resolved `PromiseValue`, or the hasTimedOut symbol if
+ * returning early.
+ * @template PromiseValue - The value of the Promise.
+ */
+export async function withTimeout(promise, timerOrMs) {
+    const timer = typeof timerOrMs === 'number' ? new Timer(timerOrMs) : timerOrMs;
+    const delayPromise = delayWithTimer(timer, hasTimedOut);
+    try {
+        return await Promise.race([promise, delayPromise]);
+    }
+    finally {
+        delayPromise.cancel();
+    }
+}
+/**
+ * Get all files in a Snap from an array of file paths.
+ *
+ * @param location - The location of the Snap.
+ * @param files - The array of file paths.
+ * @returns The array of files as {@link VirtualFile}s.
+ */
+export async function getSnapFiles(location, files) {
+    if (!files || files.length === 0) {
+        return [];
+    }
+    return await Promise.all(files.map(async (filePath) => location.fetch(filePath)));
+}
+/**
+ * Fetch the Snap manifest, source code, and any other files from the given
+ * location.
+ *
+ * @param snapId - The ID of the Snap to fetch.
+ * @param location - The location of the Snap.
+ * @returns The Snap files and location.
+ * @throws If the Snap files are invalid, or if the Snap could not be fetched.
+ */
+export async function fetchSnap(snapId, location) {
+    try {
+        const manifest = await location.manifest();
+        const sourceCode = await location.fetch(manifest.result.source.location.npm.filePath);
+        assert(sourceCode.size < MAX_FILE_SIZE, 'Snap source code must be smaller than 64 MB.');
+        const { iconPath } = manifest.result.source.location.npm;
+        const svgIcon = iconPath ? await location.fetch(iconPath) : undefined;
+        const auxiliaryFiles = await getSnapFiles(location, manifest.result.source.files);
+        validateAuxiliaryFiles(auxiliaryFiles);
+        await Promise.all(auxiliaryFiles.map(async (file) => {
+            // This should still be safe
+            // eslint-disable-next-line require-atomic-updates
+            file.data.base64 = await encodeBase64(file);
+        }));
+        const localizationFiles = await getSnapFiles(location, manifest.result.source.locales);
+        const validatedLocalizationFiles = getValidatedLocalizationFiles(localizationFiles);
+        const files = {
+            manifest,
+            sourceCode,
+            svgIcon,
+            auxiliaryFiles,
+            localizationFiles: validatedLocalizationFiles,
+        };
+        await validateFetchedSnap(files);
+        return files;
+    }
+    catch (error) {
+        throw new Error(`Failed to fetch snap "${snapId}": ${getErrorMessage(error)}.`);
+    }
+}
 //# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAEA,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,4BAA4B;AAC9D,OAAO,EACL,aAAa,EACb,YAAY,EACZ,6BAA6B,EAC7B,sBAAsB,EACtB,mBAAmB,EACpB,8BAA8B;AAC/B,OAAO,UAAS,wBAAwB;;AAGxC,OAAO,EAAE,KAAK,EAAE,0BAAsB;AAEtC;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,OAAO,CAGrB,OAAgB,EAAE,OAAgB;IAClC,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CACnC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,IAAI,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC,EAAE,CAAC;YACtB,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACuB,CAAC;AAC9B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,eAAe,CAI7B,YAA0B,EAC1B,YAA0B;IAE1B,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,MAAM,CAExC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACtB,MAAM,UAAU,GAAG,GAAG,IAAI,YAAY,CAAC;QACvC,IACE,CAAC,UAAU;YACX,CAAC,UAAU;gBACT,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,EACnE,CAAC;YACD,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACnB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAqC,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CACnB,EAAU,EACV,MAAe;IAEf,OAAO,cAAc,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,KAAY,EACZ,MAAe;IAEf,IAAI,UAAmC,CAAC;IACxC,MAAM,OAAO,GAAQ,IAAI,OAAO,CAAS,CAAC,OAAY,EAAE,MAAM,EAAE,EAAE;QAChE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE;YACf,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QACH,UAAU,GAAG,MAAM,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE;QACpB,IAAI,KAAK,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAChC,KAAK,CAAC,MAAM,EAAE,CAAC;YACf,UAAU,CAAC,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAC/B,sEAAsE,CACvE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAA8B,EAC9B,SAAyB;IAEzB,MAAM,KAAK,GACT,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IACxD,IAAI,CAAC;QACH,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;IACrD,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;AACH,CAAC;AA+FD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAsB,EACtB,KAA4B;IAE5B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CACxD,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,MAAc,EAAE,QAAsB;IACpE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAE3C,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,KAAK,CACrC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAC7C,CAAC;QAEF,MAAM,CACJ,UAAU,CAAC,IAAI,GAAG,aAAa,EAC/B,8CAA8C,CAC/C,CAAC;QAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QACzD,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEtE,MAAM,cAAc,GAAG,MAAM,YAAY,CACvC,QAAQ,EACR,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAC7B,CAAC;QAEF,sBAAsB,CAAC,cAAc,CAAC,CAAC;QAEvC,MAAM,OAAO,CAAC,GAAG,CACf,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAChC,4BAA4B;YAC5B,kDAAkD;YAClD,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC,CAAC,CACH,CAAC;QAEF,MAAM,iBAAiB,GAAG,MAAM,YAAY,CAC1C,QAAQ,EACR,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAC/B,CAAC;QAEF,MAAM,0BAA0B,GAC9B,6BAA6B,CAAC,iBAAiB,CAAC,CAAC;QAEnD,MAAM,KAAK,GAAG;YACZ,QAAQ;YACR,UAAU;YACV,OAAO;YACP,cAAc;YACd,iBAAiB,EAAE,0BAA0B;SAC9C,CAAC;QAEF,MAAM,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACb,yBAAyB,MAAM,MAAM,eAAe,CAAC,KAAK,CAAC,GAAG,CAC/D,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["import type { PermissionConstraint } from '@metamask/permission-controller';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { assert, getErrorMessage } from '@metamask/snaps-sdk';\nimport {\n  MAX_FILE_SIZE,\n  encodeBase64,\n  getValidatedLocalizationFiles,\n  validateAuxiliaryFiles,\n  validateFetchedSnap,\n} from '@metamask/snaps-utils';\nimport deepEqual from 'fast-deep-equal';\n\nimport type { SnapLocation } from './snaps';\nimport { Timer } from './snaps/Timer';\n\n/**\n * Takes two objects and does a Set Difference of them.\n * Set Difference is generally defined as follows:\n * ```\n * 𝑥 ∈ A ∖ B ⟺ 𝑥 ∈ A ∧ 𝑥 ∉ B\n * ```\n * Meaning that the returned object contains all properties of A expect those that also\n * appear in B. Notice that properties that appear in B, but not in A, have no effect.\n *\n * @see [Set Difference]{@link https://proofwiki.org/wiki/Definition:Set_Difference}\n * @param objectA - The object on which the difference is being calculated.\n * @param objectB - The object whose properties will be removed from objectA.\n * @returns The objectA without properties from objectB.\n */\nexport function setDiff<\n  ObjectA extends Record<any, unknown>,\n  ObjectB extends Record<any, unknown>,\n>(objectA: ObjectA, objectB: ObjectB): Diff<ObjectA, ObjectB> {\n  return Object.entries(objectA).reduce<Record<any, unknown>>(\n    (acc, [key, value]) => {\n      if (!(key in objectB)) {\n        acc[key] = value;\n      }\n      return acc;\n    },\n    {},\n  ) as Diff<ObjectA, ObjectB>;\n}\n\n/**\n * Calculate a difference between two permissions objects.\n *\n * Similar to `setDiff` except for one additional condition:\n * Permissions in B should be removed from A if they exist in both and have differing caveats.\n *\n * @param permissionsA - An object containing one or more partial permissions.\n * @param permissionsB - An object containing one or more partial permissions to be subtracted from A.\n * @returns The permissions set A without properties from B.\n */\nexport function permissionsDiff<\n  PermissionsA extends Record<string, Pick<PermissionConstraint, 'caveats'>>,\n  PermissionsB extends Record<string, Pick<PermissionConstraint, 'caveats'>>,\n>(\n  permissionsA: PermissionsA,\n  permissionsB: PermissionsB,\n): Diff<PermissionsA, PermissionsB> {\n  return Object.entries(permissionsA).reduce<\n    Record<string, Pick<PermissionConstraint, 'caveats'>>\n  >((acc, [key, value]) => {\n    const isIncluded = key in permissionsB;\n    if (\n      !isIncluded ||\n      (isIncluded &&\n        !deepEqual(value.caveats ?? [], permissionsB[key].caveats ?? []))\n    ) {\n      acc[key] = value;\n    }\n    return acc;\n  }, {}) as Diff<PermissionsA, PermissionsB>;\n}\n\n/**\n * A Promise that delays its return for a given amount of milliseconds.\n *\n * @param ms - Milliseconds to delay the execution for.\n * @param result - The result to return from the Promise after delay.\n * @returns A promise that is void if no result provided, result otherwise.\n * @template Result - The `result`.\n */\nexport function delay<Result = void>(\n  ms: number,\n  result?: Result,\n): Promise<Result> & { cancel: () => void } {\n  return delayWithTimer(new Timer(ms), result);\n}\n\n/**\n * A Promise that delays it's return by using a pausable Timer.\n *\n * @param timer - Timer used to control the delay.\n * @param result - The result to return from the Promise after delay.\n * @returns A promise that is void if no result provided, result otherwise.\n * @template Result - The `result`.\n */\nexport function delayWithTimer<Result = void>(\n  timer: Timer,\n  result?: Result,\n): Promise<Result> & { cancel: () => void } {\n  let rejectFunc: (reason: Error) => void;\n  const promise: any = new Promise<Result>((resolve: any, reject) => {\n    timer.start(() => {\n      result === undefined ? resolve() : resolve(result);\n    });\n    rejectFunc = reject;\n  });\n\n  promise.cancel = () => {\n    if (timer.status !== 'finished') {\n      timer.cancel();\n      rejectFunc(new Error('The delay has been canceled.'));\n    }\n  };\n  return promise;\n}\n\n/*\n * We use a Symbol instead of rejecting the promise so that Errors thrown\n * by the main promise will propagate.\n */\nexport const hasTimedOut = Symbol(\n  'Used to check if the requested promise has timeout (see withTimeout)',\n);\n\n/**\n * Executes the given Promise, if the Timer expires before the Promise settles, we return earlier.\n *\n * NOTE:** The given Promise is not cancelled or interrupted, and will continue to execute uninterrupted. We will just discard its result if it does not complete before the timeout.\n *\n * @param promise - The promise that you want to execute.\n * @param timerOrMs - The timer controlling the timeout or a ms value.\n * @returns The resolved `PromiseValue`, or the hasTimedOut symbol if\n * returning early.\n * @template PromiseValue - The value of the Promise.\n */\nexport async function withTimeout<PromiseValue = void>(\n  promise: Promise<PromiseValue>,\n  timerOrMs: Timer | number,\n): Promise<PromiseValue | typeof hasTimedOut> {\n  const timer =\n    typeof timerOrMs === 'number' ? new Timer(timerOrMs) : timerOrMs;\n  const delayPromise = delayWithTimer(timer, hasTimedOut);\n  try {\n    return await Promise.race([promise, delayPromise]);\n  } finally {\n    delayPromise.cancel();\n  }\n}\n\n/**\n * Checks whether the type is composed of literal types\n *\n * @returns @type {true} if whole type is composed of literals, @type {false} if whole type is not literals, @type {boolean} if mixed\n * @example\n * ```\n * type t1 = IsLiteral<1 | 2 | \"asd\" | true>;\n * // t1 = true\n *\n * type t2 = IsLiteral<number | string>;\n * // t2 = false\n *\n * type t3 = IsLiteral<1 | string>;\n * // t3 = boolean\n *\n * const s = Symbol();\n * type t4 = IsLiteral<typeof s>;\n * // t4 = true\n *\n * type t5 = IsLiteral<symbol>\n * // t5 = false;\n * ```\n */\ntype IsLiteral<Type> = Type extends string | number | boolean | symbol\n  ? Extract<string | number | boolean | symbol, Type> extends never\n    ? true\n    : false\n  : false;\n\n/**\n * Returns all keys of an object, that are literal, as an union\n *\n * @example\n * ```\n * type t1 = _LiteralKeys<{a: number, b: 0, c: 'foo', d: string}>\n * // t1 = 'b' | 'c'\n * ```\n * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}\n */\ntype LiteralKeys<Type> = NonNullable<\n  {\n    [Key in keyof Type]: IsLiteral<Key> extends true ? Key : never;\n  }[keyof Type]\n>;\n\n/**\n * Returns all keys of an object, that are not literal, as an union\n *\n * @example\n * ```\n * type t1 = _NonLiteralKeys<{a: number, b: 0, c: 'foo', d: string}>\n * // t1 = 'a' | 'd'\n * ```\n * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}\n */\ntype NonLiteralKeys<Type> = NonNullable<\n  {\n    [Key in keyof Type]: IsLiteral<Key> extends false ? Key : never;\n  }[keyof Type]\n>;\n\n/**\n * A set difference of two objects based on their keys\n *\n * @example\n * ```\n * type t1 = Diff<{a: string, b: string}, {a: number}>\n * // t1 = {b: string};\n * type t2 = Diff<{a: string, 0: string}, Record<string, unknown>>;\n * // t2 = { a?: string, 0: string};\n * type t3 = Diff<{a: string, 0: string, 1: string}, Record<1 | string, unknown>>;\n * // t3 = {a?: string, 0: string}\n * ```\n * @see {@link setDiff} for the main use-case\n */\nexport type Diff<First, Second> = Omit<First, LiteralKeys<Second>> &\n  Partial<Pick<First, Extract<keyof First, NonLiteralKeys<Second>>>>;\n\n/**\n * Makes every specified property of the specified object type mutable.\n *\n * @template Type - The object whose readonly properties to make mutable.\n * @template TargetKey - The property key(s) to make mutable.\n */\nexport type Mutable<\n  Type extends Record<string, unknown>,\n  TargetKey extends string,\n> = {\n  -readonly [Key in keyof Pick<Type, TargetKey>]: Type[Key];\n} & {\n  [Key in keyof Omit<Type, TargetKey>]: Type[Key];\n};\n\n/**\n * Get all files in a Snap from an array of file paths.\n *\n * @param location - The location of the Snap.\n * @param files - The array of file paths.\n * @returns The array of files as {@link VirtualFile}s.\n */\nexport async function getSnapFiles(\n  location: SnapLocation,\n  files?: string[] | undefined,\n) {\n  if (!files || files.length === 0) {\n    return [];\n  }\n\n  return await Promise.all(\n    files.map(async (filePath) => location.fetch(filePath)),\n  );\n}\n\n/**\n * Fetch the Snap manifest, source code, and any other files from the given\n * location.\n *\n * @param snapId - The ID of the Snap to fetch.\n * @param location - The location of the Snap.\n * @returns The Snap files and location.\n * @throws If the Snap files are invalid, or if the Snap could not be fetched.\n */\nexport async function fetchSnap(snapId: SnapId, location: SnapLocation) {\n  try {\n    const manifest = await location.manifest();\n\n    const sourceCode = await location.fetch(\n      manifest.result.source.location.npm.filePath,\n    );\n\n    assert(\n      sourceCode.size < MAX_FILE_SIZE,\n      'Snap source code must be smaller than 64 MB.',\n    );\n\n    const { iconPath } = manifest.result.source.location.npm;\n    const svgIcon = iconPath ? await location.fetch(iconPath) : undefined;\n\n    const auxiliaryFiles = await getSnapFiles(\n      location,\n      manifest.result.source.files,\n    );\n\n    validateAuxiliaryFiles(auxiliaryFiles);\n\n    await Promise.all(\n      auxiliaryFiles.map(async (file) => {\n        // This should still be safe\n        // eslint-disable-next-line require-atomic-updates\n        file.data.base64 = await encodeBase64(file);\n      }),\n    );\n\n    const localizationFiles = await getSnapFiles(\n      location,\n      manifest.result.source.locales,\n    );\n\n    const validatedLocalizationFiles =\n      getValidatedLocalizationFiles(localizationFiles);\n\n    const files = {\n      manifest,\n      sourceCode,\n      svgIcon,\n      auxiliaryFiles,\n      localizationFiles: validatedLocalizationFiles,\n    };\n\n    await validateFetchedSnap(files);\n\n    return files;\n  } catch (error) {\n    throw new Error(\n      `Failed to fetch snap \"${snapId}\": ${getErrorMessage(error)}.`,\n    );\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-controllers",
-  "version": "9.5.0",
+  "version": "9.7.0",
   "description": "Controllers for MetaMask Snaps.",
   "repository": {
     "type": "git",
@@ -9,25 +9,40 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/types/index.d.ts"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     },
     "./node": {
-      "import": "./dist/node.mjs",
-      "require": "./dist/node.js",
-      "types": "./dist/types/node.d.ts"
+      "import": {
+        "types": "./dist/types/node.d.mts",
+        "default": "./dist/node.mjs"
+      },
+      "require": {
+        "types": "./dist/types/node.d.cts",
+        "default": "./dist/node.cjs"
+      }
     },
     "./react-native": {
-      "import": "./dist/react-native.mjs",
-      "require": "./dist/react-native.js",
-      "types": "./dist/types/react-native.d.ts"
+      "import": {
+        "types": "./dist/types/react-native.d.mts",
+        "default": "./dist/react-native.mjs"
+      },
+      "require": {
+        "types": "./dist/types/react-native.d.cts",
+        "default": "./dist/react-native.cjs"
+      }
     },
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/types/index.d.ts",
+  "types": "./dist/index.d.cts",
   "files": [
     "dist",
     "react-native.d.ts",
@@ -39,9 +54,7 @@
     "posttest": "ts-node scripts/coverage.ts && rimraf coverage/jest coverage/wdio",
     "test:browser": "wdio run wdio.config.js",
     "test:ci": "yarn test",
-    "build": "tsup --clean && yarn build:types",
-    "build:types": "tsc --project tsconfig.build.json",
-    "clean": "rimraf '*.tsbuildinfo' 'dist'",
+    "build": "ts-bridge --project tsconfig.build.json --verbose --no-references",
     "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx",
     "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" --ignore-path ../../.gitignore",
     "lint": "yarn lint:eslint && yarn lint:misc --check && yarn lint:changelog && yarn lint:dependencies",
@@ -49,8 +62,7 @@
     "lint:changelog": "../../scripts/validate-changelog.sh @metamask/snaps-controllers",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
-    "lint:dependencies": "depcheck",
-    "build:ci": "tsup --clean"
+    "lint:dependencies": "depcheck"
   },
   "dependencies": {
     "@metamask/approval-controller": "^7.0.2",
@@ -59,14 +71,14 @@
     "@metamask/json-rpc-middleware-stream": "^8.0.2",
     "@metamask/object-multiplex": "^2.0.0",
     "@metamask/permission-controller": "^11.0.0",
-    "@metamask/phishing-controller": "^10.1.1",
-    "@metamask/post-message-stream": "^8.1.0",
+    "@metamask/phishing-controller": "^12.0.2",
+    "@metamask/post-message-stream": "^8.1.1",
     "@metamask/rpc-errors": "^6.3.1",
     "@metamask/snaps-registry": "^3.2.1",
-    "@metamask/snaps-rpc-methods": "^11.0.0",
-    "@metamask/snaps-sdk": "^6.3.0",
-    "@metamask/snaps-utils": "^8.0.1",
-    "@metamask/utils": "^9.1.0",
+    "@metamask/snaps-rpc-methods": "^11.1.1",
+    "@metamask/snaps-sdk": "^6.5.0",
+    "@metamask/snaps-utils": "^8.1.1",
+    "@metamask/utils": "^9.2.1",
     "@xstate/fsm": "^2.0.0",
     "browserify-zlib": "^0.2.0",
     "concat-stream": "^2.0.0",
@@ -83,7 +95,7 @@
     "@esbuild-plugins/node-modules-polyfill": "^0.2.2",
     "@lavamoat/allow-scripts": "^3.0.4",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/browser-passworder": "^5.0.0",
+    "@metamask/browser-passworder": "^5.0.1",
     "@metamask/eslint-config": "^12.1.0",
     "@metamask/eslint-config-jest": "^12.1.0",
     "@metamask/eslint-config-nodejs": "^12.1.0",
@@ -91,16 +103,17 @@
     "@metamask/template-snap": "^0.7.0",
     "@swc/core": "1.3.78",
     "@swc/jest": "^0.2.26",
+    "@ts-bridge/cli": "^0.5.1",
     "@types/chrome": "^0.0.237",
     "@types/concat-stream": "^2.0.0",
     "@types/gunzip-maybe": "^1.4.0",
     "@types/jest": "^27.5.1",
     "@types/mocha": "^10.0.1",
     "@types/node": "18.14.2",
-    "@types/readable-stream": "^2.3.15",
+    "@types/readable-stream": "^4.0.15",
     "@types/tar-stream": "^3.1.1",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
-    "@typescript-eslint/parser": "^5.42.1",
+    "@typescript-eslint/parser": "^6.21.0",
     "@wdio/browser-runner": "^8.19.0",
     "@wdio/cli": "^8.19.0",
     "@wdio/globals": "^8.19.0",
@@ -114,7 +127,7 @@
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^27.1.5",
-    "eslint-plugin-jsdoc": "^39.6.2",
+    "eslint-plugin-jsdoc": "^41.1.2",
     "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-promise": "^6.1.1",
@@ -129,8 +142,7 @@
     "prettier-plugin-packagejson": "^2.2.11",
     "rimraf": "^4.1.2",
     "ts-node": "^10.9.1",
-    "tsup": "^8.0.1",
-    "typescript": "~5.0.4",
+    "typescript": "~5.3.3",
     "vite": "^4.3.9",
     "vite-tsconfig-paths": "^4.0.5",
     "wdio-chromedriver-service": "^8.1.1",
@@ -138,7 +150,7 @@
     "webdriverio": "^8.19.0"
   },
   "peerDependencies": {
-    "@metamask/snaps-execution-environments": "^6.6.2"
+    "@metamask/snaps-execution-environments": "^6.7.1"
   },
   "peerDependenciesMeta": {
     "@metamask/snaps-execution-environments": {

package/react-native.d.ts

@@ -1 +1,3 @@
-export * from './dist/types/react-native';
+/* eslint-disable import/extensions */
+
+export * from './dist/react-native.cjs';

package/react-native.js

@@ -2,4 +2,4 @@
 
 // Re-exported for compatibility with build tools that don't support the
 // `exports` field in package.json
-module.exports = require('./dist/react-native');
+module.exports = require('./dist/react-native.cjs');

package/dist/chunk-272IFIK7.mjs

@@ -1 +0,0 @@
-//# sourceMappingURL=chunk-272IFIK7.mjs.map

package/dist/chunk-272IFIK7.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/chunk-2D5PGL7S.js

@@ -1,253 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-
-
-var _chunkRZ2NHZXHjs = require('./chunk-RZ2NHZXH.js');
-
-
-
-var _chunkEXN2TFDJjs = require('./chunk-EXN2TFDJ.js');
-
-// src/interface/SnapInterfaceController.ts
-var _basecontroller = require('@metamask/base-controller');
-var _snapsutils = require('@metamask/snaps-utils');
-var _utils = require('@metamask/utils');
-var _nanoid = require('nanoid');
-var MAX_UI_CONTENT_SIZE = 1e7;
-var controllerName = "SnapInterfaceController";
-var _registerMessageHandlers, registerMessageHandlers_fn, _validateArgs, validateArgs_fn, _validateApproval, validateApproval_fn, _triggerPhishingListUpdate, triggerPhishingListUpdate_fn, _checkPhishingList, checkPhishingList_fn, _hasApprovalRequest, hasApprovalRequest_fn, _acceptApprovalRequest, acceptApprovalRequest_fn, _validateContent, validateContent_fn;
-var SnapInterfaceController = class extends _basecontroller.BaseController {
-  constructor({ messenger, state }) {
-    super({
-      messenger,
-      metadata: {
-        interfaces: { persist: false, anonymous: false }
-      },
-      name: controllerName,
-      state: { interfaces: {}, ...state }
-    });
-    /**
-     * Constructor helper for registering this controller's messaging system
-     * actions.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _registerMessageHandlers);
-    /**
-     * Utility function to validate the args passed to the other methods.
-     *
-     * @param snapId - The snap id.
-     * @param id - The interface id.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _validateArgs);
-    /**
-     * Utility function to validate that the approval request exists.
-     *
-     * @param id - The interface id.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _validateApproval);
-    /**
-     * Trigger a Phishing list update if needed.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _triggerPhishingListUpdate);
-    /**
-     * Check an origin against the phishing list.
-     *
-     * @param origin - The origin to check.
-     * @returns True if the origin is on the phishing list, otherwise false.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _checkPhishingList);
-    /**
-     * Check if an approval request exists for a given interface by looking up
-     * if the ApprovalController has a request with the given interface ID.
-     *
-     * @param id - The interface id.
-     * @returns True if an approval request exists, otherwise false.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _hasApprovalRequest);
-    /**
-     * Accept an approval request for a given interface.
-     *
-     * @param id - The interface id.
-     * @param value - The value to resolve the promise with.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _acceptApprovalRequest);
-    /**
-     * Utility function to validate the components of an interface.
-     * Throws if something is invalid.
-     *
-     * @param element - The JSX element to verify.
-     */
-    _chunkEXN2TFDJjs.__privateAdd.call(void 0, this, _validateContent);
-    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _registerMessageHandlers, registerMessageHandlers_fn).call(this);
-  }
-  /**
-   * Create an interface in the controller state with the associated data.
-   *
-   * @param snapId - The snap id that created the interface.
-   * @param content - The interface content.
-   * @param context - An optional interface context object.
-   * @returns The newly interface id.
-   */
-  async createInterface(snapId, content, context) {
-    const element = _chunkRZ2NHZXHjs.getJsxInterface.call(void 0, content);
-    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateContent, validateContent_fn).call(this, element);
-    _chunkRZ2NHZXHjs.validateInterfaceContext.call(void 0, context);
-    const id = _nanoid.nanoid.call(void 0, );
-    const componentState = _chunkRZ2NHZXHjs.constructState.call(void 0, {}, element);
-    this.update((draftState) => {
-      draftState.interfaces[id] = {
-        snapId,
-        content: element,
-        state: componentState,
-        context: context ?? null
-      };
-    });
-    return id;
-  }
-  /**
-   * Get the data of a given interface id.
-   *
-   * @param snapId - The snap id requesting the interface data.
-   * @param id - The interface id.
-   * @returns The interface state.
-   */
-  getInterface(snapId, id) {
-    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateArgs, validateArgs_fn).call(this, snapId, id);
-    return this.state.interfaces[id];
-  }
-  /**
-   * Update the interface with the given content.
-   *
-   * @param snapId - The snap id requesting the update.
-   * @param id - The interface id.
-   * @param content - The new content.
-   */
-  async updateInterface(snapId, id, content) {
-    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateArgs, validateArgs_fn).call(this, snapId, id);
-    const element = _chunkRZ2NHZXHjs.getJsxInterface.call(void 0, content);
-    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateContent, validateContent_fn).call(this, element);
-    const oldState = this.state.interfaces[id].state;
-    const newState = _chunkRZ2NHZXHjs.constructState.call(void 0, oldState, element);
-    this.update((draftState) => {
-      draftState.interfaces[id].state = newState;
-      draftState.interfaces[id].content = element;
-    });
-  }
-  /**
-   * Delete an interface from state.
-   *
-   * @param id - The interface id.
-   */
-  deleteInterface(id) {
-    this.update((draftState) => {
-      delete draftState.interfaces[id];
-    });
-  }
-  /**
-   * Update the interface state.
-   *
-   * @param id - The interface id.
-   * @param state - The new state.
-   */
-  updateInterfaceState(id, state) {
-    this.update((draftState) => {
-      draftState.interfaces[id].state = state;
-    });
-  }
-  /**
-   * Resolve the promise of a given interface approval request.
-   * The approval needs to have the same ID as the interface.
-   *
-   * @param snapId - The snap id.
-   * @param id - The interface id.
-   * @param value - The value to resolve the promise with.
-   */
-  async resolveInterface(snapId, id, value) {
-    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateArgs, validateArgs_fn).call(this, snapId, id);
-    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _validateApproval, validateApproval_fn).call(this, id);
-    await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _acceptApprovalRequest, acceptApprovalRequest_fn).call(this, id, value);
-    this.deleteInterface(id);
-  }
-};
-_registerMessageHandlers = new WeakSet();
-registerMessageHandlers_fn = function() {
-  this.messagingSystem.registerActionHandler(
-    `${controllerName}:createInterface`,
-    this.createInterface.bind(this)
-  );
-  this.messagingSystem.registerActionHandler(
-    `${controllerName}:getInterface`,
-    this.getInterface.bind(this)
-  );
-  this.messagingSystem.registerActionHandler(
-    `${controllerName}:updateInterface`,
-    this.updateInterface.bind(this)
-  );
-  this.messagingSystem.registerActionHandler(
-    `${controllerName}:deleteInterface`,
-    this.deleteInterface.bind(this)
-  );
-  this.messagingSystem.registerActionHandler(
-    `${controllerName}:updateInterfaceState`,
-    this.updateInterfaceState.bind(this)
-  );
-  this.messagingSystem.registerActionHandler(
-    `${controllerName}:resolveInterface`,
-    this.resolveInterface.bind(this)
-  );
-};
-_validateArgs = new WeakSet();
-validateArgs_fn = function(snapId, id) {
-  const existingInterface = this.state.interfaces[id];
-  _utils.assert.call(void 0, 
-    existingInterface !== void 0,
-    `Interface with id '${id}' not found.`
-  );
-  _utils.assert.call(void 0, 
-    existingInterface.snapId === snapId,
-    `Interface not created by ${snapId}.`
-  );
-};
-_validateApproval = new WeakSet();
-validateApproval_fn = function(id) {
-  _utils.assert.call(void 0, 
-    _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _hasApprovalRequest, hasApprovalRequest_fn).call(this, id),
-    `Approval request with id '${id}' not found.`
-  );
-};
-_triggerPhishingListUpdate = new WeakSet();
-triggerPhishingListUpdate_fn = async function() {
-  await this.messagingSystem.call("PhishingController:maybeUpdateState");
-};
-_checkPhishingList = new WeakSet();
-checkPhishingList_fn = function(origin) {
-  return this.messagingSystem.call("PhishingController:testOrigin", origin).result;
-};
-_hasApprovalRequest = new WeakSet();
-hasApprovalRequest_fn = function(id) {
-  return this.messagingSystem.call("ApprovalController:hasRequest", {
-    id
-  });
-};
-_acceptApprovalRequest = new WeakSet();
-acceptApprovalRequest_fn = async function(id, value) {
-  await this.messagingSystem.call(
-    "ApprovalController:acceptRequest",
-    id,
-    value
-  );
-};
-_validateContent = new WeakSet();
-validateContent_fn = async function(element) {
-  const size = _snapsutils.getJsonSizeUnsafe.call(void 0, element);
-  _utils.assert.call(void 0, 
-    size <= MAX_UI_CONTENT_SIZE,
-    `A Snap UI may not be larger than ${MAX_UI_CONTENT_SIZE / 1e6} MB.`
-  );
-  await _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _triggerPhishingListUpdate, triggerPhishingListUpdate_fn).call(this);
-  _snapsutils.validateJsxLinks.call(void 0, element, _chunkEXN2TFDJjs.__privateMethod.call(void 0, this, _checkPhishingList, checkPhishingList_fn).bind(this));
-};
-
-
-
-exports.SnapInterfaceController = SnapInterfaceController;
-//# sourceMappingURL=chunk-2D5PGL7S.js.map