@metamask/snaps-sdk 10.3.0 → 11.0.0

package/dist/errors.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJsonError = exports.SnapError = void 0;
+exports.isSnapError = exports.isSerializedSnapError = exports.getJsonError = exports.SnapError = void 0;
 const utils_1 = require("@metamask/utils");
 const internals_1 = require("./internals/index.cjs");
 /**
@@ -160,4 +160,30 @@ error) {
     };
 }
 exports.getJsonError = getJsonError;
+/**
+ * Check if a JSON-RPC error is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+function isSerializedSnapError(error) {
+    return error.code === internals_1.SNAP_ERROR_CODE && error.message === internals_1.SNAP_ERROR_MESSAGE;
+}
+exports.isSerializedSnapError = isSerializedSnapError;
+/**
+ * Check if an object is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+function isSnapError(error) {
+    if ((0, utils_1.isObject)(error) &&
+        'serialize' in error &&
+        typeof error.serialize === 'function') {
+        const serialized = error.serialize();
+        return (0, utils_1.isJsonRpcError)(serialized) && isSerializedSnapError(serialized);
+    }
+    return false;
+}
+exports.isSnapError = isSnapError;
 //# sourceMappingURL=errors.cjs.map

package/dist/errors.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"errors.cjs","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AACA,2CAAiD;AAEjD,qDASqB;AAGrB;;;GAGG;AACH,MAAa,SAAU,SAAQ,KAAK;IACzB,KAAK,CAAS;IAEd,QAAQ,CAAS;IAEjB,KAAK,CAAwB;IAE7B,MAAM,CAAU;IAEzB;;;;;;;;;;;OAWG;IACH,YACE,KAAoC,EACpC,OAA6B,EAAE;QAE/B,MAAM,OAAO,GAAG,IAAA,2BAAe,EAAC,KAAK,CAAC,CAAC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAA,wBAAY,EAAC,KAAK,CAAC,CAAC;QAEjC,MAAM,UAAU,GAAG,EAAE,GAAG,IAAA,wBAAY,EAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QACvD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,2BAAe;YACrB,OAAO,EAAE,8BAAkB;YAC3B,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC1C;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF;AArHD,8BAqHC;AAwBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,YAAY;AAC1B,6EAA6E;AAC7E,WAAW;AACX,KAA8C;IAE9C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO;YACL,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,IAAA,sBAAc,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO;YACL,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,IAAA,2BAAe,EAAC,KAAK,CAAC;YAC/B,KAAK,EAAE,IAAA,yBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,yBAAa,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI;YAChE,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,IAAA,yBAAa,EAAC,KAAK,CAAC,CAAC;IAEnC,OAAO;QACL,IAAI,EAAE,IAAA,wBAAY,EAAC,KAAK,CAAC;QACzB,OAAO,EAAE,IAAA,2BAAe,EAAC,KAAK,CAAC;QAC/B,KAAK,EAAE,IAAA,yBAAa,EAAC,KAAK,CAAC,IAAI,IAAI;QACnC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;KACnD,CAAC;AACJ,CAAC;AA/BD,oCA+BC","sourcesContent":["import type { Json, JsonRpcError } from '@metamask/utils';\nimport { isJsonRpcError } from '@metamask/utils';\n\nimport {\n  getErrorCause,\n  getErrorCode,\n  getErrorData,\n  getErrorMessage,\n  getErrorName,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n} from './internals';\nimport type { TrackableError } from './types';\n\n/**\n * A generic error which can be thrown by a Snap, without it causing the Snap to\n * crash.\n */\nexport class SnapError extends Error {\n  readonly #code: number;\n\n  readonly #message: string;\n\n  readonly #data?: Record<string, Json>;\n\n  readonly #stack?: string;\n\n  /**\n   * Create a new `SnapError`.\n   *\n   * @param error - The error to create the `SnapError` from. If this is a\n   * `string`, it will be used as the error message. If this is an `Error`, its\n   * `message` property will be used as the error message. If this is a\n   * `JsonRpcError`, its `message` property will be used as the error message\n   * and its `code` property will be used as the error code. Otherwise, the\n   * error will be converted to a string and used as the error message.\n   * @param data - Additional data to include in the error. This will be merged\n   * with the error data, if any.\n   */\n  constructor(\n    error: string | Error | JsonRpcError,\n    data: Record<string, Json> = {},\n  ) {\n    const message = getErrorMessage(error);\n    super(message);\n\n    this.#message = message;\n    this.#code = getErrorCode(error);\n\n    const mergedData = { ...getErrorData(error), ...data };\n    if (Object.keys(mergedData).length > 0) {\n      this.#data = mergedData;\n    }\n\n    this.#stack = super.stack;\n  }\n\n  /**\n   * The error name.\n   *\n   * @returns The error name.\n   */\n  get name() {\n    return 'SnapError';\n  }\n\n  /**\n   * The error code.\n   *\n   * @returns The error code.\n   */\n  get code() {\n    return this.#code;\n  }\n\n  /**\n   * The error message.\n   *\n   * @returns The error message.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get message() {\n    return this.#message;\n  }\n\n  /**\n   * Additional data for the error.\n   *\n   * @returns Additional data for the error.\n   */\n  get data() {\n    return this.#data;\n  }\n\n  /**\n   * The error stack.\n   *\n   * @returns The error stack.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get stack() {\n    return this.#stack;\n  }\n\n  /**\n   * Convert the error to a JSON object.\n   *\n   * @returns The JSON object.\n   */\n  toJSON(): SerializedSnapError {\n    return {\n      code: SNAP_ERROR_CODE,\n      message: SNAP_ERROR_MESSAGE,\n      data: {\n        cause: {\n          code: this.code,\n          message: this.message,\n          stack: this.stack,\n          ...(this.data ? { data: this.data } : {}),\n        },\n      },\n    };\n  }\n\n  /**\n   * Serialize the error to a JSON object. This is called by\n   * `@metamask/rpc-errors` when serializing the error.\n   *\n   * @returns The JSON object.\n   */\n  serialize() {\n    return this.toJSON();\n  }\n}\n\n/**\n * A serialized {@link SnapError}. It's JSON-serializable, so it can be sent\n * over the RPC. The original error is wrapped in the `cause` property.\n *\n * @property code - The error code. This is always `-31002`.\n * @property message - The error message. This is always `'Snap Error'`.\n * @property data - The error data.\n * @property data.cause - The cause of the error.\n * @property data.cause.code - The error code.\n * @property data.cause.message - The error message.\n * @property data.cause.stack - The error stack.\n * @property data.cause.data - Additional data for the error.\n * @see SnapError\n */\nexport type SerializedSnapError = {\n  code: typeof SNAP_ERROR_CODE;\n  message: typeof SNAP_ERROR_MESSAGE;\n  data: {\n    cause: JsonRpcError;\n  };\n};\n\n/**\n * Get a serialised JSON error from a given error. This is intended to be used\n * with `snap_trackError` to convert an error to a JSON object that can be\n * tracked by the Sentry instance in the client.\n *\n * @param error - The error to convert to a JSON error. This can be a string, an\n * `Error`, a `JsonRpcError`, or any other type. If it is not a string or an\n * `Error`, it will be converted to a string using its `toString()` method.\n * @returns A JSON object containing the error message and stack trace, if\n * available.\n * @example\n * try {\n *   // Some code that may throw an error\n * } catch (error) {\n *   await snap.request({\n *     method: 'snap_trackError',\n *     params: {\n *       error: getJsonError(error),\n *     },\n *   });\n * }\n */\nexport function getJsonError(\n  // TypeScript will narrow this to `unknown`, but we specify all the types for\n  // clarity.\n  error: string | Error | JsonRpcError | unknown,\n): TrackableError {\n  if (typeof error === 'string') {\n    return {\n      name: 'Error',\n      message: error,\n      stack: null,\n      cause: null,\n    };\n  }\n\n  if (isJsonRpcError(error)) {\n    return {\n      name: 'JsonRpcError',\n      message: getErrorMessage(error),\n      stack: getErrorStack(error) ?? getErrorStack(error.data) ?? null,\n      cause: null,\n    };\n  }\n\n  const cause = getErrorCause(error);\n\n  return {\n    name: getErrorName(error),\n    message: getErrorMessage(error),\n    stack: getErrorStack(error) ?? null,\n    cause: cause === null ? null : getJsonError(cause),\n  };\n}\n"]}
+{"version":3,"file":"errors.cjs","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AACA,2CAA2D;AAE3D,qDASqB;AAGrB;;;GAGG;AACH,MAAa,SAAU,SAAQ,KAAK;IACzB,KAAK,CAAS;IAEd,QAAQ,CAAS;IAEjB,KAAK,CAAwB;IAE7B,MAAM,CAAU;IAEzB;;;;;;;;;;;OAWG;IACH,YACE,KAAoC,EACpC,OAA6B,EAAE;QAE/B,MAAM,OAAO,GAAG,IAAA,2BAAe,EAAC,KAAK,CAAC,CAAC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,IAAA,wBAAY,EAAC,KAAK,CAAC,CAAC;QAEjC,MAAM,UAAU,GAAG,EAAE,GAAG,IAAA,wBAAY,EAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QACvD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,2BAAe;YACrB,OAAO,EAAE,8BAAkB;YAC3B,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC1C;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF;AArHD,8BAqHC;AAwBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,YAAY;AAC1B,6EAA6E;AAC7E,WAAW;AACX,KAA8C;IAE9C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO;YACL,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,IAAA,sBAAc,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO;YACL,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,IAAA,2BAAe,EAAC,KAAK,CAAC;YAC/B,KAAK,EAAE,IAAA,yBAAa,EAAC,KAAK,CAAC,IAAI,IAAA,yBAAa,EAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI;YAChE,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,IAAA,yBAAa,EAAC,KAAK,CAAC,CAAC;IAEnC,OAAO;QACL,IAAI,EAAE,IAAA,wBAAY,EAAC,KAAK,CAAC;QACzB,OAAO,EAAE,IAAA,2BAAe,EAAC,KAAK,CAAC;QAC/B,KAAK,EAAE,IAAA,yBAAa,EAAC,KAAK,CAAC,IAAI,IAAI;QACnC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;KACnD,CAAC;AACJ,CAAC;AA/BD,oCA+BC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,KAAmB;IAEnB,OAAO,KAAK,CAAC,IAAI,KAAK,2BAAe,IAAI,KAAK,CAAC,OAAO,KAAK,8BAAkB,CAAC;AAChF,CAAC;AAJD,sDAIC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,IACE,IAAA,gBAAQ,EAAC,KAAK,CAAC;QACf,WAAW,IAAI,KAAK;QACpB,OAAO,KAAK,CAAC,SAAS,KAAK,UAAU,EACrC,CAAC;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QACrC,OAAO,IAAA,sBAAc,EAAC,UAAU,CAAC,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAXD,kCAWC","sourcesContent":["import type { Json, JsonRpcError } from '@metamask/utils';\nimport { isJsonRpcError, isObject } from '@metamask/utils';\n\nimport {\n  getErrorCause,\n  getErrorCode,\n  getErrorData,\n  getErrorMessage,\n  getErrorName,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n} from './internals';\nimport type { TrackableError } from './types';\n\n/**\n * A generic error which can be thrown by a Snap, without it causing the Snap to\n * crash.\n */\nexport class SnapError extends Error {\n  readonly #code: number;\n\n  readonly #message: string;\n\n  readonly #data?: Record<string, Json>;\n\n  readonly #stack?: string;\n\n  /**\n   * Create a new `SnapError`.\n   *\n   * @param error - The error to create the `SnapError` from. If this is a\n   * `string`, it will be used as the error message. If this is an `Error`, its\n   * `message` property will be used as the error message. If this is a\n   * `JsonRpcError`, its `message` property will be used as the error message\n   * and its `code` property will be used as the error code. Otherwise, the\n   * error will be converted to a string and used as the error message.\n   * @param data - Additional data to include in the error. This will be merged\n   * with the error data, if any.\n   */\n  constructor(\n    error: string | Error | JsonRpcError,\n    data: Record<string, Json> = {},\n  ) {\n    const message = getErrorMessage(error);\n    super(message);\n\n    this.#message = message;\n    this.#code = getErrorCode(error);\n\n    const mergedData = { ...getErrorData(error), ...data };\n    if (Object.keys(mergedData).length > 0) {\n      this.#data = mergedData;\n    }\n\n    this.#stack = super.stack;\n  }\n\n  /**\n   * The error name.\n   *\n   * @returns The error name.\n   */\n  get name() {\n    return 'SnapError';\n  }\n\n  /**\n   * The error code.\n   *\n   * @returns The error code.\n   */\n  get code() {\n    return this.#code;\n  }\n\n  /**\n   * The error message.\n   *\n   * @returns The error message.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get message() {\n    return this.#message;\n  }\n\n  /**\n   * Additional data for the error.\n   *\n   * @returns Additional data for the error.\n   */\n  get data() {\n    return this.#data;\n  }\n\n  /**\n   * The error stack.\n   *\n   * @returns The error stack.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get stack() {\n    return this.#stack;\n  }\n\n  /**\n   * Convert the error to a JSON object.\n   *\n   * @returns The JSON object.\n   */\n  toJSON(): SerializedSnapError {\n    return {\n      code: SNAP_ERROR_CODE,\n      message: SNAP_ERROR_MESSAGE,\n      data: {\n        cause: {\n          code: this.code,\n          message: this.message,\n          stack: this.stack,\n          ...(this.data ? { data: this.data } : {}),\n        },\n      },\n    };\n  }\n\n  /**\n   * Serialize the error to a JSON object. This is called by\n   * `@metamask/rpc-errors` when serializing the error.\n   *\n   * @returns The JSON object.\n   */\n  serialize() {\n    return this.toJSON();\n  }\n}\n\n/**\n * A serialized {@link SnapError}. It's JSON-serializable, so it can be sent\n * over the RPC. The original error is wrapped in the `cause` property.\n *\n * @property code - The error code. This is always `-31002`.\n * @property message - The error message. This is always `'Snap Error'`.\n * @property data - The error data.\n * @property data.cause - The cause of the error.\n * @property data.cause.code - The error code.\n * @property data.cause.message - The error message.\n * @property data.cause.stack - The error stack.\n * @property data.cause.data - Additional data for the error.\n * @see SnapError\n */\nexport type SerializedSnapError = {\n  code: typeof SNAP_ERROR_CODE;\n  message: typeof SNAP_ERROR_MESSAGE;\n  data: {\n    cause: JsonRpcError;\n  };\n};\n\n/**\n * Get a serialised JSON error from a given error. This is intended to be used\n * with `snap_trackError` to convert an error to a JSON object that can be\n * tracked by the Sentry instance in the client.\n *\n * @param error - The error to convert to a JSON error. This can be a string, an\n * `Error`, a `JsonRpcError`, or any other type. If it is not a string or an\n * `Error`, it will be converted to a string using its `toString()` method.\n * @returns A JSON object containing the error message and stack trace, if\n * available.\n * @example\n * try {\n *   // Some code that may throw an error\n * } catch (error) {\n *   await snap.request({\n *     method: 'snap_trackError',\n *     params: {\n *       error: getJsonError(error),\n *     },\n *   });\n * }\n */\nexport function getJsonError(\n  // TypeScript will narrow this to `unknown`, but we specify all the types for\n  // clarity.\n  error: string | Error | JsonRpcError | unknown,\n): TrackableError {\n  if (typeof error === 'string') {\n    return {\n      name: 'Error',\n      message: error,\n      stack: null,\n      cause: null,\n    };\n  }\n\n  if (isJsonRpcError(error)) {\n    return {\n      name: 'JsonRpcError',\n      message: getErrorMessage(error),\n      stack: getErrorStack(error) ?? getErrorStack(error.data) ?? null,\n      cause: null,\n    };\n  }\n\n  const cause = getErrorCause(error);\n\n  return {\n    name: getErrorName(error),\n    message: getErrorMessage(error),\n    stack: getErrorStack(error) ?? null,\n    cause: cause === null ? null : getJsonError(cause),\n  };\n}\n\n/**\n * Check if a JSON-RPC error is a `SnapError`.\n *\n * @param error - The object to check.\n * @returns Whether the object is a `SnapError`.\n */\nexport function isSerializedSnapError(\n  error: JsonRpcError,\n): error is SerializedSnapError {\n  return error.code === SNAP_ERROR_CODE && error.message === SNAP_ERROR_MESSAGE;\n}\n\n/**\n * Check if an object is a `SnapError`.\n *\n * @param error - The object to check.\n * @returns Whether the object is a `SnapError`.\n */\nexport function isSnapError(error: unknown): error is SnapError {\n  if (\n    isObject(error) &&\n    'serialize' in error &&\n    typeof error.serialize === 'function'\n  ) {\n    const serialized = error.serialize();\n    return isJsonRpcError(serialized) && isSerializedSnapError(serialized);\n  }\n\n  return false;\n}\n"]}

package/dist/errors.d.cts

@@ -108,4 +108,18 @@ export type SerializedSnapError = {
  * }
  */
 export declare function getJsonError(error: string | Error | JsonRpcError | unknown): TrackableError;
+/**
+ * Check if a JSON-RPC error is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+export declare function isSerializedSnapError(error: JsonRpcError): error is SerializedSnapError;
+/**
+ * Check if an object is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+export declare function isSnapError(error: unknown): error is SnapError;
 //# sourceMappingURL=errors.d.cts.map

package/dist/errors.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.cts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,wBAAwB;AAG1D,OAAO,EAOL,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AACrB,OAAO,KAAK,EAAE,cAAc,EAAE,0BAAgB;AAE9C;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;;IASlC;;;;;;;;;;;OAWG;gBAED,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,EACpC,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAM;IAgBjC;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IAGH,IAAI,OAAO,WAEV;IAED;;;;OAIG;IACH,IAAI,IAAI,qCAEP;IAED;;;;OAIG;IAGH,IAAI,KAAK,uBAER;IAED;;;;OAIG;IACH,MAAM,IAAI,mBAAmB;IAe7B;;;;;OAKG;IACH,SAAS;CAGV;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,eAAe,CAAC;IAC7B,OAAO,EAAE,OAAO,kBAAkB,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,YAAY,CAAC;KACrB,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAG1B,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,GAAG,OAAO,GAC7C,cAAc,CA2BhB"}
+{"version":3,"file":"errors.d.cts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,wBAAwB;AAG1D,OAAO,EAOL,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AACrB,OAAO,KAAK,EAAE,cAAc,EAAE,0BAAgB;AAE9C;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;;IASlC;;;;;;;;;;;OAWG;gBAED,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,EACpC,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAM;IAgBjC;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IAGH,IAAI,OAAO,WAEV;IAED;;;;OAIG;IACH,IAAI,IAAI,qCAEP;IAED;;;;OAIG;IAGH,IAAI,KAAK,uBAER;IAED;;;;OAIG;IACH,MAAM,IAAI,mBAAmB;IAe7B;;;;;OAKG;IACH,SAAS;CAGV;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,eAAe,CAAC;IAC7B,OAAO,EAAE,OAAO,kBAAkB,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,YAAY,CAAC;KACrB,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAG1B,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,GAAG,OAAO,GAC7C,cAAc,CA2BhB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,YAAY,GAClB,KAAK,IAAI,mBAAmB,CAE9B;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAW9D"}

package/dist/errors.d.mts

@@ -108,4 +108,18 @@ export type SerializedSnapError = {
  * }
  */
 export declare function getJsonError(error: string | Error | JsonRpcError | unknown): TrackableError;
+/**
+ * Check if a JSON-RPC error is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+export declare function isSerializedSnapError(error: JsonRpcError): error is SerializedSnapError;
+/**
+ * Check if an object is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+export declare function isSnapError(error: unknown): error is SnapError;
 //# sourceMappingURL=errors.d.mts.map

package/dist/errors.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.mts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,wBAAwB;AAG1D,OAAO,EAOL,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AACrB,OAAO,KAAK,EAAE,cAAc,EAAE,0BAAgB;AAE9C;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;;IASlC;;;;;;;;;;;OAWG;gBAED,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,EACpC,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAM;IAgBjC;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IAGH,IAAI,OAAO,WAEV;IAED;;;;OAIG;IACH,IAAI,IAAI,qCAEP;IAED;;;;OAIG;IAGH,IAAI,KAAK,uBAER;IAED;;;;OAIG;IACH,MAAM,IAAI,mBAAmB;IAe7B;;;;;OAKG;IACH,SAAS;CAGV;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,eAAe,CAAC;IAC7B,OAAO,EAAE,OAAO,kBAAkB,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,YAAY,CAAC;KACrB,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAG1B,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,GAAG,OAAO,GAC7C,cAAc,CA2BhB"}
+{"version":3,"file":"errors.d.mts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,wBAAwB;AAG1D,OAAO,EAOL,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AACrB,OAAO,KAAK,EAAE,cAAc,EAAE,0BAAgB;AAE9C;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;;IASlC;;;;;;;;;;;OAWG;gBAED,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,EACpC,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAM;IAgBjC;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IACH,IAAI,IAAI,WAEP;IAED;;;;OAIG;IAGH,IAAI,OAAO,WAEV;IAED;;;;OAIG;IACH,IAAI,IAAI,qCAEP;IAED;;;;OAIG;IAGH,IAAI,KAAK,uBAER;IAED;;;;OAIG;IACH,MAAM,IAAI,mBAAmB;IAe7B;;;;;OAKG;IACH,SAAS;CAGV;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,eAAe,CAAC;IAC7B,OAAO,EAAE,OAAO,kBAAkB,CAAC;IACnC,IAAI,EAAE;QACJ,KAAK,EAAE,YAAY,CAAC;KACrB,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAG1B,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,YAAY,GAAG,OAAO,GAC7C,cAAc,CA2BhB;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,YAAY,GAClB,KAAK,IAAI,mBAAmB,CAE9B;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,CAW9D"}

package/dist/errors.mjs

@@ -1,4 +1,4 @@
-import { isJsonRpcError } from "@metamask/utils";
+import { isJsonRpcError, isObject } from "@metamask/utils";
 import { getErrorCause, getErrorCode, getErrorData, getErrorMessage, getErrorName, getErrorStack, SNAP_ERROR_CODE, SNAP_ERROR_MESSAGE } from "./internals/index.mjs";
 /**
  * A generic error which can be thrown by a Snap, without it causing the Snap to
@@ -155,4 +155,28 @@ error) {
         cause: cause === null ? null : getJsonError(cause),
     };
 }
+/**
+ * Check if a JSON-RPC error is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+export function isSerializedSnapError(error) {
+    return error.code === SNAP_ERROR_CODE && error.message === SNAP_ERROR_MESSAGE;
+}
+/**
+ * Check if an object is a `SnapError`.
+ *
+ * @param error - The object to check.
+ * @returns Whether the object is a `SnapError`.
+ */
+export function isSnapError(error) {
+    if (isObject(error) &&
+        'serialize' in error &&
+        typeof error.serialize === 'function') {
+        const serialized = error.serialize();
+        return isJsonRpcError(serialized) && isSerializedSnapError(serialized);
+    }
+    return false;
+}
 //# sourceMappingURL=errors.mjs.map

package/dist/errors.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"errors.mjs","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,wBAAwB;AAEjD,OAAO,EACL,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,aAAa,EACb,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AAGrB;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IACzB,KAAK,CAAS;IAEd,QAAQ,CAAS;IAEjB,KAAK,CAAwB;IAE7B,MAAM,CAAU;IAEzB;;;;;;;;;;;OAWG;IACH,YACE,KAAoC,EACpC,OAA6B,EAAE;QAE/B,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAEjC,MAAM,UAAU,GAAG,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QACvD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,kBAAkB;YAC3B,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC1C;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF;AAwBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,YAAY;AAC1B,6EAA6E;AAC7E,WAAW;AACX,KAA8C;IAE9C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO;YACL,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO;YACL,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC;YAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI;YAChE,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAEnC,OAAO;QACL,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC;QACzB,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC;QAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,IAAI;QACnC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;KACnD,CAAC;AACJ,CAAC","sourcesContent":["import type { Json, JsonRpcError } from '@metamask/utils';\nimport { isJsonRpcError } from '@metamask/utils';\n\nimport {\n  getErrorCause,\n  getErrorCode,\n  getErrorData,\n  getErrorMessage,\n  getErrorName,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n} from './internals';\nimport type { TrackableError } from './types';\n\n/**\n * A generic error which can be thrown by a Snap, without it causing the Snap to\n * crash.\n */\nexport class SnapError extends Error {\n  readonly #code: number;\n\n  readonly #message: string;\n\n  readonly #data?: Record<string, Json>;\n\n  readonly #stack?: string;\n\n  /**\n   * Create a new `SnapError`.\n   *\n   * @param error - The error to create the `SnapError` from. If this is a\n   * `string`, it will be used as the error message. If this is an `Error`, its\n   * `message` property will be used as the error message. If this is a\n   * `JsonRpcError`, its `message` property will be used as the error message\n   * and its `code` property will be used as the error code. Otherwise, the\n   * error will be converted to a string and used as the error message.\n   * @param data - Additional data to include in the error. This will be merged\n   * with the error data, if any.\n   */\n  constructor(\n    error: string | Error | JsonRpcError,\n    data: Record<string, Json> = {},\n  ) {\n    const message = getErrorMessage(error);\n    super(message);\n\n    this.#message = message;\n    this.#code = getErrorCode(error);\n\n    const mergedData = { ...getErrorData(error), ...data };\n    if (Object.keys(mergedData).length > 0) {\n      this.#data = mergedData;\n    }\n\n    this.#stack = super.stack;\n  }\n\n  /**\n   * The error name.\n   *\n   * @returns The error name.\n   */\n  get name() {\n    return 'SnapError';\n  }\n\n  /**\n   * The error code.\n   *\n   * @returns The error code.\n   */\n  get code() {\n    return this.#code;\n  }\n\n  /**\n   * The error message.\n   *\n   * @returns The error message.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get message() {\n    return this.#message;\n  }\n\n  /**\n   * Additional data for the error.\n   *\n   * @returns Additional data for the error.\n   */\n  get data() {\n    return this.#data;\n  }\n\n  /**\n   * The error stack.\n   *\n   * @returns The error stack.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get stack() {\n    return this.#stack;\n  }\n\n  /**\n   * Convert the error to a JSON object.\n   *\n   * @returns The JSON object.\n   */\n  toJSON(): SerializedSnapError {\n    return {\n      code: SNAP_ERROR_CODE,\n      message: SNAP_ERROR_MESSAGE,\n      data: {\n        cause: {\n          code: this.code,\n          message: this.message,\n          stack: this.stack,\n          ...(this.data ? { data: this.data } : {}),\n        },\n      },\n    };\n  }\n\n  /**\n   * Serialize the error to a JSON object. This is called by\n   * `@metamask/rpc-errors` when serializing the error.\n   *\n   * @returns The JSON object.\n   */\n  serialize() {\n    return this.toJSON();\n  }\n}\n\n/**\n * A serialized {@link SnapError}. It's JSON-serializable, so it can be sent\n * over the RPC. The original error is wrapped in the `cause` property.\n *\n * @property code - The error code. This is always `-31002`.\n * @property message - The error message. This is always `'Snap Error'`.\n * @property data - The error data.\n * @property data.cause - The cause of the error.\n * @property data.cause.code - The error code.\n * @property data.cause.message - The error message.\n * @property data.cause.stack - The error stack.\n * @property data.cause.data - Additional data for the error.\n * @see SnapError\n */\nexport type SerializedSnapError = {\n  code: typeof SNAP_ERROR_CODE;\n  message: typeof SNAP_ERROR_MESSAGE;\n  data: {\n    cause: JsonRpcError;\n  };\n};\n\n/**\n * Get a serialised JSON error from a given error. This is intended to be used\n * with `snap_trackError` to convert an error to a JSON object that can be\n * tracked by the Sentry instance in the client.\n *\n * @param error - The error to convert to a JSON error. This can be a string, an\n * `Error`, a `JsonRpcError`, or any other type. If it is not a string or an\n * `Error`, it will be converted to a string using its `toString()` method.\n * @returns A JSON object containing the error message and stack trace, if\n * available.\n * @example\n * try {\n *   // Some code that may throw an error\n * } catch (error) {\n *   await snap.request({\n *     method: 'snap_trackError',\n *     params: {\n *       error: getJsonError(error),\n *     },\n *   });\n * }\n */\nexport function getJsonError(\n  // TypeScript will narrow this to `unknown`, but we specify all the types for\n  // clarity.\n  error: string | Error | JsonRpcError | unknown,\n): TrackableError {\n  if (typeof error === 'string') {\n    return {\n      name: 'Error',\n      message: error,\n      stack: null,\n      cause: null,\n    };\n  }\n\n  if (isJsonRpcError(error)) {\n    return {\n      name: 'JsonRpcError',\n      message: getErrorMessage(error),\n      stack: getErrorStack(error) ?? getErrorStack(error.data) ?? null,\n      cause: null,\n    };\n  }\n\n  const cause = getErrorCause(error);\n\n  return {\n    name: getErrorName(error),\n    message: getErrorMessage(error),\n    stack: getErrorStack(error) ?? null,\n    cause: cause === null ? null : getJsonError(cause),\n  };\n}\n"]}
+{"version":3,"file":"errors.mjs","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,wBAAwB;AAE3D,OAAO,EACL,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,aAAa,EACb,eAAe,EACf,kBAAkB,EACnB,8BAAoB;AAGrB;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IACzB,KAAK,CAAS;IAEd,QAAQ,CAAS;IAEjB,KAAK,CAAwB;IAE7B,MAAM,CAAU;IAEzB;;;;;;;;;;;OAWG;IACH,YACE,KAAoC,EACpC,OAA6B,EAAE;QAE/B,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACvC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QAEjC,MAAM,UAAU,GAAG,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC;QACvD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,qEAAqE;IACrE,0BAA0B;IAC1B,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,kBAAkB;YAC3B,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAC1C;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF;AAwBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,YAAY;AAC1B,6EAA6E;AAC7E,WAAW;AACX,KAA8C;IAE9C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO;YACL,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO;YACL,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC;YAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI;YAChE,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAEnC,OAAO;QACL,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC;QACzB,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC;QAC/B,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,IAAI,IAAI;QACnC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC;KACnD,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,KAAmB;IAEnB,OAAO,KAAK,CAAC,IAAI,KAAK,eAAe,IAAI,KAAK,CAAC,OAAO,KAAK,kBAAkB,CAAC;AAChF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,IACE,QAAQ,CAAC,KAAK,CAAC;QACf,WAAW,IAAI,KAAK;QACpB,OAAO,KAAK,CAAC,SAAS,KAAK,UAAU,EACrC,CAAC;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QACrC,OAAO,cAAc,CAAC,UAAU,CAAC,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import type { Json, JsonRpcError } from '@metamask/utils';\nimport { isJsonRpcError, isObject } from '@metamask/utils';\n\nimport {\n  getErrorCause,\n  getErrorCode,\n  getErrorData,\n  getErrorMessage,\n  getErrorName,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n} from './internals';\nimport type { TrackableError } from './types';\n\n/**\n * A generic error which can be thrown by a Snap, without it causing the Snap to\n * crash.\n */\nexport class SnapError extends Error {\n  readonly #code: number;\n\n  readonly #message: string;\n\n  readonly #data?: Record<string, Json>;\n\n  readonly #stack?: string;\n\n  /**\n   * Create a new `SnapError`.\n   *\n   * @param error - The error to create the `SnapError` from. If this is a\n   * `string`, it will be used as the error message. If this is an `Error`, its\n   * `message` property will be used as the error message. If this is a\n   * `JsonRpcError`, its `message` property will be used as the error message\n   * and its `code` property will be used as the error code. Otherwise, the\n   * error will be converted to a string and used as the error message.\n   * @param data - Additional data to include in the error. This will be merged\n   * with the error data, if any.\n   */\n  constructor(\n    error: string | Error | JsonRpcError,\n    data: Record<string, Json> = {},\n  ) {\n    const message = getErrorMessage(error);\n    super(message);\n\n    this.#message = message;\n    this.#code = getErrorCode(error);\n\n    const mergedData = { ...getErrorData(error), ...data };\n    if (Object.keys(mergedData).length > 0) {\n      this.#data = mergedData;\n    }\n\n    this.#stack = super.stack;\n  }\n\n  /**\n   * The error name.\n   *\n   * @returns The error name.\n   */\n  get name() {\n    return 'SnapError';\n  }\n\n  /**\n   * The error code.\n   *\n   * @returns The error code.\n   */\n  get code() {\n    return this.#code;\n  }\n\n  /**\n   * The error message.\n   *\n   * @returns The error message.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get message() {\n    return this.#message;\n  }\n\n  /**\n   * Additional data for the error.\n   *\n   * @returns Additional data for the error.\n   */\n  get data() {\n    return this.#data;\n  }\n\n  /**\n   * The error stack.\n   *\n   * @returns The error stack.\n   */\n  // This line is covered, but Jest doesn't pick it up for some reason.\n  /* istanbul ignore next */\n  get stack() {\n    return this.#stack;\n  }\n\n  /**\n   * Convert the error to a JSON object.\n   *\n   * @returns The JSON object.\n   */\n  toJSON(): SerializedSnapError {\n    return {\n      code: SNAP_ERROR_CODE,\n      message: SNAP_ERROR_MESSAGE,\n      data: {\n        cause: {\n          code: this.code,\n          message: this.message,\n          stack: this.stack,\n          ...(this.data ? { data: this.data } : {}),\n        },\n      },\n    };\n  }\n\n  /**\n   * Serialize the error to a JSON object. This is called by\n   * `@metamask/rpc-errors` when serializing the error.\n   *\n   * @returns The JSON object.\n   */\n  serialize() {\n    return this.toJSON();\n  }\n}\n\n/**\n * A serialized {@link SnapError}. It's JSON-serializable, so it can be sent\n * over the RPC. The original error is wrapped in the `cause` property.\n *\n * @property code - The error code. This is always `-31002`.\n * @property message - The error message. This is always `'Snap Error'`.\n * @property data - The error data.\n * @property data.cause - The cause of the error.\n * @property data.cause.code - The error code.\n * @property data.cause.message - The error message.\n * @property data.cause.stack - The error stack.\n * @property data.cause.data - Additional data for the error.\n * @see SnapError\n */\nexport type SerializedSnapError = {\n  code: typeof SNAP_ERROR_CODE;\n  message: typeof SNAP_ERROR_MESSAGE;\n  data: {\n    cause: JsonRpcError;\n  };\n};\n\n/**\n * Get a serialised JSON error from a given error. This is intended to be used\n * with `snap_trackError` to convert an error to a JSON object that can be\n * tracked by the Sentry instance in the client.\n *\n * @param error - The error to convert to a JSON error. This can be a string, an\n * `Error`, a `JsonRpcError`, or any other type. If it is not a string or an\n * `Error`, it will be converted to a string using its `toString()` method.\n * @returns A JSON object containing the error message and stack trace, if\n * available.\n * @example\n * try {\n *   // Some code that may throw an error\n * } catch (error) {\n *   await snap.request({\n *     method: 'snap_trackError',\n *     params: {\n *       error: getJsonError(error),\n *     },\n *   });\n * }\n */\nexport function getJsonError(\n  // TypeScript will narrow this to `unknown`, but we specify all the types for\n  // clarity.\n  error: string | Error | JsonRpcError | unknown,\n): TrackableError {\n  if (typeof error === 'string') {\n    return {\n      name: 'Error',\n      message: error,\n      stack: null,\n      cause: null,\n    };\n  }\n\n  if (isJsonRpcError(error)) {\n    return {\n      name: 'JsonRpcError',\n      message: getErrorMessage(error),\n      stack: getErrorStack(error) ?? getErrorStack(error.data) ?? null,\n      cause: null,\n    };\n  }\n\n  const cause = getErrorCause(error);\n\n  return {\n    name: getErrorName(error),\n    message: getErrorMessage(error),\n    stack: getErrorStack(error) ?? null,\n    cause: cause === null ? null : getJsonError(cause),\n  };\n}\n\n/**\n * Check if a JSON-RPC error is a `SnapError`.\n *\n * @param error - The object to check.\n * @returns Whether the object is a `SnapError`.\n */\nexport function isSerializedSnapError(\n  error: JsonRpcError,\n): error is SerializedSnapError {\n  return error.code === SNAP_ERROR_CODE && error.message === SNAP_ERROR_MESSAGE;\n}\n\n/**\n * Check if an object is a `SnapError`.\n *\n * @param error - The object to check.\n * @returns Whether the object is a `SnapError`.\n */\nexport function isSnapError(error: unknown): error is SnapError {\n  if (\n    isObject(error) &&\n    'serialize' in error &&\n    typeof error.serialize === 'function'\n  ) {\n    const serialized = error.serialize();\n    return isJsonRpcError(serialized) && isSerializedSnapError(serialized);\n  }\n\n  return false;\n}\n"]}

