@metamask/snaps-controllers 5.0.0 → 6.0.0

package/dist/chunk-5526GKFY.mjs

@@ -0,0 +1,101 @@
+// src/snaps/Timer.ts
+import { assert } from "@metamask/utils";
+var Timer = class {
+  /**
+   * If `ms` is smaller or equal to zero (including -Infinity), the callback is added to the event loop and executed async immediately
+   * If `ms` is +Infinity the timer never finishes.
+   *
+   * @throws {@link TypeError}. If `ms` is NaN or negative.
+   * @param ms - The number of milliseconds before the callback is called after started.
+   */
+  constructor(ms) {
+    assert(
+      !Number.isNaN(ms),
+      new TypeError("Can't start a timer with NaN time")
+    );
+    assert(ms >= 0, new TypeError("Can't start a timer with negative time"));
+    this.state = { value: "stopped", remaining: ms };
+  }
+  get status() {
+    return this.state.value;
+  }
+  /**
+   * Cancels the currently running timer and marks it finished.
+   *
+   * @throws {@link Error}. If it wasn't running or paused.
+   */
+  cancel() {
+    assert(
+      this.status === "paused" || this.status === "running",
+      new Error("Tried to cancel a not running Timer")
+    );
+    this.onFinish(false);
+  }
+  /**
+   * Pauses a currently running timer, allowing it to resume later.
+   *
+   * @throws {@link Error}. If it wasn't running.
+   */
+  pause() {
+    assert(
+      this.state.value === "running",
+      new Error("Tried to pause a not running Timer")
+    );
+    const { callback, start, timeout, remaining } = this.state;
+    timeout !== void 0 && clearTimeout(timeout);
+    this.state = {
+      value: "paused",
+      callback,
+      remaining: remaining - (Date.now() - start)
+    };
+  }
+  /**
+   * Starts the timer.
+   *
+   * @param callback - The function that will be called after the timer finishes.
+   * @throws {@link Error}. If it was already started.
+   */
+  start(callback) {
+    assert(
+      this.state.value === "stopped",
+      new Error("Tried to start an already running Timer")
+    );
+    const { remaining } = this.state;
+    this.state = { value: "paused", remaining, callback };
+    this.resume();
+  }
+  /**
+   * Resumes a currently paused timer.
+   *
+   * @throws {@link Error}. If it wasn't paused.
+   */
+  resume() {
+    assert(
+      this.state.value === "paused",
+      new Error("Tried to resume not paused Timer")
+    );
+    const { remaining, callback } = this.state;
+    const start = Date.now();
+    let timeout;
+    if (remaining !== Number.POSITIVE_INFINITY) {
+      timeout = setTimeout(() => this.onFinish(true), remaining);
+    }
+    this.state = { value: "running", callback, remaining, start, timeout };
+  }
+  onFinish(shouldCall) {
+    assert(this.state.value === "running" || this.state.value === "paused");
+    if (this.state.value === "running" && this.state.timeout !== void 0) {
+      clearTimeout(this.state.timeout);
+    }
+    const { callback } = this.state;
+    this.state = { value: "finished" };
+    if (shouldCall) {
+      callback();
+    }
+  }
+};
+
+export {
+  Timer
+};
+//# sourceMappingURL=chunk-5526GKFY.mjs.map

