@metamask/snaps-controllers 0.24.0

package/dist/snaps/utils/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./npm"), exports);
+__exportStar(require("./stream"), exports);
+//# sourceMappingURL=index.js.map

package/dist/snaps/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/snaps/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,2CAAyB","sourcesContent":["export * from './npm';\nexport * from './stream';\n"]}

package/dist/snaps/utils/npm.d.ts

@@ -0,0 +1,14 @@
+import { SnapFiles } from '@metamask/snaps-utils';
+export declare const DEFAULT_NPM_REGISTRY = "https://registry.npmjs.org";
+/**
+ * Fetches a Snap from the public npm registry.
+ *
+ * @param packageName - The name of the package whose tarball to fetch.
+ * @param versionRange - The SemVer range of the package to fetch. The highest
+ * version satisfying the range will be fetched.
+ * @param registryUrl - The URL of the npm registry to fetch from.
+ * @param fetchFunction - The fetch function to use. Defaults to the global
+ * {@link fetch}. Useful for Node.js compatibility.
+ * @returns A tuple of the Snap manifest object and the Snap source code.
+ */
+export declare function fetchNpmSnap(packageName: string, versionRange: string, registryUrl?: string, fetchFunction?: typeof fetch): Promise<SnapFiles>;

package/dist/snaps/utils/npm.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchNpmSnap = exports.DEFAULT_NPM_REGISTRY = void 0;
+const utils_1 = require("@metamask/utils");
+const pump_1 = __importDefault(require("pump"));
+const gunzip_maybe_1 = __importDefault(require("gunzip-maybe"));
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const stream_1 = require("./stream");
+exports.DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org';
+/**
+ * Fetches a Snap from the public npm registry.
+ *
+ * @param packageName - The name of the package whose tarball to fetch.
+ * @param versionRange - The SemVer range of the package to fetch. The highest
+ * version satisfying the range will be fetched.
+ * @param registryUrl - The URL of the npm registry to fetch from.
+ * @param fetchFunction - The fetch function to use. Defaults to the global
+ * {@link fetch}. Useful for Node.js compatibility.
+ * @returns A tuple of the Snap manifest object and the Snap source code.
+ */
+async function fetchNpmSnap(packageName, versionRange, registryUrl = exports.DEFAULT_NPM_REGISTRY, fetchFunction = fetch) {
+    const [tarballResponse, actualVersion] = await fetchNpmTarball(packageName, versionRange, registryUrl, fetchFunction);
+    // Extract the tarball and get the necessary files from it.
+    const snapFiles = {};
+    await new Promise((resolve, reject) => {
+        (0, pump_1.default)((0, stream_1.getNodeStream)(tarballResponse), 
+        // The "gz" in "tgz" stands for "gzip". The tarball needs to be decompressed
+        // before we can actually grab any files from it.
+        (0, gunzip_maybe_1.default)(), (0, stream_1.createTarballExtractionStream)(snapFiles), (error) => {
+            error ? reject(error) : resolve();
+        });
+    });
+    // At this point, the necessary files will have been added to the snapFiles
+    // object if they exist.
+    return (0, snaps_utils_1.validateNpmSnap)(snapFiles, `npm Snap "${packageName}@${actualVersion}" validation error: `);
+}
+exports.fetchNpmSnap = fetchNpmSnap;
+/**
+ * Fetches the tarball (`.tgz` file) of the specified package and version from
+ * the public npm registry. Throws an error if fetching fails.
+ *
+ * @param packageName - The name of the package whose tarball to fetch.
+ * @param versionRange - The SemVer range of the package to fetch. The highest
+ * version satisfying the range will be fetched.
+ * @param registryUrl - The URL of the npm registry to fetch the tarball from.
+ * @param fetchFunction - The fetch function to use. Defaults to the global
+ * {@link fetch}. Useful for Node.js compatibility.
+ * @returns A tuple of the {@link Response} for the package tarball and the
+ * actual version of the package.
+ */
+async function fetchNpmTarball(packageName, versionRange, registryUrl = exports.DEFAULT_NPM_REGISTRY, fetchFunction = fetch) {
+    var _a, _b, _c, _d;
+    const packageMetadata = await (await fetchFunction(new URL(packageName, registryUrl).toString())).json();
+    if (!(0, utils_1.isObject)(packageMetadata)) {
+        throw new Error(`Failed to fetch package "${packageName}" metadata from npm.`);
+    }
+    const targetVersion = (0, snaps_utils_1.getTargetVersion)(Object.keys((_a = packageMetadata === null || packageMetadata === void 0 ? void 0 : packageMetadata.versions) !== null && _a !== void 0 ? _a : {}), versionRange);
+    if (targetVersion === null) {
+        throw new Error(`Failed to find a matching version in npm metadata for package "${packageName}" and requested semver range "${versionRange}"`);
+    }
+    const tarballUrlString = (_d = (_c = (_b = packageMetadata.versions) === null || _b === void 0 ? void 0 : _b[targetVersion]) === null || _c === void 0 ? void 0 : _c.dist) === null || _d === void 0 ? void 0 : _d.tarball;
+    if (!(0, snaps_utils_1.isValidUrl)(tarballUrlString) || !tarballUrlString.endsWith('.tgz')) {
+        throw new Error(`Failed to find valid tarball URL in npm metadata for package "${packageName}".`);
+    }
+    // Override the tarball hostname/protocol with registryUrl hostname/protocol
+    const newRegistryUrl = new URL(registryUrl);
+    const newTarballUrl = new URL(tarballUrlString);
+    newTarballUrl.hostname = newRegistryUrl.hostname;
+    newTarballUrl.protocol = newRegistryUrl.protocol;
+    // Perform a raw fetch because we want the Response object itself.
+    const tarballResponse = await fetchFunction(newTarballUrl.toString());
+    if (!tarballResponse.ok) {
+        throw new Error(`Failed to fetch tarball for package "${packageName}".`);
+    }
+    const stream = await tarballResponse.blob().then((blob) => blob.stream());
+    return [stream, targetVersion];
+}
+//# sourceMappingURL=npm.js.map

