@metamask/snaps-controllers 9.5.0 → 9.6.0

package/dist/cronjob/CronjobController.mjs

@@ -1,43 +1,251 @@
-import {
-  CronjobController,
-  DAILY_TIMEOUT
-} from "../chunk-Z4BUMSH3.mjs";
-import "../chunk-IABOI7TW.mjs";
-import "../chunk-V6NFZ47P.mjs";
-import "../chunk-HLQQTAMM.mjs";
-import "../chunk-ESQPQNEF.mjs";
-import "../chunk-WR7CVDEY.mjs";
-import "../chunk-XOSHP4J3.mjs";
-import "../chunk-KCMULJ2M.mjs";
-import "../chunk-LDL6LJ3P.mjs";
-import "../chunk-272IFIK7.mjs";
-import "../chunk-F3ZMDQ52.mjs";
-import "../chunk-BAEXVO3U.mjs";
-import "../chunk-P7Y6MIZW.mjs";
-import "../chunk-QWN3UOMA.mjs";
-import "../chunk-QL3QGUTM.mjs";
-import "../chunk-ZKG6FRKN.mjs";
-import "../chunk-UM4NFNEI.mjs";
-import "../chunk-2SRKMEUV.mjs";
-import "../chunk-BAUQWPSP.mjs";
-import "../chunk-HWJE3SDW.mjs";
-import "../chunk-I5V56NYO.mjs";
-import "../chunk-ZZD3HUNE.mjs";
-import "../chunk-NC5PBDKD.mjs";
-import "../chunk-4M2FX2AT.mjs";
-import "../chunk-U74FML7Z.mjs";
-import "../chunk-Z5QWRDUN.mjs";
-import "../chunk-HULNFJMA.mjs";
-import "../chunk-TSDUJNOP.mjs";
-import "../chunk-3RNW7OKG.mjs";
-import "../chunk-ZVOYOZFT.mjs";
-import "../chunk-6EZSNS4O.mjs";
-import "../chunk-4HVWEABQ.mjs";
-import "../chunk-KRI4OKC3.mjs";
-import "../chunk-XO7KDFBY.mjs";
-import "../chunk-YRZVIDCF.mjs";
-export {
-  CronjobController,
-  DAILY_TIMEOUT
+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;
 };
