@metamask/snaps-utils 0.24.0

package/dist/post-process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"post-process.js","sourceRoot":"","sources":["../src/post-process.ts"],"names":[],"mappings":";;;AAAA,wCAQsB;AACtB,sCAAgF;AAgDhF,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,wEAAwE;IACxE,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,MAAA,GAAG,CAAC,QAAQ,0CAAE,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,KAAI,MAAA,IAAI,CAAC,KAAK,0CAAE,aAAa,CAAA,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,wDAAwD;gBACxD,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,oBAAoB,EACzC;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,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC,IAAI,MAAK,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,aAAP,OAAO,uBAAP,OAAO,CAAE,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,KAAwB,CAAC;wBACvC,CAAC,GAAG,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAe,CAAC;qBACxD,CAAC;iBACH;gBAED,OAAO;oBACL,CAAC,GAAG,QAAQ,EAAE,GAAI,MAAM,CAAC,CAAC,CAAuB,CAAC;oBAClD;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,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAC9C,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,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,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;AAjQD,8CAiQC","sourcesContent":["import {\n  binaryExpression,\n  Expression,\n  Identifier,\n  stringLiteral,\n  TemplateElement,\n  templateElement,\n  templateLiteral,\n} from '@babel/types';\nimport { transformSync, Node, Visitor, template, PluginObj } from '@babel/core';\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  // @ts-expect-error `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        // If the expression is already wrapped we can ignore it\n        path.parent.type !== 'SequenceExpression'\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 as TemplateElement],\n              [...expressions, node.expressions[index] as Expression],\n            ];\n          }\n\n          return [\n            [...elements, ...(tokens[0] as TemplateElement[])],\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((e) => e !== undefined),\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/snaps.d.ts

@@ -0,0 +1,165 @@
+import { Json } from '@metamask/utils';
+import { SerializedEthereumRpcError } from 'eth-rpc-errors/dist/classes';
+import { SnapManifest, SnapPermissions } from './manifest/validation';
+import { SnapId, SnapIdPrefixes, SnapValidationFailureReason } from './types';
+export declare const LOCALHOST_HOSTNAMES: Set<string>;
+export declare const SNAP_PREFIX = "wallet_snap_";
+export declare const SNAP_PREFIX_REGEX: RegExp;
+export declare const PROPOSED_NAME_REGEX: RegExp;
+/**
+ * wallet_enable / wallet_installSnaps permission typing.
+ *
+ * @deprecated This type is confusing and not descriptive, people confused it with typing initialPermissions, remove when removing wallet_enable.
+ */
+export declare type RequestedSnapPermissions = {
+    [permission: string]: Record<string, Json>;
+};
+export declare type BlockedSnapInfo = {
+    infoUrl?: string;
+    reason?: string;
+};
+export declare enum SnapStatus {
+    Installing = "installing",
+    Updating = "updating",
+    Running = "running",
+    Stopped = "stopped",
+    Crashed = "crashed"
+}
+export declare enum SnapStatusEvents {
+    Start = "START",
+    Stop = "STOP",
+    Crash = "CRASH",
+    Update = "UPDATE"
+}
+export declare type StatusContext = {
+    snapId: string;
+};
+export declare type StatusEvents = {
+    type: SnapStatusEvents;
+};
+export declare type StatusStates = {
+    value: SnapStatus;
+    context: StatusContext;
+};
+export declare type Status = StatusStates['value'];
+export declare type VersionHistory = {
+    origin: string;
+    version: string;
+    date: number;
+};
+export declare type PersistedSnap = Snap & {
+    /**
+     * The source code of the Snap.
+     */
+    sourceCode: string;
+};
+/**
+ * A Snap as it exists in {@link SnapController} state.
+ */
+export declare type Snap = {
+    /**
+     * Whether the Snap is enabled, which determines if it can be started.
+     */
+    enabled: boolean;
+    /**
+     * The ID of the Snap.
+     */
+    id: SnapId;
+    /**
+     * The initial permissions of the Snap, which will be requested when it is
+     * installed.
+     */
+    initialPermissions: SnapPermissions;
+    /**
+     * The Snap's manifest file.
+     */
+    manifest: SnapManifest;
+    /**
+     * Whether the Snap is blocked.
+     */
+    blocked: boolean;
+    /**
+     * Information detailing why the snap is blocked.
+     */
+    blockInformation?: BlockedSnapInfo;
+    /**
+     * The name of the permission used to invoke the Snap.
+     */
+    permissionName: string;
+    /**
+     * The current status of the Snap, e.g. whether it's running or stopped.
+     */
+    status: Status;
+    /**
+     * The version of the Snap.
+     */
+    version: string;
+    /**
+     * The version history of the Snap.
+     * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.
+     */
+    versionHistory: VersionHistory[];
+};
+export declare type TruncatedSnapFields = 'id' | 'initialPermissions' | 'permissionName' | 'version' | 'enabled' | 'blocked';
+/**
+ * A {@link Snap} object with the fields that are relevant to an external
+ * caller.
+ */
+export declare type TruncatedSnap = Pick<Snap, TruncatedSnapFields>;
+export declare type ProcessSnapResult = TruncatedSnap | {
+    error: SerializedEthereumRpcError;
+};
+export declare type InstallSnapsResult = Record<SnapId, ProcessSnapResult>;
+/**
+ * An error indicating that a Snap validation failure is programmatically
+ * fixable during development.
+ */
+export declare class ProgrammaticallyFixableSnapError extends Error {
+    reason: SnapValidationFailureReason;
+    constructor(message: string, reason: SnapValidationFailureReason);
+}
+/**
+ * Calculates the Base64-encoded SHA-256 digest of a Snap source code string.
+ *
+ * @param sourceCode - The UTF-8 string source code of a Snap.
+ * @returns The Base64-encoded SHA-256 digest of the source code.
+ */
+export declare function getSnapSourceShasum(sourceCode: string): string;
+export declare type ValidatedSnapId = `local:${string}` | `npm:${string}`;
+/**
+ * Checks whether the `source.shasum` property of a Snap manifest matches the
+ * shasum of a snap source code string.
+ *
+ * @param manifest - The manifest whose shasum to validate.
+ * @param sourceCode - The source code of the snap.
+ * @param errorMessage - The error message to throw if validation fails.
+ */
+export declare function validateSnapShasum(manifest: SnapManifest, sourceCode: string, errorMessage?: string): void;
+/**
+ * Extracts the snap prefix from a snap ID.
+ *
+ * @param snapId - The snap ID to extract the prefix from.
+ * @returns The snap prefix from a snap id, e.g. `npm:`.
+ */
+export declare function getSnapPrefix(snapId: string): SnapIdPrefixes;
+/**
+ * Computes the permission name of a snap from its snap ID.
+ *
+ * @param snapId - The snap ID.
+ * @returns The permission name corresponding to the given snap ID.
+ */
+export declare function getSnapPermissionName(snapId: string): string;
+/**
+ * Asserts the provided object is a snapId with a supported prefix.
+ *
+ * @param snapId - The object to validate.
+ * @throws {@link Error}. If the validation fails.
+ */
+export declare function validateSnapId(snapId: unknown): asserts snapId is ValidatedSnapId;
+/**
+ * Typeguard to ensure a chainId follows the CAIP-2 standard.
+ *
+ * @param chainId - The chainId being tested.
+ * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.
+ */
+export declare function isCaipChainId(chainId: unknown): chainId is string;

package/dist/snaps.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCaipChainId = exports.validateSnapId = exports.getSnapPermissionName = exports.getSnapPrefix = exports.validateSnapShasum = exports.getSnapSourceShasum = exports.ProgrammaticallyFixableSnapError = exports.SnapStatusEvents = exports.SnapStatus = exports.PROPOSED_NAME_REGEX = exports.SNAP_PREFIX_REGEX = exports.SNAP_PREFIX = exports.LOCALHOST_HOSTNAMES = void 0;
+const sha256_1 = require("@noble/hashes/sha256");
+const base_1 = require("@scure/base");
+const types_1 = require("./types");
+exports.LOCALHOST_HOSTNAMES = new Set(['localhost', '127.0.0.1', '::1']);
+exports.SNAP_PREFIX = 'wallet_snap_';
+exports.SNAP_PREFIX_REGEX = new RegExp(`^${exports.SNAP_PREFIX}`, 'u');
+// This RegEx matches valid npm package names (with some exceptions) and space-
+// separated alphanumerical words, optionally with dashes and underscores.
+// The RegEx consists of two parts. The first part matches space-separated
+// words. It is based on the following Stackoverflow answer:
+// https://stackoverflow.com/a/34974982
+// The second part, after the pipe operator, is the same RegEx used for the
+// `name` field of the official package.json JSON Schema, except that we allow
+// mixed-case letters. It was originally copied from:
+// https://github.com/SchemaStore/schemastore/blob/81a16897c1dabfd98c72242a5fd62eb080ff76d8/src/schemas/json/package.json#L132-L138
+exports.PROPOSED_NAME_REGEX = /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u;
+var SnapStatus;
+(function (SnapStatus) {
+    SnapStatus["Installing"] = "installing";
+    SnapStatus["Updating"] = "updating";
+    SnapStatus["Running"] = "running";
+    SnapStatus["Stopped"] = "stopped";
+    SnapStatus["Crashed"] = "crashed";
+})(SnapStatus = exports.SnapStatus || (exports.SnapStatus = {}));
+var SnapStatusEvents;
+(function (SnapStatusEvents) {
+    SnapStatusEvents["Start"] = "START";
+    SnapStatusEvents["Stop"] = "STOP";
+    SnapStatusEvents["Crash"] = "CRASH";
+    SnapStatusEvents["Update"] = "UPDATE";
+})(SnapStatusEvents = exports.SnapStatusEvents || (exports.SnapStatusEvents = {}));
+/**
+ * An error indicating that a Snap validation failure is programmatically
+ * fixable during development.
+ */
+class ProgrammaticallyFixableSnapError extends Error {
+    constructor(message, reason) {
+        super(message);
+        this.reason = reason;
+    }
+}
+exports.ProgrammaticallyFixableSnapError = ProgrammaticallyFixableSnapError;
+/**
+ * Calculates the Base64-encoded SHA-256 digest of a Snap source code string.
+ *
+ * @param sourceCode - The UTF-8 string source code of a Snap.
+ * @returns The Base64-encoded SHA-256 digest of the source code.
+ */
+function getSnapSourceShasum(sourceCode) {
+    return base_1.base64.encode((0, sha256_1.sha256)(sourceCode));
+}
+exports.getSnapSourceShasum = getSnapSourceShasum;
+/**
+ * Checks whether the `source.shasum` property of a Snap manifest matches the
+ * shasum of a snap source code string.
+ *
+ * @param manifest - The manifest whose shasum to validate.
+ * @param sourceCode - The source code of the snap.
+ * @param errorMessage - The error message to throw if validation fails.
+ */
+function validateSnapShasum(manifest, sourceCode, errorMessage = 'Invalid Snap manifest: manifest shasum does not match computed shasum.') {
+    if (manifest.source.shasum !== getSnapSourceShasum(sourceCode)) {
+        throw new ProgrammaticallyFixableSnapError(errorMessage, types_1.SnapValidationFailureReason.ShasumMismatch);
+    }
+}
+exports.validateSnapShasum = validateSnapShasum;
+/**
+ * Extracts the snap prefix from a snap ID.
+ *
+ * @param snapId - The snap ID to extract the prefix from.
+ * @returns The snap prefix from a snap id, e.g. `npm:`.
+ */
+function getSnapPrefix(snapId) {
+    const prefix = Object.values(types_1.SnapIdPrefixes).find((p) => snapId.startsWith(p));
+    if (prefix !== undefined) {
+        return prefix;
+    }
+    throw new Error(`Invalid or no prefix found for "${snapId}"`);
+}
+exports.getSnapPrefix = getSnapPrefix;
+/**
+ * Computes the permission name of a snap from its snap ID.
+ *
+ * @param snapId - The snap ID.
+ * @returns The permission name corresponding to the given snap ID.
+ */
+function getSnapPermissionName(snapId) {
+    return exports.SNAP_PREFIX + snapId;
+}
+exports.getSnapPermissionName = getSnapPermissionName;
+/**
+ * Asserts the provided object is a snapId with a supported prefix.
+ *
+ * @param snapId - The object to validate.
+ * @throws {@link Error}. If the validation fails.
+ */
+function validateSnapId(snapId) {
+    if (!snapId || typeof snapId !== 'string') {
+        throw new Error(`Invalid snap id. Not a string. Received "${snapId}"`);
+    }
+    for (const prefix of Object.values(types_1.SnapIdPrefixes)) {
+        if (snapId.startsWith(prefix) && snapId.replace(prefix, '').length > 0) {
+            return;
+        }
+    }
+    throw new Error(`Invalid snap id. Unknown prefix. Received: "${snapId}"`);
+}
+exports.validateSnapId = validateSnapId;
+/**
+ * Typeguard to ensure a chainId follows the CAIP-2 standard.
+ *
+ * @param chainId - The chainId being tested.
+ * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.
+ */
+function isCaipChainId(chainId) {
+    return (typeof chainId === 'string' &&
+        /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u.test(chainId));
+}
+exports.isCaipChainId = isCaipChainId;
+//# sourceMappingURL=snaps.js.map

package/dist/snaps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snaps.js","sourceRoot":"","sources":["../src/snaps.ts"],"names":[],"mappings":";;;AACA,iDAA8C;AAC9C,sCAAqC;AAGrC,mCAA8E;AAEjE,QAAA,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;AACjE,QAAA,WAAW,GAAG,cAAc,CAAC;AAE7B,QAAA,iBAAiB,GAAG,IAAI,MAAM,CAAC,IAAI,mBAAW,EAAE,EAAE,GAAG,CAAC,CAAC;AAEpE,+EAA+E;AAC/E,0EAA0E;AAC1E,0EAA0E;AAC1E,4DAA4D;AAC5D,uCAAuC;AACvC,2EAA2E;AAC3E,8EAA8E;AAC9E,qDAAqD;AACrD,mIAAmI;AACtH,QAAA,mBAAmB,GAC9B,kHAAkH,CAAC;AAarH,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,uCAAyB,CAAA;IACzB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;AACrB,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAED,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,qCAAiB,CAAA;AACnB,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B;AAqGD;;;GAGG;AACH,MAAa,gCAAiC,SAAQ,KAAK;IAGzD,YAAY,OAAe,EAAE,MAAmC;QAC9D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAPD,4EAOC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,UAAkB;IACpD,OAAO,aAAM,CAAC,MAAM,CAAC,IAAA,eAAM,EAAC,UAAU,CAAC,CAAC,CAAC;AAC3C,CAAC;AAFD,kDAEC;AAID;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,QAAsB,EACtB,UAAkB,EAClB,YAAY,GAAG,wEAAwE;IAEvF,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,KAAK,mBAAmB,CAAC,UAAU,CAAC,EAAE;QAC9D,MAAM,IAAI,gCAAgC,CACxC,YAAY,EACZ,mCAA2B,CAAC,cAAc,CAC3C,CAAC;KACH;AACH,CAAC;AAXD,gDAWC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,MAAc;IAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACtD,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CACrB,CAAC;IACF,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,OAAO,MAAM,CAAC;KACf;IACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,GAAG,CAAC,CAAC;AAChE,CAAC;AARD,sCAQC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,MAAc;IAClD,OAAO,mBAAW,GAAG,MAAM,CAAC;AAC9B,CAAC;AAFD,sDAEC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAC5B,MAAe;IAEf,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QACzC,MAAM,IAAI,KAAK,CAAC,4CAA4C,MAAM,GAAG,CAAC,CAAC;KACxE;IAED,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAc,CAAC,EAAE;QAClD,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACtE,OAAO;SACR;KACF;IAED,MAAM,IAAI,KAAK,CAAC,+CAA+C,MAAM,GAAG,CAAC,CAAC;AAC5E,CAAC;AAdD,wCAcC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,OAAgB;IAC5C,OAAO,CACL,OAAO,OAAO,KAAK,QAAQ;QAC3B,kEAAkE,CAAC,IAAI,CACrE,OAAO,CACR,CACF,CAAC;AACJ,CAAC;AAPD,sCAOC","sourcesContent":["import { Json } from '@metamask/utils';\nimport { sha256 } from '@noble/hashes/sha256';\nimport { base64 } from '@scure/base';\nimport { SerializedEthereumRpcError } from 'eth-rpc-errors/dist/classes';\nimport { SnapManifest, SnapPermissions } from './manifest/validation';\nimport { SnapId, SnapIdPrefixes, SnapValidationFailureReason } from './types';\n\nexport const LOCALHOST_HOSTNAMES = new Set(['localhost', '127.0.0.1', '::1']);\nexport const SNAP_PREFIX = 'wallet_snap_';\n\nexport const SNAP_PREFIX_REGEX = new RegExp(`^${SNAP_PREFIX}`, 'u');\n\n// This RegEx matches valid npm package names (with some exceptions) and space-\n// separated alphanumerical words, optionally with dashes and underscores.\n// The RegEx consists of two parts. The first part matches space-separated\n// words. It is based on the following Stackoverflow answer:\n// https://stackoverflow.com/a/34974982\n// The second part, after the pipe operator, is the same RegEx used for the\n// `name` field of the official package.json JSON Schema, except that we allow\n// mixed-case letters. It was originally copied from:\n// https://github.com/SchemaStore/schemastore/blob/81a16897c1dabfd98c72242a5fd62eb080ff76d8/src/schemas/json/package.json#L132-L138\nexport const PROPOSED_NAME_REGEX =\n  /^(?:[A-Za-z0-9-_]+( [A-Za-z0-9-_]+)*)|(?:(?:@[A-Za-z0-9-*~][A-Za-z0-9-*._~]*\\/)?[A-Za-z0-9-~][A-Za-z0-9-._~]*)$/u;\n\n/**\n * wallet_enable / wallet_installSnaps permission typing.\n *\n * @deprecated This type is confusing and not descriptive, people confused it with typing initialPermissions, remove when removing wallet_enable.\n */\nexport type RequestedSnapPermissions = {\n  [permission: string]: Record<string, Json>;\n};\n\nexport type BlockedSnapInfo = { infoUrl?: string; reason?: string };\n\nexport enum SnapStatus {\n  Installing = 'installing',\n  Updating = 'updating',\n  Running = 'running',\n  Stopped = 'stopped',\n  Crashed = 'crashed',\n}\n\nexport enum SnapStatusEvents {\n  Start = 'START',\n  Stop = 'STOP',\n  Crash = 'CRASH',\n  Update = 'UPDATE',\n}\n\nexport type StatusContext = { snapId: string };\nexport type StatusEvents = { type: SnapStatusEvents };\nexport type StatusStates = {\n  value: SnapStatus;\n  context: StatusContext;\n};\nexport type Status = StatusStates['value'];\n\nexport type VersionHistory = {\n  origin: string;\n  version: string;\n  // Unix timestamp\n  date: number;\n};\n\nexport type PersistedSnap = Snap & {\n  /**\n   * The source code of the Snap.\n   */\n  sourceCode: string;\n};\n\n/**\n * A Snap as it exists in {@link SnapController} state.\n */\nexport type Snap = {\n  /**\n   * Whether the Snap is enabled, which determines if it can be started.\n   */\n  enabled: boolean;\n\n  /**\n   * The ID of the Snap.\n   */\n  id: SnapId;\n\n  /**\n   * The initial permissions of the Snap, which will be requested when it is\n   * installed.\n   */\n  initialPermissions: SnapPermissions;\n\n  /**\n   * The Snap's manifest file.\n   */\n  manifest: SnapManifest;\n\n  /**\n   * Whether the Snap is blocked.\n   */\n  blocked: boolean;\n\n  /**\n   * Information detailing why the snap is blocked.\n   */\n  blockInformation?: BlockedSnapInfo;\n\n  /**\n   * The name of the permission used to invoke the Snap.\n   */\n  permissionName: string;\n\n  /**\n   * The current status of the Snap, e.g. whether it's running or stopped.\n   */\n  status: Status;\n\n  /**\n   * The version of the Snap.\n   */\n  version: string;\n\n  /**\n   * The version history of the Snap.\n   * Can be used to derive when the Snap was installed, when it was updated to a certain version and who requested the change.\n   */\n  versionHistory: VersionHistory[];\n};\n\nexport type TruncatedSnapFields =\n  | 'id'\n  | 'initialPermissions'\n  | 'permissionName'\n  | 'version'\n  | 'enabled'\n  | 'blocked';\n\n/**\n * A {@link Snap} object with the fields that are relevant to an external\n * caller.\n */\nexport type TruncatedSnap = Pick<Snap, TruncatedSnapFields>;\n\nexport type ProcessSnapResult =\n  | TruncatedSnap\n  | { error: SerializedEthereumRpcError };\n\nexport type InstallSnapsResult = Record<SnapId, ProcessSnapResult>;\n\n/**\n * An error indicating that a Snap validation failure is programmatically\n * fixable during development.\n */\nexport class ProgrammaticallyFixableSnapError extends Error {\n  reason: SnapValidationFailureReason;\n\n  constructor(message: string, reason: SnapValidationFailureReason) {\n    super(message);\n    this.reason = reason;\n  }\n}\n\n/**\n * Calculates the Base64-encoded SHA-256 digest of a Snap source code string.\n *\n * @param sourceCode - The UTF-8 string source code of a Snap.\n * @returns The Base64-encoded SHA-256 digest of the source code.\n */\nexport function getSnapSourceShasum(sourceCode: string): string {\n  return base64.encode(sha256(sourceCode));\n}\n\nexport type ValidatedSnapId = `local:${string}` | `npm:${string}`;\n\n/**\n * Checks whether the `source.shasum` property of a Snap manifest matches the\n * shasum of a snap source code string.\n *\n * @param manifest - The manifest whose shasum to validate.\n * @param sourceCode - The source code of the snap.\n * @param errorMessage - The error message to throw if validation fails.\n */\nexport function validateSnapShasum(\n  manifest: SnapManifest,\n  sourceCode: string,\n  errorMessage = 'Invalid Snap manifest: manifest shasum does not match computed shasum.',\n): void {\n  if (manifest.source.shasum !== getSnapSourceShasum(sourceCode)) {\n    throw new ProgrammaticallyFixableSnapError(\n      errorMessage,\n      SnapValidationFailureReason.ShasumMismatch,\n    );\n  }\n}\n\n/**\n * Extracts the snap prefix from a snap ID.\n *\n * @param snapId - The snap ID to extract the prefix from.\n * @returns The snap prefix from a snap id, e.g. `npm:`.\n */\nexport function getSnapPrefix(snapId: string): SnapIdPrefixes {\n  const prefix = Object.values(SnapIdPrefixes).find((p) =>\n    snapId.startsWith(p),\n  );\n  if (prefix !== undefined) {\n    return prefix;\n  }\n  throw new Error(`Invalid or no prefix found for \"${snapId}\"`);\n}\n\n/**\n * Computes the permission name of a snap from its snap ID.\n *\n * @param snapId - The snap ID.\n * @returns The permission name corresponding to the given snap ID.\n */\nexport function getSnapPermissionName(snapId: string): string {\n  return SNAP_PREFIX + snapId;\n}\n\n/**\n * Asserts the provided object is a snapId with a supported prefix.\n *\n * @param snapId - The object to validate.\n * @throws {@link Error}. If the validation fails.\n */\nexport function validateSnapId(\n  snapId: unknown,\n): asserts snapId is ValidatedSnapId {\n  if (!snapId || typeof snapId !== 'string') {\n    throw new Error(`Invalid snap id. Not a string. Received \"${snapId}\"`);\n  }\n\n  for (const prefix of Object.values(SnapIdPrefixes)) {\n    if (snapId.startsWith(prefix) && snapId.replace(prefix, '').length > 0) {\n      return;\n    }\n  }\n\n  throw new Error(`Invalid snap id. Unknown prefix. Received: \"${snapId}\"`);\n}\n\n/**\n * Typeguard to ensure a chainId follows the CAIP-2 standard.\n *\n * @param chainId - The chainId being tested.\n * @returns `true` if the value is a valid CAIP chain id, and `false` otherwise.\n */\nexport function isCaipChainId(chainId: unknown): chainId is string {\n  return (\n    typeof chainId === 'string' &&\n    /^(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-a-zA-Z0-9]{1,32})$/u.test(\n      chainId,\n    )\n  );\n}\n"]}

package/dist/types.d.ts

@@ -0,0 +1,107 @@
+import { SnapFunctionExports, SnapKeyring as Keyring } from '@metamask/snaps-types';
+import { Json } from '@metamask/utils';
+import { Infer } from 'superstruct';
+import { SnapManifest } from './manifest/validation';
+export declare enum NpmSnapFileNames {
+    PackageJson = "package.json",
+    Manifest = "snap.manifest.json"
+}
+/**
+ * A struct for validating a version string.
+ */
+export declare const VersionStruct: import("superstruct").Struct<string, null>;
+export declare const NameStruct: import("superstruct").Struct<string, null>;
+export declare const NpmSnapPackageJsonStruct: import("superstruct").Struct<{
+    name: string;
+    version: string;
+    repository?: {
+        type: string;
+        url: string;
+    } | undefined;
+    main?: string | undefined;
+}, {
+    version: import("superstruct").Struct<string, null>;
+    name: import("superstruct").Struct<string, null>;
+    main: import("superstruct").Struct<string | undefined, null>;
+    repository: import("superstruct").Struct<{
+        type: string;
+        url: string;
+    } | undefined, {
+        type: import("superstruct").Struct<string, null>;
+        url: import("superstruct").Struct<string, null>;
+    }>;
+}>;
+export declare type NpmSnapPackageJson = Infer<typeof NpmSnapPackageJsonStruct> & Record<string, any>;
+/**
+ * Check if the given value is a valid {@link NpmSnapPackageJson} object.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid {@link NpmSnapPackageJson} object.
+ */
+export declare function isNpmSnapPackageJson(value: unknown): value is NpmSnapPackageJson;
+/**
+ * Asserts that the given value is a valid {@link NpmSnapPackageJson} object.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a valid {@link NpmSnapPackageJson} object.
+ */
+export declare function assertIsNpmSnapPackageJson(value: unknown): asserts value is NpmSnapPackageJson;
+/**
+ * An object for storing parsed but unvalidated Snap file contents.
+ */
+export declare type UnvalidatedSnapFiles = {
+    manifest?: Json;
+    packageJson?: Json;
+    sourceCode?: string;
+    svgIcon?: string;
+};
+/**
+ * An object for storing the contents of Snap files that have passed JSON
+ * Schema validation, or are non-empty if they are strings.
+ */
+export declare type SnapFiles = {
+    manifest: SnapManifest;
+    packageJson: NpmSnapPackageJson;
+    sourceCode: string;
+    svgIcon?: string;
+};
+/**
+ * The possible prefixes for snap ids.
+ */
+export declare enum SnapIdPrefixes {
+    npm = "npm:",
+    local = "local:"
+}
+export declare type SnapId = string;
+/**
+ * Snap validation failure reason codes that are programmatically fixable
+ * if validation occurs during development.
+ */
+export declare enum SnapValidationFailureReason {
+    NameMismatch = "\"name\" field mismatch",
+    VersionMismatch = "\"version\" field mismatch",
+    RepositoryMismatch = "\"repository\" field mismatch",
+    ShasumMismatch = "\"shasum\" field mismatch"
+}
+export declare enum SNAP_STREAM_NAMES {
+    JSON_RPC = "jsonRpc",
+    COMMAND = "command"
+}
+export declare enum HandlerType {
+    OnRpcRequest = "onRpcRequest",
+    OnTransaction = "onTransaction",
+    SnapKeyring = "keyring",
+    OnCronjob = "onCronjob"
+}
+export declare const SNAP_EXPORT_NAMES: HandlerType[];
+export declare type SnapRpcHookArgs = {
+    origin: string;
+    handler: HandlerType;
+    request: Record<string, unknown>;
+};
+export declare type SnapRpcHook = (options: SnapRpcHookArgs) => Promise<unknown>;
+declare type ObjectParameters<Type extends Record<string, (...args: any[]) => unknown>> = Parameters<Type[keyof Type]>;
+declare type KeyringParameter<Fn> = Fn extends (...args: any[]) => unknown ? Parameters<Fn> : never;
+declare type KeyringParameters = KeyringParameter<Keyring[keyof Keyring]>;
+export declare type SnapExportsParameters = ObjectParameters<SnapFunctionExports> | KeyringParameters;
+export {};

package/dist/types.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SNAP_EXPORT_NAMES = exports.HandlerType = exports.SNAP_STREAM_NAMES = exports.SnapValidationFailureReason = exports.SnapIdPrefixes = exports.assertIsNpmSnapPackageJson = exports.isNpmSnapPackageJson = exports.NpmSnapPackageJsonStruct = exports.NameStruct = exports.VersionStruct = exports.NpmSnapFileNames = void 0;
+const utils_1 = require("@metamask/utils");
+const semver_1 = require("semver");
+const superstruct_1 = require("superstruct");
+var NpmSnapFileNames;
+(function (NpmSnapFileNames) {
+    NpmSnapFileNames["PackageJson"] = "package.json";
+    NpmSnapFileNames["Manifest"] = "snap.manifest.json";
+})(NpmSnapFileNames = exports.NpmSnapFileNames || (exports.NpmSnapFileNames = {}));
+/**
+ * A struct for validating a version string.
+ */
+exports.VersionStruct = (0, superstruct_1.refine)((0, superstruct_1.string)(), 'Version', (value) => {
+    return (0, semver_1.valid)(value) !== null;
+});
+exports.NameStruct = (0, superstruct_1.size)((0, superstruct_1.pattern)((0, superstruct_1.string)(), /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/u), 1, 214);
+// Note we use `type` instead of `object` here, because the latter does not
+// allow unknown keys.
+exports.NpmSnapPackageJsonStruct = (0, superstruct_1.type)({
+    version: exports.VersionStruct,
+    name: exports.NameStruct,
+    main: (0, superstruct_1.optional)((0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity)),
+    repository: (0, superstruct_1.optional)((0, superstruct_1.object)({
+        type: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
+        url: (0, superstruct_1.size)((0, superstruct_1.string)(), 1, Infinity),
+    })),
+});
+/**
+ * Check if the given value is a valid {@link NpmSnapPackageJson} object.
+ *
+ * @param value - The value to check.
+ * @returns Whether the value is a valid {@link NpmSnapPackageJson} object.
+ */
+function isNpmSnapPackageJson(value) {
+    return (0, superstruct_1.is)(value, exports.NpmSnapPackageJsonStruct);
+}
+exports.isNpmSnapPackageJson = isNpmSnapPackageJson;
+/**
+ * Asserts that the given value is a valid {@link NpmSnapPackageJson} object.
+ *
+ * @param value - The value to check.
+ * @throws If the value is not a valid {@link NpmSnapPackageJson} object.
+ */
+function assertIsNpmSnapPackageJson(value) {
+    (0, utils_1.assertStruct)(value, exports.NpmSnapPackageJsonStruct, `"${NpmSnapFileNames.PackageJson}" is invalid`);
+}
+exports.assertIsNpmSnapPackageJson = assertIsNpmSnapPackageJson;
+/**
+ * The possible prefixes for snap ids.
+ */
+var SnapIdPrefixes;
+(function (SnapIdPrefixes) {
+    SnapIdPrefixes["npm"] = "npm:";
+    SnapIdPrefixes["local"] = "local:";
+})(SnapIdPrefixes = exports.SnapIdPrefixes || (exports.SnapIdPrefixes = {}));
+/**
+ * Snap validation failure reason codes that are programmatically fixable
+ * if validation occurs during development.
+ */
+var SnapValidationFailureReason;
+(function (SnapValidationFailureReason) {
+    SnapValidationFailureReason["NameMismatch"] = "\"name\" field mismatch";
+    SnapValidationFailureReason["VersionMismatch"] = "\"version\" field mismatch";
+    SnapValidationFailureReason["RepositoryMismatch"] = "\"repository\" field mismatch";
+    SnapValidationFailureReason["ShasumMismatch"] = "\"shasum\" field mismatch";
+})(SnapValidationFailureReason = exports.SnapValidationFailureReason || (exports.SnapValidationFailureReason = {}));
+var SNAP_STREAM_NAMES;
+(function (SNAP_STREAM_NAMES) {
+    SNAP_STREAM_NAMES["JSON_RPC"] = "jsonRpc";
+    SNAP_STREAM_NAMES["COMMAND"] = "command";
+})(SNAP_STREAM_NAMES = exports.SNAP_STREAM_NAMES || (exports.SNAP_STREAM_NAMES = {}));
+var HandlerType;
+(function (HandlerType) {
+    HandlerType["OnRpcRequest"] = "onRpcRequest";
+    HandlerType["OnTransaction"] = "onTransaction";
+    HandlerType["SnapKeyring"] = "keyring";
+    HandlerType["OnCronjob"] = "onCronjob";
+})(HandlerType = exports.HandlerType || (exports.HandlerType = {}));
+exports.SNAP_EXPORT_NAMES = Object.values(HandlerType);
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAIA,2CAAqD;AACrD,mCAA8C;AAC9C,6CAUqB;AAGrB,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,gDAA4B,CAAA;IAC5B,mDAA+B,CAAA;AACjC,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAED;;GAEG;AACU,QAAA,aAAa,GAAG,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;IACjE,OAAO,IAAA,cAAW,EAAC,KAAK,CAAC,KAAK,IAAI,CAAC;AACrC,CAAC,CAAC,CAAC;AAEU,QAAA,UAAU,GAAG,IAAA,kBAAI,EAC5B,IAAA,qBAAO,EACL,IAAA,oBAAM,GAAE,EACR,6DAA6D,CAC9D,EACD,CAAC,EACD,GAAG,CACJ,CAAC;AAEF,2EAA2E;AAC3E,sBAAsB;AACT,QAAA,wBAAwB,GAAG,IAAA,kBAAI,EAAC;IAC3C,OAAO,EAAE,qBAAa;IACtB,IAAI,EAAE,kBAAU;IAChB,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC3C,UAAU,EAAE,IAAA,sBAAQ,EAClB,IAAA,oBAAM,EAAC;QACL,IAAI,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;QACjC,GAAG,EAAE,IAAA,kBAAI,EAAC,IAAA,oBAAM,GAAE,EAAE,CAAC,EAAE,QAAQ,CAAC;KACjC,CAAC,CACH;CACF,CAAC,CAAC;AAKH;;;;;GAKG;AACH,SAAgB,oBAAoB,CAClC,KAAc;IAEd,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,gCAAwB,CAAC,CAAC;AAC7C,CAAC;AAJD,oDAIC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CACxC,KAAc;IAEd,IAAA,oBAAY,EACV,KAAK,EACL,gCAAwB,EACxB,IAAI,gBAAgB,CAAC,WAAW,cAAc,CAC/C,CAAC;AACJ,CAAC;AARD,gEAQC;AAuBD;;GAEG;AACH,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,8BAAY,CAAA;IACZ,kCAAgB,CAAA;AAClB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAID;;;GAGG;AACH,IAAY,2BAKX;AALD,WAAY,2BAA2B;IACrC,uEAAsC,CAAA;IACtC,6EAA4C,CAAA;IAC5C,mFAAkD,CAAA;IAClD,2EAA0C,CAAA;AAC5C,CAAC,EALW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAKtC;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,yCAAoB,CAAA;IACpB,wCAAmB,CAAA;AACrB,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;AAED,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,4CAA6B,CAAA;IAC7B,8CAA+B,CAAA;IAC/B,sCAAuB,CAAA;IACvB,sCAAuB,CAAA;AACzB,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAEY,QAAA,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC","sourcesContent":["import {\n  SnapFunctionExports,\n  SnapKeyring as Keyring,\n} from '@metamask/snaps-types';\nimport { assertStruct, Json } from '@metamask/utils';\nimport { valid as validSemver } from 'semver';\nimport {\n  Infer,\n  is,\n  object,\n  optional,\n  pattern,\n  refine,\n  size,\n  string,\n  type,\n} from 'superstruct';\nimport { SnapManifest } from './manifest/validation';\n\nexport enum NpmSnapFileNames {\n  PackageJson = 'package.json',\n  Manifest = 'snap.manifest.json',\n}\n\n/**\n * A struct for validating a version string.\n */\nexport const VersionStruct = refine(string(), 'Version', (value) => {\n  return validSemver(value) !== null;\n});\n\nexport const NameStruct = size(\n  pattern(\n    string(),\n    /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\\/)?[a-z0-9-~][a-z0-9-._~]*$/u,\n  ),\n  1,\n  214,\n);\n\n// Note we use `type` instead of `object` here, because the latter does not\n// allow unknown keys.\nexport const NpmSnapPackageJsonStruct = type({\n  version: VersionStruct,\n  name: NameStruct,\n  main: optional(size(string(), 1, Infinity)),\n  repository: optional(\n    object({\n      type: size(string(), 1, Infinity),\n      url: size(string(), 1, Infinity),\n    }),\n  ),\n});\n\nexport type NpmSnapPackageJson = Infer<typeof NpmSnapPackageJsonStruct> &\n  Record<string, any>;\n\n/**\n * Check if the given value is a valid {@link NpmSnapPackageJson} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link NpmSnapPackageJson} object.\n */\nexport function isNpmSnapPackageJson(\n  value: unknown,\n): value is NpmSnapPackageJson {\n  return is(value, NpmSnapPackageJsonStruct);\n}\n\n/**\n * Asserts that the given value is a valid {@link NpmSnapPackageJson} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link NpmSnapPackageJson} object.\n */\nexport function assertIsNpmSnapPackageJson(\n  value: unknown,\n): asserts value is NpmSnapPackageJson {\n  assertStruct(\n    value,\n    NpmSnapPackageJsonStruct,\n    `\"${NpmSnapFileNames.PackageJson}\" is invalid`,\n  );\n}\n\n/**\n * An object for storing parsed but unvalidated Snap file contents.\n */\nexport type UnvalidatedSnapFiles = {\n  manifest?: Json;\n  packageJson?: Json;\n  sourceCode?: string;\n  svgIcon?: string;\n};\n\n/**\n * An object for storing the contents of Snap files that have passed JSON\n * Schema validation, or are non-empty if they are strings.\n */\nexport type SnapFiles = {\n  manifest: SnapManifest;\n  packageJson: NpmSnapPackageJson;\n  sourceCode: string;\n  svgIcon?: string;\n};\n\n/**\n * The possible prefixes for snap ids.\n */\nexport enum SnapIdPrefixes {\n  npm = 'npm:',\n  local = 'local:',\n}\n\nexport type SnapId = string;\n\n/**\n * Snap validation failure reason codes that are programmatically fixable\n * if validation occurs during development.\n */\nexport enum SnapValidationFailureReason {\n  NameMismatch = '\"name\" field mismatch',\n  VersionMismatch = '\"version\" field mismatch',\n  RepositoryMismatch = '\"repository\" field mismatch',\n  ShasumMismatch = '\"shasum\" field mismatch',\n}\n\nexport enum SNAP_STREAM_NAMES {\n  JSON_RPC = 'jsonRpc',\n  COMMAND = 'command',\n}\n\nexport enum HandlerType {\n  OnRpcRequest = 'onRpcRequest',\n  OnTransaction = 'onTransaction',\n  SnapKeyring = 'keyring',\n  OnCronjob = 'onCronjob',\n}\n\nexport const SNAP_EXPORT_NAMES = Object.values(HandlerType);\n\nexport type SnapRpcHookArgs = {\n  origin: string;\n  handler: HandlerType;\n  request: Record<string, unknown>;\n};\n\n// The snap is the callee\nexport type SnapRpcHook = (options: SnapRpcHookArgs) => Promise<unknown>;\n\ntype ObjectParameters<\n  Type extends Record<string, (...args: any[]) => unknown>,\n> = Parameters<Type[keyof Type]>;\n\ntype KeyringParameter<Fn> = Fn extends (...args: any[]) => unknown\n  ? Parameters<Fn>\n  : never;\n\ntype KeyringParameters = KeyringParameter<Keyring[keyof Keyring]>;\n\nexport type SnapExportsParameters =\n  | ObjectParameters<SnapFunctionExports>\n  | KeyringParameters;\n"]}

