@metamask-previews/composable-controller 3.0.0-preview.d32a7cc

package/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [3.0.0]
+### Changed
+- **BREAKING:** Bump to Node 16 ([#1262](https://github.com/MetaMask/core/pull/1262))
+
+## [2.0.0]
+### Removed
+- **BREAKING:** Remove `isomorphic-fetch` ([#1106](https://github.com/MetaMask/controllers/pull/1106))
+  - Consumers must now import `isomorphic-fetch` or another polyfill themselves if they are running in an environment without `fetch`
+
+## [1.0.2]
+### Changed
+- Rename this repository to `core` ([#1031](https://github.com/MetaMask/controllers/pull/1031))
+- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041)) 
+
+## [1.0.1]
+### Changed
+- Relax dependency on `@metamask/controller-utils` (use `^` instead of `~`) ([#998](https://github.com/MetaMask/core/pull/998))
+
+## [1.0.0]
+### Added
+- Initial release
+  - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/core/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/core/tree/v33.0.0), namely:
+    - `src/ComposableController.ts`
+    - `src/ComposableController.test.ts`
+
+    All changes listed after this point were applied to this package following the monorepo conversion.
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@3.0.0...HEAD
+[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@2.0.0...@metamask/composable-controller@3.0.0
+[2.0.0]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@1.0.2...@metamask/composable-controller@2.0.0
+[1.0.2]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@1.0.1...@metamask/composable-controller@1.0.2
+[1.0.1]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@1.0.0...@metamask/composable-controller@1.0.1
+[1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/composable-controller@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2018 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/composable-controller`
+
+Consolidates the state from multiple controllers into one.
+
+## Installation
+
+`yarn add @metamask/composable-controller`
+
+or
+
+`npm install @metamask/composable-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/ComposableController.d.ts

@@ -0,0 +1,44 @@
+import type { RestrictedControllerMessenger } from '@metamask/base-controller';
+import { BaseController } from '@metamask/base-controller';
+/**
+ * List of child controller instances
+ *
+ * This type encompasses controllers based up either BaseController or
+ * BaseControllerV2. The BaseControllerV2 type can't be included directly
+ * because the generic parameters it expects require knowing the exact state
+ * shape, so instead we look for an object with the BaseControllerV2 properties
+ * that we use in the ComposableController (name and state).
+ */
+export declare type ControllerList = (BaseController<any, any> | {
+    name: string;
+    state: Record<string, unknown>;
+})[];
+export declare type ComposableControllerRestrictedMessenger = RestrictedControllerMessenger<'ComposableController', never, any, never, any>;
+/**
+ * Controller that can be used to compose multiple controllers together.
+ */
+export declare class ComposableController extends BaseController<never, any> {
+    private readonly controllers;
+    private readonly messagingSystem?;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    /**
+     * Creates a ComposableController instance.
+     *
+     * @param controllers - Map of names to controller instances.
+     * @param messenger - The controller messaging system, used for communicating with BaseControllerV2 controllers.
+     */
+    constructor(controllers: ControllerList, messenger?: ComposableControllerRestrictedMessenger);
+    /**
+     * Flat state representation, one that isn't keyed
+     * of controller name. Instead, all child controller state is merged
+     * together into a single, flat object.
+     *
+     * @returns Merged state representation of all child controllers.
+     */
+    get flatState(): {};
+}
+export default ComposableController;
+//# sourceMappingURL=ComposableController.d.ts.map

package/dist/ComposableController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComposableController.d.ts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D;;;;;;;;GAQG;AACH,oBAAY,cAAc,GAAG,CACzB,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GACxB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CACnD,EAAE,CAAC;AAEJ,oBAAY,uCAAuC,GACjD,6BAA6B,CAAC,sBAAsB,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;AAEhF;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC;IAClE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAElD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAA0C;IAE3E;;OAEG;IACM,IAAI,SAA0B;IAEvC;;;;;OAKG;gBAED,WAAW,EAAE,cAAc,EAC3B,SAAS,CAAC,EAAE,uCAAuC;IAiCrD;;;;;;OAMG;IACH,IAAI,SAAS,OAMZ;CACF;AAED,eAAe,oBAAoB,CAAC"}

package/dist/ComposableController.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComposableController = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+/**
+ * Controller that can be used to compose multiple controllers together.
+ */
+class ComposableController extends base_controller_1.BaseController {
+    /**
+     * Creates a ComposableController instance.
+     *
+     * @param controllers - Map of names to controller instances.
+     * @param messenger - The controller messaging system, used for communicating with BaseControllerV2 controllers.
+     */
+    constructor(controllers, messenger) {
+        super(undefined, controllers.reduce((state, controller) => {
+            state[controller.name] = controller.state;
+            return state;
+        }, {}));
+        this.controllers = [];
+        /**
+         * Name of this controller used during composition
+         */
+        this.name = 'ComposableController';
+        this.initialize();
+        this.controllers = controllers;
+        this.messagingSystem = messenger;
+        this.controllers.forEach((controller) => {
+            const { name } = controller;
+            if (controller.subscribe !== undefined) {
+                controller.subscribe((state) => {
+                    this.update({ [name]: state });
+                });
+            }
+            else if (this.messagingSystem) {
+                this.messagingSystem.subscribe(`${name}:stateChange`, (state) => {
+                    this.update({ [name]: state });
+                });
+            }
+            else {
+                throw new Error(`Messaging system required if any BaseControllerV2 controllers are used`);
+            }
+        });
+    }
+    /**
+     * Flat state representation, one that isn't keyed
+     * of controller name. Instead, all child controller state is merged
+     * together into a single, flat object.
+     *
+     * @returns Merged state representation of all child controllers.
+     */
+    get flatState() {
+        let flatState = {};
+        for (const controller of this.controllers) {
+            flatState = Object.assign(Object.assign({}, flatState), controller.state);
+        }
+        return flatState;
+    }
+}
+exports.ComposableController = ComposableController;
+exports.default = ComposableController;
+//# sourceMappingURL=ComposableController.js.map

package/dist/ComposableController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComposableController.js","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;AACA,+DAA2D;AAmB3D;;GAEG;AACH,MAAa,oBAAqB,SAAQ,gCAA0B;IAUlE;;;;;OAKG;IACH,YACE,WAA2B,EAC3B,SAAmD;QAEnD,KAAK,CACH,SAAS,EACT,WAAW,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;YACvC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;YAC1C,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,EAAS,CAAC,CACd,CAAC;QAzBa,gBAAW,GAAmB,EAAE,CAAC;QAIlD;;WAEG;QACM,SAAI,GAAG,sBAAsB,CAAC;QAmBrC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACtC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;YAC5B,IAAK,UAAuC,CAAC,SAAS,KAAK,SAAS,EAAE;gBACnE,UAAuC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC3D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjC,CAAC,CAAC,CAAC;aACJ;iBAAM,IAAI,IAAI,CAAC,eAAe,EAAE;gBAC9B,IAAI,CAAC,eAAe,CAAC,SAAiB,CACrC,GAAG,IAAI,cAAc,EACrB,CAAC,KAAU,EAAE,EAAE;oBACb,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjC,CAAC,CACF,CAAC;aACH;iBAAM;gBACL,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,IAAI,SAAS;QACX,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,SAAS,mCAAQ,SAAS,GAAK,UAAU,CAAC,KAAK,CAAE,CAAC;SACnD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAjED,oDAiEC;AAED,kBAAe,oBAAoB,CAAC","sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\n\n/**\n * List of child controller instances\n *\n * This type encompasses controllers based up either BaseController or\n * BaseControllerV2. The BaseControllerV2 type can't be included directly\n * because the generic parameters it expects require knowing the exact state\n * shape, so instead we look for an object with the BaseControllerV2 properties\n * that we use in the ComposableController (name and state).\n */\nexport type ControllerList = (\n  | BaseController<any, any>\n  | { name: string; state: Record<string, unknown> }\n)[];\n\nexport type ComposableControllerRestrictedMessenger =\n  RestrictedControllerMessenger<'ComposableController', never, any, never, any>;\n\n/**\n * Controller that can be used to compose multiple controllers together.\n */\nexport class ComposableController extends BaseController<never, any> {\n  private readonly controllers: ControllerList = [];\n\n  private readonly messagingSystem?: ComposableControllerRestrictedMessenger;\n\n  /**\n   * Name of this controller used during composition\n   */\n  override name = 'ComposableController';\n\n  /**\n   * Creates a ComposableController instance.\n   *\n   * @param controllers - Map of names to controller instances.\n   * @param messenger - The controller messaging system, used for communicating with BaseControllerV2 controllers.\n   */\n  constructor(\n    controllers: ControllerList,\n    messenger?: ComposableControllerRestrictedMessenger,\n  ) {\n    super(\n      undefined,\n      controllers.reduce((state, controller) => {\n        state[controller.name] = controller.state;\n        return state;\n      }, {} as any),\n    );\n    this.initialize();\n    this.controllers = controllers;\n    this.messagingSystem = messenger;\n    this.controllers.forEach((controller) => {\n      const { name } = controller;\n      if ((controller as BaseController<any, any>).subscribe !== undefined) {\n        (controller as BaseController<any, any>).subscribe((state) => {\n          this.update({ [name]: state });\n        });\n      } else if (this.messagingSystem) {\n        (this.messagingSystem.subscribe as any)(\n          `${name}:stateChange`,\n          (state: any) => {\n            this.update({ [name]: state });\n          },\n        );\n      } else {\n        throw new Error(\n          `Messaging system required if any BaseControllerV2 controllers are used`,\n        );\n      }\n    });\n  }\n\n  /**\n   * Flat state representation, one that isn't keyed\n   * of controller name. Instead, all child controller state is merged\n   * together into a single, flat object.\n   *\n   * @returns Merged state representation of all child controllers.\n   */\n  get flatState() {\n    let flatState = {};\n    for (const controller of this.controllers) {\n      flatState = { ...flatState, ...controller.state };\n    }\n    return flatState;\n  }\n}\n\nexport default ComposableController;\n"]}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ComposableController';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"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("./ComposableController"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC","sourcesContent":["export * from './ComposableController';\n"]}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@metamask-previews/composable-controller",
+  "version": "3.0.0-preview.d32a7cc",
+  "description": "Consolidates the state from multiple controllers into one",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/composable-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build:docs": "typedoc",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/composable-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@metamask-previews/base-controller": "3.2.0-preview.d32a7cc"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.1.0",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "immer": "^9.0.6",
+    "jest": "^27.5.1",
+    "sinon": "^9.2.4",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typescript": "~4.6.3"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}