@metamask/polling-controller 0.0.0 → 0.1.0

package/CHANGELOG.md

@@ -6,4 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/MetaMask/core/
+## [0.1.0]
+### Added
+- Initial release
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/polling-controller@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/polling-controller@0.1.0

package/dist/PollingController.d.ts

@@ -0,0 +1,96 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { BaseController, BaseControllerV2 } from '@metamask/base-controller';
+import type { NetworkClientId } from '@metamask/network-controller';
+export declare const PollingController: (abstract new (...args: any[]) => {
+    readonly "__#112124@#networkClientIdTokensMap": Map<NetworkClientId, Set<string>>;
+    readonly "__#112124@#intervalIds": Record<NetworkClientId, NodeJS.Timeout>;
+    "__#112124@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
+    "__#112124@#intervalLength": number;
+    getIntervalLength(): number;
+    /**
+     * Sets the length of the polling interval
+     *
+     * @param length - The length of the polling interval in milliseconds
+     */
+    setIntervalLength(length: number): void;
+    /**
+     * Starts polling for a networkClientId
+     *
+     * @param networkClientId - The networkClientId to start polling for
+     * @returns void
+     */
+    startPollingByNetworkClientId(networkClientId: NetworkClientId): string;
+    /**
+     * Stops polling for all networkClientIds
+     */
+    stopAllPolling(): void;
+    /**
+     * Stops polling for a networkClientId
+     *
+     * @param pollingToken - The polling token to stop polling for
+     */
+    stopPollingByNetworkClientId(pollingToken: string): void;
+    /**
+     * Executes the poll for a networkClientId
+     *
+     * @param networkClientId - The networkClientId to execute the poll for
+     */
+    executePoll(networkClientId: NetworkClientId): Promise<void>;
+    "__#112124@#poll"(networkClientId: NetworkClientId): void;
+    /**
+     * Adds a callback to execute when polling is complete
+     *
+     * @param networkClientId - The networkClientId to listen for polling complete events
+     * @param callback - The callback to execute when polling is complete
+     */
+    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void): void;
+}) & typeof BaseControllerV2;
+export declare const PollingControllerV1: (abstract new (...args: any[]) => {
+    readonly "__#112124@#networkClientIdTokensMap": Map<NetworkClientId, Set<string>>;
+    readonly "__#112124@#intervalIds": Record<NetworkClientId, NodeJS.Timeout>;
+    "__#112124@#callbacks": Map<string, Set<(networkClientId: NetworkClientId) => void>>;
+    "__#112124@#intervalLength": number;
+    getIntervalLength(): number;
+    /**
+     * Sets the length of the polling interval
+     *
+     * @param length - The length of the polling interval in milliseconds
+     */
+    setIntervalLength(length: number): void;
+    /**
+     * Starts polling for a networkClientId
+     *
+     * @param networkClientId - The networkClientId to start polling for
+     * @returns void
+     */
+    startPollingByNetworkClientId(networkClientId: NetworkClientId): string;
+    /**
+     * Stops polling for all networkClientIds
+     */
+    stopAllPolling(): void;
+    /**
+     * Stops polling for a networkClientId
+     *
+     * @param pollingToken - The polling token to stop polling for
+     */
+    stopPollingByNetworkClientId(pollingToken: string): void;
+    /**
+     * Executes the poll for a networkClientId
+     *
+     * @param networkClientId - The networkClientId to execute the poll for
+     */
+    executePoll(networkClientId: NetworkClientId): Promise<void>;
+    "__#112124@#poll"(networkClientId: NetworkClientId): void;
+    /**
+     * Adds a callback to execute when polling is complete
+     *
+     * @param networkClientId - The networkClientId to listen for polling complete events
+     * @param callback - The callback to execute when polling is complete
+     */
+    onPollingCompleteByNetworkClientId(networkClientId: NetworkClientId, callback: (networkClientId: NetworkClientId) => void): void;
+}) & typeof BaseController;
+//# sourceMappingURL=PollingController.d.ts.map

