@metamask/snaps-utils 0.37.1-flask.1 → 0.37.2-flask.1

package/dist/cjs/structs.js

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    literal: function() {
+        return literal;
+    },
+    union: function() {
+        return union;
+    },
+    file: function() {
+        return file;
+    },
+    named: function() {
+        return named;
+    },
+    SnapsStructError: function() {
+        return SnapsStructError;
+    },
+    arrayToGenerator: function() {
+        return arrayToGenerator;
+    },
+    getError: function() {
+        return getError;
+    },
+    createFromStruct: function() {
+        return createFromStruct;
+    },
+    getStructFromPath: function() {
+        return getStructFromPath;
+    },
+    getUnionStructNames: function() {
+        return getUnionStructNames;
+    },
+    getStructErrorPrefix: function() {
+        return getStructErrorPrefix;
+    },
+    getStructFailureMessage: function() {
+        return getStructFailureMessage;
+    },
+    getStructErrorMessage: function() {
+        return getStructErrorMessage;
+    }
+});
+const _utils = require("@metamask/utils");
+const _chalk = require("chalk");
+const _path = require("path");
+const _superstruct = require("superstruct");
+const _strings = require("./strings");
+function literal(value) {
+    return (0, _superstruct.define)(JSON.stringify(value), (0, _superstruct.literal)(value).validator);
+}
+function union([head, ...tail]) {
+    const struct = (0, _superstruct.union)([
+        head,
+        ...tail
+    ]);
+    return new _superstruct.Struct({
+        ...struct,
+        schema: [
+            head,
+            ...tail
+        ]
+    });
+}
+function file() {
+    return (0, _superstruct.coerce)((0, _superstruct.string)(), (0, _superstruct.string)(), (value)=>{
+        return (0, _path.resolve)(process.cwd(), value);
+    });
+}
+function named(name, struct) {
+    return new _superstruct.Struct({
+        ...struct,
+        type: name
+    });
+}
+class SnapsStructError extends _superstruct.StructError {
+    constructor(struct, prefix, suffix, failure, failures){
+        super(failure, failures);
+        this.name = 'SnapsStructError';
+        this.message = `${prefix}.\n\n${getStructErrorMessage(struct, [
+            ...failures()
+        ])}${suffix ? `\n\n${suffix}` : ''}`;
+    }
+}
+function* arrayToGenerator(array) {
+    for (const item of array){
+        yield item;
+    }
+}
+function getError({ struct, prefix, suffix = '', error }) {
+    return new SnapsStructError(struct, prefix, suffix, error, ()=>arrayToGenerator(error.failures()));
+}
+function createFromStruct(value, struct, prefix, suffix = '') {
+    try {
+        return (0, _superstruct.create)(value, struct);
+    } catch (error) {
+        if (error instanceof _superstruct.StructError) {
+            throw getError({
+                struct,
+                prefix,
+                suffix,
+                error
+            });
+        }
+        throw error;
+    }
+}
+function getStructFromPath(struct, path) {
+    return path.reduce((result, key)=>{
+        if ((0, _utils.isObject)(struct.schema) && struct.schema[key]) {
+            return struct.schema[key];
+        }
+        return result;
+    }, struct);
+}
+function getUnionStructNames(struct) {
+    if (Array.isArray(struct.schema)) {
+        return struct.schema.map(({ type })=>(0, _chalk.green)(type));
+    }
+    return null;
+}
+function getStructErrorPrefix(failure) {
+    if (failure.type === 'never' || failure.path.length === 0) {
+        return '';
+    }
+    return `At path: ${(0, _chalk.bold)(failure.path.join('.'))} — `;
+}
+function getStructFailureMessage(struct, failure) {
+    const received = (0, _chalk.red)(JSON.stringify(failure.value));
+    const prefix = getStructErrorPrefix(failure);
+    if (failure.type === 'union') {
+        const childStruct = getStructFromPath(struct, failure.path);
+        const unionNames = getUnionStructNames(childStruct);
+        if (unionNames) {
+            return `${prefix}Expected the value to be one of: ${unionNames.join(', ')}, but received: ${received}.`;
+        }
+        return `${prefix}${failure.message}.`;
+    }
+    if (failure.type === 'literal') {
+        // Superstruct's failure does not provide information about which literal
+        // value was expected, so we need to parse the message to get the literal.
+        const message = failure.message.replace(/the literal `(.+)`,/u, `the value to be \`${(0, _chalk.green)('$1')}\`,`).replace(/, but received: (.+)/u, `, but received: ${(0, _chalk.red)('$1')}`);
+        return `${prefix}${message}.`;
+    }
+    if (failure.type === 'never') {
+        return `Unknown key: ${(0, _chalk.bold)(failure.path.join('.'))}, received: ${received}.`;
+    }
+    return `${prefix}Expected a value of type ${(0, _chalk.green)(failure.type)}, but received: ${received}.`;
+}
+function getStructErrorMessage(struct, failures) {
+    const formattedFailures = failures.map((failure)=>(0, _strings.indent)(`• ${getStructFailureMessage(struct, failure)}`));
+    return formattedFailures.join('\n');
+}
+
+//# sourceMappingURL=structs.js.map

