@metamask/snaps-utils 6.1.0 → 7.0.0

package/dist/chunk-XRGYWWT7.js

@@ -0,0 +1,151 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunkPHUTP7NBjs = require('./chunk-PHUTP7NB.js');
+
+// src/errors.ts
+
+
+
+
+var _rpcerrors = require('@metamask/rpc-errors');
+
+
+
+
+
+var _snapssdk = require('@metamask/snaps-sdk');
+var _utils = require('@metamask/utils');
+var SNAP_ERROR_WRAPPER_CODE = -31001;
+var SNAP_ERROR_WRAPPER_MESSAGE = "Wrapped Snap Error";
+var _error, _message, _stack;
+var WrappedSnapError = class extends Error {
+  /**
+   * Create a new `WrappedSnapError`.
+   *
+   * @param error - The error to create the `WrappedSnapError` from.
+   */
+  constructor(error) {
+    const message = _snapssdk.getErrorMessage.call(void 0, error);
+    super(message);
+    _chunkPHUTP7NBjs.__privateAdd.call(void 0, this, _error, void 0);
+    _chunkPHUTP7NBjs.__privateAdd.call(void 0, this, _message, void 0);
+    _chunkPHUTP7NBjs.__privateAdd.call(void 0, this, _stack, void 0);
+    _chunkPHUTP7NBjs.__privateSet.call(void 0, this, _error, error);
+    _chunkPHUTP7NBjs.__privateSet.call(void 0, this, _message, message);
+    _chunkPHUTP7NBjs.__privateSet.call(void 0, this, _stack, _snapssdk.getErrorStack.call(void 0, error));
+  }
+  /**
+   * The error name.
+   *
+   * @returns The error name.
+   */
+  get name() {
+    return "WrappedSnapError";
+  }
+  /**
+   * The error message.
+   *
+   * @returns The error message.
+   */
+  get message() {
+    return _chunkPHUTP7NBjs.__privateGet.call(void 0, this, _message);
+  }
+  /**
+   * The error stack.
+   *
+   * @returns The error stack.
+   */
+  get stack() {
+    return _chunkPHUTP7NBjs.__privateGet.call(void 0, this, _stack);
+  }
+  /**
+   * Convert the error to a JSON object.
+   *
+   * @returns The JSON object.
+   */
+  toJSON() {
+    const cause = isSnapError(_chunkPHUTP7NBjs.__privateGet.call(void 0, this, _error)) ? _chunkPHUTP7NBjs.__privateGet.call(void 0, this, _error).serialize() : _rpcerrors.serializeCause.call(void 0, _chunkPHUTP7NBjs.__privateGet.call(void 0, this, _error));
+    return {
+      code: SNAP_ERROR_WRAPPER_CODE,
+      message: SNAP_ERROR_WRAPPER_MESSAGE,
+      data: {
+        cause
+      }
+    };
+  }
+  /**
+   * Serialize the error to a JSON object. This is called by
+   * `@metamask/rpc-errors` when serializing the error.
+   *
+   * @returns The JSON object.
+   */
+  serialize() {
+    return this.toJSON();
+  }
+};
+_error = new WeakMap();
+_message = new WeakMap();
+_stack = new WeakMap();
+function isSnapError(error) {
+  if (_utils.isObject.call(void 0, error) && "serialize" in error && typeof error.serialize === "function") {
+    const serialized = error.serialize();
+    return _utils.isJsonRpcError.call(void 0, serialized) && isSerializedSnapError(serialized);
+  }
+  return false;
+}
+function isSerializedSnapError(error) {
+  return error.code === _snapssdk.SNAP_ERROR_CODE && error.message === _snapssdk.SNAP_ERROR_MESSAGE;
+}
+function isWrappedSnapError(error) {
+  return _utils.isJsonRpcError.call(void 0, error) && error.code === SNAP_ERROR_WRAPPER_CODE && error.message === SNAP_ERROR_WRAPPER_MESSAGE;
+}
+function getJsonRpcError(code, message, stack, data) {
+  const error = new (0, _rpcerrors.JsonRpcError)(code, message, data);
+  error.stack = stack;
+  return error;
+}
+function unwrapError(error) {
+  if (isWrappedSnapError(error)) {
+    if (_utils.isJsonRpcError.call(void 0, error.data.cause)) {
+      if (isSerializedSnapError(error.data.cause)) {
+        const { code: code2, message: message2, stack: stack2, data: data2 } = error.data.cause.data.cause;
+        return [getJsonRpcError(code2, message2, stack2, data2), true];
+      }
+      const { code, message, stack, data } = error.data.cause;
+      return [getJsonRpcError(code, message, stack, data), false];
+    }
+    return [
+      getJsonRpcError(
+        _rpcerrors.errorCodes.rpc.internal,
+        _snapssdk.getErrorMessage.call(void 0, error.data.cause),
+        _snapssdk.getErrorStack.call(void 0, error.data.cause)
+      ),
+      false
+    ];
+  }
+  if (_utils.isJsonRpcError.call(void 0, error)) {
+    const { code, message, stack, data } = error;
+    return [getJsonRpcError(code, message, stack, data), false];
+  }
+  return [
+    getJsonRpcError(
+      _rpcerrors.errorCodes.rpc.internal,
+      _snapssdk.getErrorMessage.call(void 0, error),
+      _snapssdk.getErrorStack.call(void 0, error)
+    ),
+    false
+  ];
+}
+
+
+
+
+
+
+
+
+
+exports.SNAP_ERROR_WRAPPER_CODE = SNAP_ERROR_WRAPPER_CODE; exports.SNAP_ERROR_WRAPPER_MESSAGE = SNAP_ERROR_WRAPPER_MESSAGE; exports.WrappedSnapError = WrappedSnapError; exports.isSnapError = isSnapError; exports.isSerializedSnapError = isSerializedSnapError; exports.isWrappedSnapError = isWrappedSnapError; exports.unwrapError = unwrapError;
+//# sourceMappingURL=chunk-XRGYWWT7.js.map