package/dist/PollingController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PollingController.d.ts","sourceRoot":"","sources":["../src/PollingController.ts"],"names":[],"mappings":";;;;;AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AA4JpE,eAAO,MAAM,iBAAiB,0BAvJG,GAAG,EAAE;oDAgBE,IAAI,eAAe,EAAE,IAAI,MAAM,CAAC,CAAC;uCAG9C,OAAO,eAAe,EAAE,OAAO,OAAO,CAAC;8DAItC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;OAKG;mDAC4C,eAAe;IAc9D;;OAEG;;IASH;;;;OAIG;+CACwC,MAAM;IA2BjD;;;;OAIG;iCACmC,eAAe,GAAG,QAAQ,IAAI,CAAC;uCAE9C,eAAe;IAkBtC;;;;;OAKG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI;4BAce,CAAC;AAC1E,eAAO,MAAM,mBAAmB,0BAxJC,GAAG,EAAE;oDAgBE,IAAI,eAAe,EAAE,IAAI,MAAM,CAAC,CAAC;uCAG9C,OAAO,eAAe,EAAE,OAAO,OAAO,CAAC;8DAItC,eAAe,KAAK,IAAI;;;IAShD;;;;OAIG;8BACuB,MAAM;IAIhC;;;;;OAKG;mDAC4C,eAAe;IAc9D;;OAEG;;IASH;;;;OAIG;+CACwC,MAAM;IA2BjD;;;;OAIG;iCACmC,eAAe,GAAG,QAAQ,IAAI,CAAC;uCAE9C,eAAe;IAkBtC;;;;;OAKG;wDAEgB,eAAe,8BACJ,eAAe,KAAK,IAAI;0BAee,CAAC"}

package/dist/PollingController.js