package/dist/snaps/utils/npm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"npm.js","sourceRoot":"","sources":["../../../src/snaps/utils/npm.ts"],"names":[],"mappings":";;;;;;AAAA,2CAA2C;AAC3C,gDAAwB;AACxB,gEAA8C;AAC9C,uDAM+B;AAE/B,qCAAwE;AAE3D,QAAA,oBAAoB,GAAG,4BAA4B,CAAC;AAEjE;;;;;;;;;;GAUG;AACI,KAAK,UAAU,YAAY,CAChC,WAAmB,EACnB,YAAoB,EACpB,WAAW,GAAG,4BAAoB,EAClC,aAAa,GAAG,KAAK;IAErB,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,MAAM,eAAe,CAC5D,WAAW,EACX,YAAY,EACZ,WAAW,EACX,aAAa,CACd,CAAC;IAEF,2DAA2D;IAC3D,MAAM,SAAS,GAAyB,EAAE,CAAC;IAC3C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,IAAA,cAAI,EACF,IAAA,sBAAa,EAAC,eAAe,CAAC;QAC9B,4EAA4E;QAC5E,iDAAiD;QACjD,IAAA,sBAAkB,GAAE,EACpB,IAAA,sCAA6B,EAAC,SAAS,CAAC,EACxC,CAAC,KAAK,EAAE,EAAE;YACR,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACpC,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,2EAA2E;IAC3E,wBAAwB;IACxB,OAAO,IAAA,6BAAe,EACpB,SAAS,EACT,aAAa,WAAW,IAAI,aAAa,sBAAsB,CAChE,CAAC;AACJ,CAAC;AAlCD,oCAkCC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,eAAe,CAC5B,WAAmB,EACnB,YAAoB,EACpB,WAAW,GAAG,4BAAoB,EAClC,aAAa,GAAG,KAAK;;IAErB,MAAM,eAAe,GAAG,MAAM,CAC5B,MAAM,aAAa,CAAC,IAAI,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC,CAClE,CAAC,IAAI,EAAE,CAAC;IAET,IAAI,CAAC,IAAA,gBAAQ,EAAC,eAAe,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CACb,4BAA4B,WAAW,sBAAsB,CAC9D,CAAC;KACH;IAED,MAAM,aAAa,GAAG,IAAA,8BAAgB,EACpC,MAAM,CAAC,IAAI,CAAC,MAAC,eAAuB,aAAvB,eAAe,uBAAf,eAAe,CAAU,QAAQ,mCAAI,EAAE,CAAC,EACrD,YAAY,CACb,CAAC;IAEF,IAAI,aAAa,KAAK,IAAI,EAAE;QAC1B,MAAM,IAAI,KAAK,CACb,kEAAkE,WAAW,iCAAiC,YAAY,GAAG,CAC9H,CAAC;KACH;IAED,MAAM,gBAAgB,GAAG,MAAA,MAAA,MAAC,eAAuB,CAAC,QAAQ,0CAAG,aAAa,CAAC,0CACvE,IAAI,0CAAE,OAAO,CAAC;IAElB,IAAI,CAAC,IAAA,wBAAU,EAAC,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACvE,MAAM,IAAI,KAAK,CACb,iEAAiE,WAAW,IAAI,CACjF,CAAC;KACH;IAED,4EAA4E;IAC5E,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAChD,aAAa,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;IACjD,aAAa,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;IAEjD,kEAAkE;IAClE,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC;IACtE,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,wCAAwC,WAAW,IAAI,CAAC,CAAC;KAC1E;IACD,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAE1E,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AACjC,CAAC","sourcesContent":["import { isObject } from '@metamask/utils';\nimport pump from 'pump';\nimport createGunzipStream from 'gunzip-maybe';\nimport {\n  SnapFiles,\n  UnvalidatedSnapFiles,\n  isValidUrl,\n  getTargetVersion,\n  validateNpmSnap,\n} from '@metamask/snaps-utils';\n\nimport { createTarballExtractionStream, getNodeStream } from './stream';\n\nexport const DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org';\n\n/**\n * Fetches a Snap from the public npm registry.\n *\n * @param packageName - The name of the package whose tarball to fetch.\n * @param versionRange - The SemVer range of the package to fetch. The highest\n * version satisfying the range will be fetched.\n * @param registryUrl - The URL of the npm registry to fetch from.\n * @param fetchFunction - The fetch function to use. Defaults to the global\n * {@link fetch}. Useful for Node.js compatibility.\n * @returns A tuple of the Snap manifest object and the Snap source code.\n */\nexport async function fetchNpmSnap(\n  packageName: string,\n  versionRange: string,\n  registryUrl = DEFAULT_NPM_REGISTRY,\n  fetchFunction = fetch,\n): Promise<SnapFiles> {\n  const [tarballResponse, actualVersion] = await fetchNpmTarball(\n    packageName,\n    versionRange,\n    registryUrl,\n    fetchFunction,\n  );\n\n  // Extract the tarball and get the necessary files from it.\n  const snapFiles: UnvalidatedSnapFiles = {};\n  await new Promise<void>((resolve, reject) => {\n    pump(\n      getNodeStream(tarballResponse),\n      // The \"gz\" in \"tgz\" stands for \"gzip\". The tarball needs to be decompressed\n      // before we can actually grab any files from it.\n      createGunzipStream(),\n      createTarballExtractionStream(snapFiles),\n      (error) => {\n        error ? reject(error) : resolve();\n      },\n    );\n  });\n\n  // At this point, the necessary files will have been added to the snapFiles\n  // object if they exist.\n  return validateNpmSnap(\n    snapFiles,\n    `npm Snap \"${packageName}@${actualVersion}\" validation error: `,\n  );\n}\n\n/**\n * Fetches the tarball (`.tgz` file) of the specified package and version from\n * the public npm registry. Throws an error if fetching fails.\n *\n * @param packageName - The name of the package whose tarball to fetch.\n * @param versionRange - The SemVer range of the package to fetch. The highest\n * version satisfying the range will be fetched.\n * @param registryUrl - The URL of the npm registry to fetch the tarball from.\n * @param fetchFunction - The fetch function to use. Defaults to the global\n * {@link fetch}. Useful for Node.js compatibility.\n * @returns A tuple of the {@link Response} for the package tarball and the\n * actual version of the package.\n */\nasync function fetchNpmTarball(\n  packageName: string,\n  versionRange: string,\n  registryUrl = DEFAULT_NPM_REGISTRY,\n  fetchFunction = fetch,\n): Promise<[ReadableStream, string]> {\n  const packageMetadata = await (\n    await fetchFunction(new URL(packageName, registryUrl).toString())\n  ).json();\n\n  if (!isObject(packageMetadata)) {\n    throw new Error(\n      `Failed to fetch package \"${packageName}\" metadata from npm.`,\n    );\n  }\n\n  const targetVersion = getTargetVersion(\n    Object.keys((packageMetadata as any)?.versions ?? {}),\n    versionRange,\n  );\n\n  if (targetVersion === null) {\n    throw new Error(\n      `Failed to find a matching version in npm metadata for package \"${packageName}\" and requested semver range \"${versionRange}\"`,\n    );\n  }\n\n  const tarballUrlString = (packageMetadata as any).versions?.[targetVersion]\n    ?.dist?.tarball;\n\n  if (!isValidUrl(tarballUrlString) || !tarballUrlString.endsWith('.tgz')) {\n    throw new Error(\n      `Failed to find valid tarball URL in npm metadata for package \"${packageName}\".`,\n    );\n  }\n\n  // Override the tarball hostname/protocol with registryUrl hostname/protocol\n  const newRegistryUrl = new URL(registryUrl);\n  const newTarballUrl = new URL(tarballUrlString);\n  newTarballUrl.hostname = newRegistryUrl.hostname;\n  newTarballUrl.protocol = newRegistryUrl.protocol;\n\n  // Perform a raw fetch because we want the Response object itself.\n  const tarballResponse = await fetchFunction(newTarballUrl.toString());\n  if (!tarballResponse.ok) {\n    throw new Error(`Failed to fetch tarball for package \"${packageName}\".`);\n  }\n  const stream = await tarballResponse.blob().then((blob) => blob.stream());\n\n  return [stream, targetVersion];\n}\n"]}