package/dist/url.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks whether a URL is valid.
+ *
+ * @param maybeUrl - The string to check.
+ * @returns Whether the specified string is a valid URL.
+ */
+export declare function isValidUrl(maybeUrl: string): maybeUrl is string;

package/dist/url.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidUrl = void 0;
+/**
+ * Checks whether a URL is valid.
+ *
+ * @param maybeUrl - The string to check.
+ * @returns Whether the specified string is a valid URL.
+ */
+function isValidUrl(maybeUrl) {
+    try {
+        return Boolean(new URL(maybeUrl));
+    }
+    catch (_error) {
+        return false;
+    }
+}
+exports.isValidUrl = isValidUrl;
+//# sourceMappingURL=url.js.map

package/dist/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,QAAgB;IACzC,IAAI;QACF,OAAO,OAAO,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;KACnC;IAAC,OAAO,MAAM,EAAE;QACf,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAND,gCAMC","sourcesContent":["/**\n * Checks whether a URL is valid.\n *\n * @param maybeUrl - The string to check.\n * @returns Whether the specified string is a valid URL.\n */\nexport function isValidUrl(maybeUrl: string): maybeUrl is string {\n  try {\n    return Boolean(new URL(maybeUrl));\n  } catch (_error) {\n    return false;\n  }\n}\n"]}