+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 _CronjobController_messenger, _CronjobController_dailyTimer, _CronjobController_timers, _CronjobController_snapIds;
+import { BaseController } from "@metamask/base-controller";
+import { getCronjobCaveatJobs, SnapEndowments } from "@metamask/snaps-rpc-methods";
+import { HandlerType, parseCronExpression, logError } from "@metamask/snaps-utils";
+import { Duration, inMilliseconds } from "@metamask/utils";
+import { getRunnableSnaps } from "../index.mjs";
+import { Timer } from "../snaps/Timer.mjs";
+export const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);
+const controllerName = 'CronjobController';
+/**
+ * Use this controller to register and schedule periodically executed jobs
+ * using RPC method hooks.
+ */
+export class CronjobController extends BaseController {
+    constructor({ messenger, state }) {
+        super({
+            messenger,
+            metadata: {
+                jobs: { persist: true, anonymous: false },
+            },
+            name: controllerName,
+            state: {
+                jobs: {},
+                ...state,
+            },
+        });
+        _CronjobController_messenger.set(this, void 0);
+        _CronjobController_dailyTimer.set(this, void 0);
+        _CronjobController_timers.set(this, void 0);
+        // Mapping from jobId to snapId
+        _CronjobController_snapIds.set(this, void 0);
+        __classPrivateFieldSet(this, _CronjobController_timers, new Map(), "f");
+        __classPrivateFieldSet(this, _CronjobController_snapIds, new Map(), "f");
+        __classPrivateFieldSet(this, _CronjobController_messenger, messenger, "f");
+        this._handleSnapRegisterEvent = this._handleSnapRegisterEvent.bind(this);
+        this._handleSnapUnregisterEvent =
+            this._handleSnapUnregisterEvent.bind(this);
+        this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);
+        // Subscribe to Snap events
+        /* eslint-disable @typescript-eslint/unbound-method */
+        this.messagingSystem.subscribe('SnapController:snapInstalled', this._handleSnapRegisterEvent);
+        this.messagingSystem.subscribe('SnapController:snapUninstalled', this._handleSnapUnregisterEvent);
+        this.messagingSystem.subscribe('SnapController:snapEnabled', this._handleSnapRegisterEvent);
+        this.messagingSystem.subscribe('SnapController:snapDisabled', this._handleSnapUnregisterEvent);
+        this.messagingSystem.subscribe('SnapController:snapUpdated', this._handleEventSnapUpdated);
+        /* eslint-enable @typescript-eslint/unbound-method */
+        this.dailyCheckIn().catch((error) => {
+            logError(error);
+        });
+    }
+    /**
+     * Retrieve all cronjob specifications for all runnable snaps.
+     *
+     * @returns Array of Cronjob specifications.
+     */
+    getAllJobs() {
+        const snaps = this.messagingSystem.call('SnapController:getAll');
+        const filteredSnaps = getRunnableSnaps(snaps);
+        const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+        return jobs.flat().filter((job) => job !== undefined);
+    }
+    /**
+     * Retrieve all Cronjob specifications for a Snap.
+     *
+     * @param snapId - ID of a Snap.
+     * @returns Array of Cronjob specifications.
+     */
+    getSnapJobs(snapId) {
+        const permissions = __classPrivateFieldGet(this, _CronjobController_messenger, "f").call('PermissionController:getPermissions', snapId);
+        const permission = permissions?.[SnapEndowments.Cronjob];
+        const definitions = getCronjobCaveatJobs(permission);
+        return definitions?.map((definition, idx) => {
+            return { ...definition, id: `${snapId}-${idx}`, snapId };
+        });
+    }
+    /**
+     * Register cron jobs for a given snap by getting specification from a permission caveats.
+     * Once registered, each job will be scheduled.
+     *
+     * @param snapId - ID of a snap.
+     */
+    register(snapId) {
+        const jobs = this.getSnapJobs(snapId);
+        jobs?.forEach((job) => this.schedule(job));
+    }
+    /**
+     * Schedule a new job.
+     * This will interpret the cron expression and tell the timer to execute the job
+     * at the next suitable point in time.
+     * Job last run state will be initialized afterwards.
+     *
+     * Note: Schedule will be skipped if the job's execution time is too far in the future and
+     * will be revisited on a daily check.
+     *
+     * @param job - Cronjob specification.
+     */
+    schedule(job) {
+        if (__classPrivateFieldGet(this, _CronjobController_timers, "f").has(job.id)) {
+            return;
+        }
+        const parsed = parseCronExpression(job.expression);
+        const next = parsed.next();
+        const now = new Date();
+        const ms = next.getTime() - now.getTime();
+        // Don't schedule this job yet as it is too far in the future
+        if (ms > DAILY_TIMEOUT) {
+            return;
+        }
+        const timer = new Timer(ms);
+        timer.start(() => {
+            this.executeCronjob(job).catch((error) => {
+                // TODO: Decide how to handle errors.
+                logError(error);
+            });
+            __classPrivateFieldGet(this, _CronjobController_timers, "f").delete(job.id);
+            this.schedule(job);
+        });
+        if (!this.state.jobs[job.id]?.lastRun) {
+            this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually
+        }
+        __classPrivateFieldGet(this, _CronjobController_timers, "f").set(job.id, timer);
+        __classPrivateFieldGet(this, _CronjobController_snapIds, "f").set(job.id, job.snapId);
+    }
+    /**
+     * Execute job.
+     *
+     * @param job - Cronjob specification.
+     */
+    async executeCronjob(job) {
+        this.updateJobLastRunState(job.id, Date.now());
+        await __classPrivateFieldGet(this, _CronjobController_messenger, "f").call('SnapController:handleRequest', {
+            snapId: job.snapId,
+            origin: '',
+            handler: HandlerType.OnCronjob,
+            request: job.request,
+        });
+    }
+    /**
+     * Unregister all jobs related to the given snapId.
+     *
+     * @param snapId - ID of a snap.
+     */
+    unregister(snapId) {
+        const jobs = [...__classPrivateFieldGet(this, _CronjobController_snapIds, "f").entries()].filter(([_, jobSnapId]) => jobSnapId === snapId);
+        if (jobs.length) {
+            jobs.forEach(([id]) => {
+                const timer = __classPrivateFieldGet(this, _CronjobController_timers, "f").get(id);
+                if (timer) {
+                    timer.cancel();
+                    __classPrivateFieldGet(this, _CronjobController_timers, "f").delete(id);
+                    __classPrivateFieldGet(this, _CronjobController_snapIds, "f").delete(id);
+                }
+            });
+        }
+    }
+    /**
+     * Update time of a last run for the Cronjob specified by ID.
+     *
+     * @param jobId - ID of a cron job.
+     * @param lastRun - Unix timestamp when the job was last ran.
+     */
+    updateJobLastRunState(jobId, lastRun) {
+        this.update((state) => {
+            state.jobs[jobId] = {
+                lastRun,
+            };
+        });
+    }
+    /**
+     * Runs every 24 hours to check if new jobs need to be scheduled.
+     *
+     * This is necessary for longer running jobs that execute with more than 24 hours between them.
+     */
+    async dailyCheckIn() {
+        const jobs = this.getAllJobs();
+        for (const job of jobs) {
+            const parsed = parseCronExpression(job.expression);
+            const lastRun = this.state.jobs[job.id]?.lastRun;
+            // If a job was supposed to run while we were shut down but wasn't we run it now
+            if (lastRun !== undefined &&
+                parsed.hasPrev() &&
+                parsed.prev().getTime() > lastRun) {
+                await this.executeCronjob(job);
+            }
+            // Try scheduling, will fail if an existing scheduled job is found
+            this.schedule(job);
+        }
+        __classPrivateFieldSet(this, _CronjobController_dailyTimer, new Timer(DAILY_TIMEOUT), "f");
+        __classPrivateFieldGet(this, _CronjobController_dailyTimer, "f").start(() => {
+            this.dailyCheckIn().catch((error) => {
+                // TODO: Decide how to handle errors.
+                logError(error);
+            });
+        });
+    }
+    /**
+     * Run controller teardown process and unsubscribe from Snap events.
+     */
+    destroy() {
+        super.destroy();
+        /* eslint-disable @typescript-eslint/unbound-method */
+        this.messagingSystem.unsubscribe('SnapController:snapInstalled', this._handleSnapRegisterEvent);
+        this.messagingSystem.unsubscribe('SnapController:snapUninstalled', this._handleSnapUnregisterEvent);
+        this.messagingSystem.unsubscribe('SnapController:snapEnabled', this._handleSnapRegisterEvent);
+        this.messagingSystem.unsubscribe('SnapController:snapDisabled', this._handleSnapUnregisterEvent);
+        this.messagingSystem.unsubscribe('SnapController:snapUpdated', this._handleEventSnapUpdated);
+        /* eslint-enable @typescript-eslint/unbound-method */
+        __classPrivateFieldGet(this, _CronjobController_snapIds, "f").forEach((snapId) => {
+            this.unregister(snapId);
+        });
+    }
+    /**
+     * Handle events that should cause cronjobs to be registered.
+     *
+     * @param snap - Basic Snap information.
+     */
+    _handleSnapRegisterEvent(snap) {
+        this.register(snap.id);
+    }
+    /**
+     * Handle events that should cause cronjobs to be unregistered.
+     *
+     * @param snap - Basic Snap information.
+     */
+    _handleSnapUnregisterEvent(snap) {
+        this.unregister(snap.id);
+    }
+    /**
+     * Handle cron jobs on 'snapUpdated' event.
+     *
+     * @param snap - Basic Snap information.
+     */
+    _handleEventSnapUpdated(snap) {
+        this.unregister(snap.id);
+        this.register(snap.id);
+    }
+}
+_CronjobController_messenger = new WeakMap(), _CronjobController_dailyTimer = new WeakMap(), _CronjobController_timers = new WeakMap(), _CronjobController_snapIds = new WeakMap();
 //# sourceMappingURL=CronjobController.mjs.map