package/dist/images.cjs

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getImageComponent = exports.getImageData = void 0;
+exports.getImageData = void 0;
 const utils_1 = require("@metamask/utils");
-const ui_1 = require("./ui/index.cjs");
 /**
  * Get raw image data from a URL.
  *
@@ -39,8 +38,6 @@ async function getRawImageData(url, options) {
  *   </svg>
  * `;
  *
- * // Render the SVG in a Snap UI.
- * const ui = image(svg);
  * @param url - The URL to get the image data from.
  * @param options - The options to use when fetching the image data. This is
  * passed directly to `fetch`.
@@ -52,41 +49,4 @@ async function getImageData(url, options) {
     return `data:${blob.type};base64,${(0, utils_1.bytesToBase64)(bytes)}`;
 }
 exports.getImageData = getImageData;
-/**
- * Get an image component from a URL. This is useful for embedding images inside
- * Snap UIs. Only JPEG and PNG images are supported.
- *
- * Note: This function uses `fetch` to get the image data. This means that using
- * it requires the `endowment:network-access` permission.
- *
- * @example
- * const component = await getImage('https://cataas.com/cat');
- *
- * return await snap.request({
- *   method: 'snap_dialog',
- *   params: {
- *     type: 'alert',
- *     content: panel([
- *       component,
- *     ]),
- *   },
- * });
- * @param url - The URL to get the image data from.
- * @param options - The options to use when fetching and rendering the image.
- * @param options.width - The width of the image.
- * @param options.height - The height of the image. If this is not provided, the
- * width will be used as the height.
- * @param options.request - The options to use when fetching the image data.
- * This is passed directly to `fetch`.
- * @returns A promise that resolves to the image data as an image component.
- * @deprecated Use `<Image src="external_url" />` instead. This function will be removed in a future release.
- */
-async function getImageComponent(url, { width, height = width, request }) {
-    (0, utils_1.assert)(typeof width === 'number' && width > 0, 'Expected width to be a number greater than 0.');
-    (0, utils_1.assert)(typeof height === 'number' && height > 0, 'Expected height to be a number greater than 0.');
-    const imageData = await getImageData(url, request);
-    const size = `width="${width}" height="${height}"`;
-    return (0, ui_1.image)(`<svg ${size.trim()} xmlns="http://www.w3.org/2000/svg"><image ${size.trim()} href="${imageData}" /></svg>`);
-}
-exports.getImageComponent = getImageComponent;
 //# sourceMappingURL=images.cjs.map