package/dist/chunk-XRGYWWT7.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors.ts"],"names":["code","message","stack","data"],"mappings":";;;;;;;AAAA;AAAA,EACE;AAAA,EACA,gBAAgB;AAAA,EAChB;AAAA,OACK;AAGP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,UAAU,sBAAsB;AAElC,IAAM,0BAA0B;AAChC,IAAM,6BAA6B;AAjB1C;AA2BO,IAAM,mBAAN,cAA+B,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY1C,YAAY,OAAgB;AAC1B,UAAM,UAAU,gBAAgB,KAAK;AACrC,UAAM,OAAO;AAbf,uBAAS,QAAT;AAEA,uBAAS,UAAT;AAEA,uBAAS,QAAT;AAWE,uBAAK,QAAS;AACd,uBAAK,UAAW;AAChB,uBAAK,QAAS,cAAc,KAAK;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,OAAO;AACT,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,UAAU;AACZ,WAAO,mBAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,QAAQ;AACV,WAAO,mBAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAqC;AACnC,UAAM,QAAQ,YAAY,mBAAK,OAAM,IACjC,mBAAK,QAAO,UAAU,IACtB,eAAe,mBAAK,OAAM;AAE9B,WAAO;AAAA,MACL,MAAM;AAAA,MACN,SAAS;AAAA,MACT,MAAM;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,YAAY;AACV,WAAO,KAAK,OAAO;AAAA,EACrB;AACF;AA3EW;AAEA;AAEA;AA+EJ,SAAS,YAAY,OAAoC;AAC9D,MACE,SAAS,KAAK,KACd,eAAe,SACf,OAAO,MAAM,cAAc,YAC3B;AACA,UAAM,aAAa,MAAM,UAAU;AACnC,WAAO,eAAe,UAAU,KAAK,sBAAsB,UAAU;AAAA,EACvE;AAEA,SAAO;AACT;AAQO,SAAS,sBACd,OAC8B;AAC9B,SAAO,MAAM,SAAS,mBAAmB,MAAM,YAAY;AAC7D;AAQO,SAAS,mBACd,OACqC;AACrC,SACE,eAAe,KAAK,KACpB,MAAM,SAAS,2BACf,MAAM,YAAY;AAEtB;AAWA,SAAS,gBACP,MACA,SACA,OACA,MACA;AACA,QAAM,QAAQ,IAAI,SAAS,MAAM,SAAS,IAAI;AAC9C,QAAM,QAAQ;AAEd,SAAO;AACT;AAWO,SAAS,YACd,OAC8D;AAK9D,MAAI,mBAAmB,KAAK,GAAG;AAG7B,QAAI,eAAe,MAAM,KAAK,KAAK,GAAG;AAEpC,UAAI,sBAAsB,MAAM,KAAK,KAAK,GAAG;AAC3C,cAAM,EAAE,MAAAA,OAAM,SAAAC,UAAS,OAAAC,QAAO,MAAAC,MAAK,IAAI,MAAM,KAAK,MAAM,KAAK;AAC7D,eAAO,CAAC,gBAAgBH,OAAMC,UAASC,QAAOC,KAAI,GAAG,IAAI;AAAA,MAC3D;AAGA,YAAM,EAAE,MAAM,SAAS,OAAO,KAAK,IAAI,MAAM,KAAK;AAClD,aAAO,CAAC,gBAAgB,MAAM,SAAS,OAAO,IAAI,GAAG,KAAK;AAAA,IAC5D;AAIA,WAAO;AAAA,MACL;AAAA,QACE,WAAW,IAAI;AAAA,QACf,gBAAgB,MAAM,KAAK,KAAK;AAAA,QAChC,cAAc,MAAM,KAAK,KAAK;AAAA,MAChC;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAIA,MAAI,eAAe,KAAK,GAAG;AACzB,UAAM,EAAE,MAAM,SAAS,OAAO,KAAK,IAAI;AACvC,WAAO,CAAC,gBAAgB,MAAM,SAAS,OAAO,IAAI,GAAG,KAAK;AAAA,EAC5D;AAIA,SAAO;AAAA,IACL;AAAA,MACE,WAAW,IAAI;AAAA,MACf,gBAAgB,KAAK;AAAA,MACrB,cAAc,KAAK;AAAA,IACrB;AAAA,IACA;AAAA,EACF;AACF","sourcesContent":["import {\n  errorCodes,\n  JsonRpcError as RpcError,\n  serializeCause,\n} from '@metamask/rpc-errors';\nimport type { DataWithOptionalCause } from '@metamask/rpc-errors';\nimport type { SerializedSnapError, SnapError } from '@metamask/snaps-sdk';\nimport {\n  getErrorMessage,\n  getErrorStack,\n  SNAP_ERROR_CODE,\n  SNAP_ERROR_MESSAGE,\n} from '@metamask/snaps-sdk';\nimport type { Json, JsonRpcError } from '@metamask/utils';\nimport { isObject, isJsonRpcError } from '@metamask/utils';\n\nexport const SNAP_ERROR_WRAPPER_CODE = -31001;\nexport const SNAP_ERROR_WRAPPER_MESSAGE = 'Wrapped Snap Error';\n\nexport type SerializedSnapErrorWrapper = {\n  code: typeof SNAP_ERROR_WRAPPER_CODE;\n  message: typeof SNAP_ERROR_WRAPPER_MESSAGE;\n  data: {\n    cause: Json;\n  };\n};\n\nexport class WrappedSnapError extends Error {\n  readonly #error: unknown;\n\n  readonly #message: string;\n\n  readonly #stack?: string;\n\n  /**\n   * Create a new `WrappedSnapError`.\n   *\n   * @param error - The error to create the `WrappedSnapError` from.\n   */\n  constructor(error: unknown) {\n    const message = getErrorMessage(error);\n    super(message);\n\n    this.#error = error;\n    this.#message = message;\n    this.#stack = getErrorStack(error);\n  }\n\n  /**\n   * The error name.\n   *\n   * @returns The error name.\n   */\n  get name() {\n    return 'WrappedSnapError';\n  }\n\n  /**\n   * The error message.\n   *\n   * @returns The error message.\n   */\n  get message() {\n    return this.#message;\n  }\n\n  /**\n   * The error stack.\n   *\n   * @returns The error stack.\n   */\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(): SerializedSnapErrorWrapper {\n    const cause = isSnapError(this.#error)\n      ? this.#error.serialize()\n      : serializeCause(this.#error);\n\n    return {\n      code: SNAP_ERROR_WRAPPER_CODE,\n      message: SNAP_ERROR_WRAPPER_MESSAGE,\n      data: {\n        cause,\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 * 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\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 a JSON-RPC error is a `WrappedSnapError`.\n *\n * @param error - The object to check.\n * @returns Whether the object is a `WrappedSnapError`.\n */\nexport function isWrappedSnapError(\n  error: unknown,\n): error is SerializedSnapErrorWrapper {\n  return (\n    isJsonRpcError(error) &&\n    error.code === SNAP_ERROR_WRAPPER_CODE &&\n    error.message === SNAP_ERROR_WRAPPER_MESSAGE\n  );\n}\n\n/**\n * Get a JSON-RPC error with the given code, message, stack, and data.\n *\n * @param code - The error code.\n * @param message - The error message.\n * @param stack - The error stack.\n * @param data - Additional data for the error.\n * @returns The JSON-RPC error.\n */\nfunction getJsonRpcError(\n  code: number,\n  message: string,\n  stack?: string,\n  data?: Json,\n) {\n  const error = new RpcError(code, message, data);\n  error.stack = stack;\n\n  return error;\n}\n\n/**\n * Attempt to unwrap an unknown error to a `JsonRpcError`. This function will\n * try to get the error code, message, and data from the error, and return a\n * `JsonRpcError` with those properties.\n *\n * @param error - The error to unwrap.\n * @returns A tuple containing the unwrapped error and a boolean indicating\n * whether the error was handled.\n */\nexport function unwrapError(\n  error: unknown,\n): [error: RpcError<DataWithOptionalCause>, isHandled: boolean] {\n  // This logic is a bit complicated, but it's necessary to handle all the\n  // different types of errors that can be thrown by a Snap.\n\n  // If the error is a wrapped Snap error, unwrap it.\n  if (isWrappedSnapError(error)) {\n    // The wrapped error can be a JSON-RPC error, or an unknown error. If it's\n    // a JSON-RPC error, we can unwrap it further.\n    if (isJsonRpcError(error.data.cause)) {\n      // If the JSON-RPC error is a wrapped Snap error, unwrap it further.\n      if (isSerializedSnapError(error.data.cause)) {\n        const { code, message, stack, data } = error.data.cause.data.cause;\n        return [getJsonRpcError(code, message, stack, data), true];\n      }\n\n      // Otherwise, we use the original JSON-RPC error.\n      const { code, message, stack, data } = error.data.cause;\n      return [getJsonRpcError(code, message, stack, data), false];\n    }\n\n    // Otherwise, we throw an internal error with the wrapped error as the\n    // message.\n    return [\n      getJsonRpcError(\n        errorCodes.rpc.internal,\n        getErrorMessage(error.data.cause),\n        getErrorStack(error.data.cause),\n      ),\n      false,\n    ];\n  }\n\n  // The error can be a non-wrapped JSON-RPC error, in which case we can just\n  // re-throw it with the same code, message, and data.\n  if (isJsonRpcError(error)) {\n    const { code, message, stack, data } = error;\n    return [getJsonRpcError(code, message, stack, data), false];\n  }\n\n  // If the error is not a wrapped error, we don't know how to handle it, so we\n  // throw an internal error with the error as the message.\n  return [\n    getJsonRpcError(\n      errorCodes.rpc.internal,\n      getErrorMessage(error),\n      getErrorStack(error),\n    ),\n    false,\n  ];\n}\n"]}

package/dist/chunk-XWFKTDB3.js

@@ -0,0 +1,50 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
+
+var _chunkQ7FGULTVjs = require('./chunk-Q7FGULTV.js');
+
+// src/virtual-file/VirtualFile.ts
+var _utils = require('@metamask/utils');
+var _base = require('@scure/base');
+var VirtualFile = class _VirtualFile {
+  constructor(value) {
+    let options;
+    if (typeof value === "string" || value instanceof Uint8Array) {
+      options = { value };
+    } else {
+      options = value;
+    }
+    this.value = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _ => _.value]), () => ( ""));
+    this.result = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _2 => _2.result]), () => ( void 0));
+    this.data = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _3 => _3.data]), () => ( {}));
+    this.path = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _4 => _4.path]), () => ( "/"));
+  }
+  toString(encoding) {
+    if (typeof this.value === "string") {
+      _utils.assert.call(void 0, encoding === void 0, "Tried to encode string.");
+      return this.value;
+    } else if (this.value instanceof Uint8Array && encoding === "hex") {
+      return _utils.bytesToHex.call(void 0, this.value);
+    } else if (this.value instanceof Uint8Array && encoding === "base64") {
+      return _base.base64.encode(this.value);
+    }
+    const decoder = new TextDecoder(encoding);
+    return decoder.decode(this.value);
+  }
+  clone() {
+    const vfile = new _VirtualFile();
+    if (typeof this.value === "string") {
+      vfile.value = this.value;
+    } else {
+      vfile.value = this.value.slice(0);
+    }
+    vfile.result = _chunkQ7FGULTVjs.deepClone.call(void 0, this.result);
+    vfile.data = _chunkQ7FGULTVjs.deepClone.call(void 0, this.data);
+    vfile.path = this.path;
+    return vfile;
+  }
+};
+
+
+
+exports.VirtualFile = VirtualFile;
+//# sourceMappingURL=chunk-XWFKTDB3.js.map

