@metamask/snaps-utils 0.34.0-flask.1 → 0.35.0-flask.1

package/dist/cjs/handlers.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+//# sourceMappingURL=handlers.js.map

package/dist/cjs/handlers.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/handlers.ts"],"names":[],"mappings":""}

package/dist/cjs/icon.js

@@ -0,0 +1,37 @@
+"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, {
+    SVG_MAX_BYTE_SIZE: function() {
+        return SVG_MAX_BYTE_SIZE;
+    },
+    SVG_MAX_BYTE_SIZE_TEXT: function() {
+        return SVG_MAX_BYTE_SIZE_TEXT;
+    },
+    assertIsSnapIcon: function() {
+        return assertIsSnapIcon;
+    }
+});
+const _utils = require("@metamask/utils");
+const _issvg = /*#__PURE__*/ _interop_require_default(require("is-svg"));
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const SVG_MAX_BYTE_SIZE = 100000;
+const SVG_MAX_BYTE_SIZE_TEXT = `${Math.floor(SVG_MAX_BYTE_SIZE / 1000)}kb`;
+const assertIsSnapIcon = (icon)=>{
+    (0, _utils.assert)(icon.path.endsWith('.svg'), 'Expected snap icon to end in ".svg".');
+    (0, _utils.assert)(Buffer.byteLength(icon.value, 'utf8') <= SVG_MAX_BYTE_SIZE, `The specified SVG icon exceeds the maximum size of ${SVG_MAX_BYTE_SIZE_TEXT}.`);
+    (0, _utils.assert)((0, _issvg.default)(icon.toString()), 'Snap icon must be a valid SVG.');
+};
+
+//# sourceMappingURL=icon.js.map

package/dist/cjs/icon.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/icon.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\nimport isSvg from 'is-svg';\n\nimport { VirtualFile } from './virtual-file';\n\nexport const SVG_MAX_BYTE_SIZE = 100_000;\nexport const SVG_MAX_BYTE_SIZE_TEXT = `${Math.floor(\n  SVG_MAX_BYTE_SIZE / 1000,\n)}kb`;\n\nexport const assertIsSnapIcon = (icon: VirtualFile) => {\n  assert(icon.path.endsWith('.svg'), 'Expected snap icon to end in \".svg\".');\n\n  assert(\n    Buffer.byteLength(icon.value, 'utf8') <= SVG_MAX_BYTE_SIZE,\n    `The specified SVG icon exceeds the maximum size of ${SVG_MAX_BYTE_SIZE_TEXT}.`,\n  );\n\n  assert(isSvg(icon.toString()), 'Snap icon must be a valid SVG.');\n};\n"],"names":["SVG_MAX_BYTE_SIZE","SVG_MAX_BYTE_SIZE_TEXT","assertIsSnapIcon","Math","floor","icon","assert","path","endsWith","Buffer","byteLength","value","isSvg","toString"],"mappings":";;;;;;;;;;;IAKaA,iBAAiB;eAAjBA;;IACAC,sBAAsB;eAAtBA;;IAIAC,gBAAgB;eAAhBA;;;uBAVU;8DACL;;;;;;AAIX,MAAMF,oBAAoB;AAC1B,MAAMC,yBAAyB,CAAC,EAAEE,KAAKC,KAAK,CACjDJ,oBAAoB,MACpB,EAAE,CAAC;AAEE,MAAME,mBAAmB,CAACG;IAC/BC,IAAAA,aAAM,EAACD,KAAKE,IAAI,CAACC,QAAQ,CAAC,SAAS;IAEnCF,IAAAA,aAAM,EACJG,OAAOC,UAAU,CAACL,KAAKM,KAAK,EAAE,WAAWX,mBACzC,CAAC,mDAAmD,EAAEC,uBAAuB,CAAC,CAAC;IAGjFK,IAAAA,aAAM,EAACM,IAAAA,cAAK,EAACP,KAAKQ,QAAQ,KAAK;AACjC"}

