@metamask/snaps-controllers 0.35.1-flask.1 → 1.0.0-prerelease.1

package/dist/services/node/NodeThreadExecutionService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeThreadExecutionService.js","sourceRoot":"","sources":["../../../src/services/node/NodeThreadExecutionService.ts"],"names":[],"mappings":";;;AAAA,uEAGuC;AACvC,wDAAwD;AACxD,mDAAwC;AAExC,0BAAmD;AAEnD,MAAa,0BAA2B,SAAQ,4BAAgC;IACpE,KAAK,CAAC,aAAa;QAI3B,MAAM,MAAM,GAAG,IAAI,uBAAM,CACvB,OAAO,CAAC,OAAO,CACb,8EAA8E,CAC/E,CACF,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,+CAAyB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QACjE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7C,CAAC;IAES,KAAK,CAAC,YAAY,CAAC,UAAuB;QAClD,MAAM,UAAU,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;IACtC,CAAC;CACF;AAjBD,gEAiBC","sourcesContent":["import {\n  ThreadParentMessageStream,\n  BasePostMessageStream,\n} from '@metamask/post-message-stream';\n// eslint-disable-next-line @typescript-eslint/no-shadow\nimport { Worker } from 'worker_threads';\n\nimport { AbstractExecutionService, Job } from '..';\n\nexport class NodeThreadExecutionService extends AbstractExecutionService<Worker> {\n  protected async initEnvStream(): Promise<{\n    worker: Worker;\n    stream: BasePostMessageStream;\n  }> {\n    const worker = new Worker(\n      require.resolve(\n        '@metamask/snaps-execution-environments/dist/browserify/node-thread/bundle.js',\n      ),\n    );\n    const stream = new ThreadParentMessageStream({ thread: worker });\n    return Promise.resolve({ worker, stream });\n  }\n\n  protected async terminateJob(jobWrapper: Job<Worker>): Promise<void> {\n    await jobWrapper.worker.terminate();\n  }\n}\n"]}

package/dist/services/node/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("./NodeProcessExecutionService"), exports);
+__exportStar(require("./NodeThreadExecutionService"), exports);
+//# sourceMappingURL=index.js.map

package/dist/services/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/node/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,+DAA6C","sourcesContent":["export * from './NodeProcessExecutionService';\nexport * from './NodeThreadExecutionService';\n"]}

package/dist/{types/services → services}/offscreen/OffscreenExecutionService.d.ts

@@ -1,5 +1,5 @@
 import { AbstractExecutionService, ExecutionServiceArgs, Job } from '../AbstractExecutionService';