package/dist/cjs/structs.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/structs.ts"],"sourcesContent":["import { isObject } from '@metamask/utils';\nimport { bold, green, red } from 'chalk';\nimport { resolve } from 'path';\nimport type { Failure, Infer } from 'superstruct';\nimport {\n  Struct,\n  StructError,\n  define,\n  literal as superstructLiteral,\n  union as superstructUnion,\n  create,\n  string,\n  coerce,\n} from 'superstruct';\nimport type { AnyStruct, InferStructTuple } from 'superstruct/dist/utils';\n\nimport { indent } from './strings';\n\n/**\n * A wrapper of `superstruct`'s `literal` struct that also defines the name of\n * the struct as the literal value.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n * For example, instead of returning an error like:\n *\n * ```\n * Expected the value to satisfy a union of `literal | literal`, but received: \\\"baz\\\"\n * ```\n *\n * This struct will return an error like:\n *\n * ```\n * Expected the value to satisfy a union of `\"foo\" | \"bar\"`, but received: \\\"baz\\\"\n * ```\n *\n * @param value - The literal value.\n * @returns The `superstruct` struct, which validates that the value is equal\n * to the literal value.\n */\nexport function literal<Type extends string | number | boolean>(value: Type) {\n  return define<Type>(\n    JSON.stringify(value),\n    superstructLiteral(value).validator,\n  );\n}\n\n/**\n * A wrapper of `superstruct`'s `union` struct that also defines the schema as\n * the union of the schemas of the structs.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n *\n * @param structs - The structs to union.\n * @param structs.\"0\" - The first struct.\n * @param structs.\"1\" - The remaining structs.\n * @returns The `superstruct` struct, which validates that the value satisfies\n * one of the structs.\n */\nexport function union<Head extends AnyStruct, Tail extends AnyStruct[]>([\n  head,\n  ...tail\n]: [head: Head, ...tail: Tail]): Struct<\n  Infer<Head> | InferStructTuple<Tail>[number],\n  [head: Head, ...tail: Tail]\n> {\n  const struct = superstructUnion([head, ...tail]);\n\n  return new Struct({\n    ...struct,\n    schema: [head, ...tail],\n  });\n}\n\n/**\n * A wrapper of `superstruct`'s `string` struct that coerces a value to a string\n * and resolves it relative to the current working directory. This is useful\n * for specifying file paths in a configuration file, as it allows the user to\n * use both relative and absolute paths.\n *\n * @returns The `superstruct` struct, which validates that the value is a\n * string, and resolves it relative to the current working directory.\n * @example\n * ```ts\n * const config = struct({\n *   file: file(),\n *   // ...\n * });\n *\n * const value = create({ file: 'path/to/file' }, config);\n * console.log(value.file); // /process/cwd/path/to/file\n * ```\n */\nexport function file() {\n  return coerce(string(), string(), (value) => {\n    return resolve(process.cwd(), value);\n  });\n}\n\n/**\n * Define a struct, and also define the name of the struct as the given name.\n *\n * This is useful for improving the error messages returned by `superstruct`.\n *\n * @param name - The name of the struct.\n * @param struct - The struct.\n * @returns The struct.\n */\nexport function named<Type, Schema>(\n  name: string,\n  struct: Struct<Type, Schema>,\n) {\n  return new Struct({\n    ...struct,\n    type: name,\n  });\n}\n\nexport class SnapsStructError<Type, Schema> extends StructError {\n  constructor(\n    struct: Struct<Type, Schema>,\n    prefix: string,\n    suffix: string,\n    failure: StructError,\n    failures: () => Generator<Failure>,\n  ) {\n    super(failure, failures);\n\n    this.name = 'SnapsStructError';\n    this.message = `${prefix}.\\n\\n${getStructErrorMessage(struct, [\n      ...failures(),\n    ])}${suffix ? `\\n\\n${suffix}` : ''}`;\n  }\n}\n\ntype GetErrorOptions<Type, Schema> = {\n  struct: Struct<Type, Schema>;\n  prefix: string;\n  suffix?: string;\n  error: StructError;\n};\n\n/**\n * Converts an array to a generator function that yields the items in the\n * array.\n *\n * @param array - The array.\n * @returns A generator function.\n * @yields The items in the array.\n */\nexport function* arrayToGenerator<Type>(\n  array: Type[],\n): Generator<Type, void, undefined> {\n  for (const item of array) {\n    yield item;\n  }\n}\n\n/**\n * Returns a `SnapsStructError` with the given prefix and suffix.\n *\n * @param options - The options.\n * @param options.struct - The struct that caused the error.\n * @param options.prefix - The prefix to add to the error message.\n * @param options.suffix - The suffix to add to the error message. Defaults to\n * an empty string.\n * @param options.error - The `superstruct` error to wrap.\n * @returns The `SnapsStructError`.\n */\nexport function getError<Type, Schema>({\n  struct,\n  prefix,\n  suffix = '',\n  error,\n}: GetErrorOptions<Type, Schema>) {\n  return new SnapsStructError(struct, prefix, suffix, error, () =>\n    arrayToGenerator(error.failures()),\n  );\n}\n\n/**\n * A wrapper of `superstruct`'s `create` function that throws a\n * `SnapsStructError` instead of a `StructError`. This is useful for improving\n * the error messages returned by `superstruct`.\n *\n * @param value - The value to validate.\n * @param struct - The `superstruct` struct to validate the value against.\n * @param prefix - The prefix to add to the error message.\n * @param suffix - The suffix to add to the error message. Defaults to an empty\n * string.\n * @returns The validated value.\n */\nexport function createFromStruct<Type, Schema>(\n  value: unknown,\n  struct: Struct<Type, Schema>,\n  prefix: string,\n  suffix = '',\n) {\n  try {\n    return create(value, struct);\n  } catch (error) {\n    if (error instanceof StructError) {\n      throw getError({ struct, prefix, suffix, error });\n    }\n\n    throw error;\n  }\n}\n\n/**\n * Get a struct from a failure path.\n *\n * @param struct - The struct.\n * @param path - The failure path.\n * @returns The struct at the failure path.\n */\nexport function getStructFromPath<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  path: string[],\n) {\n  return path.reduce<AnyStruct>((result, key) => {\n    if (isObject(struct.schema) && struct.schema[key]) {\n      return struct.schema[key] as AnyStruct;\n    }\n\n    return result;\n  }, struct);\n}\n\n/**\n * Get the union struct names from a struct.\n *\n * @param struct - The struct.\n * @returns The union struct names, or `null` if the struct is not a union\n * struct.\n */\nexport function getUnionStructNames<Type, Schema>(\n  struct: Struct<Type, Schema>,\n) {\n  if (Array.isArray(struct.schema)) {\n    return struct.schema.map(({ type }) => green(type));\n  }\n\n  return null;\n}\n\n/**\n * Get a error prefix from a `superstruct` failure. This is useful for\n * formatting the error message returned by `superstruct`.\n *\n * @param failure - The `superstruct` failure.\n * @returns The error prefix.\n */\nexport function getStructErrorPrefix(failure: Failure) {\n  if (failure.type === 'never' || failure.path.length === 0) {\n    return '';\n  }\n\n  return `At path: ${bold(failure.path.join('.'))} — `;\n}\n\n/**\n * Get a string describing the failure. This is similar to the `message`\n * property of `superstruct`'s `Failure` type, but formats the value in a more\n * readable way.\n *\n * @param struct - The struct that caused the failure.\n * @param failure - The `superstruct` failure.\n * @returns A string describing the failure.\n */\nexport function getStructFailureMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failure: Failure,\n) {\n  const received = red(JSON.stringify(failure.value));\n  const prefix = getStructErrorPrefix(failure);\n\n  if (failure.type === 'union') {\n    const childStruct = getStructFromPath(struct, failure.path);\n    const unionNames = getUnionStructNames(childStruct);\n\n    if (unionNames) {\n      return `${prefix}Expected the value to be one of: ${unionNames.join(\n        ', ',\n      )}, but received: ${received}.`;\n    }\n\n    return `${prefix}${failure.message}.`;\n  }\n\n  if (failure.type === 'literal') {\n    // Superstruct's failure does not provide information about which literal\n    // value was expected, so we need to parse the message to get the literal.\n    const message = failure.message\n      .replace(/the literal `(.+)`,/u, `the value to be \\`${green('$1')}\\`,`)\n      .replace(/, but received: (.+)/u, `, but received: ${red('$1')}`);\n\n    return `${prefix}${message}.`;\n  }\n\n  if (failure.type === 'never') {\n    return `Unknown key: ${bold(\n      failure.path.join('.'),\n    )}, received: ${received}.`;\n  }\n\n  return `${prefix}Expected a value of type ${green(\n    failure.type,\n  )}, but received: ${received}.`;\n}\n\n/**\n * Get a string describing the errors. This formats all the errors in a\n * human-readable way.\n *\n * @param struct - The struct that caused the failures.\n * @param failures - The `superstruct` failures.\n * @returns A string describing the errors.\n */\nexport function getStructErrorMessage<Type, Schema>(\n  struct: Struct<Type, Schema>,\n  failures: Failure[],\n) {\n  const formattedFailures = failures.map((failure) =>\n    indent(`• ${getStructFailureMessage(struct, failure)}`),\n  );\n\n  return formattedFailures.join('\\n');\n}\n"],"names":["literal","union","file","named","SnapsStructError","arrayToGenerator","getError","createFromStruct","getStructFromPath","getUnionStructNames","getStructErrorPrefix","getStructFailureMessage","getStructErrorMessage","value","define","JSON","stringify","superstructLiteral","validator","head","tail","struct","superstructUnion","Struct","schema","coerce","string","resolve","process","cwd","name","type","StructError","constructor","prefix","suffix","failure","failures","message","array","item","error","create","path","reduce","result","key","isObject","Array","isArray","map","green","length","bold","join","received","red","childStruct","unionNames","replace","formattedFailures","indent"],"mappings":";;;;;;;;;;;IAuCgBA,OAAO;eAAPA;;IAmBAC,KAAK;eAALA;;IAkCAC,IAAI;eAAJA;;IAeAC,KAAK;eAALA;;IAUHC,gBAAgB;eAAhBA;;IAgCIC,gBAAgB;eAAhBA;;IAmBDC,QAAQ;eAARA;;IAuBAC,gBAAgB;eAAhBA;;IAwBAC,iBAAiB;eAAjBA;;IAoBAC,mBAAmB;eAAnBA;;IAiBAC,oBAAoB;eAApBA;;IAiBAC,uBAAuB;eAAvBA;;IAiDAC,qBAAqB;eAArBA;;;uBA9TS;uBACQ;sBACT;6BAWjB;yBAGgB;AAuBhB,SAASZ,QAAgDa,KAAW;IACzE,OAAOC,IAAAA,mBAAM,EACXC,KAAKC,SAAS,CAACH,QACfI,IAAAA,oBAAkB,EAACJ,OAAOK,SAAS;AAEvC;AAcO,SAASjB,MAAwD,CACtEkB,MACA,GAAGC,KACyB;IAI5B,MAAMC,SAASC,IAAAA,kBAAgB,EAAC;QAACH;WAASC;KAAK;IAE/C,OAAO,IAAIG,mBAAM,CAAC;QAChB,GAAGF,MAAM;QACTG,QAAQ;YAACL;eAASC;SAAK;IACzB;AACF;AAqBO,SAASlB;IACd,OAAOuB,IAAAA,mBAAM,EAACC,IAAAA,mBAAM,KAAIA,IAAAA,mBAAM,KAAI,CAACb;QACjC,OAAOc,IAAAA,aAAO,EAACC,QAAQC,GAAG,IAAIhB;IAChC;AACF;AAWO,SAASV,MACd2B,IAAY,EACZT,MAA4B;IAE5B,OAAO,IAAIE,mBAAM,CAAC;QAChB,GAAGF,MAAM;QACTU,MAAMD;IACR;AACF;AAEO,MAAM1B,yBAAuC4B,wBAAW;IAC7DC,YACEZ,MAA4B,EAC5Ba,MAAc,EACdC,MAAc,EACdC,OAAoB,EACpBC,QAAkC,CAClC;QACA,KAAK,CAACD,SAASC;QAEf,IAAI,CAACP,IAAI,GAAG;QACZ,IAAI,CAACQ,OAAO,GAAG,CAAC,EAAEJ,OAAO,KAAK,EAAEtB,sBAAsBS,QAAQ;eACzDgB;SACJ,EAAE,EAAEF,SAAS,CAAC,IAAI,EAAEA,OAAO,CAAC,GAAG,GAAG,CAAC;IACtC;AACF;AAiBO,UAAU9B,iBACfkC,KAAa;IAEb,KAAK,MAAMC,QAAQD,MAAO;QACxB,MAAMC;IACR;AACF;AAaO,SAASlC,SAAuB,EACrCe,MAAM,EACNa,MAAM,EACNC,SAAS,EAAE,EACXM,KAAK,EACyB;IAC9B,OAAO,IAAIrC,iBAAiBiB,QAAQa,QAAQC,QAAQM,OAAO,IACzDpC,iBAAiBoC,MAAMJ,QAAQ;AAEnC;AAcO,SAAS9B,iBACdM,KAAc,EACdQ,MAA4B,EAC5Ba,MAAc,EACdC,SAAS,EAAE;IAEX,IAAI;QACF,OAAOO,IAAAA,mBAAM,EAAC7B,OAAOQ;IACvB,EAAE,OAAOoB,OAAO;QACd,IAAIA,iBAAiBT,wBAAW,EAAE;YAChC,MAAM1B,SAAS;gBAAEe;gBAAQa;gBAAQC;gBAAQM;YAAM;QACjD;QAEA,MAAMA;IACR;AACF;AASO,SAASjC,kBACda,MAA4B,EAC5BsB,IAAc;IAEd,OAAOA,KAAKC,MAAM,CAAY,CAACC,QAAQC;QACrC,IAAIC,IAAAA,eAAQ,EAAC1B,OAAOG,MAAM,KAAKH,OAAOG,MAAM,CAACsB,IAAI,EAAE;YACjD,OAAOzB,OAAOG,MAAM,CAACsB,IAAI;QAC3B;QAEA,OAAOD;IACT,GAAGxB;AACL;AASO,SAASZ,oBACdY,MAA4B;IAE5B,IAAI2B,MAAMC,OAAO,CAAC5B,OAAOG,MAAM,GAAG;QAChC,OAAOH,OAAOG,MAAM,CAAC0B,GAAG,CAAC,CAAC,EAAEnB,IAAI,EAAE,GAAKoB,IAAAA,YAAK,EAACpB;IAC/C;IAEA,OAAO;AACT;AASO,SAASrB,qBAAqB0B,OAAgB;IACnD,IAAIA,QAAQL,IAAI,KAAK,WAAWK,QAAQO,IAAI,CAACS,MAAM,KAAK,GAAG;QACzD,OAAO;IACT;IAEA,OAAO,CAAC,SAAS,EAAEC,IAAAA,WAAI,EAACjB,QAAQO,IAAI,CAACW,IAAI,CAAC,MAAM,GAAG,CAAC;AACtD;AAWO,SAAS3C,wBACdU,MAA4B,EAC5Be,OAAgB;IAEhB,MAAMmB,WAAWC,IAAAA,UAAG,EAACzC,KAAKC,SAAS,CAACoB,QAAQvB,KAAK;IACjD,MAAMqB,SAASxB,qBAAqB0B;IAEpC,IAAIA,QAAQL,IAAI,KAAK,SAAS;QAC5B,MAAM0B,cAAcjD,kBAAkBa,QAAQe,QAAQO,IAAI;QAC1D,MAAMe,aAAajD,oBAAoBgD;QAEvC,IAAIC,YAAY;YACd,OAAO,CAAC,EAAExB,OAAO,iCAAiC,EAAEwB,WAAWJ,IAAI,CACjE,MACA,gBAAgB,EAAEC,SAAS,CAAC,CAAC;QACjC;QAEA,OAAO,CAAC,EAAErB,OAAO,EAAEE,QAAQE,OAAO,CAAC,CAAC,CAAC;IACvC;IAEA,IAAIF,QAAQL,IAAI,KAAK,WAAW;QAC9B,yEAAyE;QACzE,0EAA0E;QAC1E,MAAMO,UAAUF,QAAQE,OAAO,CAC5BqB,OAAO,CAAC,wBAAwB,CAAC,kBAAkB,EAAER,IAAAA,YAAK,EAAC,MAAM,GAAG,CAAC,EACrEQ,OAAO,CAAC,yBAAyB,CAAC,gBAAgB,EAAEH,IAAAA,UAAG,EAAC,MAAM,CAAC;QAElE,OAAO,CAAC,EAAEtB,OAAO,EAAEI,QAAQ,CAAC,CAAC;IAC/B;IAEA,IAAIF,QAAQL,IAAI,KAAK,SAAS;QAC5B,OAAO,CAAC,aAAa,EAAEsB,IAAAA,WAAI,EACzBjB,QAAQO,IAAI,CAACW,IAAI,CAAC,MAClB,YAAY,EAAEC,SAAS,CAAC,CAAC;IAC7B;IAEA,OAAO,CAAC,EAAErB,OAAO,yBAAyB,EAAEiB,IAAAA,YAAK,EAC/Cf,QAAQL,IAAI,EACZ,gBAAgB,EAAEwB,SAAS,CAAC,CAAC;AACjC;AAUO,SAAS3C,sBACdS,MAA4B,EAC5BgB,QAAmB;IAEnB,MAAMuB,oBAAoBvB,SAASa,GAAG,CAAC,CAACd,UACtCyB,IAAAA,eAAM,EAAC,CAAC,EAAE,EAAElD,wBAAwBU,QAAQe,SAAS,CAAC;IAGxD,OAAOwB,kBAAkBN,IAAI,CAAC;AAChC"}

package/dist/esm/enum.js

@@ -1,4 +1,4 @@
-import { literal } from 'superstruct';
+import { literal } from './structs';
 /**
  * Superstruct struct for validating an enum value. This allows using both the
  * enum string values and the enum itself as values.

package/dist/esm/enum.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/enum.ts"],"sourcesContent":["import type { Struct } from 'superstruct';\nimport { literal } from 'superstruct';\n\n/**\n * Get the enum values as union type. This allows using both the enum string\n * values and the enum itself as values.\n *\n * Note: This only works for string enums.\n *\n * @example\n * ```typescript\n * enum Foo {\n *   Bar = 'bar',\n *   Baz = 'baz',\n * }\n *\n * type FooValue = EnumToUnion<Foo>;\n * // FooValue is 'bar' | 'baz'\n *\n * const foo: FooValue = Foo.Bar; // Works\n * const foo: FooValue = 'bar'; // Also works\n * ```\n */\nexport type EnumToUnion<Type extends string> = `${Type}`;\n\n/**\n * Superstruct struct for validating an enum value. This allows using both the\n * enum string values and the enum itself as values.\n *\n * @param constant - The enum to validate against.\n * @returns The superstruct struct.\n */\nexport function enumValue<Type extends string>(\n  constant: Type,\n): Struct<EnumToUnion<Type>, EnumToUnion<Type>> {\n  return literal(constant as EnumToUnion<Type>);\n}\n"],"names":["literal","enumValue","constant"],"mappings":"AACA,SAASA,OAAO,QAAQ,cAAc;AAwBtC;;;;;;CAMC,GACD,OAAO,SAASC,UACdC,QAAc;IAEd,OAAOF,QAAQE;AACjB"}
+{"version":3,"sources":["../../src/enum.ts"],"sourcesContent":["import type { Struct } from 'superstruct';\n\nimport { literal } from './structs';\n\n/**\n * Get the enum values as union type. This allows using both the enum string\n * values and the enum itself as values.\n *\n * Note: This only works for string enums.\n *\n * @example\n * ```typescript\n * enum Foo {\n *   Bar = 'bar',\n *   Baz = 'baz',\n * }\n *\n * type FooValue = EnumToUnion<Foo>;\n * // FooValue is 'bar' | 'baz'\n *\n * const foo: FooValue = Foo.Bar; // Works\n * const foo: FooValue = 'bar'; // Also works\n * ```\n */\nexport type EnumToUnion<Type extends string> = `${Type}`;\n\n/**\n * Superstruct struct for validating an enum value. This allows using both the\n * enum string values and the enum itself as values.\n *\n * @param constant - The enum to validate against.\n * @returns The superstruct struct.\n */\nexport function enumValue<Type extends string>(\n  constant: Type,\n): Struct<EnumToUnion<Type>, null> {\n  return literal(constant as EnumToUnion<Type>);\n}\n"],"names":["literal","enumValue","constant"],"mappings":"AAEA,SAASA,OAAO,QAAQ,YAAY;AAwBpC;;;;;;CAMC,GACD,OAAO,SAASC,UACdC,QAAc;IAEd,OAAOF,QAAQE;AACjB"}

package/dist/esm/eval.js

@@ -1,6 +1,28 @@
+function _define_property(obj, key, value) {
+    if (key in obj) {
+        Object.defineProperty(obj, key, {
+            value: value,
+            enumerable: true,
+            configurable: true,
+            writable: true
+        });
+    } else {
+        obj[key] = value;
+    }
+    return obj;
+}
+import { assert } from '@metamask/utils';
 import { fork } from 'child_process';
 import { join } from 'path';
 import { validateFilePath } from './fs';
+export class SnapEvalError extends Error {
+    constructor(message, output){
+        super(message);
+        _define_property(this, "output", void 0);
+        this.name = 'SnapEvalError';
+        this.output = output;
+    }
+}
 /**
  * Spawn a new process to run the provided bundle in.
  *
@@ -12,12 +34,30 @@ import { validateFilePath } from './fs';
     return new Promise((resolve, reject)=>{
         const worker = fork(join(__dirname, 'eval-worker.js'), [
             bundlePath
-        ]);
+        ], {
+            // To avoid printing the output of the worker to the console, we set
+            // `stdio` to `pipe` and handle the output ourselves.
+            stdio: 'pipe'
+        });
+        let stdout = '';
+        let stderr = '';
+        assert(worker.stdout, '`stdout` should be defined.');
+        assert(worker.stderr, '`stderr` should be defined.');
+        worker.stdout.on('data', (data)=>{
+            stdout += data.toString();
+        });
+        worker.stderr.on('data', (data)=>{
+            stderr += data.toString();
+        });
         worker.on('exit', (exitCode)=>{
+            const output = {
+                stdout,
+                stderr
+            };
             if (exitCode === 0) {
-                return resolve(null);
+                return resolve(output);
             }
-            return reject(new Error(`Process exited with non-zero exit code: ${exitCode}`));
+            return reject(new SnapEvalError(`Process exited with non-zero exit code: ${exitCode}.`, output));
         });
     });
 }

package/dist/esm/eval.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/eval.ts"],"sourcesContent":["import { fork } from 'child_process';\nimport { join } from 'path';\n\nimport { validateFilePath } from './fs';\n\n/**\n * Spawn a new process to run the provided bundle in.\n *\n * @param bundlePath - The path to the bundle to run.\n * @returns `null` if the worker ran successfully.\n * @throws If the worker failed to run successfully.\n */\nexport async function evalBundle(bundlePath: string): Promise<null> {\n  await validateFilePath(bundlePath);\n\n  return new Promise((resolve, reject) => {\n    const worker = fork(join(__dirname, 'eval-worker.js'), [bundlePath]);\n\n    worker.on('exit', (exitCode: number) => {\n      if (exitCode === 0) {\n        return resolve(null);\n      }\n\n      return reject(\n        new Error(`Process exited with non-zero exit code: ${exitCode}`),\n      );\n    });\n  });\n}\n"],"names":["fork","join","validateFilePath","evalBundle","bundlePath","Promise","resolve","reject","worker","__dirname","on","exitCode","Error"],"mappings":"AAAA,SAASA,IAAI,QAAQ,gBAAgB;AACrC,SAASC,IAAI,QAAQ,OAAO;AAE5B,SAASC,gBAAgB,QAAQ,OAAO;AAExC;;;;;;CAMC,GACD,OAAO,eAAeC,WAAWC,UAAkB;IACjD,MAAMF,iBAAiBE;IAEvB,OAAO,IAAIC,QAAQ,CAACC,SAASC;QAC3B,MAAMC,SAASR,KAAKC,KAAKQ,WAAW,mBAAmB;YAACL;SAAW;QAEnEI,OAAOE,EAAE,CAAC,QAAQ,CAACC;YACjB,IAAIA,aAAa,GAAG;gBAClB,OAAOL,QAAQ;YACjB;YAEA,OAAOC,OACL,IAAIK,MAAM,CAAC,wCAAwC,EAAED,SAAS,CAAC;QAEnE;IACF;AACF"}
+{"version":3,"sources":["../../src/eval.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\nimport { fork } from 'child_process';\nimport { join } from 'path';\n\nimport { validateFilePath } from './fs';\n\nexport type EvalOutput = {\n  stdout: string;\n  stderr: string;\n};\n\nexport class SnapEvalError extends Error {\n  readonly output: EvalOutput;\n\n  constructor(message: string, output: EvalOutput) {\n    super(message);\n\n    this.name = 'SnapEvalError';\n    this.output = output;\n  }\n}\n\n/**\n * Spawn a new process to run the provided bundle in.\n *\n * @param bundlePath - The path to the bundle to run.\n * @returns `null` if the worker ran successfully.\n * @throws If the worker failed to run successfully.\n */\nexport async function evalBundle(bundlePath: string): Promise<EvalOutput> {\n  await validateFilePath(bundlePath);\n\n  return new Promise((resolve, reject) => {\n    const worker = fork(join(__dirname, 'eval-worker.js'), [bundlePath], {\n      // To avoid printing the output of the worker to the console, we set\n      // `stdio` to `pipe` and handle the output ourselves.\n      stdio: 'pipe',\n    });\n\n    let stdout = '';\n    let stderr = '';\n\n    assert(worker.stdout, '`stdout` should be defined.');\n    assert(worker.stderr, '`stderr` should be defined.');\n\n    worker.stdout.on('data', (data: Buffer) => {\n      stdout += data.toString();\n    });\n\n    worker.stderr.on('data', (data: Buffer) => {\n      stderr += data.toString();\n    });\n\n    worker.on('exit', (exitCode: number) => {\n      const output = {\n        stdout,\n        stderr,\n      };\n\n      if (exitCode === 0) {\n        return resolve(output);\n      }\n\n      return reject(\n        new SnapEvalError(\n          `Process exited with non-zero exit code: ${exitCode}.`,\n          output,\n        ),\n      );\n    });\n  });\n}\n"],"names":["assert","fork","join","validateFilePath","SnapEvalError","Error","constructor","message","output","name","evalBundle","bundlePath","Promise","resolve","reject","worker","__dirname","stdio","stdout","stderr","on","data","toString","exitCode"],"mappings":";;;;;;;;;;;;;AAAA,SAASA,MAAM,QAAQ,kBAAkB;AACzC,SAASC,IAAI,QAAQ,gBAAgB;AACrC,SAASC,IAAI,QAAQ,OAAO;AAE5B,SAASC,gBAAgB,QAAQ,OAAO;AAOxC,OAAO,MAAMC,sBAAsBC;IAGjCC,YAAYC,OAAe,EAAEC,MAAkB,CAAE;QAC/C,KAAK,CAACD;QAHR,uBAASC,UAAT,KAAA;QAKE,IAAI,CAACC,IAAI,GAAG;QACZ,IAAI,CAACD,MAAM,GAAGA;IAChB;AACF;AAEA;;;;;;CAMC,GACD,OAAO,eAAeE,WAAWC,UAAkB;IACjD,MAAMR,iBAAiBQ;IAEvB,OAAO,IAAIC,QAAQ,CAACC,SAASC;QAC3B,MAAMC,SAASd,KAAKC,KAAKc,WAAW,mBAAmB;YAACL;SAAW,EAAE;YACnE,oEAAoE;YACpE,qDAAqD;YACrDM,OAAO;QACT;QAEA,IAAIC,SAAS;QACb,IAAIC,SAAS;QAEbnB,OAAOe,OAAOG,MAAM,EAAE;QACtBlB,OAAOe,OAAOI,MAAM,EAAE;QAEtBJ,OAAOG,MAAM,CAACE,EAAE,CAAC,QAAQ,CAACC;YACxBH,UAAUG,KAAKC,QAAQ;QACzB;QAEAP,OAAOI,MAAM,CAACC,EAAE,CAAC,QAAQ,CAACC;YACxBF,UAAUE,KAAKC,QAAQ;QACzB;QAEAP,OAAOK,EAAE,CAAC,QAAQ,CAACG;YACjB,MAAMf,SAAS;gBACbU;gBACAC;YACF;YAEA,IAAII,aAAa,GAAG;gBAClB,OAAOV,QAAQL;YACjB;YAEA,OAAOM,OACL,IAAIV,cACF,CAAC,wCAAwC,EAAEmB,SAAS,CAAC,CAAC,EACtDf;QAGN;IACF;AACF"}

package/dist/esm/index.browser.js

@@ -15,6 +15,8 @@ export * from './manifest/index.browser';
 export * from './namespace';
 export * from './path';
 export * from './snaps';
+export * from './strings';
+export * from './structs';
 export * from './types';
 export * from './validation';
 export * from './versions';

package/dist/esm/index.browser.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.browser.ts"],"sourcesContent":["export * from './array';\nexport * from './caveats';\nexport * from './checksum';\nexport * from './cronjob';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './enum';\nexport * from './handlers';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './logging';\nexport * from './manifest/index.browser';\nexport * from './namespace';\nexport * from './path';\nexport * from './snaps';\nexport * from './types';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file/index.browser';\n"],"names":[],"mappings":"AAAA,cAAc,UAAU;AACxB,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,eAAe;AAC7B,cAAc,uBAAuB;AACrC,cAAc,YAAY;AAC1B,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,WAAW;AACzB,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,2BAA2B;AACzC,cAAc,cAAc;AAC5B,cAAc,SAAS;AACvB,cAAc,UAAU;AACxB,cAAc,UAAU;AACxB,cAAc,eAAe;AAC7B,cAAc,aAAa;AAC3B,cAAc,+BAA+B"}
+{"version":3,"sources":["../../src/index.browser.ts"],"sourcesContent":["export * from './array';\nexport * from './caveats';\nexport * from './checksum';\nexport * from './cronjob';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './enum';\nexport * from './handlers';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './logging';\nexport * from './manifest/index.browser';\nexport * from './namespace';\nexport * from './path';\nexport * from './snaps';\nexport * from './strings';\nexport * from './structs';\nexport * from './types';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file/index.browser';\n"],"names":[],"mappings":"AAAA,cAAc,UAAU;AACxB,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,eAAe;AAC7B,cAAc,uBAAuB;AACrC,cAAc,YAAY;AAC1B,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,WAAW;AACzB,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,2BAA2B;AACzC,cAAc,cAAc;AAC5B,cAAc,SAAS;AACvB,cAAc,UAAU;AACxB,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,UAAU;AACxB,cAAc,eAAe;AAC7B,cAAc,aAAa;AAC3B,cAAc,+BAA+B"}

package/dist/esm/index.js

@@ -20,6 +20,8 @@ export * from './npm';
 export * from './path';
 export * from './post-process';
 export * from './snaps';
+export * from './strings';
+export * from './structs';
 export * from './types';
 export * from './validation';
 export * from './versions';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './array';\nexport * from './caveats';\nexport * from './cronjob';\nexport * from './checksum';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './enum';\nexport * from './eval';\nexport * from './fs';\nexport * from './handlers';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './logging';\nexport * from './manifest';\nexport * from './mock';\nexport * from './namespace';\nexport * from './npm';\nexport * from './path';\nexport * from './post-process';\nexport * from './snaps';\nexport * from './types';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file';\n"],"names":[],"mappings":"AAAA,cAAc,UAAU;AACxB,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,cAAc,uBAAuB;AACrC,cAAc,YAAY;AAC1B,cAAc,SAAS;AACvB,cAAc,SAAS;AACvB,cAAc,OAAO;AACrB,cAAc,aAAa;AAC3B,cAAc,WAAW;AACzB,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,SAAS;AACvB,cAAc,cAAc;AAC5B,cAAc,QAAQ;AACtB,cAAc,SAAS;AACvB,cAAc,iBAAiB;AAC/B,cAAc,UAAU;AACxB,cAAc,UAAU;AACxB,cAAc,eAAe;AAC7B,cAAc,aAAa;AAC3B,cAAc,iBAAiB"}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './array';\nexport * from './caveats';\nexport * from './cronjob';\nexport * from './checksum';\nexport * from './deep-clone';\nexport * from './default-endowments';\nexport * from './entropy';\nexport * from './enum';\nexport * from './eval';\nexport * from './fs';\nexport * from './handlers';\nexport * from './iframe';\nexport * from './json';\nexport * from './json-rpc';\nexport * from './logging';\nexport * from './manifest';\nexport * from './mock';\nexport * from './namespace';\nexport * from './npm';\nexport * from './path';\nexport * from './post-process';\nexport * from './snaps';\nexport * from './strings';\nexport * from './structs';\nexport * from './types';\nexport * from './validation';\nexport * from './versions';\nexport * from './virtual-file';\n"],"names":[],"mappings":"AAAA,cAAc,UAAU;AACxB,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,cAAc,uBAAuB;AACrC,cAAc,YAAY;AAC1B,cAAc,SAAS;AACvB,cAAc,SAAS;AACvB,cAAc,OAAO;AACrB,cAAc,aAAa;AAC3B,cAAc,WAAW;AACzB,cAAc,SAAS;AACvB,cAAc,aAAa;AAC3B,cAAc,YAAY;AAC1B,cAAc,aAAa;AAC3B,cAAc,SAAS;AACvB,cAAc,cAAc;AAC5B,cAAc,QAAQ;AACtB,cAAc,SAAS;AACvB,cAAc,iBAAiB;AAC/B,cAAc,UAAU;AACxB,cAAc,YAAY;AAC1B,cAAc,YAAY;AAC1B,cAAc,UAAU;AACxB,cAAc,eAAe;AAC7B,cAAc,aAAa;AAC3B,cAAc,iBAAiB"}

package/dist/esm/manifest/manifest.js

@@ -26,9 +26,10 @@ const MANIFEST_SORT_ORDER = {
  * @param basePath - The path to the folder with the manifest files.
  * @param writeManifest - Whether to write the fixed manifest to disk.
  * @param sourceCode - The source code of the Snap.
+ * @param writeFileFn - The function to use to write the manifest to disk.
  * @returns Whether the manifest was updated, and an array of warnings that
  * were encountered during processing of the manifest files.
- */ export async function checkManifest(basePath, writeManifest = true, sourceCode) {
+ */ export async function checkManifest(basePath, writeManifest = true, sourceCode, writeFileFn = fs.writeFile) {
     const warnings = [];
     const errors = [];
     let updated = false;
@@ -99,7 +100,7 @@ const MANIFEST_SORT_ORDER = {
         try {
             const newManifest = `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\n`;
             if (updated || newManifest !== manifestFile.value) {
-                await fs.writeFile(pathUtils.join(basePath, NpmSnapFileNames.Manifest), newManifest);
+                await writeFileFn(pathUtils.join(basePath, NpmSnapFileNames.Manifest), newManifest);
             }
         } catch (error) {
             // Note: This error isn't pushed to the errors array, because it's not an
@@ -172,7 +173,7 @@ const MANIFEST_SORT_ORDER = {
         const virtualFile = await readVirtualFile(pathUtils.join(basePath, sourceFilePath), 'utf8');
         return virtualFile;
     } catch (error) {
-        throw new Error(`Failed to read Snap bundle file: ${error.message}`);
+        throw new Error(`Failed to read snap bundle file: ${error.message}`);
     }
 }
 /**
@@ -194,7 +195,7 @@ const MANIFEST_SORT_ORDER = {
         const virtualFile = await readVirtualFile(pathUtils.join(basePath, iconPath), 'utf8');
         return virtualFile;
     } catch (error) {
-        throw new Error(`Failed to read Snap icon file: ${error.message}`);
+        throw new Error(`Failed to read snap icon file: ${error.message}`);
     }
 }
 /**

package/dist/esm/manifest/manifest.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/manifest/manifest.ts"],"sourcesContent":["import type { Json } from '@metamask/utils';\nimport { assertExhaustive, assert, isPlainObject } from '@metamask/utils';\nimport deepEqual from 'fast-deep-equal';\nimport { promises as fs } from 'fs';\nimport pathUtils from 'path';\n\nimport { deepClone } from '../deep-clone';\nimport { readJsonFile } from '../fs';\nimport { validateNpmSnap } from '../npm';\nimport {\n  getSnapChecksum,\n  ProgrammaticallyFixableSnapError,\n  validateSnapShasum,\n} from '../snaps';\nimport type { SnapFiles, UnvalidatedSnapFiles } from '../types';\nimport { NpmSnapFileNames, SnapValidationFailureReason } from '../types';\nimport { readVirtualFile, VirtualFile } from '../virtual-file';\nimport type { SnapManifest } from './validation';\n\nconst MANIFEST_SORT_ORDER: Record<keyof SnapManifest, number> = {\n  $schema: 1,\n  version: 2,\n  description: 3,\n  proposedName: 4,\n  repository: 5,\n  source: 6,\n  initialPermissions: 7,\n  manifestVersion: 8,\n};\n\n/**\n * The result from the `checkManifest` function.\n *\n * @property manifest - The fixed manifest object.\n * @property updated - Whether the manifest was updated.\n * @property warnings - An array of warnings that were encountered during\n * processing of the manifest files. These warnings are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n * @property errors - An array of errors that were encountered during\n * processing of the manifest files. These errors are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n */\nexport type CheckManifestResult = {\n  manifest: SnapManifest;\n  updated?: boolean;\n  warnings: string[];\n  errors: string[];\n};\n\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param writeManifest - Whether to write the fixed manifest to disk.\n * @param sourceCode - The source code of the Snap.\n * @returns Whether the manifest was updated, and an array of warnings that\n * were encountered during processing of the manifest files.\n */\nexport async function checkManifest(\n  basePath: string,\n  writeManifest = true,\n  sourceCode?: string,\n): Promise<CheckManifestResult> {\n  const warnings: string[] = [];\n  const errors: string[] = [];\n\n  let updated = false;\n\n  const manifestPath = pathUtils.join(basePath, NpmSnapFileNames.Manifest);\n  const manifestFile = await readJsonFile(manifestPath);\n  const unvalidatedManifest = manifestFile.result;\n\n  const packageFile = await readJsonFile(\n    pathUtils.join(basePath, NpmSnapFileNames.PackageJson),\n  );\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: manifestFile,\n    packageJson: packageFile,\n    sourceCode: await getSnapSourceCode(\n      basePath,\n      unvalidatedManifest,\n      sourceCode,\n    ),\n    svgIcon: await getSnapIcon(basePath, unvalidatedManifest),\n  };\n\n  let manifest: VirtualFile<SnapManifest> | undefined;\n  try {\n    ({ manifest } = validateNpmSnap(snapFiles));\n  } catch (error) {\n    if (error instanceof ProgrammaticallyFixableSnapError) {\n      errors.push(error.message);\n\n      // If we get here, the files at least have the correct shape.\n      const partiallyValidatedFiles = snapFiles as SnapFiles;\n\n      let isInvalid = true;\n      let currentError = error;\n      const maxAttempts = Object.keys(SnapValidationFailureReason).length;\n\n      // Attempt to fix all fixable validation failure reasons. All such reasons\n      // are enumerated by the `SnapValidationFailureReason` enum, so we only\n      // attempt to fix the manifest the same amount of times as there are\n      // reasons in the enum.\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = fixManifest(\n          manifest\n            ? { ...partiallyValidatedFiles, manifest }\n            : partiallyValidatedFiles,\n          currentError,\n        );\n\n        try {\n          validateNpmSnapManifest({ ...partiallyValidatedFiles, manifest });\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          currentError = nextValidationError;\n          /* istanbul ignore next: this should be impossible */\n          if (\n            !(\n              nextValidationError instanceof ProgrammaticallyFixableSnapError\n            ) ||\n            (attempts === maxAttempts && !isInvalid)\n          ) {\n            throw new Error(\n              `Internal error: Failed to fix manifest. This is a bug, please report it. Reason:\\n${error.message}`,\n            );\n          }\n\n          errors.push(currentError.message);\n        }\n      }\n\n      updated = true;\n    } else {\n      throw error;\n    }\n  }\n\n  // TypeScript assumes `manifest` can still be undefined, that is not the case.\n  // But we assert to keep TypeScript happy.\n  assert(manifest);\n\n  const validatedManifest = manifest.result;\n\n  // Check presence of recommended keys\n  const recommendedFields = ['repository'] as const;\n\n  const missingRecommendedFields = recommendedFields.filter(\n    (key) => !validatedManifest[key],\n  );\n\n  if (missingRecommendedFields.length > 0) {\n    warnings.push(\n      `Missing recommended package.json properties:\\n${missingRecommendedFields.reduce(\n        (allMissing, currentField) => {\n          return `${allMissing}\\t${currentField}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  if (writeManifest) {\n    try {\n      const newManifest = `${JSON.stringify(\n        getWritableManifest(validatedManifest),\n        null,\n        2,\n      )}\\n`;\n\n      if (updated || newManifest !== manifestFile.value) {\n        await fs.writeFile(\n          pathUtils.join(basePath, NpmSnapFileNames.Manifest),\n          newManifest,\n        );\n      }\n    } catch (error) {\n      // Note: This error isn't pushed to the errors array, because it's not an\n      // error in the manifest itself.\n      throw new Error(`Failed to update snap.manifest.json: ${error.message}`);\n    }\n  }\n\n  return { manifest: validatedManifest, updated, warnings, errors };\n}\n\n/**\n * Given the relevant Snap files (manifest, `package.json`, and bundle) and a\n * Snap manifest validation error, fixes the fault in the manifest that caused\n * the error.\n *\n * @param snapFiles - The contents of all Snap files.\n * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.\n * @returns A copy of the manifest file where the cause of the error is fixed.\n */\nexport function fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): VirtualFile<SnapManifest> {\n  const { manifest, packageJson } = snapFiles;\n  const clonedFile = manifest.clone();\n  const manifestCopy = clonedFile.result;\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.result.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.result.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.result.repository\n        ? deepClone(packageJson.result.repository)\n        : undefined;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = getSnapChecksum(snapFiles);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      assertExhaustive(error.reason);\n  }\n\n  clonedFile.result = manifestCopy;\n  clonedFile.value = JSON.stringify(manifestCopy);\n  return clonedFile;\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * bundle source file location and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @param sourceCode - Override source code for plugins.\n * @returns The contents of the bundle file, if any.\n */\nexport async function getSnapSourceCode(\n  basePath: string,\n  manifest: Json,\n  sourceCode?: string,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n    ?.npm?.filePath;\n\n  if (!sourceFilePath) {\n    return undefined;\n  }\n\n  if (sourceCode) {\n    return new VirtualFile({\n      path: pathUtils.join(basePath, sourceFilePath),\n      value: sourceCode,\n    });\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, sourceFilePath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read Snap bundle file: ${error.message}`);\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * icon and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the icon, if any.\n */\nexport async function getSnapIcon(\n  basePath: string,\n  manifest: Json,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const iconPath = (manifest as Partial<SnapManifest>).source?.location?.npm\n    ?.iconPath;\n\n  if (!iconPath) {\n    return undefined;\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, iconPath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read Snap icon file: ${error.message}`);\n  }\n}\n\n/**\n * Sorts the given manifest in our preferred sort order and removes the\n * `repository` field if it is falsy (it may be `null`).\n *\n * @param manifest - The manifest to sort and modify.\n * @returns The disk-ready manifest.\n */\nexport function getWritableManifest(manifest: SnapManifest): SnapManifest {\n  const { repository, ...remaining } = manifest;\n\n  const keys = Object.keys(\n    repository ? { ...remaining, repository } : remaining,\n  ) as (keyof SnapManifest)[];\n\n  const writableManifest = keys\n    .sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b])\n    .reduce<Partial<SnapManifest>>(\n      (result, key) => ({\n        ...result,\n        [key]: manifest[key],\n      }),\n      {},\n    );\n\n  return writableManifest as SnapManifest;\n}\n\n/**\n * Validates the fields of an npm Snap manifest that has already passed JSON\n * Schema validation.\n *\n * @param snapFiles - The relevant snap files to validate.\n * @param snapFiles.manifest - The npm Snap manifest to validate.\n * @param snapFiles.packageJson - The npm Snap's `package.json`.\n * @param snapFiles.sourceCode - The Snap's source code.\n * @param snapFiles.svgIcon - The Snap's optional icon.\n */\nexport function validateNpmSnapManifest({\n  manifest,\n  packageJson,\n  sourceCode,\n  svgIcon,\n}: SnapFiles) {\n  const packageJsonName = packageJson.result.name;\n  const packageJsonVersion = packageJson.result.version;\n  const packageJsonRepository = packageJson.result.repository;\n\n  const manifestPackageName = manifest.result.source.location.npm.packageName;\n  const manifestPackageVersion = manifest.result.version;\n  const manifestRepository = manifest.result.repository;\n\n  if (packageJsonName !== manifestPackageName) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package name (\"${manifestPackageName}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"name\" field (\"${packageJsonName}\").`,\n      SnapValidationFailureReason.NameMismatch,\n    );\n  }\n\n  if (packageJsonVersion !== manifestPackageVersion) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package version (\"${manifestPackageVersion}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"version\" field (\"${packageJsonVersion}\").`,\n      SnapValidationFailureReason.VersionMismatch,\n    );\n  }\n\n  if (\n    // The repository may be `undefined` in package.json but can only be defined\n    // or `null` in the Snap manifest due to TS@<4.4 issues.\n    (packageJsonRepository || manifestRepository) &&\n    !deepEqual(packageJsonRepository, manifestRepository)\n  ) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" \"repository\" field does not match the \"${NpmSnapFileNames.PackageJson}\" \"repository\" field.`,\n      SnapValidationFailureReason.RepositoryMismatch,\n    );\n  }\n\n  validateSnapShasum(\n    { manifest, sourceCode, svgIcon },\n    `\"${NpmSnapFileNames.Manifest}\" \"shasum\" field does not match computed shasum.`,\n  );\n}\n"],"names":["assertExhaustive","assert","isPlainObject","deepEqual","promises","fs","pathUtils","deepClone","readJsonFile","validateNpmSnap","getSnapChecksum","ProgrammaticallyFixableSnapError","validateSnapShasum","NpmSnapFileNames","SnapValidationFailureReason","readVirtualFile","VirtualFile","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialPermissions","manifestVersion","checkManifest","basePath","writeManifest","sourceCode","warnings","errors","updated","manifestPath","join","Manifest","manifestFile","unvalidatedManifest","result","packageFile","PackageJson","snapFiles","manifest","packageJson","getSnapSourceCode","svgIcon","getSnapIcon","error","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","length","attempts","fixManifest","validateNpmSnapManifest","nextValidationError","Error","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","newManifest","JSON","stringify","getWritableManifest","value","writeFile","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","undefined","ShasumMismatch","shasum","sourceFilePath","filePath","path","virtualFile","iconPath","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository"],"mappings":"AACA,SAASA,gBAAgB,EAAEC,MAAM,EAAEC,aAAa,QAAQ,kBAAkB;AAC1E,OAAOC,eAAe,kBAAkB;AACxC,SAASC,YAAYC,EAAE,QAAQ,KAAK;AACpC,OAAOC,eAAe,OAAO;AAE7B,SAASC,SAAS,QAAQ,gBAAgB;AAC1C,SAASC,YAAY,QAAQ,QAAQ;AACrC,SAASC,eAAe,QAAQ,SAAS;AACzC,SACEC,eAAe,EACfC,gCAAgC,EAChCC,kBAAkB,QACb,WAAW;AAElB,SAASC,gBAAgB,EAAEC,2BAA2B,QAAQ,WAAW;AACzE,SAASC,eAAe,EAAEC,WAAW,QAAQ,kBAAkB;AAG/D,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,iBAAiB;AACnB;AAuBA;;;;;;;;;;CAUC,GACD,OAAO,eAAeC,cACpBC,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB;IAEnB,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAe3B,UAAU4B,IAAI,CAACP,UAAUd,iBAAiBsB,QAAQ;IACvE,MAAMC,eAAe,MAAM5B,aAAayB;IACxC,MAAMI,sBAAsBD,aAAaE,MAAM;IAE/C,MAAMC,cAAc,MAAM/B,aACxBF,UAAU4B,IAAI,CAACP,UAAUd,iBAAiB2B,WAAW;IAGvD,MAAMC,YAAkC;QACtCC,UAAUN;QACVO,aAAaJ;QACbV,YAAY,MAAMe,kBAChBjB,UACAU,qBACAR;QAEFgB,SAAS,MAAMC,YAAYnB,UAAUU;IACvC;IAEA,IAAIK;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAGjC,gBAAgBgC,UAAS;IAC3C,EAAE,OAAOM,OAAO;QACd,IAAIA,iBAAiBpC,kCAAkC;YACrDoB,OAAOiB,IAAI,CAACD,MAAME,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BT;YAEhC,IAAIU,YAAY;YAChB,IAAIC,eAAeL;YACnB,MAAMM,cAAcC,OAAOC,IAAI,CAACzC,6BAA6B0C,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGN,aAAaM,YAAYJ,aAAaI,WAAY;gBACvEf,WAAWgB,YACThB,WACI;oBAAE,GAAGQ,uBAAuB;oBAAER;gBAAS,IACvCQ,yBACJE;gBAGF,IAAI;oBACFO,wBAAwB;wBAAE,GAAGT,uBAAuB;wBAAER;oBAAS;oBAE/DS,YAAY;gBACd,EAAE,OAAOS,qBAAqB;oBAC5BR,eAAeQ;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+BjD,gCAA+B,KAE/D8C,aAAaJ,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIU,MACR,CAAC,kFAAkF,EAAEd,MAAME,OAAO,CAAC,CAAC;oBAExG;oBAEAlB,OAAOiB,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEAjB,UAAU;QACZ,OAAO;YACL,MAAMe;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1C9C,OAAOyC;IAEP,MAAMoB,oBAAoBpB,SAASJ,MAAM;IAEzC,qCAAqC;IACrC,MAAMyB,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBR,MAAM,GAAG,GAAG;QACvC1B,SAASkB,IAAI,CACX,CAAC,8CAA8C,EAAEgB,yBAAyBG,MAAM,CAC9E,CAACC,YAAYC;YACX,OAAO,CAAC,EAAED,WAAW,EAAE,EAAEC,aAAa,EAAE,CAAC;QAC3C,GACA,IACA,CAAC;IAEP;IAEA,IAAIzC,eAAe;QACjB,IAAI;YACF,MAAM0C,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnCC,oBAAoBX,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAI9B,WAAWsC,gBAAgBlC,aAAasC,KAAK,EAAE;gBACjD,MAAMrE,GAAGsE,SAAS,CAChBrE,UAAU4B,IAAI,CAACP,UAAUd,iBAAiBsB,QAAQ,GAClDmC;YAEJ;QACF,EAAE,OAAOvB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAME,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEP,UAAUoB;QAAmB9B;QAASF;QAAUC;IAAO;AAClE;AAEA;;;;;;;;CAQC,GACD,OAAO,SAAS2B,YACdjB,SAAoB,EACpBM,KAAuC;IAEvC,MAAM,EAAEL,QAAQ,EAAEC,WAAW,EAAE,GAAGF;IAClC,MAAMmC,aAAalC,SAASmC,KAAK;IACjC,MAAMC,eAAeF,WAAWtC,MAAM;IAEtC,OAAQS,MAAMgC,MAAM;QAClB,KAAKjE,4BAA4BkE,YAAY;YAC3CF,aAAavD,MAAM,CAAC0D,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAGxC,YAAYL,MAAM,CAAC8C,IAAI;YACtE;QAEF,KAAKtE,4BAA4BuE,eAAe;YAC9CP,aAAa3D,OAAO,GAAGwB,YAAYL,MAAM,CAACnB,OAAO;YACjD;QAEF,KAAKL,4BAA4BwE,kBAAkB;YACjDR,aAAaxD,UAAU,GAAGqB,YAAYL,MAAM,CAAChB,UAAU,GACnDf,UAAUoC,YAAYL,MAAM,CAAChB,UAAU,IACvCiE;YACJ;QAEF,KAAKzE,4BAA4B0E,cAAc;YAC7CV,aAAavD,MAAM,CAACkE,MAAM,GAAG/E,gBAAgB+B;YAC7C;QAEF,wBAAwB,GACxB;YACEzC,iBAAiB+C,MAAMgC,MAAM;IACjC;IAEAH,WAAWtC,MAAM,GAAGwC;IACpBF,WAAWF,KAAK,GAAGH,KAAKC,SAAS,CAACM;IAClC,OAAOF;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAehC,kBACpBjB,QAAgB,EAChBe,QAAc,EACdb,UAAmB;IAEnB,IAAI,CAAC3B,cAAcwC,WAAW;QAC5B,OAAO6C;IACT;IAEA,MAAMG,iBAAiB,AAAChD,SAAmCnB,MAAM,EAAE0D,UAC/DC,KAAKS;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAOH;IACT;IAEA,IAAI1D,YAAY;QACd,OAAO,IAAIb,YAAY;YACrB4E,MAAMtF,UAAU4B,IAAI,CAACP,UAAU+D;YAC/BhB,OAAO7C;QACT;IACF;IAEA,IAAI;QACF,MAAMgE,cAAc,MAAM9E,gBACxBT,UAAU4B,IAAI,CAACP,UAAU+D,iBACzB;QAEF,OAAOG;IACT,EAAE,OAAO9C,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,iCAAiC,EAAEd,MAAME,OAAO,CAAC,CAAC;IACrE;AACF;AAEA;;;;;;;CAOC,GACD,OAAO,eAAeH,YACpBnB,QAAgB,EAChBe,QAAc;IAEd,IAAI,CAACxC,cAAcwC,WAAW;QAC5B,OAAO6C;IACT;IAEA,MAAMO,WAAW,AAACpD,SAAmCnB,MAAM,EAAE0D,UAAUC,KACnEY;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOP;IACT;IAEA,IAAI;QACF,MAAMM,cAAc,MAAM9E,gBACxBT,UAAU4B,IAAI,CAACP,UAAUmE,WACzB;QAEF,OAAOD;IACT,EAAE,OAAO9C,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAEd,MAAME,OAAO,CAAC,CAAC;IACnE;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASwB,oBAAoB/B,QAAsB;IACxD,MAAM,EAAEpB,UAAU,EAAE,GAAGyE,WAAW,GAAGrD;IAErC,MAAMa,OAAOD,OAAOC,IAAI,CACtBjC,aAAa;QAAE,GAAGyE,SAAS;QAAEzE;IAAW,IAAIyE;IAG9C,MAAMC,mBAAmBzC,KACtB0C,IAAI,CAAC,CAACC,GAAGC,IAAMlF,mBAAmB,CAACiF,EAAE,GAAGjF,mBAAmB,CAACkF,EAAE,EAC9DhC,MAAM,CACL,CAAC7B,QAAQ4B,MAAS,CAAA;YAChB,GAAG5B,MAAM;YACT,CAAC4B,IAAI,EAAExB,QAAQ,CAACwB,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAO8B;AACT;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASrC,wBAAwB,EACtCjB,QAAQ,EACRC,WAAW,EACXd,UAAU,EACVgB,OAAO,EACG;IACV,MAAMuD,kBAAkBzD,YAAYL,MAAM,CAAC8C,IAAI;IAC/C,MAAMiB,qBAAqB1D,YAAYL,MAAM,CAACnB,OAAO;IACrD,MAAMmF,wBAAwB3D,YAAYL,MAAM,CAAChB,UAAU;IAE3D,MAAMiF,sBAAsB7D,SAASJ,MAAM,CAACf,MAAM,CAAC0D,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAMqB,yBAAyB9D,SAASJ,MAAM,CAACnB,OAAO;IACtD,MAAMsF,qBAAqB/D,SAASJ,MAAM,CAAChB,UAAU;IAErD,IAAI8E,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAI5F,iCACR,CAAC,CAAC,EAAEE,iBAAiBsB,QAAQ,CAAC,qBAAqB,EAAEoE,oBAAoB,uBAAuB,EAAE1F,iBAAiB2B,WAAW,CAAC,iBAAiB,EAAE4D,gBAAgB,GAAG,CAAC,EACtKtF,4BAA4BkE,YAAY;IAE5C;IAEA,IAAIqB,uBAAuBG,wBAAwB;QACjD,MAAM,IAAI7F,iCACR,CAAC,CAAC,EAAEE,iBAAiBsB,QAAQ,CAAC,wBAAwB,EAAEqE,uBAAuB,uBAAuB,EAAE3F,iBAAiB2B,WAAW,CAAC,oBAAoB,EAAE6D,mBAAmB,GAAG,CAAC,EAClLvF,4BAA4BuE,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvDiB,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACtG,UAAUmG,uBAAuBG,qBAClC;QACA,MAAM,IAAI9F,iCACR,CAAC,CAAC,EAAEE,iBAAiBsB,QAAQ,CAAC,yCAAyC,EAAEtB,iBAAiB2B,WAAW,CAAC,qBAAqB,CAAC,EAC5H1B,4BAA4BwE,kBAAkB;IAElD;IAEA1E,mBACE;QAAE8B;QAAUb;QAAYgB;IAAQ,GAChC,CAAC,CAAC,EAAEhC,iBAAiBsB,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}
+{"version":3,"sources":["../../../src/manifest/manifest.ts"],"sourcesContent":["import type { Json } from '@metamask/utils';\nimport { assertExhaustive, assert, isPlainObject } from '@metamask/utils';\nimport deepEqual from 'fast-deep-equal';\nimport { promises as fs } from 'fs';\nimport pathUtils from 'path';\n\nimport { deepClone } from '../deep-clone';\nimport { readJsonFile } from '../fs';\nimport { validateNpmSnap } from '../npm';\nimport {\n  getSnapChecksum,\n  ProgrammaticallyFixableSnapError,\n  validateSnapShasum,\n} from '../snaps';\nimport type { SnapFiles, UnvalidatedSnapFiles } from '../types';\nimport { NpmSnapFileNames, SnapValidationFailureReason } from '../types';\nimport { readVirtualFile, VirtualFile } from '../virtual-file';\nimport type { SnapManifest } from './validation';\n\nconst MANIFEST_SORT_ORDER: Record<keyof SnapManifest, number> = {\n  $schema: 1,\n  version: 2,\n  description: 3,\n  proposedName: 4,\n  repository: 5,\n  source: 6,\n  initialPermissions: 7,\n  manifestVersion: 8,\n};\n\n/**\n * The result from the `checkManifest` function.\n *\n * @property manifest - The fixed manifest object.\n * @property updated - Whether the manifest was updated.\n * @property warnings - An array of warnings that were encountered during\n * processing of the manifest files. These warnings are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n * @property errors - An array of errors that were encountered during\n * processing of the manifest files. These errors are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n */\nexport type CheckManifestResult = {\n  manifest: SnapManifest;\n  updated?: boolean;\n  warnings: string[];\n  errors: string[];\n};\n\nexport type WriteFileFunction = (path: string, data: string) => Promise<void>;\n\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param writeManifest - Whether to write the fixed manifest to disk.\n * @param sourceCode - The source code of the Snap.\n * @param writeFileFn - The function to use to write the manifest to disk.\n * @returns Whether the manifest was updated, and an array of warnings that\n * were encountered during processing of the manifest files.\n */\nexport async function checkManifest(\n  basePath: string,\n  writeManifest = true,\n  sourceCode?: string,\n  writeFileFn: WriteFileFunction = fs.writeFile,\n): Promise<CheckManifestResult> {\n  const warnings: string[] = [];\n  const errors: string[] = [];\n\n  let updated = false;\n\n  const manifestPath = pathUtils.join(basePath, NpmSnapFileNames.Manifest);\n  const manifestFile = await readJsonFile(manifestPath);\n  const unvalidatedManifest = manifestFile.result;\n\n  const packageFile = await readJsonFile(\n    pathUtils.join(basePath, NpmSnapFileNames.PackageJson),\n  );\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: manifestFile,\n    packageJson: packageFile,\n    sourceCode: await getSnapSourceCode(\n      basePath,\n      unvalidatedManifest,\n      sourceCode,\n    ),\n    svgIcon: await getSnapIcon(basePath, unvalidatedManifest),\n  };\n\n  let manifest: VirtualFile<SnapManifest> | undefined;\n  try {\n    ({ manifest } = validateNpmSnap(snapFiles));\n  } catch (error) {\n    if (error instanceof ProgrammaticallyFixableSnapError) {\n      errors.push(error.message);\n\n      // If we get here, the files at least have the correct shape.\n      const partiallyValidatedFiles = snapFiles as SnapFiles;\n\n      let isInvalid = true;\n      let currentError = error;\n      const maxAttempts = Object.keys(SnapValidationFailureReason).length;\n\n      // Attempt to fix all fixable validation failure reasons. All such reasons\n      // are enumerated by the `SnapValidationFailureReason` enum, so we only\n      // attempt to fix the manifest the same amount of times as there are\n      // reasons in the enum.\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = fixManifest(\n          manifest\n            ? { ...partiallyValidatedFiles, manifest }\n            : partiallyValidatedFiles,\n          currentError,\n        );\n\n        try {\n          validateNpmSnapManifest({ ...partiallyValidatedFiles, manifest });\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          currentError = nextValidationError;\n          /* istanbul ignore next: this should be impossible */\n          if (\n            !(\n              nextValidationError instanceof ProgrammaticallyFixableSnapError\n            ) ||\n            (attempts === maxAttempts && !isInvalid)\n          ) {\n            throw new Error(\n              `Internal error: Failed to fix manifest. This is a bug, please report it. Reason:\\n${error.message}`,\n            );\n          }\n\n          errors.push(currentError.message);\n        }\n      }\n\n      updated = true;\n    } else {\n      throw error;\n    }\n  }\n\n  // TypeScript assumes `manifest` can still be undefined, that is not the case.\n  // But we assert to keep TypeScript happy.\n  assert(manifest);\n\n  const validatedManifest = manifest.result;\n\n  // Check presence of recommended keys\n  const recommendedFields = ['repository'] as const;\n\n  const missingRecommendedFields = recommendedFields.filter(\n    (key) => !validatedManifest[key],\n  );\n\n  if (missingRecommendedFields.length > 0) {\n    warnings.push(\n      `Missing recommended package.json properties:\\n${missingRecommendedFields.reduce(\n        (allMissing, currentField) => {\n          return `${allMissing}\\t${currentField}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  if (writeManifest) {\n    try {\n      const newManifest = `${JSON.stringify(\n        getWritableManifest(validatedManifest),\n        null,\n        2,\n      )}\\n`;\n\n      if (updated || newManifest !== manifestFile.value) {\n        await writeFileFn(\n          pathUtils.join(basePath, NpmSnapFileNames.Manifest),\n          newManifest,\n        );\n      }\n    } catch (error) {\n      // Note: This error isn't pushed to the errors array, because it's not an\n      // error in the manifest itself.\n      throw new Error(`Failed to update snap.manifest.json: ${error.message}`);\n    }\n  }\n\n  return { manifest: validatedManifest, updated, warnings, errors };\n}\n\n/**\n * Given the relevant Snap files (manifest, `package.json`, and bundle) and a\n * Snap manifest validation error, fixes the fault in the manifest that caused\n * the error.\n *\n * @param snapFiles - The contents of all Snap files.\n * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.\n * @returns A copy of the manifest file where the cause of the error is fixed.\n */\nexport function fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): VirtualFile<SnapManifest> {\n  const { manifest, packageJson } = snapFiles;\n  const clonedFile = manifest.clone();\n  const manifestCopy = clonedFile.result;\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.result.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.result.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.result.repository\n        ? deepClone(packageJson.result.repository)\n        : undefined;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = getSnapChecksum(snapFiles);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      assertExhaustive(error.reason);\n  }\n\n  clonedFile.result = manifestCopy;\n  clonedFile.value = JSON.stringify(manifestCopy);\n  return clonedFile;\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * bundle source file location and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @param sourceCode - Override source code for plugins.\n * @returns The contents of the bundle file, if any.\n */\nexport async function getSnapSourceCode(\n  basePath: string,\n  manifest: Json,\n  sourceCode?: string,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n    ?.npm?.filePath;\n\n  if (!sourceFilePath) {\n    return undefined;\n  }\n\n  if (sourceCode) {\n    return new VirtualFile({\n      path: pathUtils.join(basePath, sourceFilePath),\n      value: sourceCode,\n    });\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, sourceFilePath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read snap bundle file: ${error.message}`);\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * icon and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the icon, if any.\n */\nexport async function getSnapIcon(\n  basePath: string,\n  manifest: Json,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const iconPath = (manifest as Partial<SnapManifest>).source?.location?.npm\n    ?.iconPath;\n\n  if (!iconPath) {\n    return undefined;\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, iconPath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read snap icon file: ${error.message}`);\n  }\n}\n\n/**\n * Sorts the given manifest in our preferred sort order and removes the\n * `repository` field if it is falsy (it may be `null`).\n *\n * @param manifest - The manifest to sort and modify.\n * @returns The disk-ready manifest.\n */\nexport function getWritableManifest(manifest: SnapManifest): SnapManifest {\n  const { repository, ...remaining } = manifest;\n\n  const keys = Object.keys(\n    repository ? { ...remaining, repository } : remaining,\n  ) as (keyof SnapManifest)[];\n\n  const writableManifest = keys\n    .sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b])\n    .reduce<Partial<SnapManifest>>(\n      (result, key) => ({\n        ...result,\n        [key]: manifest[key],\n      }),\n      {},\n    );\n\n  return writableManifest as SnapManifest;\n}\n\n/**\n * Validates the fields of an npm Snap manifest that has already passed JSON\n * Schema validation.\n *\n * @param snapFiles - The relevant snap files to validate.\n * @param snapFiles.manifest - The npm Snap manifest to validate.\n * @param snapFiles.packageJson - The npm Snap's `package.json`.\n * @param snapFiles.sourceCode - The Snap's source code.\n * @param snapFiles.svgIcon - The Snap's optional icon.\n */\nexport function validateNpmSnapManifest({\n  manifest,\n  packageJson,\n  sourceCode,\n  svgIcon,\n}: SnapFiles) {\n  const packageJsonName = packageJson.result.name;\n  const packageJsonVersion = packageJson.result.version;\n  const packageJsonRepository = packageJson.result.repository;\n\n  const manifestPackageName = manifest.result.source.location.npm.packageName;\n  const manifestPackageVersion = manifest.result.version;\n  const manifestRepository = manifest.result.repository;\n\n  if (packageJsonName !== manifestPackageName) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package name (\"${manifestPackageName}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"name\" field (\"${packageJsonName}\").`,\n      SnapValidationFailureReason.NameMismatch,\n    );\n  }\n\n  if (packageJsonVersion !== manifestPackageVersion) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package version (\"${manifestPackageVersion}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"version\" field (\"${packageJsonVersion}\").`,\n      SnapValidationFailureReason.VersionMismatch,\n    );\n  }\n\n  if (\n    // The repository may be `undefined` in package.json but can only be defined\n    // or `null` in the Snap manifest due to TS@<4.4 issues.\n    (packageJsonRepository || manifestRepository) &&\n    !deepEqual(packageJsonRepository, manifestRepository)\n  ) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" \"repository\" field does not match the \"${NpmSnapFileNames.PackageJson}\" \"repository\" field.`,\n      SnapValidationFailureReason.RepositoryMismatch,\n    );\n  }\n\n  validateSnapShasum(\n    { manifest, sourceCode, svgIcon },\n    `\"${NpmSnapFileNames.Manifest}\" \"shasum\" field does not match computed shasum.`,\n  );\n}\n"],"names":["assertExhaustive","assert","isPlainObject","deepEqual","promises","fs","pathUtils","deepClone","readJsonFile","validateNpmSnap","getSnapChecksum","ProgrammaticallyFixableSnapError","validateSnapShasum","NpmSnapFileNames","SnapValidationFailureReason","readVirtualFile","VirtualFile","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialPermissions","manifestVersion","checkManifest","basePath","writeManifest","sourceCode","writeFileFn","writeFile","warnings","errors","updated","manifestPath","join","Manifest","manifestFile","unvalidatedManifest","result","packageFile","PackageJson","snapFiles","manifest","packageJson","getSnapSourceCode","svgIcon","getSnapIcon","error","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","length","attempts","fixManifest","validateNpmSnapManifest","nextValidationError","Error","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","newManifest","JSON","stringify","getWritableManifest","value","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","undefined","ShasumMismatch","shasum","sourceFilePath","filePath","path","virtualFile","iconPath","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository"],"mappings":"AACA,SAASA,gBAAgB,EAAEC,MAAM,EAAEC,aAAa,QAAQ,kBAAkB;AAC1E,OAAOC,eAAe,kBAAkB;AACxC,SAASC,YAAYC,EAAE,QAAQ,KAAK;AACpC,OAAOC,eAAe,OAAO;AAE7B,SAASC,SAAS,QAAQ,gBAAgB;AAC1C,SAASC,YAAY,QAAQ,QAAQ;AACrC,SAASC,eAAe,QAAQ,SAAS;AACzC,SACEC,eAAe,EACfC,gCAAgC,EAChCC,kBAAkB,QACb,WAAW;AAElB,SAASC,gBAAgB,EAAEC,2BAA2B,QAAQ,WAAW;AACzE,SAASC,eAAe,EAAEC,WAAW,QAAQ,kBAAkB;AAG/D,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,iBAAiB;AACnB;AAyBA;;;;;;;;;;;CAWC,GACD,OAAO,eAAeC,cACpBC,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB,EACnBC,cAAiCzB,GAAG0B,SAAS;IAE7C,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAe7B,UAAU8B,IAAI,CAACT,UAAUd,iBAAiBwB,QAAQ;IACvE,MAAMC,eAAe,MAAM9B,aAAa2B;IACxC,MAAMI,sBAAsBD,aAAaE,MAAM;IAE/C,MAAMC,cAAc,MAAMjC,aACxBF,UAAU8B,IAAI,CAACT,UAAUd,iBAAiB6B,WAAW;IAGvD,MAAMC,YAAkC;QACtCC,UAAUN;QACVO,aAAaJ;QACbZ,YAAY,MAAMiB,kBAChBnB,UACAY,qBACAV;QAEFkB,SAAS,MAAMC,YAAYrB,UAAUY;IACvC;IAEA,IAAIK;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAGnC,gBAAgBkC,UAAS;IAC3C,EAAE,OAAOM,OAAO;QACd,IAAIA,iBAAiBtC,kCAAkC;YACrDsB,OAAOiB,IAAI,CAACD,MAAME,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BT;YAEhC,IAAIU,YAAY;YAChB,IAAIC,eAAeL;YACnB,MAAMM,cAAcC,OAAOC,IAAI,CAAC3C,6BAA6B4C,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGN,aAAaM,YAAYJ,aAAaI,WAAY;gBACvEf,WAAWgB,YACThB,WACI;oBAAE,GAAGQ,uBAAuB;oBAAER;gBAAS,IACvCQ,yBACJE;gBAGF,IAAI;oBACFO,wBAAwB;wBAAE,GAAGT,uBAAuB;wBAAER;oBAAS;oBAE/DS,YAAY;gBACd,EAAE,OAAOS,qBAAqB;oBAC5BR,eAAeQ;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+BnD,gCAA+B,KAE/DgD,aAAaJ,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIU,MACR,CAAC,kFAAkF,EAAEd,MAAME,OAAO,CAAC,CAAC;oBAExG;oBAEAlB,OAAOiB,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEAjB,UAAU;QACZ,OAAO;YACL,MAAMe;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1ChD,OAAO2C;IAEP,MAAMoB,oBAAoBpB,SAASJ,MAAM;IAEzC,qCAAqC;IACrC,MAAMyB,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBR,MAAM,GAAG,GAAG;QACvC1B,SAASkB,IAAI,CACX,CAAC,8CAA8C,EAAEgB,yBAAyBG,MAAM,CAC9E,CAACC,YAAYC;YACX,OAAO,CAAC,EAAED,WAAW,EAAE,EAAEC,aAAa,EAAE,CAAC;QAC3C,GACA,IACA,CAAC;IAEP;IAEA,IAAI3C,eAAe;QACjB,IAAI;YACF,MAAM4C,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnCC,oBAAoBX,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAI9B,WAAWsC,gBAAgBlC,aAAasC,KAAK,EAAE;gBACjD,MAAM9C,YACJxB,UAAU8B,IAAI,CAACT,UAAUd,iBAAiBwB,QAAQ,GAClDmC;YAEJ;QACF,EAAE,OAAOvB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAME,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEP,UAAUoB;QAAmB9B;QAASF;QAAUC;IAAO;AAClE;AAEA;;;;;;;;CAQC,GACD,OAAO,SAAS2B,YACdjB,SAAoB,EACpBM,KAAuC;IAEvC,MAAM,EAAEL,QAAQ,EAAEC,WAAW,EAAE,GAAGF;IAClC,MAAMkC,aAAajC,SAASkC,KAAK;IACjC,MAAMC,eAAeF,WAAWrC,MAAM;IAEtC,OAAQS,MAAM+B,MAAM;QAClB,KAAKlE,4BAA4BmE,YAAY;YAC3CF,aAAaxD,MAAM,CAAC2D,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAGvC,YAAYL,MAAM,CAAC6C,IAAI;YACtE;QAEF,KAAKvE,4BAA4BwE,eAAe;YAC9CP,aAAa5D,OAAO,GAAG0B,YAAYL,MAAM,CAACrB,OAAO;YACjD;QAEF,KAAKL,4BAA4ByE,kBAAkB;YACjDR,aAAazD,UAAU,GAAGuB,YAAYL,MAAM,CAAClB,UAAU,GACnDf,UAAUsC,YAAYL,MAAM,CAAClB,UAAU,IACvCkE;YACJ;QAEF,KAAK1E,4BAA4B2E,cAAc;YAC7CV,aAAaxD,MAAM,CAACmE,MAAM,GAAGhF,gBAAgBiC;YAC7C;QAEF,wBAAwB,GACxB;YACE3C,iBAAiBiD,MAAM+B,MAAM;IACjC;IAEAH,WAAWrC,MAAM,GAAGuC;IACpBF,WAAWD,KAAK,GAAGH,KAAKC,SAAS,CAACK;IAClC,OAAOF;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAe/B,kBACpBnB,QAAgB,EAChBiB,QAAc,EACdf,UAAmB;IAEnB,IAAI,CAAC3B,cAAc0C,WAAW;QAC5B,OAAO4C;IACT;IAEA,MAAMG,iBAAiB,AAAC/C,SAAmCrB,MAAM,EAAE2D,UAC/DC,KAAKS;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAOH;IACT;IAEA,IAAI3D,YAAY;QACd,OAAO,IAAIb,YAAY;YACrB6E,MAAMvF,UAAU8B,IAAI,CAACT,UAAUgE;YAC/Bf,OAAO/C;QACT;IACF;IAEA,IAAI;QACF,MAAMiE,cAAc,MAAM/E,gBACxBT,UAAU8B,IAAI,CAACT,UAAUgE,iBACzB;QAEF,OAAOG;IACT,EAAE,OAAO7C,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,iCAAiC,EAAEd,MAAME,OAAO,CAAC,CAAC;IACrE;AACF;AAEA;;;;;;;CAOC,GACD,OAAO,eAAeH,YACpBrB,QAAgB,EAChBiB,QAAc;IAEd,IAAI,CAAC1C,cAAc0C,WAAW;QAC5B,OAAO4C;IACT;IAEA,MAAMO,WAAW,AAACnD,SAAmCrB,MAAM,EAAE2D,UAAUC,KACnEY;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOP;IACT;IAEA,IAAI;QACF,MAAMM,cAAc,MAAM/E,gBACxBT,UAAU8B,IAAI,CAACT,UAAUoE,WACzB;QAEF,OAAOD;IACT,EAAE,OAAO7C,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAEd,MAAME,OAAO,CAAC,CAAC;IACnE;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASwB,oBAAoB/B,QAAsB;IACxD,MAAM,EAAEtB,UAAU,EAAE,GAAG0E,WAAW,GAAGpD;IAErC,MAAMa,OAAOD,OAAOC,IAAI,CACtBnC,aAAa;QAAE,GAAG0E,SAAS;QAAE1E;IAAW,IAAI0E;IAG9C,MAAMC,mBAAmBxC,KACtByC,IAAI,CAAC,CAACC,GAAGC,IAAMnF,mBAAmB,CAACkF,EAAE,GAAGlF,mBAAmB,CAACmF,EAAE,EAC9D/B,MAAM,CACL,CAAC7B,QAAQ4B,MAAS,CAAA;YAChB,GAAG5B,MAAM;YACT,CAAC4B,IAAI,EAAExB,QAAQ,CAACwB,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAO6B;AACT;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASpC,wBAAwB,EACtCjB,QAAQ,EACRC,WAAW,EACXhB,UAAU,EACVkB,OAAO,EACG;IACV,MAAMsD,kBAAkBxD,YAAYL,MAAM,CAAC6C,IAAI;IAC/C,MAAMiB,qBAAqBzD,YAAYL,MAAM,CAACrB,OAAO;IACrD,MAAMoF,wBAAwB1D,YAAYL,MAAM,CAAClB,UAAU;IAE3D,MAAMkF,sBAAsB5D,SAASJ,MAAM,CAACjB,MAAM,CAAC2D,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAMqB,yBAAyB7D,SAASJ,MAAM,CAACrB,OAAO;IACtD,MAAMuF,qBAAqB9D,SAASJ,MAAM,CAAClB,UAAU;IAErD,IAAI+E,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAI7F,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,qBAAqB,EAAEmE,oBAAoB,uBAAuB,EAAE3F,iBAAiB6B,WAAW,CAAC,iBAAiB,EAAE2D,gBAAgB,GAAG,CAAC,EACtKvF,4BAA4BmE,YAAY;IAE5C;IAEA,IAAIqB,uBAAuBG,wBAAwB;QACjD,MAAM,IAAI9F,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,wBAAwB,EAAEoE,uBAAuB,uBAAuB,EAAE5F,iBAAiB6B,WAAW,CAAC,oBAAoB,EAAE4D,mBAAmB,GAAG,CAAC,EAClLxF,4BAA4BwE,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvDiB,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACvG,UAAUoG,uBAAuBG,qBAClC;QACA,MAAM,IAAI/F,iCACR,CAAC,CAAC,EAAEE,iBAAiBwB,QAAQ,CAAC,yCAAyC,EAAExB,iBAAiB6B,WAAW,CAAC,qBAAqB,CAAC,EAC5H5B,4BAA4ByE,kBAAkB;IAElD;IAEA3E,mBACE;QAAEgC;QAAUf;QAAYkB;IAAQ,GAChC,CAAC,CAAC,EAAElC,iBAAiBwB,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}

package/dist/esm/strings.js

@@ -0,0 +1,11 @@
+/**
+ * Indent a message by adding a number of spaces to the beginning of each line.
+ *
+ * @param message - The message to indent.
+ * @param spaces - The number of spaces to indent by. Defaults to 2.
+ * @returns The indented message.
+ */ export function indent(message, spaces = 2) {
+    return message.replace(/^/gmu, ' '.repeat(spaces));
+}
+
+//# sourceMappingURL=strings.js.map

package/dist/esm/strings.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/strings.ts"],"sourcesContent":["/**\n * Indent a message by adding a number of spaces to the beginning of each line.\n *\n * @param message - The message to indent.\n * @param spaces - The number of spaces to indent by. Defaults to 2.\n * @returns The indented message.\n */\nexport function indent(message: string, spaces = 2) {\n  return message.replace(/^/gmu, ' '.repeat(spaces));\n}\n"],"names":["indent","message","spaces","replace","repeat"],"mappings":"AAAA;;;;;;CAMC,GACD,OAAO,SAASA,OAAOC,OAAe,EAAEC,SAAS,CAAC;IAChD,OAAOD,QAAQE,OAAO,CAAC,QAAQ,IAAIC,MAAM,CAACF;AAC5C"}