package/dist/chunk-XWFKTDB3.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/virtual-file/VirtualFile.ts"],"names":[],"mappings":";;;;;AAQA,SAAS,QAAQ,kBAAkB;AACnC,SAAS,cAAc;AAiChB,IAAM,cAAN,MAAM,aAA8B;AAAA,EACzC,YAAY,OAA4B;AACtC,QAAI;AACJ,QAAI,OAAO,UAAU,YAAY,iBAAiB,YAAY;AAC5D,gBAAU,EAAE,MAAM;AAAA,IACpB,OAAO;AACL,gBAAU;AAAA,IACZ;AAEA,SAAK,QAAQ,SAAS,SAAS;AAU/B,SAAK,SAAS,SAAS,UAAW;AAClC,SAAK,OAAO,SAAS,QAAQ,CAAC;AAC9B,SAAK,OAAO,SAAS,QAAQ;AAAA,EAC/B;AAAA,EAUA,SAAS,UAAmB;AAC1B,QAAI,OAAO,KAAK,UAAU,UAAU;AAClC,aAAO,aAAa,QAAW,yBAAyB;AACxD,aAAO,KAAK;AAAA,IACd,WAAW,KAAK,iBAAiB,cAAc,aAAa,OAAO;AACjE,aAAO,WAAW,KAAK,KAAK;AAAA,IAC9B,WAAW,KAAK,iBAAiB,cAAc,aAAa,UAAU;AAGpE,aAAO,OAAO,OAAO,KAAK,KAAK;AAAA,IACjC;AACA,UAAM,UAAU,IAAI,YAAY,QAAQ;AACxC,WAAO,QAAQ,OAAO,KAAK,KAAK;AAAA,EAClC;AAAA,EAEA,QAAQ;AACN,UAAM,QAAQ,IAAI,aAAoB;AACtC,QAAI,OAAO,KAAK,UAAU,UAAU;AAClC,YAAM,QAAQ,KAAK;AAAA,IACrB,OAAO;AAEL,YAAM,QAAQ,KAAK,MAAM,MAAM,CAAC;AAAA,IAClC;AACA,UAAM,SAAS,UAAU,KAAK,MAAM;AACpC,UAAM,OAAO,UAAU,KAAK,IAAI;AAChC,UAAM,OAAO,KAAK;AAClB,WAAO;AAAA,EACT;AACF","sourcesContent":["// TODO(ritave): Move into separate package @metamask/vfile / @metamask/utils + @metamask/to-vfile when passes code review\n// TODO(ritave): Streaming vfile contents similar to vinyl maybe?\n// TODO(ritave): Move fixing manifest in cli and bundler plugins to write messages to vfile\n//               similar to unified instead of throwing \"ProgrammaticallyFixableErrors\".\n//\n// Using https://github.com/vfile/vfile would be helpful, but they only support ESM and we need to support CommonJS.\n// https://github.com/gulpjs/vinyl is also good, but they normalize paths, which we can't do, because\n// we're calculating checksums based on original path.\nimport { assert, bytesToHex } from '@metamask/utils';\nimport { base64 } from '@scure/base';\n\nimport { deepClone } from '../deep-clone';\n\n/**\n * This map registers the type of the {@link VirtualFile.data} key of a {@link VirtualFile}.\n *\n * This type can be augmented to register custom `data` types.\n *\n * @example\n * declare module '@metamask/snaps-utils' {\n *   interface DataMap {\n *     // `file.data.name` is typed as `string`\n *     name: string\n *   }\n * }\n */\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions, @typescript-eslint/no-empty-interface\nexport interface DataMap {}\n\nexport type Value = string | Uint8Array;\nexport type Compatible<Result = unknown> =\n  | string\n  | Uint8Array\n  | Options<Result>;\nexport type Data = Record<string, unknown> & Partial<DataMap>;\nexport type Options<Result = unknown> = {\n  value: Value;\n  path?: string;\n  data?: Data;\n  result?: Result;\n};\n\nexport class VirtualFile<Result = unknown> {\n  constructor(value?: Compatible<Result>) {\n    let options: Options | undefined;\n    if (typeof value === 'string' || value instanceof Uint8Array) {\n      options = { value };\n    } else {\n      options = value;\n    }\n\n    this.value = options?.value ?? '';\n    // This situations happens when there's no .result used,\n    // we expect the file to have default generic in that situation:\n    // VirtualFile<unknown> which will handle undefined properly\n    //\n    // While not 100% type safe, it'll be way less frustrating to work with.\n    // The alternative would be to have VirtualFile.result be Result | undefined\n    // and that would result in needing to branch out and check in all situations.\n    //\n    // In short, optimizing for most common use case.\n    this.result = options?.result ?? (undefined as any);\n    this.data = options?.data ?? {};\n    this.path = options?.path ?? '/';\n  }\n\n  value: Value;\n\n  result: Result;\n\n  data: Data;\n\n  path: string;\n\n  toString(encoding?: string) {\n    if (typeof this.value === 'string') {\n      assert(encoding === undefined, 'Tried to encode string.');\n      return this.value;\n    } else if (this.value instanceof Uint8Array && encoding === 'hex') {\n      return bytesToHex(this.value);\n    } else if (this.value instanceof Uint8Array && encoding === 'base64') {\n      // For large files, this is quite slow, instead use `encodeBase64()`\n      // TODO: Use @metamask/utils for this\n      return base64.encode(this.value);\n    }\n    const decoder = new TextDecoder(encoding);\n    return decoder.decode(this.value);\n  }\n\n  clone() {\n    const vfile = new VirtualFile<Result>();\n    if (typeof this.value === 'string') {\n      vfile.value = this.value;\n    } else {\n      // deep-clone doesn't clone Buffer properly, even if it's a sub-class of Uint8Array\n      vfile.value = this.value.slice(0);\n    }\n    vfile.result = deepClone(this.result);\n    vfile.data = deepClone(this.data);\n    vfile.path = this.path;\n    return vfile;\n  }\n}\n"]}