package/dist/chunk-5526GKFY.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/snaps/Timer.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\n\nexport type TimerStatus = 'stopped' | 'paused' | 'running' | 'finished';\n\nexport class Timer {\n  private state:\n    | { value: 'stopped'; remaining: number }\n    | {\n        value: 'paused';\n        remaining: number;\n        callback: () => void;\n      }\n    | {\n        value: 'running';\n        remaining: number;\n        callback: () => void;\n        start: number;\n        timeout?: unknown;\n      }\n    | { value: 'finished' };\n\n  /**\n   * If `ms` is smaller or equal to zero (including -Infinity), the callback is added to the event loop and executed async immediately\n   * If `ms` is +Infinity the timer never finishes.\n   *\n   * @throws {@link TypeError}. If `ms` is NaN or negative.\n   * @param ms - The number of milliseconds before the callback is called after started.\n   */\n  constructor(ms: number) {\n    assert(\n      !Number.isNaN(ms),\n      new TypeError(\"Can't start a timer with NaN time\"),\n    );\n    assert(ms >= 0, new TypeError(\"Can't start a timer with negative time\"));\n    this.state = { value: 'stopped', remaining: ms };\n  }\n\n  get status(): TimerStatus {\n    return this.state.value;\n  }\n\n  /**\n   * Cancels the currently running timer and marks it finished.\n   *\n   * @throws {@link Error}. If it wasn't running or paused.\n   */\n  cancel() {\n    assert(\n      this.status === 'paused' || this.status === 'running',\n      new Error('Tried to cancel a not running Timer'),\n    );\n    this.onFinish(false);\n  }\n\n  /**\n   * Pauses a currently running timer, allowing it to resume later.\n   *\n   * @throws {@link Error}. If it wasn't running.\n   */\n  pause() {\n    assert(\n      this.state.value === 'running',\n      new Error('Tried to pause a not running Timer'),\n    );\n\n    const { callback, start, timeout, remaining } = this.state;\n\n    timeout !== undefined && clearTimeout(timeout as any);\n    this.state = {\n      value: 'paused',\n      callback,\n      remaining: remaining - (Date.now() - start),\n    };\n  }\n\n  /**\n   * Starts the timer.\n   *\n   * @param callback - The function that will be called after the timer finishes.\n   * @throws {@link Error}. If it was already started.\n   */\n  start(callback: () => void) {\n    assert(\n      this.state.value === 'stopped',\n      new Error('Tried to start an already running Timer'),\n    );\n\n    const { remaining } = this.state;\n    this.state = { value: 'paused', remaining, callback };\n    this.resume();\n  }\n\n  /**\n   * Resumes a currently paused timer.\n   *\n   * @throws {@link Error}. If it wasn't paused.\n   */\n  resume() {\n    assert(\n      this.state.value === 'paused',\n      new Error('Tried to resume not paused Timer'),\n    );\n    const { remaining, callback } = this.state;\n    const start = Date.now();\n\n    let timeout: unknown;\n    // setTimeout returns immediately on +Infinity which we use\n    if (remaining !== Number.POSITIVE_INFINITY) {\n      timeout = setTimeout(() => this.onFinish(true), remaining);\n    }\n\n    this.state = { value: 'running', callback, remaining, start, timeout };\n  }\n\n  private onFinish(shouldCall: boolean) {\n    assert(this.state.value === 'running' || this.state.value === 'paused');\n\n    if (this.state.value === 'running' && this.state.timeout !== undefined) {\n      clearTimeout(this.state.timeout as any);\n    }\n\n    const { callback } = this.state;\n    this.state = { value: 'finished' };\n\n    if (shouldCall) {\n      callback();\n    }\n  }\n}\n"],"mappings":";AAAA,SAAS,cAAc;AAIhB,IAAM,QAAN,MAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBjB,YAAY,IAAY;AACtB;AAAA,MACE,CAAC,OAAO,MAAM,EAAE;AAAA,MAChB,IAAI,UAAU,mCAAmC;AAAA,IACnD;AACA,WAAO,MAAM,GAAG,IAAI,UAAU,wCAAwC,CAAC;AACvE,SAAK,QAAQ,EAAE,OAAO,WAAW,WAAW,GAAG;AAAA,EACjD;AAAA,EAEA,IAAI,SAAsB;AACxB,WAAO,KAAK,MAAM;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS;AACP;AAAA,MACE,KAAK,WAAW,YAAY,KAAK,WAAW;AAAA,MAC5C,IAAI,MAAM,qCAAqC;AAAA,IACjD;AACA,SAAK,SAAS,KAAK;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,QAAQ;AACN;AAAA,MACE,KAAK,MAAM,UAAU;AAAA,MACrB,IAAI,MAAM,oCAAoC;AAAA,IAChD;AAEA,UAAM,EAAE,UAAU,OAAO,SAAS,UAAU,IAAI,KAAK;AAErD,gBAAY,UAAa,aAAa,OAAc;AACpD,SAAK,QAAQ;AAAA,MACX,OAAO;AAAA,MACP;AAAA,MACA,WAAW,aAAa,KAAK,IAAI,IAAI;AAAA,IACvC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,UAAsB;AAC1B;AAAA,MACE,KAAK,MAAM,UAAU;AAAA,MACrB,IAAI,MAAM,yCAAyC;AAAA,IACrD;AAEA,UAAM,EAAE,UAAU,IAAI,KAAK;AAC3B,SAAK,QAAQ,EAAE,OAAO,UAAU,WAAW,SAAS;AACpD,SAAK,OAAO;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS;AACP;AAAA,MACE,KAAK,MAAM,UAAU;AAAA,MACrB,IAAI,MAAM,kCAAkC;AAAA,IAC9C;AACA,UAAM,EAAE,WAAW,SAAS,IAAI,KAAK;AACrC,UAAM,QAAQ,KAAK,IAAI;AAEvB,QAAI;AAEJ,QAAI,cAAc,OAAO,mBAAmB;AAC1C,gBAAU,WAAW,MAAM,KAAK,SAAS,IAAI,GAAG,SAAS;AAAA,IAC3D;AAEA,SAAK,QAAQ,EAAE,OAAO,WAAW,UAAU,WAAW,OAAO,QAAQ;AAAA,EACvE;AAAA,EAEQ,SAAS,YAAqB;AACpC,WAAO,KAAK,MAAM,UAAU,aAAa,KAAK,MAAM,UAAU,QAAQ;AAEtE,QAAI,KAAK,MAAM,UAAU,aAAa,KAAK,MAAM,YAAY,QAAW;AACtE,mBAAa,KAAK,MAAM,OAAc;AAAA,IACxC;AAEA,UAAM,EAAE,SAAS,IAAI,KAAK;AAC1B,SAAK,QAAQ,EAAE,OAAO,WAAW;AAEjC,QAAI,YAAY;AACd,eAAS;AAAA,IACX;AAAA,EACF;AACF;","names":[]}

package/dist/chunk-57XSIYLY.mjs

@@ -0,0 +1,9 @@
+// src/logging.ts
+import { snapsLogger } from "@metamask/snaps-utils";
+import { createModuleLogger } from "@metamask/utils";
+var log = createModuleLogger(snapsLogger, "snaps-controllers");
+
+export {
+  log
+};
+//# sourceMappingURL=chunk-57XSIYLY.mjs.map

package/dist/chunk-57XSIYLY.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/logging.ts"],"sourcesContent":["import { snapsLogger } from '@metamask/snaps-utils';\nimport { createModuleLogger } from '@metamask/utils';\n\n/**\n * A logging function specific to this package. The log messages don't show up\n * by default, but they can be enabled by setting the environment variable:\n * - `DEBUG=metamask:snaps:snaps-controllers`, or\n * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.\n */\nexport const log = createModuleLogger(snapsLogger, 'snaps-controllers');\n"],"mappings":";AAAA,SAAS,mBAAmB;AAC5B,SAAS,0BAA0B;AAQ5B,IAAM,MAAM,mBAAmB,aAAa,mBAAmB;","names":[]}

package/dist/chunk-5AOHJSZ6.mjs

@@ -0,0 +1,40 @@
+import {
+  NpmLocation
+} from "./chunk-26FZJGWA.mjs";
+import {
+  LocalLocation
+} from "./chunk-XQ2TCH36.mjs";
+import {
+  HttpLocation
+} from "./chunk-WUAYTNK4.mjs";
+
+// src/snaps/location/location.ts
+import { assert } from "@metamask/utils";
+function detectSnapLocation(location, opts) {
+  const allowHttp = opts?.allowHttp ?? false;
+  const allowLocal = opts?.allowLocal ?? false;
+  const root = new URL(location);
+  switch (root.protocol) {
+    case "npm:":
+      return new NpmLocation(root, opts);
+    case "local:":
+      assert(allowLocal, new TypeError("Fetching local snaps is disabled."));
+      return new LocalLocation(root, opts);
+    case "http:":
+    case "https:":
+      assert(
+        allowHttp,
+        new TypeError("Fetching snaps through http/https is disabled.")
+      );
+      return new HttpLocation(root, opts);
+    default:
+      throw new TypeError(
+        `Unrecognized "${root.protocol}" snap location protocol.`
+      );
+  }
+}
+
+export {
+  detectSnapLocation
+};
+//# sourceMappingURL=chunk-5AOHJSZ6.mjs.map

package/dist/chunk-5AOHJSZ6.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/snaps/location/location.ts"],"sourcesContent":["import type { SnapManifest, VirtualFile } from '@metamask/snaps-utils';\nimport type { SemVerRange } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\n\nimport { HttpLocation } from './http';\nimport { LocalLocation } from './local';\nimport type { NpmOptions } from './npm';\nimport { NpmLocation } from './npm';\n\ndeclare module '@metamask/snaps-utils' {\n  interface DataMap {\n    /**\n     * Fully qualified, canonical path for the file in {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8 } URI format.\n     */\n    canonicalPath: string;\n  }\n}\n\nexport interface SnapLocation {\n  /**\n   * All files are relative to the manifest, except the manifest itself.\n   */\n  manifest(): Promise<VirtualFile<SnapManifest>>;\n  fetch(path: string): Promise<VirtualFile>;\n\n  readonly shouldAlwaysReload?: boolean;\n}\n\nexport type DetectSnapLocationOptions = NpmOptions & {\n  /**\n   * The function used to fetch data.\n   *\n   * @default globalThis.fetch\n   */\n  fetch?: typeof fetch;\n  /**\n   * @default false\n   */\n  allowHttp?: boolean;\n  /**\n   * @default false\n   */\n  allowLocal?: boolean;\n\n  resolveVersion?: (range: SemVerRange) => Promise<SemVerRange>;\n};\n\n/**\n * Auto-magically detects which SnapLocation object to create based on the provided {@link location}.\n *\n * @param location - A {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8} uri.\n * @param opts - NPM options and feature flags.\n * @returns SnapLocation based on url.\n */\nexport function detectSnapLocation(\n  location: string | URL,\n  opts?: DetectSnapLocationOptions,\n): SnapLocation {\n  const allowHttp = opts?.allowHttp ?? false;\n  const allowLocal = opts?.allowLocal ?? false;\n  const root = new URL(location);\n  switch (root.protocol) {\n    case 'npm:':\n      return new NpmLocation(root, opts);\n    case 'local:':\n      assert(allowLocal, new TypeError('Fetching local snaps is disabled.'));\n      return new LocalLocation(root, opts);\n    case 'http:':\n    case 'https:':\n      assert(\n        allowHttp,\n        new TypeError('Fetching snaps through http/https is disabled.'),\n      );\n      return new HttpLocation(root, opts);\n    default:\n      throw new TypeError(\n        `Unrecognized \"${root.protocol}\" snap location protocol.`,\n      );\n  }\n}\n"],"mappings":";;;;;;;;;;;AAEA,SAAS,cAAc;AAoDhB,SAAS,mBACd,UACA,MACc;AACd,QAAM,YAAY,MAAM,aAAa;AACrC,QAAM,aAAa,MAAM,cAAc;AACvC,QAAM,OAAO,IAAI,IAAI,QAAQ;AAC7B,UAAQ,KAAK,UAAU;AAAA,IACrB,KAAK;AACH,aAAO,IAAI,YAAY,MAAM,IAAI;AAAA,IACnC,KAAK;AACH,aAAO,YAAY,IAAI,UAAU,mCAAmC,CAAC;AACrE,aAAO,IAAI,cAAc,MAAM,IAAI;AAAA,IACrC,KAAK;AAAA,IACL,KAAK;AACH;AAAA,QACE;AAAA,QACA,IAAI,UAAU,gDAAgD;AAAA,MAChE;AACA,aAAO,IAAI,aAAa,MAAM,IAAI;AAAA,IACpC;AACE,YAAM,IAAI;AAAA,QACR,iBAAiB,KAAK,QAAQ;AAAA,MAChC;AAAA,EACJ;AACF;","names":[]}

package/dist/chunk-5JX3PHKY.mjs

@@ -0,0 +1,7 @@
+// src/snaps/selectors.ts
+var getRunnableSnaps = (snaps) => snaps.filter((snap) => snap.enabled && !snap.blocked);
+
+export {
+  getRunnableSnaps
+};
+//# sourceMappingURL=chunk-5JX3PHKY.mjs.map

package/dist/chunk-5JX3PHKY.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/snaps/selectors.ts"],"sourcesContent":["import type { TruncatedSnap } from '@metamask/snaps-utils';\n\nexport const getRunnableSnaps = <Snap extends TruncatedSnap>(snaps: Snap[]) =>\n  snaps.filter((snap) => snap.enabled && !snap.blocked);\n"],"mappings":";AAEO,IAAM,mBAAmB,CAA6B,UAC3D,MAAM,OAAO,CAAC,SAAS,KAAK,WAAW,CAAC,KAAK,OAAO;","names":[]}

package/dist/chunk-5UJDZGAF.mjs

@@ -0,0 +1,19 @@
+// src/snaps/constants.ts
+import { SnapEndowments } from "@metamask/snaps-rpc-methods";
+var ALLOWED_PERMISSIONS = Object.freeze([
+  "snap_dialog",
+  "snap_manageState",
+  "snap_notify",
+  "snap_getLocale",
+  SnapEndowments.Cronjob,
+  SnapEndowments.HomePage,
+  SnapEndowments.LifecycleHooks,
+  SnapEndowments.EthereumProvider,
+  SnapEndowments.TransactionInsight,
+  SnapEndowments.SignatureInsight
+]);
+
+export {
+  ALLOWED_PERMISSIONS
+};
+//# sourceMappingURL=chunk-5UJDZGAF.mjs.map

package/dist/chunk-5UJDZGAF.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/snaps/constants.ts"],"sourcesContent":["import { SnapEndowments } from '@metamask/snaps-rpc-methods';\n\n// These permissions are allowed without being on the allowlist.\nexport const ALLOWED_PERMISSIONS = Object.freeze([\n  'snap_dialog',\n  'snap_manageState',\n  'snap_notify',\n  'snap_getLocale',\n  SnapEndowments.Cronjob,\n  SnapEndowments.HomePage,\n  SnapEndowments.LifecycleHooks,\n  SnapEndowments.EthereumProvider,\n  SnapEndowments.TransactionInsight,\n  SnapEndowments.SignatureInsight,\n]);\n"],"mappings":";AAAA,SAAS,sBAAsB;AAGxB,IAAM,sBAAsB,OAAO,OAAO;AAAA,EAC/C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AAAA,EACf,eAAe;AACjB,CAAC;","names":[]}

package/dist/chunk-66XO4TRY.js

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/logging.ts
+var _snapsutils = require('@metamask/snaps-utils');
+var _utils = require('@metamask/utils');
+var log = _utils.createModuleLogger.call(void 0, _snapsutils.snapsLogger, "snaps-controllers");
+
+
+
+exports.log = log;
+//# sourceMappingURL=chunk-66XO4TRY.js.map

package/dist/chunk-66XO4TRY.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/logging.ts"],"names":[],"mappings":";AAAA,SAAS,mBAAmB;AAC5B,SAAS,0BAA0B;AAQ5B,IAAM,MAAM,mBAAmB,aAAa,mBAAmB","sourcesContent":["import { snapsLogger } from '@metamask/snaps-utils';\nimport { createModuleLogger } from '@metamask/utils';\n\n/**\n * A logging function specific to this package. The log messages don't show up\n * by default, but they can be enabled by setting the environment variable:\n * - `DEBUG=metamask:snaps:snaps-controllers`, or\n * - `DEBUG=metamask:snaps:*` to enable all logs from `@metamask/snaps-*`.\n */\nexport const log = createModuleLogger(snapsLogger, 'snaps-controllers');\n"]}

package/dist/chunk-6I34XHMY.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=chunk-6I34XHMY.mjs.map

package/dist/chunk-6I34XHMY.mjs.map

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