package/dist/cronjob/CronjobController.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"CronjobController.mjs","sourceRoot":"","sources":["../../src/cronjob/CronjobController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,EACL,oBAAoB,EACpB,cAAc,EACf,oCAAoC;AAMrC,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,QAAQ,EACT,8BAA8B;AAC/B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,wBAAwB;AAW3D,OAAO,EAAE,gBAAgB,EAAE,qBAAW;AACtC,OAAO,EAAE,KAAK,EAAE,2BAAuB;AAgCvC,MAAM,CAAC,MAAM,aAAa,GAAG,cAAc,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;AAwB/D,MAAM,cAAc,GAAG,mBAAmB,CAAC;AAE3C;;;GAGG;AACH,MAAM,OAAO,iBAAkB,SAAQ,cAItC;IAUC,YAAY,EAAE,SAAS,EAAE,KAAK,EAAyB;QACrD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE;gBACR,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;aAC1C;YACD,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,IAAI,EAAE,EAAE;gBACR,GAAG,KAAK;aACT;SACF,CAAC,CAAC;QApBL,+CAAuC;QAEvC,gDAAoB;QAEpB,4CAA4B;QAE5B,+BAA+B;QAC/B,6CAA8B;QAc5B,uBAAA,IAAI,6BAAW,IAAI,GAAG,EAAE,MAAA,CAAC;QACzB,uBAAA,IAAI,8BAAY,IAAI,GAAG,EAAE,MAAA,CAAC;QAC1B,uBAAA,IAAI,gCAAc,SAAS,MAAA,CAAC;QAE5B,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzE,IAAI,CAAC,0BAA0B;YAC7B,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEvE,2BAA2B;QAC3B,sDAAsD;QACtD,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,8BAA8B,EAC9B,IAAI,CAAC,wBAAwB,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,gCAAgC,EAChC,IAAI,CAAC,0BAA0B,CAChC,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,4BAA4B,EAC5B,IAAI,CAAC,wBAAwB,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,6BAA6B,EAC7B,IAAI,CAAC,0BAA0B,CAChC,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QACF,qDAAqD;QAErD,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAClC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,UAAU;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACjE,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE9C,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACpE,4EAA4E;QAC5E,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,CAAc,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,MAAc;QAChC,MAAM,WAAW,GAAG,uBAAA,IAAI,oCAAW,CAAC,IAAI,CACtC,qCAAqC,EACrC,MAAM,CACP,CAAC;QAEF,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAErD,OAAO,WAAW,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YAC1C,OAAO,EAAE,GAAG,UAAU,EAAE,EAAE,EAAE,GAAG,MAAM,IAAI,GAAG,EAAE,EAAE,MAAM,EAAE,CAAC;QAC3D,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,MAAc;QACrB,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;OAUG;IACK,QAAQ,CAAC,GAAY;QAC3B,IAAI,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;QAE1C,6DAA6D;QAC7D,IAAI,EAAE,GAAG,aAAa,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5B,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE;YACf,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACvC,qCAAqC;gBACrC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;YAEH,uBAAA,IAAI,iCAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC5B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;YACtC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,iCAAiC;QAC1E,CAAC;QAED,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAChC,uBAAA,IAAI,kCAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,cAAc,CAAC,GAAY;QACvC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,MAAM,uBAAA,IAAI,oCAAW,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACzD,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,WAAW,CAAC,SAAS;YAC9B,OAAO,EAAE,GAAG,CAAC,OAAO;SACrB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,MAAc;QACvB,MAAM,IAAI,GAAG,CAAC,GAAG,uBAAA,IAAI,kCAAS,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAC9C,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,KAAK,MAAM,CACzC,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACpB,MAAM,KAAK,GAAG,uBAAA,IAAI,iCAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACnC,IAAI,KAAK,EAAE,CAAC;oBACV,KAAK,CAAC,MAAM,EAAE,CAAC;oBACf,uBAAA,IAAI,iCAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACxB,uBAAA,IAAI,kCAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,qBAAqB,CAAC,KAAa,EAAE,OAAe;QAC1D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;gBAClB,OAAO;aACR,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAE/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC;YACjD,gFAAgF;YAChF,IACE,OAAO,KAAK,SAAS;gBACrB,MAAM,CAAC,OAAO,EAAE;gBAChB,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,OAAO,EACjC,CAAC;gBACD,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;YAED,kEAAkE;YAClE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QAED,uBAAA,IAAI,iCAAe,IAAI,KAAK,CAAC,aAAa,CAAC,MAAA,CAAC;QAC5C,uBAAA,IAAI,qCAAY,CAAC,KAAK,CAAC,GAAG,EAAE;YAC1B,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAClC,qCAAqC;gBACrC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO;QACL,KAAK,CAAC,OAAO,EAAE,CAAC;QAEhB,sDAAsD;QACtD,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,8BAA8B,EAC9B,IAAI,CAAC,wBAAwB,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,gCAAgC,EAChC,IAAI,CAAC,0BAA0B,CAChC,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,4BAA4B,EAC5B,IAAI,CAAC,wBAAwB,CAC9B,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,6BAA6B,EAC7B,IAAI,CAAC,0BAA0B,CAChC,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,4BAA4B,EAC5B,IAAI,CAAC,uBAAuB,CAC7B,CAAC;QACF,qDAAqD;QAErD,uBAAA,IAAI,kCAAS,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC/B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACK,wBAAwB,CAAC,IAAmB;QAClD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACK,0BAA0B,CAAC,IAAmB;QACpD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACK,uBAAuB,CAAC,IAAmB;QACjD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;CACF","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { GetPermissions } from '@metamask/permission-controller';\nimport {\n  getCronjobCaveatJobs,\n  SnapEndowments,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type {\n  TruncatedSnap,\n  CronjobSpecification,\n} from '@metamask/snaps-utils';\nimport {\n  HandlerType,\n  parseCronExpression,\n  logError,\n} from '@metamask/snaps-utils';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n  GetAllSnaps,\n  HandleSnapRequest,\n  SnapDisabled,\n  SnapEnabled,\n  SnapInstalled,\n  SnapUninstalled,\n  SnapUpdated,\n} from '..';\nimport { getRunnableSnaps } from '..';\nimport { Timer } from '../snaps/Timer';\n\nexport type CronjobControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  CronjobControllerState\n>;\nexport type CronjobControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  CronjobControllerState\n>;\nexport type CronjobControllerActions =\n  | GetAllSnaps\n  | HandleSnapRequest\n  | GetPermissions\n  | CronjobControllerGetStateAction;\n\nexport type CronjobControllerEvents =\n  | SnapInstalled\n  | SnapUninstalled\n  | SnapUpdated\n  | SnapEnabled\n  | SnapDisabled\n  | CronjobControllerStateChangeEvent;\n\nexport type CronjobControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  CronjobControllerActions,\n  CronjobControllerEvents,\n  CronjobControllerActions['type'],\n  CronjobControllerEvents['type']\n>;\n\nexport const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);\n\nexport type CronjobControllerArgs = {\n  messenger: CronjobControllerMessenger;\n  /**\n   * Persisted state that will be used for rehydration.\n   */\n  state?: CronjobControllerState;\n};\n\nexport type Cronjob = {\n  timer?: Timer;\n  id: string;\n  snapId: SnapId;\n} & CronjobSpecification;\n\nexport type StoredJobInformation = {\n  lastRun: number;\n};\n\nexport type CronjobControllerState = {\n  jobs: Record<string, StoredJobInformation>;\n};\n\nconst controllerName = 'CronjobController';\n\n/**\n * Use this controller to register and schedule periodically executed jobs\n * using RPC method hooks.\n */\nexport class CronjobController extends BaseController<\n  typeof controllerName,\n  CronjobControllerState,\n  CronjobControllerMessenger\n> {\n  #messenger: CronjobControllerMessenger;\n\n  #dailyTimer!: Timer;\n\n  #timers: Map<string, Timer>;\n\n  // Mapping from jobId to snapId\n  #snapIds: Map<string, string>;\n\n  constructor({ messenger, state }: CronjobControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        jobs: { persist: true, anonymous: false },\n      },\n      name: controllerName,\n      state: {\n        jobs: {},\n        ...state,\n      },\n    });\n    this.#timers = new Map();\n    this.#snapIds = new Map();\n    this.#messenger = messenger;\n\n    this._handleSnapRegisterEvent = this._handleSnapRegisterEvent.bind(this);\n    this._handleSnapUnregisterEvent =\n      this._handleSnapUnregisterEvent.bind(this);\n    this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);\n\n    // Subscribe to Snap events\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.subscribe(\n      'SnapController:snapInstalled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapUninstalled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapEnabled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapDisabled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.subscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.dailyCheckIn().catch((error) => {\n      logError(error);\n    });\n  }\n\n  /**\n   * Retrieve all cronjob specifications for all runnable snaps.\n   *\n   * @returns Array of Cronjob specifications.\n   */\n  private getAllJobs(): Cronjob[] {\n    const snaps = this.messagingSystem.call('SnapController:getAll');\n    const filteredSnaps = getRunnableSnaps(snaps);\n\n    const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));\n    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n    return jobs.flat().filter((job) => job !== undefined) as Cronjob[];\n  }\n\n  /**\n   * Retrieve all Cronjob specifications for a Snap.\n   *\n   * @param snapId - ID of a Snap.\n   * @returns Array of Cronjob specifications.\n   */\n  private getSnapJobs(snapId: SnapId): Cronjob[] | undefined {\n    const permissions = this.#messenger.call(\n      'PermissionController:getPermissions',\n      snapId,\n    );\n\n    const permission = permissions?.[SnapEndowments.Cronjob];\n    const definitions = getCronjobCaveatJobs(permission);\n\n    return definitions?.map((definition, idx) => {\n      return { ...definition, id: `${snapId}-${idx}`, snapId };\n    });\n  }\n\n  /**\n   * Register cron jobs for a given snap by getting specification from a permission caveats.\n   * Once registered, each job will be scheduled.\n   *\n   * @param snapId - ID of a snap.\n   */\n  register(snapId: SnapId) {\n    const jobs = this.getSnapJobs(snapId);\n    jobs?.forEach((job) => this.schedule(job));\n  }\n\n  /**\n   * Schedule a new job.\n   * This will interpret the cron expression and tell the timer to execute the job\n   * at the next suitable point in time.\n   * Job last run state will be initialized afterwards.\n   *\n   * Note: Schedule will be skipped if the job's execution time is too far in the future and\n   * will be revisited on a daily check.\n   *\n   * @param job - Cronjob specification.\n   */\n  private schedule(job: Cronjob) {\n    if (this.#timers.has(job.id)) {\n      return;\n    }\n\n    const parsed = parseCronExpression(job.expression);\n    const next = parsed.next();\n    const now = new Date();\n    const ms = next.getTime() - now.getTime();\n\n    // Don't schedule this job yet as it is too far in the future\n    if (ms > DAILY_TIMEOUT) {\n      return;\n    }\n\n    const timer = new Timer(ms);\n    timer.start(() => {\n      this.executeCronjob(job).catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n\n      this.#timers.delete(job.id);\n      this.schedule(job);\n    });\n\n    if (!this.state.jobs[job.id]?.lastRun) {\n      this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually\n    }\n\n    this.#timers.set(job.id, timer);\n    this.#snapIds.set(job.id, job.snapId);\n  }\n\n  /**\n   * Execute job.\n   *\n   * @param job - Cronjob specification.\n   */\n  private async executeCronjob(job: Cronjob) {\n    this.updateJobLastRunState(job.id, Date.now());\n    await this.#messenger.call('SnapController:handleRequest', {\n      snapId: job.snapId,\n      origin: '',\n      handler: HandlerType.OnCronjob,\n      request: job.request,\n    });\n  }\n\n  /**\n   * Unregister all jobs related to the given snapId.\n   *\n   * @param snapId - ID of a snap.\n   */\n  unregister(snapId: string) {\n    const jobs = [...this.#snapIds.entries()].filter(\n      ([_, jobSnapId]) => jobSnapId === snapId,\n    );\n\n    if (jobs.length) {\n      jobs.forEach(([id]) => {\n        const timer = this.#timers.get(id);\n        if (timer) {\n          timer.cancel();\n          this.#timers.delete(id);\n          this.#snapIds.delete(id);\n        }\n      });\n    }\n  }\n\n  /**\n   * Update time of a last run for the Cronjob specified by ID.\n   *\n   * @param jobId - ID of a cron job.\n   * @param lastRun - Unix timestamp when the job was last ran.\n   */\n  private updateJobLastRunState(jobId: string, lastRun: number) {\n    this.update((state) => {\n      state.jobs[jobId] = {\n        lastRun,\n      };\n    });\n  }\n\n  /**\n   * Runs every 24 hours to check if new jobs need to be scheduled.\n   *\n   * This is necessary for longer running jobs that execute with more than 24 hours between them.\n   */\n  async dailyCheckIn() {\n    const jobs = this.getAllJobs();\n\n    for (const job of jobs) {\n      const parsed = parseCronExpression(job.expression);\n      const lastRun = this.state.jobs[job.id]?.lastRun;\n      // If a job was supposed to run while we were shut down but wasn't we run it now\n      if (\n        lastRun !== undefined &&\n        parsed.hasPrev() &&\n        parsed.prev().getTime() > lastRun\n      ) {\n        await this.executeCronjob(job);\n      }\n\n      // Try scheduling, will fail if an existing scheduled job is found\n      this.schedule(job);\n    }\n\n    this.#dailyTimer = new Timer(DAILY_TIMEOUT);\n    this.#dailyTimer.start(() => {\n      this.dailyCheckIn().catch((error) => {\n        // TODO: Decide how to handle errors.\n        logError(error);\n      });\n    });\n  }\n\n  /**\n   * Run controller teardown process and unsubscribe from Snap events.\n   */\n  destroy() {\n    super.destroy();\n\n    /* eslint-disable @typescript-eslint/unbound-method */\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapInstalled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapUninstalled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapEnabled',\n      this._handleSnapRegisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapDisabled',\n      this._handleSnapUnregisterEvent,\n    );\n\n    this.messagingSystem.unsubscribe(\n      'SnapController:snapUpdated',\n      this._handleEventSnapUpdated,\n    );\n    /* eslint-enable @typescript-eslint/unbound-method */\n\n    this.#snapIds.forEach((snapId) => {\n      this.unregister(snapId);\n    });\n  }\n\n  /**\n   * Handle events that should cause cronjobs to be registered.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleSnapRegisterEvent(snap: TruncatedSnap) {\n    this.register(snap.id);\n  }\n\n  /**\n   * Handle events that should cause cronjobs to be unregistered.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleSnapUnregisterEvent(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n  }\n\n  /**\n   * Handle cron jobs on 'snapUpdated' event.\n   *\n   * @param snap - Basic Snap information.\n   */\n  private _handleEventSnapUpdated(snap: TruncatedSnap) {\n    this.unregister(snap.id);\n    this.register(snap.id);\n  }\n}\n"]}

