@metamask/snaps-controllers 11.2.2 → 12.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/CHANGELOG.md +30 -1
  2. package/dist/cronjob/CronjobController.cjs +6 -9
  3. package/dist/cronjob/CronjobController.cjs.map +1 -1
  4. package/dist/cronjob/CronjobController.d.cts +1 -1
  5. package/dist/cronjob/CronjobController.d.cts.map +1 -1
  6. package/dist/cronjob/CronjobController.d.mts +1 -1
  7. package/dist/cronjob/CronjobController.d.mts.map +1 -1
  8. package/dist/cronjob/CronjobController.mjs +6 -9
  9. package/dist/cronjob/CronjobController.mjs.map +1 -1
  10. package/dist/services/AbstractExecutionService.cjs +1 -1
  11. package/dist/services/AbstractExecutionService.cjs.map +1 -1
  12. package/dist/services/AbstractExecutionService.mjs +2 -2
  13. package/dist/services/AbstractExecutionService.mjs.map +1 -1
  14. package/dist/services/browser.cjs +0 -3
  15. package/dist/services/browser.cjs.map +1 -1
  16. package/dist/services/browser.d.cts +0 -1
  17. package/dist/services/browser.d.cts.map +1 -1
  18. package/dist/services/browser.d.mts +0 -1
  19. package/dist/services/browser.d.mts.map +1 -1
  20. package/dist/services/browser.mjs +0 -1
  21. package/dist/services/browser.mjs.map +1 -1
  22. package/dist/services/index.cjs +0 -3
  23. package/dist/services/index.cjs.map +1 -1
  24. package/dist/services/index.d.cts +0 -1
  25. package/dist/services/index.d.cts.map +1 -1
  26. package/dist/services/index.d.mts +0 -1
  27. package/dist/services/index.d.mts.map +1 -1
  28. package/dist/services/index.mjs +0 -1
  29. package/dist/services/index.mjs.map +1 -1
  30. package/dist/services/node-js/NodeProcessExecutionService.cjs +3 -3
  31. package/dist/services/node-js/NodeProcessExecutionService.cjs.map +1 -1
  32. package/dist/services/node-js/NodeProcessExecutionService.d.cts.map +1 -1
  33. package/dist/services/node-js/NodeProcessExecutionService.d.mts.map +1 -1
  34. package/dist/services/node-js/NodeProcessExecutionService.mjs +2 -2
  35. package/dist/services/node-js/NodeProcessExecutionService.mjs.map +1 -1
  36. package/dist/services/node-js/NodeThreadExecutionService.cjs +3 -3
  37. package/dist/services/node-js/NodeThreadExecutionService.cjs.map +1 -1
  38. package/dist/services/node-js/NodeThreadExecutionService.d.cts.map +1 -1
  39. package/dist/services/node-js/NodeThreadExecutionService.d.mts.map +1 -1
  40. package/dist/services/node-js/NodeThreadExecutionService.mjs +2 -2
  41. package/dist/services/node-js/NodeThreadExecutionService.mjs.map +1 -1
  42. package/dist/services/webview/WebViewMessageStream.cjs +6 -9
  43. package/dist/services/webview/WebViewMessageStream.cjs.map +1 -1
  44. package/dist/services/webview/WebViewMessageStream.d.cts.map +1 -1
  45. package/dist/services/webview/WebViewMessageStream.d.mts.map +1 -1
  46. package/dist/services/webview/WebViewMessageStream.mjs +4 -7
  47. package/dist/services/webview/WebViewMessageStream.mjs.map +1 -1
  48. package/dist/snaps/SnapController.cjs +36 -18
  49. package/dist/snaps/SnapController.cjs.map +1 -1
  50. package/dist/snaps/SnapController.d.cts +13 -15
  51. package/dist/snaps/SnapController.d.cts.map +1 -1
  52. package/dist/snaps/SnapController.d.mts +13 -15
  53. package/dist/snaps/SnapController.d.mts.map +1 -1
  54. package/dist/snaps/SnapController.mjs +37 -19
  55. package/dist/snaps/SnapController.mjs.map +1 -1
  56. package/dist/snaps/registry/json.cjs +3 -12
  57. package/dist/snaps/registry/json.cjs.map +1 -1
  58. package/dist/snaps/registry/json.d.cts.map +1 -1
  59. package/dist/snaps/registry/json.d.mts.map +1 -1
  60. package/dist/snaps/registry/json.mjs +3 -12
  61. package/dist/snaps/registry/json.mjs.map +1 -1
  62. package/dist/snaps/registry/registry.cjs.map +1 -1
  63. package/dist/snaps/registry/registry.d.cts +1 -1
  64. package/dist/snaps/registry/registry.d.cts.map +1 -1
  65. package/dist/snaps/registry/registry.d.mts +1 -1
  66. package/dist/snaps/registry/registry.d.mts.map +1 -1
  67. package/dist/snaps/registry/registry.mjs.map +1 -1
  68. package/dist/types/controllers.cjs.map +1 -1
  69. package/dist/types/controllers.d.cts +2 -2
  70. package/dist/types/controllers.d.mts +2 -2
  71. package/dist/types/controllers.mjs.map +1 -1
  72. package/dist/utils.cjs +63 -1
  73. package/dist/utils.cjs.map +1 -1
  74. package/dist/utils.d.cts +24 -0
  75. package/dist/utils.d.cts.map +1 -1
  76. package/dist/utils.d.mts +24 -0
  77. package/dist/utils.d.mts.map +1 -1
  78. package/dist/utils.mjs +61 -1
  79. package/dist/utils.mjs.map +1 -1
  80. package/package.json +11 -11
  81. package/dist/services/webworker/WebWorkerExecutionService.cjs +0 -112
  82. package/dist/services/webworker/WebWorkerExecutionService.cjs.map +0 -1
  83. package/dist/services/webworker/WebWorkerExecutionService.d.cts +0 -47
  84. package/dist/services/webworker/WebWorkerExecutionService.d.cts.map +0 -1
  85. package/dist/services/webworker/WebWorkerExecutionService.d.mts +0 -47
  86. package/dist/services/webworker/WebWorkerExecutionService.d.mts.map +0 -1
  87. package/dist/services/webworker/WebWorkerExecutionService.mjs +0 -108
  88. package/dist/services/webworker/WebWorkerExecutionService.mjs.map +0 -1
  89. package/dist/services/webworker/index.cjs +0 -18
  90. package/dist/services/webworker/index.cjs.map +0 -1
  91. package/dist/services/webworker/index.d.cts +0 -2
  92. package/dist/services/webworker/index.d.cts.map +0 -1
  93. package/dist/services/webworker/index.d.mts +0 -2
  94. package/dist/services/webworker/index.d.mts.map +0 -1
  95. package/dist/services/webworker/index.mjs +0 -2
  96. package/dist/services/webworker/index.mjs.map +0 -1
