@metamask/snaps-utils 0.35.1-flask.1 → 1.0.0-prerelease.1

package/dist/npm.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateNpmSnap = exports.SnapFileNameFromKey = exports.EXPECTED_SNAP_FILES = exports.SVG_MAX_BYTE_SIZE_TEXT = exports.SVG_MAX_BYTE_SIZE = void 0;
+const manifest_1 = require("./manifest/manifest");
+const validation_1 = require("./manifest/validation");
+const types_1 = require("./types");
+exports.SVG_MAX_BYTE_SIZE = 100000;
+exports.SVG_MAX_BYTE_SIZE_TEXT = `${Math.floor(exports.SVG_MAX_BYTE_SIZE / 1000)}kb`;
+exports.EXPECTED_SNAP_FILES = [
+    'manifest',
+    'packageJson',
+    'sourceCode',
+];
+exports.SnapFileNameFromKey = {
+    manifest: types_1.NpmSnapFileNames.Manifest,
+    packageJson: types_1.NpmSnapFileNames.PackageJson,
+    sourceCode: 'source code bundle',
+};
+/**
+ * Validates the files extracted from an npm Snap package tarball by ensuring
+ * that they're non-empty and that the Json files match their respective schemas
+ * and the Snaps publishing specification.
+ *
+ * @param snapFiles - The object containing the expected Snap file contents,
+ * if any.
+ * @param errorPrefix - The prefix of the error message.
+ * @returns A tuple of the Snap manifest object and the Snap source code.
+ */
+function validateNpmSnap(snapFiles, errorPrefix) {
+    exports.EXPECTED_SNAP_FILES.forEach((key) => {
+        if (!snapFiles[key]) {
+            throw new Error(`${errorPrefix ?? ''}Missing file "${exports.SnapFileNameFromKey[key]}".`);
+        }
+    });
+    // Typecast: We are assured that the required files exist if we get here.
+    const { manifest, packageJson, sourceCode, svgIcon } = snapFiles;
+    try {
+        (0, validation_1.assertIsSnapManifest)(manifest.result);
+    }
+    catch (error) {
+        throw new Error(`${errorPrefix ?? ''}${error.message}`);
+    }
+    const validatedManifest = manifest;
+    const { iconPath } = validatedManifest.result.source.location.npm;
+    if (iconPath && !svgIcon) {
+        throw new Error(`Missing file "${iconPath}".`);
+    }
+    try {
+        (0, types_1.assertIsNpmSnapPackageJson)(packageJson.result);
+    }
+    catch (error) {
+        throw new Error(`${errorPrefix ?? ''}${error.message}`);
+    }
+    const validatedPackageJson = packageJson;
+    (0, manifest_1.validateNpmSnapManifest)({
+        manifest: validatedManifest,
+        packageJson: validatedPackageJson,
+        sourceCode,
+        svgIcon,
+    });
+    if (svgIcon) {
+        if (Buffer.byteLength(svgIcon.value, 'utf8') > exports.SVG_MAX_BYTE_SIZE) {
+            throw new Error(`${errorPrefix ?? ''}The specified SVG icon exceeds the maximum size of ${exports.SVG_MAX_BYTE_SIZE_TEXT}.`);
+        }
+    }
+    return {
+        manifest: validatedManifest,
+        packageJson: validatedPackageJson,
+        sourceCode,
+        svgIcon,
+    };
+}
+exports.validateNpmSnap = validateNpmSnap;
+//# sourceMappingURL=npm.js.map

package/dist/npm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"npm.js","sourceRoot":"","sources":["../src/npm.ts"],"names":[],"mappings":";;;AAAA,kDAA8D;AAC9D,sDAA6D;AAC7D,mCAKiB;AAEJ,QAAA,iBAAiB,GAAG,MAAO,CAAC;AAC5B,QAAA,sBAAsB,GAAG,GAAG,IAAI,CAAC,KAAK,CACjD,yBAAiB,GAAG,IAAI,CACzB,IAAI,CAAC;AAEO,QAAA,mBAAmB,GAAG;IACjC,UAAU;IACV,aAAa;IACb,YAAY;CACJ,CAAC;AAEE,QAAA,mBAAmB,GAAG;IACjC,QAAQ,EAAE,wBAAgB,CAAC,QAAQ;IACnC,WAAW,EAAE,wBAAgB,CAAC,WAAW;IACzC,UAAU,EAAE,oBAAoB;CACxB,CAAC;AAEX;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAC7B,SAA+B,EAC/B,WAA2B;IAE3B,2BAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAClC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,GAAG,WAAW,IAAI,EAAE,iBAAiB,2BAAmB,CAAC,GAAG,CAAC,IAAI,CAClE,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,yEAAyE;IACzE,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,SAAsB,CAAC;IAC9E,IAAI;QACF,IAAA,iCAAoB,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;KACvC;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,IAAI,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KACzD;IACD,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IAEnC,MAAM,EAAE,QAAQ,EAAE,GAAG,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;IAClE,IAAI,QAAQ,IAAI,CAAC,OAAO,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,iBAAiB,QAAQ,IAAI,CAAC,CAAC;KAChD;IAED,IAAI;QACF,IAAA,kCAA0B,EAAC,WAAW,CAAC,MAAM,CAAC,CAAC;KAChD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,IAAI,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KACzD;IACD,MAAM,oBAAoB,GAAG,WAAW,CAAC;IAEzC,IAAA,kCAAuB,EAAC;QACtB,QAAQ,EAAE,iBAAiB;QAC3B,WAAW,EAAE,oBAAoB;QACjC,UAAU;QACV,OAAO;KACR,CAAC,CAAC;IAEH,IAAI,OAAO,EAAE;QACX,IAAI,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,yBAAiB,EAAE;YAChE,MAAM,IAAI,KAAK,CACb,GACE,WAAW,IAAI,EACjB,sDAAsD,8BAAsB,GAAG,CAChF,CAAC;SACH;KACF;IAED,OAAO;QACL,QAAQ,EAAE,iBAAiB;QAC3B,WAAW,EAAE,oBAAoB;QACjC,UAAU;QACV,OAAO;KACR,CAAC;AACJ,CAAC;AAxDD,0CAwDC","sourcesContent":["import { validateNpmSnapManifest } from './manifest/manifest';\nimport { assertIsSnapManifest } from './manifest/validation';\nimport {\n  assertIsNpmSnapPackageJson,\n  NpmSnapFileNames,\n  SnapFiles,\n  UnvalidatedSnapFiles,\n} from './types';\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 EXPECTED_SNAP_FILES = [\n  'manifest',\n  'packageJson',\n  'sourceCode',\n] as const;\n\nexport const SnapFileNameFromKey = {\n  manifest: NpmSnapFileNames.Manifest,\n  packageJson: NpmSnapFileNames.PackageJson,\n  sourceCode: 'source code bundle',\n} as const;\n\n/**\n * Validates the files extracted from an npm Snap package tarball by ensuring\n * that they're non-empty and that the Json files match their respective schemas\n * and the Snaps publishing specification.\n *\n * @param snapFiles - The object containing the expected Snap file contents,\n * if any.\n * @param errorPrefix - The prefix of the error message.\n * @returns A tuple of the Snap manifest object and the Snap source code.\n */\nexport function validateNpmSnap(\n  snapFiles: UnvalidatedSnapFiles,\n  errorPrefix?: `${string}: `,\n): SnapFiles {\n  EXPECTED_SNAP_FILES.forEach((key) => {\n    if (!snapFiles[key]) {\n      throw new Error(\n        `${errorPrefix ?? ''}Missing file \"${SnapFileNameFromKey[key]}\".`,\n      );\n    }\n  });\n\n  // Typecast: We are assured that the required files exist if we get here.\n  const { manifest, packageJson, sourceCode, svgIcon } = snapFiles as SnapFiles;\n  try {\n    assertIsSnapManifest(manifest.result);\n  } catch (error) {\n    throw new Error(`${errorPrefix ?? ''}${error.message}`);\n  }\n  const validatedManifest = manifest;\n\n  const { iconPath } = validatedManifest.result.source.location.npm;\n  if (iconPath && !svgIcon) {\n    throw new Error(`Missing file \"${iconPath}\".`);\n  }\n\n  try {\n    assertIsNpmSnapPackageJson(packageJson.result);\n  } catch (error) {\n    throw new Error(`${errorPrefix ?? ''}${error.message}`);\n  }\n  const validatedPackageJson = packageJson;\n\n  validateNpmSnapManifest({\n    manifest: validatedManifest,\n    packageJson: validatedPackageJson,\n    sourceCode,\n    svgIcon,\n  });\n\n  if (svgIcon) {\n    if (Buffer.byteLength(svgIcon.value, 'utf8') > SVG_MAX_BYTE_SIZE) {\n      throw new Error(\n        `${\n          errorPrefix ?? ''\n        }The specified SVG icon exceeds the maximum size of ${SVG_MAX_BYTE_SIZE_TEXT}.`,\n      );\n    }\n  }\n\n  return {\n    manifest: validatedManifest,\n    packageJson: validatedPackageJson,\n    sourceCode,\n    svgIcon,\n  };\n}\n"]}