package/dist/cronjob/index.cjs

@@ -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("./CronjobController.cjs"), exports);
+//# sourceMappingURL=index.cjs.map

package/dist/cronjob/index.cjs.map

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

package/dist/cronjob/index.d.cts

@@ -0,0 +1,2 @@
+export * from "./CronjobController.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/cronjob/index.d.cts.map

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

package/dist/cronjob/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./CronjobController.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/cronjob/index.d.mts.map

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

package/dist/cronjob/index.mjs

@@ -1,43 +1,2 @@
-import {
-  CronjobController,
-  DAILY_TIMEOUT
-} from "../chunk-Z4BUMSH3.mjs";
-import "../chunk-IABOI7TW.mjs";
-import "../chunk-V6NFZ47P.mjs";
-import "../chunk-HLQQTAMM.mjs";
-import "../chunk-ESQPQNEF.mjs";
-import "../chunk-WR7CVDEY.mjs";
-import "../chunk-XOSHP4J3.mjs";
-import "../chunk-KCMULJ2M.mjs";
-import "../chunk-LDL6LJ3P.mjs";
-import "../chunk-272IFIK7.mjs";
-import "../chunk-F3ZMDQ52.mjs";
-import "../chunk-BAEXVO3U.mjs";
-import "../chunk-P7Y6MIZW.mjs";
-import "../chunk-QWN3UOMA.mjs";
-import "../chunk-QL3QGUTM.mjs";
-import "../chunk-ZKG6FRKN.mjs";
-import "../chunk-UM4NFNEI.mjs";
-import "../chunk-2SRKMEUV.mjs";
-import "../chunk-BAUQWPSP.mjs";
-import "../chunk-HWJE3SDW.mjs";
-import "../chunk-I5V56NYO.mjs";
-import "../chunk-ZZD3HUNE.mjs";
-import "../chunk-NC5PBDKD.mjs";
-import "../chunk-4M2FX2AT.mjs";
-import "../chunk-U74FML7Z.mjs";
-import "../chunk-Z5QWRDUN.mjs";
-import "../chunk-HULNFJMA.mjs";
-import "../chunk-TSDUJNOP.mjs";
-import "../chunk-3RNW7OKG.mjs";
-import "../chunk-ZVOYOZFT.mjs";
-import "../chunk-6EZSNS4O.mjs";
-import "../chunk-4HVWEABQ.mjs";
-import "../chunk-KRI4OKC3.mjs";
-import "../chunk-XO7KDFBY.mjs";
-import "../chunk-YRZVIDCF.mjs";
-export {
-  CronjobController,
-  DAILY_TIMEOUT
-};
+export * from "./CronjobController.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/cronjob/index.mjs.map

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