package/dist/snaps/utils/stream.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="node" />
+import { Readable, Writable } from 'stream';
+import { UnvalidatedSnapFiles } from '@metamask/snaps-utils';
+/**
+ * Strips the leading `./` from a string, or does nothing if no string is
+ * provided.
+ *
+ * @param pathString - The path string to normalize.
+ * @returns The specified path without a `./` prefix, or `undefined` if no
+ * string was provided.
+ */
+export declare function stripDotSlash(pathString?: string): string | undefined;
+/**
+ * Converts a {@link ReadableStream} to a Node.js {@link Readable}
+ * stream. Returns the stream directly if it is already a Node.js stream.
+ * We can't use the native Web {@link ReadableStream} directly because the
+ * other stream libraries we use expect Node.js streams.
+ *
+ * @param stream - The stream to convert.
+ * @returns The given stream as a Node.js Readable stream.
+ */
+export declare function getNodeStream(stream: ReadableStream): Readable;
+/**
+ * Creates a `tar-stream` that will get the necessary files from an npm Snap
+ * package tarball (`.tgz` file).
+ *
+ * @param snapFiles - An object to write target file contents to.
+ * @returns The {@link Writable} tarball extraction stream.
+ */
+export declare function createTarballExtractionStream(snapFiles: UnvalidatedSnapFiles): Writable;

package/dist/snaps/utils/stream.js