package/dist/images.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"images.cjs","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":";;;AAAA,2CAAwD;AAExD,uCAA6B;AAE7B;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,OAAqB;IAC/D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,4EAA4E,CACpH,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACjD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,MAAM,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CACtF,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAA,cAAM,EACJ,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EACvD,gDAAgD,CACjD,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,OAAqB;IACnE,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvD,OAAO,QAAQ,IAAI,CAAC,IAAI,WAAW,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;AAC5D,CAAC;AALD,oCAKC;AAiBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,iBAAiB,CACrC,GAAW,EACX,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,EAAgB;IAEhD,IAAA,cAAM,EACJ,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,EACtC,+CAA+C,CAChD,CAAC;IAEF,IAAA,cAAM,EACJ,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,GAAG,CAAC,EACxC,gDAAgD,CACjD,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,IAAI,GAAG,UAAU,KAAK,aAAa,MAAM,GAAG,CAAC;IAEnD,OAAO,IAAA,UAAK,EACV,QAAQ,IAAI,CAAC,IAAI,EAAE,8CAA8C,IAAI,CAAC,IAAI,EAAE,UAAU,SAAS,YAAY,CAC5G,CAAC;AACJ,CAAC;AApBD,8CAoBC","sourcesContent":["import { assert, bytesToBase64 } from '@metamask/utils';\n\nimport { image } from './ui';\n\n/**\n * Get raw image data from a URL.\n *\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a blob.\n */\nasync function getRawImageData(url: string, options?: RequestInit) {\n  if (typeof fetch !== 'function') {\n    throw new Error(\n      `Failed to fetch image data from \"${url}\": Using this function requires the \"endowment:network-access\" permission.`,\n    );\n  }\n\n  return fetch(url, options).then(async (response) => {\n    if (!response.ok) {\n      throw new Error(\n        `Failed to fetch image data from \"${url}\": ${response.status} ${response.statusText}`,\n      );\n    }\n\n    const blob = await response.blob();\n    assert(\n      blob.type === 'image/jpeg' || blob.type === 'image/png',\n      'Expected image data to be a JPEG or PNG image.',\n    );\n\n    return blob;\n  });\n}\n\n/**\n * Get image data as data-string from a URL. This is useful for embedding images\n * inside of SVGs. Only JPEG and PNG images are supported.\n *\n * Note: This function uses `fetch` to get the image data. This means that using\n * it requires the `endowment:network-access` permission.\n *\n * @example\n * const imageData = await getImageData('https://cataas.com/cat');\n * const svg = `\n *   <svg width=\"100\" height=\"100\" xmlns=\"http://www.w3.org/2000/svg\">\n *     <image href=\"${imageData}\" />\n *   </svg>\n * `;\n *\n * // Render the SVG in a Snap UI.\n * const ui = image(svg);\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a data-string.\n */\nexport async function getImageData(url: string, options?: RequestInit) {\n  const blob = await getRawImageData(url, options);\n  const bytes = new Uint8Array(await blob.arrayBuffer());\n\n  return `data:${blob.type};base64,${bytesToBase64(bytes)}`;\n}\n\n/**\n * Options for getting an SVG image element from a URL.\n *\n * @property width - The width of the image.\n * @property height - The height of the image. If this is not provided, the\n * width will be used as the height.\n * @property request - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n */\nexport type ImageOptions = {\n  width: number;\n  height?: number;\n  request?: RequestInit;\n};\n\n/**\n * Get an image component from a URL. This is useful for embedding images inside\n * Snap UIs. Only JPEG and PNG images are supported.\n *\n * Note: This function uses `fetch` to get the image data. This means that using\n * it requires the `endowment:network-access` permission.\n *\n * @example\n * const component = await getImage('https://cataas.com/cat');\n *\n * return await snap.request({\n *   method: 'snap_dialog',\n *   params: {\n *     type: 'alert',\n *     content: panel([\n *       component,\n *     ]),\n *   },\n * });\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching and rendering the image.\n * @param options.width - The width of the image.\n * @param options.height - The height of the image. If this is not provided, the\n * width will be used as the height.\n * @param options.request - The options to use when fetching the image data.\n * This is passed directly to `fetch`.\n * @returns A promise that resolves to the image data as an image component.\n * @deprecated Use `<Image src=\"external_url\" />` instead. This function will be removed in a future release.\n */\nexport async function getImageComponent(\n  url: string,\n  { width, height = width, request }: ImageOptions,\n) {\n  assert(\n    typeof width === 'number' && width > 0,\n    'Expected width to be a number greater than 0.',\n  );\n\n  assert(\n    typeof height === 'number' && height > 0,\n    'Expected height to be a number greater than 0.',\n  );\n\n  const imageData = await getImageData(url, request);\n  const size = `width=\"${width}\" height=\"${height}\"`;\n\n  return image(\n    `<svg ${size.trim()} xmlns=\"http://www.w3.org/2000/svg\"><image ${size.trim()} href=\"${imageData}\" /></svg>`,\n  );\n}\n"]}
+{"version":3,"file":"images.cjs","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":";;;AAAA,2CAAwD;AAExD;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,OAAqB;IAC/D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,4EAA4E,CACpH,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACjD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,MAAM,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CACtF,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAA,cAAM,EACJ,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EACvD,gDAAgD,CACjD,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,OAAqB;IACnE,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvD,OAAO,QAAQ,IAAI,CAAC,IAAI,WAAW,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;AAC5D,CAAC;AALD,oCAKC","sourcesContent":["import { assert, bytesToBase64 } from '@metamask/utils';\n\n/**\n * Get raw image data from a URL.\n *\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a blob.\n */\nasync function getRawImageData(url: string, options?: RequestInit) {\n  if (typeof fetch !== 'function') {\n    throw new Error(\n      `Failed to fetch image data from \"${url}\": Using this function requires the \"endowment:network-access\" permission.`,\n    );\n  }\n\n  return fetch(url, options).then(async (response) => {\n    if (!response.ok) {\n      throw new Error(\n        `Failed to fetch image data from \"${url}\": ${response.status} ${response.statusText}`,\n      );\n    }\n\n    const blob = await response.blob();\n    assert(\n      blob.type === 'image/jpeg' || blob.type === 'image/png',\n      'Expected image data to be a JPEG or PNG image.',\n    );\n\n    return blob;\n  });\n}\n\n/**\n * Get image data as data-string from a URL. This is useful for embedding images\n * inside of SVGs. Only JPEG and PNG images are supported.\n *\n * Note: This function uses `fetch` to get the image data. This means that using\n * it requires the `endowment:network-access` permission.\n *\n * @example\n * const imageData = await getImageData('https://cataas.com/cat');\n * const svg = `\n *   <svg width=\"100\" height=\"100\" xmlns=\"http://www.w3.org/2000/svg\">\n *     <image href=\"${imageData}\" />\n *   </svg>\n * `;\n *\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a data-string.\n */\nexport async function getImageData(url: string, options?: RequestInit) {\n  const blob = await getRawImageData(url, options);\n  const bytes = new Uint8Array(await blob.arrayBuffer());\n\n  return `data:${blob.type};base64,${bytesToBase64(bytes)}`;\n}\n"]}