package/dist/fsm.cjs

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.forceStrict = exports.validateMachine = void 0;
+const utils_1 = require("@metamask/utils");
+const fsm_1 = require("@xstate/fsm");
+/**
+ * Validates the set-up of a @xstate/fsm machine.
+ *
+ * 1. Ensures that all named actions in the config have a provided implementation.
+ *
+ * @param machine - The machine to validate.
+ * @throws {@link AssertionError}. If the validation fails.
+ */
+function validateMachine(machine) {
+    (0, utils_1.assert)('_options' in machine, 'The machine is not an @xstate/fsm machine');
+    const typed = machine;
+    // 1.
+    const toArray = (obj) => {
+        if (Array.isArray(obj)) {
+            return obj;
+        }
+        else if (obj === undefined || obj === null) {
+            return [];
+        }
+        return [obj];
+    };
+    const allActions = new Set();
+    const addActions = (actions) => toArray(actions)
+        .flatMap((action) => {
+        if (typeof action === 'string') {
+            return [action];
+        }
+        (0, utils_1.assert)(typeof action === 'function');
+        return [];
+    })
+        .forEach(allActions.add.bind(allActions));
+    for (const state of Object.values(typed.config.states)) {
+        addActions(state.entry);
+        addActions(state.exit);
+        for (const transition of Object.values(state.on ?? {})) {
+            addActions(transition.actions);
+        }
+    }
+    allActions.forEach((action) => (0, utils_1.assert)(typed._options.actions !== undefined && action in typed._options.actions, `Action "${action}" doesn't have an implementation`));
+}
+exports.validateMachine = validateMachine;
+/**
+ * Ensure that the interpreter is strict.
+ * Strict means that the transition must occur.
+ * The event must exist in .on {} state config and it's guard must succeed.
+ *
+ * The error will be thrown when an invalid `interpreter.send()` is called
+ * and will be bubbled there.
+ *
+ * TODO(ritave): Doesn't support self transitions.
+ *
+ * @param interpreter - The interpreter that will be force into strict mode.
+ * @throws {@link Error} Thrown when the transition is invalid.
+ */
+function forceStrict(interpreter) {
+    // As soon as a listener subscribes, it is called. It might be called in
+    // an initial state which doesn't have the .changed property
+    let onInitialCalled = false;
+    interpreter.subscribe((state) => {
+        (0, utils_1.assert)(!onInitialCalled || state.changed, 'Invalid state transition');
+        onInitialCalled = true;
+    });
+    const ogSend = interpreter.send.bind(interpreter);
+    interpreter.send = (...args) => {
+        (0, utils_1.assert)(interpreter.status === fsm_1.InterpreterStatus.Running, 'Interpreter is stopped');
+        return ogSend(...args);
+    };
+}
+exports.forceStrict = forceStrict;
+//# sourceMappingURL=fsm.cjs.map