@@ -0,0 +1,124 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTarballExtractionStream = exports.getNodeStream = exports.stripDotSlash = void 0;
+const readable_web_to_node_stream_1 = require("readable-web-to-node-stream");
+const tar_stream_1 = require("tar-stream");
+const concat_stream_1 = __importDefault(require("concat-stream"));
+const utils_1 = require("@metamask/utils");
+const snaps_utils_1 = require("@metamask/snaps-utils");
+// The paths of files within npm tarballs appear to always be prefixed with
+// "package/".
+const NPM_TARBALL_PATH_PREFIX = /^package\//u;
+/**
+ * Strips the leading `./` from a string, or does nothing if no string is
+ * provided.
+ *
+ * @param pathString - The path string to normalize.
+ * @returns The specified path without a `./` prefix, or `undefined` if no
+ * string was provided.
+ */
+function stripDotSlash(pathString) {
+    return pathString === null || pathString === void 0 ? void 0 : pathString.replace(/^\.\//u, '');
+}
+exports.stripDotSlash = stripDotSlash;
+/**
+ * Converts a {@link ReadableStream} to a Node.js {@link Readable}
+ * stream. Returns the stream directly if it is already a Node.js stream.
+ * We can't use the native Web {@link ReadableStream} directly because the
+ * other stream libraries we use expect Node.js streams.
+ *
+ * @param stream - The stream to convert.
+ * @returns The given stream as a Node.js Readable stream.
+ */
+function getNodeStream(stream) {
+    if (typeof stream.getReader !== 'function') {
+        return stream;
+    }
+    return new readable_web_to_node_stream_1.ReadableWebToNodeStream(stream);
+}
+exports.getNodeStream = getNodeStream;
+/**
+ * Creates a `tar-stream` that will get the necessary files from an npm Snap
+ * package tarball (`.tgz` file).
+ *
+ * @param snapFiles - An object to write target file contents to.
+ * @returns The {@link Writable} tarball extraction stream.
+ */
+function createTarballExtractionStream(snapFiles) {
+    // `tar-stream` is pretty old-school, so we create it first and then
+    // instrument it by adding event listeners.
+    const extractStream = (0, tar_stream_1.extract)();
+    // `tar-stream` reads every file in the tarball serially. We already know
+    // where to look for package.json and the Snap manifest, but we don't know
+    // where the source code is. Therefore, we cache the contents of each .js
+    // file in the tarball and pick out the correct one when the stream has ended.
+    const jsFileCache = new Map();
+    // "entry" is fired for every discreet entity in the tarball. This includes
+    // files and folders.
+    extractStream.on('entry', (header, entryStream, next) => {
+        const { name: headerName, type: headerType } = header;
+        if (headerType === 'file') {
+            // The name is a path if the header type is "file".
+            const filePath = headerName.replace(NPM_TARBALL_PATH_PREFIX, '');
+            // Note the use of `concat-stream` since the data for each file may be
+            // chunked.
+            if (filePath === snaps_utils_1.NpmSnapFileNames.PackageJson) {
+                return entryStream.pipe((0, concat_stream_1.default)((data) => {
+                    try {
+                        snapFiles.packageJson = JSON.parse(data.toString());
+                    }
+                    catch (_error) {
+                        return extractStream.destroy(new Error(`Failed to parse "${snaps_utils_1.NpmSnapFileNames.PackageJson}".`));
+                    }
+                    return next();
+                }));
+            }
+            else if (filePath === snaps_utils_1.NpmSnapFileNames.Manifest) {
+                return entryStream.pipe((0, concat_stream_1.default)((data) => {
+                    try {
+                        snapFiles.manifest = JSON.parse(data.toString());
+                    }
+                    catch (_error) {
+                        return extractStream.destroy(new Error(`Failed to parse "${snaps_utils_1.NpmSnapFileNames.Manifest}".`));
+                    }
+                    return next();
+                }));
+            }
+            else if (/\w+\.(?:js|svg)$/u.test(filePath)) {
+                return entryStream.pipe((0, concat_stream_1.default)((data) => {
+                    jsFileCache.set(filePath, data);
+                    return next();
+                }));
+            }
+        }
+        // If we get here, the entry is not a file, and we want to ignore. The entry
+        // stream must be drained, or the extractStream will stop reading. This is
+        // effectively a no-op for the current entry.
+        entryStream.on('end', () => next());
+        return entryStream.resume();
+    });
+    // Once we've read the entire tarball, attempt to grab the bundle file
+    // contents from the .js file cache.
+    extractStream.once('finish', () => {
+        var _a, _b, _c, _d, _e;
+        if ((0, utils_1.isObject)(snapFiles.manifest)) {
+            /* istanbul ignore next: optional chaining */
+            const { filePath: _bundlePath, iconPath: _iconPath } = (_c = (_b = (_a = snapFiles.manifest.source) === null || _a === void 0 ? void 0 : _a.location) === null || _b === void 0 ? void 0 : _b.npm) !== null && _c !== void 0 ? _c : {};
+            const bundlePath = stripDotSlash(_bundlePath);
+            const iconPath = stripDotSlash(_iconPath);
+            if (bundlePath) {
+                snapFiles.sourceCode = (_d = jsFileCache.get(bundlePath)) === null || _d === void 0 ? void 0 : _d.toString('utf8');
+            }
+            if (typeof iconPath === 'string' && iconPath.endsWith('.svg')) {
+                snapFiles.svgIcon = (_e = jsFileCache.get(iconPath)) === null || _e === void 0 ? void 0 : _e.toString('utf8');
+            }
+        }
+        jsFileCache.clear();
+    });
+    return extractStream;
+}
+exports.createTarballExtractionStream = createTarballExtractionStream;
+//# sourceMappingURL=stream.js.map

package/dist/snaps/utils/stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../src/snaps/utils/stream.ts"],"names":[],"mappings":";;;;;;AACA,6EAAsE;AACtE,2CAAmD;AACnD,kEAAmC;AACnC,2CAA2C;AAC3C,uDAI+B;AAE/B,2EAA2E;AAC3E,cAAc;AACd,MAAM,uBAAuB,GAAG,aAAa,CAAC;AAE9C;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,UAAmB;IAC/C,OAAO,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AAC3C,CAAC;AAFD,sCAEC;AAED;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAAC,MAAsB;IAClD,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,EAAE;QAC1C,OAAO,MAA6B,CAAC;KACtC;IAED,OAAO,IAAI,qDAAuB,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC;AAND,sCAMC;AAED;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAC3C,SAA+B;IAE/B,oEAAoE;IACpE,2CAA2C;IAC3C,MAAM,aAAa,GAAG,IAAA,oBAAU,GAAE,CAAC;IAEnC,yEAAyE;IACzE,0EAA0E;IAC1E,yEAAyE;IACzE,8EAA8E;IAC9E,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9C,2EAA2E;IAC3E,qBAAqB;IACrB,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;QACtD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACtD,IAAI,UAAU,KAAK,MAAM,EAAE;YACzB,mDAAmD;YACnD,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;YAEjE,sEAAsE;YACtE,WAAW;YACX,IAAI,QAAQ,KAAK,8BAAgB,CAAC,WAAW,EAAE;gBAC7C,OAAO,WAAW,CAAC,IAAI,CACrB,IAAA,uBAAM,EAAC,CAAC,IAAI,EAAE,EAAE;oBACd,IAAI;wBACF,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;qBACrD;oBAAC,OAAO,MAAM,EAAE;wBACf,OAAO,aAAa,CAAC,OAAO,CAC1B,IAAI,KAAK,CAAC,oBAAoB,8BAAgB,CAAC,WAAW,IAAI,CAAC,CAChE,CAAC;qBACH;oBAED,OAAO,IAAI,EAAE,CAAC;gBAChB,CAAC,CAAC,CACH,CAAC;aACH;iBAAM,IAAI,QAAQ,KAAK,8BAAgB,CAAC,QAAQ,EAAE;gBACjD,OAAO,WAAW,CAAC,IAAI,CACrB,IAAA,uBAAM,EAAC,CAAC,IAAI,EAAE,EAAE;oBACd,IAAI;wBACF,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;qBAClD;oBAAC,OAAO,MAAM,EAAE;wBACf,OAAO,aAAa,CAAC,OAAO,CAC1B,IAAI,KAAK,CAAC,oBAAoB,8BAAgB,CAAC,QAAQ,IAAI,CAAC,CAC7D,CAAC;qBACH;oBAED,OAAO,IAAI,EAAE,CAAC;gBAChB,CAAC,CAAC,CACH,CAAC;aACH;iBAAM,IAAI,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBAC7C,OAAO,WAAW,CAAC,IAAI,CACrB,IAAA,uBAAM,EAAC,CAAC,IAAI,EAAE,EAAE;oBACd,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;oBAChC,OAAO,IAAI,EAAE,CAAC;gBAChB,CAAC,CAAC,CACH,CAAC;aACH;SACF;QAED,4EAA4E;QAC5E,0EAA0E;QAC1E,6CAA6C;QAC7C,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QACpC,OAAO,WAAW,CAAC,MAAM,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,sEAAsE;IACtE,oCAAoC;IACpC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE;;QAChC,IAAI,IAAA,gBAAQ,EAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;YAChC,6CAA6C;YAC7C,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,GAClD,MAAA,MAAA,MAAC,SAAS,CAAC,QAA6C,CAAC,MAAM,0CAC3D,QAAQ,0CAAE,GAAG,mCAAI,EAAE,CAAC;YAE1B,MAAM,UAAU,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;YAE1C,IAAI,UAAU,EAAE;gBACd,SAAS,CAAC,UAAU,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;aACtE;YAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAC7D,SAAS,CAAC,OAAO,GAAG,MAAA,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,0CAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;aACjE;SACF;QACD,WAAW,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC;AACvB,CAAC;AA5FD,sEA4FC","sourcesContent":["import { Readable, Writable } from 'stream';\nimport { ReadableWebToNodeStream } from 'readable-web-to-node-stream';\nimport { extract as tarExtract } from 'tar-stream';\nimport concat from 'concat-stream';\nimport { isObject } from '@metamask/utils';\nimport {\n  SnapManifest,\n  NpmSnapFileNames,\n  UnvalidatedSnapFiles,\n} from '@metamask/snaps-utils';\n\n// The paths of files within npm tarballs appear to always be prefixed with\n// \"package/\".\nconst NPM_TARBALL_PATH_PREFIX = /^package\\//u;\n\n/**\n * Strips the leading `./` from a string, or does nothing if no string is\n * provided.\n *\n * @param pathString - The path string to normalize.\n * @returns The specified path without a `./` prefix, or `undefined` if no\n * string was provided.\n */\nexport function stripDotSlash(pathString?: string): string | undefined {\n  return pathString?.replace(/^\\.\\//u, '');\n}\n\n/**\n * Converts a {@link ReadableStream} to a Node.js {@link Readable}\n * stream. Returns the stream directly if it is already a Node.js stream.\n * We can't use the native Web {@link ReadableStream} directly because the\n * other stream libraries we use expect Node.js streams.\n *\n * @param stream - The stream to convert.\n * @returns The given stream as a Node.js Readable stream.\n */\nexport function getNodeStream(stream: ReadableStream): Readable {\n  if (typeof stream.getReader !== 'function') {\n    return stream as unknown as Readable;\n  }\n\n  return new ReadableWebToNodeStream(stream);\n}\n\n/**\n * Creates a `tar-stream` that will get the necessary files from an npm Snap\n * package tarball (`.tgz` file).\n *\n * @param snapFiles - An object to write target file contents to.\n * @returns The {@link Writable} tarball extraction stream.\n */\nexport function createTarballExtractionStream(\n  snapFiles: UnvalidatedSnapFiles,\n): Writable {\n  // `tar-stream` is pretty old-school, so we create it first and then\n  // instrument it by adding event listeners.\n  const extractStream = tarExtract();\n\n  // `tar-stream` reads every file in the tarball serially. We already know\n  // where to look for package.json and the Snap manifest, but we don't know\n  // where the source code is. Therefore, we cache the contents of each .js\n  // file in the tarball and pick out the correct one when the stream has ended.\n  const jsFileCache = new Map<string, Buffer>();\n\n  // \"entry\" is fired for every discreet entity in the tarball. This includes\n  // files and folders.\n  extractStream.on('entry', (header, entryStream, next) => {\n    const { name: headerName, type: headerType } = header;\n    if (headerType === 'file') {\n      // The name is a path if the header type is \"file\".\n      const filePath = headerName.replace(NPM_TARBALL_PATH_PREFIX, '');\n\n      // Note the use of `concat-stream` since the data for each file may be\n      // chunked.\n      if (filePath === NpmSnapFileNames.PackageJson) {\n        return entryStream.pipe(\n          concat((data) => {\n            try {\n              snapFiles.packageJson = JSON.parse(data.toString());\n            } catch (_error) {\n              return extractStream.destroy(\n                new Error(`Failed to parse \"${NpmSnapFileNames.PackageJson}\".`),\n              );\n            }\n\n            return next();\n          }),\n        );\n      } else if (filePath === NpmSnapFileNames.Manifest) {\n        return entryStream.pipe(\n          concat((data) => {\n            try {\n              snapFiles.manifest = JSON.parse(data.toString());\n            } catch (_error) {\n              return extractStream.destroy(\n                new Error(`Failed to parse \"${NpmSnapFileNames.Manifest}\".`),\n              );\n            }\n\n            return next();\n          }),\n        );\n      } else if (/\\w+\\.(?:js|svg)$/u.test(filePath)) {\n        return entryStream.pipe(\n          concat((data) => {\n            jsFileCache.set(filePath, data);\n            return next();\n          }),\n        );\n      }\n    }\n\n    // If we get here, the entry is not a file, and we want to ignore. The entry\n    // stream must be drained, or the extractStream will stop reading. This is\n    // effectively a no-op for the current entry.\n    entryStream.on('end', () => next());\n    return entryStream.resume();\n  });\n\n  // Once we've read the entire tarball, attempt to grab the bundle file\n  // contents from the .js file cache.\n  extractStream.once('finish', () => {\n    if (isObject(snapFiles.manifest)) {\n      /* istanbul ignore next: optional chaining */\n      const { filePath: _bundlePath, iconPath: _iconPath } =\n        (snapFiles.manifest as unknown as Partial<SnapManifest>).source\n          ?.location?.npm ?? {};\n\n      const bundlePath = stripDotSlash(_bundlePath);\n      const iconPath = stripDotSlash(_iconPath);\n\n      if (bundlePath) {\n        snapFiles.sourceCode = jsFileCache.get(bundlePath)?.toString('utf8');\n      }\n\n      if (typeof iconPath === 'string' && iconPath.endsWith('.svg')) {\n        snapFiles.svgIcon = jsFileCache.get(iconPath)?.toString('utf8');\n      }\n    }\n    jsFileCache.clear();\n  });\n\n  return extractStream;\n}\n"]}

package/dist/utils.d.ts

@@ -0,0 +1,128 @@
+import { Timer } from './snaps/Timer';
+/**
+ * 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 declare function setDiff<ObjectA extends Record<any, unknown>, ObjectB extends Record<any, unknown>>(objectA: ObjectA, objectB: ObjectB): Diff<ObjectA, ObjectB>;
+/**
+ * A Promise that delays it's 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 declare function delay<Result = void>(ms: number, result?: Result): Promise<Result> & {
+    cancel: () => void;
+};
+/**
+ * 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 declare function delayWithTimer<Result = void>(timer: Timer, result?: Result): Promise<Result> & {
+    cancel: () => void;
+};
+export declare const hasTimedOut: unique symbol;
+/**
+ * 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 declare function withTimeout<PromiseValue = void>(promise: Promise<PromiseValue>, timerOrMs: Timer | number): Promise<PromiseValue | typeof hasTimedOut>;
+/**
+ * Checks whether the type is composed of literal types
+ *
+ * @returns @type {true} if whole type is composed of literals, @type {false} if whole type is not literals, @type {boolean} if mixed
+ * @example
+ * ```
+ * type t1 = IsLiteral<1 | 2 | "asd" | true>;
+ * // t1 = true
+ *
+ * type t2 = IsLiteral<number | string>;
+ * // t2 = false
+ *
+ * type t3 = IsLiteral<1 | string>;
+ * // t3 = boolean
+ *
+ * const s = Symbol();
+ * type t4 = IsLiteral<typeof s>;
+ * // t4 = true
+ *
+ * type t5 = IsLiteral<symbol>
+ * // t5 = false;
+ * ```
+ */
+declare type IsLiteral<T> = T extends string | number | boolean | symbol ? Extract<string | number | boolean | symbol, T> extends never ? true : false : false;
+/**
+ * Returns all keys of an object, that are literal, as an union
+ *
+ * @example
+ * ```
+ * type t1 = _LiteralKeys<{a: number, b: 0, c: 'foo', d: string}>
+ * // t1 = 'b' | 'c'
+ * ```
+ * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}
+ */
+declare type _LiteralKeys<T> = NonNullable<{
+    [Key in keyof T]: IsLiteral<Key> extends true ? Key : never;
+}[keyof T]>;
+/**
+ * Returns all keys of an object, that are not literal, as an union
+ *
+ * @example
+ * ```
+ * type t1 = _NonLiteralKeys<{a: number, b: 0, c: 'foo', d: string}>
+ * // t1 = 'a' | 'd'
+ * ```
+ * @see [Literal types]{@link https://www.typescriptlang.org/docs/handbook/literal-types.html}
+ */
+declare type _NonLiteralKeys<T> = NonNullable<{
+    [Key in keyof T]: IsLiteral<Key> extends false ? Key : never;
+}[keyof T]>;
+/**
+ * A set difference of two objects based on their keys
+ *
+ * @example
+ * ```
+ * type t1 = Diff<{a: string, b: string}, {a: number}>
+ * // t1 = {b: string};
+ * type t2 = Diff<{a: string, 0: string}, Record<string, unknown>>;
+ * // t2 = { a?: string, 0: string};
+ * type t3 = Diff<{a: string, 0: string, 1: string}, Record<1 | string, unknown>>;
+ * // t3 = {a?: string, 0: string}
+ * ```
+ * @see {@link setDiff} for the main use-case
+ */
+export declare type Diff<A, B> = Omit<A, _LiteralKeys<B>> & Partial<Pick<A, Extract<keyof A, _NonLiteralKeys<B>>>>;
+/**
+ * Makes every specified property of the specified object type mutable.
+ *
+ * @template T - The object whose readonly properties to make mutable.
+ * @template TargetKey - The property key(s) to make mutable.
+ */
+export declare type Mutable<T extends Record<string, unknown>, TargetKey extends string> = {
+    -readonly [Key in keyof Pick<T, TargetKey>]: T[Key];
+} & {
+    [Key in keyof Omit<T, TargetKey>]: T[Key];
+};
+export {};

package/dist/utils.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withTimeout = exports.hasTimedOut = exports.delayWithTimer = exports.delay = exports.setDiff = void 0;
+const Timer_1 = require("./snaps/Timer");
+/**
+ * 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.
+ */
+function setDiff(objectA, objectB) {
+    return Object.entries(objectA).reduce((acc, [key, value]) => {
+        if (!(key in objectB)) {
+            acc[key] = value;
+        }
+        return acc;
+    }, {});
+}
+exports.setDiff = setDiff;
+/**
+ * A Promise that delays it's 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`.
+ */
+function delay(ms, result) {
+    return delayWithTimer(new Timer_1.Timer(ms), result);
+}
+exports.delay = delay;
+/**
+ * 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`.
+ */
+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;
+}
+exports.delayWithTimer = delayWithTimer;
+/*
+ * We use a Symbol instead of rejecting the promise so that Errors thrown
+ * by the main promise will propagate.
+ */
+exports.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.
+ */
+async function withTimeout(promise, timerOrMs) {
+    const timer = typeof timerOrMs === 'number' ? new Timer_1.Timer(timerOrMs) : timerOrMs;
+    const delayPromise = delayWithTimer(timer, exports.hasTimedOut);
+    try {
+        return await Promise.race([promise, delayPromise]);
+    }
+    finally {
+        delayPromise.cancel();
+    }
+}
+exports.withTimeout = withTimeout;
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,yCAAsC;AAEtC;;;;;;;;;;;;;GAaG;AACH,SAAgB,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;YACrB,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SAClB;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACuB,CAAC;AAC9B,CAAC;AAbD,0BAaC;AAED;;;;;;;GAOG;AACH,SAAgB,KAAK,CACnB,EAAU,EACV,MAAe;IAEf,OAAO,cAAc,CAAC,IAAI,aAAK,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AALD,sBAKC;AAED;;;;;;;GAOG;AACH,SAAgB,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;YAC/B,KAAK,CAAC,MAAM,EAAE,CAAC;YACf,UAAU,CAAC,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;SACvD;IACH,CAAC,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAnBD,wCAmBC;AAED;;;GAGG;AACU,QAAA,WAAW,GAAG,MAAM,CAC/B,sEAAsE,CACvE,CAAC;AAEF;;;;;;;;;;GAUG;AACI,KAAK,UAAU,WAAW,CAC/B,OAA8B,EAC9B,SAAyB;IAEzB,MAAM,KAAK,GACT,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,aAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,EAAE,mBAAW,CAAC,CAAC;IACxD,IAAI;QACF,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;KACpD;YAAS;QACR,YAAY,CAAC,MAAM,EAAE,CAAC;KACvB;AACH,CAAC;AAZD,kCAYC","sourcesContent":["import { 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 * A Promise that delays it's 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<T> = T extends string | number | boolean | symbol\n  ? Extract<string | number | boolean | symbol, T> 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<T> = NonNullable<\n  {\n    [Key in keyof T]: IsLiteral<Key> extends true ? Key : never;\n  }[keyof T]\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<T> = NonNullable<\n  {\n    [Key in keyof T]: IsLiteral<Key> extends false ? Key : never;\n  }[keyof T]\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<A, B> = Omit<A, _LiteralKeys<B>> &\n  Partial<Pick<A, Extract<keyof A, _NonLiteralKeys<B>>>>;\n\n/**\n * Makes every specified property of the specified object type mutable.\n *\n * @template T - The object whose readonly properties to make mutable.\n * @template TargetKey - The property key(s) to make mutable.\n */\nexport type Mutable<\n  T extends Record<string, unknown>,\n  TargetKey extends string,\n> = {\n  -readonly [Key in keyof Pick<T, TargetKey>]: T[Key];\n} &\n  {\n    [Key in keyof Omit<T, TargetKey>]: T[Key];\n  };\n"]}

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "@metamask/snaps-controllers",
+  "version": "0.24.0",
+  "description": "Controllers for MetaMask Snaps.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/snaps-monorepo.git"
+  },
+  "main": "dist/index.js",
+  "browser": {
+    "./dist/services": "./dist/services/browser.js"
+  },
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "test:prepare": "yarn mkdirp test/fixtures && ./scripts/generate-fixtures.sh",
+    "test": "yarn test:prepare && jest && yarn posttest",
+    "posttest": "jest-it-up --margin 0.25",
+    "test:ci": "yarn test",
+    "build:tsc": "tsc --project tsconfig.build.json",
+    "build": "yarn build:tsc",
+    "build:clean": "yarn clean && yarn build",
+    "clean": "rimraf '*.tsbuildinfo' 'dist/*'",
+    "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",
+    "publish:package": "../../scripts/publish-package.sh"
+  },
+  "dependencies": {
+    "@metamask/browser-passworder": "^3.0.0",
+    "@metamask/controllers": "^32.0.2",
+    "@metamask/object-multiplex": "^1.1.0",
+    "@metamask/post-message-stream": "^6.0.0",
+    "@metamask/rpc-methods": "^0.24.0",
+    "@metamask/snaps-execution-environments": "^0.24.0",
+    "@metamask/snaps-types": "^0.24.0",
+    "@metamask/snaps-utils": "^0.24.0",
+    "@metamask/utils": "^3.3.1",
+    "@xstate/fsm": "^2.0.0",
+    "concat-stream": "^2.0.0",
+    "cron-parser": "^4.5.0",
+    "eth-rpc-errors": "^4.0.2",
+    "gunzip-maybe": "^1.4.2",
+    "immer": "^9.0.6",
+    "json-rpc-engine": "^6.1.0",
+    "json-rpc-middleware-stream": "^4.2.0",
+    "nanoid": "^3.1.31",
+    "pump": "^3.0.0",
+    "readable-web-to-node-stream": "^3.0.2",
+    "tar-stream": "^2.2.0"
+  },
+  "devDependencies": {
+    "@lavamoat/allow-scripts": "^2.0.3",
+    "@metamask/auto-changelog": "^2.6.0",
+    "@metamask/eslint-config": "^9.0.0",
+    "@metamask/eslint-config-jest": "^9.0.0",
+    "@metamask/eslint-config-nodejs": "^9.0.0",
+    "@metamask/eslint-config-typescript": "^9.0.1",
+    "@metamask/template-snap": "^0.7.0",
+    "@peculiar/webcrypto": "^1.3.3",
+    "@types/concat-stream": "^2.0.0",
+    "@types/gunzip-maybe": "^1.4.0",
+    "@types/jest": "^27.5.1",
+    "@types/pump": "^1.1.1",
+    "@types/readable-stream": "^2.3.9",
+    "@types/tar-stream": "^2.2.2",
+    "deepmerge": "^4.2.2",
+    "eslint": "^7.30.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-jest": "^24.4.0",
+    "eslint-plugin-jsdoc": "^36.1.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^29.0.2",
+    "jest-environment-jsdom": "^29.0.2",
+    "jest-fetch-mock": "^3.0.3",
+    "jest-it-up": "^2.0.0",
+    "jsdom": "^19.0.0",
+    "mkdirp": "^1.0.4",
+    "prettier": "^2.3.2",
+    "prettier-plugin-packagejson": "^2.2.11",
+    "rimraf": "^3.0.2",
+    "serve-handler": "^6.1.5",
+    "ts-jest": "^29.0.0",
+    "typescript": "^4.4.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}