@metamask/snaps-controllers 0.25.0 → 0.26.1

package/dist/snaps/location/http.d.ts

@@ -0,0 +1,21 @@
+import { SnapManifest, VirtualFile } from '@metamask/snaps-utils';
+import { SnapLocation } from './location';
+export interface HttpOptions {
+    /**
+     * @default fetch
+     */
+    fetch?: typeof fetch;
+    fetchOptions?: RequestInit;
+}
+export declare class HttpLocation implements SnapLocation {
+    private readonly cache;
+    private validatedManifest?;
+    private readonly url;
+    private readonly fetchFn;
+    private readonly fetchOptions?;
+    constructor(url: URL, opts?: HttpOptions);
+    manifest(): Promise<VirtualFile<SnapManifest>>;
+    fetch(path: string): Promise<VirtualFile>;
+    get root(): URL;
+    private toCanonical;
+}

package/dist/snaps/location/http.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpLocation = void 0;
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+class HttpLocation {
+    constructor(url, opts = {}) {
+        var _a;
+        // We keep contents separate because then we can use only one Blob in cache,
+        // which we convert to Uint8Array when actually returning the file.
+        //
+        // That avoids deepCloning file contents.
+        // I imagine ArrayBuffers are copy-on-write optimized, meaning
+        // in most often case we'll only have one file contents in common case.
+        this.cache = new Map();
+        (0, utils_1.assertStruct)(url.toString(), snaps_utils_1.HttpSnapIdStruct, 'Invalid Snap Id: ');
+        this.fetchFn = (_a = opts.fetch) !== null && _a !== void 0 ? _a : globalThis.fetch.bind(globalThis);
+        this.fetchOptions = opts.fetchOptions;
+        this.url = url;
+    }
+    async manifest() {
+        if (this.validatedManifest) {
+            return this.validatedManifest.clone();
+        }
+        // jest-fetch-mock doesn't handle new URL(), we need to convert .toString()
+        const canonicalPath = new URL(snaps_utils_1.NpmSnapFileNames.Manifest, this.url).toString();
+        const contents = await (await this.fetchFn(canonicalPath, this.fetchOptions)).text();
+        const manifest = JSON.parse(contents);
+        const vfile = new snaps_utils_1.VirtualFile({
+            value: contents,
+            result: (0, snaps_utils_1.createSnapManifest)(manifest),
+            path: snaps_utils_1.NpmSnapFileNames.Manifest,
+            data: { canonicalPath },
+        });
+        this.validatedManifest = vfile;
+        return this.manifest();
+    }
+    async fetch(path) {
+        const relativePath = (0, snaps_utils_1.normalizeRelative)(path);
+        const cached = this.cache.get(relativePath);
+        if (cached !== undefined) {
+            const { file, contents } = cached;
+            const value = new Uint8Array(await contents.arrayBuffer());
+            const vfile = file.clone();
+            vfile.value = value;
+            return vfile;
+        }
+        const canonicalPath = this.toCanonical(relativePath).toString();
+        const response = await this.fetchFn(canonicalPath, this.fetchOptions);
+        const vfile = new snaps_utils_1.VirtualFile({
+            value: '',
+            path: relativePath,
+            data: { canonicalPath },
+        });
+        const blob = await response.blob();
+        (0, utils_1.assert)(!this.cache.has(relativePath), 'Corrupted cache, multiple files with same path.');
+        this.cache.set(relativePath, { file: vfile, contents: blob });
+        return this.fetch(relativePath);
+    }
+    get root() {
+        return new URL(this.url);
+    }
+    toCanonical(path) {
+        (0, utils_1.assert)(!path.startsWith('/'), 'Tried to parse absolute path.');
+        return new URL(path, this.url);
+    }
+}
+exports.HttpLocation = HttpLocation;
+//# sourceMappingURL=http.js.map