package/dist/fsm.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"fsm.cjs","sourceRoot":"","sources":["../src/fsm.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAEzC,qCAAgD;AAEhD;;;;;;;GAOG;AACH,SAAgB,eAAe,CAI7B,OAAuD;IACvD,IAAA,cAAM,EAAC,UAAU,IAAI,OAAO,EAAE,2CAA2C,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,OAEb,CAAC;IAEF,KAAK;IACL,MAAM,OAAO,GAAG,CAAO,GAAkB,EAAU,EAAE;QACnD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,GAAG,CAAC;QACb,CAAC;aAAM,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC7C,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IACrC,MAAM,UAAU,GAAG,CAAC,OAAY,EAAE,EAAE,CAClC,OAAO,CAAC,OAAO,CAAC;SACb,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAClB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC;QACD,IAAA,cAAM,EAAC,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC;QACrC,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;SACD,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAE9C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAC/B,KAAK,CAAC,MAAM,CAAC,MAAM,CACpB,EAAE,CAAC;QACF,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxB,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvB,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAM,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5D,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAC5B,IAAA,cAAM,EACJ,KAAK,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,EACxE,WAAW,MAAM,kCAAkC,CACpD,CACF,CAAC;AACJ,CAAC;AAhDD,0CAgDC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,WAAW,CAAC,WAAgD;IAC1E,wEAAwE;IACxE,4DAA4D;IAC5D,IAAI,eAAe,GAAG,KAAK,CAAC;IAC5B,WAAW,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9B,IAAA,cAAM,EAAC,CAAC,eAAe,IAAI,KAAK,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;QACtE,eAAe,GAAG,IAAI,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,WAAW,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE;QAC7B,IAAA,cAAM,EACJ,WAAW,CAAC,MAAM,KAAK,uBAAiB,CAAC,OAAO,EAChD,wBAAwB,CACzB,CAAC;QACF,OAAO,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC;AACJ,CAAC;AAjBD,kCAiBC","sourcesContent":["import { assert } from '@metamask/utils';\nimport type { EventObject, StateMachine, Typestate } from '@xstate/fsm';\nimport { InterpreterStatus } from '@xstate/fsm';\n\n/**\n * Validates the set-up of a @xstate/fsm machine.\n *\n * 1. Ensures that all named actions in the config have a provided implementation.\n *\n * @param machine - The machine to validate.\n * @throws {@link AssertionError}. If the validation fails.\n */\nexport function validateMachine<\n  TContext extends object,\n  TEvent extends EventObject,\n  TState extends Typestate<TContext>,\n>(machine: StateMachine.Machine<TContext, TEvent, TState>) {\n  assert('_options' in machine, 'The machine is not an @xstate/fsm machine');\n  const typed = machine as StateMachine.Machine<TContext, TEvent, TState> & {\n    _options: { actions?: StateMachine.ActionMap<TContext, TEvent> };\n  };\n\n  // 1.\n  const toArray = <Type>(obj: Type | Type[]): Type[] => {\n    if (Array.isArray(obj)) {\n      return obj;\n    } else if (obj === undefined || obj === null) {\n      return [];\n    }\n    return [obj];\n  };\n\n  const allActions = new Set<string>();\n  const addActions = (actions: any) =>\n    toArray(actions)\n      .flatMap((action) => {\n        if (typeof action === 'string') {\n          return [action];\n        }\n        assert(typeof action === 'function');\n        return [];\n      })\n      .forEach(allActions.add.bind(allActions));\n\n  for (const state of Object.values<(typeof typed.config.states)[string]>(\n    typed.config.states,\n  )) {\n    addActions(state.entry);\n    addActions(state.exit);\n    for (const transition of Object.values<any>(state.on ?? {})) {\n      addActions(transition.actions);\n    }\n  }\n\n  allActions.forEach((action) =>\n    assert(\n      typed._options.actions !== undefined && action in typed._options.actions,\n      `Action \"${action}\" doesn't have an implementation`,\n    ),\n  );\n}\n\n/**\n * Ensure that the interpreter is strict.\n * Strict means that the transition must occur.\n * The event must exist in .on {} state config and it's guard must succeed.\n *\n * The error will be thrown when an invalid `interpreter.send()` is called\n * and will be bubbled there.\n *\n * TODO(ritave): Doesn't support self transitions.\n *\n * @param interpreter - The interpreter that will be force into strict mode.\n * @throws {@link Error} Thrown when the transition is invalid.\n */\nexport function forceStrict(interpreter: StateMachine.Service<any, any, any>) {\n  // As soon as a listener subscribes, it is called. It might be called in\n  // an initial state which doesn't have the .changed property\n  let onInitialCalled = false;\n  interpreter.subscribe((state) => {\n    assert(!onInitialCalled || state.changed, 'Invalid state transition');\n    onInitialCalled = true;\n  });\n\n  const ogSend = interpreter.send.bind(interpreter);\n  interpreter.send = (...args) => {\n    assert(\n      interpreter.status === InterpreterStatus.Running,\n      'Interpreter is stopped',\n    );\n    return ogSend(...args);\n  };\n}\n"]}

