@metamask/snaps-controllers 1.0.2 → 2.0.0

package/dist/esm/cronjob/CronjobController.js

@@ -0,0 +1,279 @@
+function _check_private_redeclaration(obj, privateCollection) {
+    if (privateCollection.has(obj)) {
+        throw new TypeError("Cannot initialize the same private elements twice on an object");
+    }
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+    if (descriptor.get) {
+        return descriptor.get.call(receiver);
+    }
+    return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+    if (descriptor.set) {
+        descriptor.set.call(receiver, value);
+    } else {
+        if (!descriptor.writable) {
+            throw new TypeError("attempted to set read only private field");
+        }
+        descriptor.value = value;
+    }
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to " + action + " private field on non-instance");
+    }
+    return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+    return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+    _check_private_redeclaration(obj, privateMap);
+    privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+    var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+    _class_apply_descriptor_set(receiver, descriptor, value);
+    return value;
+}
+import { BaseControllerV2 as BaseController } from '@metamask/base-controller';
+import { HandlerType, parseCronExpression, logError } from '@metamask/snaps-utils';
+import { Duration, inMilliseconds } from '@metamask/utils';
+import { getRunnableSnaps, SnapEndowments } from '..';
+import { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';
+import { Timer } from '../snaps/Timer';
+export const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);
+const controllerName = 'CronjobController';
+var _messenger = /*#__PURE__*/ new WeakMap(), _dailyTimer = /*#__PURE__*/ new WeakMap(), _timers = /*#__PURE__*/ new WeakMap(), // Mapping from jobId to snapId
+_snapIds = /*#__PURE__*/ new WeakMap();
+/**
+ * Use this controller to register and schedule periodically executed jobs
+ * using RPC method hooks.
+ */ export class CronjobController extends BaseController {
+    /**
+   * 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 = _class_private_field_get(this, _messenger).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 (_class_private_field_get(this, _timers).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);
+            });
+            _class_private_field_get(this, _timers).delete(job.id);
+            this.schedule(job);
+        });
+        this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually
+        _class_private_field_get(this, _timers).set(job.id, timer);
+        _class_private_field_get(this, _snapIds).set(job.id, job.snapId);
+    }
+    /**
+   * Execute job.
+   *
+   * @param job - Cronjob specification.
+   */ async executeCronjob(job) {
+        this.updateJobLastRunState(job.id, Date.now());
+        await _class_private_field_get(this, _messenger).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 = [
+            ..._class_private_field_get(this, _snapIds).entries()
+        ].filter(([_, jobSnapId])=>jobSnapId === snapId);
+        if (jobs.length) {
+            jobs.forEach(([id])=>{
+                const timer = _class_private_field_get(this, _timers).get(id);
+                if (timer) {
+                    timer.cancel();
+                    _class_private_field_get(this, _timers).delete(id);
+                    _class_private_field_get(this, _snapIds).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 necesary 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);
+        }
+        _class_private_field_set(this, _dailyTimer, new Timer(DAILY_TIMEOUT));
+        _class_private_field_get(this, _dailyTimer).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:snapRemoved', 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 */ _class_private_field_get(this, _snapIds).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);
+    }
+    constructor({ messenger, state }){
+        super({
+            messenger,
+            metadata: {
+                jobs: {
+                    persist: true,
+                    anonymous: false
+                }
+            },
+            name: controllerName,
+            state: {
+                jobs: {},
+                ...state
+            }
+        });
+        _class_private_field_init(this, _messenger, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_init(this, _dailyTimer, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_init(this, _timers, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_init(this, _snapIds, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_set(this, _timers, new Map());
+        _class_private_field_set(this, _snapIds, new Map());
+        _class_private_field_set(this, _messenger, messenger);
+        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:snapRemoved', 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);
+        });
+    }
+}
+
+//# sourceMappingURL=CronjobController.js.map

package/dist/esm/cronjob/CronjobController.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/cronjob/CronjobController.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV2 as BaseController } from '@metamask/base-controller';\nimport type { GetPermissions } from '@metamask/permission-controller';\nimport type {\n  SnapId,\n  ValidatedSnapId,\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  SnapRemoved,\n  SnapUpdated,\n} from '..';\nimport { getRunnableSnaps, SnapEndowments } from '..';\nimport { getCronjobCaveatJobs } from '../snaps/endowments/cronjob';\nimport { Timer } from '../snaps/Timer';\n\nexport type CronjobControllerActions =\n  | GetAllSnaps\n  | HandleSnapRequest\n  | GetPermissions;\n\nexport type CronjobControllerEvents =\n  | SnapInstalled\n  | SnapRemoved\n  | SnapUpdated\n  | SnapEnabled\n  | SnapDisabled;\n\nexport type CronjobControllerMessenger = RestrictedControllerMessenger<\n  'CronjobController',\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: ValidatedSnapId;\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:snapRemoved',\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: ValidatedSnapId): 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: ValidatedSnapId) {\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    this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually\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: SnapId) {\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 necesary 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:snapRemoved',\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"],"names":["BaseControllerV2","BaseController","HandlerType","parseCronExpression","logError","Duration","inMilliseconds","getRunnableSnaps","SnapEndowments","getCronjobCaveatJobs","Timer","DAILY_TIMEOUT","Hour","controllerName","CronjobController","getAllJobs","snaps","messagingSystem","call","filteredSnaps","jobs","map","snap","getSnapJobs","id","flat","filter","job","undefined","snapId","permissions","messenger","permission","Cronjob","definitions","definition","idx","register","forEach","schedule","timers","has","parsed","expression","next","now","Date","ms","getTime","timer","start","executeCronjob","catch","error","delete","updateJobLastRunState","set","snapIds","origin","handler","OnCronjob","request","unregister","entries","_","jobSnapId","length","get","cancel","jobId","lastRun","update","state","dailyCheckIn","hasPrev","prev","dailyTimer","destroy","unsubscribe","_handleSnapRegisterEvent","_handleSnapUnregisterEvent","_handleEventSnapUpdated","constructor","metadata","persist","anonymous","name","Map","bind","subscribe"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,SAASA,oBAAoBC,cAAc,QAAQ,4BAA4B;AAQ/E,SACEC,WAAW,EACXC,mBAAmB,EACnBC,QAAQ,QACH,wBAAwB;AAC/B,SAASC,QAAQ,EAAEC,cAAc,QAAQ,kBAAkB;AAW3D,SAASC,gBAAgB,EAAEC,cAAc,QAAQ,KAAK;AACtD,SAASC,oBAAoB,QAAQ,8BAA8B;AACnE,SAASC,KAAK,QAAQ,iBAAiB;AAsBvC,OAAO,MAAMC,gBAAgBL,eAAe,IAAID,SAASO,IAAI,EAAE;AAwB/D,MAAMC,iBAAiB;IAWrB,0CAEA,2CAEA,uCAEA,+BAA+B;AAC/B;AAhBF;;;CAGC,GACD,OAAO,MAAMC,0BAA0Bb;IAoErC;;;;GAIC,GACD,AAAQc,aAAwB;QAC9B,MAAMC,QAAQ,IAAI,CAACC,eAAe,CAACC,IAAI,CAAC;QACxC,MAAMC,gBAAgBZ,iBAAiBS;QAEvC,MAAMI,OAAOD,cAAcE,GAAG,CAAC,CAACC,OAAS,IAAI,CAACC,WAAW,CAACD,KAAKE,EAAE;QACjE,4EAA4E;QAC5E,OAAOJ,KAAKK,IAAI,GAAGC,MAAM,CAAC,CAACC,MAAQA,QAAQC;IAC7C;IAEA;;;;;GAKC,GACD,AAAQL,YAAYM,MAAuB,EAAyB;QAClE,MAAMC,cAAc,yBAAA,IAAI,EAAEC,YAAUb,IAAI,CACtC,uCACAW;QAGF,MAAMG,aAAaF,aAAa,CAACtB,eAAeyB,OAAO,CAAC;QACxD,MAAMC,cAAczB,qBAAqBuB;QAEzC,OAAOE,aAAab,IAAI,CAACc,YAAYC;YACnC,OAAO;gBAAE,GAAGD,UAAU;gBAAEX,IAAI,CAAC,EAAEK,OAAO,CAAC,EAAEO,IAAI,CAAC;gBAAEP;YAAO;QACzD;IACF;IAEA;;;;;GAKC,GACDQ,SAASR,MAAuB,EAAE;QAChC,MAAMT,OAAO,IAAI,CAACG,WAAW,CAACM;QAC9BT,MAAMkB,QAAQ,CAACX,MAAQ,IAAI,CAACY,QAAQ,CAACZ;IACvC;IAEA;;;;;;;;;;GAUC,GACD,AAAQY,SAASZ,GAAY,EAAE;QAC7B,IAAI,yBAAA,IAAI,EAAEa,SAAOC,GAAG,CAACd,IAAIH,EAAE,GAAG;YAC5B;QACF;QAEA,MAAMkB,SAASvC,oBAAoBwB,IAAIgB,UAAU;QACjD,MAAMC,OAAOF,OAAOE,IAAI;QACxB,MAAMC,MAAM,IAAIC;QAChB,MAAMC,KAAKH,KAAKI,OAAO,KAAKH,IAAIG,OAAO;QAEvC,6DAA6D;QAC7D,IAAID,KAAKpC,eAAe;YACtB;QACF;QAEA,MAAMsC,QAAQ,IAAIvC,MAAMqC;QACxBE,MAAMC,KAAK,CAAC;YACV,IAAI,CAACC,cAAc,CAACxB,KAAKyB,KAAK,CAAC,CAACC;gBAC9B,qCAAqC;gBACrCjD,SAASiD;YACX;YAEA,yBAAA,IAAI,EAAEb,SAAOc,MAAM,CAAC3B,IAAIH,EAAE;YAC1B,IAAI,CAACe,QAAQ,CAACZ;QAChB;QAEA,IAAI,CAAC4B,qBAAqB,CAAC5B,IAAIH,EAAE,EAAE,IAAI,iCAAiC;QACxE,yBAAA,IAAI,EAAEgB,SAAOgB,GAAG,CAAC7B,IAAIH,EAAE,EAAEyB;QACzB,yBAAA,IAAI,EAAEQ,UAAQD,GAAG,CAAC7B,IAAIH,EAAE,EAAEG,IAAIE,MAAM;IACtC;IAEA;;;;GAIC,GACD,MAAcsB,eAAexB,GAAY,EAAE;QACzC,IAAI,CAAC4B,qBAAqB,CAAC5B,IAAIH,EAAE,EAAEsB,KAAKD,GAAG;QAC3C,MAAM,yBAAA,IAAI,EAAEd,YAAUb,IAAI,CAAC,gCAAgC;YACzDW,QAAQF,IAAIE,MAAM;YAClB6B,QAAQ;YACRC,SAASzD,YAAY0D,SAAS;YAC9BC,SAASlC,IAAIkC,OAAO;QACtB;IACF;IAEA;;;;GAIC,GACDC,WAAWjC,MAAc,EAAE;QACzB,MAAMT,OAAO;eAAI,yBAAA,IAAI,EAAEqC,UAAQM,OAAO;SAAG,CAACrC,MAAM,CAC9C,CAAC,CAACsC,GAAGC,UAAU,GAAKA,cAAcpC;QAGpC,IAAIT,KAAK8C,MAAM,EAAE;YACf9C,KAAKkB,OAAO,CAAC,CAAC,CAACd,GAAG;gBAChB,MAAMyB,QAAQ,yBAAA,IAAI,EAAET,SAAO2B,GAAG,CAAC3C;gBAC/B,IAAIyB,OAAO;oBACTA,MAAMmB,MAAM;oBACZ,yBAAA,IAAI,EAAE5B,SAAOc,MAAM,CAAC9B;oBACpB,yBAAA,IAAI,EAAEiC,UAAQH,MAAM,CAAC9B;gBACvB;YACF;QACF;IACF;IAEA;;;;;GAKC,GACD,AAAQ+B,sBAAsBc,KAAa,EAAEC,OAAe,EAAE;QAC5D,IAAI,CAACC,MAAM,CAAC,CAACC;YACXA,MAAMpD,IAAI,CAACiD,MAAM,GAAG;gBAClBC;YACF;QACF;IACF;IAEA;;;;GAIC,GACD,MAAMG,eAAe;QACnB,MAAMrD,OAAO,IAAI,CAACL,UAAU;QAE5B,KAAK,MAAMY,OAAOP,KAAM;YACtB,MAAMsB,SAASvC,oBAAoBwB,IAAIgB,UAAU;YACjD,MAAM2B,UAAU,IAAI,CAACE,KAAK,CAACpD,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAE8C;YACzC,gFAAgF;YAChF,IACEA,YAAY1C,aACZc,OAAOgC,OAAO,MACdhC,OAAOiC,IAAI,GAAG3B,OAAO,KAAKsB,SAC1B;gBACA,MAAM,IAAI,CAACnB,cAAc,CAACxB;YAC5B;YAEA,kEAAkE;YAClE,IAAI,CAACY,QAAQ,CAACZ;QAChB;uCAEMiD,aAAa,IAAIlE,MAAMC;QAC7B,yBAAA,IAAI,EAAEiE,aAAW1B,KAAK,CAAC;YACrB,IAAI,CAACuB,YAAY,GAAGrB,KAAK,CAAC,CAACC;gBACzB,qCAAqC;gBACrCjD,SAASiD;YACX;QACF;IACF;IAEA;;GAEC,GACDwB,UAAU;QACR,KAAK,CAACA;QAEN,oDAAoD,GACpD,IAAI,CAAC5D,eAAe,CAAC6D,WAAW,CAC9B,gCACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAAC9D,eAAe,CAAC6D,WAAW,CAC9B,8BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAAC/D,eAAe,CAAC6D,WAAW,CAC9B,8BACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAAC9D,eAAe,CAAC6D,WAAW,CAC9B,+BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAAC/D,eAAe,CAAC6D,WAAW,CAC9B,8BACA,IAAI,CAACG,uBAAuB;QAE9B,mDAAmD,GAEnD,yBAAA,IAAI,EAAExB,UAAQnB,OAAO,CAAC,CAACT;YACrB,IAAI,CAACiC,UAAU,CAACjC;QAClB;IACF;IAEA;;;;GAIC,GACD,AAAQkD,yBAAyBzD,IAAmB,EAAE;QACpD,IAAI,CAACe,QAAQ,CAACf,KAAKE,EAAE;IACvB;IAEA;;;;GAIC,GACD,AAAQwD,2BAA2B1D,IAAmB,EAAE;QACtD,IAAI,CAACwC,UAAU,CAACxC,KAAKE,EAAE;IACzB;IAEA;;;;GAIC,GACD,AAAQyD,wBAAwB3D,IAAmB,EAAE;QACnD,IAAI,CAACwC,UAAU,CAACxC,KAAKE,EAAE;QACvB,IAAI,CAACa,QAAQ,CAACf,KAAKE,EAAE;IACvB;IAjSA0D,YAAY,EAAEnD,SAAS,EAAEyC,KAAK,EAAyB,CAAE;QACvD,KAAK,CAAC;YACJzC;YACAoD,UAAU;gBACR/D,MAAM;oBAAEgE,SAAS;oBAAMC,WAAW;gBAAM;YAC1C;YACAC,MAAMzE;YACN2D,OAAO;gBACLpD,MAAM,CAAC;gBACP,GAAGoD,KAAK;YACV;QACF;QApBF,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAGA,gCAAA;;mBAAA,KAAA;;uCAcQhC,SAAS,IAAI+C;uCACb9B,UAAU,IAAI8B;uCACdxD,YAAYA;QAElB,IAAI,CAACgD,wBAAwB,GAAG,IAAI,CAACA,wBAAwB,CAACS,IAAI,CAAC,IAAI;QACvE,IAAI,CAACR,0BAA0B,GAC7B,IAAI,CAACA,0BAA0B,CAACQ,IAAI,CAAC,IAAI;QAC3C,IAAI,CAACP,uBAAuB,GAAG,IAAI,CAACA,uBAAuB,CAACO,IAAI,CAAC,IAAI;QAErE,2BAA2B;QAC3B,oDAAoD,GACpD,IAAI,CAACvE,eAAe,CAACwE,SAAS,CAC5B,gCACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAAC9D,eAAe,CAACwE,SAAS,CAC5B,8BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAAC/D,eAAe,CAACwE,SAAS,CAC5B,8BACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAAC9D,eAAe,CAACwE,SAAS,CAC5B,+BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAAC/D,eAAe,CAACwE,SAAS,CAC5B,8BACA,IAAI,CAACR,uBAAuB;QAE9B,mDAAmD,GAEnD,IAAI,CAACR,YAAY,GAAGrB,KAAK,CAAC,CAACC;YACzBjD,SAASiD;QACX;IACF;AA8OF"}

package/dist/esm/cronjob/index.js

@@ -0,0 +1,3 @@
+export * from './CronjobController';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/cronjob/index.js.map

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

package/dist/esm/fsm.js

@@ -0,0 +1,70 @@
+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.js.map

package/dist/esm/fsm.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/fsm.ts"],"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"],"names":["assert","InterpreterStatus","validateMachine","machine","typed","toArray","obj","Array","isArray","undefined","allActions","Set","addActions","actions","flatMap","action","forEach","add","bind","state","Object","values","config","states","entry","exit","transition","on","_options","forceStrict","interpreter","onInitialCalled","subscribe","changed","ogSend","send","args","status","Running"],"mappings":"AAAA,SAASA,MAAM,QAAQ,kBAAkB;AAEzC,SAASC,iBAAiB,QAAQ,cAAc;AAEhD;;;;;;;CAOC,GACD,OAAO,SAASC,gBAIdC,OAAuD;IACvDH,OAAO,cAAcG,SAAS;IAC9B,MAAMC,QAAQD;IAId,KAAK;IACL,MAAME,UAAU,CAAOC;QACrB,IAAIC,MAAMC,OAAO,CAACF,MAAM;YACtB,OAAOA;QACT,OAAO,IAAIA,QAAQG,aAAaH,QAAQ,MAAM;YAC5C,OAAO,EAAE;QACX;QACA,OAAO;YAACA;SAAI;IACd;IAEA,MAAMI,aAAa,IAAIC;IACvB,MAAMC,aAAa,CAACC,UAClBR,QAAQQ,SACLC,OAAO,CAAC,CAACC;YACR,IAAI,OAAOA,WAAW,UAAU;gBAC9B,OAAO;oBAACA;iBAAO;YACjB;YACAf,OAAO,OAAOe,WAAW;YACzB,OAAO,EAAE;QACX,GACCC,OAAO,CAACN,WAAWO,GAAG,CAACC,IAAI,CAACR;IAEjC,KAAK,MAAMS,SAASC,OAAOC,MAAM,CAC/BjB,MAAMkB,MAAM,CAACC,MAAM,EAClB;QACDX,WAAWO,MAAMK,KAAK;QACtBZ,WAAWO,MAAMM,IAAI;QACrB,KAAK,MAAMC,cAAcN,OAAOC,MAAM,CAAMF,MAAMQ,EAAE,IAAI,CAAC,GAAI;YAC3Df,WAAWc,WAAWb,OAAO;QAC/B;IACF;IAEAH,WAAWM,OAAO,CAAC,CAACD,SAClBf,OACEI,MAAMwB,QAAQ,CAACf,OAAO,KAAKJ,aAAaM,UAAUX,MAAMwB,QAAQ,CAACf,OAAO,EACxE,CAAC,QAAQ,EAAEE,OAAO,gCAAgC,CAAC;AAGzD;AAEA;;;;;;;;;;;;CAYC,GACD,OAAO,SAASc,YAAYC,WAAgD;IAC1E,wEAAwE;IACxE,4DAA4D;IAC5D,IAAIC,kBAAkB;IACtBD,YAAYE,SAAS,CAAC,CAACb;QACrBnB,OAAO,CAAC+B,mBAAmBZ,MAAMc,OAAO,EAAE;QAC1CF,kBAAkB;IACpB;IAEA,MAAMG,SAASJ,YAAYK,IAAI,CAACjB,IAAI,CAACY;IACrCA,YAAYK,IAAI,GAAG,CAAC,GAAGC;QACrBpC,OACE8B,YAAYO,MAAM,KAAKpC,kBAAkBqC,OAAO,EAChD;QAEF,OAAOJ,UAAUE;IACnB;AACF"}

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+export * from './services';
+export * from './snaps';
+export * from './utils';
+export * from './cronjob';
+
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export type { Json } from '@metamask/utils';\nexport * from './services';\nexport * from './snaps';\nexport * from './utils';\nexport * from './cronjob';\n"],"names":[],"mappings":"AACA,cAAc,aAAa;AAC3B,cAAc,UAAU;AACxB,cAAc,UAAU;AACxB,cAAc,YAAY"}

package/dist/esm/logging.js

@@ -0,0 +1,10 @@
+import { snapsLogger } from '@metamask/snaps-utils';
+import { createModuleLogger } from '@metamask/utils';
+/**
+ * A logging function specific to this package. The log messages don't show up
+ * by default, but they can be enabled by setting the environment variable:
+ * - `DEBUG=metamask:snaps:snaps-controllers`, or
+ * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.
+ */ export const log = createModuleLogger(snapsLogger, 'snaps-controllers');
+
+//# sourceMappingURL=logging.js.map

package/dist/esm/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/logging.ts"],"sourcesContent":["import { snapsLogger } from '@metamask/snaps-utils';\nimport { createModuleLogger } from '@metamask/utils';\n\n/**\n * A logging function specific to this package. The log messages don't show up\n * by default, but they can be enabled by setting the environment variable:\n * - `DEBUG=metamask:snaps:snaps-controllers`, or\n * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.\n */\nexport const log = createModuleLogger(snapsLogger, 'snaps-controllers');\n"],"names":["snapsLogger","createModuleLogger","log"],"mappings":"AAAA,SAASA,WAAW,QAAQ,wBAAwB;AACpD,SAASC,kBAAkB,QAAQ,kBAAkB;AAErD;;;;;CAKC,GACD,OAAO,MAAMC,MAAMD,mBAAmBD,aAAa,qBAAqB"}