@metamask/snaps-controllers 4.0.0 → 5.0.0

package/dist/esm/services/webview/WebViewExecutionService.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/services/webview/WebViewExecutionService.ts"],"sourcesContent":["import type { ExecutionServiceArgs } from '../AbstractExecutionService';\nimport { ProxyExecutionService } from '../proxy/ProxyExecutionService';\nimport type { WebViewInterface } from './WebViewMessageStream';\nimport { WebViewMessageStream } from './WebViewMessageStream';\n\nexport type WebViewExecutionServiceArgs = ExecutionServiceArgs & {\n  getWebView: () => Promise<WebViewInterface>;\n};\n\nexport class WebViewExecutionService extends ProxyExecutionService {\n  #getWebView;\n\n  constructor({\n    messenger,\n    setupSnapProvider,\n    getWebView,\n  }: WebViewExecutionServiceArgs) {\n    super({\n      messenger,\n      setupSnapProvider,\n      stream: new WebViewMessageStream({\n        name: 'parent',\n        target: 'child',\n        getWebView,\n      }),\n    });\n    this.#getWebView = getWebView;\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    // Ensure that the WebView has been loaded before we proceed.\n    await this.#ensureWebViewLoaded();\n\n    return super.initEnvStream(jobId);\n  }\n\n  /**\n   * Ensure that the WebView has been loaded by awaiting the getWebView promise.\n   */\n  async #ensureWebViewLoaded() {\n    await this.#getWebView();\n  }\n}\n"],"names":["ProxyExecutionService","WebViewMessageStream","WebViewExecutionService","initEnvStream","jobId","ensureWebViewLoaded","constructor","messenger","setupSnapProvider","getWebView","stream","name","target"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,SAASA,qBAAqB,QAAQ,iCAAiC;AAEvE,SAASC,oBAAoB,QAAQ,yBAAyB;IAO5D,2CAmCM;AApCR,OAAO,MAAMC,gCAAgCF;IAoB3C;;;;;GAKC,GACD,MAAgBG,cAAcC,KAAa,EAAE;QAC3C,6DAA6D;QAC7D,MAAM,0BAAA,IAAI,EAAEC,sBAAAA,0BAAN,IAAI;QAEV,OAAO,KAAK,CAACF,cAAcC;IAC7B;IA5BAE,YAAY,EACVC,SAAS,EACTC,iBAAiB,EACjBC,UAAU,EACkB,CAAE;QAC9B,KAAK,CAAC;YACJF;YACAC;YACAE,QAAQ,IAAIT,qBAAqB;gBAC/BU,MAAM;gBACNC,QAAQ;gBACRH;YACF;QACF;QAiBF;;GAEC,GACD,iCAAM;QAnCN,gCAAA;;mBAAA,KAAA;;uCAgBQA,aAAaA;IACrB;AAqBF;AAHE,eAAA;IACE,MAAM,yBAAA,IAAI,EAAEA,kBAAN,IAAI;AACZ"}

package/dist/esm/services/webview/WebViewMessageStream.js

@@ -0,0 +1,119 @@
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) {
+        throw new TypeError("Cannot initialize the same private elements twice on an object");
+    }
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+    if (descriptor.get) {
+        return descriptor.get.call(receiver);
+    }
+    return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+    if (descriptor.set) {
+        descriptor.set.call(receiver, value);
+    } else {
+        if (!descriptor.writable) {
+            throw new TypeError("attempted to set read only private field");
+        }
+        descriptor.value = value;
+    }
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to " + action + " private field on non-instance");
+    }
+    return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+    return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+    _check_private_redeclaration(obj, privateMap);
+    privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+    _class_apply_descriptor_set(receiver, descriptor, value);
+    return value;
+}
+import { BasePostMessageStream } from '@metamask/post-message-stream';
+import { isValidStreamMessage } from '@metamask/post-message-stream/dist/utils';
+import { logError } from '@metamask/snaps-utils';
+import { assert, bytesToBase64, stringToBytes } from '@metamask/utils';
+var _name = /*#__PURE__*/ new WeakMap(), _target = /*#__PURE__*/ new WeakMap(), _webView = /*#__PURE__*/ new WeakMap();
+/**
+ * A special postMessage stream used to interface with a WebView.
+ */ export class WebViewMessageStream extends BasePostMessageStream {
+    _postMessage(data) {
+        assert(_class_private_field_get(this, _webView));
+        const json = JSON.stringify({
+            target: _class_private_field_get(this, _target),
+            data
+        });
+        // To prevent XSS, we base64 encode the message before injecting it.
+        // This adds significant performance overhead.
+        // TODO: Should we use mobile native base64 here?
+        const bytes = stringToBytes(json);
+        const base64 = bytesToBase64(bytes);
+        _class_private_field_get(this, _webView).injectJavaScript(`window.postMessage('${base64}')`);
+    }
+    _onMessage(event) {
+        if (typeof event.data !== 'string') {
+            return;
+        }
+        const message = JSON.parse(event.data);
+        // Notice that we don't check targetWindow or targetOrigin here.
+        // This doesn't seem possible to do in RN.
+        if (!isValidStreamMessage(message) || message.target !== _class_private_field_get(this, _name)) {
+            return;
+        }
+        this._onData(message.data);
+    }
+    _destroy() {
+        assert(_class_private_field_get(this, _webView));
+        // This method is already bound.
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        _class_private_field_get(this, _webView).unregisterMessageListener(this._onMessage);
+    }
+    /**
+   * Creates a stream for communicating with other streams inside a WebView.
+   *
+   * @param args - Options bag.
+   * @param args.name - The name of the stream. Used to differentiate between
+   * multiple streams sharing the same window object.
+   * @param args.target - The name of the stream to exchange messages with.
+   * @param args.getWebView - A asynchronous getter for the webview.
+   */ constructor({ name, target, getWebView }){
+        super();
+        _class_private_field_init(this, _name, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_init(this, _target, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_init(this, _webView, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_set(this, _name, name);
+        _class_private_field_set(this, _target, target);
+        this._onMessage = this._onMessage.bind(this);
+        // This is a bit atypical from other post-message streams.
+        // We have to wait for the WebView to fully load before we can continue using the stream.
+        getWebView().then((webView)=>{
+            _class_private_field_set(this, _webView, webView);
+            // This method is already bound.
+            // eslint-disable-next-line @typescript-eslint/unbound-method
+            webView.registerMessageListener(this._onMessage);
+            this._handshake();
+        }).catch((error)=>{
+            logError(error);
+        });
+    }
+}
+
+//# sourceMappingURL=WebViewMessageStream.js.map

package/dist/esm/services/webview/WebViewMessageStream.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/services/webview/WebViewMessageStream.ts"],"sourcesContent":["import type { PostMessageEvent } from '@metamask/post-message-stream';\nimport { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { isValidStreamMessage } from '@metamask/post-message-stream/dist/utils';\nimport { logError } from '@metamask/snaps-utils';\nimport { assert, bytesToBase64, stringToBytes } from '@metamask/utils';\n\nexport type WebViewInterface = {\n  injectJavaScript(js: string): void;\n  registerMessageListener(listener: (event: PostMessageEvent) => void): void;\n  unregisterMessageListener(listener: (event: PostMessageEvent) => void): void;\n};\n\ntype WebViewStreamArgs = {\n  name: string;\n  target: string;\n  getWebView: () => Promise<WebViewInterface>;\n};\n\n/**\n * A special postMessage stream used to interface with a WebView.\n */\n\nexport class WebViewMessageStream extends BasePostMessageStream {\n  #name;\n\n  #target;\n\n  #webView: WebViewInterface | undefined;\n\n  /**\n   * Creates a stream for communicating with other streams inside a WebView.\n   *\n   * @param args - Options bag.\n   * @param args.name - The name of the stream. Used to differentiate between\n   * multiple streams sharing the same window object.\n   * @param args.target - The name of the stream to exchange messages with.\n   * @param args.getWebView - A asynchronous getter for the webview.\n   */\n  constructor({ name, target, getWebView }: WebViewStreamArgs) {\n    super();\n\n    this.#name = name;\n    this.#target = target;\n\n    this._onMessage = this._onMessage.bind(this);\n\n    // This is a bit atypical from other post-message streams.\n    // We have to wait for the WebView to fully load before we can continue using the stream.\n    getWebView()\n      .then((webView) => {\n        this.#webView = webView;\n        // This method is already bound.\n        // eslint-disable-next-line @typescript-eslint/unbound-method\n        webView.registerMessageListener(this._onMessage);\n        this._handshake();\n      })\n      .catch((error) => {\n        logError(error);\n      });\n  }\n\n  protected _postMessage(data: unknown): void {\n    assert(this.#webView);\n    const json = JSON.stringify({\n      target: this.#target,\n      data,\n    });\n\n    // To prevent XSS, we base64 encode the message before injecting it.\n    // This adds significant performance overhead.\n    // TODO: Should we use mobile native base64 here?\n    const bytes = stringToBytes(json);\n    const base64 = bytesToBase64(bytes);\n    this.#webView.injectJavaScript(`window.postMessage('${base64}')`);\n  }\n\n  private _onMessage(event: PostMessageEvent): void {\n    if (typeof event.data !== 'string') {\n      return;\n    }\n\n    const message = JSON.parse(event.data);\n\n    // Notice that we don't check targetWindow or targetOrigin here.\n    // This doesn't seem possible to do in RN.\n    if (!isValidStreamMessage(message) || message.target !== this.#name) {\n      return;\n    }\n\n    this._onData(message.data);\n  }\n\n  _destroy() {\n    assert(this.#webView);\n    // This method is already bound.\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    this.#webView.unregisterMessageListener(this._onMessage);\n  }\n}\n"],"names":["BasePostMessageStream","isValidStreamMessage","logError","assert","bytesToBase64","stringToBytes","WebViewMessageStream","_postMessage","data","webView","json","JSON","stringify","target","bytes","base64","injectJavaScript","_onMessage","event","message","parse","name","_onData","_destroy","unregisterMessageListener","constructor","getWebView","bind","then","registerMessageListener","_handshake","catch","error"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,SAASA,qBAAqB,QAAQ,gCAAgC;AACtE,SAASC,oBAAoB,QAAQ,2CAA2C;AAChF,SAASC,QAAQ,QAAQ,wBAAwB;AACjD,SAASC,MAAM,EAAEC,aAAa,EAAEC,aAAa,QAAQ,kBAAkB;IAmBrE,qCAEA,uCAEA;AATF;;CAEC,GAED,OAAO,MAAMC,6BAA6BN;IAuC9BO,aAAaC,IAAa,EAAQ;QAC1CL,gCAAO,IAAI,EAAEM;QACb,MAAMC,OAAOC,KAAKC,SAAS,CAAC;YAC1BC,MAAM,2BAAE,IAAI,EAAEA;YACdL;QACF;QAEA,oEAAoE;QACpE,8CAA8C;QAC9C,iDAAiD;QACjD,MAAMM,QAAQT,cAAcK;QAC5B,MAAMK,SAASX,cAAcU;QAC7B,yBAAA,IAAI,EAAEL,UAAQO,gBAAgB,CAAC,CAAC,oBAAoB,EAAED,OAAO,EAAE,CAAC;IAClE;IAEQE,WAAWC,KAAuB,EAAQ;QAChD,IAAI,OAAOA,MAAMV,IAAI,KAAK,UAAU;YAClC;QACF;QAEA,MAAMW,UAAUR,KAAKS,KAAK,CAACF,MAAMV,IAAI;QAErC,gEAAgE;QAChE,0CAA0C;QAC1C,IAAI,CAACP,qBAAqBkB,YAAYA,QAAQN,MAAM,8BAAK,IAAI,EAAEQ,QAAM;YACnE;QACF;QAEA,IAAI,CAACC,OAAO,CAACH,QAAQX,IAAI;IAC3B;IAEAe,WAAW;QACTpB,gCAAO,IAAI,EAAEM;QACb,gCAAgC;QAChC,6DAA6D;QAC7D,yBAAA,IAAI,EAAEA,UAAQe,yBAAyB,CAAC,IAAI,CAACP,UAAU;IACzD;IApEA;;;;;;;;GAQC,GACDQ,YAAY,EAAEJ,IAAI,EAAER,MAAM,EAAEa,UAAU,EAAqB,CAAE;QAC3D,KAAK;QAhBP,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAcQL,OAAOA;uCACPR,SAASA;QAEf,IAAI,CAACI,UAAU,GAAG,IAAI,CAACA,UAAU,CAACU,IAAI,CAAC,IAAI;QAE3C,0DAA0D;QAC1D,yFAAyF;QACzFD,aACGE,IAAI,CAAC,CAACnB;2CACCA,UAAUA;YAChB,gCAAgC;YAChC,6DAA6D;YAC7DA,QAAQoB,uBAAuB,CAAC,IAAI,CAACZ,UAAU;YAC/C,IAAI,CAACa,UAAU;QACjB,GACCC,KAAK,CAAC,CAACC;YACN9B,SAAS8B;QACX;IACJ;AAuCF"}

package/dist/esm/services/webview/index.js

@@ -0,0 +1,3 @@
+export * from './WebViewExecutionService';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/services/webview/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/services/webview/index.ts"],"sourcesContent":["export * from './WebViewExecutionService';\n"],"names":[],"mappings":"AAAA,cAAc,4BAA4B"}