-import { ProxyPostMessageStream } from '../ProxyPostMessageStream';
+import { OffscreenPostMessageStream } from './OffscreenPostMessageStream';
 declare type OffscreenExecutionEnvironmentServiceArgs = {
     documentUrl: URL;
     frameUrl: URL;
@@ -37,7 +37,7 @@ export declare class OffscreenExecutionService extends AbstractExecutionService<
      */
     protected initEnvStream(jobId: string): Promise<{
         worker: string;
-        stream: ProxyPostMessageStream;
+        stream: OffscreenPostMessageStream;
     }>;
     /**
      * Creates the offscreen document to be used as the execution environment.

package/dist/services/offscreen/OffscreenExecutionService.js

@@ -0,0 +1,100 @@
+"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 _OffscreenExecutionService_runtimeStream;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OffscreenExecutionService = void 0;
+const post_message_stream_1 = require("@metamask/post-message-stream");
+const nanoid_1 = require("nanoid");
+const AbstractExecutionService_1 = require("../AbstractExecutionService");
+const OffscreenPostMessageStream_1 = require("./OffscreenPostMessageStream");
+class OffscreenExecutionService extends AbstractExecutionService_1.AbstractExecutionService {
+    /**
+     * Create a new offscreen execution service.
+     *
+     * @param args - The constructor arguments.
+     * @param args.documentUrl - The URL of the offscreen document to use as the
+     * execution environment. This must be a URL relative to the location where
+     * this is called. This cannot be a public (http(s)) URL.
+     * @param args.frameUrl - The URL of the iframe to load inside the offscreen
+     * document.
+     * @param args.messenger - The messenger to use for communication with the
+     * `SnapController`.
+     * @param args.setupSnapProvider - The function to use to set up the snap
+     * provider.
+     */
+    constructor({ documentUrl, frameUrl, messenger, setupSnapProvider, }) {
+        super({
+            messenger,
+            setupSnapProvider,
+        });
+        _OffscreenExecutionService_runtimeStream.set(this, void 0);
+        this.documentUrl = documentUrl;
+        this.frameUrl = frameUrl;
+        __classPrivateFieldSet(this, _OffscreenExecutionService_runtimeStream, new post_message_stream_1.BrowserRuntimePostMessageStream({
+            name: 'parent',
+            target: 'child',
+        }), "f");
+    }
+    /**
+     * Send a termination command to the offscreen document.
+     *
+     * @param job - The job to terminate.
+     */
+    async terminateJob(job) {
+        // The `AbstractExecutionService` will have already closed the job stream,
+        // so we write to the runtime stream directly.
+        __classPrivateFieldGet(this, _OffscreenExecutionService_runtimeStream, "f").write({
+            jobId: job.id,
+            data: {
+                jsonrpc: '2.0',
+                method: 'terminateJob',
+                id: (0, nanoid_1.nanoid)(),
+            },
+        });
+    }
+    /**
+     * Create a new stream for the specified job. This wraps the runtime stream
+     * in a stream specific to the job.
+     *
+     * @param jobId - The job ID.
+     */
+    async initEnvStream(jobId) {
+        // Lazily create the offscreen document.
+        await this.createDocument();
+        const stream = new OffscreenPostMessageStream_1.OffscreenPostMessageStream({
+            stream: __classPrivateFieldGet(this, _OffscreenExecutionService_runtimeStream, "f"),
+            frameUrl: this.frameUrl.toString(),
+            jobId,
+        });
+        return { worker: jobId, stream };
+    }
+    /**
+     * Creates the offscreen document to be used as the execution environment.
+     *
+     * If the document already exists, this does nothing.
+     */
+    async createDocument() {
+        // Extensions can only have a single offscreen document.
+        if (await chrome.offscreen.hasDocument()) {
+            return;
+        }
+        await chrome.offscreen.createDocument({
+            justification: 'MetaMask Snaps Execution Environment',
+            reasons: ['IFRAME_SCRIPTING'],
+            url: this.documentUrl.toString(),
+        });
+    }
+}
+exports.OffscreenExecutionService = OffscreenExecutionService;
+_OffscreenExecutionService_runtimeStream = new WeakMap();
+//# sourceMappingURL=OffscreenExecutionService.js.map