@@ -0,0 +1,161 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 __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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PollingControllerV1 = exports.PollingController = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const uuid_1 = require("uuid");
+/**
+ * PollingControllerMixin
+ *
+ * @param Base - The base class to mix onto.
+ * @returns The composed class.
+ */
+function PollingControllerMixin(Base) {
+    var _PollingControllerBase_instances, _PollingControllerBase_networkClientIdTokensMap, _PollingControllerBase_intervalIds, _PollingControllerBase_callbacks, _PollingControllerBase_intervalLength, _PollingControllerBase_poll;
+    /**
+     * PollingController is an abstract class that implements the polling
+     * functionality for a controller. It is meant to be extended by a controller
+     * that needs to poll for data by networkClientId.
+     *
+     */
+    class PollingControllerBase extends Base {
+        constructor() {
+            super(...arguments);
+            _PollingControllerBase_instances.add(this);
+            _PollingControllerBase_networkClientIdTokensMap.set(this, new Map());
+            _PollingControllerBase_intervalIds.set(this, {});
+            _PollingControllerBase_callbacks.set(this, new Map());
+            _PollingControllerBase_intervalLength.set(this, 1000);
+        }
+        getIntervalLength() {
+            return __classPrivateFieldGet(this, _PollingControllerBase_intervalLength, "f");
+        }
+        /**
+         * Sets the length of the polling interval
+         *
+         * @param length - The length of the polling interval in milliseconds
+         */
+        setIntervalLength(length) {
+            __classPrivateFieldSet(this, _PollingControllerBase_intervalLength, length, "f");
+        }
+        /**
+         * Starts polling for a networkClientId
+         *
+         * @param networkClientId - The networkClientId to start polling for
+         * @returns void
+         */
+        startPollingByNetworkClientId(networkClientId) {
+            const innerPollToken = (0, uuid_1.v4)();
+            if (__classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").has(networkClientId)) {
+                const set = __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").get(networkClientId);
+                set === null || set === void 0 ? void 0 : set.add(innerPollToken);
+            }
+            else {
+                const set = new Set();
+                set.add(innerPollToken);
+                __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").set(networkClientId, set);
+            }
+            __classPrivateFieldGet(this, _PollingControllerBase_instances, "m", _PollingControllerBase_poll).call(this, networkClientId);
+            return innerPollToken;
+        }
+        /**
+         * Stops polling for all networkClientIds
+         */
+        stopAllPolling() {
+            __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").forEach((tokens, _networkClientId) => {
+                tokens.forEach((token) => {
+                    this.stopPollingByNetworkClientId(token);
+                });
+            });
+        }
+        /**
+         * Stops polling for a networkClientId
+         *
+         * @param pollingToken - The polling token to stop polling for
+         */
+        stopPollingByNetworkClientId(pollingToken) {
+            if (!pollingToken) {
+                throw new Error('pollingToken required');
+            }
+            let found = false;
+            __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").forEach((tokens, networkClientId) => {
+                var _a, _b, _c, _d;
+                if (tokens.has(pollingToken)) {
+                    found = true;
+                    (_a = __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f")
+                        .get(networkClientId)) === null || _a === void 0 ? void 0 : _a.delete(pollingToken);
+                    if (((_b = __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").get(networkClientId)) === null || _b === void 0 ? void 0 : _b.size) === 0) {
+                        clearTimeout(__classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId]);
+                        delete __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId];
+                        __classPrivateFieldGet(this, _PollingControllerBase_networkClientIdTokensMap, "f").delete(networkClientId);
+                        (_c = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(networkClientId)) === null || _c === void 0 ? void 0 : _c.forEach((callback) => {
+                            callback(networkClientId);
+                        });
+                        (_d = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(networkClientId)) === null || _d === void 0 ? void 0 : _d.clear();
+                    }
+                }
+            });
+            if (!found) {
+                throw new Error('pollingToken not found');
+            }
+        }
+        /**
+         * Adds a callback to execute when polling is complete
+         *
+         * @param networkClientId - The networkClientId to listen for polling complete events
+         * @param callback - The callback to execute when polling is complete
+         */
+        onPollingCompleteByNetworkClientId(networkClientId, callback) {
+            var _a;
+            if (__classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").has(networkClientId)) {
+                (_a = __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").get(networkClientId)) === null || _a === void 0 ? void 0 : _a.add(callback);
+            }
+            else {
+                const set = new Set();
+                set.add(callback);
+                __classPrivateFieldGet(this, _PollingControllerBase_callbacks, "f").set(networkClientId, set);
+            }
+        }
+    }
+    _PollingControllerBase_networkClientIdTokensMap = new WeakMap(), _PollingControllerBase_intervalIds = new WeakMap(), _PollingControllerBase_callbacks = new WeakMap(), _PollingControllerBase_intervalLength = new WeakMap(), _PollingControllerBase_instances = new WeakSet(), _PollingControllerBase_poll = function _PollingControllerBase_poll(networkClientId) {
+        if (__classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId]) {
+            clearTimeout(__classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId]);
+            delete __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId];
+        }
+        // setTimeout is not `await`ing this async function, which is expected
+        // We're just using async here for improved stack traces
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        __classPrivateFieldGet(this, _PollingControllerBase_intervalIds, "f")[networkClientId] = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield this.executePoll(networkClientId);
+            }
+            catch (error) {
+                console.error(error);
+            }
+            __classPrivateFieldGet(this, _PollingControllerBase_instances, "m", _PollingControllerBase_poll).call(this, networkClientId);
+        }), __classPrivateFieldGet(this, _PollingControllerBase_intervalLength, "f"));
+    };
+    return PollingControllerBase;
+}
+exports.PollingController = PollingControllerMixin(base_controller_1.BaseControllerV2);
+exports.PollingControllerV1 = PollingControllerMixin(base_controller_1.BaseController);
+//# sourceMappingURL=PollingController.js.map