package/dist/{types/fsm.d.ts → fsm.d.cts}

@@ -1,4 +1,4 @@
-import type { EventObject, StateMachine, Typestate } from '@xstate/fsm';
+import type { EventObject, StateMachine, Typestate } from "@xstate/fsm";
 /**
  * Validates the set-up of a @xstate/fsm machine.
  *
@@ -22,3 +22,4 @@ export declare function validateMachine<TContext extends object, TEvent extends
  * @throws {@link Error} Thrown when the transition is invalid.
  */
 export declare function forceStrict(interpreter: StateMachine.Service<any, any, any>): void;
+//# sourceMappingURL=fsm.d.cts.map

package/dist/fsm.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fsm.d.cts","sourceRoot":"","sources":["../src/fsm.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,SAAS,EAAE,oBAAoB;AAGxE;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,SAAS,MAAM,EACvB,MAAM,SAAS,WAAW,EAC1B,MAAM,SAAS,SAAS,CAAC,QAAQ,CAAC,EAClC,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,QA4CxD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,QAiB3E"}

package/dist/fsm.d.mts

@@ -0,0 +1,25 @@
+import type { EventObject, StateMachine, Typestate } from "@xstate/fsm";
+/**
+ * Validates the set-up of a @xstate/fsm machine.
+ *
+ * 1. Ensures that all named actions in the config have a provided implementation.
+ *
+ * @param machine - The machine to validate.
+ * @throws {@link AssertionError}. If the validation fails.
+ */
+export declare function validateMachine<TContext extends object, TEvent extends EventObject, TState extends Typestate<TContext>>(machine: StateMachine.Machine<TContext, TEvent, TState>): void;
+/**
+ * Ensure that the interpreter is strict.
+ * Strict means that the transition must occur.
+ * The event must exist in .on {} state config and it's guard must succeed.
+ *
+ * The error will be thrown when an invalid `interpreter.send()` is called
+ * and will be bubbled there.
+ *
+ * TODO(ritave): Doesn't support self transitions.
+ *
+ * @param interpreter - The interpreter that will be force into strict mode.
+ * @throws {@link Error} Thrown when the transition is invalid.
+ */
+export declare function forceStrict(interpreter: StateMachine.Service<any, any, any>): void;
+//# sourceMappingURL=fsm.d.mts.map

package/dist/fsm.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fsm.d.mts","sourceRoot":"","sources":["../src/fsm.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,SAAS,EAAE,oBAAoB;AAGxE;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,SAAS,MAAM,EACvB,MAAM,SAAS,WAAW,EAC1B,MAAM,SAAS,SAAS,CAAC,QAAQ,CAAC,EAClC,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,QA4CxD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,QAiB3E"}

package/dist/fsm.mjs

@@ -1,10 +1,70 @@
-import {
-  forceStrict,
-  validateMachine
-} from "./chunk-6EZSNS4O.mjs";
-import "./chunk-YRZVIDCF.mjs";
-export {
-  forceStrict,
-  validateMachine
-};
+import { assert } from "@metamask/utils";
+import { InterpreterStatus } from "@xstate/fsm";
+/**
+ * Validates the set-up of a @xstate/fsm machine.
+ *
+ * 1. Ensures that all named actions in the config have a provided implementation.
+ *
+ * @param machine - The machine to validate.
+ * @throws {@link AssertionError}. If the validation fails.
+ */
+export function validateMachine(machine) {
+    assert('_options' in machine, 'The machine is not an @xstate/fsm machine');
+    const typed = machine;
+    // 1.
+    const toArray = (obj) => {
+        if (Array.isArray(obj)) {
+            return obj;
+        }
+        else if (obj === undefined || obj === null) {
+            return [];
+        }
+        return [obj];
+    };
+    const allActions = new Set();
+    const addActions = (actions) => toArray(actions)
+        .flatMap((action) => {
+        if (typeof action === 'string') {
+            return [action];
+        }
+        assert(typeof action === 'function');
+        return [];
+    })
+        .forEach(allActions.add.bind(allActions));
+    for (const state of Object.values(typed.config.states)) {
+        addActions(state.entry);
+        addActions(state.exit);
+        for (const transition of Object.values(state.on ?? {})) {
+            addActions(transition.actions);
+        }
+    }
+    allActions.forEach((action) => assert(typed._options.actions !== undefined && action in typed._options.actions, `Action "${action}" doesn't have an implementation`));
+}
+/**
+ * Ensure that the interpreter is strict.
+ * Strict means that the transition must occur.
+ * The event must exist in .on {} state config and it's guard must succeed.
+ *
+ * The error will be thrown when an invalid `interpreter.send()` is called
+ * and will be bubbled there.
+ *
+ * TODO(ritave): Doesn't support self transitions.
+ *
+ * @param interpreter - The interpreter that will be force into strict mode.
+ * @throws {@link Error} Thrown when the transition is invalid.
+ */
+export function forceStrict(interpreter) {
+    // As soon as a listener subscribes, it is called. It might be called in
+    // an initial state which doesn't have the .changed property
+    let onInitialCalled = false;
+    interpreter.subscribe((state) => {
+        assert(!onInitialCalled || state.changed, 'Invalid state transition');
+        onInitialCalled = true;
+    });
+    const ogSend = interpreter.send.bind(interpreter);
+    interpreter.send = (...args) => {
+        assert(interpreter.status === InterpreterStatus.Running, 'Interpreter is stopped');
+        return ogSend(...args);
+    };
+}
 //# sourceMappingURL=fsm.mjs.map