@@ -1,108 +0,0 @@
1
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
2
- if (kind === "m") throw new TypeError("Private method is not writable");
3
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
4
- 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");
5
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
6
- };
7
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
8
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
9
- 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");
10
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
- };
12
- var _WebWorkerExecutionService_documentUrl, _WebWorkerExecutionService_runtimeStream;
13
- import { WindowPostMessageStream } from "@metamask/post-message-stream";
14
- import { createWindow } from "@metamask/snaps-utils";
15
- import { assert } from "@metamask/utils";
16
- import { nanoid } from "nanoid";
17
- import { AbstractExecutionService } from "../AbstractExecutionService.mjs";
18
- import { ProxyPostMessageStream } from "../ProxyPostMessageStream.mjs";
19
- export const WORKER_POOL_ID = 'snaps-worker-pool';
20
- export class WebWorkerExecutionService extends AbstractExecutionService {
21
- /**
22
- * Create a new webworker execution service.
23
- *
24
- * @param args - The constructor arguments.
25
- * @param args.documentUrl - The URL of the worker pool document to use as the
26
- * execution environment.
27
- * @param args.messenger - The messenger to use for communication with the
28
- * `SnapController`.
29
- * @param args.setupSnapProvider - The function to use to set up the snap
30
- * provider.
31
- */
32
- constructor({ documentUrl, messenger, setupSnapProvider, ...args }) {
33
- super({
34
- ...args,
35
- messenger,
36
- setupSnapProvider,
37
- });
38
- _WebWorkerExecutionService_documentUrl.set(this, void 0);
39
- _WebWorkerExecutionService_runtimeStream.set(this, void 0);
40
- __classPrivateFieldSet(this, _WebWorkerExecutionService_documentUrl, documentUrl, "f");
41
- }
42
- /**
43
- * Send a termination command to the worker pool document.
44
- *
45
- * @param job - The job to terminate.
46
- */
47
- // TODO: Either fix this lint violation or explain why it's necessary to
48
- // ignore.
49
- // eslint-disable-next-line @typescript-eslint/no-misused-promises
50
- async terminateJob(job) {
51
- // The `AbstractExecutionService` will have already closed the job stream,
52
- // so we write to the runtime stream directly.
53
- assert(__classPrivateFieldGet(this, _WebWorkerExecutionService_runtimeStream, "f"), 'Runtime stream not initialized.');
54
- __classPrivateFieldGet(this, _WebWorkerExecutionService_runtimeStream, "f").write({
55
- jobId: job.id,
56
- data: {
57
- jsonrpc: '2.0',
58
- method: 'terminateJob',
59
- id: nanoid(),
60
- },
61
- });
62
- }
63
- /**
64
- * Create a new stream for the specified job. This wraps the runtime stream
65
- * in a stream specific to the job.
66
- *
67
- * @param jobId - The job ID.
68
- * @returns An object with the worker ID and stream.
69
- */
70
- async initEnvStream(jobId) {
71
- // Lazily create the worker pool document.
72
- await this.createDocument();
73
- // `createDocument` should have initialized the runtime stream.
74
- assert(__classPrivateFieldGet(this, _WebWorkerExecutionService_runtimeStream, "f"), 'Runtime stream not initialized.');
75
- const stream = new ProxyPostMessageStream({
76
- stream: __classPrivateFieldGet(this, _WebWorkerExecutionService_runtimeStream, "f"),
77
- jobId,
78
- });
79
- return { worker: jobId, stream };
80
- }
81
- /**
82
- * Creates the worker pool document to be used as the execution environment.
83
- *
84
- * If the document already exists, this does nothing.
85
- */
86
- // TODO: Either fix this lint violation or explain why it's necessary to
87
- // ignore.
88
- // eslint-disable-next-line no-restricted-syntax
89
- async createDocument() {
90
- // We only want to create a single pool.
91
- if (document.getElementById(WORKER_POOL_ID)) {
92
- return;
93
- }
94
- const window = await createWindow({
95
- uri: __classPrivateFieldGet(this, _WebWorkerExecutionService_documentUrl, "f").href,
96
- id: WORKER_POOL_ID,
97
- sandbox: false,
98
- });
99
- __classPrivateFieldSet(this, _WebWorkerExecutionService_runtimeStream, new WindowPostMessageStream({
100
- name: 'parent',
101
- target: 'child',
102
- targetWindow: window,
103
- targetOrigin: '*',
104
- }), "f");
105
- }
106
- }
107
- _WebWorkerExecutionService_documentUrl = new WeakMap(), _WebWorkerExecutionService_runtimeStream = new WeakMap();
108
- //# sourceMappingURL=WebWorkerExecutionService.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"WebWorkerExecutionService.mjs","sourceRoot":"","sources":["../../../src/services/webworker/WebWorkerExecutionService.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,EAAE,uBAAuB,EAAE,sCAAsC;AACxE,OAAO,EAAE,YAAY,EAAE,8BAA8B;AACrD,OAAO,EAAE,MAAM,EAAE,wBAAwB;AACzC,OAAO,EAAE,MAAM,EAAE,eAAe;AAMhC,OAAO,EAAE,wBAAwB,EAAE,wCAAoC;AACvE,OAAO,EAAE,sBAAsB,EAAE,sCAAkC;AAMnE,MAAM,CAAC,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAElD,MAAM,OAAO,yBAA0B,SAAQ,wBAAgC;IAK7E;;;;;;;;;;OAUG;IACH,YAAY,EACV,WAAW,EACX,SAAS,EACT,iBAAiB,EACjB,GAAG,IAAI,EACkC;QACzC,KAAK,CAAC;YACJ,GAAG,IAAI;YACP,SAAS;YACT,iBAAiB;SAClB,CAAC,CAAC;QAzBI,yDAAkB;QAE3B,2DAAuC;QAyBrC,uBAAA,IAAI,0CAAgB,WAAW,MAAA,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,wEAAwE;IACxE,WAAW;IACX,kEAAkE;IACxD,KAAK,CAAC,YAAY,CAAC,GAA6B;QACxD,0EAA0E;QAC1E,8CAA8C;QAC9C,MAAM,CAAC,uBAAA,IAAI,gDAAe,EAAE,iCAAiC,CAAC,CAAC;QAC/D,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,MAAM,EAAE;aACb;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,aAAa,CAAC,KAAa;QACzC,0CAA0C;QAC1C,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAE5B,+DAA+D;QAC/D,MAAM,CAAC,uBAAA,IAAI,gDAAe,EAAE,iCAAiC,CAAC,CAAC;QAE/D,MAAM,MAAM,GAAG,IAAI,sBAAsB,CAAC;YACxC,MAAM,EAAE,uBAAA,IAAI,gDAAe;YAC3B,KAAK;SACN,CAAC,CAAC;QAEH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,wEAAwE;IACxE,WAAW;IACX,gDAAgD;IACxC,KAAK,CAAC,cAAc;QAC1B,wCAAwC;QACxC,IAAI,QAAQ,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5C,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC;YAChC,GAAG,EAAE,uBAAA,IAAI,8CAAa,CAAC,IAAI;YAC3B,EAAE,EAAE,cAAc;YAClB,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;QAEH,uBAAA,IAAI,4CAAkB,IAAI,uBAAuB,CAAC;YAChD,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,YAAY,EAAE,MAAM;YACpB,YAAY,EAAE,GAAG;SAClB,CAAC,MAAA,CAAC;IACL,CAAC;CACF","sourcesContent":["import type { BasePostMessageStream } from '@metamask/post-message-stream';\nimport { WindowPostMessageStream } from '@metamask/post-message-stream';\nimport { createWindow } from '@metamask/snaps-utils';\nimport { assert } from '@metamask/utils';\nimport { nanoid } from 'nanoid';\n\nimport type {\n ExecutionServiceArgs,\n TerminateJobArgs,\n} from '../AbstractExecutionService';\nimport { AbstractExecutionService } from '../AbstractExecutionService';\nimport { ProxyPostMessageStream } from '../ProxyPostMessageStream';\n\ntype WebWorkerExecutionEnvironmentServiceArgs = {\n documentUrl: URL;\n} & ExecutionServiceArgs;\n\nexport const WORKER_POOL_ID = 'snaps-worker-pool';\n\nexport class WebWorkerExecutionService extends AbstractExecutionService<string> {\n readonly #documentUrl: URL;\n\n #runtimeStream?: BasePostMessageStream;\n\n /**\n * Create a new webworker execution service.\n *\n * @param args - The constructor arguments.\n * @param args.documentUrl - The URL of the worker pool document to use as the\n * execution environment.\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 messenger,\n setupSnapProvider,\n ...args\n }: WebWorkerExecutionEnvironmentServiceArgs) {\n super({\n ...args,\n messenger,\n setupSnapProvider,\n });\n\n this.#documentUrl = documentUrl;\n }\n\n /**\n * Send a termination command to the worker pool document.\n *\n * @param job - The job to terminate.\n */\n // TODO: Either fix this lint violation or explain why it's necessary to\n // ignore.\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n protected async terminateJob(job: TerminateJobArgs<string>) {\n // The `AbstractExecutionService` will have already closed the job stream,\n // so we write to the runtime stream directly.\n assert(this.#runtimeStream, 'Runtime stream not initialized.');\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 * @returns An object with the worker ID and stream.\n */\n protected async initEnvStream(jobId: string) {\n // Lazily create the worker pool document.\n await this.createDocument();\n\n // `createDocument` should have initialized the runtime stream.\n assert(this.#runtimeStream, 'Runtime stream not initialized.');\n\n const stream = new ProxyPostMessageStream({\n stream: this.#runtimeStream,\n jobId,\n });\n\n return { worker: jobId, stream };\n }\n\n /**\n * Creates the worker pool document to be used as the execution environment.\n *\n * If the document already exists, this does nothing.\n */\n // TODO: Either fix this lint violation or explain why it's necessary to\n // ignore.\n // eslint-disable-next-line no-restricted-syntax\n private async createDocument() {\n // We only want to create a single pool.\n if (document.getElementById(WORKER_POOL_ID)) {\n return;\n }\n\n const window = await createWindow({\n uri: this.#documentUrl.href,\n id: WORKER_POOL_ID,\n sandbox: false,\n });\n\n this.#runtimeStream = new WindowPostMessageStream({\n name: 'parent',\n target: 'child',\n targetWindow: window,\n targetOrigin: '*',\n });\n }\n}\n"]}
@@ -1,18 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./WebWorkerExecutionService.cjs"), exports);
18
- //# sourceMappingURL=index.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.cjs","sourceRoot":"","sources":["../../../src/services/webworker/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kEAA4C","sourcesContent":["export * from './WebWorkerExecutionService';\n"]}
@@ -1,2 +0,0 @@
1
- export * from "./WebWorkerExecutionService.cjs";
2
- //# sourceMappingURL=index.d.cts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../../../src/services/webworker/index.ts"],"names":[],"mappings":"AAAA,gDAA4C"}
@@ -1,2 +0,0 @@
1
- export * from "./WebWorkerExecutionService.mjs";
2
- //# sourceMappingURL=index.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/services/webworker/index.ts"],"names":[],"mappings":"AAAA,gDAA4C"}
@@ -1,2 +0,0 @@
1
- export * from "./WebWorkerExecutionService.mjs";
2
- //# sourceMappingURL=index.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/services/webworker/index.ts"],"names":[],"mappings":"AAAA,gDAA4C","sourcesContent":["export * from './WebWorkerExecutionService';\n"]}