package/dist/versions.d.ts

@@ -0,0 +1,44 @@
+import { Json } from '@metamask/utils';
+export declare const DEFAULT_REQUESTED_SNAP_VERSION = "*";
+/**
+ * Checks whether a SemVer version is greater than another.
+ *
+ * @param version1 - The left-hand version.
+ * @param version2 - The right-hand version.
+ * @returns `version1 > version2`.
+ */
+export declare function gtVersion(version1: string, version2: string): boolean;
+/**
+ * Returns whether a SemVer version satisfies a SemVer range.
+ *
+ * @param version - The SemVer version to check.
+ * @param versionRange - The SemVer version range to check against.
+ * @returns Whether the version satisfied the version range.
+ */
+export declare function satisfiesVersionRange(version: string, versionRange: string): boolean;
+/**
+ * Return the highest version in the list that satisfies the range, or `null` if
+ * none of them do. For the satisfaction check, pre-release versions will only
+ * be checked if no satisfactory non-prerelease version is found first.
+ *
+ * @param versions - The list of version to check.
+ * @param versionRange - The SemVer version range to check against.
+ * @returns The highest version in the list that satisfies the range,
+ * or `null` if none of them do.
+ */
+export declare function getTargetVersion(versions: string[], versionRange: string): string | null;
+/**
+ * Parse a version received by some subject attempting to access a snap.
+ *
+ * @param version - The received version value.
+ * @returns `*` if the version is `undefined` or `latest", otherwise returns
+ * the specified version.
+ */
+export declare function resolveVersion(version?: Json): Json;
+/**
+ * Checks whether a SemVer version range is valid.
+ *
+ * @param versionRange - A potential version range.
+ * @returns `true` if the version range is valid, and `false` otherwise.
+ */
+export declare function isValidSnapVersionRange(versionRange: unknown): versionRange is string;