package/dist/images.d.cts

@@ -13,59 +13,10 @@
  *   </svg>
  * `;
  *
- * // Render the SVG in a Snap UI.
- * const ui = image(svg);
  * @param url - The URL to get the image data from.
  * @param options - The options to use when fetching the image data. This is
  * passed directly to `fetch`.
  * @returns A promise that resolves to the image data as a data-string.
  */
 export declare function getImageData(url: string, options?: RequestInit): Promise<string>;
-/**
- * Options for getting an SVG image element from a URL.
- *
- * @property width - The width of the image.
- * @property height - The height of the image. If this is not provided, the
- * width will be used as the height.
- * @property request - The options to use when fetching the image data. This is
- * passed directly to `fetch`.
- */
-export type ImageOptions = {
-    width: number;
-    height?: number;
-    request?: RequestInit;
-};
-/**
- * Get an image component from a URL. This is useful for embedding images inside
- * Snap UIs. Only JPEG and PNG images are supported.
- *
- * Note: This function uses `fetch` to get the image data. This means that using
- * it requires the `endowment:network-access` permission.
- *
- * @example
- * const component = await getImage('https://cataas.com/cat');
- *
- * return await snap.request({
- *   method: 'snap_dialog',
- *   params: {
- *     type: 'alert',
- *     content: panel([
- *       component,
- *     ]),
- *   },
- * });
- * @param url - The URL to get the image data from.
- * @param options - The options to use when fetching and rendering the image.
- * @param options.width - The width of the image.
- * @param options.height - The height of the image. If this is not provided, the
- * width will be used as the height.
- * @param options.request - The options to use when fetching the image data.
- * This is passed directly to `fetch`.
- * @returns A promise that resolves to the image data as an image component.
- * @deprecated Use `<Image src="external_url" />` instead. This function will be removed in a future release.
- */
-export declare function getImageComponent(url: string, { width, height, request }: ImageOptions): Promise<{
-    value: string;
-    type: import("./ui/index.cjs").NodeType.Image;
-}>;
 //# sourceMappingURL=images.d.cts.map

package/dist/images.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"images.d.cts","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":"AAoCA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,mBAKpE;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,MAAM,EACX,EAAE,KAAK,EAAE,MAAc,EAAE,OAAO,EAAE,EAAE,YAAY;;;GAkBjD"}
+{"version":3,"file":"images.d.cts","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":"AAkCA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,mBAKpE"}

package/dist/images.d.mts

@@ -13,59 +13,10 @@
  *   </svg>
  * `;
  *
