@metamask/snaps-controllers 13.0.0 → 13.1.0

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [13.1.0]
+
+### Added
+
+- Add `WebSocketService` for WebSockets support ([#3450](https://github.com/MetaMask/snaps/pull/3450))
+  - This service must be instantiated to invoke `onWebSocketEvent` when WebSocket
+  messages are received.
+- Add `SnapController:init` to support `onStart` handler ([#3455](https://github.com/MetaMask/snaps/pull/3455))
+  - This function should be called when the client has been fully started.
+
 ## [13.0.0]
 
 ### Changed
@@ -809,7 +819,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@13.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@13.1.0...HEAD
+[13.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@13.0.0...@metamask/snaps-controllers@13.1.0
 [13.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@12.3.1...@metamask/snaps-controllers@13.0.0
 [12.3.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@12.3.0...@metamask/snaps-controllers@12.3.1
 [12.3.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@12.2.0...@metamask/snaps-controllers@12.3.0

package/dist/index.cjs

@@ -21,4 +21,5 @@ __exportStar(require("./cronjob/index.cjs"), exports);
 __exportStar(require("./interface/index.cjs"), exports);
 __exportStar(require("./insights/index.cjs"), exports);
 __exportStar(require("./multichain/index.cjs"), exports);
+__exportStar(require("./websocket/index.cjs"), exports);
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,uDAA2B;AAC3B,oDAAwB;AACxB,8CAAwB;AACxB,sDAA0B;AAC1B,wDAA4B;AAC5B,uDAA2B;AAC3B,yDAA6B","sourcesContent":["export type { Json } from '@metamask/utils';\nexport * from './services';\nexport * from './snaps';\nexport * from './utils';\nexport * from './cronjob';\nexport * from './interface';\nexport * from './insights';\nexport * from './multichain';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,uDAA2B;AAC3B,oDAAwB;AACxB,8CAAwB;AACxB,sDAA0B;AAC1B,wDAA4B;AAC5B,uDAA2B;AAC3B,yDAA6B;AAC7B,wDAA4B","sourcesContent":["export type { Json } from '@metamask/utils';\nexport * from './services';\nexport * from './snaps';\nexport * from './utils';\nexport * from './cronjob';\nexport * from './interface';\nexport * from './insights';\nexport * from './multichain';\nexport * from './websocket';\n"]}

package/dist/index.d.cts

@@ -6,4 +6,5 @@ export * from "./cronjob/index.cjs";
 export * from "./interface/index.cjs";
 export * from "./insights/index.cjs";
 export * from "./multichain/index.cjs";
+export * from "./websocket/index.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,wBAAwB;AAC5C,qCAA2B;AAC3B,kCAAwB;AACxB,4BAAwB;AACxB,oCAA0B;AAC1B,sCAA4B;AAC5B,qCAA2B;AAC3B,uCAA6B"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,wBAAwB;AAC5C,qCAA2B;AAC3B,kCAAwB;AACxB,4BAAwB;AACxB,oCAA0B;AAC1B,sCAA4B;AAC5B,qCAA2B;AAC3B,uCAA6B;AAC7B,sCAA4B"}

package/dist/index.d.mts

@@ -6,4 +6,5 @@ export * from "./cronjob/index.mjs";
 export * from "./interface/index.mjs";
 export * from "./insights/index.mjs";
 export * from "./multichain/index.mjs";
+export * from "./websocket/index.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,wBAAwB;AAC5C,qCAA2B;AAC3B,kCAAwB;AACxB,4BAAwB;AACxB,oCAA0B;AAC1B,sCAA4B;AAC5B,qCAA2B;AAC3B,uCAA6B"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,IAAI,EAAE,wBAAwB;AAC5C,qCAA2B;AAC3B,kCAAwB;AACxB,4BAAwB;AACxB,oCAA0B;AAC1B,sCAA4B;AAC5B,qCAA2B;AAC3B,uCAA6B;AAC7B,sCAA4B"}

package/dist/index.mjs

@@ -5,4 +5,5 @@ export * from "./cronjob/index.mjs";
 export * from "./interface/index.mjs";
 export * from "./insights/index.mjs";
 export * from "./multichain/index.mjs";
+export * from "./websocket/index.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,qCAA2B;AAC3B,kCAAwB;AACxB,4BAAwB;AACxB,oCAA0B;AAC1B,sCAA4B;AAC5B,qCAA2B;AAC3B,uCAA6B","sourcesContent":["export type { Json } from '@metamask/utils';\nexport * from './services';\nexport * from './snaps';\nexport * from './utils';\nexport * from './cronjob';\nexport * from './interface';\nexport * from './insights';\nexport * from './multichain';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,qCAA2B;AAC3B,kCAAwB;AACxB,4BAAwB;AACxB,oCAA0B;AAC1B,sCAA4B;AAC5B,qCAA2B;AAC3B,uCAA6B;AAC7B,sCAA4B","sourcesContent":["export type { Json } from '@metamask/utils';\nexport * from './services';\nexport * from './snaps';\nexport * from './utils';\nexport * from './cronjob';\nexport * from './interface';\nexport * from './insights';\nexport * from './multichain';\nexport * from './websocket';\n"]}

package/dist/snaps/SnapController.cjs

@@ -249,6 +249,7 @@ class SnapController extends base_controller_1.BaseController {
      * actions.
      */
     #registerMessageHandlers() {
+        this.messagingSystem.registerActionHandler(`${exports.controllerName}:init`, (...args) => this.init(...args));
         this.messagingSystem.registerActionHandler(`${exports.controllerName}:clearSnapState`, (...args) => this.clearSnapState(...args));
         this.messagingSystem.registerActionHandler(`${exports.controllerName}:get`, (...args) => this.get(...args));
         this.messagingSystem.registerActionHandler(`${exports.controllerName}:getSnapState`, async (...args) => this.getSnapState(...args));
@@ -271,6 +272,24 @@ class SnapController extends base_controller_1.BaseController {
         this.messagingSystem.registerActionHandler(`${exports.controllerName}:stopAllSnaps`, async (...args) => this.stopAllSnaps(...args));
         this.messagingSystem.registerActionHandler(`${exports.controllerName}:isMinimumPlatformVersion`, (...args) => this.isMinimumPlatformVersion(...args));
     }
+    /**
+     * Initialise the SnapController.
+     *
+     * Currently this method calls the `onStart` lifecycle hook for all
+     * installed Snaps.
+     */
+    init() {
+        const snaps = this.getRunnableSnaps();
+        for (const { id } of snaps) {
+            const hasLifecycleHooksEndowment = this.messagingSystem.call('PermissionController:hasPermission', id, snaps_rpc_methods_1.SnapEndowments.LifecycleHooks);
+            if (!hasLifecycleHooksEndowment) {
+                continue;
+            }
+            this.#callLifecycleHook(constants_1.METAMASK_ORIGIN, id, snaps_utils_1.HandlerType.OnStart).catch((error) => {
+                (0, snaps_utils_1.logError)(`Error when calling \`onStart\` lifecycle hook for Snap "${id}": ${(0, snaps_sdk_1.getErrorMessage)(error)}`);
+            });
+        }
+    }
     #handlePreinstalledSnaps(preinstalledSnaps) {
         for (const { snapId, manifest, files, removable, hidden, hideSnapBranding, } of preinstalledSnaps) {
             const existingSnap = this.get(snapId);