@metamask/snaps-controllers 5.0.1 → 6.0.1

package/dist/types/services/index.d.ts

@@ -2,7 +2,5 @@ export * from './AbstractExecutionService';
 export * from './ExecutionService';
 export * from './ProxyPostMessageStream';
 export * from './iframe';
-export * from './node';
 export * from './offscreen';
-export * from './webview';
 export { WebWorkerExecutionService } from './webworker';

package/dist/types/services/node.d.ts

@@ -0,0 +1,2 @@
+export * from '.';
+export * from './node-js';

package/dist/types/services/react-native.d.ts

@@ -0,0 +1,2 @@
+export * from '.';
+export * from './webview';

package/dist/types/utils.d.ts

@@ -220,8 +220,8 @@ export declare function fetchSnap(snapId: SnapId, location: SnapLocation): Promi
                 maxRequestTime?: number | undefined;
             } | undefined;
             'endowment:rpc'?: {
-                dapps?: boolean | undefined;
                 snaps?: boolean | undefined;
+                dapps?: boolean | undefined;
                 allowedOrigins?: string[] | undefined;
             } | undefined;
             'endowment:signature-insight'?: {

package/dist/types/vendor/global.d.js

@@ -0,0 +1 @@
+"use strict";//# sourceMappingURL=global.d.js.map

package/dist/types/vendor/global.d.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/types/vendor/global.d.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=global.d.mjs.map

package/dist/types/vendor/global.d.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/vendor/readable-stream.d.js

@@ -0,0 +1 @@
+"use strict";//# sourceMappingURL=readable-stream.d.js.map

package/dist/types/vendor/readable-stream.d.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/types/vendor/readable-stream.d.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=readable-stream.d.mjs.map

package/dist/types/vendor/readable-stream.d.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/vendor/zlib.d.js

@@ -0,0 +1 @@
+"use strict";//# sourceMappingURL=zlib.d.js.map

package/dist/types/vendor/zlib.d.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/types/vendor/zlib.d.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=zlib.d.mjs.map

package/dist/types/vendor/zlib.d.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/utils.js

@@ -0,0 +1,21 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+
+
+var _chunkXE5IWVNVjs = require('./chunk-XE5IWVNV.js');
+require('./chunk-NOLPMHXS.js');
+require('./chunk-EXN2TFDJ.js');
+
+
+
+
+
+
+
+
+exports.delay = _chunkXE5IWVNVjs.delay; exports.delayWithTimer = _chunkXE5IWVNVjs.delayWithTimer; exports.fetchSnap = _chunkXE5IWVNVjs.fetchSnap; exports.getSnapFiles = _chunkXE5IWVNVjs.getSnapFiles; exports.hasTimedOut = _chunkXE5IWVNVjs.hasTimedOut; exports.setDiff = _chunkXE5IWVNVjs.setDiff; exports.withTimeout = _chunkXE5IWVNVjs.withTimeout;
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/utils.mjs

@@ -0,0 +1,21 @@
+import {
+  delay,
+  delayWithTimer,
+  fetchSnap,
+  getSnapFiles,
+  hasTimedOut,
+  setDiff,
+  withTimeout
+} from "./chunk-36YC4Z3T.mjs";
+import "./chunk-VOZOZKRC.mjs";
+import "./chunk-YRZVIDCF.mjs";
+export {
+  delay,
+  delayWithTimer,
+  fetchSnap,
+  getSnapFiles,
+  hasTimedOut,
+  setDiff,
+  withTimeout
+};
+//# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,23 +1,35 @@
 {
   "name": "@metamask/snaps-controllers",
-  "version": "5.0.1",
+  "version": "6.0.1",
   "description": "Controllers for MetaMask Snaps.",
   "repository": {
     "type": "git",
     "url": "https://github.com/MetaMask/snaps.git"
   },
   "sideEffects": false,
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "browser": {
-    "./dist/cjs/services": "./dist/cjs/services/browser.js",
-    "./dist/esm/services": "./dist/esm/services/browser.js"
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./node": {
+      "import": "./dist/node.mjs",
+      "require": "./dist/node.js",
+      "types": "./dist/types/node.d.ts"
+    },
+    "./react-native": {
+      "import": "./dist/react-native.mjs",
+      "require": "./dist/react-native.js",
+      "types": "./dist/types/react-native.d.ts"
+    },
+    "./package.json": "./package.json"
   },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "types": "./dist/types/index.d.ts",
   "files": [
-    "dist/cjs/**",
-    "dist/esm/**",
-    "dist/types/**"
+    "dist"
   ],
   "scripts": {
     "test:prepare": "yarn mkdirp test/fixtures && ./scripts/generate-fixtures.sh",
@@ -25,12 +37,8 @@
     "posttest": "ts-node scripts/coverage.ts && rimraf coverage/jest coverage/wdio",
     "test:browser": "wdio run wdio.config.js",
     "test:ci": "yarn test",
-    "build": "yarn build:source && yarn build:types",
-    "build:source": "yarn build:esm && yarn build:cjs",
+    "build": "tsup --clean && yarn build:types",
     "build:types": "tsc --project tsconfig.build.json",
-    "build:esm": "swc src --out-dir dist/esm --config-file ../../.swcrc.build.json --config module.type=es6",
-    "build:cjs": "swc src --out-dir dist/cjs --config-file ../../.swcrc.build.json --config module.type=commonjs",
-    "build:clean": "yarn clean && yarn build",
     "clean": "rimraf '*.tsbuildinfo' 'dist'",
     "lint:eslint": "eslint . --cache --ext js,ts,jsx,tsx",
     "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" --ignore-path ../../.gitignore",
@@ -39,21 +47,22 @@
     "lint:changelog": "../../scripts/validate-changelog.sh @metamask/snaps-controllers",
     "publish:preview": "yarn npm publish --tag preview",
     "lint:ci": "yarn lint",
-    "lint:dependencies": "depcheck"
+    "lint:dependencies": "depcheck",
+    "build:ci": "tsup --clean"
   },
   "dependencies": {
     "@metamask/approval-controller": "^5.1.2",
     "@metamask/base-controller": "^4.1.0",
     "@metamask/json-rpc-engine": "^7.3.2",
     "@metamask/object-multiplex": "^2.0.0",
-    "@metamask/permission-controller": "^8.0.0",
+    "@metamask/permission-controller": "^8.0.1",
     "@metamask/phishing-controller": "^8.0.2",
     "@metamask/post-message-stream": "^8.0.0",
-    "@metamask/rpc-errors": "^6.1.0",
+    "@metamask/rpc-errors": "^6.2.1",
     "@metamask/snaps-registry": "^3.0.0",
-    "@metamask/snaps-rpc-methods": "^6.0.0",
-    "@metamask/snaps-sdk": "^2.1.0",
-    "@metamask/snaps-utils": "^6.1.0",
+    "@metamask/snaps-rpc-methods": "^7.0.1",
+    "@metamask/snaps-sdk": "^3.0.1",
+    "@metamask/snaps-utils": "^7.0.1",
     "@metamask/utils": "^8.3.0",
     "@xstate/fsm": "^2.0.0",
     "browserify-zlib": "^0.2.0",
@@ -76,7 +85,6 @@
     "@metamask/eslint-config-nodejs": "^12.1.0",
     "@metamask/eslint-config-typescript": "^12.1.0",
     "@metamask/template-snap": "^0.7.0",
-    "@swc/cli": "^0.1.62",
     "@swc/core": "1.3.78",
     "@swc/jest": "^0.2.26",
     "@types/chrome": "^0.0.237",
@@ -117,6 +125,7 @@
     "prettier-plugin-packagejson": "^2.2.11",
     "rimraf": "^4.1.2",
     "ts-node": "^10.9.1",
+    "tsup": "^8.0.1",
     "typescript": "~4.8.4",
     "vite": "^4.3.9",
     "vite-tsconfig-paths": "^4.0.5",
@@ -125,7 +134,7 @@
     "webdriverio": "^8.19.0"
   },
   "peerDependencies": {
-    "@metamask/snaps-execution-environments": "^4.0.1"
+    "@metamask/snaps-execution-environments": "^5.0.1"
   },
   "peerDependenciesMeta": {
     "@metamask/snaps-execution-environments": {

package/dist/cjs/cronjob/CronjobController.js

@@ -1,296 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    DAILY_TIMEOUT: function() {
-        return DAILY_TIMEOUT;
-    },
-    CronjobController: function() {
-        return CronjobController;
-    }
-});
-const _basecontroller = require("@metamask/base-controller");
-const _snapsrpcmethods = require("@metamask/snaps-rpc-methods");
-const _snapsutils = require("@metamask/snaps-utils");
-const _utils = require("@metamask/utils");
-const _ = require("..");
-const _Timer = require("../snaps/Timer");
-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;
-}
-const DAILY_TIMEOUT = (0, _utils.inMilliseconds)(24, _utils.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();
-class CronjobController extends _basecontroller.BaseController {
-    /**
-   * Retrieve all cronjob specifications for all runnable snaps.
-   *
-   * @returns Array of Cronjob specifications.
-   */ getAllJobs() {
-        const snaps = this.messagingSystem.call('SnapController:getAll');
-        const filteredSnaps = (0, _.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?.[_snapsrpcmethods.SnapEndowments.Cronjob];
-        const definitions = (0, _snapsrpcmethods.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 = (0, _snapsutils.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.Timer(ms);
-        timer.start(()=>{
-            this.executeCronjob(job).catch((error)=>{
-                // TODO: Decide how to handle errors.
-                (0, _snapsutils.logError)(error);
-            });
-            _class_private_field_get(this, _timers).delete(job.id);
-            this.schedule(job);
-        });
-        if (!this.state.jobs[job.id]?.lastRun) {
-            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: _snapsutils.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 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 = (0, _snapsutils.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.Timer(DAILY_TIMEOUT));
-        _class_private_field_get(this, _dailyTimer).start(()=>{
-            this.dailyCheckIn().catch((error)=>{
-                // TODO: Decide how to handle errors.
-                (0, _snapsutils.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 */ _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: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)=>{
-            (0, _snapsutils.logError)(error);
-        });
-    }
-}
-
-//# sourceMappingURL=CronjobController.js.map

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

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/cronjob/CronjobController.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } 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 CronjobControllerActions =\n  | GetAllSnaps\n  | HandleSnapRequest\n  | GetPermissions;\n\nexport type CronjobControllerEvents =\n  | SnapInstalled\n  | SnapUninstalled\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: 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"],"names":["DAILY_TIMEOUT","CronjobController","inMilliseconds","Duration","Hour","controllerName","BaseController","getAllJobs","snaps","messagingSystem","call","filteredSnaps","getRunnableSnaps","jobs","map","snap","getSnapJobs","id","flat","filter","job","undefined","snapId","permissions","messenger","permission","SnapEndowments","Cronjob","definitions","getCronjobCaveatJobs","definition","idx","register","forEach","schedule","timers","has","parsed","parseCronExpression","expression","next","now","Date","ms","getTime","timer","Timer","start","executeCronjob","catch","error","logError","delete","state","lastRun","updateJobLastRunState","set","snapIds","origin","handler","HandlerType","OnCronjob","request","unregister","entries","_","jobSnapId","length","get","cancel","jobId","update","dailyCheckIn","hasPrev","prev","dailyTimer","destroy","unsubscribe","_handleSnapRegisterEvent","_handleSnapUnregisterEvent","_handleEventSnapUpdated","constructor","metadata","persist","anonymous","name","Map","bind","subscribe"],"mappings":";;;;;;;;;;;IAmDaA,aAAa;eAAbA;;IA8BAC,iBAAiB;eAAjBA;;;gCAhFkB;iCAKxB;4BAUA;uBACkC;kBAWR;uBACX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBf,MAAMD,gBAAgBE,IAAAA,qBAAc,EAAC,IAAIC,eAAQ,CAACC,IAAI;AAwB7D,MAAMC,iBAAiB;IAWrB,0CAEA,2CAEA,uCAEA,+BAA+B;AAC/B;AAZK,MAAMJ,0BAA0BK,8BAAc;IAoEnD;;;;GAIC,GACD,AAAQC,aAAwB;QAC9B,MAAMC,QAAQ,IAAI,CAACC,eAAe,CAACC,IAAI,CAAC;QACxC,MAAMC,gBAAgBC,IAAAA,kBAAgB,EAACJ;QAEvC,MAAMK,OAAOF,cAAcG,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,MAAc,EAAyB;QACzD,MAAMC,cAAc,yBAAA,IAAI,EAAEC,YAAUd,IAAI,CACtC,uCACAY;QAGF,MAAMG,aAAaF,aAAa,CAACG,+BAAc,CAACC,OAAO,CAAC;QACxD,MAAMC,cAAcC,IAAAA,qCAAoB,EAACJ;QAEzC,OAAOG,aAAad,IAAI,CAACgB,YAAYC;YACnC,OAAO;gBAAE,GAAGD,UAAU;gBAAEb,IAAI,CAAC,EAAEK,OAAO,CAAC,EAAES,IAAI,CAAC;gBAAET;YAAO;QACzD;IACF;IAEA;;;;;GAKC,GACDU,SAASV,MAAc,EAAE;QACvB,MAAMT,OAAO,IAAI,CAACG,WAAW,CAACM;QAC9BT,MAAMoB,QAAQ,CAACb,MAAQ,IAAI,CAACc,QAAQ,CAACd;IACvC;IAEA;;;;;;;;;;GAUC,GACD,AAAQc,SAASd,GAAY,EAAE;QAC7B,IAAI,yBAAA,IAAI,EAAEe,SAAOC,GAAG,CAAChB,IAAIH,EAAE,GAAG;YAC5B;QACF;QAEA,MAAMoB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;QACjD,MAAMC,OAAOH,OAAOG,IAAI;QACxB,MAAMC,MAAM,IAAIC;QAChB,MAAMC,KAAKH,KAAKI,OAAO,KAAKH,IAAIG,OAAO;QAEvC,6DAA6D;QAC7D,IAAID,KAAK3C,eAAe;YACtB;QACF;QAEA,MAAM6C,QAAQ,IAAIC,YAAK,CAACH;QACxBE,MAAME,KAAK,CAAC;YACV,IAAI,CAACC,cAAc,CAAC5B,KAAK6B,KAAK,CAAC,CAACC;gBAC9B,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;YAEA,yBAAA,IAAI,EAAEf,SAAOiB,MAAM,CAAChC,IAAIH,EAAE;YAC1B,IAAI,CAACiB,QAAQ,CAACd;QAChB;QAEA,IAAI,CAAC,IAAI,CAACiC,KAAK,CAACxC,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAEqC,SAAS;YACrC,IAAI,CAACC,qBAAqB,CAACnC,IAAIH,EAAE,EAAE,IAAI,iCAAiC;QAC1E;QAEA,yBAAA,IAAI,EAAEkB,SAAOqB,GAAG,CAACpC,IAAIH,EAAE,EAAE4B;QACzB,yBAAA,IAAI,EAAEY,UAAQD,GAAG,CAACpC,IAAIH,EAAE,EAAEG,IAAIE,MAAM;IACtC;IAEA;;;;GAIC,GACD,MAAc0B,eAAe5B,GAAY,EAAE;QACzC,IAAI,CAACmC,qBAAqB,CAACnC,IAAIH,EAAE,EAAEyB,KAAKD,GAAG;QAC3C,MAAM,yBAAA,IAAI,EAAEjB,YAAUd,IAAI,CAAC,gCAAgC;YACzDY,QAAQF,IAAIE,MAAM;YAClBoC,QAAQ;YACRC,SAASC,uBAAW,CAACC,SAAS;YAC9BC,SAAS1C,IAAI0C,OAAO;QACtB;IACF;IAEA;;;;GAIC,GACDC,WAAWzC,MAAc,EAAE;QACzB,MAAMT,OAAO;eAAI,yBAAA,IAAI,EAAE4C,UAAQO,OAAO;SAAG,CAAC7C,MAAM,CAC9C,CAAC,CAAC8C,GAAGC,UAAU,GAAKA,cAAc5C;QAGpC,IAAIT,KAAKsD,MAAM,EAAE;YACftD,KAAKoB,OAAO,CAAC,CAAC,CAAChB,GAAG;gBAChB,MAAM4B,QAAQ,yBAAA,IAAI,EAAEV,SAAOiC,GAAG,CAACnD;gBAC/B,IAAI4B,OAAO;oBACTA,MAAMwB,MAAM;oBACZ,yBAAA,IAAI,EAAElC,SAAOiB,MAAM,CAACnC;oBACpB,yBAAA,IAAI,EAAEwC,UAAQL,MAAM,CAACnC;gBACvB;YACF;QACF;IACF;IAEA;;;;;GAKC,GACD,AAAQsC,sBAAsBe,KAAa,EAAEhB,OAAe,EAAE;QAC5D,IAAI,CAACiB,MAAM,CAAC,CAAClB;YACXA,MAAMxC,IAAI,CAACyD,MAAM,GAAG;gBAClBhB;YACF;QACF;IACF;IAEA;;;;GAIC,GACD,MAAMkB,eAAe;QACnB,MAAM3D,OAAO,IAAI,CAACN,UAAU;QAE5B,KAAK,MAAMa,OAAOP,KAAM;YACtB,MAAMwB,SAASC,IAAAA,+BAAmB,EAAClB,IAAImB,UAAU;YACjD,MAAMe,UAAU,IAAI,CAACD,KAAK,CAACxC,IAAI,CAACO,IAAIH,EAAE,CAAC,EAAEqC;YACzC,gFAAgF;YAChF,IACEA,YAAYjC,aACZgB,OAAOoC,OAAO,MACdpC,OAAOqC,IAAI,GAAG9B,OAAO,KAAKU,SAC1B;gBACA,MAAM,IAAI,CAACN,cAAc,CAAC5B;YAC5B;YAEA,kEAAkE;YAClE,IAAI,CAACc,QAAQ,CAACd;QAChB;uCAEMuD,aAAa,IAAI7B,YAAK,CAAC9C;QAC7B,yBAAA,IAAI,EAAE2E,aAAW5B,KAAK,CAAC;YACrB,IAAI,CAACyB,YAAY,GAAGvB,KAAK,CAAC,CAACC;gBACzB,qCAAqC;gBACrCC,IAAAA,oBAAQ,EAACD;YACX;QACF;IACF;IAEA;;GAEC,GACD0B,UAAU;QACR,KAAK,CAACA;QAEN,oDAAoD,GACpD,IAAI,CAACnE,eAAe,CAACoE,WAAW,CAC9B,gCACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,kCACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACC,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAACoE,WAAW,CAC9B,+BACA,IAAI,CAACE,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAACoE,WAAW,CAC9B,8BACA,IAAI,CAACG,uBAAuB;QAE9B,mDAAmD,GAEnD,yBAAA,IAAI,EAAEvB,UAAQxB,OAAO,CAAC,CAACX;YACrB,IAAI,CAACyC,UAAU,CAACzC;QAClB;IACF;IAEA;;;;GAIC,GACD,AAAQwD,yBAAyB/D,IAAmB,EAAE;QACpD,IAAI,CAACiB,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IAEA;;;;GAIC,GACD,AAAQ8D,2BAA2BhE,IAAmB,EAAE;QACtD,IAAI,CAACgD,UAAU,CAAChD,KAAKE,EAAE;IACzB;IAEA;;;;GAIC,GACD,AAAQ+D,wBAAwBjE,IAAmB,EAAE;QACnD,IAAI,CAACgD,UAAU,CAAChD,KAAKE,EAAE;QACvB,IAAI,CAACe,QAAQ,CAACjB,KAAKE,EAAE;IACvB;IApSAgE,YAAY,EAAEzD,SAAS,EAAE6B,KAAK,EAAyB,CAAE;QACvD,KAAK,CAAC;YACJ7B;YACA0D,UAAU;gBACRrE,MAAM;oBAAEsE,SAAS;oBAAMC,WAAW;gBAAM;YAC1C;YACAC,MAAMhF;YACNgD,OAAO;gBACLxC,MAAM,CAAC;gBACP,GAAGwC,KAAK;YACV;QACF;QApBF,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAGA,gCAAA;;mBAAA,KAAA;;uCAcQlB,SAAS,IAAImD;uCACb7B,UAAU,IAAI6B;uCACd9D,YAAYA;QAElB,IAAI,CAACsD,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,CAAC9E,eAAe,CAAC+E,SAAS,CAC5B,gCACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,kCACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACV,wBAAwB;QAG/B,IAAI,CAACrE,eAAe,CAAC+E,SAAS,CAC5B,+BACA,IAAI,CAACT,0BAA0B;QAGjC,IAAI,CAACtE,eAAe,CAAC+E,SAAS,CAC5B,8BACA,IAAI,CAACR,uBAAuB;QAE9B,mDAAmD,GAEnD,IAAI,CAACR,YAAY,GAAGvB,KAAK,CAAC,CAACC;YACzBC,IAAAA,oBAAQ,EAACD;QACX;IACF;AAiPF"}

package/dist/cjs/cronjob/index.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./CronjobController"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}
-
-//# sourceMappingURL=index.js.map

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

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