- * // Render the SVG in a Snap UI.
- * const ui = image(svg);
  * @param url - The URL to get the image data from.
  * @param options - The options to use when fetching the image data. This is
  * passed directly to `fetch`.
  * @returns A promise that resolves to the image data as a data-string.
  */
 export declare function getImageData(url: string, options?: RequestInit): Promise<string>;
-/**
- * Options for getting an SVG image element from a URL.
- *
- * @property width - The width of the image.
- * @property height - The height of the image. If this is not provided, the
- * width will be used as the height.
- * @property request - The options to use when fetching the image data. This is
- * passed directly to `fetch`.
- */
-export type ImageOptions = {
-    width: number;
-    height?: number;
-    request?: RequestInit;
-};
-/**
- * Get an image component from a URL. This is useful for embedding images inside
- * Snap UIs. Only JPEG and PNG images are supported.
- *
- * Note: This function uses `fetch` to get the image data. This means that using
- * it requires the `endowment:network-access` permission.
- *
- * @example
- * const component = await getImage('https://cataas.com/cat');
- *
- * return await snap.request({
- *   method: 'snap_dialog',
- *   params: {
- *     type: 'alert',
- *     content: panel([
- *       component,
- *     ]),
- *   },
- * });
- * @param url - The URL to get the image data from.
- * @param options - The options to use when fetching and rendering the image.
- * @param options.width - The width of the image.
- * @param options.height - The height of the image. If this is not provided, the
- * width will be used as the height.
- * @param options.request - The options to use when fetching the image data.
- * This is passed directly to `fetch`.
- * @returns A promise that resolves to the image data as an image component.
- * @deprecated Use `<Image src="external_url" />` instead. This function will be removed in a future release.
- */
-export declare function getImageComponent(url: string, { width, height, request }: ImageOptions): Promise<{
-    value: string;
-    type: import("./ui/index.mjs").NodeType.Image;
-}>;
 //# sourceMappingURL=images.d.mts.map