package/dist/chunk-Y3F7VUZB.mjs

@@ -0,0 +1,409 @@
+import {
+  assertIsSnapManifest
+} from "./chunk-HWFLO7W5.mjs";
+import {
+  ProgrammaticallyFixableSnapError,
+  getSnapChecksum,
+  validateSnapShasum
+} from "./chunk-FJH6DDEL.mjs";
+import {
+  assertIsSnapIcon,
+  getSvgDimensions
+} from "./chunk-UGQQ5DJ4.mjs";
+import {
+  SnapValidationFailureReason,
+  assertIsNpmSnapPackageJson
+} from "./chunk-ZVXX2CTH.mjs";
+import {
+  getValidatedLocalizationFiles,
+  validateSnapManifestLocalizations
+} from "./chunk-N52KMB25.mjs";
+import {
+  readJsonFile
+} from "./chunk-32B4YQM7.mjs";
+import {
+  readVirtualFile
+} from "./chunk-HOTDTMNP.mjs";
+import {
+  VirtualFile
+} from "./chunk-LOW2T4MV.mjs";
+import {
+  deepClone
+} from "./chunk-B2DMAQNK.mjs";
+
+// src/manifest/manifest.ts
+import { getErrorMessage } from "@metamask/snaps-sdk";
+import { assertExhaustive, assert, isPlainObject } from "@metamask/utils";
+import deepEqual from "fast-deep-equal";
+import { promises as fs } from "fs";
+import pathUtils from "path";
+var MANIFEST_SORT_ORDER = {
+  $schema: 1,
+  version: 2,
+  description: 3,
+  proposedName: 4,
+  repository: 5,
+  source: 6,
+  initialConnections: 7,
+  initialPermissions: 8,
+  manifestVersion: 9
+};
+async function checkManifest(basePath, writeManifest = true, sourceCode, writeFileFn = fs.writeFile) {
+  const warnings = [];
+  const errors = [];
+  let updated = false;
+  const manifestPath = pathUtils.join(basePath, "snap.manifest.json" /* Manifest */);
+  const manifestFile = await readJsonFile(manifestPath);
+  const unvalidatedManifest = manifestFile.result;
+  const packageFile = await readJsonFile(
+    pathUtils.join(basePath, "package.json" /* PackageJson */)
+  );
+  const auxiliaryFilePaths = getSnapFilePaths(
+    unvalidatedManifest,
+    (manifest2) => manifest2?.source?.files
+  );
+  const localizationFilePaths = getSnapFilePaths(
+    unvalidatedManifest,
+    (manifest2) => manifest2?.source?.locales
+  );
+  const snapFiles = {
+    manifest: manifestFile,
+    packageJson: packageFile,
+    sourceCode: await getSnapSourceCode(
+      basePath,
+      unvalidatedManifest,
+      sourceCode
+    ),
+    svgIcon: await getSnapIcon(basePath, unvalidatedManifest),
+    // Intentionally pass null as the encoding here since the files may be binary
+    auxiliaryFiles: await getSnapFiles(basePath, auxiliaryFilePaths, null) ?? [],
+    localizationFiles: await getSnapFiles(basePath, localizationFilePaths) ?? []
+  };
+  let manifest;
+  try {
+    ({ manifest } = await validateNpmSnap(snapFiles));
+  } catch (error) {
+    if (error instanceof ProgrammaticallyFixableSnapError) {
+      errors.push(error.message);
+      const partiallyValidatedFiles = snapFiles;
+      let isInvalid = true;
+      let currentError = error;
+      const maxAttempts = Object.keys(SnapValidationFailureReason).length;
+      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {
+        manifest = await fixManifest(
+          manifest ? { ...partiallyValidatedFiles, manifest } : partiallyValidatedFiles,
+          currentError
+        );
+        try {
+          await validateNpmSnapManifest({
+            ...partiallyValidatedFiles,
+            manifest
+          });
+          isInvalid = false;
+        } catch (nextValidationError) {
+          currentError = nextValidationError;
+          if (!(nextValidationError instanceof ProgrammaticallyFixableSnapError) || attempts === maxAttempts && !isInvalid) {
+            throw new Error(
+              `Internal error: Failed to fix manifest. This is a bug, please report it. Reason:
+${error.message}`
+            );
+          }
+          errors.push(currentError.message);
+        }
+      }
+      updated = true;
+    } else {
+      throw error;
+    }
+  }
+  assert(manifest);
+  const validatedManifest = manifest.result;
+  const recommendedFields = ["repository"];
+  const missingRecommendedFields = recommendedFields.filter(
+    (key) => !validatedManifest[key]
+  );
+  if (missingRecommendedFields.length > 0) {
+    warnings.push(
+      `Missing recommended package.json properties:
+${missingRecommendedFields.reduce(
+        (allMissing, currentField) => {
+          return `${allMissing}	${currentField}
+`;
+        },
+        ""
+      )}`
+    );
+  }
+  if (!snapFiles.svgIcon) {
+    warnings.push(
+      "No icon found in the Snap manifest. It is recommended to include an icon for the Snap. See https://docs.metamask.io/snaps/how-to/design-a-snap/#guidelines-at-a-glance for more information."
+    );
+  }
+  const iconDimensions = snapFiles.svgIcon && getSvgDimensions(snapFiles.svgIcon.toString());
+  if (iconDimensions && iconDimensions.height !== iconDimensions.width) {
+    warnings.push(
+      "The icon in the Snap manifest is not square. It is recommended to use a square icon for the Snap."
+    );
+  }
+  if (writeManifest) {
+    try {
+      const newManifest = `${JSON.stringify(
+        getWritableManifest(validatedManifest),
+        null,
+        2
+      )}
+`;
+      if (updated || newManifest !== manifestFile.value) {
+        await writeFileFn(
+          pathUtils.join(basePath, "snap.manifest.json" /* Manifest */),
+          newManifest
+        );
+      }
+    } catch (error) {
+      throw new Error(`Failed to update snap.manifest.json: ${error.message}`);
+    }
+  }
+  return { manifest: validatedManifest, updated, warnings, errors };
+}
+async function fixManifest(snapFiles, error) {
+  const { manifest, packageJson } = snapFiles;
+  const clonedFile = manifest.clone();
+  const manifestCopy = clonedFile.result;
+  switch (error.reason) {
+    case '"name" field mismatch' /* NameMismatch */:
+      manifestCopy.source.location.npm.packageName = packageJson.result.name;
+      break;
+    case '"version" field mismatch' /* VersionMismatch */:
+      manifestCopy.version = packageJson.result.version;
+      break;
+    case '"repository" field mismatch' /* RepositoryMismatch */:
+      manifestCopy.repository = packageJson.result.repository ? deepClone(packageJson.result.repository) : void 0;
+      break;
+    case '"shasum" field mismatch' /* ShasumMismatch */:
+      manifestCopy.source.shasum = await getSnapChecksum(snapFiles);
+      break;
+    default:
+      assertExhaustive(error.reason);
+  }
+  clonedFile.result = manifestCopy;
+  clonedFile.value = JSON.stringify(manifestCopy);
+  return clonedFile;
+}
+async function getSnapSourceCode(basePath, manifest, sourceCode) {
+  if (!isPlainObject(manifest)) {
+    return void 0;
+  }
+  const sourceFilePath = manifest.source?.location?.npm?.filePath;
+  if (!sourceFilePath) {
+    return void 0;
+  }
+  if (sourceCode) {
+    return new VirtualFile({
+      path: pathUtils.join(basePath, sourceFilePath),
+      value: sourceCode
+    });
+  }
+  try {
+    const virtualFile = await readVirtualFile(
+      pathUtils.join(basePath, sourceFilePath),
+      "utf8"
+    );
+    return virtualFile;
+  } catch (error) {
+    throw new Error(
+      `Failed to read snap bundle file: ${getErrorMessage(error)}`
+    );
+  }
+}
+async function getSnapIcon(basePath, manifest) {
+  if (!isPlainObject(manifest)) {
+    return void 0;
+  }
+  const iconPath = manifest.source?.location?.npm?.iconPath;
+  if (!iconPath) {
+    return void 0;
+  }
+  try {
+    const virtualFile = await readVirtualFile(
+      pathUtils.join(basePath, iconPath),
+      "utf8"
+    );
+    return virtualFile;
+  } catch (error) {
+    throw new Error(`Failed to read snap icon file: ${getErrorMessage(error)}`);
+  }
+}
+function getSnapFilePaths(manifest, selector) {
+  if (!isPlainObject(manifest)) {
+    return void 0;
+  }
+  const snapManifest = manifest;
+  const paths = selector(snapManifest);
+  if (!Array.isArray(paths)) {
+    return void 0;
+  }
+  return paths;
+}
+async function getSnapFiles(basePath, paths, encoding = "utf8") {
+  if (!paths) {
+    return void 0;
+  }
+  try {
+    return await Promise.all(
+      paths.map(
+        async (filePath) => readVirtualFile(pathUtils.join(basePath, filePath), encoding)
+      )
+    );
+  } catch (error) {
+    throw new Error(`Failed to read snap files: ${getErrorMessage(error)}`);
+  }
+}
+function getWritableManifest(manifest) {
+  const { repository, ...remaining } = manifest;
+  const keys = Object.keys(
+    repository ? { ...remaining, repository } : remaining
+  );
+  const writableManifest = keys.sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b]).reduce(
+    (result, key) => ({
+      ...result,
+      [key]: manifest[key]
+    }),
+    {}
+  );
+  return writableManifest;
+}
+async function validateNpmSnapManifest({
+  manifest,
+  packageJson,
+  sourceCode,
+  svgIcon,
+  auxiliaryFiles,
+  localizationFiles
+}) {
+  const packageJsonName = packageJson.result.name;
+  const packageJsonVersion = packageJson.result.version;
+  const packageJsonRepository = packageJson.result.repository;
+  const manifestPackageName = manifest.result.source.location.npm.packageName;
+  const manifestPackageVersion = manifest.result.version;
+  const manifestRepository = manifest.result.repository;
+  if (packageJsonName !== manifestPackageName) {
+    throw new ProgrammaticallyFixableSnapError(
+      `"${"snap.manifest.json" /* Manifest */}" npm package name ("${manifestPackageName}") does not match the "${"package.json" /* PackageJson */}" "name" field ("${packageJsonName}").`,
+      '"name" field mismatch' /* NameMismatch */
+    );
+  }
+  if (packageJsonVersion !== manifestPackageVersion) {
+    throw new ProgrammaticallyFixableSnapError(
+      `"${"snap.manifest.json" /* Manifest */}" npm package version ("${manifestPackageVersion}") does not match the "${"package.json" /* PackageJson */}" "version" field ("${packageJsonVersion}").`,
+      '"version" field mismatch' /* VersionMismatch */
+    );
+  }
+  if (
+    // The repository may be `undefined` in package.json but can only be defined
+    // or `null` in the Snap manifest due to TS@<4.4 issues.
+    (packageJsonRepository || manifestRepository) && !deepEqual(packageJsonRepository, manifestRepository)
+  ) {
+    throw new ProgrammaticallyFixableSnapError(
+      `"${"snap.manifest.json" /* Manifest */}" "repository" field does not match the "${"package.json" /* PackageJson */}" "repository" field.`,
+      '"repository" field mismatch' /* RepositoryMismatch */
+    );
+  }
+  await validateSnapShasum(
+    { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles },
+    `"${"snap.manifest.json" /* Manifest */}" "shasum" field does not match computed shasum.`
+  );
+}
+
+// src/npm.ts
+var EXPECTED_SNAP_FILES = [
+  "manifest",
+  "packageJson",
+  "sourceCode"
+];
+var SnapFileNameFromKey = {
+  manifest: "snap.manifest.json" /* Manifest */,
+  packageJson: "package.json" /* PackageJson */,
+  sourceCode: "source code bundle"
+};
+async function validateNpmSnap(snapFiles, errorPrefix) {
+  EXPECTED_SNAP_FILES.forEach((key) => {
+    if (!snapFiles[key]) {
+      throw new Error(
+        `${errorPrefix ?? ""}Missing file "${SnapFileNameFromKey[key]}".`
+      );
+    }
+  });
+  const {
+    manifest,
+    packageJson,
+    sourceCode,
+    svgIcon,
+    auxiliaryFiles,
+    localizationFiles
+  } = snapFiles;
+  try {
+    assertIsSnapManifest(manifest.result);
+  } catch (error) {
+    throw new Error(`${errorPrefix ?? ""}${error.message}`);
+  }
+  const validatedManifest = manifest;
+  const { iconPath } = validatedManifest.result.source.location.npm;
+  if (iconPath && !svgIcon) {
+    throw new Error(`Missing file "${iconPath}".`);
+  }
+  try {
+    assertIsNpmSnapPackageJson(packageJson.result);
+  } catch (error) {
+    throw new Error(`${errorPrefix ?? ""}${error.message}`);
+  }
+  const validatedPackageJson = packageJson;
+  await validateNpmSnapManifest({
+    manifest: validatedManifest,
+    packageJson: validatedPackageJson,
+    sourceCode,
+    svgIcon,
+    auxiliaryFiles,
+    localizationFiles
+  });
+  if (svgIcon) {
+    try {
+      assertIsSnapIcon(svgIcon);
+    } catch (error) {
+      throw new Error(`${errorPrefix ?? ""}${error.message}`);
+    }
+  }
+  if (localizationFiles) {
+    try {
+      getValidatedLocalizationFiles(localizationFiles);
+      validateSnapManifestLocalizations(
+        manifest.result,
+        localizationFiles.map((file) => file.result)
+      );
+    } catch (error) {
+      throw new Error(`${errorPrefix ?? ""}${error.message}`);
+    }
+  }
+  return {
+    manifest: validatedManifest,
+    packageJson: validatedPackageJson,
+    sourceCode,
+    svgIcon,
+    auxiliaryFiles,
+    localizationFiles
+  };
+}
+
+export {
+  EXPECTED_SNAP_FILES,
+  SnapFileNameFromKey,
+  validateNpmSnap,
+  checkManifest,
+  fixManifest,
+  getSnapSourceCode,
+  getSnapIcon,
+  getSnapFilePaths,
+  getSnapFiles,
+  getWritableManifest,
+  validateNpmSnapManifest
+};
+//# sourceMappingURL=chunk-Y3F7VUZB.mjs.map