package/dist/fsm.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"file":"fsm.mjs","sourceRoot":"","sources":["../src/fsm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,OAAO,EAAE,iBAAiB,EAAE,oBAAoB;AAEhD;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAI7B,OAAuD;IACvD,MAAM,CAAC,UAAU,IAAI,OAAO,EAAE,2CAA2C,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,OAEb,CAAC;IAEF,KAAK;IACL,MAAM,OAAO,GAAG,CAAO,GAAkB,EAAU,EAAE;QACnD,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,OAAO,GAAG,CAAC;QACb,CAAC;aAAM,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC7C,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;IACrC,MAAM,UAAU,GAAG,CAAC,OAAY,EAAE,EAAE,CAClC,OAAO,CAAC,OAAO,CAAC;SACb,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAClB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC;QACD,MAAM,CAAC,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC;QACrC,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;SACD,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAE9C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAC/B,KAAK,CAAC,MAAM,CAAC,MAAM,CACpB,EAAE,CAAC;QACF,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxB,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvB,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAM,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5D,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAC5B,MAAM,CACJ,KAAK,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,EACxE,WAAW,MAAM,kCAAkC,CACpD,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CAAC,WAAgD;IAC1E,wEAAwE;IACxE,4DAA4D;IAC5D,IAAI,eAAe,GAAG,KAAK,CAAC;IAC5B,WAAW,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9B,MAAM,CAAC,CAAC,eAAe,IAAI,KAAK,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC;QACtE,eAAe,GAAG,IAAI,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,WAAW,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE;QAC7B,MAAM,CACJ,WAAW,CAAC,MAAM,KAAK,iBAAiB,CAAC,OAAO,EAChD,wBAAwB,CACzB,CAAC;QACF,OAAO,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import { assert } from '@metamask/utils';\nimport type { EventObject, StateMachine, Typestate } from '@xstate/fsm';\nimport { InterpreterStatus } from '@xstate/fsm';\n\n/**\n * Validates the set-up of a @xstate/fsm machine.\n *\n * 1. Ensures that all named actions in the config have a provided implementation.\n *\n * @param machine - The machine to validate.\n * @throws {@link AssertionError}. If the validation fails.\n */\nexport function validateMachine<\n  TContext extends object,\n  TEvent extends EventObject,\n  TState extends Typestate<TContext>,\n>(machine: StateMachine.Machine<TContext, TEvent, TState>) {\n  assert('_options' in machine, 'The machine is not an @xstate/fsm machine');\n  const typed = machine as StateMachine.Machine<TContext, TEvent, TState> & {\n    _options: { actions?: StateMachine.ActionMap<TContext, TEvent> };\n  };\n\n  // 1.\n  const toArray = <Type>(obj: Type | Type[]): Type[] => {\n    if (Array.isArray(obj)) {\n      return obj;\n    } else if (obj === undefined || obj === null) {\n      return [];\n    }\n    return [obj];\n  };\n\n  const allActions = new Set<string>();\n  const addActions = (actions: any) =>\n    toArray(actions)\n      .flatMap((action) => {\n        if (typeof action === 'string') {\n          return [action];\n        }\n        assert(typeof action === 'function');\n        return [];\n      })\n      .forEach(allActions.add.bind(allActions));\n\n  for (const state of Object.values<(typeof typed.config.states)[string]>(\n    typed.config.states,\n  )) {\n    addActions(state.entry);\n    addActions(state.exit);\n    for (const transition of Object.values<any>(state.on ?? {})) {\n      addActions(transition.actions);\n    }\n  }\n\n  allActions.forEach((action) =>\n    assert(\n      typed._options.actions !== undefined && action in typed._options.actions,\n      `Action \"${action}\" doesn't have an implementation`,\n    ),\n  );\n}\n\n/**\n * Ensure that the interpreter is strict.\n * Strict means that the transition must occur.\n * The event must exist in .on {} state config and it's guard must succeed.\n *\n * The error will be thrown when an invalid `interpreter.send()` is called\n * and will be bubbled there.\n *\n * TODO(ritave): Doesn't support self transitions.\n *\n * @param interpreter - The interpreter that will be force into strict mode.\n * @throws {@link Error} Thrown when the transition is invalid.\n */\nexport function forceStrict(interpreter: StateMachine.Service<any, any, any>) {\n  // As soon as a listener subscribes, it is called. It might be called in\n  // an initial state which doesn't have the .changed property\n  let onInitialCalled = false;\n  interpreter.subscribe((state) => {\n    assert(!onInitialCalled || state.changed, 'Invalid state transition');\n    onInitialCalled = true;\n  });\n\n  const ogSend = interpreter.send.bind(interpreter);\n  interpreter.send = (...args) => {\n    assert(\n      interpreter.status === InterpreterStatus.Running,\n      'Interpreter is stopped',\n    );\n    return ogSend(...args);\n  };\n}\n"]}