package/dist/path.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeRelative = void 0;
+const utils_1 = require("@metamask/utils");
+/**
+ * Normalizes relative paths by optionally removing `./` prefix.
+ *
+ * @param path - Path to make normalize.
+ * @returns The same path, with `./` prefix remove.
+ */
+// TODO(ritave): Include NodeJS path polyfill and use path.normalize as well
+function normalizeRelative(path) {
+    (0, utils_1.assert)(!path.startsWith('/'));
+    (0, utils_1.assert)(path.search(/:|\/\//u) === -1, `Path "${path}" potentially an URI instead of local relative`);
+    if (path.startsWith('./')) {
+        return path.slice(2);
+    }
+    return path;
+}
+exports.normalizeRelative = normalizeRelative;
+//# sourceMappingURL=path.js.map

package/dist/path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":";;;AAAA,2CAAyC;AAEzC;;;;;GAKG;AACH,4EAA4E;AAC5E,SAAgB,iBAAiB,CAAC,IAAY;IAC5C,IAAA,cAAM,EAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9B,IAAA,cAAM,EACJ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAC7B,SAAS,IAAI,gDAAgD,CAC9D,CAAC;IAEF,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KACtB;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAXD,8CAWC","sourcesContent":["import { assert } from '@metamask/utils';\n\n/**\n * Normalizes relative paths by optionally removing `./` prefix.\n *\n * @param path - Path to make normalize.\n * @returns The same path, with `./` prefix remove.\n */\n// TODO(ritave): Include NodeJS path polyfill and use path.normalize as well\nexport function normalizeRelative(path: string): string {\n  assert(!path.startsWith('/'));\n  assert(\n    path.search(/:|\\/\\//u) === -1,\n    `Path \"${path}\" potentially an URI instead of local relative`,\n  );\n\n  if (path.startsWith('./')) {\n    return path.slice(2);\n  }\n  return path;\n}\n"]}

package/dist/{esm/post-process.js → post-process.js}

@@ -1,27 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.postProcessBundle = exports.PostProcessWarning = void 0;
 // eslint-disable-next-line @typescript-eslint/no-shadow
-import { transformSync, template } from '@babel/core';
-import { binaryExpression, isUnaryExpression, isUpdateExpression, stringLiteral, templateElement, templateLiteral } from '@babel/types';
-export var PostProcessWarning;
-(function(PostProcessWarning) {
-    PostProcessWarning["UnsafeMathRandom"] = '`Math.random` was detected in the bundle. This is not a secure source of randomness.';
-})(PostProcessWarning || (PostProcessWarning = {}));
+const core_1 = require("@babel/core");
+const types_1 = require("@babel/types");
+var PostProcessWarning;
+(function (PostProcessWarning) {
+    PostProcessWarning["UnsafeMathRandom"] = "`Math.random` was detected in the bundle. This is not a secure source of randomness.";
+})(PostProcessWarning = exports.PostProcessWarning || (exports.PostProcessWarning = {}));
 // The RegEx below consists of multiple groups joined by a boolean OR.
 // Each part consists of two groups which capture a part of each string
 // which needs to be split up, e.g., `<!--` is split into `<!` and `--`.
 const TOKEN_REGEX = /(<!)(--)|(--)(>)|(import)(\(.*?\))/gu;
 // An empty template element, i.e., a part of a template literal without any
 // value ("").
-const EMPTY_TEMPLATE_ELEMENT = templateElement({
-    raw: '',
-    cooked: ''
-});
-const evalWrapper = template.statement(`
+const EMPTY_TEMPLATE_ELEMENT = (0, types_1.templateElement)({ raw: '', cooked: '' });
+const evalWrapper = core_1.template.statement(`
   (1, REF)(ARGS)
 `);
-const objectEvalWrapper = template.statement(`
+const objectEvalWrapper = core_1.template.statement(`
   (1, OBJECT.REF)
 `);
-const regeneratorRuntimeWrapper = template.statement(`
+const regeneratorRuntimeWrapper = core_1.template.statement(`
   var regeneratorRuntime;
 `);
 /**
@@ -35,11 +35,13 @@ const regeneratorRuntimeWrapper = template.statement(`
  * @returns The string split into an array, in a way that it can be joined
  * together to form the same string, but with the tokens separated into single
  * array elements.
- */ function breakTokens(value) {
+ */
+function breakTokens(value) {
     const tokens = value.split(TOKEN_REGEX);
-    return tokens// TODO: The `split` above results in some values being `undefined`.
-    // There may be a better solution to avoid having to filter those out.
-    .filter((token)=>token !== '' && token !== undefined);
+    return (tokens
+        // TODO: The `split` above results in some values being `undefined`.
+        // There may be a better solution to avoid having to filter those out.
+        .filter((token) => token !== '' && token !== undefined));
 }
 /**
  * Breaks up tokens that would otherwise result in SES errors. The tokens are
@@ -51,59 +53,47 @@ const regeneratorRuntimeWrapper = template.statement(`
  * @param value - The string value to break up.
  * @returns The string split into a tuple consisting of the new template
  * elements and string literal expressions.
- */ function breakTokensTemplateLiteral(value) {
+ */
+function breakTokensTemplateLiteral(value) {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore `matchAll` is not available in ES2017, but this code
     // should only be used in environments where the function is supported.
     const matches = Array.from(value.matchAll(TOKEN_REGEX));
     if (matches.length > 0) {
-        const output = matches.reduce(([elements, expressions], rawMatch, index, values)=>{
-            const [, first, last] = rawMatch.filter((raw)=>raw !== undefined);
+        const output = matches.reduce(([elements, expressions], rawMatch, index, values) => {
+            const [, first, last] = rawMatch.filter((raw) => raw !== undefined);
             // Slice the text in front of the match, which does not need to be
             // broken up.
-            const prefix = value.slice(index === 0 ? 0 : values[index - 1].index + values[index - 1][0].length, rawMatch.index);
+            const prefix = value.slice(index === 0
+                ? 0
+                : values[index - 1].index + values[index - 1][0].length, rawMatch.index);
             return [
                 [
                     ...elements,
-                    templateElement({
+                    (0, types_1.templateElement)({
                         raw: getRawTemplateValue(prefix),
-                        cooked: prefix
+                        cooked: prefix,
                     }),
-                    EMPTY_TEMPLATE_ELEMENT
+                    EMPTY_TEMPLATE_ELEMENT,
                 ],
-                [
-                    ...expressions,
-                    stringLiteral(first),
-                    stringLiteral(last)
-                ]
+                [...expressions, (0, types_1.stringLiteral)(first), (0, types_1.stringLiteral)(last)],
             ];
-        }, [
-            [],
-            []
-        ]);
+        }, [[], []]);
         // Add the text after the last match to the output.
         const lastMatch = matches[matches.length - 1];
         const suffix = value.slice(lastMatch.index + lastMatch[0].length);
         return [
             [
                 ...output[0],
-                templateElement({
-                    raw: getRawTemplateValue(suffix),
-                    cooked: suffix
-                })
+                (0, types_1.templateElement)({ raw: getRawTemplateValue(suffix), cooked: suffix }),
             ],
-            output[1]
+            output[1],
         ];
     }
     // If there are no matches, simply return the original value.
     return [
-        [
-            templateElement({
-                raw: getRawTemplateValue(value),
-                cooked: value
-            })
-        ],
-        []
+        [(0, types_1.templateElement)({ raw: getRawTemplateValue(value), cooked: value })],
+        [],
     ];
 }
 /**
@@ -113,7 +103,8 @@ const regeneratorRuntimeWrapper = template.statement(`
  * @see https://github.com/babel/babel/issues/9242#issuecomment-532529613
  * @param value - The cooked string to get the raw string for.
  * @returns The value as raw value.
- */ function getRawTemplateValue(value) {
+ */
+function getRawTemplateValue(value) {
     return value.replace(/\\|`|\$\{/gu, '\\$&');
 }
 /**
@@ -139,19 +130,23 @@ const regeneratorRuntimeWrapper = template.statement(`
  * map will be generated instead.
  * @returns An object containing the modified code, and source map, or null if
  * the provided code is null.
- */ export function postProcessBundle(code, { stripComments = true, sourceMap: sourceMaps, inputSourceMap } = {}) {
+ */
+function postProcessBundle(code, { stripComments = true, sourceMap: sourceMaps, inputSourceMap, } = {}) {
     const warnings = new Set();
-    const pre = ({ ast })=>{
-        ast.comments?.forEach((comment)=>{
+    const pre = ({ ast }) => {
+        ast.comments?.forEach((comment) => {
             // Break up tokens that could be parsed as HTML comment terminators. The
             // regular expressions below are written strangely so as to avoid the
             // appearance of such tokens in our source code. For reference:
             // https://github.com/endojs/endo/blob/70cc86eb400655e922413b99c38818d7b2e79da0/packages/ses/error-codes/SES_HTML_COMMENT_REJECTED.md
-            comment.value = comment.value.replace(new RegExp(`<!${'--'}`, 'gu'), '< !--').replace(new RegExp(`${'--'}>`, 'gu'), '-- >').replace(/import(\(.*\))/gu, 'import\\$1');
+            comment.value = comment.value
+                .replace(new RegExp(`<!${'--'}`, 'gu'), '< !--')
+                .replace(new RegExp(`${'--'}>`, 'gu'), '-- >')
+                .replace(/import(\(.*\))/gu, 'import\\$1');
         });
     };
     const visitor = {
-        FunctionExpression (path) {
+        FunctionExpression(path) {
             const { node } = path;
             // Browserify provides the `Buffer` global as an argument to modules that
             // use it, but this does not work in SES. Since we pass in `Buffer` as an
@@ -164,52 +159,61 @@ const regeneratorRuntimeWrapper = template.statement(`
             // TODO: Since we're working on the AST level, we could check the scope
             // of the function expression, and possibly prevent false positives?
             if (node.type === 'FunctionExpression' && node.extra?.parenthesized) {
-                node.params = node.params.filter((param)=>!(param.type === 'Identifier' && param.name === 'Buffer'));
+                node.params = node.params.filter((param) => !(param.type === 'Identifier' && param.name === 'Buffer'));
             }
         },
-        CallExpression (path) {
+        CallExpression(path) {
             const { node } = path;
             // Replace `eval(foo)` with `(1, eval)(foo)`.
             if (node.callee.type === 'Identifier' && node.callee.name === 'eval') {
                 path.replaceWith(evalWrapper({
                     REF: node.callee,
-                    ARGS: node.arguments
+                    ARGS: node.arguments,
                 }));
             }
             // Detect the use of `Math.random()` and add a warning.
-            if (node.callee.type === 'MemberExpression' && node.callee.object.type === 'Identifier' && node.callee.object.name === 'Math' && node.callee.property.type === 'Identifier' && node.callee.property.name === 'random') {
+            if (node.callee.type === 'MemberExpression' &&
+                node.callee.object.type === 'Identifier' &&
+                node.callee.object.name === 'Math' &&
+                node.callee.property.type === 'Identifier' &&
+                node.callee.property.name === 'random') {
                 warnings.add(PostProcessWarning.UnsafeMathRandom);
             }
         },
-        MemberExpression (path) {
+        MemberExpression(path) {
             const { node } = path;
             // Replace `object.eval(foo)` with `(1, object.eval)(foo)`.
-            if (node.property.type === 'Identifier' && node.property.name === 'eval' && // We only apply this to MemberExpressions that are the callee of CallExpression
-            path.parent.type === 'CallExpression' && path.parent.callee === node) {
+            if (node.property.type === 'Identifier' &&
+                node.property.name === 'eval' &&
+                // We only apply this to MemberExpressions that are the callee of CallExpression
+                path.parent.type === 'CallExpression' &&
+                path.parent.callee === node) {
                 path.replaceWith(objectEvalWrapper({
                     OBJECT: node.object,
-                    REF: node.property
+                    REF: node.property,
                 }));
             }
         },
-        Identifier (path) {
+        Identifier(path) {
             const { node } = path;
             // Insert `regeneratorRuntime` global if it's used in the code.
             if (node.name === 'regeneratorRuntime') {
-                const program = path.findParent((parent)=>parent.node.type === 'Program');
+                const program = path.findParent((parent) => parent.node.type === 'Program');
                 // We know that `program` is a Program node here, but this keeps
                 // TypeScript happy.
                 if (program?.node.type === 'Program') {
                     const body = program.node.body[0];
                     // This stops it from inserting `regeneratorRuntime` multiple times.
-                    if (body.type === 'VariableDeclaration' && body.declarations[0].id.name === 'regeneratorRuntime') {
+                    if (body.type === 'VariableDeclaration' &&
+                        body.declarations[0].id.name ===
+                            'regeneratorRuntime') {
                         return;
                     }
                     program?.node.body.unshift(regeneratorRuntimeWrapper());
                 }
             }
         },
-        TemplateLiteral (path) {
+        TemplateLiteral(path) {
             const { node } = path;
             // This checks if the template literal was visited before. Without this,
             // it would cause an infinite loop resulting in a stack overflow. We can't
@@ -222,7 +226,7 @@ const regeneratorRuntimeWrapper = template.statement(`
             // For reference:
             // - https://github.com/endojs/endo/blob/70cc86eb400655e922413b99c38818d7b2e79da0/packages/ses/error-codes/SES_HTML_COMMENT_REJECTED.md
             // - https://github.com/MetaMask/snaps-monorepo/issues/505
-            const [replacementQuasis, replacementExpressions] = node.quasis.reduce(([elements, expressions], quasi, index)=>{
+            const [replacementQuasis, replacementExpressions] = node.quasis.reduce(([elements, expressions], quasi, index) => {
                 // Note: Template literals have two variants, "cooked" and "raw". Here
                 // we use the cooked version.
                 // https://exploringjs.com/impatient-js/ch_template-literals.html#template-strings-cooked-vs-raw
@@ -230,35 +234,23 @@ const regeneratorRuntimeWrapper = template.statement(`
                 // Only update the node if something changed.
                 if (tokens[0].length <= 1) {
                     return [
-                        [
-                            ...elements,
-                            quasi
-                        ],
-                        [
-                            ...expressions,
-                            node.expressions[index]
-                        ]
+                        [...elements, quasi],
+                        [...expressions, node.expressions[index]],
                     ];
                 }
                 return [
-                    [
-                        ...elements,
-                        ...tokens[0]
-                    ],
+                    [...elements, ...tokens[0]],
                     [
                         ...expressions,
                         ...tokens[1],
-                        node.expressions[index]
-                    ]
+                        node.expressions[index],
+                    ],
                 ];
-            }, [
-                [],
-                []
-            ]);
-            path.replaceWith(templateLiteral(replacementQuasis, replacementExpressions.filter((expression)=>expression !== undefined)));
+            }, [[], []]);
+            path.replaceWith((0, types_1.templateLiteral)(replacementQuasis, replacementExpressions.filter((expression) => expression !== undefined)));
             path.setData('visited', true);
         },
-        StringLiteral (path) {
+        StringLiteral(path) {
             const { node } = path;
             // Break up tokens that could be parsed as HTML comment terminators, or
             // `import()` statements.
@@ -270,29 +262,25 @@ const regeneratorRuntimeWrapper = template.statement(`
             if (tokens.length <= 1) {
                 return;
             }
-            const replacement = tokens.slice(1).reduce((acc, value)=>binaryExpression('+', acc, stringLiteral(value)), stringLiteral(tokens[0]));
+            const replacement = tokens
+                .slice(1)
+                .reduce((acc, value) => (0, types_1.binaryExpression)('+', acc, (0, types_1.stringLiteral)(value)), (0, types_1.stringLiteral)(tokens[0]));
             path.replaceWith(replacement);
             path.skip();
         },
-        BinaryExpression (path) {
-            const { node } = path;
-            const errorMessage = 'Using HTML comments (`<!--` and `-->`) as operators is not allowed. The behaviour of ' + 'these comments is ambiguous, and differs per browser and environment. If you want ' + 'to use them as operators, break them up into separate characters, i.e., `a-- > b` ' + 'and `a < ! --b`.';
-            if (node.operator === '<' && isUnaryExpression(node.right) && isUpdateExpression(node.right.argument) && node.right.argument.operator === '--' && node.left.end && node.right.argument.argument.start) {
-                const expression = code.slice(node.left.end, node.right.argument.argument.start);
-                if (expression.includes('<!--')) {
-                    throw new Error(errorMessage);
-                }
+        BinaryExpression(path) {
+            const source = path.getSource();
+            // Throw an error if HTML comments are used as a binary expression.
+            if (source.includes('<!--') || source.includes('-->')) {
+                throw new Error('Using HTML comments (`<!--` and `-->`) as operators is not allowed. The behaviour of ' +
+                    'these comments is ambiguous, and differs per browser and environment. If you want ' +
+                    'to use them as operators, break them up into separate characters, i.e., `a-- > b` ' +
+                    'and `a < ! --b`.');
             }
-            if (node.operator === '>' && isUpdateExpression(node.left) && node.left.operator === '--' && node.left.argument.end && node.right.start) {
-                const expression = code.slice(node.left.argument.end, node.right.start);
-                if (expression.includes('-->')) {
-                    throw new Error(errorMessage);
-                }
-            }
-        }
+        },
     };
     try {
-        const file = transformSync(code, {
+        const file = (0, core_1.transformSync)(code, {
             // Prevent Babel from searching for a config file.
             configFile: false,
             parserOpts: {
@@ -300,7 +288,7 @@ const regeneratorRuntimeWrapper = template.statement(`
                 strictMode: true,
                 // If this is disabled, the AST does not include any comments. This is
                 // useful for performance reasons, and we use it for stripping comments.
-                attachComment: !stripComments
+                attachComment: !stripComments,
             },
             // By default, Babel optimises bundles that exceed 500 KB, but that
             // results in characters which look like HTML comments, which breaks SES.
@@ -311,11 +299,11 @@ const regeneratorRuntimeWrapper = template.statement(`
             inputSourceMap,
             sourceMaps,
             plugins: [
-                ()=>({
-                        pre,
-                        visitor
-                    })
-            ]
+                () => ({
+                    pre,
+                    visitor,
+                }),
+            ],
         });
         if (!file?.code) {
             throw new Error('Bundled code is empty.');
@@ -323,11 +311,12 @@ const regeneratorRuntimeWrapper = template.statement(`
         return {
             code: file.code,
             sourceMap: file.map,
-            warnings: Array.from(warnings)
+            warnings: Array.from(warnings),
         };
-    } catch (error) {
+    }
+    catch (error) {
         throw new Error(`Failed to post process code:\n${error.message}`);
     }
 }
-
+exports.postProcessBundle = postProcessBundle;
 //# sourceMappingURL=post-process.js.map

package/dist/post-process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"post-process.js","sourceRoot":"","sources":["../src/post-process.ts"],"names":[],"mappings":";;;AAAA,wDAAwD;AACxD,sCAAgF;AAChF,wCAQsB;AAgDtB,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,+HAAyG,CAAA;AAC3G,CAAC,EAFW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAE7B;AAED,sEAAsE;AACtE,uEAAuE;AACvE,wEAAwE;AACxE,MAAM,WAAW,GAAG,sCAAsC,CAAC;AAE3D,4EAA4E;AAC5E,cAAc;AACd,MAAM,sBAAsB,GAAG,IAAA,uBAAe,EAAC,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;AAExE,MAAM,WAAW,GAAG,eAAQ,CAAC,SAAS,CAAC;;CAEtC,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAAG,eAAQ,CAAC,SAAS,CAAC;;CAE5C,CAAC,CAAC;AAEH,MAAM,yBAAyB,GAAG,eAAQ,CAAC,SAAS,CAAC;;CAEpD,CAAC,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,SAAS,WAAW,CAAC,KAAa;IAChC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACxC,OAAO,CACL,MAAM;QACJ,oEAAoE;QACpE,sEAAsE;SACrE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,SAAS,CAAC,CAC1D,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,0BAA0B,CACjC,KAAa;IAEb,6DAA6D;IAC7D,kEAAkE;IAClE,uEAAuE;IACvE,MAAM,OAAO,GAAuB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IAE5E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACtB,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAC3B,CAAC,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;YACnD,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC;YAEpE,kEAAkE;YAClE,aAAa;YACb,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CACxB,KAAK,KAAK,CAAC;gBACT,CAAC,CAAC,CAAC;gBACH,CAAC,CAAE,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,KAAgB,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EACrE,QAAQ,CAAC,KAAK,CACf,CAAC;YAEF,OAAO;gBACL;oBACE,GAAG,QAAQ;oBACX,IAAA,uBAAe,EAAC;wBACd,GAAG,EAAE,mBAAmB,CAAC,MAAM,CAAC;wBAChC,MAAM,EAAE,MAAM;qBACf,CAAC;oBACF,sBAAsB;iBACvB;gBACD,CAAC,GAAG,WAAW,EAAE,IAAA,qBAAa,EAAC,KAAK,CAAC,EAAE,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC;aAC5D,CAAC;QACJ,CAAC,EACD,CAAC,EAAE,EAAE,EAAE,CAAC,CACT,CAAC;QAEF,mDAAmD;QACnD,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CACvB,SAAS,CAAC,KAAgB,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAClD,CAAC;QAEF,OAAO;YACL;gBACE,GAAG,MAAM,CAAC,CAAC,CAAC;gBACZ,IAAA,uBAAe,EAAC,EAAE,GAAG,EAAE,mBAAmB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;aACtE;YACD,MAAM,CAAC,CAAC,CAAC;SACV,CAAC;KACH;IAED,6DAA6D;IAC7D,OAAO;QACL,CAAC,IAAA,uBAAe,EAAC,EAAE,GAAG,EAAE,mBAAmB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACrE,EAAE;KACH,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAAC,KAAa;IACxC,OAAO,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,iBAAiB,CAC/B,IAAY,EACZ,EACE,aAAa,GAAG,IAAI,EACpB,SAAS,EAAE,UAAU,EACrB,cAAc,MACiB,EAAE;IAEnC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAsB,CAAC;IAE/C,MAAM,GAAG,GAAqB,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;QACxC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAChC,wEAAwE;YACxE,qEAAqE;YACrE,+DAA+D;YAC/D,qIAAqI;YACrI,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK;iBAC1B,OAAO,CAAC,IAAI,MAAM,CAAC,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC;iBAC/C,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,IAAI,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC;iBAC7C,OAAO,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,OAAO,GAAkB;QAC7B,kBAAkB,CAAC,IAAI;YACrB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,yEAAyE;YACzE,yEAAyE;YACzE,gDAAgD;YAChD,EAAE;YACF,+DAA+D;YAC/D,qEAAqE;YACrE,oBAAoB;YACpB,EAAE;YACF,uEAAuE;YACvE,oEAAoE;YACpE,IAAI,IAAI,CAAC,IAAI,KAAK,oBAAoB,IAAI,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE;gBACnE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAC9B,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CACrE,CAAC;aACH;QACH,CAAC;QAED,cAAc,CAAC,IAAI;YACjB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,6CAA6C;YAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE;gBACpE,IAAI,CAAC,WAAW,CACd,WAAW,CAAC;oBACV,GAAG,EAAE,IAAI,CAAC,MAAM;oBAChB,IAAI,EAAE,IAAI,CAAC,SAAS;iBACrB,CAAC,CACH,CAAC;aACH;YAED,uDAAuD;YACvD,IACE,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,kBAAkB;gBACvC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY;gBACxC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM;gBAClC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY;gBAC1C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ,EACtC;gBACA,QAAQ,CAAC,GAAG,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;aACnD;QACH,CAAC;QAED,gBAAgB,CAAC,IAAI;YACnB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,2DAA2D;YAC3D,IACE,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY;gBACnC,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,MAAM;gBAC7B,gFAAgF;gBAChF,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,gBAAgB;gBACrC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,EAC3B;gBACA,IAAI,CAAC,WAAW,CACd,iBAAiB,CAAC;oBAChB,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,GAAG,EAAE,IAAI,CAAC,QAAQ;iBACnB,CAAC,CACH,CAAC;aACH;QACH,CAAC;QAED,UAAU,CAAC,IAAI;YACb,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,+DAA+D;YAC/D,IAAI,IAAI,CAAC,IAAI,KAAK,oBAAoB,EAAE;gBACtC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAC7B,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAC3C,CAAC;gBAEF,gEAAgE;gBAChE,oBAAoB;gBACpB,IAAI,OAAO,EAAE,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;oBACpC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBAElC,oEAAoE;oBACpE,IACE,IAAI,CAAC,IAAI,KAAK,qBAAqB;wBAClC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAiB,CAAC,IAAI;4BAC1C,oBAAoB,EACtB;wBACA,OAAO;qBACR;oBAED,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;iBACzD;aACF;QACH,CAAC;QAED,eAAe,CAAC,IAAI;YAClB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,wEAAwE;YACxE,0EAA0E;YAC1E,yEAAyE;YACzE,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBAC3B,OAAO;aACR;YAED,uEAAuE;YACvE,yBAAyB;YACzB,iBAAiB;YACjB,uIAAuI;YACvI,0DAA0D;YAC1D,MAAM,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAGpE,CAAC,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;gBACxC,sEAAsE;gBACtE,6BAA6B;gBAC7B,gGAAgG;gBAChG,MAAM,MAAM,GAAG,0BAA0B,CACvC,KAAK,CAAC,KAAK,CAAC,MAAgB,CAC7B,CAAC;gBAEF,6CAA6C;gBAC7C,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;oBACzB,OAAO;wBACL,CAAC,GAAG,QAAQ,EAAE,KAAK,CAAC;wBACpB,CAAC,GAAG,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAe,CAAC;qBACxD,CAAC;iBACH;gBAED,OAAO;oBACL,CAAC,GAAG,QAAQ,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;oBAC3B;wBACE,GAAG,WAAW;wBACd,GAAG,MAAM,CAAC,CAAC,CAAC;wBACZ,IAAI,CAAC,WAAW,CAAC,KAAK,CAAe;qBACtC;iBACF,CAAC;YACJ,CAAC,EACD,CAAC,EAAE,EAAE,EAAE,CAAC,CACT,CAAC;YAEF,IAAI,CAAC,WAAW,CACd,IAAA,uBAAe,EACb,iBAAiB,EACjB,sBAAsB,CAAC,MAAM,CAC3B,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,KAAK,SAAS,CACzC,CACM,CACV,CAAC;YAEF,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAChC,CAAC;QAED,aAAa,CAAC,IAAI;YAChB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;YAEtB,uEAAuE;YACvE,yBAAyB;YACzB,iBAAiB;YACjB,uIAAuI;YACvI,0DAA0D;YAC1D,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEvC,4DAA4D;YAC5D,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE;gBACtB,OAAO;aACR;YAED,MAAM,WAAW,GAAG,MAAM;iBACvB,KAAK,CAAC,CAAC,CAAC;iBACR,MAAM,CACL,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAA,wBAAgB,EAAC,GAAG,EAAE,GAAG,EAAE,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAC,EAChE,IAAA,qBAAa,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CACzB,CAAC;YAEJ,IAAI,CAAC,WAAW,CAAC,WAAmB,CAAC,CAAC;YACtC,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC;QAED,gBAAgB,CAAC,IAAI;YACnB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAEhC,mEAAmE;YACnE,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBACrD,MAAM,IAAI,KAAK,CACb,uFAAuF;oBACrF,oFAAoF;oBACpF,oFAAoF;oBACpF,kBAAkB,CACrB,CAAC;aACH;QACH,CAAC;KACF,CAAC;IAEF,IAAI;QACF,MAAM,IAAI,GAAG,IAAA,oBAAa,EAAC,IAAI,EAAE;YAC/B,kDAAkD;YAClD,UAAU,EAAE,KAAK;YAEjB,UAAU,EAAE;gBACV,sEAAsE;gBACtE,UAAU,EAAE,IAAI;gBAEhB,sEAAsE;gBACtE,wEAAwE;gBACxE,aAAa,EAAE,CAAC,aAAa;aAC9B;YAED,mEAAmE;YACnE,yEAAyE;YACzE,OAAO,EAAE,KAAK;YAEd,uEAAuE;YACvE,wEAAwE;YACxE,mEAAmE;YACnE,cAAc;YACd,UAAU;YAEV,OAAO,EAAE;gBACP,GAAG,EAAE,CAAC,CAAC;oBACL,GAAG;oBACH,OAAO;iBACR,CAAC;aACH;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC3C;QAED,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,GAAG;YACnB,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC/B,CAAC;KACH;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KACnE;AACH,CAAC;AApQD,8CAoQC","sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-shadow\nimport { transformSync, Node, Visitor, template, PluginObj } from '@babel/core';\nimport {\n  binaryExpression,\n  Expression,\n  Identifier,\n  stringLiteral,\n  TemplateElement,\n  templateElement,\n  templateLiteral,\n} from '@babel/types';\n\n/**\n * Source map declaration taken from `@babel/core`. Babel doesn't export the\n * type for this, so it's copied from the source code instead here.\n */\nexport type SourceMap = {\n  version: number;\n  sources: string[];\n  names: string[];\n  sourceRoot?: string | undefined;\n  sourcesContent?: string[] | undefined;\n  mappings: string;\n  file: string;\n};\n\n/**\n * The post process options.\n *\n * @property stripComments - Whether to strip comments. Defaults to `true`.\n * @property sourceMap - Whether to generate a source map for the modified code.\n * See also `inputSourceMap`.\n * @property inputSourceMap - The source map for the input code. When provided,\n * the source map will be used to generate a source map for the modified code.\n * This ensures that the source map is correct for the modified code, and still\n * points to the original source. If not provided, a new source map will be\n * generated instead.\n */\nexport type PostProcessOptions = {\n  stripComments?: boolean;\n  sourceMap?: boolean | 'inline';\n  inputSourceMap?: SourceMap;\n};\n\n/**\n * The post processed bundle output.\n *\n * @property code - The modified code.\n * @property sourceMap - The source map for the modified code, if the source map\n * option was enabled.\n * @property warnings - Any warnings that occurred during the post-processing.\n */\nexport type PostProcessedBundle = {\n  code: string;\n  sourceMap?: SourceMap | null;\n  warnings: PostProcessWarning[];\n};\n\nexport enum PostProcessWarning {\n  UnsafeMathRandom = '`Math.random` was detected in the bundle. This is not a secure source of randomness.',\n}\n\n// The RegEx below consists of multiple groups joined by a boolean OR.\n// Each part consists of two groups which capture a part of each string\n// which needs to be split up, e.g., `<!--` is split into `<!` and `--`.\nconst TOKEN_REGEX = /(<!)(--)|(--)(>)|(import)(\\(.*?\\))/gu;\n\n// An empty template element, i.e., a part of a template literal without any\n// value (\"\").\nconst EMPTY_TEMPLATE_ELEMENT = templateElement({ raw: '', cooked: '' });\n\nconst evalWrapper = template.statement(`\n  (1, REF)(ARGS)\n`);\n\nconst objectEvalWrapper = template.statement(`\n  (1, OBJECT.REF)\n`);\n\nconst regeneratorRuntimeWrapper = template.statement(`\n  var regeneratorRuntime;\n`);\n\n/**\n * Breaks up tokens that would otherwise result in SES errors. The tokens are\n * broken up in a non-destructive way where possible. Currently works with:\n * - HTML comment tags `<!--` and `-->`, broken up into `<!`, `--`, and `--`,\n * `>`.\n * - `import(n)` statements, broken up into `import`, `(n)`.\n *\n * @param value - The string value to break up.\n * @returns The string split into an array, in a way that it can be joined\n * together to form the same string, but with the tokens separated into single\n * array elements.\n */\nfunction breakTokens(value: string): string[] {\n  const tokens = value.split(TOKEN_REGEX);\n  return (\n    tokens\n      // TODO: The `split` above results in some values being `undefined`.\n      // There may be a better solution to avoid having to filter those out.\n      .filter((token) => token !== '' && token !== undefined)\n  );\n}\n\n/**\n * Breaks up tokens that would otherwise result in SES errors. The tokens are\n * broken up in a non-destructive way where possible. Currently works with:\n * - HTML comment tags `<!--` and `-->`, broken up into `<!`, `--`, and `--`,\n * `>`.\n * - `import(n)` statements, broken up into `import`, `(n)`.\n *\n * @param value - The string value to break up.\n * @returns The string split into a tuple consisting of the new template\n * elements and string literal expressions.\n */\nfunction breakTokensTemplateLiteral(\n  value: string,\n): [TemplateElement[], Expression[]] {\n  // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n  // @ts-ignore `matchAll` is not available in ES2017, but this code\n  // should only be used in environments where the function is supported.\n  const matches: RegExpMatchArray[] = Array.from(value.matchAll(TOKEN_REGEX));\n\n  if (matches.length > 0) {\n    const output = matches.reduce<[TemplateElement[], Expression[]]>(\n      ([elements, expressions], rawMatch, index, values) => {\n        const [, first, last] = rawMatch.filter((raw) => raw !== undefined);\n\n        // Slice the text in front of the match, which does not need to be\n        // broken up.\n        const prefix = value.slice(\n          index === 0\n            ? 0\n            : (values[index - 1].index as number) + values[index - 1][0].length,\n          rawMatch.index,\n        );\n\n        return [\n          [\n            ...elements,\n            templateElement({\n              raw: getRawTemplateValue(prefix),\n              cooked: prefix,\n            }),\n            EMPTY_TEMPLATE_ELEMENT,\n          ],\n          [...expressions, stringLiteral(first), stringLiteral(last)],\n        ];\n      },\n      [[], []],\n    );\n\n    // Add the text after the last match to the output.\n    const lastMatch = matches[matches.length - 1];\n    const suffix = value.slice(\n      (lastMatch.index as number) + lastMatch[0].length,\n    );\n\n    return [\n      [\n        ...output[0],\n        templateElement({ raw: getRawTemplateValue(suffix), cooked: suffix }),\n      ],\n      output[1],\n    ];\n  }\n\n  // If there are no matches, simply return the original value.\n  return [\n    [templateElement({ raw: getRawTemplateValue(value), cooked: value })],\n    [],\n  ];\n}\n\n/**\n * Get a raw template literal value from a cooked value. This adds a backslash\n * before every '`', '\\' and '${' characters.\n *\n * @see https://github.com/babel/babel/issues/9242#issuecomment-532529613\n * @param value - The cooked string to get the raw string for.\n * @returns The value as raw value.\n */\nfunction getRawTemplateValue(value: string) {\n  return value.replace(/\\\\|`|\\$\\{/gu, '\\\\$&');\n}\n\n/**\n * Post process code with AST such that it can be evaluated in SES.\n *\n * Currently:\n * - Makes all direct calls to eval indirect.\n * - Handles certain Babel-related edge cases.\n * - Removes the `Buffer` provided by Browserify.\n * - Optionally removes comments.\n * - Breaks up tokens that would otherwise result in SES errors, such as HTML\n * comment tags `<!--` and `-->` and `import(n)` statements.\n *\n * @param code - The code to post process.\n * @param options - The post-process options.\n * @param options.stripComments - Whether to strip comments. Defaults to `true`.\n * @param options.sourceMap - Whether to generate a source map for the modified\n * code. See also `inputSourceMap`.\n * @param options.inputSourceMap - The source map for the input code. When\n * provided, the source map will be used to generate a source map for the\n * modified code. This ensures that the source map is correct for the modified\n * code, and still points to the original source. If not provided, a new source\n * map will be generated instead.\n * @returns An object containing the modified code, and source map, or null if\n * the provided code is null.\n */\nexport function postProcessBundle(\n  code: string,\n  {\n    stripComments = true,\n    sourceMap: sourceMaps,\n    inputSourceMap,\n  }: Partial<PostProcessOptions> = {},\n): PostProcessedBundle {\n  const warnings = new Set<PostProcessWarning>();\n\n  const pre: PluginObj['pre'] = ({ ast }) => {\n    ast.comments?.forEach((comment) => {\n      // Break up tokens that could be parsed as HTML comment terminators. The\n      // regular expressions below are written strangely so as to avoid the\n      // appearance of such tokens in our source code. For reference:\n      // https://github.com/endojs/endo/blob/70cc86eb400655e922413b99c38818d7b2e79da0/packages/ses/error-codes/SES_HTML_COMMENT_REJECTED.md\n      comment.value = comment.value\n        .replace(new RegExp(`<!${'--'}`, 'gu'), '< !--')\n        .replace(new RegExp(`${'--'}>`, 'gu'), '-- >')\n        .replace(/import(\\(.*\\))/gu, 'import\\\\$1');\n    });\n  };\n\n  const visitor: Visitor<Node> = {\n    FunctionExpression(path) {\n      const { node } = path;\n\n      // Browserify provides the `Buffer` global as an argument to modules that\n      // use it, but this does not work in SES. Since we pass in `Buffer` as an\n      // endowment, we can simply remove the argument.\n      //\n      // Note that this only removes `Buffer` from a wrapped function\n      // expression, e.g., `(function (Buffer) { ... })`. Regular functions\n      // are not affected.\n      //\n      // TODO: Since we're working on the AST level, we could check the scope\n      // of the function expression, and possibly prevent false positives?\n      if (node.type === 'FunctionExpression' && node.extra?.parenthesized) {\n        node.params = node.params.filter(\n          (param) => !(param.type === 'Identifier' && param.name === 'Buffer'),\n        );\n      }\n    },\n\n    CallExpression(path) {\n      const { node } = path;\n\n      // Replace `eval(foo)` with `(1, eval)(foo)`.\n      if (node.callee.type === 'Identifier' && node.callee.name === 'eval') {\n        path.replaceWith(\n          evalWrapper({\n            REF: node.callee,\n            ARGS: node.arguments,\n          }),\n        );\n      }\n\n      // Detect the use of `Math.random()` and add a warning.\n      if (\n        node.callee.type === 'MemberExpression' &&\n        node.callee.object.type === 'Identifier' &&\n        node.callee.object.name === 'Math' &&\n        node.callee.property.type === 'Identifier' &&\n        node.callee.property.name === 'random'\n      ) {\n        warnings.add(PostProcessWarning.UnsafeMathRandom);\n      }\n    },\n\n    MemberExpression(path) {\n      const { node } = path;\n\n      // Replace `object.eval(foo)` with `(1, object.eval)(foo)`.\n      if (\n        node.property.type === 'Identifier' &&\n        node.property.name === 'eval' &&\n        // We only apply this to MemberExpressions that are the callee of CallExpression\n        path.parent.type === 'CallExpression' &&\n        path.parent.callee === node\n      ) {\n        path.replaceWith(\n          objectEvalWrapper({\n            OBJECT: node.object,\n            REF: node.property,\n          }),\n        );\n      }\n    },\n\n    Identifier(path) {\n      const { node } = path;\n\n      // Insert `regeneratorRuntime` global if it's used in the code.\n      if (node.name === 'regeneratorRuntime') {\n        const program = path.findParent(\n          (parent) => parent.node.type === 'Program',\n        );\n\n        // We know that `program` is a Program node here, but this keeps\n        // TypeScript happy.\n        if (program?.node.type === 'Program') {\n          const body = program.node.body[0];\n\n          // This stops it from inserting `regeneratorRuntime` multiple times.\n          if (\n            body.type === 'VariableDeclaration' &&\n            (body.declarations[0].id as Identifier).name ===\n              'regeneratorRuntime'\n          ) {\n            return;\n          }\n\n          program?.node.body.unshift(regeneratorRuntimeWrapper());\n        }\n      }\n    },\n\n    TemplateLiteral(path) {\n      const { node } = path;\n\n      // This checks if the template literal was visited before. Without this,\n      // it would cause an infinite loop resulting in a stack overflow. We can't\n      // skip the path here, because we need to visit the children of the node.\n      if (path.getData('visited')) {\n        return;\n      }\n\n      // Break up tokens that could be parsed as HTML comment terminators, or\n      // `import()` statements.\n      // For reference:\n      // - https://github.com/endojs/endo/blob/70cc86eb400655e922413b99c38818d7b2e79da0/packages/ses/error-codes/SES_HTML_COMMENT_REJECTED.md\n      // - https://github.com/MetaMask/snaps-monorepo/issues/505\n      const [replacementQuasis, replacementExpressions] = node.quasis.reduce<\n        [TemplateElement[], Expression[]]\n      >(\n        ([elements, expressions], quasi, index) => {\n          // Note: Template literals have two variants, \"cooked\" and \"raw\". Here\n          // we use the cooked version.\n          // https://exploringjs.com/impatient-js/ch_template-literals.html#template-strings-cooked-vs-raw\n          const tokens = breakTokensTemplateLiteral(\n            quasi.value.cooked as string,\n          );\n\n          // Only update the node if something changed.\n          if (tokens[0].length <= 1) {\n            return [\n              [...elements, quasi],\n              [...expressions, node.expressions[index] as Expression],\n            ];\n          }\n\n          return [\n            [...elements, ...tokens[0]],\n            [\n              ...expressions,\n              ...tokens[1],\n              node.expressions[index] as Expression,\n            ],\n          ];\n        },\n        [[], []],\n      );\n\n      path.replaceWith(\n        templateLiteral(\n          replacementQuasis,\n          replacementExpressions.filter(\n            (expression) => expression !== undefined,\n          ),\n        ) as Node,\n      );\n\n      path.setData('visited', true);\n    },\n\n    StringLiteral(path) {\n      const { node } = path;\n\n      // Break up tokens that could be parsed as HTML comment terminators, or\n      // `import()` statements.\n      // For reference:\n      // - https://github.com/endojs/endo/blob/70cc86eb400655e922413b99c38818d7b2e79da0/packages/ses/error-codes/SES_HTML_COMMENT_REJECTED.md\n      // - https://github.com/MetaMask/snaps-monorepo/issues/505\n      const tokens = breakTokens(node.value);\n\n      // Only update the node if the string literal was broken up.\n      if (tokens.length <= 1) {\n        return;\n      }\n\n      const replacement = tokens\n        .slice(1)\n        .reduce<Expression>(\n          (acc, value) => binaryExpression('+', acc, stringLiteral(value)),\n          stringLiteral(tokens[0]),\n        );\n\n      path.replaceWith(replacement as Node);\n      path.skip();\n    },\n\n    BinaryExpression(path) {\n      const source = path.getSource();\n\n      // Throw an error if HTML comments are used as a binary expression.\n      if (source.includes('<!--') || source.includes('-->')) {\n        throw new Error(\n          'Using HTML comments (`<!--` and `-->`) as operators is not allowed. The behaviour of ' +\n            'these comments is ambiguous, and differs per browser and environment. If you want ' +\n            'to use them as operators, break them up into separate characters, i.e., `a-- > b` ' +\n            'and `a < ! --b`.',\n        );\n      }\n    },\n  };\n\n  try {\n    const file = transformSync(code, {\n      // Prevent Babel from searching for a config file.\n      configFile: false,\n\n      parserOpts: {\n        // Strict mode isn't enabled by default, so we need to enable it here.\n        strictMode: true,\n\n        // If this is disabled, the AST does not include any comments. This is\n        // useful for performance reasons, and we use it for stripping comments.\n        attachComment: !stripComments,\n      },\n\n      // By default, Babel optimises bundles that exceed 500 KB, but that\n      // results in characters which look like HTML comments, which breaks SES.\n      compact: false,\n\n      // This configures Babel to generate a new source map from the existing\n      // source map if specified. If `sourceMap` is `true` but an input source\n      // map is not provided, a new source map will be generated instead.\n      inputSourceMap,\n      sourceMaps,\n\n      plugins: [\n        () => ({\n          pre,\n          visitor,\n        }),\n      ],\n    });\n\n    if (!file?.code) {\n      throw new Error('Bundled code is empty.');\n    }\n\n    return {\n      code: file.code,\n      sourceMap: file.map,\n      warnings: Array.from(warnings),\n    };\n  } catch (error) {\n    throw new Error(`Failed to post process code:\\n${error.message}`);\n  }\n}\n"]}

package/dist/{types/snaps.d.ts → snaps.d.ts}

@@ -28,7 +28,7 @@ export declare enum SnapStatusEvents {
     Update = "UPDATE"
 }
 export declare type StatusContext = {
-    snapId: ValidatedSnapId;
+    snapId: string;
 };
 export declare type StatusEvents = {
     type: SnapStatusEvents;
@@ -60,7 +60,7 @@ export declare type Snap = {
     /**
      * The ID of the Snap.
      */
-    id: ValidatedSnapId;
+    id: SnapId;
     /**
      * The initial permissions of the Snap, which will be requested when it is
      * installed.
@@ -140,13 +140,6 @@ declare const snapIdSymbol: unique symbol;
  * @returns The snap prefix from a snap id, e.g. `npm:`.
  */
 export declare function getSnapPrefix(snapId: string): SnapIdPrefixes;
-/**
- * Strips snap prefix from a full snap ID.
- *
- * @param snapId - The snap ID to strip.
- * @returns The stripped snap ID.
- */
-export declare function stripSnapPrefix(snapId: string): string;
 /**
  * Assert that the given value is a valid snap ID.
  *