@metamask/snaps-controllers 4.1.0 → 5.0.0

package/CHANGELOG.md

@@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.0.0]
+### Added
+- Add support for dynamic user interfaces ([#1465](https://github.com/MetaMask/snaps/pull/1465), [#2126](https://github.com/MetaMask/snaps/pull/2126), [#2144](https://github.com/MetaMask/snaps/pull/2144), [#2152](https://github.com/MetaMask/snaps/pull/2152), [#2143](https://github.com/MetaMask/snaps/pull/2143))
+- Add support for Snap defined execution timeouts ([#2098](https://github.com/MetaMask/snaps/pull/2098))
+  - A Snap can now define `maxRequestTime` to extend or shorten its execution timeout.
+- Add `WebViewExecutionService` for mobile execution ([#2005](https://github.com/MetaMask/snaps/pull/2005))
+
+### Changed
+- Loosen allowlist requirements ([#1672](https://github.com/MetaMask/snaps/pull/1672))
+  - Snaps with certain permissions can now be installed without being allowlisted.
+- Reintroduce `DecompressionStream` for improved installation performance ([#2110](https://github.com/MetaMask/snaps/pull/2110))
+- Bump `tar-stream` ([#2116](https://github.com/MetaMask/snaps/pull/2116))
+  - This fixes a problem where Snaps would sometimes fail to download from NPM.
+- Bump several MetaMask dependencies ([#2129](https://github.com/MetaMask/snaps/pull/2129), [#2132](https://github.com/MetaMask/snaps/pull/2132), [#2130](https://github.com/MetaMask/snaps/pull/2130), [#2139](https://github.com/MetaMask/snaps/pull/2139), [#2142](https://github.com/MetaMask/snaps/pull/2142))
+- Pass localized snap name to SubjectMetadataController ([#2157](https://github.com/MetaMask/snaps/pull/2157))
+
+### Removed
+- **BREAKING:** Remove endowment permission specifications from this package ([#2155](https://github.com/MetaMask/snaps/pull/2155))
+  - They can now be found in `snaps-rpc-methods`.
+
 ## [4.1.0]
 ### Added
 - Add support for signature insights ([#2074](https://github.com/MetaMask/snaps/pull/2074))
@@ -168,7 +188,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@4.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@5.0.0...HEAD
+[5.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@4.1.0...@metamask/snaps-controllers@5.0.0
 [4.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@4.0.0...@metamask/snaps-controllers@4.1.0
 [4.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.6.0...@metamask/snaps-controllers@4.0.0
 [3.6.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-controllers@3.5.1...@metamask/snaps-controllers@3.6.0

package/dist/cjs/cronjob/CronjobController.js

@@ -17,10 +17,10 @@ _export(exports, {
     }
 });
 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 _cronjob = require("../snaps/endowments/cronjob");
 const _Timer = require("../snaps/Timer");
 function _check_private_redeclaration(obj, privateCollection) {
     if (privateCollection.has(obj)) {
@@ -85,8 +85,8 @@ class CronjobController extends _basecontroller.BaseController {
    * @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 = (0, _cronjob.getCronjobCaveatJobs)(permission);
+        const permission = permissions?.[_snapsrpcmethods.SnapEndowments.Cronjob];
+        const definitions = (0, _snapsrpcmethods.getCronjobCaveatJobs)(permission);
         return definitions?.map((definition, idx)=>{
             return {
                 ...definition,

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

@@ -1 +1 @@
-{"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 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, 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  | 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":";;;;;;;;;;;IAgDaA,aAAa;eAAbA;;IA8BAC,iBAAiB;eAAjBA;;;gCA7EkB;4BAWxB;uBACkC;kBAWQ;yBACZ;uBACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,gBAAc,CAACC,OAAO,CAAC;QACxD,MAAMC,cAAcC,IAAAA,6BAAoB,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"}
+{"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/index.js

@@ -6,6 +6,7 @@ _export_star(require("./services"), exports);
 _export_star(require("./snaps"), exports);
 _export_star(require("./utils"), exports);
 _export_star(require("./cronjob"), exports);
+_export_star(require("./interface"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/dist/cjs/index.js.map

@@ -1 +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":";;;;qBACc;qBACA;qBACA;qBACA"}
+{"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';\nexport * from './interface';\n"],"names":[],"mappings":";;;;qBACc;qBACA;qBACA;qBACA;qBACA"}

package/dist/cjs/interface/SnapInterfaceController.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "SnapInterfaceController", {
+    enumerable: true,
+    get: function() {
+        return SnapInterfaceController;
+    }
+});
+const _basecontroller = require("@metamask/base-controller");
+const _snapsutils = require("@metamask/snaps-utils");
+const _utils = require("@metamask/utils");
+const _nanoid = require("nanoid");
+const _utils1 = require("./utils");
+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_private_method_get(receiver, privateSet, fn) {
+    if (!privateSet.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return fn;
+}
+function _class_private_method_init(obj, privateSet) {
+    _check_private_redeclaration(obj, privateSet);
+    privateSet.add(obj);
+}
+const controllerName = 'SnapInterfaceController';
+var /**
+   * Constructor helper for registering this controller's messaging system
+   * actions.
+   */ _registerMessageHandlers = /*#__PURE__*/ new WeakSet(), /**
+   * Utility function to validate the args passed to the other methods.
+   *
+   * @param snapId - The snap id.
+   * @param id - The interface id.
+   */ _validateArgs = /*#__PURE__*/ new WeakSet(), _triggerPhishingListUpdate = /*#__PURE__*/ new WeakSet(), /**
+   * Check an origin against the phishing list.
+   *
+   * @param origin - The origin to check.
+   * @returns True if the origin is on the phishing list, otherwise false.
+   */ _checkPhishingList = /*#__PURE__*/ new WeakSet(), _validateContent = /*#__PURE__*/ new WeakSet();
+class SnapInterfaceController extends _basecontroller.BaseController {
+    /**
+   * Create an interface in the controller state with the associated data.
+   *
+   * @param snapId - The snap id that created the interface.
+   * @param content - The interface content.
+   * @returns The newly interface id.
+   */ async createInterface(snapId, content) {
+        await _class_private_method_get(this, _validateContent, validateContent).call(this, content);
+        const id = (0, _nanoid.nanoid)();
+        const componentState = (0, _utils1.constructState)({}, content);
+        this.update((draftState)=>{
+            draftState.interfaces[id] = {
+                snapId,
+                content,
+                state: componentState
+            };
+        });
+        return id;
+    }
+    /**
+   * Get the data of a given interface id.
+   *
+   * @param snapId - The snap id requesting the interface data.
+   * @param id - The interface id.
+   * @returns The interface state.
+   */ getInterface(snapId, id) {
+        _class_private_method_get(this, _validateArgs, validateArgs).call(this, snapId, id);
+        return this.state.interfaces[id];
+    }
+    /**
+   * Update the interface with the given content.
+   *
+   * @param snapId - The snap id requesting the update.
+   * @param id - The interface id.
+   * @param content - The new content.
+   */ async updateInterface(snapId, id, content) {
+        _class_private_method_get(this, _validateArgs, validateArgs).call(this, snapId, id);
+        await _class_private_method_get(this, _validateContent, validateContent).call(this, content);
+        const oldState = this.state.interfaces[id].state;
+        const newState = (0, _utils1.constructState)(oldState, content);
+        this.update((draftState)=>{
+            draftState.interfaces[id].state = newState;
+            draftState.interfaces[id].content = content;
+        });
+    }
+    /**
+   * Delete an interface from state.
+   *
+   * @param id - The interface id.
+   */ deleteInterface(id) {
+        this.update((draftState)=>{
+            delete draftState.interfaces[id];
+        });
+    }
+    /**
+   * Update the interface state.
+   *
+   * @param id - The interface id.
+   * @param state - The new state.
+   */ updateInterfaceState(id, state) {
+        this.update((draftState)=>{
+            draftState.interfaces[id].state = state;
+        });
+    }
+    constructor({ messenger, state }){
+        super({
+            messenger,
+            metadata: {
+                interfaces: {
+                    persist: false,
+                    anonymous: false
+                }
+            },
+            name: controllerName,
+            state: {
+                interfaces: {},
+                ...state
+            }
+        });
+        _class_private_method_init(this, _registerMessageHandlers);
+        _class_private_method_init(this, _validateArgs);
+        /**
+   * Trigger a Phishing list update if needed.
+   */ _class_private_method_init(this, _triggerPhishingListUpdate);
+        _class_private_method_init(this, _checkPhishingList);
+        /**
+   * Utility function to validate the components of an interface.
+   * Throws if something is invalid.
+   *
+   * Right now this only checks links against the phighing list.
+   *
+   * @param content - The components to verify.
+   */ _class_private_method_init(this, _validateContent);
+        _class_private_method_get(this, _registerMessageHandlers, registerMessageHandlers).call(this);
+    }
+}
+function registerMessageHandlers() {
+    this.messagingSystem.registerActionHandler(`${controllerName}:createInterface`, this.createInterface.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:getInterface`, this.getInterface.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:updateInterface`, this.updateInterface.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:deleteInterface`, this.deleteInterface.bind(this));
+    this.messagingSystem.registerActionHandler(`${controllerName}:updateInterfaceState`, this.updateInterfaceState.bind(this));
+}
+function validateArgs(snapId, id) {
+    const existingInterface = this.state.interfaces[id];
+    (0, _utils.assert)(existingInterface !== undefined, `Interface with id '${id}' not found.`);
+    (0, _utils.assert)(existingInterface.snapId === snapId, `Interface not created by ${snapId}.`);
+}
+async function triggerPhishingListUpdate() {
+    await this.messagingSystem.call('PhishingController:maybeUpdateState');
+}
+function checkPhishingList(origin) {
+    return this.messagingSystem.call('PhishingController:testOrigin', origin).result;
+}
+async function validateContent(content) {
+    await _class_private_method_get(this, _triggerPhishingListUpdate, triggerPhishingListUpdate).call(this);
+    (0, _snapsutils.validateComponentLinks)(content, _class_private_method_get(this, _checkPhishingList, checkPhishingList).bind(this));
+}
+
+//# sourceMappingURL=SnapInterfaceController.js.map

package/dist/cjs/interface/SnapInterfaceController.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/interface/SnapInterfaceController.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n  MaybeUpdateState,\n  TestOrigin,\n} from '@metamask/phishing-controller';\nimport type { Component, InterfaceState, SnapId } from '@metamask/snaps-sdk';\nimport { validateComponentLinks } from '@metamask/snaps-utils';\nimport { assert } from '@metamask/utils';\nimport { nanoid } from 'nanoid';\n\nimport { constructState } from './utils';\n\nconst controllerName = 'SnapInterfaceController';\n\nexport type CreateInterface = {\n  type: `${typeof controllerName}:createInterface`;\n  handler: SnapInterfaceController['createInterface'];\n};\n\nexport type GetInterface = {\n  type: `${typeof controllerName}:getInterface`;\n  handler: SnapInterfaceController['getInterface'];\n};\n\nexport type UpdateInterface = {\n  type: `${typeof controllerName}:updateInterface`;\n  handler: SnapInterfaceController['updateInterface'];\n};\n\nexport type DeleteInterface = {\n  type: `${typeof controllerName}:deleteInterface`;\n  handler: SnapInterfaceController['deleteInterface'];\n};\n\nexport type UpdateInterfaceState = {\n  type: `${typeof controllerName}:updateInterfaceState`;\n  handler: SnapInterfaceController['updateInterfaceState'];\n};\n\nexport type SnapInterfaceControllerAllowedActions =\n  | TestOrigin\n  | MaybeUpdateState;\n\nexport type SnapInterfaceControllerActions =\n  | CreateInterface\n  | GetInterface\n  | UpdateInterface\n  | DeleteInterface\n  | UpdateInterfaceState;\n\nexport type SnapInterfaceControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  SnapInterfaceControllerActions | SnapInterfaceControllerAllowedActions,\n  never,\n  SnapInterfaceControllerAllowedActions['type'],\n  never\n>;\n\nexport type StoredInterface = {\n  snapId: SnapId;\n  content: Component;\n  state: InterfaceState;\n};\n\nexport type SnapInterfaceControllerState = {\n  interfaces: Record<string, StoredInterface>;\n};\n\nexport type SnapInterfaceControllerArgs = {\n  messenger: SnapInterfaceControllerMessenger;\n  state?: SnapInterfaceControllerState;\n};\n\n/**\n * Use this controller to manage snaps UI interfaces using RPC method hooks.\n */\nexport class SnapInterfaceController extends BaseController<\n  typeof controllerName,\n  SnapInterfaceControllerState,\n  SnapInterfaceControllerMessenger\n> {\n  constructor({ messenger, state }: SnapInterfaceControllerArgs) {\n    super({\n      messenger,\n      metadata: {\n        interfaces: { persist: false, anonymous: false },\n      },\n      name: controllerName,\n      state: { interfaces: {}, ...state },\n    });\n\n    this.#registerMessageHandlers();\n  }\n\n  /**\n   * Constructor helper for registering this controller's messaging system\n   * actions.\n   */\n  #registerMessageHandlers() {\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:createInterface`,\n      this.createInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:getInterface`,\n      this.getInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:updateInterface`,\n      this.updateInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:deleteInterface`,\n      this.deleteInterface.bind(this),\n    );\n\n    this.messagingSystem.registerActionHandler(\n      `${controllerName}:updateInterfaceState`,\n      this.updateInterfaceState.bind(this),\n    );\n  }\n\n  /**\n   * Create an interface in the controller state with the associated data.\n   *\n   * @param snapId - The snap id that created the interface.\n   * @param content - The interface content.\n   * @returns The newly interface id.\n   */\n  async createInterface(snapId: SnapId, content: Component) {\n    await this.#validateContent(content);\n\n    const id = nanoid();\n\n    const componentState = constructState({}, content);\n\n    this.update((draftState) => {\n      draftState.interfaces[id] = {\n        snapId,\n        content,\n        state: componentState,\n      };\n    });\n\n    return id;\n  }\n\n  /**\n   * Get the data of a given interface id.\n   *\n   * @param snapId - The snap id requesting the interface data.\n   * @param id - The interface id.\n   * @returns The interface state.\n   */\n  getInterface(snapId: SnapId, id: string) {\n    this.#validateArgs(snapId, id);\n\n    return this.state.interfaces[id];\n  }\n\n  /**\n   * Update the interface with the given content.\n   *\n   * @param snapId - The snap id requesting the update.\n   * @param id - The interface id.\n   * @param content - The new content.\n   */\n  async updateInterface(snapId: SnapId, id: string, content: Component) {\n    this.#validateArgs(snapId, id);\n    await this.#validateContent(content);\n\n    const oldState = this.state.interfaces[id].state;\n\n    const newState = constructState(oldState, content);\n\n    this.update((draftState) => {\n      draftState.interfaces[id].state = newState;\n      draftState.interfaces[id].content = content;\n    });\n  }\n\n  /**\n   * Delete an interface from state.\n   *\n   * @param id - The interface id.\n   */\n  deleteInterface(id: string) {\n    this.update((draftState) => {\n      delete draftState.interfaces[id];\n    });\n  }\n\n  /**\n   * Update the interface state.\n   *\n   * @param id - The interface id.\n   * @param state - The new state.\n   */\n  updateInterfaceState(id: string, state: InterfaceState) {\n    this.update((draftState) => {\n      draftState.interfaces[id].state = state;\n    });\n  }\n\n  /**\n   * Utility function to validate the args passed to the other methods.\n   *\n   * @param snapId - The snap id.\n   * @param id - The interface id.\n   */\n  #validateArgs(snapId: SnapId, id: string) {\n    const existingInterface = this.state.interfaces[id];\n\n    assert(\n      existingInterface !== undefined,\n      `Interface with id '${id}' not found.`,\n    );\n    assert(\n      existingInterface.snapId === snapId,\n      `Interface not created by ${snapId}.`,\n    );\n  }\n\n  /**\n   * Trigger a Phishing list update if needed.\n   */\n  async #triggerPhishingListUpdate() {\n    await this.messagingSystem.call('PhishingController:maybeUpdateState');\n  }\n\n  /**\n   * Check an origin against the phishing list.\n   *\n   * @param origin - The origin to check.\n   * @returns True if the origin is on the phishing list, otherwise false.\n   */\n  #checkPhishingList(origin: string) {\n    return this.messagingSystem.call('PhishingController:testOrigin', origin)\n      .result;\n  }\n\n  /**\n   * Utility function to validate the components of an interface.\n   * Throws if something is invalid.\n   *\n   * Right now this only checks links against the phighing list.\n   *\n   * @param content - The components to verify.\n   */\n  async #validateContent(content: Component) {\n    await this.#triggerPhishingListUpdate();\n\n    validateComponentLinks(content, this.#checkPhishingList.bind(this));\n  }\n}\n"],"names":["SnapInterfaceController","controllerName","BaseController","createInterface","snapId","content","validateContent","id","nanoid","componentState","constructState","update","draftState","interfaces","state","getInterface","validateArgs","updateInterface","oldState","newState","deleteInterface","updateInterfaceState","constructor","messenger","metadata","persist","anonymous","name","registerMessageHandlers","messagingSystem","registerActionHandler","bind","existingInterface","assert","undefined","call","origin","result","triggerPhishingListUpdate","validateComponentLinks","checkPhishingList"],"mappings":";;;;+BA6EaA;;;eAAAA;;;gCA5EkB;4BAMQ;uBAChB;wBACA;wBAEQ;;;;;;;;;;;;;;;;AAE/B,MAAMC,iBAAiB;IAkFrB;;;GAGC,GACD,wDA6GA;;;;;GAKC,GACD,6CAgBM,0DAIN;;;;;GAKC,GACD,kDAaM;AAhLD,MAAMD,gCAAgCE,8BAAc;IAiDzD;;;;;;GAMC,GACD,MAAMC,gBAAgBC,MAAc,EAAEC,OAAkB,EAAE;QACxD,MAAM,0BAAA,IAAI,EAAEC,kBAAAA,sBAAN,IAAI,EAAkBD;QAE5B,MAAME,KAAKC,IAAAA,cAAM;QAEjB,MAAMC,iBAAiBC,IAAAA,sBAAc,EAAC,CAAC,GAAGL;QAE1C,IAAI,CAACM,MAAM,CAAC,CAACC;YACXA,WAAWC,UAAU,CAACN,GAAG,GAAG;gBAC1BH;gBACAC;gBACAS,OAAOL;YACT;QACF;QAEA,OAAOF;IACT;IAEA;;;;;;GAMC,GACDQ,aAAaX,MAAc,EAAEG,EAAU,EAAE;QACvC,0BAAA,IAAI,EAAES,eAAAA,mBAAN,IAAI,EAAeZ,QAAQG;QAE3B,OAAO,IAAI,CAACO,KAAK,CAACD,UAAU,CAACN,GAAG;IAClC;IAEA;;;;;;GAMC,GACD,MAAMU,gBAAgBb,MAAc,EAAEG,EAAU,EAAEF,OAAkB,EAAE;QACpE,0BAAA,IAAI,EAAEW,eAAAA,mBAAN,IAAI,EAAeZ,QAAQG;QAC3B,MAAM,0BAAA,IAAI,EAAED,kBAAAA,sBAAN,IAAI,EAAkBD;QAE5B,MAAMa,WAAW,IAAI,CAACJ,KAAK,CAACD,UAAU,CAACN,GAAG,CAACO,KAAK;QAEhD,MAAMK,WAAWT,IAAAA,sBAAc,EAACQ,UAAUb;QAE1C,IAAI,CAACM,MAAM,CAAC,CAACC;YACXA,WAAWC,UAAU,CAACN,GAAG,CAACO,KAAK,GAAGK;YAClCP,WAAWC,UAAU,CAACN,GAAG,CAACF,OAAO,GAAGA;QACtC;IACF;IAEA;;;;GAIC,GACDe,gBAAgBb,EAAU,EAAE;QAC1B,IAAI,CAACI,MAAM,CAAC,CAACC;YACX,OAAOA,WAAWC,UAAU,CAACN,GAAG;QAClC;IACF;IAEA;;;;;GAKC,GACDc,qBAAqBd,EAAU,EAAEO,KAAqB,EAAE;QACtD,IAAI,CAACH,MAAM,CAAC,CAACC;YACXA,WAAWC,UAAU,CAACN,GAAG,CAACO,KAAK,GAAGA;QACpC;IACF;IA5HAQ,YAAY,EAAEC,SAAS,EAAET,KAAK,EAA+B,CAAE;QAC7D,KAAK,CAAC;YACJS;YACAC,UAAU;gBACRX,YAAY;oBAAEY,SAAS;oBAAOC,WAAW;gBAAM;YACjD;YACAC,MAAM1B;YACNa,OAAO;gBAAED,YAAY,CAAC;gBAAG,GAAGC,KAAK;YAAC;QACpC;QASF,iCAAA;QAmHA,iCAAA;QAaA;;GAEC,GACD,iCAAM;QAUN,iCAAA;QAKA;;;;;;;GAOC,GACD,iCAAM;QAjKJ,0BAAA,IAAI,EAAEc,0BAAAA,8BAAN,IAAI;IACN;AAqKF;AA/JE,SAAA;IACE,IAAI,CAACC,eAAe,CAACC,qBAAqB,CACxC,CAAC,EAAE7B,eAAe,gBAAgB,CAAC,EACnC,IAAI,CAACE,eAAe,CAAC4B,IAAI,CAAC,IAAI;IAGhC,IAAI,CAACF,eAAe,CAACC,qBAAqB,CACxC,CAAC,EAAE7B,eAAe,aAAa,CAAC,EAChC,IAAI,CAACc,YAAY,CAACgB,IAAI,CAAC,IAAI;IAG7B,IAAI,CAACF,eAAe,CAACC,qBAAqB,CACxC,CAAC,EAAE7B,eAAe,gBAAgB,CAAC,EACnC,IAAI,CAACgB,eAAe,CAACc,IAAI,CAAC,IAAI;IAGhC,IAAI,CAACF,eAAe,CAACC,qBAAqB,CACxC,CAAC,EAAE7B,eAAe,gBAAgB,CAAC,EACnC,IAAI,CAACmB,eAAe,CAACW,IAAI,CAAC,IAAI;IAGhC,IAAI,CAACF,eAAe,CAACC,qBAAqB,CACxC,CAAC,EAAE7B,eAAe,qBAAqB,CAAC,EACxC,IAAI,CAACoB,oBAAoB,CAACU,IAAI,CAAC,IAAI;AAEvC;AA0FA,SAAA,aAAc3B,MAAc,EAAEG,EAAU;IACtC,MAAMyB,oBAAoB,IAAI,CAAClB,KAAK,CAACD,UAAU,CAACN,GAAG;IAEnD0B,IAAAA,aAAM,EACJD,sBAAsBE,WACtB,CAAC,mBAAmB,EAAE3B,GAAG,YAAY,CAAC;IAExC0B,IAAAA,aAAM,EACJD,kBAAkB5B,MAAM,KAAKA,QAC7B,CAAC,yBAAyB,EAAEA,OAAO,CAAC,CAAC;AAEzC;AAKA,eAAA;IACE,MAAM,IAAI,CAACyB,eAAe,CAACM,IAAI,CAAC;AAClC;AAQA,SAAA,kBAAmBC,MAAc;IAC/B,OAAO,IAAI,CAACP,eAAe,CAACM,IAAI,CAAC,iCAAiCC,QAC/DC,MAAM;AACX;AAUA,eAAA,gBAAuBhC,OAAkB;IACvC,MAAM,0BAAA,IAAI,EAAEiC,4BAAAA,gCAAN,IAAI;IAEVC,IAAAA,kCAAsB,EAAClC,SAAS,0BAAA,IAAI,EAAEmC,oBAAAA,mBAAkBT,IAAI,CAAC,IAAI;AACnE"}

package/dist/cjs/interface/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./SnapInterfaceController"), 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/interface/index.js.map

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

package/dist/cjs/interface/utils.js

@@ -0,0 +1,59 @@
+"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, {
+    constructInputState: function() {
+        return constructInputState;
+    },
+    constructFormInputState: function() {
+        return constructFormInputState;
+    },
+    assertNameIsUnique: function() {
+        return assertNameIsUnique;
+    },
+    constructState: function() {
+        return constructState;
+    }
+});
+const _snapssdk = require("@metamask/snaps-sdk");
+const constructInputState = (state, component)=>{
+    return component.value ?? state[component.name] ?? null;
+};
+const constructFormInputState = (state, component, form)=>{
+    const oldFormState = state[form];
+    const oldInputState = oldFormState?.[component.name];
+    return component.value ?? oldInputState ?? null;
+};
+const assertNameIsUnique = (state, name)=>{
+    (0, _snapssdk.assert)(state[name] === undefined, `Duplicate component names are not allowed, found multiple instances of: "${name}".`);
+};
+const constructState = (oldState, component, newState = {})=>{
+    const { type } = component;
+    if (type === _snapssdk.NodeType.Panel) {
+        return component.children.reduce((acc, node)=>constructState(oldState, node, acc), newState);
+    }
+    if (type === _snapssdk.NodeType.Form) {
+        assertNameIsUnique(newState, component.name);
+        newState[component.name] = component.children.reduce((acc, node)=>{
+            if (node.type === _snapssdk.NodeType.Input) {
+                assertNameIsUnique(acc, node.name);
+                acc[node.name] = constructFormInputState(oldState, node, component.name);
+            }
+            return acc;
+        }, {});
+    }
+    if (type === _snapssdk.NodeType.Input) {
+        assertNameIsUnique(newState, component.name);
+        newState[component.name] = constructInputState(oldState, component);
+    }
+    return newState;
+};
+
+//# sourceMappingURL=utils.js.map

package/dist/cjs/interface/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/interface/utils.ts"],"sourcesContent":["import { NodeType, assert } from '@metamask/snaps-sdk';\nimport type {\n  Component,\n  Input,\n  FormState,\n  InterfaceState,\n} from '@metamask/snaps-sdk';\n\n/**\n * Construct the state for a stray input (not enclosed in a form).\n *\n * @param state - The interface state.\n * @param component - The Input component.\n * @returns The input state.\n */\nexport const constructInputState = (\n  state: InterfaceState,\n  component: Input,\n) => {\n  return component.value ?? state[component.name] ?? null;\n};\n\n/**\n * Construct the state for a form input.\n *\n * Sets the state to either the specified component value, the previous value from the old state or null.\n *\n * @param state - The interface state.\n * @param component - The Input component.\n * @param form - The parent form name of the input.\n * @returns The input state.\n */\nexport const constructFormInputState = (\n  state: InterfaceState,\n  component: Input,\n  form: string,\n) => {\n  const oldFormState = state[form] as FormState;\n  const oldInputState = oldFormState?.[component.name];\n  return component.value ?? oldInputState ?? null;\n};\n\n/**\n * Assert that the component name is unique in state.\n *\n * @param state - The interface state to verify against.\n * @param name - The component name to verify.\n */\nexport const assertNameIsUnique = (state: InterfaceState, name: string) => {\n  assert(\n    state[name] === undefined,\n    `Duplicate component names are not allowed, found multiple instances of: \"${name}\".`,\n  );\n};\n\n/**\n * Construct the interface state for a given component tree while preserving values for matching stateful components in the old state.\n *\n * @param oldState - The previous state.\n * @param component - The UI component to construct state from.\n * @param newState - The state that is being constructed.\n * @returns The interface state of the passed component.\n */\nexport const constructState = (\n  oldState: InterfaceState,\n  component: Component,\n  newState: InterfaceState = {},\n): InterfaceState => {\n  const { type } = component;\n  if (type === NodeType.Panel) {\n    return component.children.reduce(\n      (acc, node) => constructState(oldState, node, acc),\n      newState,\n    );\n  }\n\n  if (type === NodeType.Form) {\n    assertNameIsUnique(newState, component.name);\n    newState[component.name] = component.children.reduce<FormState>(\n      (acc, node) => {\n        if (node.type === NodeType.Input) {\n          assertNameIsUnique(acc, node.name);\n          acc[node.name] = constructFormInputState(\n            oldState,\n            node,\n            component.name,\n          );\n        }\n\n        return acc;\n      },\n      {},\n    );\n  }\n\n  if (type === NodeType.Input) {\n    assertNameIsUnique(newState, component.name);\n    newState[component.name] = constructInputState(oldState, component);\n  }\n\n  return newState;\n};\n"],"names":["constructInputState","constructFormInputState","assertNameIsUnique","constructState","state","component","value","name","form","oldFormState","oldInputState","assert","undefined","oldState","newState","type","NodeType","Panel","children","reduce","acc","node","Form","Input"],"mappings":";;;;;;;;;;;IAeaA,mBAAmB;eAAnBA;;IAiBAC,uBAAuB;eAAvBA;;IAgBAC,kBAAkB;eAAlBA;;IAeAC,cAAc;eAAdA;;;0BA/DoB;AAe1B,MAAMH,sBAAsB,CACjCI,OACAC;IAEA,OAAOA,UAAUC,KAAK,IAAIF,KAAK,CAACC,UAAUE,IAAI,CAAC,IAAI;AACrD;AAYO,MAAMN,0BAA0B,CACrCG,OACAC,WACAG;IAEA,MAAMC,eAAeL,KAAK,CAACI,KAAK;IAChC,MAAME,gBAAgBD,cAAc,CAACJ,UAAUE,IAAI,CAAC;IACpD,OAAOF,UAAUC,KAAK,IAAII,iBAAiB;AAC7C;AAQO,MAAMR,qBAAqB,CAACE,OAAuBG;IACxDI,IAAAA,gBAAM,EACJP,KAAK,CAACG,KAAK,KAAKK,WAChB,CAAC,yEAAyE,EAAEL,KAAK,EAAE,CAAC;AAExF;AAUO,MAAMJ,iBAAiB,CAC5BU,UACAR,WACAS,WAA2B,CAAC,CAAC;IAE7B,MAAM,EAAEC,IAAI,EAAE,GAAGV;IACjB,IAAIU,SAASC,kBAAQ,CAACC,KAAK,EAAE;QAC3B,OAAOZ,UAAUa,QAAQ,CAACC,MAAM,CAC9B,CAACC,KAAKC,OAASlB,eAAeU,UAAUQ,MAAMD,MAC9CN;IAEJ;IAEA,IAAIC,SAASC,kBAAQ,CAACM,IAAI,EAAE;QAC1BpB,mBAAmBY,UAAUT,UAAUE,IAAI;QAC3CO,QAAQ,CAACT,UAAUE,IAAI,CAAC,GAAGF,UAAUa,QAAQ,CAACC,MAAM,CAClD,CAACC,KAAKC;YACJ,IAAIA,KAAKN,IAAI,KAAKC,kBAAQ,CAACO,KAAK,EAAE;gBAChCrB,mBAAmBkB,KAAKC,KAAKd,IAAI;gBACjCa,GAAG,CAACC,KAAKd,IAAI,CAAC,GAAGN,wBACfY,UACAQ,MACAhB,UAAUE,IAAI;YAElB;YAEA,OAAOa;QACT,GACA,CAAC;IAEL;IAEA,IAAIL,SAASC,kBAAQ,CAACO,KAAK,EAAE;QAC3BrB,mBAAmBY,UAAUT,UAAUE,IAAI;QAC3CO,QAAQ,CAACT,UAAUE,IAAI,CAAC,GAAGP,oBAAoBa,UAAUR;IAC3D;IAEA,OAAOS;AACT"}

package/dist/cjs/services/browser.js

@@ -14,6 +14,7 @@ _export_star(require("./ExecutionService"), exports);
 _export_star(require("./ProxyPostMessageStream"), exports);
 _export_star(require("./iframe"), exports);
 _export_star(require("./offscreen"), exports);
+_export_star(require("./webview"), exports);
 const _webworker = require("./webworker");
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {

package/dist/cjs/services/browser.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/browser.ts"],"sourcesContent":["// Subset of exports meant for browser environments, omits Node.js services\nexport * from './AbstractExecutionService';\nexport * from './ExecutionService';\nexport * from './ProxyPostMessageStream';\nexport * from './iframe';\nexport * from './offscreen';\nexport { WebWorkerExecutionService } from './webworker';\n"],"names":["WebWorkerExecutionService"],"mappings":"AAAA,2EAA2E;;;;;+BAMlEA;;;eAAAA,oCAAyB;;;qBALpB;qBACA;qBACA;qBACA;qBACA;2BAC4B"}
+{"version":3,"sources":["../../../src/services/browser.ts"],"sourcesContent":["// Subset of exports meant for browser environments, omits Node.js services\nexport * from './AbstractExecutionService';\nexport * from './ExecutionService';\nexport * from './ProxyPostMessageStream';\nexport * from './iframe';\nexport * from './offscreen';\nexport * from './webview';\nexport { WebWorkerExecutionService } from './webworker';\n"],"names":["WebWorkerExecutionService"],"mappings":"AAAA,2EAA2E;;;;;+BAOlEA;;;eAAAA,oCAAyB;;;qBANpB;qBACA;qBACA;qBACA;qBACA;qBACA;2BAC4B"}

package/dist/cjs/services/index.js

@@ -14,6 +14,7 @@ _export_star(require("./ProxyPostMessageStream"), exports);
 _export_star(require("./iframe"), exports);
 _export_star(require("./node"), exports);
 _export_star(require("./offscreen"), exports);
+_export_star(require("./webview"), exports);
 const _webworker = require("./webworker");
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/services/index.ts"],"sourcesContent":["export * from './AbstractExecutionService';\nexport * from './ExecutionService';\nexport * from './ProxyPostMessageStream';\nexport * from './iframe';\nexport * from './node';\nexport * from './offscreen';\nexport { WebWorkerExecutionService } from './webworker';\n"],"names":["WebWorkerExecutionService"],"mappings":";;;;+BAMSA;;;eAAAA,oCAAyB;;;qBANpB;qBACA;qBACA;qBACA;qBACA;qBACA;2BAC4B"}
+{"version":3,"sources":["../../../src/services/index.ts"],"sourcesContent":["export * from './AbstractExecutionService';\nexport * from './ExecutionService';\nexport * from './ProxyPostMessageStream';\nexport * from './iframe';\nexport * from './node';\nexport * from './offscreen';\nexport * from './webview';\nexport { WebWorkerExecutionService } from './webworker';\n"],"names":["WebWorkerExecutionService"],"mappings":";;;;+BAOSA;;;eAAAA,oCAAyB;;;qBAPpB;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;2BAC4B"}

package/dist/cjs/services/webview/WebViewExecutionService.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "WebViewExecutionService", {
+    enumerable: true,
+    get: function() {
+        return WebViewExecutionService;
+    }
+});
+const _ProxyExecutionService = require("../proxy/ProxyExecutionService");
+const _WebViewMessageStream = require("./WebViewMessageStream");
+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;
+}
+function _class_private_method_get(receiver, privateSet, fn) {
+    if (!privateSet.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return fn;
+}
+function _class_private_method_init(obj, privateSet) {
+    _check_private_redeclaration(obj, privateSet);
+    privateSet.add(obj);
+}
+var _getWebView = /*#__PURE__*/ new WeakMap(), _ensureWebViewLoaded = /*#__PURE__*/ new WeakSet();
+class WebViewExecutionService extends _ProxyExecutionService.ProxyExecutionService {
+    /**
+   * Create a new stream for the specified job. This wraps the runtime stream
+   * in a stream specific to the job.
+   *
+   * @param jobId - The job ID.
+   */ async initEnvStream(jobId) {
+        // Ensure that the WebView has been loaded before we proceed.
+        await _class_private_method_get(this, _ensureWebViewLoaded, ensureWebViewLoaded).call(this);
+        return super.initEnvStream(jobId);
+    }
+    constructor({ messenger, setupSnapProvider, getWebView }){
+        super({
+            messenger,
+            setupSnapProvider,
+            stream: new _WebViewMessageStream.WebViewMessageStream({
+                name: 'parent',
+                target: 'child',
+                getWebView
+            })
+        });
+        /**
+   * Ensure that the WebView has been loaded by awaiting the getWebView promise.
+   */ _class_private_method_init(this, _ensureWebViewLoaded);
+        _class_private_field_init(this, _getWebView, {
+            writable: true,
+            value: void 0
+        });
+        _class_private_field_set(this, _getWebView, getWebView);
+    }
+}
+async function ensureWebViewLoaded() {
+    await _class_private_field_get(this, _getWebView).call(this);
+}
+
+//# sourceMappingURL=WebViewExecutionService.js.map

package/dist/cjs/services/webview/WebViewExecutionService.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/services/webview/WebViewExecutionService.ts"],"sourcesContent":["import type { ExecutionServiceArgs } from '../AbstractExecutionService';\nimport { ProxyExecutionService } from '../proxy/ProxyExecutionService';\nimport type { WebViewInterface } from './WebViewMessageStream';\nimport { WebViewMessageStream } from './WebViewMessageStream';\n\nexport type WebViewExecutionServiceArgs = ExecutionServiceArgs & {\n  getWebView: () => Promise<WebViewInterface>;\n};\n\nexport class WebViewExecutionService extends ProxyExecutionService {\n  #getWebView;\n\n  constructor({\n    messenger,\n    setupSnapProvider,\n    getWebView,\n  }: WebViewExecutionServiceArgs) {\n    super({\n      messenger,\n      setupSnapProvider,\n      stream: new WebViewMessageStream({\n        name: 'parent',\n        target: 'child',\n        getWebView,\n      }),\n    });\n    this.#getWebView = getWebView;\n  }\n\n  /**\n   * Create a new stream for the specified job. This wraps the runtime stream\n   * in a stream specific to the job.\n   *\n   * @param jobId - The job ID.\n   */\n  protected async initEnvStream(jobId: string) {\n    // Ensure that the WebView has been loaded before we proceed.\n    await this.#ensureWebViewLoaded();\n\n    return super.initEnvStream(jobId);\n  }\n\n  /**\n   * Ensure that the WebView has been loaded by awaiting the getWebView promise.\n   */\n  async #ensureWebViewLoaded() {\n    await this.#getWebView();\n  }\n}\n"],"names":["WebViewExecutionService","ProxyExecutionService","initEnvStream","jobId","ensureWebViewLoaded","constructor","messenger","setupSnapProvider","getWebView","stream","WebViewMessageStream","name","target"],"mappings":";;;;+BASaA;;;eAAAA;;;uCARyB;sCAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAOnC,2CAmCM;AApCD,MAAMA,gCAAgCC,4CAAqB;IAoBhE;;;;;GAKC,GACD,MAAgBC,cAAcC,KAAa,EAAE;QAC3C,6DAA6D;QAC7D,MAAM,0BAAA,IAAI,EAAEC,sBAAAA,0BAAN,IAAI;QAEV,OAAO,KAAK,CAACF,cAAcC;IAC7B;IA5BAE,YAAY,EACVC,SAAS,EACTC,iBAAiB,EACjBC,UAAU,EACkB,CAAE;QAC9B,KAAK,CAAC;YACJF;YACAC;YACAE,QAAQ,IAAIC,0CAAoB,CAAC;gBAC/BC,MAAM;gBACNC,QAAQ;gBACRJ;YACF;QACF;QAiBF;;GAEC,GACD,iCAAM;QAnCN,gCAAA;;mBAAA,KAAA;;uCAgBQA,aAAaA;IACrB;AAqBF;AAHE,eAAA;IACE,MAAM,yBAAA,IAAI,EAAEA,kBAAN,IAAI;AACZ"}