package/dist/snaps/location/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../../src/snaps/location/http.ts"],"names":[],"mappings":";;;AAAA,uDAO+B;AAC/B,2CAAuD;AAYvD,MAAa,YAAY;IAoBvB,YAAY,GAAQ,EAAE,OAAoB,EAAE;;QAnB5C,4EAA4E;QAC5E,mEAAmE;QACnE,EAAE;QACF,yCAAyC;QACzC,8DAA8D;QAC9D,uEAAuE;QACtD,UAAK,GAAG,IAAI,GAAG,EAG7B,CAAC;QAWF,IAAA,oBAAY,EAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,8BAAgB,EAAE,mBAAmB,CAAC,CAAC;QACpE,IAAI,CAAC,OAAO,GAAG,MAAA,IAAI,CAAC,KAAK,mCAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;SACvC;QAED,2EAA2E;QAC3E,MAAM,aAAa,GAAG,IAAI,GAAG,CAC3B,8BAAgB,CAAC,QAAQ,EACzB,IAAI,CAAC,GAAG,CACT,CAAC,QAAQ,EAAE,CAAC;QAEb,MAAM,QAAQ,GAAG,MAAM,CACrB,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,CAAC,CACrD,CAAC,IAAI,EAAE,CAAC;QACT,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,yBAAW,CAAe;YAC1C,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,IAAA,gCAAkB,EAAC,QAAQ,CAAC;YACpC,IAAI,EAAE,8BAAgB,CAAC,QAAQ;YAC/B,IAAI,EAAE,EAAE,aAAa,EAAE;SACxB,CAAC,CAAC;QACH,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;QAE/B,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAY;QACtB,MAAM,YAAY,GAAG,IAAA,+BAAiB,EAAC,IAAI,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC5C,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;YAClC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;YAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;YAC3B,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;YACpB,OAAO,KAAK,CAAC;SACd;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACtE,MAAM,KAAK,GAAG,IAAI,yBAAW,CAAC;YAC5B,KAAK,EAAE,EAAE;YACT,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,EAAE,aAAa,EAAE;SACxB,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAA,cAAM,EACJ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,EAC7B,iDAAiD,CAClD,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAE9D,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEO,WAAW,CAAC,IAAY;QAC9B,IAAA,cAAM,EAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,+BAA+B,CAAC,CAAC;QAC/D,OAAO,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACF;AAzFD,oCAyFC","sourcesContent":["import {\n  SnapManifest,\n  VirtualFile,\n  HttpSnapIdStruct,\n  NpmSnapFileNames,\n  createSnapManifest,\n  normalizeRelative,\n} from '@metamask/snaps-utils';\nimport { assert, assertStruct } from '@metamask/utils';\n\nimport { SnapLocation } from './location';\n\nexport interface HttpOptions {\n  /**\n   * @default fetch\n   */\n  fetch?: typeof fetch;\n  fetchOptions?: RequestInit;\n}\n\nexport class HttpLocation implements SnapLocation {\n  // We keep contents separate because then we can use only one Blob in cache,\n  // which we convert to Uint8Array when actually returning the file.\n  //\n  // That avoids deepCloning file contents.\n  // I imagine ArrayBuffers are copy-on-write optimized, meaning\n  // in most often case we'll only have one file contents in common case.\n  private readonly cache = new Map<\n    string,\n    { file: VirtualFile; contents: Blob }\n  >();\n\n  private validatedManifest?: VirtualFile<SnapManifest>;\n\n  private readonly url: URL;\n\n  private readonly fetchFn: typeof fetch;\n\n  private readonly fetchOptions?: RequestInit;\n\n  constructor(url: URL, opts: HttpOptions = {}) {\n    assertStruct(url.toString(), HttpSnapIdStruct, 'Invalid Snap Id: ');\n    this.fetchFn = opts.fetch ?? globalThis.fetch.bind(globalThis);\n    this.fetchOptions = opts.fetchOptions;\n    this.url = url;\n  }\n\n  async manifest(): Promise<VirtualFile<SnapManifest>> {\n    if (this.validatedManifest) {\n      return this.validatedManifest.clone();\n    }\n\n    // jest-fetch-mock doesn't handle new URL(), we need to convert .toString()\n    const canonicalPath = new URL(\n      NpmSnapFileNames.Manifest,\n      this.url,\n    ).toString();\n\n    const contents = await (\n      await this.fetchFn(canonicalPath, this.fetchOptions)\n    ).text();\n    const manifest = JSON.parse(contents);\n    const vfile = new VirtualFile<SnapManifest>({\n      value: contents,\n      result: createSnapManifest(manifest),\n      path: NpmSnapFileNames.Manifest,\n      data: { canonicalPath },\n    });\n    this.validatedManifest = vfile;\n\n    return this.manifest();\n  }\n\n  async fetch(path: string): Promise<VirtualFile> {\n    const relativePath = normalizeRelative(path);\n    const cached = this.cache.get(relativePath);\n    if (cached !== undefined) {\n      const { file, contents } = cached;\n      const value = new Uint8Array(await contents.arrayBuffer());\n      const vfile = file.clone();\n      vfile.value = value;\n      return vfile;\n    }\n\n    const canonicalPath = this.toCanonical(relativePath).toString();\n    const response = await this.fetchFn(canonicalPath, this.fetchOptions);\n    const vfile = new VirtualFile({\n      value: '',\n      path: relativePath,\n      data: { canonicalPath },\n    });\n    const blob = await response.blob();\n    assert(\n      !this.cache.has(relativePath),\n      'Corrupted cache, multiple files with same path.',\n    );\n    this.cache.set(relativePath, { file: vfile, contents: blob });\n\n    return this.fetch(relativePath);\n  }\n\n  get root(): URL {\n    return new URL(this.url);\n  }\n\n  private toCanonical(path: string): URL {\n    assert(!path.startsWith('/'), 'Tried to parse absolute path.');\n    return new URL(path, this.url);\n  }\n}\n"]}

package/dist/snaps/location/index.d.ts

@@ -0,0 +1,4 @@
+export * from './location';
+export * from './npm';
+export * from './local';
+export * from './http';

package/dist/snaps/{utils → location}/index.js

@@ -14,6 +14,8 @@ 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("./location"), exports);
 __exportStar(require("./npm"), exports);
