@metamask/snaps-utils 5.2.0 → 6.1.0

package/dist/esm/handlers.js

@@ -1,5 +1,5 @@
 import { SeverityLevel, ComponentStruct } from '@metamask/snaps-sdk';
-import { literal, nullable, object, optional } from 'superstruct';
+import { assign, literal, nullable, object, optional, string, array, size, union } from 'superstruct';
 import { HandlerType } from './handler-types';
 export const SNAP_EXPORTS = {
     [HandlerType.OnRpcRequest]: {
@@ -64,15 +64,56 @@ export const SNAP_EXPORTS = {
         validator: (snapExport)=>{
             return typeof snapExport === 'function';
         }
+    },
+    [HandlerType.OnUserInput]: {
+        type: HandlerType.OnUserInput,
+        required: true,
+        validator: (snapExport)=>{
+            return typeof snapExport === 'function';
+        }
     }
 };
-export const OnTransactionResponseStruct = nullable(object({
-    content: ComponentStruct,
+export const OnTransactionSeverityResponseStruct = object({
     severity: optional(literal(SeverityLevel.Critical))
+});
+export const OnTransactionResponseWithIdStruct = assign(OnTransactionSeverityResponseStruct, object({
+    id: string()
 }));
+export const OnTransactionResponseWithContentStruct = assign(OnTransactionSeverityResponseStruct, object({
+    content: ComponentStruct
+}));
+export const OnTransactionResponseStruct = nullable(union([
+    OnTransactionResponseWithContentStruct,
+    OnTransactionResponseWithIdStruct
+]));
 export const OnSignatureResponseStruct = OnTransactionResponseStruct;
-export const OnHomePageResponseStruct = object({
+export const OnHomePageResponseWithContentStruct = object({
     content: ComponentStruct
 });
+export const OnHomePageResponseWithIdStruct = object({
+    id: string()
+});
+export const OnHomePageResponseStruct = union([
+    OnHomePageResponseWithContentStruct,
+    OnHomePageResponseWithIdStruct
+]);
+export const AddressResolutionStruct = object({
+    protocol: string(),
+    resolvedDomain: string()
+});
+export const DomainResolutionStruct = object({
+    protocol: string(),
+    resolvedAddress: string()
+});
+export const AddressResolutionResponseStruct = object({
+    resolvedDomains: size(array(AddressResolutionStruct), 1, Infinity)
+});
+export const DomainResolutionResponseStruct = object({
+    resolvedAddresses: size(array(DomainResolutionStruct), 1, Infinity)
+});
+export const OnNameLookupResponseStruct = nullable(union([
+    AddressResolutionResponseStruct,
+    DomainResolutionResponseStruct
+]));
 
 //# sourceMappingURL=handlers.js.map

package/dist/esm/handlers.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/handlers.ts"],"sourcesContent":["import type {\n  OnCronjobHandler,\n  OnHomePageHandler,\n  OnInstallHandler,\n  OnKeyringRequestHandler,\n  OnNameLookupHandler,\n  OnRpcRequestHandler,\n  OnSignatureHandler,\n  OnTransactionHandler,\n  OnUpdateHandler,\n} from '@metamask/snaps-sdk';\nimport { SeverityLevel, ComponentStruct } from '@metamask/snaps-sdk';\nimport { literal, nullable, object, optional } from 'superstruct';\n\nimport type { SnapHandler } from './handler-types';\nimport { HandlerType } from './handler-types';\n\nexport type SnapRpcHookArgs = {\n  origin: string;\n  handler: HandlerType;\n  request: Record<string, unknown>;\n};\n\nexport const SNAP_EXPORTS = {\n  [HandlerType.OnRpcRequest]: {\n    type: HandlerType.OnRpcRequest,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnRpcRequestHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnTransaction]: {\n    type: HandlerType.OnTransaction,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnTransactionHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnCronjob]: {\n    type: HandlerType.OnCronjob,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnCronjobHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnNameLookup]: {\n    type: HandlerType.OnNameLookup,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnNameLookupHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnInstall]: {\n    type: HandlerType.OnInstall,\n    required: false,\n    validator: (snapExport: unknown): snapExport is OnInstallHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnUpdate]: {\n    type: HandlerType.OnUpdate,\n    required: false,\n    validator: (snapExport: unknown): snapExport is OnUpdateHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnKeyringRequest]: {\n    type: HandlerType.OnKeyringRequest,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnKeyringRequestHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnHomePage]: {\n    type: HandlerType.OnHomePage,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnHomePageHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnSignature]: {\n    type: HandlerType.OnSignature,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnSignatureHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n} as const;\n\nexport const OnTransactionResponseStruct = nullable(\n  object({\n    content: ComponentStruct,\n    severity: optional(literal(SeverityLevel.Critical)),\n  }),\n);\n\nexport const OnSignatureResponseStruct = OnTransactionResponseStruct;\n\nexport const OnHomePageResponseStruct = object({\n  content: ComponentStruct,\n});\n\n/**\n * Utility type for getting the handler function type from a handler type.\n */\nexport type HandlerFunction<Type extends SnapHandler> =\n  Type['validator'] extends (snapExport: unknown) => snapExport is infer Handler\n    ? Handler\n    : never;\n\n/**\n * All the function-based handlers that a snap can implement.\n */\nexport type SnapFunctionExports = {\n  [Key in keyof typeof SNAP_EXPORTS]?: HandlerFunction<\n    (typeof SNAP_EXPORTS)[Key]\n  >;\n};\n\n/**\n * All handlers that a snap can implement.\n */\nexport type SnapExports = SnapFunctionExports;\n"],"names":["SeverityLevel","ComponentStruct","literal","nullable","object","optional","HandlerType","SNAP_EXPORTS","OnRpcRequest","type","required","validator","snapExport","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","OnSignature","OnTransactionResponseStruct","content","severity","Critical","OnSignatureResponseStruct","OnHomePageResponseStruct"],"mappings":"AAWA,SAASA,aAAa,EAAEC,eAAe,QAAQ,sBAAsB;AACrE,SAASC,OAAO,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,cAAc;AAGlE,SAASC,WAAW,QAAQ,kBAAkB;AAQ9C,OAAO,MAAMC,eAAe;IAC1B,CAACD,YAAYE,YAAY,CAAC,EAAE;QAC1BC,MAAMH,YAAYE,YAAY;QAC9BE,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYO,aAAa,CAAC,EAAE;QAC3BJ,MAAMH,YAAYO,aAAa;QAC/BH,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYQ,SAAS,CAAC,EAAE;QACvBL,MAAMH,YAAYQ,SAAS;QAC3BJ,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYS,YAAY,CAAC,EAAE;QAC1BN,MAAMH,YAAYS,YAAY;QAC9BL,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYU,SAAS,CAAC,EAAE;QACvBP,MAAMH,YAAYU,SAAS;QAC3BN,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYW,QAAQ,CAAC,EAAE;QACtBR,MAAMH,YAAYW,QAAQ;QAC1BP,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYY,gBAAgB,CAAC,EAAE;QAC9BT,MAAMH,YAAYY,gBAAgB;QAClCR,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYa,UAAU,CAAC,EAAE;QACxBV,MAAMH,YAAYa,UAAU;QAC5BT,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYc,WAAW,CAAC,EAAE;QACzBX,MAAMH,YAAYc,WAAW;QAC7BV,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;AACF,EAAW;AAEX,OAAO,MAAMS,8BAA8BlB,SACzCC,OAAO;IACLkB,SAASrB;IACTsB,UAAUlB,SAASH,QAAQF,cAAcwB,QAAQ;AACnD,IACA;AAEF,OAAO,MAAMC,4BAA4BJ,4BAA4B;AAErE,OAAO,MAAMK,2BAA2BtB,OAAO;IAC7CkB,SAASrB;AACX,GAAG"}
+{"version":3,"sources":["../../src/handlers.ts"],"sourcesContent":["import type {\n  OnCronjobHandler,\n  OnHomePageHandler,\n  OnInstallHandler,\n  OnKeyringRequestHandler,\n  OnNameLookupHandler,\n  OnRpcRequestHandler,\n  OnSignatureHandler,\n  OnTransactionHandler,\n  OnUpdateHandler,\n  OnUserInputHandler,\n} from '@metamask/snaps-sdk';\nimport { SeverityLevel, ComponentStruct } from '@metamask/snaps-sdk';\nimport {\n  assign,\n  literal,\n  nullable,\n  object,\n  optional,\n  string,\n  array,\n  size,\n  union,\n} from 'superstruct';\n\nimport type { SnapHandler } from './handler-types';\nimport { HandlerType } from './handler-types';\n\nexport type SnapRpcHookArgs = {\n  origin: string;\n  handler: HandlerType;\n  request: Record<string, unknown>;\n};\n\nexport const SNAP_EXPORTS = {\n  [HandlerType.OnRpcRequest]: {\n    type: HandlerType.OnRpcRequest,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnRpcRequestHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnTransaction]: {\n    type: HandlerType.OnTransaction,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnTransactionHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnCronjob]: {\n    type: HandlerType.OnCronjob,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnCronjobHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnNameLookup]: {\n    type: HandlerType.OnNameLookup,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnNameLookupHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnInstall]: {\n    type: HandlerType.OnInstall,\n    required: false,\n    validator: (snapExport: unknown): snapExport is OnInstallHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnUpdate]: {\n    type: HandlerType.OnUpdate,\n    required: false,\n    validator: (snapExport: unknown): snapExport is OnUpdateHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnKeyringRequest]: {\n    type: HandlerType.OnKeyringRequest,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnKeyringRequestHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnHomePage]: {\n    type: HandlerType.OnHomePage,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnHomePageHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnSignature]: {\n    type: HandlerType.OnSignature,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnSignatureHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n  [HandlerType.OnUserInput]: {\n    type: HandlerType.OnUserInput,\n    required: true,\n    validator: (snapExport: unknown): snapExport is OnUserInputHandler => {\n      return typeof snapExport === 'function';\n    },\n  },\n} as const;\n\nexport const OnTransactionSeverityResponseStruct = object({\n  severity: optional(literal(SeverityLevel.Critical)),\n});\n\nexport const OnTransactionResponseWithIdStruct = assign(\n  OnTransactionSeverityResponseStruct,\n  object({\n    id: string(),\n  }),\n);\n\nexport const OnTransactionResponseWithContentStruct = assign(\n  OnTransactionSeverityResponseStruct,\n  object({\n    content: ComponentStruct,\n  }),\n);\n\nexport const OnTransactionResponseStruct = nullable(\n  union([\n    OnTransactionResponseWithContentStruct,\n    OnTransactionResponseWithIdStruct,\n  ]),\n);\n\nexport const OnSignatureResponseStruct = OnTransactionResponseStruct;\n\nexport const OnHomePageResponseWithContentStruct = object({\n  content: ComponentStruct,\n});\n\nexport const OnHomePageResponseWithIdStruct = object({\n  id: string(),\n});\n\nexport const OnHomePageResponseStruct = union([\n  OnHomePageResponseWithContentStruct,\n  OnHomePageResponseWithIdStruct,\n]);\n\nexport const AddressResolutionStruct = object({\n  protocol: string(),\n  resolvedDomain: string(),\n});\n\nexport const DomainResolutionStruct = object({\n  protocol: string(),\n  resolvedAddress: string(),\n});\n\nexport const AddressResolutionResponseStruct = object({\n  resolvedDomains: size(array(AddressResolutionStruct), 1, Infinity),\n});\n\nexport const DomainResolutionResponseStruct = object({\n  resolvedAddresses: size(array(DomainResolutionStruct), 1, Infinity),\n});\n\nexport const OnNameLookupResponseStruct = nullable(\n  union([AddressResolutionResponseStruct, DomainResolutionResponseStruct]),\n);\n\n/**\n * Utility type for getting the handler function type from a handler type.\n */\nexport type HandlerFunction<Type extends SnapHandler> =\n  Type['validator'] extends (snapExport: unknown) => snapExport is infer Handler\n    ? Handler\n    : never;\n\n/**\n * All the function-based handlers that a snap can implement.\n */\nexport type SnapFunctionExports = {\n  [Key in keyof typeof SNAP_EXPORTS]?: HandlerFunction<\n    (typeof SNAP_EXPORTS)[Key]\n  >;\n};\n\n/**\n * All handlers that a snap can implement.\n */\nexport type SnapExports = SnapFunctionExports;\n"],"names":["SeverityLevel","ComponentStruct","assign","literal","nullable","object","optional","string","array","size","union","HandlerType","SNAP_EXPORTS","OnRpcRequest","type","required","validator","snapExport","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","OnSignature","OnUserInput","OnTransactionSeverityResponseStruct","severity","Critical","OnTransactionResponseWithIdStruct","id","OnTransactionResponseWithContentStruct","content","OnTransactionResponseStruct","OnSignatureResponseStruct","OnHomePageResponseWithContentStruct","OnHomePageResponseWithIdStruct","OnHomePageResponseStruct","AddressResolutionStruct","protocol","resolvedDomain","DomainResolutionStruct","resolvedAddress","AddressResolutionResponseStruct","resolvedDomains","Infinity","DomainResolutionResponseStruct","resolvedAddresses","OnNameLookupResponseStruct"],"mappings":"AAYA,SAASA,aAAa,EAAEC,eAAe,QAAQ,sBAAsB;AACrE,SACEC,MAAM,EACNC,OAAO,EACPC,QAAQ,EACRC,MAAM,EACNC,QAAQ,EACRC,MAAM,EACNC,KAAK,EACLC,IAAI,EACJC,KAAK,QACA,cAAc;AAGrB,SAASC,WAAW,QAAQ,kBAAkB;AAQ9C,OAAO,MAAMC,eAAe;IAC1B,CAACD,YAAYE,YAAY,CAAC,EAAE;QAC1BC,MAAMH,YAAYE,YAAY;QAC9BE,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYO,aAAa,CAAC,EAAE;QAC3BJ,MAAMH,YAAYO,aAAa;QAC/BH,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYQ,SAAS,CAAC,EAAE;QACvBL,MAAMH,YAAYQ,SAAS;QAC3BJ,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYS,YAAY,CAAC,EAAE;QAC1BN,MAAMH,YAAYS,YAAY;QAC9BL,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYU,SAAS,CAAC,EAAE;QACvBP,MAAMH,YAAYU,SAAS;QAC3BN,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYW,QAAQ,CAAC,EAAE;QACtBR,MAAMH,YAAYW,QAAQ;QAC1BP,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYY,gBAAgB,CAAC,EAAE;QAC9BT,MAAMH,YAAYY,gBAAgB;QAClCR,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYa,UAAU,CAAC,EAAE;QACxBV,MAAMH,YAAYa,UAAU;QAC5BT,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYc,WAAW,CAAC,EAAE;QACzBX,MAAMH,YAAYc,WAAW;QAC7BV,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACN,YAAYe,WAAW,CAAC,EAAE;QACzBZ,MAAMH,YAAYe,WAAW;QAC7BX,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;AACF,EAAW;AAEX,OAAO,MAAMU,sCAAsCtB,OAAO;IACxDuB,UAAUtB,SAASH,QAAQH,cAAc6B,QAAQ;AACnD,GAAG;AAEH,OAAO,MAAMC,oCAAoC5B,OAC/CyB,qCACAtB,OAAO;IACL0B,IAAIxB;AACN,IACA;AAEF,OAAO,MAAMyB,yCAAyC9B,OACpDyB,qCACAtB,OAAO;IACL4B,SAAShC;AACX,IACA;AAEF,OAAO,MAAMiC,8BAA8B9B,SACzCM,MAAM;IACJsB;IACAF;CACD,GACD;AAEF,OAAO,MAAMK,4BAA4BD,4BAA4B;AAErE,OAAO,MAAME,sCAAsC/B,OAAO;IACxD4B,SAAShC;AACX,GAAG;AAEH,OAAO,MAAMoC,iCAAiChC,OAAO;IACnD0B,IAAIxB;AACN,GAAG;AAEH,OAAO,MAAM+B,2BAA2B5B,MAAM;IAC5C0B;IACAC;CACD,EAAE;AAEH,OAAO,MAAME,0BAA0BlC,OAAO;IAC5CmC,UAAUjC;IACVkC,gBAAgBlC;AAClB,GAAG;AAEH,OAAO,MAAMmC,yBAAyBrC,OAAO;IAC3CmC,UAAUjC;IACVoC,iBAAiBpC;AACnB,GAAG;AAEH,OAAO,MAAMqC,kCAAkCvC,OAAO;IACpDwC,iBAAiBpC,KAAKD,MAAM+B,0BAA0B,GAAGO;AAC3D,GAAG;AAEH,OAAO,MAAMC,iCAAiC1C,OAAO;IACnD2C,mBAAmBvC,KAAKD,MAAMkC,yBAAyB,GAAGI;AAC5D,GAAG;AAEH,OAAO,MAAMG,6BAA6B7C,SACxCM,MAAM;IAACkC;IAAiCG;CAA+B,GACvE"}

package/dist/esm/icon.js

@@ -1,11 +1,51 @@
+import { isSvg, parseSvg } from '@metamask/snaps-sdk';
 import { assert } from '@metamask/utils';
-import isSvg from 'is-svg';
 export const SVG_MAX_BYTE_SIZE = 100000;
 export const SVG_MAX_BYTE_SIZE_TEXT = `${Math.floor(SVG_MAX_BYTE_SIZE / 1000)}kb`;
-export const assertIsSnapIcon = (icon)=>{
+/**
+ * Assert that a virtual file containing a Snap icon is valid.
+ *
+ * @param icon - A virtual file containing a Snap icon.
+ */ export function assertIsSnapIcon(icon) {
     assert(icon.path.endsWith('.svg'), 'Expected snap icon to end in ".svg".');
     assert(Buffer.byteLength(icon.value, 'utf8') <= SVG_MAX_BYTE_SIZE, `The specified SVG icon exceeds the maximum size of ${SVG_MAX_BYTE_SIZE_TEXT}.`);
     assert(isSvg(icon.toString()), 'Snap icon must be a valid SVG.');
-};
+}
+/**
+ * Extract the dimensions of an image from an SVG string if possible.
+ *
+ * @param svg - An SVG string.
+ * @returns The height and width of the SVG or null.
+ */ export function getSvgDimensions(svg) {
+    try {
+        const parsed = parseSvg(svg);
+        const height = parsed['@_height'];
+        const width = parsed['@_width'];
+        if (height && width) {
+            return {
+                height,
+                width
+            };
+        }
+        const viewBox = parsed['@_viewBox'];
+        if (viewBox) {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const [_minX, _minY, viewBoxWidth, viewBoxHeight] = viewBox.split(' ');
+            if (viewBoxWidth && viewBoxHeight) {
+                const parsedWidth = parseInt(viewBoxWidth, 10);
+                const parsedHeight = parseInt(viewBoxHeight, 10);
+                assert(Number.isInteger(parsedWidth) && parsedWidth > 0);
+                assert(Number.isInteger(parsedHeight) && parsedHeight > 0);
+                return {
+                    width: parsedWidth,
+                    height: parsedHeight
+                };
+            }
+        }
+    } catch  {
+        throw new Error('Snap icon must be a valid SVG.');
+    }
+    return null;
+}
 
 //# sourceMappingURL=icon.js.map

package/dist/esm/icon.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/icon.ts"],"sourcesContent":["import { assert } from '@metamask/utils';\nimport isSvg from 'is-svg';\n\nimport type { VirtualFile } from './virtual-file';\n\nexport const SVG_MAX_BYTE_SIZE = 100_000;\nexport const SVG_MAX_BYTE_SIZE_TEXT = `${Math.floor(\n  SVG_MAX_BYTE_SIZE / 1000,\n)}kb`;\n\nexport const assertIsSnapIcon = (icon: VirtualFile) => {\n  assert(icon.path.endsWith('.svg'), 'Expected snap icon to end in \".svg\".');\n\n  assert(\n    Buffer.byteLength(icon.value, 'utf8') <= SVG_MAX_BYTE_SIZE,\n    `The specified SVG icon exceeds the maximum size of ${SVG_MAX_BYTE_SIZE_TEXT}.`,\n  );\n\n  assert(isSvg(icon.toString()), 'Snap icon must be a valid SVG.');\n};\n"],"names":["assert","isSvg","SVG_MAX_BYTE_SIZE","SVG_MAX_BYTE_SIZE_TEXT","Math","floor","assertIsSnapIcon","icon","path","endsWith","Buffer","byteLength","value","toString"],"mappings":"AAAA,SAASA,MAAM,QAAQ,kBAAkB;AACzC,OAAOC,WAAW,SAAS;AAI3B,OAAO,MAAMC,oBAAoB,OAAQ;AACzC,OAAO,MAAMC,yBAAyB,CAAC,EAAEC,KAAKC,KAAK,CACjDH,oBAAoB,MACpB,EAAE,CAAC,CAAC;AAEN,OAAO,MAAMI,mBAAmB,CAACC;IAC/BP,OAAOO,KAAKC,IAAI,CAACC,QAAQ,CAAC,SAAS;IAEnCT,OACEU,OAAOC,UAAU,CAACJ,KAAKK,KAAK,EAAE,WAAWV,mBACzC,CAAC,mDAAmD,EAAEC,uBAAuB,CAAC,CAAC;IAGjFH,OAAOC,MAAMM,KAAKM,QAAQ,KAAK;AACjC,EAAE"}
+{"version":3,"sources":["../../src/icon.ts"],"sourcesContent":["import { isSvg, parseSvg } from '@metamask/snaps-sdk';\nimport { assert } from '@metamask/utils';\n\nimport type { VirtualFile } from './virtual-file';\n\nexport const SVG_MAX_BYTE_SIZE = 100_000;\nexport const SVG_MAX_BYTE_SIZE_TEXT = `${Math.floor(\n  SVG_MAX_BYTE_SIZE / 1000,\n)}kb`;\n\n/**\n * Assert that a virtual file containing a Snap icon is valid.\n *\n * @param icon - A virtual file containing a Snap icon.\n */\nexport function assertIsSnapIcon(icon: VirtualFile) {\n  assert(icon.path.endsWith('.svg'), 'Expected snap icon to end in \".svg\".');\n\n  assert(\n    Buffer.byteLength(icon.value, 'utf8') <= SVG_MAX_BYTE_SIZE,\n    `The specified SVG icon exceeds the maximum size of ${SVG_MAX_BYTE_SIZE_TEXT}.`,\n  );\n\n  assert(isSvg(icon.toString()), 'Snap icon must be a valid SVG.');\n}\n\n/**\n * Extract the dimensions of an image from an SVG string if possible.\n *\n * @param svg - An SVG string.\n * @returns The height and width of the SVG or null.\n */\nexport function getSvgDimensions(svg: string): {\n  height: number;\n  width: number;\n} | null {\n  try {\n    const parsed = parseSvg(svg);\n\n    const height = parsed['@_height'];\n    const width = parsed['@_width'];\n\n    if (height && width) {\n      return { height, width };\n    }\n\n    const viewBox = parsed['@_viewBox'];\n    if (viewBox) {\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n      const [_minX, _minY, viewBoxWidth, viewBoxHeight] = viewBox.split(' ');\n\n      if (viewBoxWidth && viewBoxHeight) {\n        const parsedWidth = parseInt(viewBoxWidth, 10);\n        const parsedHeight = parseInt(viewBoxHeight, 10);\n\n        assert(Number.isInteger(parsedWidth) && parsedWidth > 0);\n        assert(Number.isInteger(parsedHeight) && parsedHeight > 0);\n\n        return {\n          width: parsedWidth,\n          height: parsedHeight,\n        };\n      }\n    }\n  } catch {\n    throw new Error('Snap icon must be a valid SVG.');\n  }\n\n  return null;\n}\n"],"names":["isSvg","parseSvg","assert","SVG_MAX_BYTE_SIZE","SVG_MAX_BYTE_SIZE_TEXT","Math","floor","assertIsSnapIcon","icon","path","endsWith","Buffer","byteLength","value","toString","getSvgDimensions","svg","parsed","height","width","viewBox","_minX","_minY","viewBoxWidth","viewBoxHeight","split","parsedWidth","parseInt","parsedHeight","Number","isInteger","Error"],"mappings":"AAAA,SAASA,KAAK,EAAEC,QAAQ,QAAQ,sBAAsB;AACtD,SAASC,MAAM,QAAQ,kBAAkB;AAIzC,OAAO,MAAMC,oBAAoB,OAAQ;AACzC,OAAO,MAAMC,yBAAyB,CAAC,EAAEC,KAAKC,KAAK,CACjDH,oBAAoB,MACpB,EAAE,CAAC,CAAC;AAEN;;;;CAIC,GACD,OAAO,SAASI,iBAAiBC,IAAiB;IAChDN,OAAOM,KAAKC,IAAI,CAACC,QAAQ,CAAC,SAAS;IAEnCR,OACES,OAAOC,UAAU,CAACJ,KAAKK,KAAK,EAAE,WAAWV,mBACzC,CAAC,mDAAmD,EAAEC,uBAAuB,CAAC,CAAC;IAGjFF,OAAOF,MAAMQ,KAAKM,QAAQ,KAAK;AACjC;AAEA;;;;;CAKC,GACD,OAAO,SAASC,iBAAiBC,GAAW;IAI1C,IAAI;QACF,MAAMC,SAAShB,SAASe;QAExB,MAAME,SAASD,MAAM,CAAC,WAAW;QACjC,MAAME,QAAQF,MAAM,CAAC,UAAU;QAE/B,IAAIC,UAAUC,OAAO;YACnB,OAAO;gBAAED;gBAAQC;YAAM;QACzB;QAEA,MAAMC,UAAUH,MAAM,CAAC,YAAY;QACnC,IAAIG,SAAS;YACX,6DAA6D;YAC7D,MAAM,CAACC,OAAOC,OAAOC,cAAcC,cAAc,GAAGJ,QAAQK,KAAK,CAAC;YAElE,IAAIF,gBAAgBC,eAAe;gBACjC,MAAME,cAAcC,SAASJ,cAAc;gBAC3C,MAAMK,eAAeD,SAASH,eAAe;gBAE7CtB,OAAO2B,OAAOC,SAAS,CAACJ,gBAAgBA,cAAc;gBACtDxB,OAAO2B,OAAOC,SAAS,CAACF,iBAAiBA,eAAe;gBAExD,OAAO;oBACLT,OAAOO;oBACPR,QAAQU;gBACV;YACF;QACF;IACF,EAAE,OAAM;QACN,MAAM,IAAIG,MAAM;IAClB;IAEA,OAAO;AACT"}

package/dist/esm/manifest/manifest.js

@@ -5,6 +5,7 @@ import { promises as fs } from 'fs';
 import pathUtils from 'path';
 import { deepClone } from '../deep-clone';
 import { readJsonFile } from '../fs';
+import { getSvgDimensions } from '../icon';
 import { validateNpmSnap } from '../npm';
 import { getSnapChecksum, ProgrammaticallyFixableSnapError, validateSnapShasum } from '../snaps';
 import { NpmSnapFileNames, SnapValidationFailureReason } from '../types';
@@ -103,6 +104,13 @@ const MANIFEST_SORT_ORDER = {
             return `${allMissing}\t${currentField}\n`;
         }, '')}`);
     }
+    if (!snapFiles.svgIcon) {
+        warnings.push('No icon found in the Snap manifest. It is recommended to include an icon for the Snap. See https://docs.metamask.io/snaps/how-to/design-a-snap/#guidelines-at-a-glance for more information.');
+    }
+    const iconDimensions = snapFiles.svgIcon && getSvgDimensions(snapFiles.svgIcon.toString());
+    if (iconDimensions && iconDimensions.height !== iconDimensions.width) {
+        warnings.push('The icon in the Snap manifest is not square. It is recommended to use a square icon for the Snap.');
+    }
     if (writeManifest) {
         try {
             const newManifest = `${JSON.stringify(getWritableManifest(validatedManifest), null, 2)}\n`;

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/manifest/manifest.ts"],"sourcesContent":["import { getErrorMessage } from '@metamask/snaps-sdk';\nimport type { Json } from '@metamask/utils';\nimport { assertExhaustive, assert, isPlainObject } from '@metamask/utils';\nimport deepEqual from 'fast-deep-equal';\nimport { promises as fs } from 'fs';\nimport pathUtils from 'path';\n\nimport { deepClone } from '../deep-clone';\nimport { readJsonFile } from '../fs';\nimport { validateNpmSnap } from '../npm';\nimport {\n  getSnapChecksum,\n  ProgrammaticallyFixableSnapError,\n  validateSnapShasum,\n} from '../snaps';\nimport type { SnapFiles, UnvalidatedSnapFiles } from '../types';\nimport { NpmSnapFileNames, SnapValidationFailureReason } from '../types';\nimport { readVirtualFile, VirtualFile } from '../virtual-file';\nimport type { SnapManifest } from './validation';\n\nconst MANIFEST_SORT_ORDER: Record<keyof SnapManifest, number> = {\n  $schema: 1,\n  version: 2,\n  description: 3,\n  proposedName: 4,\n  repository: 5,\n  source: 6,\n  initialConnections: 7,\n  initialPermissions: 8,\n  manifestVersion: 9,\n};\n\n/**\n * The result from the `checkManifest` function.\n *\n * @property manifest - The fixed manifest object.\n * @property updated - Whether the manifest was updated.\n * @property warnings - An array of warnings that were encountered during\n * processing of the manifest files. These warnings are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n * @property errors - An array of errors that were encountered during\n * processing of the manifest files. These errors are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n */\nexport type CheckManifestResult = {\n  manifest: SnapManifest;\n  updated?: boolean;\n  warnings: string[];\n  errors: string[];\n};\n\nexport type WriteFileFunction = (path: string, data: string) => Promise<void>;\n\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param writeManifest - Whether to write the fixed manifest to disk.\n * @param sourceCode - The source code of the Snap.\n * @param writeFileFn - The function to use to write the manifest to disk.\n * @returns Whether the manifest was updated, and an array of warnings that\n * were encountered during processing of the manifest files.\n */\nexport async function checkManifest(\n  basePath: string,\n  writeManifest = true,\n  sourceCode?: string,\n  writeFileFn: WriteFileFunction = fs.writeFile,\n): Promise<CheckManifestResult> {\n  const warnings: string[] = [];\n  const errors: string[] = [];\n\n  let updated = false;\n\n  const manifestPath = pathUtils.join(basePath, NpmSnapFileNames.Manifest);\n  const manifestFile = await readJsonFile(manifestPath);\n  const unvalidatedManifest = manifestFile.result;\n\n  const packageFile = await readJsonFile(\n    pathUtils.join(basePath, NpmSnapFileNames.PackageJson),\n  );\n\n  const auxiliaryFilePaths = getSnapFilePaths(\n    unvalidatedManifest,\n    (manifest) => manifest?.source?.files,\n  );\n\n  const localizationFilePaths = getSnapFilePaths(\n    unvalidatedManifest,\n    (manifest) => manifest?.source?.locales,\n  );\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: manifestFile,\n    packageJson: packageFile,\n    sourceCode: await getSnapSourceCode(\n      basePath,\n      unvalidatedManifest,\n      sourceCode,\n    ),\n    svgIcon: await getSnapIcon(basePath, unvalidatedManifest),\n    // Intentionally pass null as the encoding here since the files may be binary\n    auxiliaryFiles:\n      (await getSnapFiles(basePath, auxiliaryFilePaths, null)) ?? [],\n    localizationFiles:\n      (await getSnapFiles(basePath, localizationFilePaths)) ?? [],\n  };\n\n  let manifest: VirtualFile<SnapManifest> | undefined;\n  try {\n    ({ manifest } = await validateNpmSnap(snapFiles));\n  } catch (error) {\n    if (error instanceof ProgrammaticallyFixableSnapError) {\n      errors.push(error.message);\n\n      // If we get here, the files at least have the correct shape.\n      const partiallyValidatedFiles = snapFiles as SnapFiles;\n\n      let isInvalid = true;\n      let currentError = error;\n      const maxAttempts = Object.keys(SnapValidationFailureReason).length;\n\n      // Attempt to fix all fixable validation failure reasons. All such reasons\n      // are enumerated by the `SnapValidationFailureReason` enum, so we only\n      // attempt to fix the manifest the same amount of times as there are\n      // reasons in the enum.\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = await fixManifest(\n          manifest\n            ? { ...partiallyValidatedFiles, manifest }\n            : partiallyValidatedFiles,\n          currentError,\n        );\n\n        try {\n          await validateNpmSnapManifest({\n            ...partiallyValidatedFiles,\n            manifest,\n          });\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          currentError = nextValidationError;\n          /* istanbul ignore next: this should be impossible */\n          if (\n            !(\n              nextValidationError instanceof ProgrammaticallyFixableSnapError\n            ) ||\n            (attempts === maxAttempts && !isInvalid)\n          ) {\n            throw new Error(\n              `Internal error: Failed to fix manifest. This is a bug, please report it. Reason:\\n${error.message}`,\n            );\n          }\n\n          errors.push(currentError.message);\n        }\n      }\n\n      updated = true;\n    } else {\n      throw error;\n    }\n  }\n\n  // TypeScript assumes `manifest` can still be undefined, that is not the case.\n  // But we assert to keep TypeScript happy.\n  assert(manifest);\n\n  const validatedManifest = manifest.result;\n\n  // Check presence of recommended keys\n  const recommendedFields = ['repository'] as const;\n\n  const missingRecommendedFields = recommendedFields.filter(\n    (key) => !validatedManifest[key],\n  );\n\n  if (missingRecommendedFields.length > 0) {\n    warnings.push(\n      `Missing recommended package.json properties:\\n${missingRecommendedFields.reduce(\n        (allMissing, currentField) => {\n          return `${allMissing}\\t${currentField}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  if (writeManifest) {\n    try {\n      const newManifest = `${JSON.stringify(\n        getWritableManifest(validatedManifest),\n        null,\n        2,\n      )}\\n`;\n\n      if (updated || newManifest !== manifestFile.value) {\n        await writeFileFn(\n          pathUtils.join(basePath, NpmSnapFileNames.Manifest),\n          newManifest,\n        );\n      }\n    } catch (error) {\n      // Note: This error isn't pushed to the errors array, because it's not an\n      // error in the manifest itself.\n      throw new Error(`Failed to update snap.manifest.json: ${error.message}`);\n    }\n  }\n\n  return { manifest: validatedManifest, updated, warnings, errors };\n}\n\n/**\n * Given the relevant Snap files (manifest, `package.json`, and bundle) and a\n * Snap manifest validation error, fixes the fault in the manifest that caused\n * the error.\n *\n * @param snapFiles - The contents of all Snap files.\n * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.\n * @returns A copy of the manifest file where the cause of the error is fixed.\n */\nexport async function fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): Promise<VirtualFile<SnapManifest>> {\n  const { manifest, packageJson } = snapFiles;\n  const clonedFile = manifest.clone();\n  const manifestCopy = clonedFile.result;\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.result.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.result.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.result.repository\n        ? deepClone(packageJson.result.repository)\n        : undefined;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = await getSnapChecksum(snapFiles);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      assertExhaustive(error.reason);\n  }\n\n  clonedFile.result = manifestCopy;\n  clonedFile.value = JSON.stringify(manifestCopy);\n  return clonedFile;\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * bundle source file location and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @param sourceCode - Override source code for plugins.\n * @returns The contents of the bundle file, if any.\n */\nexport async function getSnapSourceCode(\n  basePath: string,\n  manifest: Json,\n  sourceCode?: string,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n    ?.npm?.filePath;\n\n  if (!sourceFilePath) {\n    return undefined;\n  }\n\n  if (sourceCode) {\n    return new VirtualFile({\n      path: pathUtils.join(basePath, sourceFilePath),\n      value: sourceCode,\n    });\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, sourceFilePath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(\n      `Failed to read snap bundle file: ${getErrorMessage(error)}`,\n    );\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * icon and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the icon, if any.\n */\nexport async function getSnapIcon(\n  basePath: string,\n  manifest: Json,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const iconPath = (manifest as Partial<SnapManifest>).source?.location?.npm\n    ?.iconPath;\n\n  if (!iconPath) {\n    return undefined;\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, iconPath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read snap icon file: ${getErrorMessage(error)}`);\n  }\n}\n\n/**\n * Get an array of paths from an unvalidated Snap manifest.\n *\n * @param manifest - The unvalidated Snap manifest file contents.\n * @param selector - A function that returns the paths to the files.\n * @returns The paths to the files, if any.\n */\nexport function getSnapFilePaths(\n  manifest: Json,\n  selector: (manifest: Partial<SnapManifest>) => string[] | undefined,\n) {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const snapManifest = manifest as Partial<SnapManifest>;\n  const paths = selector(snapManifest);\n\n  if (!Array.isArray(paths)) {\n    return undefined;\n  }\n\n  return paths;\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the files with the\n * given paths and read them.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param paths - The paths to the files.\n * @param encoding - An optional encoding to pass down to readVirtualFile.\n * @returns A list of auxiliary files and their contents, if any.\n */\nexport async function getSnapFiles(\n  basePath: string,\n  paths: string[] | undefined,\n  encoding: BufferEncoding | null = 'utf8',\n): Promise<VirtualFile[] | undefined> {\n  if (!paths) {\n    return undefined;\n  }\n\n  try {\n    return await Promise.all(\n      paths.map(async (filePath) =>\n        readVirtualFile(pathUtils.join(basePath, filePath), encoding),\n      ),\n    );\n  } catch (error) {\n    throw new Error(`Failed to read snap files: ${getErrorMessage(error)}`);\n  }\n}\n\n/**\n * Sorts the given manifest in our preferred sort order and removes the\n * `repository` field if it is falsy (it may be `null`).\n *\n * @param manifest - The manifest to sort and modify.\n * @returns The disk-ready manifest.\n */\nexport function getWritableManifest(manifest: SnapManifest): SnapManifest {\n  const { repository, ...remaining } = manifest;\n\n  const keys = Object.keys(\n    repository ? { ...remaining, repository } : remaining,\n  ) as (keyof SnapManifest)[];\n\n  const writableManifest = keys\n    .sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b])\n    .reduce<Partial<SnapManifest>>(\n      (result, key) => ({\n        ...result,\n        [key]: manifest[key],\n      }),\n      {},\n    );\n\n  return writableManifest as SnapManifest;\n}\n\n/**\n * Validates the fields of an NPM Snap manifest that has already passed JSON\n * Schema validation.\n *\n * @param snapFiles - The relevant snap files to validate.\n * @param snapFiles.manifest - The npm Snap manifest to validate.\n * @param snapFiles.packageJson - The npm Snap's `package.json`.\n * @param snapFiles.sourceCode - The Snap's source code.\n * @param snapFiles.svgIcon - The Snap's optional icon.\n * @param snapFiles.auxiliaryFiles - Any auxiliary files required by the snap at runtime.\n * @param snapFiles.localizationFiles - The Snap's localization files.\n */\nexport async function validateNpmSnapManifest({\n  manifest,\n  packageJson,\n  sourceCode,\n  svgIcon,\n  auxiliaryFiles,\n  localizationFiles,\n}: SnapFiles) {\n  const packageJsonName = packageJson.result.name;\n  const packageJsonVersion = packageJson.result.version;\n  const packageJsonRepository = packageJson.result.repository;\n\n  const manifestPackageName = manifest.result.source.location.npm.packageName;\n  const manifestPackageVersion = manifest.result.version;\n  const manifestRepository = manifest.result.repository;\n\n  if (packageJsonName !== manifestPackageName) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package name (\"${manifestPackageName}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"name\" field (\"${packageJsonName}\").`,\n      SnapValidationFailureReason.NameMismatch,\n    );\n  }\n\n  if (packageJsonVersion !== manifestPackageVersion) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package version (\"${manifestPackageVersion}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"version\" field (\"${packageJsonVersion}\").`,\n      SnapValidationFailureReason.VersionMismatch,\n    );\n  }\n\n  if (\n    // The repository may be `undefined` in package.json but can only be defined\n    // or `null` in the Snap manifest due to TS@<4.4 issues.\n    (packageJsonRepository || manifestRepository) &&\n    !deepEqual(packageJsonRepository, manifestRepository)\n  ) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" \"repository\" field does not match the \"${NpmSnapFileNames.PackageJson}\" \"repository\" field.`,\n      SnapValidationFailureReason.RepositoryMismatch,\n    );\n  }\n\n  await validateSnapShasum(\n    { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles },\n    `\"${NpmSnapFileNames.Manifest}\" \"shasum\" field does not match computed shasum.`,\n  );\n}\n"],"names":["getErrorMessage","assertExhaustive","assert","isPlainObject","deepEqual","promises","fs","pathUtils","deepClone","readJsonFile","validateNpmSnap","getSnapChecksum","ProgrammaticallyFixableSnapError","validateSnapShasum","NpmSnapFileNames","SnapValidationFailureReason","readVirtualFile","VirtualFile","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialConnections","initialPermissions","manifestVersion","checkManifest","basePath","writeManifest","sourceCode","writeFileFn","writeFile","warnings","errors","updated","manifestPath","join","Manifest","manifestFile","unvalidatedManifest","result","packageFile","PackageJson","auxiliaryFilePaths","getSnapFilePaths","manifest","files","localizationFilePaths","locales","snapFiles","packageJson","getSnapSourceCode","svgIcon","getSnapIcon","auxiliaryFiles","getSnapFiles","localizationFiles","error","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","length","attempts","fixManifest","validateNpmSnapManifest","nextValidationError","Error","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","newManifest","JSON","stringify","getWritableManifest","value","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","undefined","ShasumMismatch","shasum","sourceFilePath","filePath","path","virtualFile","iconPath","selector","snapManifest","paths","Array","isArray","encoding","Promise","all","map","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository"],"mappings":"AAAA,SAASA,eAAe,QAAQ,sBAAsB;AAEtD,SAASC,gBAAgB,EAAEC,MAAM,EAAEC,aAAa,QAAQ,kBAAkB;AAC1E,OAAOC,eAAe,kBAAkB;AACxC,SAASC,YAAYC,EAAE,QAAQ,KAAK;AACpC,OAAOC,eAAe,OAAO;AAE7B,SAASC,SAAS,QAAQ,gBAAgB;AAC1C,SAASC,YAAY,QAAQ,QAAQ;AACrC,SAASC,eAAe,QAAQ,SAAS;AACzC,SACEC,eAAe,EACfC,gCAAgC,EAChCC,kBAAkB,QACb,WAAW;AAElB,SAASC,gBAAgB,EAAEC,2BAA2B,QAAQ,WAAW;AACzE,SAASC,eAAe,EAAEC,WAAW,QAAQ,kBAAkB;AAG/D,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,oBAAoB;IACpBC,iBAAiB;AACnB;AAyBA;;;;;;;;;;;CAWC,GACD,OAAO,eAAeC,cACpBC,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB,EACnBC,cAAiC1B,GAAG2B,SAAS;IAE7C,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAe9B,UAAU+B,IAAI,CAACT,UAAUf,iBAAiByB,QAAQ;IACvE,MAAMC,eAAe,MAAM/B,aAAa4B;IACxC,MAAMI,sBAAsBD,aAAaE,MAAM;IAE/C,MAAMC,cAAc,MAAMlC,aACxBF,UAAU+B,IAAI,CAACT,UAAUf,iBAAiB8B,WAAW;IAGvD,MAAMC,qBAAqBC,iBACzBL,qBACA,CAACM,WAAaA,UAAUvB,QAAQwB;IAGlC,MAAMC,wBAAwBH,iBAC5BL,qBACA,CAACM,WAAaA,UAAUvB,QAAQ0B;IAGlC,MAAMC,YAAkC;QACtCJ,UAAUP;QACVY,aAAaT;QACbZ,YAAY,MAAMsB,kBAChBxB,UACAY,qBACAV;QAEFuB,SAAS,MAAMC,YAAY1B,UAAUY;QACrC,6EAA6E;QAC7Ee,gBACE,AAAC,MAAMC,aAAa5B,UAAUgB,oBAAoB,SAAU,EAAE;QAChEa,mBACE,AAAC,MAAMD,aAAa5B,UAAUoB,0BAA2B,EAAE;IAC/D;IAEA,IAAIF;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAG,MAAMrC,gBAAgByC,UAAS;IACjD,EAAE,OAAOQ,OAAO;QACd,IAAIA,iBAAiB/C,kCAAkC;YACrDuB,OAAOyB,IAAI,CAACD,MAAME,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BX;YAEhC,IAAIY,YAAY;YAChB,IAAIC,eAAeL;YACnB,MAAMM,cAAcC,OAAOC,IAAI,CAACpD,6BAA6BqD,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGN,aAAaM,YAAYJ,aAAaI,WAAY;gBACvEtB,WAAW,MAAMuB,YACfvB,WACI;oBAAE,GAAGe,uBAAuB;oBAAEf;gBAAS,IACvCe,yBACJE;gBAGF,IAAI;oBACF,MAAMO,wBAAwB;wBAC5B,GAAGT,uBAAuB;wBAC1Bf;oBACF;oBAEAgB,YAAY;gBACd,EAAE,OAAOS,qBAAqB;oBAC5BR,eAAeQ;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+B5D,gCAA+B,KAE/DyD,aAAaJ,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIU,MACR,CAAC,kFAAkF,EAAEd,MAAME,OAAO,CAAC,CAAC;oBAExG;oBAEA1B,OAAOyB,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEAzB,UAAU;QACZ,OAAO;YACL,MAAMuB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1CzD,OAAO6C;IAEP,MAAM2B,oBAAoB3B,SAASL,MAAM;IAEzC,qCAAqC;IACrC,MAAMiC,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBR,MAAM,GAAG,GAAG;QACvClC,SAAS0B,IAAI,CACX,CAAC,8CAA8C,EAAEgB,yBAAyBG,MAAM,CAC9E,CAACC,YAAYC;YACX,OAAO,CAAC,EAAED,WAAW,EAAE,EAAEC,aAAa,EAAE,CAAC;QAC3C,GACA,IACA,CAAC;IAEP;IAEA,IAAInD,eAAe;QACjB,IAAI;YACF,MAAMoD,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnCC,oBAAoBX,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAItC,WAAW8C,gBAAgB1C,aAAa8C,KAAK,EAAE;gBACjD,MAAMtD,YACJzB,UAAU+B,IAAI,CAACT,UAAUf,iBAAiByB,QAAQ,GAClD2C;YAEJ;QACF,EAAE,OAAOvB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAME,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEd,UAAU2B;QAAmBtC;QAASF;QAAUC;IAAO;AAClE;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAemC,YACpBnB,SAAoB,EACpBQ,KAAuC;IAEvC,MAAM,EAAEZ,QAAQ,EAAEK,WAAW,EAAE,GAAGD;IAClC,MAAMoC,aAAaxC,SAASyC,KAAK;IACjC,MAAMC,eAAeF,WAAW7C,MAAM;IAEtC,OAAQiB,MAAM+B,MAAM;QAClB,KAAK3E,4BAA4B4E,YAAY;YAC3CF,aAAajE,MAAM,CAACoE,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAG1C,YAAYV,MAAM,CAACqD,IAAI;YACtE;QAEF,KAAKhF,4BAA4BiF,eAAe;YAC9CP,aAAarE,OAAO,GAAGgC,YAAYV,MAAM,CAACtB,OAAO;YACjD;QAEF,KAAKL,4BAA4BkF,kBAAkB;YACjDR,aAAalE,UAAU,GAAG6B,YAAYV,MAAM,CAACnB,UAAU,GACnDf,UAAU4C,YAAYV,MAAM,CAACnB,UAAU,IACvC2E;YACJ;QAEF,KAAKnF,4BAA4BoF,cAAc;YAC7CV,aAAajE,MAAM,CAAC4E,MAAM,GAAG,MAAMzF,gBAAgBwC;YACnD;QAEF,wBAAwB,GACxB;YACElD,iBAAiB0D,MAAM+B,MAAM;IACjC;IAEAH,WAAW7C,MAAM,GAAG+C;IACpBF,WAAWD,KAAK,GAAGH,KAAKC,SAAS,CAACK;IAClC,OAAOF;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAelC,kBACpBxB,QAAgB,EAChBkB,QAAc,EACdhB,UAAmB;IAEnB,IAAI,CAAC5B,cAAc4C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMG,iBAAiB,AAACtD,SAAmCvB,MAAM,EAAEoE,UAC/DC,KAAKS;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAOH;IACT;IAEA,IAAInE,YAAY;QACd,OAAO,IAAId,YAAY;YACrBsF,MAAMhG,UAAU+B,IAAI,CAACT,UAAUwE;YAC/Bf,OAAOvD;QACT;IACF;IAEA,IAAI;QACF,MAAMyE,cAAc,MAAMxF,gBACxBT,UAAU+B,IAAI,CAACT,UAAUwE,iBACzB;QAEF,OAAOG;IACT,EAAE,OAAO7C,OAAO;QACd,MAAM,IAAIc,MACR,CAAC,iCAAiC,EAAEzE,gBAAgB2D,OAAO,CAAC;IAEhE;AACF;AAEA;;;;;;;CAOC,GACD,OAAO,eAAeJ,YACpB1B,QAAgB,EAChBkB,QAAc;IAEd,IAAI,CAAC5C,cAAc4C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMO,WAAW,AAAC1D,SAAmCvB,MAAM,EAAEoE,UAAUC,KACnEY;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOP;IACT;IAEA,IAAI;QACF,MAAMM,cAAc,MAAMxF,gBACxBT,UAAU+B,IAAI,CAACT,UAAU4E,WACzB;QAEF,OAAOD;IACT,EAAE,OAAO7C,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAEzE,gBAAgB2D,OAAO,CAAC;IAC5E;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASb,iBACdC,QAAc,EACd2D,QAAmE;IAEnE,IAAI,CAACvG,cAAc4C,WAAW;QAC5B,OAAOmD;IACT;IAEA,MAAMS,eAAe5D;IACrB,MAAM6D,QAAQF,SAASC;IAEvB,IAAI,CAACE,MAAMC,OAAO,CAACF,QAAQ;QACzB,OAAOV;IACT;IAEA,OAAOU;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAenD,aACpB5B,QAAgB,EAChB+E,KAA2B,EAC3BG,WAAkC,MAAM;IAExC,IAAI,CAACH,OAAO;QACV,OAAOV;IACT;IAEA,IAAI;QACF,OAAO,MAAMc,QAAQC,GAAG,CACtBL,MAAMM,GAAG,CAAC,OAAOZ,WACftF,gBAAgBT,UAAU+B,IAAI,CAACT,UAAUyE,WAAWS;IAG1D,EAAE,OAAOpD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,2BAA2B,EAAEzE,gBAAgB2D,OAAO,CAAC;IACxE;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAAS0B,oBAAoBtC,QAAsB;IACxD,MAAM,EAAExB,UAAU,EAAE,GAAG4F,WAAW,GAAGpE;IAErC,MAAMoB,OAAOD,OAAOC,IAAI,CACtB5C,aAAa;QAAE,GAAG4F,SAAS;QAAE5F;IAAW,IAAI4F;IAG9C,MAAMC,mBAAmBjD,KACtBkD,IAAI,CAAC,CAACC,GAAGC,IAAMrG,mBAAmB,CAACoG,EAAE,GAAGpG,mBAAmB,CAACqG,EAAE,EAC9DxC,MAAM,CACL,CAACrC,QAAQoC,MAAS,CAAA;YAChB,GAAGpC,MAAM;YACT,CAACoC,IAAI,EAAE/B,QAAQ,CAAC+B,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAOsC;AACT;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,eAAe7C,wBAAwB,EAC5CxB,QAAQ,EACRK,WAAW,EACXrB,UAAU,EACVuB,OAAO,EACPE,cAAc,EACdE,iBAAiB,EACP;IACV,MAAM8D,kBAAkBpE,YAAYV,MAAM,CAACqD,IAAI;IAC/C,MAAM0B,qBAAqBrE,YAAYV,MAAM,CAACtB,OAAO;IACrD,MAAMsG,wBAAwBtE,YAAYV,MAAM,CAACnB,UAAU;IAE3D,MAAMoG,sBAAsB5E,SAASL,MAAM,CAAClB,MAAM,CAACoE,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAM8B,yBAAyB7E,SAASL,MAAM,CAACtB,OAAO;IACtD,MAAMyG,qBAAqB9E,SAASL,MAAM,CAACnB,UAAU;IAErD,IAAIiG,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAI/G,iCACR,CAAC,CAAC,EAAEE,iBAAiByB,QAAQ,CAAC,qBAAqB,EAAEoF,oBAAoB,uBAAuB,EAAE7G,iBAAiB8B,WAAW,CAAC,iBAAiB,EAAE4E,gBAAgB,GAAG,CAAC,EACtKzG,4BAA4B4E,YAAY;IAE5C;IAEA,IAAI8B,uBAAuBG,wBAAwB;QACjD,MAAM,IAAIhH,iCACR,CAAC,CAAC,EAAEE,iBAAiByB,QAAQ,CAAC,wBAAwB,EAAEqF,uBAAuB,uBAAuB,EAAE9G,iBAAiB8B,WAAW,CAAC,oBAAoB,EAAE6E,mBAAmB,GAAG,CAAC,EAClL1G,4BAA4BiF,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvD0B,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACzH,UAAUsH,uBAAuBG,qBAClC;QACA,MAAM,IAAIjH,iCACR,CAAC,CAAC,EAAEE,iBAAiByB,QAAQ,CAAC,yCAAyC,EAAEzB,iBAAiB8B,WAAW,CAAC,qBAAqB,CAAC,EAC5H7B,4BAA4BkF,kBAAkB;IAElD;IAEA,MAAMpF,mBACJ;QAAEkC;QAAUhB;QAAYuB;QAASE;QAAgBE;IAAkB,GACnE,CAAC,CAAC,EAAE5C,iBAAiByB,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}
+{"version":3,"sources":["../../../src/manifest/manifest.ts"],"sourcesContent":["import { getErrorMessage } from '@metamask/snaps-sdk';\nimport type { Json } from '@metamask/utils';\nimport { assertExhaustive, assert, isPlainObject } from '@metamask/utils';\nimport deepEqual from 'fast-deep-equal';\nimport { promises as fs } from 'fs';\nimport pathUtils from 'path';\n\nimport { deepClone } from '../deep-clone';\nimport { readJsonFile } from '../fs';\nimport { getSvgDimensions } from '../icon';\nimport { validateNpmSnap } from '../npm';\nimport {\n  getSnapChecksum,\n  ProgrammaticallyFixableSnapError,\n  validateSnapShasum,\n} from '../snaps';\nimport type { SnapFiles, UnvalidatedSnapFiles } from '../types';\nimport { NpmSnapFileNames, SnapValidationFailureReason } from '../types';\nimport { readVirtualFile, VirtualFile } from '../virtual-file';\nimport type { SnapManifest } from './validation';\n\nconst MANIFEST_SORT_ORDER: Record<keyof SnapManifest, number> = {\n  $schema: 1,\n  version: 2,\n  description: 3,\n  proposedName: 4,\n  repository: 5,\n  source: 6,\n  initialConnections: 7,\n  initialPermissions: 8,\n  manifestVersion: 9,\n};\n\n/**\n * The result from the `checkManifest` function.\n *\n * @property manifest - The fixed manifest object.\n * @property updated - Whether the manifest was updated.\n * @property warnings - An array of warnings that were encountered during\n * processing of the manifest files. These warnings are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n * @property errors - An array of errors that were encountered during\n * processing of the manifest files. These errors are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n */\nexport type CheckManifestResult = {\n  manifest: SnapManifest;\n  updated?: boolean;\n  warnings: string[];\n  errors: string[];\n};\n\nexport type WriteFileFunction = (path: string, data: string) => Promise<void>;\n\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param writeManifest - Whether to write the fixed manifest to disk.\n * @param sourceCode - The source code of the Snap.\n * @param writeFileFn - The function to use to write the manifest to disk.\n * @returns Whether the manifest was updated, and an array of warnings that\n * were encountered during processing of the manifest files.\n */\nexport async function checkManifest(\n  basePath: string,\n  writeManifest = true,\n  sourceCode?: string,\n  writeFileFn: WriteFileFunction = fs.writeFile,\n): Promise<CheckManifestResult> {\n  const warnings: string[] = [];\n  const errors: string[] = [];\n\n  let updated = false;\n\n  const manifestPath = pathUtils.join(basePath, NpmSnapFileNames.Manifest);\n  const manifestFile = await readJsonFile(manifestPath);\n  const unvalidatedManifest = manifestFile.result;\n\n  const packageFile = await readJsonFile(\n    pathUtils.join(basePath, NpmSnapFileNames.PackageJson),\n  );\n\n  const auxiliaryFilePaths = getSnapFilePaths(\n    unvalidatedManifest,\n    (manifest) => manifest?.source?.files,\n  );\n\n  const localizationFilePaths = getSnapFilePaths(\n    unvalidatedManifest,\n    (manifest) => manifest?.source?.locales,\n  );\n\n  const snapFiles: UnvalidatedSnapFiles = {\n    manifest: manifestFile,\n    packageJson: packageFile,\n    sourceCode: await getSnapSourceCode(\n      basePath,\n      unvalidatedManifest,\n      sourceCode,\n    ),\n    svgIcon: await getSnapIcon(basePath, unvalidatedManifest),\n    // Intentionally pass null as the encoding here since the files may be binary\n    auxiliaryFiles:\n      (await getSnapFiles(basePath, auxiliaryFilePaths, null)) ?? [],\n    localizationFiles:\n      (await getSnapFiles(basePath, localizationFilePaths)) ?? [],\n  };\n\n  let manifest: VirtualFile<SnapManifest> | undefined;\n  try {\n    ({ manifest } = await validateNpmSnap(snapFiles));\n  } catch (error) {\n    if (error instanceof ProgrammaticallyFixableSnapError) {\n      errors.push(error.message);\n\n      // If we get here, the files at least have the correct shape.\n      const partiallyValidatedFiles = snapFiles as SnapFiles;\n\n      let isInvalid = true;\n      let currentError = error;\n      const maxAttempts = Object.keys(SnapValidationFailureReason).length;\n\n      // Attempt to fix all fixable validation failure reasons. All such reasons\n      // are enumerated by the `SnapValidationFailureReason` enum, so we only\n      // attempt to fix the manifest the same amount of times as there are\n      // reasons in the enum.\n      for (let attempts = 1; isInvalid && attempts <= maxAttempts; attempts++) {\n        manifest = await fixManifest(\n          manifest\n            ? { ...partiallyValidatedFiles, manifest }\n            : partiallyValidatedFiles,\n          currentError,\n        );\n\n        try {\n          await validateNpmSnapManifest({\n            ...partiallyValidatedFiles,\n            manifest,\n          });\n\n          isInvalid = false;\n        } catch (nextValidationError) {\n          currentError = nextValidationError;\n          /* istanbul ignore next: this should be impossible */\n          if (\n            !(\n              nextValidationError instanceof ProgrammaticallyFixableSnapError\n            ) ||\n            (attempts === maxAttempts && !isInvalid)\n          ) {\n            throw new Error(\n              `Internal error: Failed to fix manifest. This is a bug, please report it. Reason:\\n${error.message}`,\n            );\n          }\n\n          errors.push(currentError.message);\n        }\n      }\n\n      updated = true;\n    } else {\n      throw error;\n    }\n  }\n\n  // TypeScript assumes `manifest` can still be undefined, that is not the case.\n  // But we assert to keep TypeScript happy.\n  assert(manifest);\n\n  const validatedManifest = manifest.result;\n\n  // Check presence of recommended keys\n  const recommendedFields = ['repository'] as const;\n\n  const missingRecommendedFields = recommendedFields.filter(\n    (key) => !validatedManifest[key],\n  );\n\n  if (missingRecommendedFields.length > 0) {\n    warnings.push(\n      `Missing recommended package.json properties:\\n${missingRecommendedFields.reduce(\n        (allMissing, currentField) => {\n          return `${allMissing}\\t${currentField}\\n`;\n        },\n        '',\n      )}`,\n    );\n  }\n\n  if (!snapFiles.svgIcon) {\n    warnings.push(\n      'No icon found in the Snap manifest. It is recommended to include an icon for the Snap. See https://docs.metamask.io/snaps/how-to/design-a-snap/#guidelines-at-a-glance for more information.',\n    );\n  }\n\n  const iconDimensions =\n    snapFiles.svgIcon && getSvgDimensions(snapFiles.svgIcon.toString());\n  if (iconDimensions && iconDimensions.height !== iconDimensions.width) {\n    warnings.push(\n      'The icon in the Snap manifest is not square. It is recommended to use a square icon for the Snap.',\n    );\n  }\n\n  if (writeManifest) {\n    try {\n      const newManifest = `${JSON.stringify(\n        getWritableManifest(validatedManifest),\n        null,\n        2,\n      )}\\n`;\n\n      if (updated || newManifest !== manifestFile.value) {\n        await writeFileFn(\n          pathUtils.join(basePath, NpmSnapFileNames.Manifest),\n          newManifest,\n        );\n      }\n    } catch (error) {\n      // Note: This error isn't pushed to the errors array, because it's not an\n      // error in the manifest itself.\n      throw new Error(`Failed to update snap.manifest.json: ${error.message}`);\n    }\n  }\n\n  return { manifest: validatedManifest, updated, warnings, errors };\n}\n\n/**\n * Given the relevant Snap files (manifest, `package.json`, and bundle) and a\n * Snap manifest validation error, fixes the fault in the manifest that caused\n * the error.\n *\n * @param snapFiles - The contents of all Snap files.\n * @param error - The {@link ProgrammaticallyFixableSnapError} that was thrown.\n * @returns A copy of the manifest file where the cause of the error is fixed.\n */\nexport async function fixManifest(\n  snapFiles: SnapFiles,\n  error: ProgrammaticallyFixableSnapError,\n): Promise<VirtualFile<SnapManifest>> {\n  const { manifest, packageJson } = snapFiles;\n  const clonedFile = manifest.clone();\n  const manifestCopy = clonedFile.result;\n\n  switch (error.reason) {\n    case SnapValidationFailureReason.NameMismatch:\n      manifestCopy.source.location.npm.packageName = packageJson.result.name;\n      break;\n\n    case SnapValidationFailureReason.VersionMismatch:\n      manifestCopy.version = packageJson.result.version;\n      break;\n\n    case SnapValidationFailureReason.RepositoryMismatch:\n      manifestCopy.repository = packageJson.result.repository\n        ? deepClone(packageJson.result.repository)\n        : undefined;\n      break;\n\n    case SnapValidationFailureReason.ShasumMismatch:\n      manifestCopy.source.shasum = await getSnapChecksum(snapFiles);\n      break;\n\n    /* istanbul ignore next */\n    default:\n      assertExhaustive(error.reason);\n  }\n\n  clonedFile.result = manifestCopy;\n  clonedFile.value = JSON.stringify(manifestCopy);\n  return clonedFile;\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * bundle source file location and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @param sourceCode - Override source code for plugins.\n * @returns The contents of the bundle file, if any.\n */\nexport async function getSnapSourceCode(\n  basePath: string,\n  manifest: Json,\n  sourceCode?: string,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const sourceFilePath = (manifest as Partial<SnapManifest>).source?.location\n    ?.npm?.filePath;\n\n  if (!sourceFilePath) {\n    return undefined;\n  }\n\n  if (sourceCode) {\n    return new VirtualFile({\n      path: pathUtils.join(basePath, sourceFilePath),\n      value: sourceCode,\n    });\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, sourceFilePath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(\n      `Failed to read snap bundle file: ${getErrorMessage(error)}`,\n    );\n  }\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the location of the\n * icon and read the file.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param manifest - The unvalidated Snap manifest file contents.\n * @returns The contents of the icon, if any.\n */\nexport async function getSnapIcon(\n  basePath: string,\n  manifest: Json,\n): Promise<VirtualFile | undefined> {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const iconPath = (manifest as Partial<SnapManifest>).source?.location?.npm\n    ?.iconPath;\n\n  if (!iconPath) {\n    return undefined;\n  }\n\n  try {\n    const virtualFile = await readVirtualFile(\n      pathUtils.join(basePath, iconPath),\n      'utf8',\n    );\n    return virtualFile;\n  } catch (error) {\n    throw new Error(`Failed to read snap icon file: ${getErrorMessage(error)}`);\n  }\n}\n\n/**\n * Get an array of paths from an unvalidated Snap manifest.\n *\n * @param manifest - The unvalidated Snap manifest file contents.\n * @param selector - A function that returns the paths to the files.\n * @returns The paths to the files, if any.\n */\nexport function getSnapFilePaths(\n  manifest: Json,\n  selector: (manifest: Partial<SnapManifest>) => string[] | undefined,\n) {\n  if (!isPlainObject(manifest)) {\n    return undefined;\n  }\n\n  const snapManifest = manifest as Partial<SnapManifest>;\n  const paths = selector(snapManifest);\n\n  if (!Array.isArray(paths)) {\n    return undefined;\n  }\n\n  return paths;\n}\n\n/**\n * Given an unvalidated Snap manifest, attempts to extract the files with the\n * given paths and read them.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param paths - The paths to the files.\n * @param encoding - An optional encoding to pass down to readVirtualFile.\n * @returns A list of auxiliary files and their contents, if any.\n */\nexport async function getSnapFiles(\n  basePath: string,\n  paths: string[] | undefined,\n  encoding: BufferEncoding | null = 'utf8',\n): Promise<VirtualFile[] | undefined> {\n  if (!paths) {\n    return undefined;\n  }\n\n  try {\n    return await Promise.all(\n      paths.map(async (filePath) =>\n        readVirtualFile(pathUtils.join(basePath, filePath), encoding),\n      ),\n    );\n  } catch (error) {\n    throw new Error(`Failed to read snap files: ${getErrorMessage(error)}`);\n  }\n}\n\n/**\n * Sorts the given manifest in our preferred sort order and removes the\n * `repository` field if it is falsy (it may be `null`).\n *\n * @param manifest - The manifest to sort and modify.\n * @returns The disk-ready manifest.\n */\nexport function getWritableManifest(manifest: SnapManifest): SnapManifest {\n  const { repository, ...remaining } = manifest;\n\n  const keys = Object.keys(\n    repository ? { ...remaining, repository } : remaining,\n  ) as (keyof SnapManifest)[];\n\n  const writableManifest = keys\n    .sort((a, b) => MANIFEST_SORT_ORDER[a] - MANIFEST_SORT_ORDER[b])\n    .reduce<Partial<SnapManifest>>(\n      (result, key) => ({\n        ...result,\n        [key]: manifest[key],\n      }),\n      {},\n    );\n\n  return writableManifest as SnapManifest;\n}\n\n/**\n * Validates the fields of an NPM Snap manifest that has already passed JSON\n * Schema validation.\n *\n * @param snapFiles - The relevant snap files to validate.\n * @param snapFiles.manifest - The npm Snap manifest to validate.\n * @param snapFiles.packageJson - The npm Snap's `package.json`.\n * @param snapFiles.sourceCode - The Snap's source code.\n * @param snapFiles.svgIcon - The Snap's optional icon.\n * @param snapFiles.auxiliaryFiles - Any auxiliary files required by the snap at runtime.\n * @param snapFiles.localizationFiles - The Snap's localization files.\n */\nexport async function validateNpmSnapManifest({\n  manifest,\n  packageJson,\n  sourceCode,\n  svgIcon,\n  auxiliaryFiles,\n  localizationFiles,\n}: SnapFiles) {\n  const packageJsonName = packageJson.result.name;\n  const packageJsonVersion = packageJson.result.version;\n  const packageJsonRepository = packageJson.result.repository;\n\n  const manifestPackageName = manifest.result.source.location.npm.packageName;\n  const manifestPackageVersion = manifest.result.version;\n  const manifestRepository = manifest.result.repository;\n\n  if (packageJsonName !== manifestPackageName) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package name (\"${manifestPackageName}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"name\" field (\"${packageJsonName}\").`,\n      SnapValidationFailureReason.NameMismatch,\n    );\n  }\n\n  if (packageJsonVersion !== manifestPackageVersion) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" npm package version (\"${manifestPackageVersion}\") does not match the \"${NpmSnapFileNames.PackageJson}\" \"version\" field (\"${packageJsonVersion}\").`,\n      SnapValidationFailureReason.VersionMismatch,\n    );\n  }\n\n  if (\n    // The repository may be `undefined` in package.json but can only be defined\n    // or `null` in the Snap manifest due to TS@<4.4 issues.\n    (packageJsonRepository || manifestRepository) &&\n    !deepEqual(packageJsonRepository, manifestRepository)\n  ) {\n    throw new ProgrammaticallyFixableSnapError(\n      `\"${NpmSnapFileNames.Manifest}\" \"repository\" field does not match the \"${NpmSnapFileNames.PackageJson}\" \"repository\" field.`,\n      SnapValidationFailureReason.RepositoryMismatch,\n    );\n  }\n\n  await validateSnapShasum(\n    { manifest, sourceCode, svgIcon, auxiliaryFiles, localizationFiles },\n    `\"${NpmSnapFileNames.Manifest}\" \"shasum\" field does not match computed shasum.`,\n  );\n}\n"],"names":["getErrorMessage","assertExhaustive","assert","isPlainObject","deepEqual","promises","fs","pathUtils","deepClone","readJsonFile","getSvgDimensions","validateNpmSnap","getSnapChecksum","ProgrammaticallyFixableSnapError","validateSnapShasum","NpmSnapFileNames","SnapValidationFailureReason","readVirtualFile","VirtualFile","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialConnections","initialPermissions","manifestVersion","checkManifest","basePath","writeManifest","sourceCode","writeFileFn","writeFile","warnings","errors","updated","manifestPath","join","Manifest","manifestFile","unvalidatedManifest","result","packageFile","PackageJson","auxiliaryFilePaths","getSnapFilePaths","manifest","files","localizationFilePaths","locales","snapFiles","packageJson","getSnapSourceCode","svgIcon","getSnapIcon","auxiliaryFiles","getSnapFiles","localizationFiles","error","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","length","attempts","fixManifest","validateNpmSnapManifest","nextValidationError","Error","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","iconDimensions","toString","height","width","newManifest","JSON","stringify","getWritableManifest","value","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","undefined","ShasumMismatch","shasum","sourceFilePath","filePath","path","virtualFile","iconPath","selector","snapManifest","paths","Array","isArray","encoding","Promise","all","map","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository"],"mappings":"AAAA,SAASA,eAAe,QAAQ,sBAAsB;AAEtD,SAASC,gBAAgB,EAAEC,MAAM,EAAEC,aAAa,QAAQ,kBAAkB;AAC1E,OAAOC,eAAe,kBAAkB;AACxC,SAASC,YAAYC,EAAE,QAAQ,KAAK;AACpC,OAAOC,eAAe,OAAO;AAE7B,SAASC,SAAS,QAAQ,gBAAgB;AAC1C,SAASC,YAAY,QAAQ,QAAQ;AACrC,SAASC,gBAAgB,QAAQ,UAAU;AAC3C,SAASC,eAAe,QAAQ,SAAS;AACzC,SACEC,eAAe,EACfC,gCAAgC,EAChCC,kBAAkB,QACb,WAAW;AAElB,SAASC,gBAAgB,EAAEC,2BAA2B,QAAQ,WAAW;AACzE,SAASC,eAAe,EAAEC,WAAW,QAAQ,kBAAkB;AAG/D,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,oBAAoB;IACpBC,iBAAiB;AACnB;AAyBA;;;;;;;;;;;CAWC,GACD,OAAO,eAAeC,cACpBC,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB,EACnBC,cAAiC3B,GAAG4B,SAAS;IAE7C,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAe/B,UAAUgC,IAAI,CAACT,UAAUf,iBAAiByB,QAAQ;IACvE,MAAMC,eAAe,MAAMhC,aAAa6B;IACxC,MAAMI,sBAAsBD,aAAaE,MAAM;IAE/C,MAAMC,cAAc,MAAMnC,aACxBF,UAAUgC,IAAI,CAACT,UAAUf,iBAAiB8B,WAAW;IAGvD,MAAMC,qBAAqBC,iBACzBL,qBACA,CAACM,WAAaA,UAAUvB,QAAQwB;IAGlC,MAAMC,wBAAwBH,iBAC5BL,qBACA,CAACM,WAAaA,UAAUvB,QAAQ0B;IAGlC,MAAMC,YAAkC;QACtCJ,UAAUP;QACVY,aAAaT;QACbZ,YAAY,MAAMsB,kBAChBxB,UACAY,qBACAV;QAEFuB,SAAS,MAAMC,YAAY1B,UAAUY;QACrC,6EAA6E;QAC7Ee,gBACE,AAAC,MAAMC,aAAa5B,UAAUgB,oBAAoB,SAAU,EAAE;QAChEa,mBACE,AAAC,MAAMD,aAAa5B,UAAUoB,0BAA2B,EAAE;IAC/D;IAEA,IAAIF;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAG,MAAMrC,gBAAgByC,UAAS;IACjD,EAAE,OAAOQ,OAAO;QACd,IAAIA,iBAAiB/C,kCAAkC;YACrDuB,OAAOyB,IAAI,CAACD,MAAME,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BX;YAEhC,IAAIY,YAAY;YAChB,IAAIC,eAAeL;YACnB,MAAMM,cAAcC,OAAOC,IAAI,CAACpD,6BAA6BqD,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGN,aAAaM,YAAYJ,aAAaI,WAAY;gBACvEtB,WAAW,MAAMuB,YACfvB,WACI;oBAAE,GAAGe,uBAAuB;oBAAEf;gBAAS,IACvCe,yBACJE;gBAGF,IAAI;oBACF,MAAMO,wBAAwB;wBAC5B,GAAGT,uBAAuB;wBAC1Bf;oBACF;oBAEAgB,YAAY;gBACd,EAAE,OAAOS,qBAAqB;oBAC5BR,eAAeQ;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+B5D,gCAA+B,KAE/DyD,aAAaJ,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIU,MACR,CAAC,kFAAkF,EAAEd,MAAME,OAAO,CAAC,CAAC;oBAExG;oBAEA1B,OAAOyB,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEAzB,UAAU;QACZ,OAAO;YACL,MAAMuB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1C1D,OAAO8C;IAEP,MAAM2B,oBAAoB3B,SAASL,MAAM;IAEzC,qCAAqC;IACrC,MAAMiC,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBR,MAAM,GAAG,GAAG;QACvClC,SAAS0B,IAAI,CACX,CAAC,8CAA8C,EAAEgB,yBAAyBG,MAAM,CAC9E,CAACC,YAAYC;YACX,OAAO,CAAC,EAAED,WAAW,EAAE,EAAEC,aAAa,EAAE,CAAC;QAC3C,GACA,IACA,CAAC;IAEP;IAEA,IAAI,CAAC9B,UAAUG,OAAO,EAAE;QACtBpB,SAAS0B,IAAI,CACX;IAEJ;IAEA,MAAMsB,iBACJ/B,UAAUG,OAAO,IAAI7C,iBAAiB0C,UAAUG,OAAO,CAAC6B,QAAQ;IAClE,IAAID,kBAAkBA,eAAeE,MAAM,KAAKF,eAAeG,KAAK,EAAE;QACpEnD,SAAS0B,IAAI,CACX;IAEJ;IAEA,IAAI9B,eAAe;QACjB,IAAI;YACF,MAAMwD,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnCC,oBAAoBf,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAItC,WAAWkD,gBAAgB9C,aAAakD,KAAK,EAAE;gBACjD,MAAM1D,YACJ1B,UAAUgC,IAAI,CAACT,UAAUf,iBAAiByB,QAAQ,GAClD+C;YAEJ;QACF,EAAE,OAAO3B,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAME,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEd,UAAU2B;QAAmBtC;QAASF;QAAUC;IAAO;AAClE;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAemC,YACpBnB,SAAoB,EACpBQ,KAAuC;IAEvC,MAAM,EAAEZ,QAAQ,EAAEK,WAAW,EAAE,GAAGD;IAClC,MAAMwC,aAAa5C,SAAS6C,KAAK;IACjC,MAAMC,eAAeF,WAAWjD,MAAM;IAEtC,OAAQiB,MAAMmC,MAAM;QAClB,KAAK/E,4BAA4BgF,YAAY;YAC3CF,aAAarE,MAAM,CAACwE,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAG9C,YAAYV,MAAM,CAACyD,IAAI;YACtE;QAEF,KAAKpF,4BAA4BqF,eAAe;YAC9CP,aAAazE,OAAO,GAAGgC,YAAYV,MAAM,CAACtB,OAAO;YACjD;QAEF,KAAKL,4BAA4BsF,kBAAkB;YACjDR,aAAatE,UAAU,GAAG6B,YAAYV,MAAM,CAACnB,UAAU,GACnDhB,UAAU6C,YAAYV,MAAM,CAACnB,UAAU,IACvC+E;YACJ;QAEF,KAAKvF,4BAA4BwF,cAAc;YAC7CV,aAAarE,MAAM,CAACgF,MAAM,GAAG,MAAM7F,gBAAgBwC;YACnD;QAEF,wBAAwB,GACxB;YACEnD,iBAAiB2D,MAAMmC,MAAM;IACjC;IAEAH,WAAWjD,MAAM,GAAGmD;IACpBF,WAAWD,KAAK,GAAGH,KAAKC,SAAS,CAACK;IAClC,OAAOF;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAetC,kBACpBxB,QAAgB,EAChBkB,QAAc,EACdhB,UAAmB;IAEnB,IAAI,CAAC7B,cAAc6C,WAAW;QAC5B,OAAOuD;IACT;IAEA,MAAMG,iBAAiB,AAAC1D,SAAmCvB,MAAM,EAAEwE,UAC/DC,KAAKS;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAOH;IACT;IAEA,IAAIvE,YAAY;QACd,OAAO,IAAId,YAAY;YACrB0F,MAAMrG,UAAUgC,IAAI,CAACT,UAAU4E;YAC/Bf,OAAO3D;QACT;IACF;IAEA,IAAI;QACF,MAAM6E,cAAc,MAAM5F,gBACxBV,UAAUgC,IAAI,CAACT,UAAU4E,iBACzB;QAEF,OAAOG;IACT,EAAE,OAAOjD,OAAO;QACd,MAAM,IAAIc,MACR,CAAC,iCAAiC,EAAE1E,gBAAgB4D,OAAO,CAAC;IAEhE;AACF;AAEA;;;;;;;CAOC,GACD,OAAO,eAAeJ,YACpB1B,QAAgB,EAChBkB,QAAc;IAEd,IAAI,CAAC7C,cAAc6C,WAAW;QAC5B,OAAOuD;IACT;IAEA,MAAMO,WAAW,AAAC9D,SAAmCvB,MAAM,EAAEwE,UAAUC,KACnEY;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOP;IACT;IAEA,IAAI;QACF,MAAMM,cAAc,MAAM5F,gBACxBV,UAAUgC,IAAI,CAACT,UAAUgF,WACzB;QAEF,OAAOD;IACT,EAAE,OAAOjD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAE1E,gBAAgB4D,OAAO,CAAC;IAC5E;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASb,iBACdC,QAAc,EACd+D,QAAmE;IAEnE,IAAI,CAAC5G,cAAc6C,WAAW;QAC5B,OAAOuD;IACT;IAEA,MAAMS,eAAehE;IACrB,MAAMiE,QAAQF,SAASC;IAEvB,IAAI,CAACE,MAAMC,OAAO,CAACF,QAAQ;QACzB,OAAOV;IACT;IAEA,OAAOU;AACT;AAEA;;;;;;;;CAQC,GACD,OAAO,eAAevD,aACpB5B,QAAgB,EAChBmF,KAA2B,EAC3BG,WAAkC,MAAM;IAExC,IAAI,CAACH,OAAO;QACV,OAAOV;IACT;IAEA,IAAI;QACF,OAAO,MAAMc,QAAQC,GAAG,CACtBL,MAAMM,GAAG,CAAC,OAAOZ,WACf1F,gBAAgBV,UAAUgC,IAAI,CAACT,UAAU6E,WAAWS;IAG1D,EAAE,OAAOxD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,2BAA2B,EAAE1E,gBAAgB4D,OAAO,CAAC;IACxE;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAAS8B,oBAAoB1C,QAAsB;IACxD,MAAM,EAAExB,UAAU,EAAE,GAAGgG,WAAW,GAAGxE;IAErC,MAAMoB,OAAOD,OAAOC,IAAI,CACtB5C,aAAa;QAAE,GAAGgG,SAAS;QAAEhG;IAAW,IAAIgG;IAG9C,MAAMC,mBAAmBrD,KACtBsD,IAAI,CAAC,CAACC,GAAGC,IAAMzG,mBAAmB,CAACwG,EAAE,GAAGxG,mBAAmB,CAACyG,EAAE,EAC9D5C,MAAM,CACL,CAACrC,QAAQoC,MAAS,CAAA;YAChB,GAAGpC,MAAM;YACT,CAACoC,IAAI,EAAE/B,QAAQ,CAAC+B,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAO0C;AACT;AAEA;;;;;;;;;;;CAWC,GACD,OAAO,eAAejD,wBAAwB,EAC5CxB,QAAQ,EACRK,WAAW,EACXrB,UAAU,EACVuB,OAAO,EACPE,cAAc,EACdE,iBAAiB,EACP;IACV,MAAMkE,kBAAkBxE,YAAYV,MAAM,CAACyD,IAAI;IAC/C,MAAM0B,qBAAqBzE,YAAYV,MAAM,CAACtB,OAAO;IACrD,MAAM0G,wBAAwB1E,YAAYV,MAAM,CAACnB,UAAU;IAE3D,MAAMwG,sBAAsBhF,SAASL,MAAM,CAAClB,MAAM,CAACwE,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAM8B,yBAAyBjF,SAASL,MAAM,CAACtB,OAAO;IACtD,MAAM6G,qBAAqBlF,SAASL,MAAM,CAACnB,UAAU;IAErD,IAAIqG,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAInH,iCACR,CAAC,CAAC,EAAEE,iBAAiByB,QAAQ,CAAC,qBAAqB,EAAEwF,oBAAoB,uBAAuB,EAAEjH,iBAAiB8B,WAAW,CAAC,iBAAiB,EAAEgF,gBAAgB,GAAG,CAAC,EACtK7G,4BAA4BgF,YAAY;IAE5C;IAEA,IAAI8B,uBAAuBG,wBAAwB;QACjD,MAAM,IAAIpH,iCACR,CAAC,CAAC,EAAEE,iBAAiByB,QAAQ,CAAC,wBAAwB,EAAEyF,uBAAuB,uBAAuB,EAAElH,iBAAiB8B,WAAW,CAAC,oBAAoB,EAAEiF,mBAAmB,GAAG,CAAC,EAClL9G,4BAA4BqF,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvD0B,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAAC9H,UAAU2H,uBAAuBG,qBAClC;QACA,MAAM,IAAIrH,iCACR,CAAC,CAAC,EAAEE,iBAAiByB,QAAQ,CAAC,yCAAyC,EAAEzB,iBAAiB8B,WAAW,CAAC,qBAAqB,CAAC,EAC5H7B,4BAA4BsF,kBAAkB;IAElD;IAEA,MAAMxF,mBACJ;QAAEkC;QAAUhB;QAAYuB;QAASE;QAAgBE;IAAkB,GACnE,CAAC,CAAC,EAAE5C,iBAAiByB,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}

package/dist/esm/manifest/validation.js

@@ -1,6 +1,6 @@
 import { isValidBIP32PathSegment } from '@metamask/key-tree';
-import { assertStruct, ChecksumStruct, VersionStruct, isValidSemVerRange } from '@metamask/utils';
-import { array, boolean, create, enums, integer, is, literal, object, optional, refine, record, size, string, type, union, intersection } from 'superstruct';
+import { assertStruct, ChecksumStruct, VersionStruct, isValidSemVerRange, inMilliseconds, Duration } from '@metamask/utils';
+import { array, boolean, create, enums, integer, is, literal, object, optional, refine, record, size, string, type, union, intersection, assign } from 'superstruct';
 import { isEqual } from '../array';
 import { CronjobSpecificationArrayStruct } from '../cronjob';
 import { SIP_6_MAGIC_VALUE, STATE_ENCRYPTION_MAGIC_VALUE } from '../entropy';
@@ -72,26 +72,48 @@ export const SnapIdsStruct = refine(record(SnapIdStruct, object({
     }
     return true;
 });
-export const ChainIdsStruct = array(ChainIdStruct);
+export const ChainIdsStruct = size(array(ChainIdStruct), 1, Infinity);
+export const LookupMatchersStruct = union([
+    object({
+        tlds: size(array(string()), 1, Infinity)
+    }),
+    object({
+        schemes: size(array(string()), 1, Infinity)
+    }),
+    object({
+        tlds: size(array(string()), 1, Infinity),
+        schemes: size(array(string()), 1, Infinity)
+    })
+]);
+export const MINIMUM_REQUEST_TIMEOUT = inMilliseconds(5, Duration.Second);
+export const MAXIMUM_REQUEST_TIMEOUT = inMilliseconds(3, Duration.Minute);
+export const MaxRequestTimeStruct = size(integer(), MINIMUM_REQUEST_TIMEOUT, MAXIMUM_REQUEST_TIMEOUT);
+// Utility type to union with for all handler structs
+export const HandlerCaveatsStruct = object({
+    maxRequestTime: optional(MaxRequestTimeStruct)
+});
 /* eslint-disable @typescript-eslint/naming-convention */ export const PermissionsStruct = type({
+    'endowment:cronjob': optional(assign(HandlerCaveatsStruct, object({
+        jobs: CronjobSpecificationArrayStruct
+    }))),
     'endowment:ethereum-provider': optional(object({})),
+    'endowment:keyring': optional(assign(HandlerCaveatsStruct, KeyringOriginsStruct)),
+    'endowment:lifecycle-hooks': optional(HandlerCaveatsStruct),
+    'endowment:name-lookup': optional(assign(HandlerCaveatsStruct, object({
+        chains: optional(ChainIdsStruct),
+        matchers: optional(LookupMatchersStruct)
+    }))),
     'endowment:network-access': optional(object({})),
-    'endowment:webassembly': optional(object({})),
-    'endowment:signature-insight': optional(object({
+    'endowment:page-home': optional(HandlerCaveatsStruct),
+    'endowment:rpc': optional(RpcOriginsStruct),
+    'endowment:signature-insight': optional(assign(HandlerCaveatsStruct, object({
         allowSignatureOrigin: optional(boolean())
-    })),
-    'endowment:transaction-insight': optional(object({
+    }))),
+    'endowment:transaction-insight': optional(assign(HandlerCaveatsStruct, object({
         allowTransactionOrigin: optional(boolean())
-    })),
-    'endowment:cronjob': optional(object({
-        jobs: CronjobSpecificationArrayStruct
-    })),
-    'endowment:rpc': optional(RpcOriginsStruct),
-    'endowment:name-lookup': optional(ChainIdsStruct),
-    'endowment:keyring': optional(KeyringOriginsStruct),
+    }))),
+    'endowment:webassembly': optional(object({})),
     snap_dialog: optional(object({})),
-    // TODO: Remove
-    snap_confirm: optional(object({})),
     snap_manageState: optional(object({})),
     snap_manageAccounts: optional(object({})),
     snap_notify: optional(object({})),

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/manifest/validation.ts"],"sourcesContent":["import { isValidBIP32PathSegment } from '@metamask/key-tree';\nimport type { InitialPermissions } from '@metamask/snaps-sdk';\nimport {\n  assertStruct,\n  ChecksumStruct,\n  VersionStruct,\n  isValidSemVerRange,\n} from '@metamask/utils';\nimport type { Infer, Struct } from 'superstruct';\nimport {\n  array,\n  boolean,\n  create,\n  enums,\n  integer,\n  is,\n  literal,\n  object,\n  optional,\n  refine,\n  record,\n  size,\n  string,\n  type,\n  union,\n  intersection,\n} from 'superstruct';\n\nimport { isEqual } from '../array';\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { SIP_6_MAGIC_VALUE, STATE_ENCRYPTION_MAGIC_VALUE } from '../entropy';\nimport { KeyringOriginsStruct, RpcOriginsStruct } from '../json-rpc';\nimport { ChainIdStruct } from '../namespace';\nimport { SnapIdStruct } from '../snaps';\nimport type { InferMatching } from '../structs';\nimport { NameStruct, NpmSnapFileNames, uri } from '../types';\n\n// BIP-43 purposes that cannot be used for entropy derivation. These are in the\n// string form, ending with `'`.\nconst FORBIDDEN_PURPOSES: string[] = [\n  SIP_6_MAGIC_VALUE,\n  STATE_ENCRYPTION_MAGIC_VALUE,\n];\n\nexport const FORBIDDEN_COIN_TYPES: number[] = [60];\nconst FORBIDDEN_PATHS: string[][] = FORBIDDEN_COIN_TYPES.map((coinType) => [\n  'm',\n  \"44'\",\n  `${coinType}'`,\n]);\n\nexport const Bip32PathStruct = refine(\n  array(string()),\n  'BIP-32 path',\n  (path: string[]) => {\n    if (path.length === 0) {\n      return 'Path must be a non-empty BIP-32 derivation path array';\n    }\n\n    if (path[0] !== 'm') {\n      return 'Path must start with \"m\".';\n    }\n\n    if (path.length < 3) {\n      return 'Paths must have a length of at least three.';\n    }\n\n    if (path.slice(1).some((part) => !isValidBIP32PathSegment(part))) {\n      return 'Path must be a valid BIP-32 derivation path array.';\n    }\n\n    if (FORBIDDEN_PURPOSES.includes(path[1])) {\n      return `The purpose \"${path[1]}\" is not allowed for entropy derivation.`;\n    }\n\n    if (\n      FORBIDDEN_PATHS.some((forbiddenPath) =>\n        isEqual(path.slice(0, forbiddenPath.length), forbiddenPath),\n      )\n    ) {\n      return `The path \"${path.join(\n        '/',\n      )}\" is not allowed for entropy derivation.`;\n    }\n\n    return true;\n  },\n);\n\nexport const bip32entropy = <\n  Type extends { path: string[]; curve: string },\n  Schema,\n>(\n  struct: Struct<Type, Schema>,\n) =>\n  refine(struct, 'BIP-32 entropy', (value) => {\n    if (\n      value.curve === 'ed25519' &&\n      value.path.slice(1).some((part) => !part.endsWith(\"'\"))\n    ) {\n      return 'Ed25519 does not support unhardened paths.';\n    }\n\n    return true;\n  });\n\n// Used outside @metamask/snap-utils\nexport const Bip32EntropyStruct = bip32entropy(\n  type({\n    path: Bip32PathStruct,\n    curve: enums(['ed25519', 'secp256k1']),\n  }),\n);\n\nexport type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;\n\nexport const SnapGetBip32EntropyPermissionsStruct = size(\n  array(Bip32EntropyStruct),\n  1,\n  Infinity,\n);\n\nexport const SemVerRangeStruct = refine(string(), 'SemVer range', (value) => {\n  if (isValidSemVerRange(value)) {\n    return true;\n  }\n  return 'Expected a valid SemVer range.';\n});\n\nexport const SnapIdsStruct = refine(\n  record(SnapIdStruct, object({ version: optional(SemVerRangeStruct) })),\n  'SnapIds',\n  (value) => {\n    if (Object.keys(value).length === 0) {\n      return false;\n    }\n\n    return true;\n  },\n);\n\nexport type SnapIds = Infer<typeof SnapIdsStruct>;\n\nexport const ChainIdsStruct = array(ChainIdStruct);\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const PermissionsStruct = type({\n  'endowment:ethereum-provider': optional(object({})),\n  'endowment:network-access': optional(object({})),\n  'endowment:webassembly': optional(object({})),\n  'endowment:signature-insight': optional(\n    object({\n      allowSignatureOrigin: optional(boolean()),\n    }),\n  ),\n  'endowment:transaction-insight': optional(\n    object({\n      allowTransactionOrigin: optional(boolean()),\n    }),\n  ),\n  'endowment:cronjob': optional(\n    object({ jobs: CronjobSpecificationArrayStruct }),\n  ),\n  'endowment:rpc': optional(RpcOriginsStruct),\n  'endowment:name-lookup': optional(ChainIdsStruct),\n  'endowment:keyring': optional(KeyringOriginsStruct),\n  snap_dialog: optional(object({})),\n  // TODO: Remove\n  snap_confirm: optional(object({})),\n  snap_manageState: optional(object({})),\n  snap_manageAccounts: optional(object({})),\n  snap_notify: optional(object({})),\n  snap_getBip32Entropy: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip32PublicKey: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip44Entropy: optional(\n    size(\n      array(object({ coinType: size(integer(), 0, 2 ** 32 - 1) })),\n      1,\n      Infinity,\n    ),\n  ),\n  snap_getEntropy: optional(object({})),\n  snap_getLocale: optional(object({})),\n  wallet_snap: optional(SnapIdsStruct),\n});\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport type SnapPermissions = InferMatching<\n  typeof PermissionsStruct,\n  InitialPermissions\n>;\n\nexport const SnapAuxilaryFilesStruct = array(string());\n\nexport const InitialConnectionsStruct = record(\n  intersection([string(), uri()]),\n  object({}),\n);\n\nexport type InitialConnections = Infer<typeof InitialConnectionsStruct>;\n\nexport const SnapManifestStruct = object({\n  version: VersionStruct,\n  description: size(string(), 1, 280),\n  proposedName: size(string(), 1, 214),\n  repository: optional(\n    object({\n      type: size(string(), 1, Infinity),\n      url: size(string(), 1, Infinity),\n    }),\n  ),\n  source: object({\n    shasum: ChecksumStruct,\n    location: object({\n      npm: object({\n        filePath: size(string(), 1, Infinity),\n        iconPath: optional(size(string(), 1, Infinity)),\n        packageName: NameStruct,\n        registry: union([\n          literal('https://registry.npmjs.org'),\n          literal('https://registry.npmjs.org/'),\n        ]),\n      }),\n    }),\n    files: optional(SnapAuxilaryFilesStruct),\n    locales: optional(SnapAuxilaryFilesStruct),\n  }),\n  initialConnections: optional(InitialConnectionsStruct),\n  initialPermissions: PermissionsStruct,\n  manifestVersion: literal('0.1'),\n  $schema: optional(string()), // enables JSON-Schema linting in VSC and other IDEs\n});\n\nexport type SnapManifest = Infer<typeof SnapManifestStruct>;\n\n/**\n * Check if the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link SnapManifest} object.\n */\nexport function isSnapManifest(value: unknown): value is SnapManifest {\n  return is(value, SnapManifestStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link SnapManifest} object.\n */\nexport function assertIsSnapManifest(\n  value: unknown,\n): asserts value is SnapManifest {\n  assertStruct(\n    value,\n    SnapManifestStruct,\n    `\"${NpmSnapFileNames.Manifest}\" is invalid`,\n  );\n}\n\n/**\n * Creates a {@link SnapManifest} object from JSON.\n *\n * @param value - The value to check.\n * @throws If the value cannot be coerced to a {@link SnapManifest} object.\n * @returns The created {@link SnapManifest} object.\n */\nexport function createSnapManifest(value: unknown): SnapManifest {\n  // TODO: Add a utility to prefix these errors similar to assertStruct\n  return create(value, SnapManifestStruct);\n}\n"],"names":["isValidBIP32PathSegment","assertStruct","ChecksumStruct","VersionStruct","isValidSemVerRange","array","boolean","create","enums","integer","is","literal","object","optional","refine","record","size","string","type","union","intersection","isEqual","CronjobSpecificationArrayStruct","SIP_6_MAGIC_VALUE","STATE_ENCRYPTION_MAGIC_VALUE","KeyringOriginsStruct","RpcOriginsStruct","ChainIdStruct","SnapIdStruct","NameStruct","NpmSnapFileNames","uri","FORBIDDEN_PURPOSES","FORBIDDEN_COIN_TYPES","FORBIDDEN_PATHS","map","coinType","Bip32PathStruct","path","length","slice","some","part","includes","forbiddenPath","join","bip32entropy","struct","value","curve","endsWith","Bip32EntropyStruct","SnapGetBip32EntropyPermissionsStruct","Infinity","SemVerRangeStruct","SnapIdsStruct","version","Object","keys","ChainIdsStruct","PermissionsStruct","allowSignatureOrigin","allowTransactionOrigin","jobs","snap_dialog","snap_confirm","snap_manageState","snap_manageAccounts","snap_notify","snap_getBip32Entropy","snap_getBip32PublicKey","snap_getBip44Entropy","snap_getEntropy","snap_getLocale","wallet_snap","SnapAuxilaryFilesStruct","InitialConnectionsStruct","SnapManifestStruct","description","proposedName","repository","url","source","shasum","location","npm","filePath","iconPath","packageName","registry","files","locales","initialConnections","initialPermissions","manifestVersion","$schema","isSnapManifest","assertIsSnapManifest","Manifest","createSnapManifest"],"mappings":"AAAA,SAASA,uBAAuB,QAAQ,qBAAqB;AAE7D,SACEC,YAAY,EACZC,cAAc,EACdC,aAAa,EACbC,kBAAkB,QACb,kBAAkB;AAEzB,SACEC,KAAK,EACLC,OAAO,EACPC,MAAM,EACNC,KAAK,EACLC,OAAO,EACPC,EAAE,EACFC,OAAO,EACPC,MAAM,EACNC,QAAQ,EACRC,MAAM,EACNC,MAAM,EACNC,IAAI,EACJC,MAAM,EACNC,IAAI,EACJC,KAAK,EACLC,YAAY,QACP,cAAc;AAErB,SAASC,OAAO,QAAQ,WAAW;AACnC,SAASC,+BAA+B,QAAQ,aAAa;AAC7D,SAASC,iBAAiB,EAAEC,4BAA4B,QAAQ,aAAa;AAC7E,SAASC,oBAAoB,EAAEC,gBAAgB,QAAQ,cAAc;AACrE,SAASC,aAAa,QAAQ,eAAe;AAC7C,SAASC,YAAY,QAAQ,WAAW;AAExC,SAASC,UAAU,EAAEC,gBAAgB,EAAEC,GAAG,QAAQ,WAAW;AAE7D,+EAA+E;AAC/E,gCAAgC;AAChC,MAAMC,qBAA+B;IACnCT;IACAC;CACD;AAED,OAAO,MAAMS,uBAAiC;IAAC;CAAG,CAAC;AACnD,MAAMC,kBAA8BD,qBAAqBE,GAAG,CAAC,CAACC,WAAa;QACzE;QACA;QACA,CAAC,EAAEA,SAAS,CAAC,CAAC;KACf;AAED,OAAO,MAAMC,kBAAkBvB,OAC7BT,MAAMY,WACN,eACA,CAACqB;IACC,IAAIA,KAAKC,MAAM,KAAK,GAAG;QACrB,OAAO;IACT;IAEA,IAAID,IAAI,CAAC,EAAE,KAAK,KAAK;QACnB,OAAO;IACT;IAEA,IAAIA,KAAKC,MAAM,GAAG,GAAG;QACnB,OAAO;IACT;IAEA,IAAID,KAAKE,KAAK,CAAC,GAAGC,IAAI,CAAC,CAACC,OAAS,CAAC1C,wBAAwB0C,QAAQ;QAChE,OAAO;IACT;IAEA,IAAIV,mBAAmBW,QAAQ,CAACL,IAAI,CAAC,EAAE,GAAG;QACxC,OAAO,CAAC,aAAa,EAAEA,IAAI,CAAC,EAAE,CAAC,wCAAwC,CAAC;IAC1E;IAEA,IACEJ,gBAAgBO,IAAI,CAAC,CAACG,gBACpBvB,QAAQiB,KAAKE,KAAK,CAAC,GAAGI,cAAcL,MAAM,GAAGK,iBAE/C;QACA,OAAO,CAAC,UAAU,EAAEN,KAAKO,IAAI,CAC3B,KACA,wCAAwC,CAAC;IAC7C;IAEA,OAAO;AACT,GACA;AAEF,OAAO,MAAMC,eAAe,CAI1BC,SAEAjC,OAAOiC,QAAQ,kBAAkB,CAACC;QAChC,IACEA,MAAMC,KAAK,KAAK,aAChBD,MAAMV,IAAI,CAACE,KAAK,CAAC,GAAGC,IAAI,CAAC,CAACC,OAAS,CAACA,KAAKQ,QAAQ,CAAC,OAClD;YACA,OAAO;QACT;QAEA,OAAO;IACT,GAAG;AAEL,oCAAoC;AACpC,OAAO,MAAMC,qBAAqBL,aAChC5B,KAAK;IACHoB,MAAMD;IACNY,OAAOzC,MAAM;QAAC;QAAW;KAAY;AACvC,IACA;AAIF,OAAO,MAAM4C,uCAAuCpC,KAClDX,MAAM8C,qBACN,GACAE,UACA;AAEF,OAAO,MAAMC,oBAAoBxC,OAAOG,UAAU,gBAAgB,CAAC+B;IACjE,IAAI5C,mBAAmB4C,QAAQ;QAC7B,OAAO;IACT;IACA,OAAO;AACT,GAAG;AAEH,OAAO,MAAMO,gBAAgBzC,OAC3BC,OAAOa,cAAchB,OAAO;IAAE4C,SAAS3C,SAASyC;AAAmB,KACnE,WACA,CAACN;IACC,IAAIS,OAAOC,IAAI,CAACV,OAAOT,MAAM,KAAK,GAAG;QACnC,OAAO;IACT;IAEA,OAAO;AACT,GACA;AAIF,OAAO,MAAMoB,iBAAiBtD,MAAMsB,eAAe;AAEnD,uDAAuD,GACvD,OAAO,MAAMiC,oBAAoB1C,KAAK;IACpC,+BAA+BL,SAASD,OAAO,CAAC;IAChD,4BAA4BC,SAASD,OAAO,CAAC;IAC7C,yBAAyBC,SAASD,OAAO,CAAC;IAC1C,+BAA+BC,SAC7BD,OAAO;QACLiD,sBAAsBhD,SAASP;IACjC;IAEF,iCAAiCO,SAC/BD,OAAO;QACLkD,wBAAwBjD,SAASP;IACnC;IAEF,qBAAqBO,SACnBD,OAAO;QAAEmD,MAAMzC;IAAgC;IAEjD,iBAAiBT,SAASa;IAC1B,yBAAyBb,SAAS8C;IAClC,qBAAqB9C,SAASY;IAC9BuC,aAAanD,SAASD,OAAO,CAAC;IAC9B,eAAe;IACfqD,cAAcpD,SAASD,OAAO,CAAC;IAC/BsD,kBAAkBrD,SAASD,OAAO,CAAC;IACnCuD,qBAAqBtD,SAASD,OAAO,CAAC;IACtCwD,aAAavD,SAASD,OAAO,CAAC;IAC9ByD,sBAAsBxD,SAASuC;IAC/BkB,wBAAwBzD,SAASuC;IACjCmB,sBAAsB1D,SACpBG,KACEX,MAAMO,OAAO;QAAEwB,UAAUpB,KAAKP,WAAW,GAAG,KAAK,KAAK;IAAG,KACzD,GACA4C;IAGJmB,iBAAiB3D,SAASD,OAAO,CAAC;IAClC6D,gBAAgB5D,SAASD,OAAO,CAAC;IACjC8D,aAAa7D,SAAS0C;AACxB,GAAG;AAQH,OAAO,MAAMoB,0BAA0BtE,MAAMY,UAAU;AAEvD,OAAO,MAAM2D,2BAA2B7D,OACtCK,aAAa;IAACH;IAAUc;CAAM,GAC9BnB,OAAO,CAAC,IACR;AAIF,OAAO,MAAMiE,qBAAqBjE,OAAO;IACvC4C,SAASrD;IACT2E,aAAa9D,KAAKC,UAAU,GAAG;IAC/B8D,cAAc/D,KAAKC,UAAU,GAAG;IAChC+D,YAAYnE,SACVD,OAAO;QACLM,MAAMF,KAAKC,UAAU,GAAGoC;QACxB4B,KAAKjE,KAAKC,UAAU,GAAGoC;IACzB;IAEF6B,QAAQtE,OAAO;QACbuE,QAAQjF;QACRkF,UAAUxE,OAAO;YACfyE,KAAKzE,OAAO;gBACV0E,UAAUtE,KAAKC,UAAU,GAAGoC;gBAC5BkC,UAAU1E,SAASG,KAAKC,UAAU,GAAGoC;gBACrCmC,aAAa3D;gBACb4D,UAAUtE,MAAM;oBACdR,QAAQ;oBACRA,QAAQ;iBACT;YACH;QACF;QACA+E,OAAO7E,SAAS8D;QAChBgB,SAAS9E,SAAS8D;IACpB;IACAiB,oBAAoB/E,SAAS+D;IAC7BiB,oBAAoBjC;IACpBkC,iBAAiBnF,QAAQ;IACzBoF,SAASlF,SAASI;AACpB,GAAG;AAIH;;;;;CAKC,GACD,OAAO,SAAS+E,eAAehD,KAAc;IAC3C,OAAOtC,GAAGsC,OAAO6B;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASoB,qBACdjD,KAAc;IAEd/C,aACE+C,OACA6B,oBACA,CAAC,CAAC,EAAE/C,iBAAiBoE,QAAQ,CAAC,YAAY,CAAC;AAE/C;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,mBAAmBnD,KAAc;IAC/C,qEAAqE;IACrE,OAAOzC,OAAOyC,OAAO6B;AACvB"}
+{"version":3,"sources":["../../../src/manifest/validation.ts"],"sourcesContent":["import { isValidBIP32PathSegment } from '@metamask/key-tree';\nimport type { InitialPermissions } from '@metamask/snaps-sdk';\nimport {\n  assertStruct,\n  ChecksumStruct,\n  VersionStruct,\n  isValidSemVerRange,\n  inMilliseconds,\n  Duration,\n} from '@metamask/utils';\nimport type { Infer, Struct } from 'superstruct';\nimport {\n  array,\n  boolean,\n  create,\n  enums,\n  integer,\n  is,\n  literal,\n  object,\n  optional,\n  refine,\n  record,\n  size,\n  string,\n  type,\n  union,\n  intersection,\n  assign,\n} from 'superstruct';\n\nimport { isEqual } from '../array';\nimport { CronjobSpecificationArrayStruct } from '../cronjob';\nimport { SIP_6_MAGIC_VALUE, STATE_ENCRYPTION_MAGIC_VALUE } from '../entropy';\nimport { KeyringOriginsStruct, RpcOriginsStruct } from '../json-rpc';\nimport { ChainIdStruct } from '../namespace';\nimport { SnapIdStruct } from '../snaps';\nimport type { InferMatching } from '../structs';\nimport { NameStruct, NpmSnapFileNames, uri } from '../types';\n\n// BIP-43 purposes that cannot be used for entropy derivation. These are in the\n// string form, ending with `'`.\nconst FORBIDDEN_PURPOSES: string[] = [\n  SIP_6_MAGIC_VALUE,\n  STATE_ENCRYPTION_MAGIC_VALUE,\n];\n\nexport const FORBIDDEN_COIN_TYPES: number[] = [60];\nconst FORBIDDEN_PATHS: string[][] = FORBIDDEN_COIN_TYPES.map((coinType) => [\n  'm',\n  \"44'\",\n  `${coinType}'`,\n]);\n\nexport const Bip32PathStruct = refine(\n  array(string()),\n  'BIP-32 path',\n  (path: string[]) => {\n    if (path.length === 0) {\n      return 'Path must be a non-empty BIP-32 derivation path array';\n    }\n\n    if (path[0] !== 'm') {\n      return 'Path must start with \"m\".';\n    }\n\n    if (path.length < 3) {\n      return 'Paths must have a length of at least three.';\n    }\n\n    if (path.slice(1).some((part) => !isValidBIP32PathSegment(part))) {\n      return 'Path must be a valid BIP-32 derivation path array.';\n    }\n\n    if (FORBIDDEN_PURPOSES.includes(path[1])) {\n      return `The purpose \"${path[1]}\" is not allowed for entropy derivation.`;\n    }\n\n    if (\n      FORBIDDEN_PATHS.some((forbiddenPath) =>\n        isEqual(path.slice(0, forbiddenPath.length), forbiddenPath),\n      )\n    ) {\n      return `The path \"${path.join(\n        '/',\n      )}\" is not allowed for entropy derivation.`;\n    }\n\n    return true;\n  },\n);\n\nexport const bip32entropy = <\n  Type extends { path: string[]; curve: string },\n  Schema,\n>(\n  struct: Struct<Type, Schema>,\n) =>\n  refine(struct, 'BIP-32 entropy', (value) => {\n    if (\n      value.curve === 'ed25519' &&\n      value.path.slice(1).some((part) => !part.endsWith(\"'\"))\n    ) {\n      return 'Ed25519 does not support unhardened paths.';\n    }\n\n    return true;\n  });\n\n// Used outside @metamask/snap-utils\nexport const Bip32EntropyStruct = bip32entropy(\n  type({\n    path: Bip32PathStruct,\n    curve: enums(['ed25519', 'secp256k1']),\n  }),\n);\n\nexport type Bip32Entropy = Infer<typeof Bip32EntropyStruct>;\n\nexport const SnapGetBip32EntropyPermissionsStruct = size(\n  array(Bip32EntropyStruct),\n  1,\n  Infinity,\n);\n\nexport const SemVerRangeStruct = refine(string(), 'SemVer range', (value) => {\n  if (isValidSemVerRange(value)) {\n    return true;\n  }\n  return 'Expected a valid SemVer range.';\n});\n\nexport const SnapIdsStruct = refine(\n  record(SnapIdStruct, object({ version: optional(SemVerRangeStruct) })),\n  'SnapIds',\n  (value) => {\n    if (Object.keys(value).length === 0) {\n      return false;\n    }\n\n    return true;\n  },\n);\n\nexport type SnapIds = Infer<typeof SnapIdsStruct>;\n\nexport const ChainIdsStruct = size(array(ChainIdStruct), 1, Infinity);\n\nexport const LookupMatchersStruct = union([\n  object({\n    tlds: size(array(string()), 1, Infinity),\n  }),\n  object({\n    schemes: size(array(string()), 1, Infinity),\n  }),\n  object({\n    tlds: size(array(string()), 1, Infinity),\n    schemes: size(array(string()), 1, Infinity),\n  }),\n]);\n\nexport const MINIMUM_REQUEST_TIMEOUT = inMilliseconds(5, Duration.Second);\nexport const MAXIMUM_REQUEST_TIMEOUT = inMilliseconds(3, Duration.Minute);\n\nexport const MaxRequestTimeStruct = size(\n  integer(),\n  MINIMUM_REQUEST_TIMEOUT,\n  MAXIMUM_REQUEST_TIMEOUT,\n);\n\n// Utility type to union with for all handler structs\nexport const HandlerCaveatsStruct = object({\n  maxRequestTime: optional(MaxRequestTimeStruct),\n});\n\nexport type HandlerCaveats = Infer<typeof HandlerCaveatsStruct>;\n\n/* eslint-disable @typescript-eslint/naming-convention */\nexport const PermissionsStruct = type({\n  'endowment:cronjob': optional(\n    assign(\n      HandlerCaveatsStruct,\n      object({ jobs: CronjobSpecificationArrayStruct }),\n    ),\n  ),\n  'endowment:ethereum-provider': optional(object({})),\n  'endowment:keyring': optional(\n    assign(HandlerCaveatsStruct, KeyringOriginsStruct),\n  ),\n  'endowment:lifecycle-hooks': optional(HandlerCaveatsStruct),\n  'endowment:name-lookup': optional(\n    assign(\n      HandlerCaveatsStruct,\n      object({\n        chains: optional(ChainIdsStruct),\n        matchers: optional(LookupMatchersStruct),\n      }),\n    ),\n  ),\n  'endowment:network-access': optional(object({})),\n  'endowment:page-home': optional(HandlerCaveatsStruct),\n  'endowment:rpc': optional(RpcOriginsStruct),\n  'endowment:signature-insight': optional(\n    assign(\n      HandlerCaveatsStruct,\n      object({\n        allowSignatureOrigin: optional(boolean()),\n      }),\n    ),\n  ),\n  'endowment:transaction-insight': optional(\n    assign(\n      HandlerCaveatsStruct,\n      object({\n        allowTransactionOrigin: optional(boolean()),\n      }),\n    ),\n  ),\n  'endowment:webassembly': optional(object({})),\n  snap_dialog: optional(object({})),\n  snap_manageState: optional(object({})),\n  snap_manageAccounts: optional(object({})),\n  snap_notify: optional(object({})),\n  snap_getBip32Entropy: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip32PublicKey: optional(SnapGetBip32EntropyPermissionsStruct),\n  snap_getBip44Entropy: optional(\n    size(\n      array(object({ coinType: size(integer(), 0, 2 ** 32 - 1) })),\n      1,\n      Infinity,\n    ),\n  ),\n  snap_getEntropy: optional(object({})),\n  snap_getLocale: optional(object({})),\n  wallet_snap: optional(SnapIdsStruct),\n});\n/* eslint-enable @typescript-eslint/naming-convention */\n\nexport type SnapPermissions = InferMatching<\n  typeof PermissionsStruct,\n  InitialPermissions\n>;\n\nexport const SnapAuxilaryFilesStruct = array(string());\n\nexport const InitialConnectionsStruct = record(\n  intersection([string(), uri()]),\n  object({}),\n);\n\nexport type InitialConnections = Infer<typeof InitialConnectionsStruct>;\n\nexport const SnapManifestStruct = object({\n  version: VersionStruct,\n  description: size(string(), 1, 280),\n  proposedName: size(string(), 1, 214),\n  repository: optional(\n    object({\n      type: size(string(), 1, Infinity),\n      url: size(string(), 1, Infinity),\n    }),\n  ),\n  source: object({\n    shasum: ChecksumStruct,\n    location: object({\n      npm: object({\n        filePath: size(string(), 1, Infinity),\n        iconPath: optional(size(string(), 1, Infinity)),\n        packageName: NameStruct,\n        registry: union([\n          literal('https://registry.npmjs.org'),\n          literal('https://registry.npmjs.org/'),\n        ]),\n      }),\n    }),\n    files: optional(SnapAuxilaryFilesStruct),\n    locales: optional(SnapAuxilaryFilesStruct),\n  }),\n  initialConnections: optional(InitialConnectionsStruct),\n  initialPermissions: PermissionsStruct,\n  manifestVersion: literal('0.1'),\n  $schema: optional(string()), // enables JSON-Schema linting in VSC and other IDEs\n});\n\nexport type SnapManifest = Infer<typeof SnapManifestStruct>;\n\n/**\n * Check if the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link SnapManifest} object.\n */\nexport function isSnapManifest(value: unknown): value is SnapManifest {\n  return is(value, SnapManifestStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link SnapManifest} object.\n *\n * @param value - The value to check.\n * @throws If the value is not a valid {@link SnapManifest} object.\n */\nexport function assertIsSnapManifest(\n  value: unknown,\n): asserts value is SnapManifest {\n  assertStruct(\n    value,\n    SnapManifestStruct,\n    `\"${NpmSnapFileNames.Manifest}\" is invalid`,\n  );\n}\n\n/**\n * Creates a {@link SnapManifest} object from JSON.\n *\n * @param value - The value to check.\n * @throws If the value cannot be coerced to a {@link SnapManifest} object.\n * @returns The created {@link SnapManifest} object.\n */\nexport function createSnapManifest(value: unknown): SnapManifest {\n  // TODO: Add a utility to prefix these errors similar to assertStruct\n  return create(value, SnapManifestStruct);\n}\n"],"names":["isValidBIP32PathSegment","assertStruct","ChecksumStruct","VersionStruct","isValidSemVerRange","inMilliseconds","Duration","array","boolean","create","enums","integer","is","literal","object","optional","refine","record","size","string","type","union","intersection","assign","isEqual","CronjobSpecificationArrayStruct","SIP_6_MAGIC_VALUE","STATE_ENCRYPTION_MAGIC_VALUE","KeyringOriginsStruct","RpcOriginsStruct","ChainIdStruct","SnapIdStruct","NameStruct","NpmSnapFileNames","uri","FORBIDDEN_PURPOSES","FORBIDDEN_COIN_TYPES","FORBIDDEN_PATHS","map","coinType","Bip32PathStruct","path","length","slice","some","part","includes","forbiddenPath","join","bip32entropy","struct","value","curve","endsWith","Bip32EntropyStruct","SnapGetBip32EntropyPermissionsStruct","Infinity","SemVerRangeStruct","SnapIdsStruct","version","Object","keys","ChainIdsStruct","LookupMatchersStruct","tlds","schemes","MINIMUM_REQUEST_TIMEOUT","Second","MAXIMUM_REQUEST_TIMEOUT","Minute","MaxRequestTimeStruct","HandlerCaveatsStruct","maxRequestTime","PermissionsStruct","jobs","chains","matchers","allowSignatureOrigin","allowTransactionOrigin","snap_dialog","snap_manageState","snap_manageAccounts","snap_notify","snap_getBip32Entropy","snap_getBip32PublicKey","snap_getBip44Entropy","snap_getEntropy","snap_getLocale","wallet_snap","SnapAuxilaryFilesStruct","InitialConnectionsStruct","SnapManifestStruct","description","proposedName","repository","url","source","shasum","location","npm","filePath","iconPath","packageName","registry","files","locales","initialConnections","initialPermissions","manifestVersion","$schema","isSnapManifest","assertIsSnapManifest","Manifest","createSnapManifest"],"mappings":"AAAA,SAASA,uBAAuB,QAAQ,qBAAqB;AAE7D,SACEC,YAAY,EACZC,cAAc,EACdC,aAAa,EACbC,kBAAkB,EAClBC,cAAc,EACdC,QAAQ,QACH,kBAAkB;AAEzB,SACEC,KAAK,EACLC,OAAO,EACPC,MAAM,EACNC,KAAK,EACLC,OAAO,EACPC,EAAE,EACFC,OAAO,EACPC,MAAM,EACNC,QAAQ,EACRC,MAAM,EACNC,MAAM,EACNC,IAAI,EACJC,MAAM,EACNC,IAAI,EACJC,KAAK,EACLC,YAAY,EACZC,MAAM,QACD,cAAc;AAErB,SAASC,OAAO,QAAQ,WAAW;AACnC,SAASC,+BAA+B,QAAQ,aAAa;AAC7D,SAASC,iBAAiB,EAAEC,4BAA4B,QAAQ,aAAa;AAC7E,SAASC,oBAAoB,EAAEC,gBAAgB,QAAQ,cAAc;AACrE,SAASC,aAAa,QAAQ,eAAe;AAC7C,SAASC,YAAY,QAAQ,WAAW;AAExC,SAASC,UAAU,EAAEC,gBAAgB,EAAEC,GAAG,QAAQ,WAAW;AAE7D,+EAA+E;AAC/E,gCAAgC;AAChC,MAAMC,qBAA+B;IACnCT;IACAC;CACD;AAED,OAAO,MAAMS,uBAAiC;IAAC;CAAG,CAAC;AACnD,MAAMC,kBAA8BD,qBAAqBE,GAAG,CAAC,CAACC,WAAa;QACzE;QACA;QACA,CAAC,EAAEA,SAAS,CAAC,CAAC;KACf;AAED,OAAO,MAAMC,kBAAkBxB,OAC7BT,MAAMY,WACN,eACA,CAACsB;IACC,IAAIA,KAAKC,MAAM,KAAK,GAAG;QACrB,OAAO;IACT;IAEA,IAAID,IAAI,CAAC,EAAE,KAAK,KAAK;QACnB,OAAO;IACT;IAEA,IAAIA,KAAKC,MAAM,GAAG,GAAG;QACnB,OAAO;IACT;IAEA,IAAID,KAAKE,KAAK,CAAC,GAAGC,IAAI,CAAC,CAACC,OAAS,CAAC7C,wBAAwB6C,QAAQ;QAChE,OAAO;IACT;IAEA,IAAIV,mBAAmBW,QAAQ,CAACL,IAAI,CAAC,EAAE,GAAG;QACxC,OAAO,CAAC,aAAa,EAAEA,IAAI,CAAC,EAAE,CAAC,wCAAwC,CAAC;IAC1E;IAEA,IACEJ,gBAAgBO,IAAI,CAAC,CAACG,gBACpBvB,QAAQiB,KAAKE,KAAK,CAAC,GAAGI,cAAcL,MAAM,GAAGK,iBAE/C;QACA,OAAO,CAAC,UAAU,EAAEN,KAAKO,IAAI,CAC3B,KACA,wCAAwC,CAAC;IAC7C;IAEA,OAAO;AACT,GACA;AAEF,OAAO,MAAMC,eAAe,CAI1BC,SAEAlC,OAAOkC,QAAQ,kBAAkB,CAACC;QAChC,IACEA,MAAMC,KAAK,KAAK,aAChBD,MAAMV,IAAI,CAACE,KAAK,CAAC,GAAGC,IAAI,CAAC,CAACC,OAAS,CAACA,KAAKQ,QAAQ,CAAC,OAClD;YACA,OAAO;QACT;QAEA,OAAO;IACT,GAAG;AAEL,oCAAoC;AACpC,OAAO,MAAMC,qBAAqBL,aAChC7B,KAAK;IACHqB,MAAMD;IACNY,OAAO1C,MAAM;QAAC;QAAW;KAAY;AACvC,IACA;AAIF,OAAO,MAAM6C,uCAAuCrC,KAClDX,MAAM+C,qBACN,GACAE,UACA;AAEF,OAAO,MAAMC,oBAAoBzC,OAAOG,UAAU,gBAAgB,CAACgC;IACjE,IAAI/C,mBAAmB+C,QAAQ;QAC7B,OAAO;IACT;IACA,OAAO;AACT,GAAG;AAEH,OAAO,MAAMO,gBAAgB1C,OAC3BC,OAAOc,cAAcjB,OAAO;IAAE6C,SAAS5C,SAAS0C;AAAmB,KACnE,WACA,CAACN;IACC,IAAIS,OAAOC,IAAI,CAACV,OAAOT,MAAM,KAAK,GAAG;QACnC,OAAO;IACT;IAEA,OAAO;AACT,GACA;AAIF,OAAO,MAAMoB,iBAAiB5C,KAAKX,MAAMuB,gBAAgB,GAAG0B,UAAU;AAEtE,OAAO,MAAMO,uBAAuB1C,MAAM;IACxCP,OAAO;QACLkD,MAAM9C,KAAKX,MAAMY,WAAW,GAAGqC;IACjC;IACA1C,OAAO;QACLmD,SAAS/C,KAAKX,MAAMY,WAAW,GAAGqC;IACpC;IACA1C,OAAO;QACLkD,MAAM9C,KAAKX,MAAMY,WAAW,GAAGqC;QAC/BS,SAAS/C,KAAKX,MAAMY,WAAW,GAAGqC;IACpC;CACD,EAAE;AAEH,OAAO,MAAMU,0BAA0B7D,eAAe,GAAGC,SAAS6D,MAAM,EAAE;AAC1E,OAAO,MAAMC,0BAA0B/D,eAAe,GAAGC,SAAS+D,MAAM,EAAE;AAE1E,OAAO,MAAMC,uBAAuBpD,KAClCP,WACAuD,yBACAE,yBACA;AAEF,qDAAqD;AACrD,OAAO,MAAMG,uBAAuBzD,OAAO;IACzC0D,gBAAgBzD,SAASuD;AAC3B,GAAG;AAIH,uDAAuD,GACvD,OAAO,MAAMG,oBAAoBrD,KAAK;IACpC,qBAAqBL,SACnBQ,OACEgD,sBACAzD,OAAO;QAAE4D,MAAMjD;IAAgC;IAGnD,+BAA+BV,SAASD,OAAO,CAAC;IAChD,qBAAqBC,SACnBQ,OAAOgD,sBAAsB3C;IAE/B,6BAA6Bb,SAASwD;IACtC,yBAAyBxD,SACvBQ,OACEgD,sBACAzD,OAAO;QACL6D,QAAQ5D,SAAS+C;QACjBc,UAAU7D,SAASgD;IACrB;IAGJ,4BAA4BhD,SAASD,OAAO,CAAC;IAC7C,uBAAuBC,SAASwD;IAChC,iBAAiBxD,SAASc;IAC1B,+BAA+Bd,SAC7BQ,OACEgD,sBACAzD,OAAO;QACL+D,sBAAsB9D,SAASP;IACjC;IAGJ,iCAAiCO,SAC/BQ,OACEgD,sBACAzD,OAAO;QACLgE,wBAAwB/D,SAASP;IACnC;IAGJ,yBAAyBO,SAASD,OAAO,CAAC;IAC1CiE,aAAahE,SAASD,OAAO,CAAC;IAC9BkE,kBAAkBjE,SAASD,OAAO,CAAC;IACnCmE,qBAAqBlE,SAASD,OAAO,CAAC;IACtCoE,aAAanE,SAASD,OAAO,CAAC;IAC9BqE,sBAAsBpE,SAASwC;IAC/B6B,wBAAwBrE,SAASwC;IACjC8B,sBAAsBtE,SACpBG,KACEX,MAAMO,OAAO;QAAEyB,UAAUrB,KAAKP,WAAW,GAAG,KAAK,KAAK;IAAG,KACzD,GACA6C;IAGJ8B,iBAAiBvE,SAASD,OAAO,CAAC;IAClCyE,gBAAgBxE,SAASD,OAAO,CAAC;IACjC0E,aAAazE,SAAS2C;AACxB,GAAG;AAQH,OAAO,MAAM+B,0BAA0BlF,MAAMY,UAAU;AAEvD,OAAO,MAAMuE,2BAA2BzE,OACtCK,aAAa;IAACH;IAAUe;CAAM,GAC9BpB,OAAO,CAAC,IACR;AAIF,OAAO,MAAM6E,qBAAqB7E,OAAO;IACvC6C,SAASxD;IACTyF,aAAa1E,KAAKC,UAAU,GAAG;IAC/B0E,cAAc3E,KAAKC,UAAU,GAAG;IAChC2E,YAAY/E,SACVD,OAAO;QACLM,MAAMF,KAAKC,UAAU,GAAGqC;QACxBuC,KAAK7E,KAAKC,UAAU,GAAGqC;IACzB;IAEFwC,QAAQlF,OAAO;QACbmF,QAAQ/F;QACRgG,UAAUpF,OAAO;YACfqF,KAAKrF,OAAO;gBACVsF,UAAUlF,KAAKC,UAAU,GAAGqC;gBAC5B6C,UAAUtF,SAASG,KAAKC,UAAU,GAAGqC;gBACrC8C,aAAatE;gBACbuE,UAAUlF,MAAM;oBACdR,QAAQ;oBACRA,QAAQ;iBACT;YACH;QACF;QACA2F,OAAOzF,SAAS0E;QAChBgB,SAAS1F,SAAS0E;IACpB;IACAiB,oBAAoB3F,SAAS2E;IAC7BiB,oBAAoBlC;IACpBmC,iBAAiB/F,QAAQ;IACzBgG,SAAS9F,SAASI;AACpB,GAAG;AAIH;;;;;CAKC,GACD,OAAO,SAAS2F,eAAe3D,KAAc;IAC3C,OAAOvC,GAAGuC,OAAOwC;AACnB;AAEA;;;;;CAKC,GACD,OAAO,SAASoB,qBACd5D,KAAc;IAEdlD,aACEkD,OACAwC,oBACA,CAAC,CAAC,EAAE1D,iBAAiB+E,QAAQ,CAAC,YAAY,CAAC;AAE/C;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,mBAAmB9D,KAAc;IAC/C,qEAAqE;IACrE,OAAO1C,OAAO0C,OAAOwC;AACvB"}

package/dist/esm/post-process.js

@@ -3,7 +3,7 @@ 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["UnsafeMathRandom"] = '`Math.random` was detected in the Snap bundle. This is not a secure source of randomness, and should not be used in a secure context. Use `crypto.getRandomValues` instead.';
 })(PostProcessWarning || (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