package/dist/{iframe.js → cjs/iframe.js}

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createWindow = void 0;
 /**
  * Creates the iframe to be used as the execution environment. This may run
  * forever if the iframe never loads, but the promise should be wrapped in
@@ -10,9 +7,18 @@ exports.createWindow = void 0;
  * @param id - The ID to assign to the iframe.
  * @param sandbox - Whether to enable the sandbox attribute.
  * @returns A promise that resolves to the contentWindow of the iframe.
- */
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "createWindow", {
+    enumerable: true,
+    get: function() {
+        return createWindow;
+    }
+});
 async function createWindow(uri, id, sandbox = true) {
-    return await new Promise((resolve, reject) => {
+    return await new Promise((resolve, reject)=>{
         const iframe = document.createElement('iframe');
         // The order of operations appears to matter for everything except this
         // attribute. We may as well set it here.
@@ -38,11 +44,10 @@ async function createWindow(uri, id, sandbox = true) {
         // Re: `load` firing twice: https://stackoverflow.com/questions/10781880/dynamically-created-iframe-triggers-onload-event-twice/15880489#15880489
         iframe.setAttribute('src', uri);
         document.body.appendChild(iframe);
-        iframe.addEventListener('load', () => {
+        iframe.addEventListener('load', ()=>{
             if (iframe.contentWindow) {
                 resolve(iframe.contentWindow);
-            }
-            else {
+            } else {
                 // We don't know of a case when this would happen, but better to fail
                 // fast if it does.
                 reject(new Error(`iframe.contentWindow not present on load for job "${id}".`));
@@ -50,5 +55,5 @@ async function createWindow(uri, id, sandbox = true) {
         });
     });
 }
-exports.createWindow = createWindow;
+
 //# sourceMappingURL=iframe.js.map

package/dist/cjs/iframe.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/iframe.ts"],"sourcesContent":["/**\n * Creates the iframe to be used as the execution environment. This may run\n * forever if the iframe never loads, but the promise should be wrapped in\n * an initialization timeout in the SnapController.\n *\n * @param uri - The iframe URI.\n * @param id - The ID to assign to the iframe.\n * @param sandbox - Whether to enable the sandbox attribute.\n * @returns A promise that resolves to the contentWindow of the iframe.\n */\nexport async function createWindow(\n  uri: string,\n  id: string,\n  sandbox = true,\n): Promise<Window> {\n  return await new Promise((resolve, reject) => {\n    const iframe = document.createElement('iframe');\n    // The order of operations appears to matter for everything except this\n    // attribute. We may as well set it here.\n    iframe.setAttribute('id', id);\n    iframe.setAttribute('data-testid', 'snaps-iframe');\n\n    if (sandbox) {\n      // For the sandbox property to have any effect it needs to be set before the iframe is appended.\n      // We apply this property as a principle of least authority (POLA)\n      // measure.\n      // Ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox\n      iframe.setAttribute('sandbox', 'allow-scripts');\n    }\n\n    // In the past, we've had problems that appear to be symptomatic of the\n    // iframe firing the `load` event before its scripts are actually loaded,\n    // which has prevented snaps from executing properly. Therefore, we set\n    // the `src` attribute and append the iframe to the DOM before attaching\n    // the `load` listener.\n    //\n    // `load` should only fire when \"all dependent resources\" have been\n    // loaded, which includes scripts.\n    //\n    // MDN article for `load` event: https://developer.mozilla.org/en-US/docs/Web/API/Window/load_event\n    // Re: `load` firing twice: https://stackoverflow.com/questions/10781880/dynamically-created-iframe-triggers-onload-event-twice/15880489#15880489\n    iframe.setAttribute('src', uri);\n    document.body.appendChild(iframe);\n\n    iframe.addEventListener('load', () => {\n      if (iframe.contentWindow) {\n        resolve(iframe.contentWindow);\n      } else {\n        // We don't know of a case when this would happen, but better to fail\n        // fast if it does.\n        reject(\n          new Error(\n            `iframe.contentWindow not present on load for job \"${id}\".`,\n          ),\n        );\n      }\n    });\n  });\n}\n"],"names":["createWindow","uri","id","sandbox","Promise","resolve","reject","iframe","document","createElement","setAttribute","body","appendChild","addEventListener","contentWindow","Error"],"mappings":"AAAA;;;;;;;;;CASC;;;;+BACqBA;;;eAAAA;;;AAAf,eAAeA,aACpBC,GAAW,EACXC,EAAU,EACVC,UAAU,IAAI;IAEd,OAAO,MAAM,IAAIC,QAAQ,CAACC,SAASC;QACjC,MAAMC,SAASC,SAASC,aAAa,CAAC;QACtC,uEAAuE;QACvE,yCAAyC;QACzCF,OAAOG,YAAY,CAAC,MAAMR;QAC1BK,OAAOG,YAAY,CAAC,eAAe;QAEnC,IAAIP,SAAS;YACX,gGAAgG;YAChG,kEAAkE;YAClE,WAAW;YACX,qFAAqF;YACrFI,OAAOG,YAAY,CAAC,WAAW;QACjC;QAEA,uEAAuE;QACvE,yEAAyE;QACzE,uEAAuE;QACvE,wEAAwE;QACxE,uBAAuB;QACvB,EAAE;QACF,mEAAmE;QACnE,kCAAkC;QAClC,EAAE;QACF,mGAAmG;QACnG,iJAAiJ;QACjJH,OAAOG,YAAY,CAAC,OAAOT;QAC3BO,SAASG,IAAI,CAACC,WAAW,CAACL;QAE1BA,OAAOM,gBAAgB,CAAC,QAAQ;YAC9B,IAAIN,OAAOO,aAAa,EAAE;gBACxBT,QAAQE,OAAOO,aAAa;YAC9B,OAAO;gBACL,qEAAqE;gBACrE,mBAAmB;gBACnBR,OACE,IAAIS,MACF,CAAC,kDAAkD,EAAEb,GAAG,EAAE,CAAC;YAGjE;QACF;IACF;AACF"}

package/dist/cjs/index.browser.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./array"), exports);
+_export_star(require("./caveats"), exports);
+_export_star(require("./checksum"), exports);
+_export_star(require("./cronjob"), exports);
+_export_star(require("./deep-clone"), exports);
+_export_star(require("./default-endowments"), exports);
+_export_star(require("./entropy"), exports);
+_export_star(require("./enum"), exports);
+_export_star(require("./handlers"), exports);
+_export_star(require("./iframe"), exports);
+_export_star(require("./json"), exports);
+_export_star(require("./json-rpc"), exports);
+_export_star(require("./logging"), exports);
+_export_star(require("./manifest/index.browser"), exports);
+_export_star(require("./namespace"), exports);
+_export_star(require("./path"), exports);
+_export_star(require("./snaps"), exports);
+_export_star(require("./types"), exports);
+_export_star(require("./validation"), exports);
+_export_star(require("./versions"), exports);
+_export_star(require("./virtual-file/index.browser"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}
+
+//# sourceMappingURL=index.browser.js.map

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

@@ -0,0 +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":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}

package/dist/cjs/index.executionenv.js

@@ -0,0 +1,24 @@
+// Special entrypoint for execution environments for bundle sizing reasons
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./handlers"), exports);
+_export_star(require("./logging"), exports);
+_export_star(require("./namespace"), exports);
+_export_star(require("./types"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}
+
+//# sourceMappingURL=index.executionenv.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/index.executionenv.ts"],"sourcesContent":["// Special entrypoint for execution environments for bundle sizing reasons\nexport * from './handlers';\nexport * from './logging';\nexport * from './namespace';\nexport * from './types';\n"],"names":[],"mappings":"AAAA,0EAA0E;;;;;qBAC5D;qBACA;qBACA;qBACA"}

package/dist/cjs/index.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./array"), exports);
+_export_star(require("./caveats"), exports);
+_export_star(require("./cronjob"), exports);
+_export_star(require("./checksum"), exports);
+_export_star(require("./deep-clone"), exports);
+_export_star(require("./default-endowments"), exports);
+_export_star(require("./entropy"), exports);
+_export_star(require("./enum"), exports);
+_export_star(require("./eval"), exports);
+_export_star(require("./fs"), exports);
+_export_star(require("./handlers"), exports);
+_export_star(require("./iframe"), exports);
+_export_star(require("./json"), exports);
+_export_star(require("./json-rpc"), exports);
+_export_star(require("./logging"), exports);
+_export_star(require("./manifest"), exports);
+_export_star(require("./mock"), exports);
+_export_star(require("./namespace"), exports);
+_export_star(require("./npm"), exports);
+_export_star(require("./path"), exports);
+_export_star(require("./post-process"), exports);
+_export_star(require("./snaps"), exports);
+_export_star(require("./types"), exports);
+_export_star(require("./validation"), exports);
+_export_star(require("./versions"), exports);
+_export_star(require("./virtual-file"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}
+
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +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":";;;;qBAAc;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA;qBACA"}

package/dist/cjs/json-rpc.js

@@ -0,0 +1,46 @@
+"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, {
+    RpcOriginsStruct: function() {
+        return RpcOriginsStruct;
+    },
+    assertIsRpcOrigins: function() {
+        return assertIsRpcOrigins;
+    },
+    assertIsJsonRpcSuccess: function() {
+        return assertIsJsonRpcSuccess;
+    }
+});
+const _utils = require("@metamask/utils");
+const _superstruct = require("superstruct");
+const RpcOriginsStruct = (0, _superstruct.refine)((0, _superstruct.object)({
+    dapps: (0, _superstruct.optional)((0, _superstruct.boolean)()),
+    snaps: (0, _superstruct.optional)((0, _superstruct.boolean)())
+}), 'RPC origins', (value)=>{
+    if (!Object.values(value).some(Boolean)) {
+        throw new Error('Must specify at least one JSON-RPC origin');
+    }
+    return true;
+});
+function assertIsRpcOrigins(value, // eslint-disable-next-line @typescript-eslint/naming-convention
+ErrorWrapper) {
+    (0, _utils.assertStruct)(value, RpcOriginsStruct, 'Invalid JSON-RPC origins', ErrorWrapper);
+}
+function assertIsJsonRpcSuccess(value) {
+    if (!(0, _utils.isJsonRpcSuccess)(value)) {
+        if ((0, _utils.isJsonRpcFailure)(value)) {
+            throw new Error(`JSON-RPC request failed: ${value.error.message}`);
+        }
+        throw new Error('Invalid JSON-RPC response.');
+    }
+}
+
+//# sourceMappingURL=json-rpc.js.map

package/dist/cjs/json-rpc.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/json-rpc.ts"],"sourcesContent":["import {\n  isJsonRpcFailure,\n  isJsonRpcSuccess,\n  Json,\n  JsonRpcSuccess,\n  AssertionErrorConstructor,\n  assertStruct,\n} from '@metamask/utils';\nimport { boolean, Infer, object, optional, refine } from 'superstruct';\n\nexport const RpcOriginsStruct = refine(\n  object({\n    dapps: optional(boolean()),\n    snaps: optional(boolean()),\n  }),\n  'RPC origins',\n  (value) => {\n    if (!Object.values(value).some(Boolean)) {\n      throw new Error('Must specify at least one JSON-RPC origin');\n    }\n\n    return true;\n  },\n);\n\nexport type RpcOrigins = Infer<typeof RpcOriginsStruct>;\n\n/**\n * Asserts that the given value is a valid {@link RpcOrigins} object.\n *\n * @param value - The value to assert.\n * @param ErrorWrapper - An optional error wrapper to use. Defaults to\n * {@link AssertionError}.\n * @throws If the value is not a valid {@link RpcOrigins} object.\n */\nexport function assertIsRpcOrigins(\n  value: unknown,\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is RpcOrigins {\n  assertStruct(\n    value,\n    RpcOriginsStruct,\n    'Invalid JSON-RPC origins',\n    ErrorWrapper,\n  );\n}\n\n/**\n * Assert that the given value is a successful JSON-RPC response. If the value\n * is not a success response, an error is thrown. If the value is an JSON-RPC\n * error, the error message is included in the thrown error.\n *\n * @param value - The value to check.\n * @throws If the value is not a JSON-RPC success response.\n */\nexport function assertIsJsonRpcSuccess(\n  value: unknown,\n): asserts value is JsonRpcSuccess<Json> {\n  if (!isJsonRpcSuccess(value)) {\n    if (isJsonRpcFailure(value)) {\n      throw new Error(`JSON-RPC request failed: ${value.error.message}`);\n    }\n\n    throw new Error('Invalid JSON-RPC response.');\n  }\n}\n"],"names":["RpcOriginsStruct","assertIsRpcOrigins","assertIsJsonRpcSuccess","refine","object","dapps","optional","boolean","snaps","value","Object","values","some","Boolean","Error","ErrorWrapper","assertStruct","isJsonRpcSuccess","isJsonRpcFailure","error","message"],"mappings":";;;;;;;;;;;IAUaA,gBAAgB;eAAhBA;;IAyBGC,kBAAkB;eAAlBA;;IAqBAC,sBAAsB;eAAtBA;;;uBAjDT;6BACkD;AAElD,MAAMF,mBAAmBG,IAAAA,mBAAM,EACpCC,IAAAA,mBAAM,EAAC;IACLC,OAAOC,IAAAA,qBAAQ,EAACC,IAAAA,oBAAO;IACvBC,OAAOF,IAAAA,qBAAQ,EAACC,IAAAA,oBAAO;AACzB,IACA,eACA,CAACE;IACC,IAAI,CAACC,OAAOC,MAAM,CAACF,OAAOG,IAAI,CAACC,UAAU;QACvC,MAAM,IAAIC,MAAM;IAClB;IAEA,OAAO;AACT;AAaK,SAASb,mBACdQ,KAAc,EACd,gEAAgE;AAChEM,YAAwC;IAExCC,IAAAA,mBAAY,EACVP,OACAT,kBACA,4BACAe;AAEJ;AAUO,SAASb,uBACdO,KAAc;IAEd,IAAI,CAACQ,IAAAA,uBAAgB,EAACR,QAAQ;QAC5B,IAAIS,IAAAA,uBAAgB,EAACT,QAAQ;YAC3B,MAAM,IAAIK,MAAM,CAAC,yBAAyB,EAAEL,MAAMU,KAAK,CAACC,OAAO,CAAC,CAAC;QACnE;QAEA,MAAM,IAAIN,MAAM;IAClB;AACF"}

package/dist/cjs/json.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "parseJson", {
+    enumerable: true,
+    get: function() {
+        return parseJson;
+    }
+});
+const _utils = require("@metamask/utils");
+function parseJson(json) {
+    return (0, _utils.getSafeJson)(JSON.parse(json));
+}
+
+//# sourceMappingURL=json.js.map

package/dist/cjs/json.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/json.ts"],"sourcesContent":["import { getSafeJson, Json } from '@metamask/utils';\n\n// TODO: Upstream this to @metamask/utils\n\n/**\n * Parse JSON safely.\n *\n * Does multiple kinds of validation and strips unwanted properties like\n * `__proto__` and `constructor`.\n *\n * @param json - A JSON string to be parsed.\n * @returns The parsed JSON object.\n * @template Type - The type of the JSON object. The type is not actually\n * checked, but it is used to infer the return type.\n */\nexport function parseJson<Type extends Json = Json>(json: string) {\n  return getSafeJson<Type>(JSON.parse(json));\n}\n"],"names":["parseJson","json","getSafeJson","JSON","parse"],"mappings":";;;;+BAegBA;;;eAAAA;;;uBAfkB;AAe3B,SAASA,UAAoCC,IAAY;IAC9D,OAAOC,IAAAA,kBAAW,EAAOC,KAAKC,KAAK,CAACH;AACtC"}

package/dist/cjs/logging.js

@@ -0,0 +1,40 @@
+"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, {
+    snapsLogger: function() {
+        return snapsLogger;
+    },
+    logInfo: function() {
+        return logInfo;
+    },
+    logError: function() {
+        return logError;
+    },
+    logWarning: function() {
+        return logWarning;
+    }
+});
+const _utils = require("@metamask/utils");
+const snapsLogger = (0, _utils.createProjectLogger)('snaps');
+function logInfo(message, ...optionalParams) {
+    // eslint-disable-next-line no-console
+    console.log(message, ...optionalParams);
+}
+function logError(error, ...optionalParams) {
+    // eslint-disable-next-line no-console
+    console.error(error, ...optionalParams);
+}
+function logWarning(message, ...optionalParams) {
+    // eslint-disable-next-line no-console
+    console.warn(message, ...optionalParams);
+}
+
+//# sourceMappingURL=logging.js.map

package/dist/cjs/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/logging.ts"],"sourcesContent":["import { createProjectLogger } from '@metamask/utils';\n\n// The global logger used across the monorepo. Other projects should use this\n// to create a module logger.\nexport const snapsLogger = createProjectLogger('snaps');\n\n/**\n * Log a message. Currently, this is just a wrapper around `console.log`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param message - The message to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logInfo(message: string, ...optionalParams: unknown[]): void {\n  // eslint-disable-next-line no-console\n  console.log(message, ...optionalParams);\n}\n\n/**\n * Log an error. Currently, this is just a wrapper around `console.error`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * These logs should always be visible, without requiring the user to enable\n * verbose logging (like setting a `DEBUG` environment variable), as they are\n * important for debugging snaps.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param error - The error to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logError(error: unknown, ...optionalParams: unknown[]): void {\n  // eslint-disable-next-line no-console\n  console.error(error, ...optionalParams);\n}\n\n/**\n * Log a warning. Currently, this is just a wrapper around `console.warn`, but\n * the implementation may change in the future. These logs will be included in\n * production builds, so they should be used sparingly, and not contain any\n * sensitive information.\n *\n * These logs should always be visible, without requiring the user to enable\n * verbose logging (like setting a `DEBUG` environment variable), as they are\n * important for debugging snaps.\n *\n * This function makes it easy to swap out the logging implementation in all\n * files at once.\n *\n * @param message - The message to log.\n * @param optionalParams - Additional parameters to pass to the logging.\n */\nexport function logWarning(\n  message: string,\n  ...optionalParams: unknown[]\n): void {\n  // eslint-disable-next-line no-console\n  console.warn(message, ...optionalParams);\n}\n"],"names":["snapsLogger","logInfo","logError","logWarning","createProjectLogger","message","optionalParams","console","log","error","warn"],"mappings":";;;;;;;;;;;IAIaA,WAAW;eAAXA;;IAcGC,OAAO;eAAPA;;IAqBAC,QAAQ;eAARA;;IAqBAC,UAAU;eAAVA;;;uBA5DoB;AAI7B,MAAMH,cAAcI,IAAAA,0BAAmB,EAAC;AAcxC,SAASH,QAAQI,OAAe,EAAE,GAAGC,cAAyB;IACnE,sCAAsC;IACtCC,QAAQC,GAAG,CAACH,YAAYC;AAC1B;AAkBO,SAASJ,SAASO,KAAc,EAAE,GAAGH,cAAyB;IACnE,sCAAsC;IACtCC,QAAQE,KAAK,CAACA,UAAUH;AAC1B;AAkBO,SAASH,WACdE,OAAe,EACf,GAAGC,cAAyB;IAE5B,sCAAsC;IACtCC,QAAQG,IAAI,CAACL,YAAYC;AAC3B"}

package/dist/cjs/manifest/index.browser.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./validation"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}
+
+//# sourceMappingURL=index.browser.js.map

package/dist/cjs/manifest/index.browser.js.map

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

package/dist/cjs/manifest/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./manifest"), exports);
+_export_star(require("./validation"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}
+
+//# sourceMappingURL=index.js.map

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

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

package/dist/cjs/manifest/manifest.js

@@ -0,0 +1,239 @@
+"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, {
+    checkManifest: function() {
+        return checkManifest;
+    },
+    fixManifest: function() {
+        return fixManifest;
+    },
+    getSnapSourceCode: function() {
+        return getSnapSourceCode;
+    },
+    getSnapIcon: function() {
+        return getSnapIcon;
+    },
+    getWritableManifest: function() {
+        return getWritableManifest;
+    },
+    validateNpmSnapManifest: function() {
+        return validateNpmSnapManifest;
+    }
+});
+const _utils = require("@metamask/utils");
+const _fastdeepequal = /*#__PURE__*/ _interop_require_default(require("fast-deep-equal"));
+const _fs = require("fs");
+const _path = /*#__PURE__*/ _interop_require_default(require("path"));
+const _deepclone = require("../deep-clone");
+const _fs1 = require("../fs");
+const _npm = require("../npm");
+const _snaps = require("../snaps");
+const _types = require("../types");
+const _virtualfile = require("../virtual-file");
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+const MANIFEST_SORT_ORDER = {
+    $schema: 1,
+    version: 2,
+    description: 3,
+    proposedName: 4,
+    repository: 5,
+    source: 6,
+    initialPermissions: 7,
+    manifestVersion: 8
+};
+async function checkManifest(basePath, writeManifest = true, sourceCode) {
+    const warnings = [];
+    const errors = [];
+    let updated = false;
+    const manifestPath = _path.default.join(basePath, _types.NpmSnapFileNames.Manifest);
+    const manifestFile = await (0, _fs1.readJsonFile)(manifestPath);
+    const unvalidatedManifest = manifestFile.result;
+    const packageFile = await (0, _fs1.readJsonFile)(_path.default.join(basePath, _types.NpmSnapFileNames.PackageJson));
+    const snapFiles = {
+        manifest: manifestFile,
+        packageJson: packageFile,
+        sourceCode: await getSnapSourceCode(basePath, unvalidatedManifest, sourceCode),
+        svgIcon: await getSnapIcon(basePath, unvalidatedManifest)
+    };
+    let manifest;
+    try {
+        ({ manifest } = (0, _npm.validateNpmSnap)(snapFiles));
+    } catch (error) {
+        if (error instanceof _snaps.ProgrammaticallyFixableSnapError) {
+            errors.push(error.message);
+            // If we get here, the files at least have the correct shape.
+            const partiallyValidatedFiles = snapFiles;
+            let isInvalid = true;
+            let currentError = error;
+            const maxAttempts = Object.keys(_types.SnapValidationFailureReason).length;
+            // Attempt to fix all fixable validation failure reasons. All such reasons
+            // are enumerated by the `SnapValidationFailureReason` enum, so we only
+            // attempt to fix the manifest the same amount of times as there are
+            // reasons in the enum.
+            for(let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++){
+                manifest = fixManifest(manifest ? {
+                    ...partiallyValidatedFiles,
+                    manifest
+                } : partiallyValidatedFiles, currentError);
+                try {
+                    validateNpmSnapManifest({
+                        ...partiallyValidatedFiles,
+                        manifest
+                    });
+                    isInvalid = false;
+                } catch (nextValidationError) {
+                    currentError = nextValidationError;
+                    /* istanbul ignore next: this should be impossible */ if (!(nextValidationError instanceof _snaps.ProgrammaticallyFixableSnapError) || attempts === maxAttempts && !isInvalid) {
+                        throw new Error(`Internal error: Failed to fix manifest. This is a bug, please report it. Reason:\n${error.message}`);
+                    }
+                    errors.push(currentError.message);
+                }
+            }
+            updated = true;
+        } else {
+            throw error;
+        }
+    }
+    // TypeScript assumes `manifest` can still be undefined, that is not the case.
+    // But we assert to keep TypeScript happy.
+    (0, _utils.assert)(manifest);
+    const validatedManifest = manifest.result;
+    // Check presence of recommended keys
+    const recommendedFields = [
+        'repository'
+    ];
+    const missingRecommendedFields = recommendedFields.filter((key)=>!validatedManifest[key]);
+    if (missingRecommendedFields.length > 0) {
+        warnings.push(`Missing recommended package.json properties:\n${missingRecommendedFields.reduce((allMissing, currentField)=>{
+            return `${allMissing}\t${currentField}\n`;
+        }, '')}`);
+    }
+    if (writeManifest) {
+        try {
+            const newManifest = `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\n`;
+            if (updated || newManifest !== manifestFile.value) {
+                await _fs.promises.writeFile(_path.default.join(basePath, _types.NpmSnapFileNames.Manifest), newManifest);
+            }
+        } catch (error) {
+            // Note: This error isn't pushed to the errors array, because it's not an
+            // error in the manifest itself.
+            throw new Error(`Failed to update snap.manifest.json: ${error.message}`);
+        }
+    }
+    return {
+        manifest: validatedManifest,
+        updated,
+        warnings,
+        errors
+    };
+}
+function fixManifest(snapFiles, error) {
+    const { manifest, packageJson } = snapFiles;
+    const clonedFile = manifest.clone();
+    const manifestCopy = clonedFile.result;
+    switch(error.reason){
+        case _types.SnapValidationFailureReason.NameMismatch:
+            manifestCopy.source.location.npm.packageName = packageJson.result.name;
+            break;
+        case _types.SnapValidationFailureReason.VersionMismatch:
+            manifestCopy.version = packageJson.result.version;
+            break;
+        case _types.SnapValidationFailureReason.RepositoryMismatch:
+            manifestCopy.repository = packageJson.result.repository ? (0, _deepclone.deepClone)(packageJson.result.repository) : undefined;
+            break;
+        case _types.SnapValidationFailureReason.ShasumMismatch:
+            manifestCopy.source.shasum = (0, _snaps.getSnapChecksum)(snapFiles);
+            break;
+        /* istanbul ignore next */ default:
+            (0, _utils.assertExhaustive)(error.reason);
+    }
+    clonedFile.result = manifestCopy;
+    clonedFile.value = JSON.stringify(manifestCopy);
+    return clonedFile;
+}
+async function getSnapSourceCode(basePath, manifest, sourceCode) {
+    if (!(0, _utils.isPlainObject)(manifest)) {
+        return undefined;
+    }
+    const sourceFilePath = manifest.source?.location?.npm?.filePath;
+    if (!sourceFilePath) {
+        return undefined;
+    }
+    if (sourceCode) {
+        return new _virtualfile.VirtualFile({
+            path: _path.default.join(basePath, sourceFilePath),
+            value: sourceCode
+        });
+    }
+    try {
+        const virtualFile = await (0, _virtualfile.readVirtualFile)(_path.default.join(basePath, sourceFilePath), 'utf8');
+        return virtualFile;
+    } catch (error) {
+        throw new Error(`Failed to read Snap bundle file: ${error.message}`);
+    }
+}
+async function getSnapIcon(basePath, manifest) {
+    if (!(0, _utils.isPlainObject)(manifest)) {
+        return undefined;
+    }
+    const iconPath = manifest.source?.location?.npm?.iconPath;
+    if (!iconPath) {
+        return undefined;
+    }
+    try {
+        const virtualFile = await (0, _virtualfile.readVirtualFile)(_path.default.join(basePath, iconPath), 'utf8');
+        return virtualFile;
+    } catch (error) {
+        throw new Error(`Failed to read Snap icon file: ${error.message}`);
+    }
+}
+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;
+}
+function validateNpmSnapManifest({ manifest, packageJson, sourceCode, svgIcon }) {
+    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 _snaps.ProgrammaticallyFixableSnapError(`"${_types.NpmSnapFileNames.Manifest}" npm package name ("${manifestPackageName}") does not match the "${_types.NpmSnapFileNames.PackageJson}" "name" field ("${packageJsonName}").`, _types.SnapValidationFailureReason.NameMismatch);
+    }
+    if (packageJsonVersion !== manifestPackageVersion) {
+        throw new _snaps.ProgrammaticallyFixableSnapError(`"${_types.NpmSnapFileNames.Manifest}" npm package version ("${manifestPackageVersion}") does not match the "${_types.NpmSnapFileNames.PackageJson}" "version" field ("${packageJsonVersion}").`, _types.SnapValidationFailureReason.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) && !(0, _fastdeepequal.default)(packageJsonRepository, manifestRepository)) {
+        throw new _snaps.ProgrammaticallyFixableSnapError(`"${_types.NpmSnapFileNames.Manifest}" "repository" field does not match the "${_types.NpmSnapFileNames.PackageJson}" "repository" field.`, _types.SnapValidationFailureReason.RepositoryMismatch);
+    }
+    (0, _snaps.validateSnapShasum)({
+        manifest,
+        sourceCode,
+        svgIcon
+    }, `"${_types.NpmSnapFileNames.Manifest}" "shasum" field does not match computed shasum.`);
+}
+
+//# sourceMappingURL=manifest.js.map