package/dist/images.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"images.d.mts","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":"AAoCA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,mBAKpE;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,MAAM,EACX,EAAE,KAAK,EAAE,MAAc,EAAE,OAAO,EAAE,EAAE,YAAY;;;GAkBjD"}
+{"version":3,"file":"images.d.mts","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":"AAkCA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,mBAKpE"}

package/dist/images.mjs

@@ -1,5 +1,4 @@
 import { assert, bytesToBase64 } from "@metamask/utils";
-import { image } from "./ui/index.mjs";
 /**
  * Get raw image data from a URL.
  *
@@ -36,8 +35,6 @@ async function getRawImageData(url, options) {
  *   </svg>
  * `;
  *
- * // Render the SVG in a Snap UI.
- * const ui = image(svg);
  * @param url - The URL to get the image data from.
  * @param options - The options to use when fetching the image data. This is
  * passed directly to `fetch`.
@@ -48,40 +45,4 @@ export async function getImageData(url, options) {
     const bytes = new Uint8Array(await blob.arrayBuffer());
     return `data:${blob.type};base64,${bytesToBase64(bytes)}`;
 }
-/**
- * Get an image component from a URL. This is useful for embedding images inside
- * Snap UIs. Only JPEG and PNG images are supported.
- *
- * Note: This function uses `fetch` to get the image data. This means that using
- * it requires the `endowment:network-access` permission.
- *
- * @example
- * const component = await getImage('https://cataas.com/cat');
- *
- * return await snap.request({
- *   method: 'snap_dialog',
- *   params: {
- *     type: 'alert',
- *     content: panel([
- *       component,
- *     ]),
- *   },
- * });
- * @param url - The URL to get the image data from.
- * @param options - The options to use when fetching and rendering the image.
- * @param options.width - The width of the image.
- * @param options.height - The height of the image. If this is not provided, the
- * width will be used as the height.
- * @param options.request - The options to use when fetching the image data.
- * This is passed directly to `fetch`.
- * @returns A promise that resolves to the image data as an image component.
- * @deprecated Use `<Image src="external_url" />` instead. This function will be removed in a future release.
- */
-export async function getImageComponent(url, { width, height = width, request }) {
-    assert(typeof width === 'number' && width > 0, 'Expected width to be a number greater than 0.');
-    assert(typeof height === 'number' && height > 0, 'Expected height to be a number greater than 0.');
-    const imageData = await getImageData(url, request);
-    const size = `width="${width}" height="${height}"`;
-    return image(`<svg ${size.trim()} xmlns="http://www.w3.org/2000/svg"><image ${size.trim()} href="${imageData}" /></svg>`);
-}
 //# sourceMappingURL=images.mjs.map