package/dist/PollingController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PollingController.js","sourceRoot":"","sources":["../src/PollingController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAA6E;AAE7E,+BAAoC;AAMpC;;;;;GAKG;AACH,SAAS,sBAAsB,CAA4B,IAAW;;IACpE;;;;;OAKG;IACH,MAAe,qBAAsB,SAAQ,IAAI;QAAjD;;;YACE,0DACE,IAAI,GAAG,EAAE,EAAC;YAEZ,6CAAiE,EAAE,EAAC;YAEpE,2CAGI,IAAI,GAAG,EAAE,EAAC;YAEd,gDAAkB,IAAI,EAAC;QAyHzB,CAAC;QAvHC,iBAAiB;YACf,OAAO,uBAAA,IAAI,6CAAgB,CAAC;QAC9B,CAAC;QAED;;;;WAIG;QACH,iBAAiB,CAAC,MAAc;YAC9B,uBAAA,IAAI,yCAAmB,MAAM,MAAA,CAAC;QAChC,CAAC;QAED;;;;;WAKG;QACH,6BAA6B,CAAC,eAAgC;YAC5D,MAAM,cAAc,GAAG,IAAA,SAAM,GAAE,CAAC;YAChC,IAAI,uBAAA,IAAI,uDAA0B,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE;gBACvD,MAAM,GAAG,GAAG,uBAAA,IAAI,uDAA0B,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAChE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,GAAG,CAAC,cAAc,CAAC,CAAC;aAC1B;iBAAM;gBACL,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC9B,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;gBACxB,uBAAA,IAAI,uDAA0B,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;aAC1D;YACD,uBAAA,IAAI,qEAAM,MAAV,IAAI,EAAO,eAAe,CAAC,CAAC;YAC5B,OAAO,cAAc,CAAC;QACxB,CAAC;QAED;;WAEG;QACH,cAAc;YACZ,uBAAA,IAAI,uDAA0B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,gBAAgB,EAAE,EAAE;gBAClE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBACvB,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC;gBAC3C,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,4BAA4B,CAAC,YAAoB;YAC/C,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;aAC1C;YACD,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,uBAAA,IAAI,uDAA0B,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,eAAe,EAAE,EAAE;;gBACjE,IAAI,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE;oBAC5B,KAAK,GAAG,IAAI,CAAC;oBACb,MAAA,uBAAA,IAAI,uDAA0B;yBAC3B,GAAG,CAAC,eAAe,CAAC,0CACnB,MAAM,CAAC,YAAY,CAAC,CAAC;oBACzB,IAAI,CAAA,MAAA,uBAAA,IAAI,uDAA0B,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,IAAI,MAAK,CAAC,EAAE;wBACnE,YAAY,CAAC,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,CAAC,CAAC;wBACjD,OAAO,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,CAAC;wBAC1C,uBAAA,IAAI,uDAA0B,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;wBACvD,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;4BACzD,QAAQ,CAAC,eAAe,CAAC,CAAC;wBAC5B,CAAC,CAAC,CAAC;wBACH,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,KAAK,EAAE,CAAC;qBAC/C;iBACF;YACH,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;aAC3C;QACH,CAAC;QA2BD;;;;;WAKG;QACH,kCAAkC,CAChC,eAAgC,EAChC,QAAoD;;YAEpD,IAAI,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE;gBACxC,MAAA,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,CAAC,0CAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;aACrD;iBAAM;gBACL,MAAM,GAAG,GAAG,IAAI,GAAG,EAAmB,CAAC;gBACvC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAClB,uBAAA,IAAI,wCAAW,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;aAC3C;QACH,CAAC;KACF;uVApCO,eAAgC;QACpC,IAAI,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,EAAE;YACtC,YAAY,CAAC,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,CAAC,CAAC;YACjD,OAAO,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,CAAC;SAC3C;QACD,sEAAsE;QACtE,wDAAwD;QACxD,kEAAkE;QAClE,uBAAA,IAAI,0CAAa,CAAC,eAAe,CAAC,GAAG,UAAU,CAAC,GAAS,EAAE;YACzD,IAAI;gBACF,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;aACzC;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACtB;YACD,uBAAA,IAAI,qEAAM,MAAV,IAAI,EAAO,eAAe,CAAC,CAAC;QAC9B,CAAC,CAAA,EAAE,uBAAA,IAAI,6CAAgB,CAAC,CAAC;IAC3B,CAAC;IAqBH,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAEY,QAAA,iBAAiB,GAAG,sBAAsB,CAAC,kCAAgB,CAAC,CAAC;AAC7D,QAAA,mBAAmB,GAAG,sBAAsB,CAAC,gCAAc,CAAC,CAAC","sourcesContent":["import { BaseController, BaseControllerV2 } from '@metamask/base-controller';\nimport type { NetworkClientId } from '@metamask/network-controller';\nimport { v4 as random } from 'uuid';\n\n// Mixin classes require a constructor with an `...any[]` parameter\n// See TS2545\ntype Constructor = new (...args: any[]) => object;\n\n/**\n * PollingControllerMixin\n *\n * @param Base - The base class to mix onto.\n * @returns The composed class.\n */\nfunction PollingControllerMixin<TBase extends Constructor>(Base: TBase) {\n  /**\n   * PollingController is an abstract class that implements the polling\n   * functionality for a controller. It is meant to be extended by a controller\n   * that needs to poll for data by networkClientId.\n   *\n   */\n  abstract class PollingControllerBase extends Base {\n    readonly #networkClientIdTokensMap: Map<NetworkClientId, Set<string>> =\n      new Map();\n\n    readonly #intervalIds: Record<NetworkClientId, NodeJS.Timeout> = {};\n\n    #callbacks: Map<\n      NetworkClientId,\n      Set<(networkClientId: NetworkClientId) => void>\n    > = new Map();\n\n    #intervalLength = 1000;\n\n    getIntervalLength() {\n      return this.#intervalLength;\n    }\n\n    /**\n     * Sets the length of the polling interval\n     *\n     * @param length - The length of the polling interval in milliseconds\n     */\n    setIntervalLength(length: number) {\n      this.#intervalLength = length;\n    }\n\n    /**\n     * Starts polling for a networkClientId\n     *\n     * @param networkClientId - The networkClientId to start polling for\n     * @returns void\n     */\n    startPollingByNetworkClientId(networkClientId: NetworkClientId) {\n      const innerPollToken = random();\n      if (this.#networkClientIdTokensMap.has(networkClientId)) {\n        const set = this.#networkClientIdTokensMap.get(networkClientId);\n        set?.add(innerPollToken);\n      } else {\n        const set = new Set<string>();\n        set.add(innerPollToken);\n        this.#networkClientIdTokensMap.set(networkClientId, set);\n      }\n      this.#poll(networkClientId);\n      return innerPollToken;\n    }\n\n    /**\n     * Stops polling for all networkClientIds\n     */\n    stopAllPolling() {\n      this.#networkClientIdTokensMap.forEach((tokens, _networkClientId) => {\n        tokens.forEach((token) => {\n          this.stopPollingByNetworkClientId(token);\n        });\n      });\n    }\n\n    /**\n     * Stops polling for a networkClientId\n     *\n     * @param pollingToken - The polling token to stop polling for\n     */\n    stopPollingByNetworkClientId(pollingToken: string) {\n      if (!pollingToken) {\n        throw new Error('pollingToken required');\n      }\n      let found = false;\n      this.#networkClientIdTokensMap.forEach((tokens, networkClientId) => {\n        if (tokens.has(pollingToken)) {\n          found = true;\n          this.#networkClientIdTokensMap\n            .get(networkClientId)\n            ?.delete(pollingToken);\n          if (this.#networkClientIdTokensMap.get(networkClientId)?.size === 0) {\n            clearTimeout(this.#intervalIds[networkClientId]);\n            delete this.#intervalIds[networkClientId];\n            this.#networkClientIdTokensMap.delete(networkClientId);\n            this.#callbacks.get(networkClientId)?.forEach((callback) => {\n              callback(networkClientId);\n            });\n            this.#callbacks.get(networkClientId)?.clear();\n          }\n        }\n      });\n      if (!found) {\n        throw new Error('pollingToken not found');\n      }\n    }\n\n    /**\n     * Executes the poll for a networkClientId\n     *\n     * @param networkClientId - The networkClientId to execute the poll for\n     */\n    abstract executePoll(networkClientId: NetworkClientId): Promise<void>;\n\n    #poll(networkClientId: NetworkClientId) {\n      if (this.#intervalIds[networkClientId]) {\n        clearTimeout(this.#intervalIds[networkClientId]);\n        delete this.#intervalIds[networkClientId];\n      }\n      // setTimeout is not `await`ing this async function, which is expected\n      // We're just using async here for improved stack traces\n      // eslint-disable-next-line @typescript-eslint/no-misused-promises\n      this.#intervalIds[networkClientId] = setTimeout(async () => {\n        try {\n          await this.executePoll(networkClientId);\n        } catch (error) {\n          console.error(error);\n        }\n        this.#poll(networkClientId);\n      }, this.#intervalLength);\n    }\n\n    /**\n     * Adds a callback to execute when polling is complete\n     *\n     * @param networkClientId - The networkClientId to listen for polling complete events\n     * @param callback - The callback to execute when polling is complete\n     */\n    onPollingCompleteByNetworkClientId(\n      networkClientId: NetworkClientId,\n      callback: (networkClientId: NetworkClientId) => void,\n    ) {\n      if (this.#callbacks.has(networkClientId)) {\n        this.#callbacks.get(networkClientId)?.add(callback);\n      } else {\n        const set = new Set<typeof callback>();\n        set.add(callback);\n        this.#callbacks.set(networkClientId, set);\n      }\n    }\n  }\n  return PollingControllerBase;\n}\n\nexport const PollingController = PollingControllerMixin(BaseControllerV2);\nexport const PollingControllerV1 = PollingControllerMixin(BaseController);\n"]}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { PollingController, PollingControllerV1 } from './PollingController';
+//# 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,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PollingControllerV1 = exports.PollingController = void 0;
+var PollingController_1 = require("./PollingController");
+Object.defineProperty(exports, "PollingController", { enumerable: true, get: function () { return PollingController_1.PollingController; } });
+Object.defineProperty(exports, "PollingControllerV1", { enumerable: true, get: function () { return PollingController_1.PollingControllerV1; } });
+//# 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,yDAA6E;AAApE,sHAAA,iBAAiB,OAAA;AAAE,wHAAA,mBAAmB,OAAA","sourcesContent":["export { PollingController, PollingControllerV1 } from './PollingController';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/polling-controller",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "Polling Controller is the base for controllers that polling by networkClientId",
   "keywords": [
     "MetaMask",
@@ -25,13 +25,14 @@
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/polling-controller",
     "publish:preview": "yarn npm publish --tag preview",
     "test": "jest",
+    "test:clean": "jest --clearCache",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^3.2.2",
-    "@metamask/controller-utils": "^5.0.1",
-    "@metamask/network-controller": "^13.0.1",
-    "@metamask/utils": "^6.2.0",
+    "@metamask/base-controller": "^3.2.3",
+    "@metamask/controller-utils": "^5.0.2",
+    "@metamask/network-controller": "^14.0.0",
+    "@metamask/utils": "^8.1.0",
     "@types/uuid": "^8.3.0",
     "uuid": "^8.3.2"
   },
@@ -41,12 +42,12 @@
     "deepmerge": "^4.2.2",
     "jest": "^27.5.1",
     "ts-jest": "^27.1.4",
-    "typedoc": "^0.23.15",
-    "typedoc-plugin-missing-exports": "^0.23.0",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "~4.8.4"
   },
   "peerDependencies": {
-    "@metamask/network-controller": "^13.0.1"
+    "@metamask/network-controller": "^14.0.0"
   },
   "engines": {
     "node": ">=16.0.0"