-__exportStar(require("./stream"), exports);
+__exportStar(require("./local"), exports);
+__exportStar(require("./http"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/snaps/location/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,wCAAsB;AACtB,0CAAwB;AACxB,yCAAuB","sourcesContent":["export * from './location';\nexport * from './npm';\nexport * from './local';\nexport * from './http';\n"]}

package/dist/snaps/location/local.d.ts

@@ -0,0 +1,10 @@
+import { SnapManifest, VirtualFile } from '@metamask/snaps-utils';
+import { HttpOptions } from './http';
+import { SnapLocation } from './location';
+export declare class LocalLocation implements SnapLocation {
+    #private;
+    constructor(url: URL, opts?: HttpOptions);
+    manifest(): Promise<VirtualFile<SnapManifest>>;
+    fetch(path: string): Promise<VirtualFile>;
+    get shouldAlwaysReload(): boolean;
+}

package/dist/snaps/location/local.js

@@ -0,0 +1,51 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _LocalLocation_http;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalLocation = void 0;
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const http_1 = require("./http");
+class LocalLocation {
+    constructor(url, opts = {}) {
+        _LocalLocation_http.set(this, void 0);
+        (0, utils_1.assertStruct)(url.toString(), snaps_utils_1.LocalSnapIdStruct, 'Invalid Snap Id');
+        // TODO(ritave): Write deepMerge() which merges fetchOptions.
+        (0, utils_1.assert)(opts.fetchOptions === undefined, 'Currently adding fetch options to local: is unsupported.');
+        __classPrivateFieldSet(this, _LocalLocation_http, new http_1.HttpLocation(new URL(url.toString().slice(snaps_utils_1.SnapIdPrefixes.local.length)), Object.assign(Object.assign({}, opts), { fetchOptions: { cache: 'no-cache' } })), "f");
+    }
+    async manifest() {
+        const vfile = await __classPrivateFieldGet(this, _LocalLocation_http, "f").manifest();
+        return convertCanonical(vfile);
+    }
+    async fetch(path) {
+        return convertCanonical(await __classPrivateFieldGet(this, _LocalLocation_http, "f").fetch(path));
+    }
+    get shouldAlwaysReload() {
+        return true;
+    }
+}
+exports.LocalLocation = LocalLocation;
+_LocalLocation_http = new WeakMap();
+/**
+ * Converts vfiles with canonical `http:` paths into `local:` paths.
+ *
+ * @param vfile - The {@link VirtualFile} to convert.
+ * @returns The same object with updated `.data.canonicalPath`.
+ */
+function convertCanonical(vfile) {
+    (0, utils_1.assert)(vfile.data.canonicalPath !== undefined);
+    vfile.data.canonicalPath = `local:${vfile.data.canonicalPath}`;
+    return vfile;
+}
+//# sourceMappingURL=local.js.map

package/dist/snaps/location/local.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.js","sourceRoot":"","sources":["../../../src/snaps/location/local.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAK+B;AAC/B,2CAAuD;AAEvD,iCAAmD;AAGnD,MAAa,aAAa;IAGxB,YAAY,GAAQ,EAAE,OAAoB,EAAE;QAF5C,sCAA6B;QAG3B,IAAA,oBAAY,EAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,+BAAiB,EAAE,iBAAiB,CAAC,CAAC;QACnE,6DAA6D;QAC7D,IAAA,cAAM,EACJ,IAAI,CAAC,YAAY,KAAK,SAAS,EAC/B,0DAA0D,CAC3D,CAAC;QAEF,uBAAA,IAAI,uBAAS,IAAI,mBAAY,CAC3B,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,4BAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,kCACrD,IAAI,KAAE,YAAY,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,IAC/C,MAAA,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,KAAK,GAAG,MAAM,uBAAA,IAAI,2BAAM,CAAC,QAAQ,EAAE,CAAC;QAE1C,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAY;QACtB,OAAO,gBAAgB,CAAC,MAAM,uBAAA,IAAI,2BAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA9BD,sCA8BC;;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,KAA0B;IAE1B,IAAA,cAAM,EAAC,KAAK,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC;IAC/C,KAAK,CAAC,IAAI,CAAC,aAAa,GAAG,SAAS,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IAC/D,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import {\n  LocalSnapIdStruct,\n  SnapIdPrefixes,\n  SnapManifest,\n  VirtualFile,\n} from '@metamask/snaps-utils';\nimport { assert, assertStruct } from '@metamask/utils';\n\nimport { HttpLocation, HttpOptions } from './http';\nimport { SnapLocation } from './location';\n\nexport class LocalLocation implements SnapLocation {\n  readonly #http: HttpLocation;\n\n  constructor(url: URL, opts: HttpOptions = {}) {\n    assertStruct(url.toString(), LocalSnapIdStruct, 'Invalid Snap Id');\n    // TODO(ritave): Write deepMerge() which merges fetchOptions.\n    assert(\n      opts.fetchOptions === undefined,\n      'Currently adding fetch options to local: is unsupported.',\n    );\n\n    this.#http = new HttpLocation(\n      new URL(url.toString().slice(SnapIdPrefixes.local.length)),\n      { ...opts, fetchOptions: { cache: 'no-cache' } },\n    );\n  }\n\n  async manifest(): Promise<VirtualFile<SnapManifest>> {\n    const vfile = await this.#http.manifest();\n\n    return convertCanonical(vfile);\n  }\n\n  async fetch(path: string): Promise<VirtualFile> {\n    return convertCanonical(await this.#http.fetch(path));\n  }\n\n  get shouldAlwaysReload() {\n    return true;\n  }\n}\n\n/**\n * Converts vfiles with canonical `http:` paths into `local:` paths.\n *\n * @param vfile - The {@link VirtualFile} to convert.\n * @returns The same object with updated `.data.canonicalPath`.\n */\nfunction convertCanonical<Result>(\n  vfile: VirtualFile<Result>,\n): VirtualFile<Result> {\n  assert(vfile.data.canonicalPath !== undefined);\n  vfile.data.canonicalPath = `local:${vfile.data.canonicalPath}`;\n  return vfile;\n}\n"]}

package/dist/snaps/location/location.d.ts

@@ -0,0 +1,38 @@
+import { SnapManifest, VirtualFile } from '@metamask/snaps-utils';
+import { NpmOptions } from './npm';
+declare module '@metamask/snaps-utils' {
+    interface DataMap {
+        /**
+         * Fully qualified, canonical path for the file in {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8 } URI format.
+         */
+        canonicalPath: string;
+    }
+}
+export interface SnapLocation {
+    /**
+     * All files are relative to the manifest, except the manifest itself.
+     */
+    manifest(): Promise<VirtualFile<SnapManifest>>;
+    fetch(path: string): Promise<VirtualFile>;
+    readonly shouldAlwaysReload?: boolean;
+}
+export declare type DetectSnapLocationOptions = NpmOptions & {
+    /**
+     * The function used to fetch data.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * @default false
+     */
+    allowHttp?: boolean;
+};
+/**
+ * Auto-magically detects which SnapLocation object to create based on the provided {@link location}.
+ *
+ * @param location - A {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8} uri.
+ * @param opts - NPM options and feature flags.
+ * @returns SnapLocation based on url.
+ */
+export declare function detectSnapLocation(location: string | URL, opts?: DetectSnapLocationOptions): SnapLocation;

package/dist/snaps/location/location.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectSnapLocation = void 0;
+const utils_1 = require("@metamask/utils");
+const http_1 = require("./http");
+const local_1 = require("./local");
+const npm_1 = require("./npm");
+/**
+ * Auto-magically detects which SnapLocation object to create based on the provided {@link location}.
+ *
+ * @param location - A {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8} uri.
+ * @param opts - NPM options and feature flags.
+ * @returns SnapLocation based on url.
+ */
+function detectSnapLocation(location, opts) {
+    var _a;
+    const allowHttp = (_a = opts === null || opts === void 0 ? void 0 : opts.allowHttp) !== null && _a !== void 0 ? _a : false;
+    const root = new URL(location);
+    switch (root.protocol) {
+        case 'npm:':
+            return new npm_1.NpmLocation(root, opts);
+        case 'local:':
+            return new local_1.LocalLocation(root, opts);
+        case 'http:':
+        case 'https:':
+            (0, utils_1.assert)(allowHttp, new TypeError('Fetching snaps through http/https is disabled.'));
+            return new http_1.HttpLocation(root, opts);
+        default:
+            throw new TypeError(`Unrecognized "${root.protocol}" snap location protocol.`);
+    }
+}
+exports.detectSnapLocation = detectSnapLocation;
+//# sourceMappingURL=location.js.map

package/dist/snaps/location/location.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../../../src/snaps/location/location.ts"],"names":[],"mappings":";;;AACA,2CAAyC;AAEzC,iCAAsC;AACtC,mCAAwC;AACxC,+BAAgD;AAkChD;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAChC,QAAsB,EACtB,IAAgC;;IAEhC,MAAM,SAAS,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,mCAAI,KAAK,CAAC;IAC3C,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC/B,QAAQ,IAAI,CAAC,QAAQ,EAAE;QACrB,KAAK,MAAM;YACT,OAAO,IAAI,iBAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrC,KAAK,QAAQ;YACX,OAAO,IAAI,qBAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvC,KAAK,OAAO,CAAC;QACb,KAAK,QAAQ;YACX,IAAA,cAAM,EACJ,SAAS,EACT,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAChE,CAAC;YACF,OAAO,IAAI,mBAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACtC;YACE,MAAM,IAAI,SAAS,CACjB,iBAAiB,IAAI,CAAC,QAAQ,2BAA2B,CAC1D,CAAC;KACL;AACH,CAAC;AAvBD,gDAuBC","sourcesContent":["import { SnapManifest, VirtualFile } from '@metamask/snaps-utils';\nimport { assert } from '@metamask/utils';\n\nimport { HttpLocation } from './http';\nimport { LocalLocation } from './local';\nimport { NpmLocation, NpmOptions } from './npm';\n\ndeclare module '@metamask/snaps-utils' {\n  interface DataMap {\n    /**\n     * Fully qualified, canonical path for the file in {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8 } URI format.\n     */\n    canonicalPath: string;\n  }\n}\n\nexport interface SnapLocation {\n  /**\n   * All files are relative to the manifest, except the manifest itself.\n   */\n  manifest(): Promise<VirtualFile<SnapManifest>>;\n  fetch(path: string): Promise<VirtualFile>;\n\n  readonly shouldAlwaysReload?: boolean;\n}\n\nexport type DetectSnapLocationOptions = NpmOptions & {\n  /**\n   * The function used to fetch data.\n   *\n   * @default globalThis.fetch\n   */\n  fetch?: typeof fetch;\n  /**\n   * @default false\n   */\n  allowHttp?: boolean;\n};\n\n/**\n * Auto-magically detects which SnapLocation object to create based on the provided {@link location}.\n *\n * @param location - A {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8} uri.\n * @param opts - NPM options and feature flags.\n * @returns SnapLocation based on url.\n */\nexport function detectSnapLocation(\n  location: string | URL,\n  opts?: DetectSnapLocationOptions,\n): SnapLocation {\n  const allowHttp = opts?.allowHttp ?? false;\n  const root = new URL(location);\n  switch (root.protocol) {\n    case 'npm:':\n      return new NpmLocation(root, opts);\n    case 'local:':\n      return new LocalLocation(root, opts);\n    case 'http:':\n    case 'https:':\n      assert(\n        allowHttp,\n        new TypeError('Fetching snaps through http/https is disabled.'),\n      );\n      return new HttpLocation(root, opts);\n    default:\n      throw new TypeError(\n        `Unrecognized \"${root.protocol}\" snap location protocol.`,\n      );\n  }\n}\n"]}

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

@@ -0,0 +1,27 @@
+import { SemVerRange, SnapManifest, VirtualFile } from '@metamask/snaps-utils';
+import { DetectSnapLocationOptions, SnapLocation } from './location';
+export interface NpmOptions {
+    /**
+     * @default DEFAULT_REQUESTED_SNAP_VERSION
+     */
+    versionRange?: SemVerRange;
+    /**
+     * Whether to allow custom NPM registries outside of {@link DEFAULT_NPM_REGISTRY}.
+     *
+     * @default false
+     */
+    allowCustomRegistries?: boolean;
+}
+export declare class NpmLocation implements SnapLocation {
+    #private;
+    private readonly meta;
+    private validatedManifest?;
+    private files?;
+    constructor(url: URL, opts?: DetectSnapLocationOptions);
+    manifest(): Promise<VirtualFile<SnapManifest>>;
+    fetch(path: string): Promise<VirtualFile>;
+    get packageName(): string;
+    get version(): string;
+    get registry(): URL;
+    get versionRange(): SemVerRange;
+}

package/dist/snaps/location/npm.js

@@ -0,0 +1,230 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _NpmLocation_instances, _NpmLocation_lazyInit;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NpmLocation = void 0;
+const snaps_utils_1 = require("@metamask/snaps-utils");
+const utils_1 = require("@metamask/utils");
+const concat_stream_1 = __importDefault(require("concat-stream"));
+const gunzip_maybe_1 = __importDefault(require("gunzip-maybe"));
+const pump_1 = __importDefault(require("pump"));
+const readable_web_to_node_stream_1 = require("readable-web-to-node-stream");
+const tar_stream_1 = require("tar-stream");
+const DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org';
+class NpmLocation {
+    constructor(url, opts = {}) {
+        var _a, _b, _c;
+        _NpmLocation_instances.add(this);
+        const allowCustomRegistries = (_a = opts.allowCustomRegistries) !== null && _a !== void 0 ? _a : false;
+        const fetchFunction = (_b = opts.fetch) !== null && _b !== void 0 ? _b : globalThis.fetch.bind(globalThis);
+        const requestedRange = (_c = opts.versionRange) !== null && _c !== void 0 ? _c : snaps_utils_1.DEFAULT_REQUESTED_SNAP_VERSION;
+        (0, utils_1.assertStruct)(url.toString(), snaps_utils_1.NpmSnapIdStruct, 'Invalid Snap Id: ');
+        let registry;
+        if (url.host === '' &&
+            url.port === '' &&
+            url.username === '' &&
+            url.password === '') {
+            registry = new URL(DEFAULT_NPM_REGISTRY);
+        }
+        else {
+            registry = 'https://';
+            if (url.username) {
+                registry += url.username;
+                if (url.password) {
+                    registry += `:${url.password}`;
+                }
+                registry += '@';
+            }
+            registry += url.host;
+            registry = new URL(registry);
+            (0, utils_1.assert)(allowCustomRegistries, new TypeError(`Custom NPM registries are disabled, tried to use "${registry.toString()}".`));
+        }
+        (0, utils_1.assert)(registry.pathname === '/' &&
+            registry.search === '' &&
+            registry.hash === '');
+        (0, utils_1.assert)(url.pathname !== '' && url.pathname !== '/', new TypeError('The package name in NPM location is empty.'));
+        let packageName = url.pathname;
+        if (packageName.startsWith('/')) {
+            packageName = packageName.slice(1);
+        }
+        this.meta = {
+            requestedRange,
+            registry,
+            packageName,
+            fetch: fetchFunction,
+        };
+    }
+    async manifest() {
+        if (this.validatedManifest) {
+            return this.validatedManifest.clone();
+        }
+        const vfile = await this.fetch('snap.manifest.json');
+        const result = JSON.parse(vfile.toString());
+        vfile.result = (0, snaps_utils_1.createSnapManifest)(result);
+        this.validatedManifest = vfile;
+        return this.manifest();
+    }
+    async fetch(path) {
+        const relativePath = (0, snaps_utils_1.normalizeRelative)(path);
+        if (!this.files) {
+            await __classPrivateFieldGet(this, _NpmLocation_instances, "m", _NpmLocation_lazyInit).call(this);
+            (0, utils_1.assert)(this.files !== undefined);
+        }
+        const vfile = this.files.get(relativePath);
+        (0, utils_1.assert)(vfile !== undefined, new TypeError(`File "${path}" not found in package.`));
+        return vfile.clone();
+    }
+    get packageName() {
+        return this.meta.packageName;
+    }
+    get version() {
+        (0, utils_1.assert)(this.meta.version !== undefined, 'Tried to access version without first fetching NPM package.');
+        return this.meta.version;
+    }
+    get registry() {
+        return this.meta.registry;
+    }
+    get versionRange() {
+        return this.meta.requestedRange;
+    }
+}
+exports.NpmLocation = NpmLocation;
+_NpmLocation_instances = new WeakSet(), _NpmLocation_lazyInit = async function _NpmLocation_lazyInit() {
+    (0, utils_1.assert)(this.files === undefined);
+    const [tarballResponse, actualVersion] = await fetchNpmTarball(this.meta.packageName, this.meta.requestedRange, this.meta.registry, this.meta.fetch);
+    this.meta.version = actualVersion;
+    let canonicalBase = 'npm://';
+    if (this.meta.registry.username !== '') {
+        canonicalBase += this.meta.registry.username;
+        if (this.meta.registry.password !== '') {
+            canonicalBase += `:${this.meta.registry.password}`;
+        }
+        canonicalBase += '@';
+    }
+    canonicalBase += this.meta.registry.host;
+    // TODO(ritave): Lazily extract files instead of up-front extracting all of them
+    //               We would need to replace tar-stream package because it requires immediate consumption of streams.
+    await new Promise((resolve, reject) => {
+        this.files = new Map();
+        (0, pump_1.default)(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)(), createTarballStream(`${canonicalBase}/${this.meta.packageName}/`, this.files), (error) => {
+            error ? reject(error) : resolve();
+        });
+    });
+};
+/**
+ * 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, fetchFunction) {
+    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 versions = Object.keys((_a = packageMetadata === null || packageMetadata === void 0 ? void 0 : packageMetadata.versions) !== null && _a !== void 0 ? _a : {}).map((version) => {
+        (0, snaps_utils_1.assertIsSemVerVersion)(version);
+        return version;
+    });
+    const targetVersion = (0, snaps_utils_1.getTargetVersion)(versions, 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 === null || packageMetadata === void 0 ? void 0 : 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.toString().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 || !tarballResponse.body) {
+        throw new Error(`Failed to fetch tarball for package "${packageName}".`);
+    }
+    return [tarballResponse.body, targetVersion];
+}
+/**
+ * The paths of files within npm tarballs appear to always be prefixed with
+ * "package/".
+ */
+const NPM_TARBALL_PATH_PREFIX = /^package\//u;
+/**
+ * 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);
+}
+/**
+ * Creates a `tar-stream` that will get the necessary files from an npm Snap
+ * package tarball (`.tgz` file).
+ *
+ * @param canonicalBase - A base URI as specified in {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8}. Starting with 'npm:'. Will be used for canonicalPath vfile argument.
+ * @param files - An object to write target file contents to.
+ * @returns The {@link Writable} tarball extraction stream.
+ */
+function createTarballStream(canonicalBase, files) {
+    (0, utils_1.assert)(canonicalBase.endsWith('/'), "Base needs to end with '/' for relative paths to be added as children instead of siblings.");
+    (0, utils_1.assert)(canonicalBase.startsWith('npm:'), 'Protocol mismatch, expected "npm:".');
+    // `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)();
+    // "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 path = headerName.replace(NPM_TARBALL_PATH_PREFIX, '');
+            return entryStream.pipe((0, concat_stream_1.default)((data) => {
+                const vfile = new snaps_utils_1.VirtualFile({
+                    value: data,
+                    path,
+                    data: {
+                        canonicalPath: new URL(path, canonicalBase).toString(),
+                    },
+                });
+                (0, utils_1.assert)(!files.has(path), 'Malformed tarball, multiple files with the same path.');
+                files.set(path, vfile);
+                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();
+    });
+    return extractStream;
+}
+//# sourceMappingURL=npm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"npm.js","sourceRoot":"","sources":["../../../src/snaps/location/npm.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uDAY+B;AAC/B,2CAAiE;AACjE,kEAAmC;AACnC,gEAA8C;AAC9C,gDAAwB;AACxB,6EAAsE;AAEtE,2CAAmD;AAInD,MAAM,oBAAoB,GAAG,4BAA4B,CAAC;AAsB1D,MAAa,WAAW;IAOtB,YAAY,GAAQ,EAAE,OAAkC,EAAE;;;QACxD,MAAM,qBAAqB,GAAG,MAAA,IAAI,CAAC,qBAAqB,mCAAI,KAAK,CAAC;QAClE,MAAM,aAAa,GAAG,MAAA,IAAI,CAAC,KAAK,mCAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtE,MAAM,cAAc,GAAG,MAAA,IAAI,CAAC,YAAY,mCAAI,4CAA8B,CAAC;QAE3E,IAAA,oBAAY,EAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,6BAAe,EAAE,mBAAmB,CAAC,CAAC;QAEnE,IAAI,QAAsB,CAAC;QAC3B,IACE,GAAG,CAAC,IAAI,KAAK,EAAE;YACf,GAAG,CAAC,IAAI,KAAK,EAAE;YACf,GAAG,CAAC,QAAQ,KAAK,EAAE;YACnB,GAAG,CAAC,QAAQ,KAAK,EAAE,EACnB;YACA,QAAQ,GAAG,IAAI,GAAG,CAAC,oBAAoB,CAAC,CAAC;SAC1C;aAAM;YACL,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,GAAG,CAAC,QAAQ,EAAE;gBAChB,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC;gBACzB,IAAI,GAAG,CAAC,QAAQ,EAAE;oBAChB,QAAQ,IAAI,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;iBAChC;gBACD,QAAQ,IAAI,GAAG,CAAC;aACjB;YACD,QAAQ,IAAI,GAAG,CAAC,IAAI,CAAC;YACrB,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC7B,IAAA,cAAM,EACJ,qBAAqB,EACrB,IAAI,SAAS,CACX,qDAAqD,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAC7E,CACF,CAAC;SACH;QAED,IAAA,cAAM,EACJ,QAAQ,CAAC,QAAQ,KAAK,GAAG;YACvB,QAAQ,CAAC,MAAM,KAAK,EAAE;YACtB,QAAQ,CAAC,IAAI,KAAK,EAAE,CACvB,CAAC;QAEF,IAAA,cAAM,EACJ,GAAG,CAAC,QAAQ,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,EAC3C,IAAI,SAAS,CAAC,4CAA4C,CAAC,CAC5D,CAAC;QACF,IAAI,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC/B,IAAI,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC/B,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACpC;QAED,IAAI,CAAC,IAAI,GAAG;YACV,cAAc;YACd,QAAQ;YACR,WAAW;YACX,KAAK,EAAE,aAAa;SACrB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;SACvC;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACrD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC5C,KAAK,CAAC,MAAM,GAAG,IAAA,gCAAkB,EAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,KAAkC,CAAC;QAE5D,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAY;QACtB,MAAM,YAAY,GAAG,IAAA,+BAAiB,EAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,uBAAA,IAAI,qDAAU,MAAd,IAAI,CAAY,CAAC;YACvB,IAAA,cAAM,EAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;SAClC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3C,IAAA,cAAM,EACJ,KAAK,KAAK,SAAS,EACnB,IAAI,SAAS,CAAC,SAAS,IAAI,yBAAyB,CAAC,CACtD,CAAC;QACF,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO;QACT,IAAA,cAAM,EACJ,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,EAC/B,6DAA6D,CAC9D,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;IAClC,CAAC;CAyCF;AAtJD,kCAsJC;gEAvCC,KAAK;IACH,IAAA,cAAM,EAAC,IAAI,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;IACjC,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,MAAM,eAAe,CAC5D,IAAI,CAAC,IAAI,CAAC,WAAW,EACrB,IAAI,CAAC,IAAI,CAAC,cAAc,EACxB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAClB,IAAI,CAAC,IAAI,CAAC,KAAK,CAChB,CAAC;IACF,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC;IAElC,IAAI,aAAa,GAAG,QAAQ,CAAC;IAC7B,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,KAAK,EAAE,EAAE;QACtC,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC7C,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,KAAK,EAAE,EAAE;YACtC,aAAa,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;SACpD;QACD,aAAa,IAAI,GAAG,CAAC;KACtB;IACD,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAEzC,gFAAgF;IAChF,kHAAkH;IAClH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;QACvB,IAAA,cAAI,EACF,aAAa,CAAC,eAAe,CAAC;QAC9B,4EAA4E;QAC5E,iDAAiD;QACjD,IAAA,sBAAkB,GAAE,EACpB,mBAAmB,CACjB,GAAG,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,EAC5C,IAAI,CAAC,KAAK,CACX,EACD,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;AACL,CAAC;AAGH;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,eAAe,CAC5B,WAAmB,EACnB,YAAyB,EACzB,WAAyB,EACzB,aAA2B;;IAE3B,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,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,MAAC,eAAuB,aAAvB,eAAe,uBAAf,eAAe,CAAU,QAAQ,mCAAI,EAAE,CAAC,CAAC,GAAG,CACxE,CAAC,OAAO,EAAE,EAAE;QACV,IAAA,mCAAqB,EAAC,OAAO,CAAC,CAAC;QAC/B,OAAO,OAAO,CAAC;IACjB,CAAC,CACF,CAAC;IAEF,MAAM,aAAa,GAAG,IAAA,8BAAgB,EAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAE/D,IAAI,aAAa,KAAK,IAAI,EAAE;QAC1B,MAAM,IAAI,KAAK,CACb,kEAAkE,WAAW,iCAAiC,YAAY,IAAI,CAC/H,CAAC;KACH;IAED,MAAM,gBAAgB,GAAG,MAAA,MAAA,MAAC,eAAuB,aAAvB,eAAe,uBAAf,eAAe,CAAU,QAAQ,0CAAG,aAAa,CAAC,0CACxE,IAAI,0CAAE,OAAO,CAAC;IAElB,IACE,CAAC,IAAA,wBAAU,EAAC,gBAAgB,CAAC;QAC7B,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAC7C;QACA,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,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE;QAChD,MAAM,IAAI,KAAK,CAAC,wCAAwC,WAAW,IAAI,CAAC,CAAC;KAC1E;IACD,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,uBAAuB,GAAG,aAAa,CAAC;AAE9C;;;;;;;;GAQG;AACH,SAAS,aAAa,CAAC,MAAsB;IAC3C,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,EAAE;QAC1C,OAAO,MAA6B,CAAC;KACtC;IAED,OAAO,IAAI,qDAAuB,CAAC,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAC1B,aAAqB,EACrB,KAA+B;IAE/B,IAAA,cAAM,EACJ,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAC3B,4FAA4F,CAC7F,CAAC;IAEF,IAAA,cAAM,EACJ,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,EAChC,qCAAqC,CACtC,CAAC;IACF,oEAAoE;IACpE,2CAA2C;IAC3C,MAAM,aAAa,GAAG,IAAA,oBAAU,GAAE,CAAC;IAEnC,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,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;YAC7D,OAAO,WAAW,CAAC,IAAI,CACrB,IAAA,uBAAM,EAAC,CAAC,IAAI,EAAE,EAAE;gBACd,MAAM,KAAK,GAAG,IAAI,yBAAW,CAAC;oBAC5B,KAAK,EAAE,IAAI;oBACX,IAAI;oBACJ,IAAI,EAAE;wBACJ,aAAa,EAAE,IAAI,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,QAAQ,EAAE;qBACvD;iBACF,CAAC,CAAC;gBACH,IAAA,cAAM,EACJ,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAChB,uDAAuD,CACxD,CAAC;gBACF,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACvB,OAAO,IAAI,EAAE,CAAC;YAChB,CAAC,CAAC,CACH,CAAC;SACH;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;IACH,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["import {\n  assertIsSemVerVersion,\n  createSnapManifest,\n  DEFAULT_REQUESTED_SNAP_VERSION,\n  getTargetVersion,\n  isValidUrl,\n  NpmSnapIdStruct,\n  SemVerRange,\n  SemVerVersion,\n  SnapManifest,\n  VirtualFile,\n  normalizeRelative,\n} from '@metamask/snaps-utils';\nimport { assert, assertStruct, isObject } from '@metamask/utils';\nimport concat from 'concat-stream';\nimport createGunzipStream from 'gunzip-maybe';\nimport pump from 'pump';\nimport { ReadableWebToNodeStream } from 'readable-web-to-node-stream';\nimport { Readable, Writable } from 'stream';\nimport { extract as tarExtract } from 'tar-stream';\n\nimport { DetectSnapLocationOptions, SnapLocation } from './location';\n\nconst DEFAULT_NPM_REGISTRY = 'https://registry.npmjs.org';\n\ninterface NpmMeta {\n  registry: URL;\n  packageName: string;\n  requestedRange: SemVerRange;\n  version?: string;\n  fetch: typeof fetch;\n}\nexport interface NpmOptions {\n  /**\n   * @default DEFAULT_REQUESTED_SNAP_VERSION\n   */\n  versionRange?: SemVerRange;\n  /**\n   * Whether to allow custom NPM registries outside of {@link DEFAULT_NPM_REGISTRY}.\n   *\n   * @default false\n   */\n  allowCustomRegistries?: boolean;\n}\n\nexport class NpmLocation implements SnapLocation {\n  private readonly meta: NpmMeta;\n\n  private validatedManifest?: VirtualFile<SnapManifest>;\n\n  private files?: Map<string, VirtualFile>;\n\n  constructor(url: URL, opts: DetectSnapLocationOptions = {}) {\n    const allowCustomRegistries = opts.allowCustomRegistries ?? false;\n    const fetchFunction = opts.fetch ?? globalThis.fetch.bind(globalThis);\n    const requestedRange = opts.versionRange ?? DEFAULT_REQUESTED_SNAP_VERSION;\n\n    assertStruct(url.toString(), NpmSnapIdStruct, 'Invalid Snap Id: ');\n\n    let registry: string | URL;\n    if (\n      url.host === '' &&\n      url.port === '' &&\n      url.username === '' &&\n      url.password === ''\n    ) {\n      registry = new URL(DEFAULT_NPM_REGISTRY);\n    } else {\n      registry = 'https://';\n      if (url.username) {\n        registry += url.username;\n        if (url.password) {\n          registry += `:${url.password}`;\n        }\n        registry += '@';\n      }\n      registry += url.host;\n      registry = new URL(registry);\n      assert(\n        allowCustomRegistries,\n        new TypeError(\n          `Custom NPM registries are disabled, tried to use \"${registry.toString()}\".`,\n        ),\n      );\n    }\n\n    assert(\n      registry.pathname === '/' &&\n        registry.search === '' &&\n        registry.hash === '',\n    );\n\n    assert(\n      url.pathname !== '' && url.pathname !== '/',\n      new TypeError('The package name in NPM location is empty.'),\n    );\n    let packageName = url.pathname;\n    if (packageName.startsWith('/')) {\n      packageName = packageName.slice(1);\n    }\n\n    this.meta = {\n      requestedRange,\n      registry,\n      packageName,\n      fetch: fetchFunction,\n    };\n  }\n\n  async manifest(): Promise<VirtualFile<SnapManifest>> {\n    if (this.validatedManifest) {\n      return this.validatedManifest.clone();\n    }\n\n    const vfile = await this.fetch('snap.manifest.json');\n    const result = JSON.parse(vfile.toString());\n    vfile.result = createSnapManifest(result);\n    this.validatedManifest = vfile as VirtualFile<SnapManifest>;\n\n    return this.manifest();\n  }\n\n  async fetch(path: string): Promise<VirtualFile> {\n    const relativePath = normalizeRelative(path);\n    if (!this.files) {\n      await this.#lazyInit();\n      assert(this.files !== undefined);\n    }\n    const vfile = this.files.get(relativePath);\n    assert(\n      vfile !== undefined,\n      new TypeError(`File \"${path}\" not found in package.`),\n    );\n    return vfile.clone();\n  }\n\n  get packageName(): string {\n    return this.meta.packageName;\n  }\n\n  get version(): string {\n    assert(\n      this.meta.version !== undefined,\n      'Tried to access version without first fetching NPM package.',\n    );\n    return this.meta.version;\n  }\n\n  get registry(): URL {\n    return this.meta.registry;\n  }\n\n  get versionRange(): SemVerRange {\n    return this.meta.requestedRange;\n  }\n\n  async #lazyInit() {\n    assert(this.files === undefined);\n    const [tarballResponse, actualVersion] = await fetchNpmTarball(\n      this.meta.packageName,\n      this.meta.requestedRange,\n      this.meta.registry,\n      this.meta.fetch,\n    );\n    this.meta.version = actualVersion;\n\n    let canonicalBase = 'npm://';\n    if (this.meta.registry.username !== '') {\n      canonicalBase += this.meta.registry.username;\n      if (this.meta.registry.password !== '') {\n        canonicalBase += `:${this.meta.registry.password}`;\n      }\n      canonicalBase += '@';\n    }\n    canonicalBase += this.meta.registry.host;\n\n    // TODO(ritave): Lazily extract files instead of up-front extracting all of them\n    //               We would need to replace tar-stream package because it requires immediate consumption of streams.\n    await new Promise<void>((resolve, reject) => {\n      this.files = new Map();\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        createTarballStream(\n          `${canonicalBase}/${this.meta.packageName}/`,\n          this.files,\n        ),\n        (error) => {\n          error ? reject(error) : resolve();\n        },\n      );\n    });\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: SemVerRange,\n  registryUrl: URL | string,\n  fetchFunction: typeof fetch,\n): Promise<[ReadableStream, SemVerVersion]> {\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 versions = Object.keys((packageMetadata as any)?.versions ?? {}).map(\n    (version) => {\n      assertIsSemVerVersion(version);\n      return version;\n    },\n  );\n\n  const targetVersion = getTargetVersion(versions, versionRange);\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 (\n    !isValidUrl(tarballUrlString) ||\n    !tarballUrlString.toString().endsWith('.tgz')\n  ) {\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 || !tarballResponse.body) {\n    throw new Error(`Failed to fetch tarball for package \"${packageName}\".`);\n  }\n  return [tarballResponse.body, targetVersion];\n}\n\n/**\n * The paths of files within npm tarballs appear to always be prefixed with\n * \"package/\".\n */\nconst NPM_TARBALL_PATH_PREFIX = /^package\\//u;\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 */\nfunction 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 canonicalBase - A base URI as specified in {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8}. Starting with 'npm:'. Will be used for canonicalPath vfile argument.\n * @param files - An object to write target file contents to.\n * @returns The {@link Writable} tarball extraction stream.\n */\nfunction createTarballStream(\n  canonicalBase: string,\n  files: Map<string, VirtualFile>,\n): Writable {\n  assert(\n    canonicalBase.endsWith('/'),\n    \"Base needs to end with '/' for relative paths to be added as children instead of siblings.\",\n  );\n\n  assert(\n    canonicalBase.startsWith('npm:'),\n    'Protocol mismatch, expected \"npm:\".',\n  );\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  // \"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 path = headerName.replace(NPM_TARBALL_PATH_PREFIX, '');\n      return entryStream.pipe(\n        concat((data) => {\n          const vfile = new VirtualFile({\n            value: data,\n            path,\n            data: {\n              canonicalPath: new URL(path, canonicalBase).toString(),\n            },\n          });\n          assert(\n            !files.has(path),\n            'Malformed tarball, multiple files with the same path.',\n          );\n          files.set(path, vfile);\n          return next();\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  return extractStream;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/snaps-controllers",
-  "version": "0.25.0",
+  "version": "0.26.1",
   "description": "Controllers for MetaMask Snaps.",
   "repository": {
     "type": "git",
@@ -31,17 +31,17 @@
     "publish:package": "../../scripts/publish-package.sh"
   },
   "dependencies": {
-    "@metamask/approval-controller": "^1.0.0",
-    "@metamask/base-controller": "^1.0.0",
+    "@metamask/approval-controller": "^1.0.1",
+    "@metamask/base-controller": "^1.1.1",
     "@metamask/browser-passworder": "^4.0.2",
     "@metamask/object-multiplex": "^1.1.0",
-    "@metamask/permission-controller": "^1.0.0",
+    "@metamask/permission-controller": "^1.0.1",
     "@metamask/post-message-stream": "^6.0.0",
-    "@metamask/rpc-methods": "^0.25.0",
-    "@metamask/snaps-execution-environments": "^0.25.0",
-    "@metamask/snaps-types": "^0.25.0",
-    "@metamask/snaps-utils": "^0.25.0",
-    "@metamask/subject-metadata-controller": "^1.0.0",
+    "@metamask/rpc-methods": "^0.26.1",
+    "@metamask/snaps-execution-environments": "^0.26.1",
+    "@metamask/snaps-types": "^0.26.1",
+    "@metamask/snaps-utils": "^0.26.1",
+    "@metamask/subject-metadata-controller": "^1.0.1",
     "@metamask/utils": "^3.3.1",
     "@xstate/fsm": "^2.0.0",
     "concat-stream": "^2.0.0",

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

@@ -1,2 +0,0 @@
-export * from './npm';
-export * from './stream';

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

@@ -1 +0,0 @@
-{"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

@@ -1,14 +0,0 @@
-import { SnapFiles, SemVerRange } 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: SemVerRange, registryUrl?: string, fetchFunction?: typeof fetch): Promise<SnapFiles>;