package/dist/images.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"images.mjs","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,wBAAwB;AAExD,OAAO,EAAE,KAAK,EAAE,uBAAa;AAE7B;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,OAAqB;IAC/D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,4EAA4E,CACpH,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACjD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,MAAM,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CACtF,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,MAAM,CACJ,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EACvD,gDAAgD,CACjD,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,OAAqB;IACnE,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvD,OAAO,QAAQ,IAAI,CAAC,IAAI,WAAW,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;AAC5D,CAAC;AAiBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,GAAW,EACX,EAAE,KAAK,EAAE,MAAM,GAAG,KAAK,EAAE,OAAO,EAAgB;IAEhD,MAAM,CACJ,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,EACtC,+CAA+C,CAChD,CAAC;IAEF,MAAM,CACJ,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,GAAG,CAAC,EACxC,gDAAgD,CACjD,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACnD,MAAM,IAAI,GAAG,UAAU,KAAK,aAAa,MAAM,GAAG,CAAC;IAEnD,OAAO,KAAK,CACV,QAAQ,IAAI,CAAC,IAAI,EAAE,8CAA8C,IAAI,CAAC,IAAI,EAAE,UAAU,SAAS,YAAY,CAC5G,CAAC;AACJ,CAAC","sourcesContent":["import { assert, bytesToBase64 } from '@metamask/utils';\n\nimport { image } from './ui';\n\n/**\n * Get raw image data from a URL.\n *\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a blob.\n */\nasync function getRawImageData(url: string, options?: RequestInit) {\n  if (typeof fetch !== 'function') {\n    throw new Error(\n      `Failed to fetch image data from \"${url}\": Using this function requires the \"endowment:network-access\" permission.`,\n    );\n  }\n\n  return fetch(url, options).then(async (response) => {\n    if (!response.ok) {\n      throw new Error(\n        `Failed to fetch image data from \"${url}\": ${response.status} ${response.statusText}`,\n      );\n    }\n\n    const blob = await response.blob();\n    assert(\n      blob.type === 'image/jpeg' || blob.type === 'image/png',\n      'Expected image data to be a JPEG or PNG image.',\n    );\n\n    return blob;\n  });\n}\n\n/**\n * Get image data as data-string from a URL. This is useful for embedding images\n * inside of SVGs. Only JPEG and PNG images are supported.\n *\n * Note: This function uses `fetch` to get the image data. This means that using\n * it requires the `endowment:network-access` permission.\n *\n * @example\n * const imageData = await getImageData('https://cataas.com/cat');\n * const svg = `\n *   <svg width=\"100\" height=\"100\" xmlns=\"http://www.w3.org/2000/svg\">\n *     <image href=\"${imageData}\" />\n *   </svg>\n * `;\n *\n * // Render the SVG in a Snap UI.\n * const ui = image(svg);\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a data-string.\n */\nexport async function getImageData(url: string, options?: RequestInit) {\n  const blob = await getRawImageData(url, options);\n  const bytes = new Uint8Array(await blob.arrayBuffer());\n\n  return `data:${blob.type};base64,${bytesToBase64(bytes)}`;\n}\n\n/**\n * Options for getting an SVG image element from a URL.\n *\n * @property width - The width of the image.\n * @property height - The height of the image. If this is not provided, the\n * width will be used as the height.\n * @property request - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n */\nexport type ImageOptions = {\n  width: number;\n  height?: number;\n  request?: RequestInit;\n};\n\n/**\n * Get an image component from a URL. This is useful for embedding images inside\n * Snap UIs. Only JPEG and PNG images are supported.\n *\n * Note: This function uses `fetch` to get the image data. This means that using\n * it requires the `endowment:network-access` permission.\n *\n * @example\n * const component = await getImage('https://cataas.com/cat');\n *\n * return await snap.request({\n *   method: 'snap_dialog',\n *   params: {\n *     type: 'alert',\n *     content: panel([\n *       component,\n *     ]),\n *   },\n * });\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching and rendering the image.\n * @param options.width - The width of the image.\n * @param options.height - The height of the image. If this is not provided, the\n * width will be used as the height.\n * @param options.request - The options to use when fetching the image data.\n * This is passed directly to `fetch`.\n * @returns A promise that resolves to the image data as an image component.\n * @deprecated Use `<Image src=\"external_url\" />` instead. This function will be removed in a future release.\n */\nexport async function getImageComponent(\n  url: string,\n  { width, height = width, request }: ImageOptions,\n) {\n  assert(\n    typeof width === 'number' && width > 0,\n    'Expected width to be a number greater than 0.',\n  );\n\n  assert(\n    typeof height === 'number' && height > 0,\n    'Expected height to be a number greater than 0.',\n  );\n\n  const imageData = await getImageData(url, request);\n  const size = `width=\"${width}\" height=\"${height}\"`;\n\n  return image(\n    `<svg ${size.trim()} xmlns=\"http://www.w3.org/2000/svg\"><image ${size.trim()} href=\"${imageData}\" /></svg>`,\n  );\n}\n"]}
+{"version":3,"file":"images.mjs","sourceRoot":"","sources":["../src/images.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,wBAAwB;AAExD;;;;;;;GAOG;AACH,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,OAAqB;IAC/D,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,4EAA4E,CACpH,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QACjD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CACb,oCAAoC,GAAG,MAAM,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE,CACtF,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,MAAM,CACJ,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EACvD,gDAAgD,CACjD,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,OAAqB;IACnE,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvD,OAAO,QAAQ,IAAI,CAAC,IAAI,WAAW,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;AAC5D,CAAC","sourcesContent":["import { assert, bytesToBase64 } from '@metamask/utils';\n\n/**\n * Get raw image data from a URL.\n *\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a blob.\n */\nasync function getRawImageData(url: string, options?: RequestInit) {\n  if (typeof fetch !== 'function') {\n    throw new Error(\n      `Failed to fetch image data from \"${url}\": Using this function requires the \"endowment:network-access\" permission.`,\n    );\n  }\n\n  return fetch(url, options).then(async (response) => {\n    if (!response.ok) {\n      throw new Error(\n        `Failed to fetch image data from \"${url}\": ${response.status} ${response.statusText}`,\n      );\n    }\n\n    const blob = await response.blob();\n    assert(\n      blob.type === 'image/jpeg' || blob.type === 'image/png',\n      'Expected image data to be a JPEG or PNG image.',\n    );\n\n    return blob;\n  });\n}\n\n/**\n * Get image data as data-string from a URL. This is useful for embedding images\n * inside of SVGs. Only JPEG and PNG images are supported.\n *\n * Note: This function uses `fetch` to get the image data. This means that using\n * it requires the `endowment:network-access` permission.\n *\n * @example\n * const imageData = await getImageData('https://cataas.com/cat');\n * const svg = `\n *   <svg width=\"100\" height=\"100\" xmlns=\"http://www.w3.org/2000/svg\">\n *     <image href=\"${imageData}\" />\n *   </svg>\n * `;\n *\n * @param url - The URL to get the image data from.\n * @param options - The options to use when fetching the image data. This is\n * passed directly to `fetch`.\n * @returns A promise that resolves to the image data as a data-string.\n */\nexport async function getImageData(url: string, options?: RequestInit) {\n  const blob = await getRawImageData(url, options);\n  const bytes = new Uint8Array(await blob.arrayBuffer());\n\n  return `data:${blob.type};base64,${bytesToBase64(bytes)}`;\n}\n"]}

package/dist/index.cjs

@@ -1,4 +1,12 @@
 "use strict";
+/**
+ * The main entry point for the Snaps SDK, which can be accessed by importing
+ * from `@metamask/snaps-sdk`.
+ *
+ * @module Main
+ * @primaryExport
+ * @showGroups
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAGA,mDAcqB;AAbnB,yGAAA,YAAY,OAAA;AACZ,4GAAA,eAAe,OAAA;AACf,0GAAA,aAAa,OAAA;AACb,4GAAA,eAAe,OAAA;AACf,+GAAA,kBAAkB,OAAA;AAClB,oGAAA,OAAO,OAAA;AACP,kGAAA,KAAK,OAAA;AACL,sGAAA,SAAS,OAAA;AACT,uGAAA,UAAU,OAAA;AACV,2GAAA,cAAc,OAAA;AACd,2GAAA,cAAc,OAAA;AACd,8GAAA,iBAAiB,OAAA;AACjB,gGAAA,GAAG,OAAA;AAUL,yCAAyC;AAAhC,+FAAA,MAAM,OAAA;AAEf,+CAAyB;AACzB,uDAAiC;AACjC,+CAAyB;AACzB,oDAAwB;AACxB,iDAAqB","sourcesContent":["// Only internals that are used by other Snaps packages should be exported here.\nexport type { EnumToUnion } from './internals';\nexport type { UriOptions } from './internals';\nexport {\n  getErrorData,\n  getErrorMessage,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n  literal,\n  union,\n  enumValue,\n  typedUnion,\n  selectiveUnion,\n  nonEmptyRecord,\n  ISO8601DateStruct,\n  uri,\n} from './internals';\n\n// Re-exported from `@metamask/utils` for convenience.\nexport type {\n  Json,\n  JsonRpcError,\n  JsonRpcRequest,\n  JsonRpcParams,\n} from '@metamask/utils';\nexport { assert } from '@metamask/utils';\n\nexport * from './errors';\nexport * from './error-wrappers';\nexport * from './images';\nexport * from './types';\nexport * from './ui';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;;;;;;;;;;;;;AAKH,mDAcqB;AAbnB,yGAAA,YAAY,OAAA;AACZ,4GAAA,eAAe,OAAA;AACf,0GAAA,aAAa,OAAA;AACb,4GAAA,eAAe,OAAA;AACf,+GAAA,kBAAkB,OAAA;AAClB,oGAAA,OAAO,OAAA;AACP,kGAAA,KAAK,OAAA;AACL,sGAAA,SAAS,OAAA;AACT,uGAAA,UAAU,OAAA;AACV,2GAAA,cAAc,OAAA;AACd,2GAAA,cAAc,OAAA;AACd,8GAAA,iBAAiB,OAAA;AACjB,gGAAA,GAAG,OAAA;AAUL,yCAAyC;AAAhC,+FAAA,MAAM,OAAA;AAEf,+CAAyB;AACzB,uDAAiC;AACjC,+CAAyB;AACzB,oDAAwB;AACxB,iDAAqB","sourcesContent":["/**\n * The main entry point for the Snaps SDK, which can be accessed by importing\n * from `@metamask/snaps-sdk`.\n *\n * @module Main\n * @primaryExport\n * @showGroups\n */\n\n// Only internals that are used by other Snaps packages should be exported here.\nexport type { EnumToUnion } from './internals';\nexport type { UriOptions } from './internals';\nexport {\n  getErrorData,\n  getErrorMessage,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n  literal,\n  union,\n  enumValue,\n  typedUnion,\n  selectiveUnion,\n  nonEmptyRecord,\n  ISO8601DateStruct,\n  uri,\n} from './internals';\n\n// Re-exported from `@metamask/utils` for convenience.\nexport type {\n  Json,\n  JsonRpcError,\n  JsonRpcRequest,\n  JsonRpcParams,\n} from '@metamask/utils';\nexport { assert } from '@metamask/utils';\n\nexport * from './errors';\nexport * from './error-wrappers';\nexport * from './images';\nexport * from './types';\nexport * from './ui';\n"]}

package/dist/index.d.cts

@@ -1,3 +1,11 @@
+/**
+ * The main entry point for the Snaps SDK, which can be accessed by importing
+ * from `@metamask/snaps-sdk`.
+ *
+ * @module Main
+ * @primaryExport
+ * @showGroups
+ */
 export type { EnumToUnion } from "./internals/index.cjs";
 export type { UriOptions } from "./internals/index.cjs";
 export { getErrorData, getErrorMessage, getErrorStack, SNAP_ERROR_CODE, SNAP_ERROR_MESSAGE, literal, union, enumValue, typedUnion, selectiveUnion, nonEmptyRecord, ISO8601DateStruct, uri, } from "./internals/index.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,WAAW,EAAE,8BAAoB;AAC/C,YAAY,EAAE,UAAU,EAAE,8BAAoB;AAC9C,OAAO,EACL,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,OAAO,EACP,KAAK,EACL,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,GAAG,GACJ,8BAAoB;AAGrB,YAAY,EACV,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,aAAa,GACd,wBAAwB;AACzB,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,6BAAyB;AACzB,qCAAiC;AACjC,6BAAyB;AACzB,kCAAwB;AACxB,+BAAqB"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,YAAY,EAAE,WAAW,EAAE,8BAAoB;AAC/C,YAAY,EAAE,UAAU,EAAE,8BAAoB;AAC9C,OAAO,EACL,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,OAAO,EACP,KAAK,EACL,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,GAAG,GACJ,8BAAoB;AAGrB,YAAY,EACV,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,aAAa,GACd,wBAAwB;AACzB,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,6BAAyB;AACzB,qCAAiC;AACjC,6BAAyB;AACzB,kCAAwB;AACxB,+BAAqB"}

package/dist/index.d.mts

@@ -1,3 +1,11 @@
+/**
+ * The main entry point for the Snaps SDK, which can be accessed by importing
+ * from `@metamask/snaps-sdk`.
+ *
+ * @module Main
+ * @primaryExport
+ * @showGroups
+ */
 export type { EnumToUnion } from "./internals/index.mjs";
 export type { UriOptions } from "./internals/index.mjs";
 export { getErrorData, getErrorMessage, getErrorStack, SNAP_ERROR_CODE, SNAP_ERROR_MESSAGE, literal, union, enumValue, typedUnion, selectiveUnion, nonEmptyRecord, ISO8601DateStruct, uri, } from "./internals/index.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,WAAW,EAAE,8BAAoB;AAC/C,YAAY,EAAE,UAAU,EAAE,8BAAoB;AAC9C,OAAO,EACL,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,OAAO,EACP,KAAK,EACL,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,GAAG,GACJ,8BAAoB;AAGrB,YAAY,EACV,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,aAAa,GACd,wBAAwB;AACzB,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,6BAAyB;AACzB,qCAAiC;AACjC,6BAAyB;AACzB,kCAAwB;AACxB,+BAAqB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,YAAY,EAAE,WAAW,EAAE,8BAAoB;AAC/C,YAAY,EAAE,UAAU,EAAE,8BAAoB;AAC9C,OAAO,EACL,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,OAAO,EACP,KAAK,EACL,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,GAAG,GACJ,8BAAoB;AAGrB,YAAY,EACV,IAAI,EACJ,YAAY,EACZ,cAAc,EACd,aAAa,GACd,wBAAwB;AACzB,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,6BAAyB;AACzB,qCAAiC;AACjC,6BAAyB;AACzB,kCAAwB;AACxB,+BAAqB"}