package/dist/services/offscreen/OffscreenExecutionService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OffscreenExecutionService.js","sourceRoot":"","sources":["../../../src/services/offscreen/OffscreenExecutionService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uEAAgF;AAChF,mCAAgC;AAEhC,0EAIqC;AACrC,6EAA0E;AAO1E,MAAa,yBAA0B,SAAQ,mDAAgC;IAO7E;;;;;;;;;;;;;OAaG;IACH,YAAY,EACV,WAAW,EACX,QAAQ,EACR,SAAS,EACT,iBAAiB,GACwB;QACzC,KAAK,CAAC;YACJ,SAAS;YACT,iBAAiB;SAClB,CAAC,CAAC;QAzBL,2DAAyD;QA2BvD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,uBAAA,IAAI,4CAAkB,IAAI,qDAA+B,CAAC;YACxD,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;SAChB,CAAC,MAAA,CAAC;IACL,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,YAAY,CAAC,GAAgB;QAC3C,0EAA0E;QAC1E,8CAA8C;QAC9C,uBAAA,IAAI,gDAAe,CAAC,KAAK,CAAC;YACxB,KAAK,EAAE,GAAG,CAAC,EAAE;YACb,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,cAAc;gBACtB,EAAE,EAAE,IAAA,eAAM,GAAE;aACb;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,aAAa,CAAC,KAAa;QACzC,wCAAwC;QACxC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAE5B,MAAM,MAAM,GAAG,IAAI,uDAA0B,CAAC;YAC5C,MAAM,EAAE,uBAAA,IAAI,gDAAe;YAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YAClC,KAAK;SACN,CAAC,CAAC;QAEH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,cAAc;QAC1B,wDAAwD;QACxD,IAAI,MAAM,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE;YACxC,OAAO;SACR;QAED,MAAM,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC;YACpC,aAAa,EAAE,sCAAsC;YACrD,OAAO,EAAE,CAAC,kBAAkB,CAAC;YAC7B,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE;SACjC,CAAC,CAAC;IACL,CAAC;CACF;AA9FD,8DA8FC","sourcesContent":["import { BrowserRuntimePostMessageStream } from '@metamask/post-message-stream';\nimport { nanoid } from 'nanoid';\n\nimport {\n  AbstractExecutionService,\n  ExecutionServiceArgs,\n  Job,\n} from '../AbstractExecutionService';\nimport { OffscreenPostMessageStream } from './OffscreenPostMessageStream';\n\ntype OffscreenExecutionEnvironmentServiceArgs = {\n  documentUrl: URL;\n  frameUrl: URL;\n} & ExecutionServiceArgs;\n\nexport class OffscreenExecutionService extends AbstractExecutionService<string> {\n  public readonly documentUrl: URL;\n\n  public readonly frameUrl: URL;\n\n  readonly #runtimeStream: BrowserRuntimePostMessageStream;\n\n  /**\n   * Create a new offscreen execution service.\n   *\n   * @param args - The constructor arguments.\n   * @param args.documentUrl - The URL of the offscreen document to use as the\n   * execution environment. This must be a URL relative to the location where\n   * this is called. This cannot be a public (http(s)) URL.\n   * @param args.frameUrl - The URL of the iframe to load inside the offscreen\n   * document.\n   * @param args.messenger - The messenger to use for communication with the\n   * `SnapController`.\n   * @param args.setupSnapProvider - The function to use to set up the snap\n   * provider.\n   */\n  constructor({\n    documentUrl,\n    frameUrl,\n    messenger,\n    setupSnapProvider,\n  }: OffscreenExecutionEnvironmentServiceArgs) {\n    super({\n      messenger,\n      setupSnapProvider,\n    });\n\n    this.documentUrl = documentUrl;\n    this.frameUrl = frameUrl;\n    this.#runtimeStream = new BrowserRuntimePostMessageStream({\n      name: 'parent',\n      target: 'child',\n    });\n  }\n\n  /**\n   * Send a termination command to the offscreen document.\n   *\n   * @param job - The job to terminate.\n   */\n  protected async terminateJob(job: Job<string>) {\n    // The `AbstractExecutionService` will have already closed the job stream,\n    // so we write to the runtime stream directly.\n    this.#runtimeStream.write({\n      jobId: job.id,\n      data: {\n        jsonrpc: '2.0',\n        method: 'terminateJob',\n        id: nanoid(),\n      },\n    });\n  }\n\n  /**\n   * Create a new stream for the specified job. This wraps the runtime stream\n   * in a stream specific to the job.\n   *\n   * @param jobId - The job ID.\n   */\n  protected async initEnvStream(jobId: string) {\n    // Lazily create the offscreen document.\n    await this.createDocument();\n\n    const stream = new OffscreenPostMessageStream({\n      stream: this.#runtimeStream,\n      frameUrl: this.frameUrl.toString(),\n      jobId,\n    });\n\n    return { worker: jobId, stream };\n  }\n\n  /**\n   * Creates the offscreen document to be used as the execution environment.\n   *\n   * If the document already exists, this does nothing.\n   */\n  private async createDocument() {\n    // Extensions can only have a single offscreen document.\n    if (await chrome.offscreen.hasDocument()) {\n      return;\n    }\n\n    await chrome.offscreen.createDocument({\n      justification: 'MetaMask Snaps Execution Environment',\n      reasons: ['IFRAME_SCRIPTING'],\n      url: this.documentUrl.toString(),\n    });\n  }\n}\n"]}

package/dist/{types/services/ProxyPostMessageStream.d.ts → services/offscreen/OffscreenPostMessageStream.d.ts}

@@ -1,35 +1,35 @@
 import { BasePostMessageStream } from '@metamask/post-message-stream';
 import { JsonRpcRequest } from '@metamask/utils';
-export declare type ProxyPostMessageStreamArgs = {
+export declare type OffscreenPostMessageStreamArgs = {
     stream: BasePostMessageStream;
     jobId: string;
-    extra?: Record<string, unknown>;
+    frameUrl: string;
 };
-export declare type ProxyPostMessage = {
+export declare type OffscreenPostMessage = {
     jobId: string;
     data: JsonRpcRequest;
-    extra?: Record<string, unknown>;
 };
 /**
  * A post message stream that wraps messages in a job ID, before sending them
  * over the underlying stream.
  */
-export declare class ProxyPostMessageStream extends BasePostMessageStream {
+export declare class OffscreenPostMessageStream extends BasePostMessageStream {
     #private;
     /**
-     * Initializes a new `ProxyPostMessageStream` instance.
+     * Initializes a new `OffscreenPostMessageStream` instance.
      *
      * @param args - The constructor arguments.
      * @param args.stream - The underlying stream to use for communication.
      * @param args.jobId - The ID of the job this stream is associated with.
-     * @param args.extra - Extra data to include in the post message.
+     * @param args.frameUrl - The URL of the frame to load inside the offscreen
+     * document.
      */
-    constructor({ stream, jobId, extra }: ProxyPostMessageStreamArgs);
+    constructor({ stream, jobId, frameUrl }: OffscreenPostMessageStreamArgs);
     /**
      * Write data to the underlying stream. This wraps the data in an object with
      * the job ID.
      *
      * @param data - The data to write.
      */
-    _postMessage(data: ProxyPostMessage): void;
+    _postMessage(data: OffscreenPostMessage): void;
 }

package/dist/services/offscreen/OffscreenPostMessageStream.js

@@ -0,0 +1,66 @@
+"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 _OffscreenPostMessageStream_instances, _OffscreenPostMessageStream_stream, _OffscreenPostMessageStream_jobId, _OffscreenPostMessageStream_frameUrl, _OffscreenPostMessageStream_onData;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OffscreenPostMessageStream = void 0;
+const post_message_stream_1 = require("@metamask/post-message-stream");
+/**
+ * A post message stream that wraps messages in a job ID, before sending them
+ * over the underlying stream.
+ */
+class OffscreenPostMessageStream extends post_message_stream_1.BasePostMessageStream {
+    /**
+     * Initializes a new `OffscreenPostMessageStream` instance.
+     *
+     * @param args - The constructor arguments.
+     * @param args.stream - The underlying stream to use for communication.
+     * @param args.jobId - The ID of the job this stream is associated with.
+     * @param args.frameUrl - The URL of the frame to load inside the offscreen
+     * document.
+     */
+    constructor({ stream, jobId, frameUrl }) {
+        super();
+        _OffscreenPostMessageStream_instances.add(this);
+        _OffscreenPostMessageStream_stream.set(this, void 0);
+        _OffscreenPostMessageStream_jobId.set(this, void 0);
+        _OffscreenPostMessageStream_frameUrl.set(this, void 0);
+        __classPrivateFieldSet(this, _OffscreenPostMessageStream_stream, stream, "f");
+        __classPrivateFieldSet(this, _OffscreenPostMessageStream_jobId, jobId, "f");
+        __classPrivateFieldSet(this, _OffscreenPostMessageStream_frameUrl, frameUrl, "f");
+        __classPrivateFieldGet(this, _OffscreenPostMessageStream_stream, "f").on('data', __classPrivateFieldGet(this, _OffscreenPostMessageStream_instances, "m", _OffscreenPostMessageStream_onData).bind(this));
+    }
+    /**
+     * Write data to the underlying stream. This wraps the data in an object with
+     * the job ID.
+     *
+     * @param data - The data to write.
+     */
+    _postMessage(data) {
+        __classPrivateFieldGet(this, _OffscreenPostMessageStream_stream, "f").write({
+            jobId: __classPrivateFieldGet(this, _OffscreenPostMessageStream_jobId, "f"),
+            // TODO: Rather than injecting the frame URL here, we should come up with
+            // a better way to do this. The frame URL is needed to avoid hard coding
+            // it in the offscreen execution environment.
+            frameUrl: __classPrivateFieldGet(this, _OffscreenPostMessageStream_frameUrl, "f"),
+            data,
+        });
+    }
+}
+exports.OffscreenPostMessageStream = OffscreenPostMessageStream;
+_OffscreenPostMessageStream_stream = new WeakMap(), _OffscreenPostMessageStream_jobId = new WeakMap(), _OffscreenPostMessageStream_frameUrl = new WeakMap(), _OffscreenPostMessageStream_instances = new WeakSet(), _OffscreenPostMessageStream_onData = function _OffscreenPostMessageStream_onData(data) {
+    if (data.jobId !== __classPrivateFieldGet(this, _OffscreenPostMessageStream_jobId, "f")) {
+        return;
+    }
+    this.push(data.data);
+};
+//# sourceMappingURL=OffscreenPostMessageStream.js.map

package/dist/services/offscreen/OffscreenPostMessageStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OffscreenPostMessageStream.js","sourceRoot":"","sources":["../../../src/services/offscreen/OffscreenPostMessageStream.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uEAAsE;AActE;;;GAGG;AACH,MAAa,0BAA2B,SAAQ,2CAAqB;IAOnE;;;;;;;;OAQG;IACH,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAkC;QACrE,KAAK,EAAE,CAAC;;QAhBV,qDAAwC;QAExC,oDAAwB;QAExB,uDAA2B;QAczB,uBAAA,IAAI,sCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,qCAAU,KAAK,MAAA,CAAC;QACpB,uBAAA,IAAI,wCAAa,QAAQ,MAAA,CAAC;QAE1B,uBAAA,IAAI,0CAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,uBAAA,IAAI,iFAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,CAAC;IAgBD;;;;;OAKG;IACH,YAAY,CAAC,IAA0B;QACrC,uBAAA,IAAI,0CAAQ,CAAC,KAAK,CAAC;YACjB,KAAK,EAAE,uBAAA,IAAI,yCAAO;YAClB,yEAAyE;YACzE,wEAAwE;YACxE,6CAA6C;YAC7C,QAAQ,EAAE,uBAAA,IAAI,4CAAU;YACxB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;CACF;AAxDD,gEAwDC;qSAxBS,IAA0B;IAChC,IAAI,IAAI,CAAC,KAAK,KAAK,uBAAA,IAAI,yCAAO,EAAE;QAC9B,OAAO;KACR;IAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC","sourcesContent":["import { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { JsonRpcRequest } from '@metamask/utils';\n\nexport type OffscreenPostMessageStreamArgs = {\n  stream: BasePostMessageStream;\n  jobId: string;\n  frameUrl: string;\n};\n\nexport type OffscreenPostMessage = {\n  jobId: string;\n  data: JsonRpcRequest;\n};\n\n/**\n * A post message stream that wraps messages in a job ID, before sending them\n * over the underlying stream.\n */\nexport class OffscreenPostMessageStream extends BasePostMessageStream {\n  readonly #stream: BasePostMessageStream;\n\n  readonly #jobId: string;\n\n  readonly #frameUrl: string;\n\n  /**\n   * Initializes a new `OffscreenPostMessageStream` instance.\n   *\n   * @param args - The constructor arguments.\n   * @param args.stream - The underlying stream to use for communication.\n   * @param args.jobId - The ID of the job this stream is associated with.\n   * @param args.frameUrl - The URL of the frame to load inside the offscreen\n   * document.\n   */\n  constructor({ stream, jobId, frameUrl }: OffscreenPostMessageStreamArgs) {\n    super();\n\n    this.#stream = stream;\n    this.#jobId = jobId;\n    this.#frameUrl = frameUrl;\n\n    this.#stream.on('data', this.#onData.bind(this));\n  }\n\n  /**\n   * Handle incoming data from the underlying stream. This checks that the job\n   * ID matches the expected job ID, and pushes the data to the stream if so.\n   *\n   * @param data - The data to handle.\n   */\n  #onData(data: OffscreenPostMessage) {\n    if (data.jobId !== this.#jobId) {\n      return;\n    }\n\n    this.push(data.data);\n  }\n\n  /**\n   * Write data to the underlying stream. This wraps the data in an object with\n   * the job ID.\n   *\n   * @param data - The data to write.\n   */\n  _postMessage(data: OffscreenPostMessage) {\n    this.#stream.write({\n      jobId: this.#jobId,\n      // TODO: Rather than injecting the frame URL here, we should come up with\n      // a better way to do this. The frame URL is needed to avoid hard coding\n      // it in the offscreen execution environment.\n      frameUrl: this.#frameUrl,\n      data,\n    });\n  }\n}\n"]}

package/dist/services/offscreen/index.d.ts

@@ -0,0 +1,2 @@
+export * from './OffscreenExecutionService';
+export * from './OffscreenPostMessageStream';

package/dist/services/offscreen/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("./OffscreenExecutionService"), exports);
+__exportStar(require("./OffscreenPostMessageStream"), exports);
+//# sourceMappingURL=index.js.map

package/dist/services/offscreen/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/offscreen/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C;AAC5C,+DAA6C","sourcesContent":["export * from './OffscreenExecutionService';\nexport * from './OffscreenPostMessageStream';\n"]}

package/dist/snaps/RequestQueue.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestQueue = void 0;
+class RequestQueue {
+    constructor(maxQueueSize) {
+        this.maxQueueSize = maxQueueSize;
+        this.queueSizes = new Map();
+    }
+    /**
+     * Increments the queue count for a particular origin.
+     *
+     * @param origin - A string identifying the origin.
+     */
+    increment(origin) {
+        const currentCount = this.queueSizes.get(origin) ?? 0;
+        if (currentCount >= this.maxQueueSize) {
+            throw new Error('Maximum number of requests reached. Try again later.');
+        }
+        this.queueSizes.set(origin, currentCount + 1);
+    }
+    /**
+     * Decrements the queue count for a particular origin.
+     *
+     * @param origin - A string identifying the origin.
+     */
+    decrement(origin) {
+        const currentCount = this.queueSizes.get(origin) ?? 0;
+        if (currentCount === 0) {
+            throw new Error(`Cannot decrement, ${origin} does not have any outstanding requests.`);
+        }
+        this.queueSizes.set(origin, currentCount - 1);
+    }
+    /**
+     * Gets the queue count for a particular origin.
+     *
+     * @param origin - A string identifying the origin.
+     * @returns The queue count for the origin.
+     */
+    get(origin) {
+        return this.queueSizes.get(origin) ?? 0;
+    }
+}
+exports.RequestQueue = RequestQueue;
+//# sourceMappingURL=RequestQueue.js.map

package/dist/snaps/RequestQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestQueue.js","sourceRoot":"","sources":["../../src/snaps/RequestQueue.ts"],"names":[],"mappings":";;;AAAA,MAAa,YAAY;IAKvB,YAAY,YAAoB;QAC9B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,MAAc;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,YAAY,IAAI,IAAI,CAAC,YAAY,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;SACzE;QACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,SAAS,CAAC,MAAc;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,YAAY,KAAK,CAAC,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,qBAAqB,MAAM,0CAA0C,CACtE,CAAC;SACH;QACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,MAAc;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;CACF;AA/CD,oCA+CC","sourcesContent":["export class RequestQueue {\n  public readonly maxQueueSize: number;\n\n  private readonly queueSizes: Map<string, number>;\n\n  constructor(maxQueueSize: number) {\n    this.maxQueueSize = maxQueueSize;\n    this.queueSizes = new Map<string, number>();\n  }\n\n  /**\n   * Increments the queue count for a particular origin.\n   *\n   * @param origin - A string identifying the origin.\n   */\n  public increment(origin: string) {\n    const currentCount = this.queueSizes.get(origin) ?? 0;\n    if (currentCount >= this.maxQueueSize) {\n      throw new Error('Maximum number of requests reached. Try again later.');\n    }\n    this.queueSizes.set(origin, currentCount + 1);\n  }\n\n  /**\n   * Decrements the queue count for a particular origin.\n   *\n   * @param origin - A string identifying the origin.\n   */\n  public decrement(origin: string) {\n    const currentCount = this.queueSizes.get(origin) ?? 0;\n    if (currentCount === 0) {\n      throw new Error(\n        `Cannot decrement, ${origin} does not have any outstanding requests.`,\n      );\n    }\n    this.queueSizes.set(origin, currentCount - 1);\n  }\n\n  /**\n   * Gets the queue count for a particular origin.\n   *\n   * @param origin - A string identifying the origin.\n   * @returns The queue count for the origin.\n   */\n  public get(origin: string): number {\n    return this.queueSizes.get(origin) ?? 0;\n  }\n}\n"]}

package/dist/{types/snaps → snaps}/SnapController.d.ts

@@ -71,7 +71,7 @@ export declare type SnapError = {
     data?: Json;
 };
 declare type CloseAllConnectionsFunction = (origin: string) => void;
-declare type StoredSnaps = Record<ValidatedSnapId, Snap>;
+declare type StoredSnaps = Record<SnapId, Snap>;
 export declare type SnapControllerState = {
     snaps: StoredSnaps;
     snapStates: {};
@@ -82,8 +82,8 @@ export declare type SnapControllerState = {
     };
 };
 export declare type PersistedSnapControllerState = SnapControllerState & {
-    snaps: Record<ValidatedSnapId, PersistedSnap>;
-    snapStates: Record<ValidatedSnapId, string>;
+    snaps: Record<SnapId, PersistedSnap>;
+    snapStates: Record<SnapId, string>;
 };
 /**
  * Gets the specified Snap from state.
@@ -174,11 +174,7 @@ export declare type GetRegistryMetadata = {
     type: `${typeof controllerName}:getRegistryMetadata`;
     handler: SnapController['getRegistryMetadata'];
 };
-export declare type DisconnectOrigin = {
-    type: `${typeof controllerName}:disconnectOrigin`;
-    handler: SnapController['removeSnapFromSubject'];
-};
-export declare type SnapControllerActions = ClearSnapState | GetSnap | GetSnapState | HandleSnapRequest | HasSnap | UpdateBlockedSnaps | UpdateSnapState | EnableSnap | DisableSnap | RemoveSnap | GetPermittedSnaps | InstallSnaps | RemoveSnapError | GetAllSnaps | IncrementActiveReferences | DecrementActiveReferences | GetRegistryMetadata | DisconnectOrigin;
+export declare type SnapControllerActions = ClearSnapState | GetSnap | GetSnapState | HandleSnapRequest | HasSnap | UpdateBlockedSnaps | UpdateSnapState | EnableSnap | DisableSnap | RemoveSnap | GetPermittedSnaps | InstallSnaps | RemoveSnapError | GetAllSnaps | IncrementActiveReferences | DecrementActiveReferences | GetRegistryMetadata;
 export declare type SnapStateChange = {
     type: `${typeof controllerName}:stateChange`;
     payload: [SnapControllerState, Patch[]];
@@ -334,21 +330,21 @@ export declare class SnapController extends BaseController<string, SnapControlle
      *
      * @param snapId - The id of the Snap to start.
      */
-    startSnap(snapId: ValidatedSnapId): Promise<void>;
+    startSnap(snapId: SnapId): Promise<void>;
     /**
      * Enables the given snap. A snap can only be started if it is enabled. A snap
      * can only be enabled if it isn't blocked.
      *
      * @param snapId - The id of the Snap to enable.
      */
-    enableSnap(snapId: ValidatedSnapId): void;
+    enableSnap(snapId: SnapId): void;
     /**
      * Disables the given snap. A snap can only be started if it is enabled.
      *
      * @param snapId - The id of the Snap to disable.
      * @returns A promise that resolves once the snap has been disabled.
      */
-    disableSnap(snapId: ValidatedSnapId): Promise<void>;
+    disableSnap(snapId: SnapId): Promise<void>;
     /**
      * Stops the given snap, removes all hooks, closes all connections, and
      * terminates its worker.
@@ -357,7 +353,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param statusEvent - The Snap status event that caused the snap to be
      * stopped.
      */
-    stopSnap(snapId: ValidatedSnapId, statusEvent?: SnapStatusEvents.Stop | SnapStatusEvents.Crash): Promise<void>;
+    stopSnap(snapId: SnapId, statusEvent?: SnapStatusEvents.Stop | SnapStatusEvents.Crash): Promise<void>;
     /**
      * Returns whether the given snap is running.
      * Throws an error if the snap doesn't exist.
@@ -365,14 +361,14 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param snapId - The id of the Snap to check.
      * @returns `true` if the snap is running, otherwise `false`.
      */
-    isRunning(snapId: ValidatedSnapId): boolean;
+    isRunning(snapId: SnapId): boolean;
     /**
      * Returns whether the given snap has been added to state.
      *
      * @param snapId - The id of the Snap to check for.
      * @returns `true` if the snap exists in the controller state, otherwise `false`.
      */
-    has(snapId: ValidatedSnapId): boolean;
+    has(snapId: SnapId): boolean;
     /**
      * Gets the snap with the given id if it exists, including all data.
      * This should not be used if the snap is to be serializable, as e.g.
@@ -392,7 +388,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param snapId - The id of the snap to get.
      * @returns The entire snap object.
      */
-    getExpect(snapId: ValidatedSnapId): Snap;
+    getExpect(snapId: SnapId): Snap;
     /**
      * Gets the snap with the given id if it exists, excluding any
      * non-serializable or expensive-to-serialize data.
@@ -400,7 +396,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param snapId - The id of the Snap to get.
      * @returns A truncated version of the snap state, that is less expensive to serialize.
      */
-    getTruncated(snapId: ValidatedSnapId): TruncatedSnap | null;
+    getTruncated(snapId: SnapId): TruncatedSnap | null;
     /**
      * Gets the snap with the given id, throw if it doesn't exist.
      *
@@ -408,7 +404,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param snapId - The id of the snap to get.
      * @returns A truncated version of the snap state, that is less expensive to serialize.
      */
-    getTruncatedExpect(snapId: ValidatedSnapId): TruncatedSnap;
+    getTruncatedExpect(snapId: SnapId): TruncatedSnap;
     /**
      * Updates the own state of the snap with the given id.
      * This is distinct from the state MetaMask uses to manage snaps.
@@ -416,14 +412,14 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param snapId - The id of the Snap whose state should be updated.
      * @param newSnapState - The new state of the snap.
      */
-    updateSnapState(snapId: ValidatedSnapId, newSnapState: string): Promise<void>;
+    updateSnapState(snapId: SnapId, newSnapState: string): Promise<void>;
     /**
      * Clears the state of the snap with the given id.
      * This is distinct from the state MetaMask uses to manage snaps.
      *
      * @param snapId - The id of the Snap whose state should be cleared.
      */
-    clearSnapState(snapId: ValidatedSnapId): void;
+    clearSnapState(snapId: SnapId): void;
     /**
      * Adds error from a snap to the SnapController state.
      *
@@ -448,7 +444,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @returns A promise that resolves with the decrypted snap state or null if no state exists.
      * @throws If the snap state decryption fails.
      */
-    getSnapState(snapId: ValidatedSnapId): Promise<Json>;
+    getSnapState(snapId: SnapId): Promise<Json>;
     /**
      * Completely clear the controller's state: delete all associated data,
      * handlers, event listeners, and permissions; tear down all snap providers.
@@ -461,21 +457,14 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @param snapId - The id of the Snap.
      * @returns A promise that resolves once the snap has been removed.
      */
-    removeSnap(snapId: ValidatedSnapId): Promise<void>;
+    removeSnap(snapId: SnapId): Promise<void>;
     /**
      * Stops the given snaps, removes them from state, and clears all associated
      * permissions, handlers, and listeners.
      *
      * @param snapIds - The ids of the Snaps.
      */
-    removeSnaps(snapIds: ValidatedSnapId[]): Promise<void>;
-    /**
-     * Removes a snap's permission (caveat) from the specified subject.
-     *
-     * @param origin - The origin from which to remove the snap.
-     * @param snapId - The id of the snap to remove.
-     */
-    removeSnapFromSubject(origin: string, snapId: ValidatedSnapId): void;
+    removeSnaps(snapIds: string[]): Promise<void>;
     /**
      * Safely revokes all permissions granted to a Snap.
      *
@@ -487,13 +476,13 @@ export declare class SnapController extends BaseController<string, SnapControlle
      *
      * @param snapId - The snap id of the snap that was referenced.
      */
-    incrementActiveReferences(snapId: ValidatedSnapId): void;
+    incrementActiveReferences(snapId: SnapId): void;
     /**
      * Handles decrement the activeReferences counter.
      *
      * @param snapId - The snap id of the snap that was referenced..
      */
-    decrementActiveReferences(snapId: ValidatedSnapId): void;
+    decrementActiveReferences(snapId: SnapId): void;
     /**
      * Gets all snaps in their truncated format.
      *
@@ -555,7 +544,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @returns The metadata for the given snap ID, or `null` if the snap is not
      * verified.
      */
-    getRegistryMetadata(snapId: ValidatedSnapId): Promise<SnapsRegistryMetadata | null>;
+    getRegistryMetadata(snapId: SnapId): Promise<SnapsRegistryMetadata | null>;
     /**
      * Initiates a request for the given snap's initial permissions.
      * Must be called in order. See processRequestedSnap.
@@ -579,7 +568,7 @@ export declare class SnapController extends BaseController<string, SnapControlle
      * @returns The result of the JSON-RPC request.
      */
     handleRequest({ snapId, origin, handler: handlerType, request, }: SnapRpcHookArgs & {
-        snapId: ValidatedSnapId;
+        snapId: SnapId;
     }): Promise<unknown>;
 }
 export {};