package/dist/index.mjs

@@ -1,3 +1,11 @@
+/**
+ * The main entry point for the Snaps SDK, which can be accessed by importing
+ * from `@metamask/snaps-sdk`.
+ *
+ * @module Main
+ * @primaryExport
+ * @showGroups
+ */
 export { getErrorData, getErrorMessage, getErrorStack, SNAP_ERROR_CODE, SNAP_ERROR_MESSAGE, literal, union, enumValue, typedUnion, selectiveUnion, nonEmptyRecord, ISO8601DateStruct, uri } from "./internals/index.mjs";
 export { assert } from "@metamask/utils";
 export * from "./errors.mjs";

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,OAAO,EACP,KAAK,EACL,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,GAAG,EACJ,8BAAoB;AASrB,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,6BAAyB;AACzB,qCAAiC;AACjC,6BAAyB;AACzB,kCAAwB;AACxB,+BAAqB","sourcesContent":["// Only internals that are used by other Snaps packages should be exported here.\nexport type { EnumToUnion } from './internals';\nexport type { UriOptions } from './internals';\nexport {\n  getErrorData,\n  getErrorMessage,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n  literal,\n  union,\n  enumValue,\n  typedUnion,\n  selectiveUnion,\n  nonEmptyRecord,\n  ISO8601DateStruct,\n  uri,\n} from './internals';\n\n// Re-exported from `@metamask/utils` for convenience.\nexport type {\n  Json,\n  JsonRpcError,\n  JsonRpcRequest,\n  JsonRpcParams,\n} from '@metamask/utils';\nexport { assert } from '@metamask/utils';\n\nexport * from './errors';\nexport * from './error-wrappers';\nexport * from './images';\nexport * from './types';\nexport * from './ui';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAKH,OAAO,EACL,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,OAAO,EACP,KAAK,EACL,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,iBAAiB,EACjB,GAAG,EACJ,8BAAoB;AASrB,OAAO,EAAE,MAAM,EAAE,wBAAwB;AAEzC,6BAAyB;AACzB,qCAAiC;AACjC,6BAAyB;AACzB,kCAAwB;AACxB,+BAAqB","sourcesContent":["/**\n * The main entry point for the Snaps SDK, which can be accessed by importing\n * from `@metamask/snaps-sdk`.\n *\n * @module Main\n * @primaryExport\n * @showGroups\n */\n\n// Only internals that are used by other Snaps packages should be exported here.\nexport type { EnumToUnion } from './internals';\nexport type { UriOptions } from './internals';\nexport {\n  getErrorData,\n  getErrorMessage,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n  literal,\n  union,\n  enumValue,\n  typedUnion,\n  selectiveUnion,\n  nonEmptyRecord,\n  ISO8601DateStruct,\n  uri,\n} from './internals';\n\n// Re-exported from `@metamask/utils` for convenience.\nexport type {\n  Json,\n  JsonRpcError,\n  JsonRpcRequest,\n  JsonRpcParams,\n} from '@metamask/utils';\nexport { assert } from '@metamask/utils';\n\nexport * from './errors';\nexport * from './error-wrappers';\nexport * from './images';\nexport * from './types';\nexport * from './ui';\n"]}