@metamask/snaps-utils 5.1.2 → 6.0.0

package/CHANGELOG.md

@@ -6,6 +6,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.0.0]
+### Added
+- Add support for dynamic user interfaces ([#1465](https://github.com/MetaMask/snaps/pull/1465), [#2126](https://github.com/MetaMask/snaps/pull/2126))
+- Add support for snap defined execution timeouts ([#2098](https://github.com/MetaMask/snaps/pull/2098))
+
+### Changed
+- **BREAKING:** Update name lookup type validation ([#2113](https://github.com/MetaMask/snaps/pull/2113))
+  - The return value and the permission format has changed, see [SIP-12](https://metamask.github.io/SIPs/SIPS/sip-12) for more details.
+- Speed up eval-worker for improved CLI performance ([#2147](https://github.com/MetaMask/snaps/pull/2147))
+- Update MetaMask dependencies ([#2132](https://github.com/MetaMask/snaps/pull/2132), [#2142](https://github.com/MetaMask/snaps/pull/2142))
+
+### Fixed
+- Fix initial permissions types ([#2111](https://github.com/MetaMask/snaps/pull/2111))
+
+## [5.2.0]
+### Added
+- Add support for initial connections ([#2048](https://github.com/MetaMask/snaps/pull/2048))
+- Add support for preinstalled snaps ([#2008](https://github.com/MetaMask/snaps/pull/2008))
+- Add support for signature insights ([#2074](https://github.com/MetaMask/snaps/pull/2074))
+
+### Changed
+- Bump several MetaMask dependencies ([#2086](https://github.com/MetaMask/snaps/pull/2086), [#2100](https://github.com/MetaMask/snaps/pull/2100))
+
 ## [5.1.2]
 ### Fixed
 - Fix missing `global` during snap evaluation ([#2072](https://github.com/MetaMask/snaps/pull/2072))
@@ -125,8 +148,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.38.1-flask.1]
 ### Changed
 - Update transaction insights response and add severity level enum ([#1653](https://github.com/MetaMask/snaps/pull/1653))
-   - Snaps are now able to specify a `severity` for alongside their insights.
-   - See [SIP-11](https://metamask.github.io/SIPs/SIPS/sip-11) for more information.
+  - Snaps are now able to specify a `severity` for alongside their insights.
+  - See [SIP-11](https://metamask.github.io/SIPs/SIPS/sip-11) for more information.
 
 ## [0.38.0-flask.1]
 ### Added
@@ -142,7 +165,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.1.2...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@6.0.0...HEAD
+[6.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.2.0...@metamask/snaps-utils@6.0.0
+[5.2.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.1.2...@metamask/snaps-utils@5.2.0
 [5.1.2]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.1.1...@metamask/snaps-utils@5.1.2
 [5.1.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.1.0...@metamask/snaps-utils@5.1.1
 [5.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-utils@5.0.1...@metamask/snaps-utils@5.1.0

package/dist/cjs/caveats.js

@@ -23,6 +23,9 @@ var SnapCaveatType;
    * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.
    */ "TransactionOrigin"] = 'transactionOrigin';
     SnapCaveatType[/**
+   * Caveat specifying access to the signature origin, used by `endowment:signature-insight`.
+   */ "SignatureOrigin"] = 'signatureOrigin';
+    SnapCaveatType[/**
    * The origins that a Snap can receive JSON-RPC messages from.
    */ "RpcOrigin"] = 'rpcOrigin';
     SnapCaveatType[/**
@@ -34,6 +37,12 @@ var SnapCaveatType;
     SnapCaveatType[/**
    * Caveat specifying the CAIP-2 chain IDs that a snap can service, currently limited to `endowment:name-lookup`.
    */ "ChainIds"] = 'chainIds';
+    SnapCaveatType[/**
+   * Caveat specifying the input that a name lookup snap can service, currently limited to `endowment:name-lookup`.
+   */ "LookupMatchers"] = 'lookupMatchers';
+    SnapCaveatType[/**
+   * Caveat specifying the max request time for a handler endowment.
+   */ "MaxRequestTime"] = 'maxRequestTime';
 })(SnapCaveatType || (SnapCaveatType = {}));
 
 //# sourceMappingURL=caveats.js.map

package/dist/cjs/caveats.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/caveats.ts"],"sourcesContent":["export enum SnapCaveatType {\n  /**\n   * Permitted derivation paths, used by `snap_getBip32Entropy`.\n   */\n  PermittedDerivationPaths = 'permittedDerivationPaths',\n\n  /**\n   * Permitted coin types, used by `snap_getBip44Entropy`.\n   */\n  PermittedCoinTypes = 'permittedCoinTypes',\n\n  /**\n   * Caveat specifying a snap cronjob.\n   */\n  SnapCronjob = 'snapCronjob',\n\n  /**\n   * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.\n   */\n  TransactionOrigin = 'transactionOrigin',\n\n  /**\n   * The origins that a Snap can receive JSON-RPC messages from.\n   */\n  RpcOrigin = 'rpcOrigin',\n\n  /**\n   * The origins that a Snap can receive keyring messages from.\n   */\n  KeyringOrigin = 'keyringOrigin',\n\n  /**\n   * Caveat specifying the snap IDs that can be interacted with.\n   */\n  SnapIds = 'snapIds',\n\n  /**\n   * Caveat specifying the CAIP-2 chain IDs that a snap can service, currently limited to `endowment:name-lookup`.\n   */\n  ChainIds = 'chainIds',\n}\n"],"names":["SnapCaveatType","PermittedDerivationPaths","PermittedCoinTypes","SnapCronjob","TransactionOrigin","RpcOrigin","KeyringOrigin","SnapIds","ChainIds"],"mappings":";;;;;;;;;;IAAO;UAAKA,cAAc;IAAdA,eACV;;GAEC,GACDC,8BAA2B;IAJjBD,eAMV;;GAEC,GACDE,wBAAqB;IATXF,eAWV;;GAEC,GACDG,iBAAc;IAdJH,eAgBV;;GAEC,GACDI,uBAAoB;IAnBVJ,eAqBV;;GAEC,GACDK,eAAY;IAxBFL,eA0BV;;GAEC,GACDM,mBAAgB;IA7BNN,eA+BV;;GAEC,GACDO,aAAU;IAlCAP,eAoCV;;GAEC,GACDQ,cAAW;GAvCDR,mBAAAA"}
+{"version":3,"sources":["../../src/caveats.ts"],"sourcesContent":["export enum SnapCaveatType {\n  /**\n   * Permitted derivation paths, used by `snap_getBip32Entropy`.\n   */\n  PermittedDerivationPaths = 'permittedDerivationPaths',\n\n  /**\n   * Permitted coin types, used by `snap_getBip44Entropy`.\n   */\n  PermittedCoinTypes = 'permittedCoinTypes',\n\n  /**\n   * Caveat specifying a snap cronjob.\n   */\n  SnapCronjob = 'snapCronjob',\n\n  /**\n   * Caveat specifying access to the transaction origin, used by `endowment:transaction-insight`.\n   */\n  TransactionOrigin = 'transactionOrigin',\n\n  /**\n   * Caveat specifying access to the signature origin, used by `endowment:signature-insight`.\n   */\n  SignatureOrigin = 'signatureOrigin',\n\n  /**\n   * The origins that a Snap can receive JSON-RPC messages from.\n   */\n  RpcOrigin = 'rpcOrigin',\n\n  /**\n   * The origins that a Snap can receive keyring messages from.\n   */\n  KeyringOrigin = 'keyringOrigin',\n\n  /**\n   * Caveat specifying the snap IDs that can be interacted with.\n   */\n  SnapIds = 'snapIds',\n\n  /**\n   * Caveat specifying the CAIP-2 chain IDs that a snap can service, currently limited to `endowment:name-lookup`.\n   */\n  ChainIds = 'chainIds',\n\n  /**\n   * Caveat specifying the input that a name lookup snap can service, currently limited to `endowment:name-lookup`.\n   */\n  LookupMatchers = 'lookupMatchers',\n\n  /**\n   * Caveat specifying the max request time for a handler endowment.\n   */\n  MaxRequestTime = 'maxRequestTime',\n}\n"],"names":["SnapCaveatType","PermittedDerivationPaths","PermittedCoinTypes","SnapCronjob","TransactionOrigin","SignatureOrigin","RpcOrigin","KeyringOrigin","SnapIds","ChainIds","LookupMatchers","MaxRequestTime"],"mappings":";;;;;;;;;;IAAO;UAAKA,cAAc;IAAdA,eACV;;GAEC,GACDC,8BAA2B;IAJjBD,eAMV;;GAEC,GACDE,wBAAqB;IATXF,eAWV;;GAEC,GACDG,iBAAc;IAdJH,eAgBV;;GAEC,GACDI,uBAAoB;IAnBVJ,eAqBV;;GAEC,GACDK,qBAAkB;IAxBRL,eA0BV;;GAEC,GACDM,eAAY;IA7BFN,eA+BV;;GAEC,GACDO,mBAAgB;IAlCNP,eAoCV;;GAEC,GACDQ,aAAU;IAvCAR,eAyCV;;GAEC,GACDS,cAAW;IA5CDT,eA8CV;;GAEC,GACDU,oBAAiB;IAjDPV,eAmDV;;GAEC,GACDW,oBAAiB;GAtDPX,mBAAAA"}

package/dist/cjs/eval-worker.js

@@ -37,6 +37,8 @@ if (invalidExports.length > 0) {
     // eslint-disable-next-line no-console
     console.warn(`Invalid snap exports detected:\n${invalidExports.join('\n')}`);
 }
-setTimeout(()=>process.exit(0), 1000); // Hack to ensure worker exits
+// To ensure the worker exits we explicitly call exit here
+// If we didn't the eval would wait for timers set during Compartment eval
+process.exit(0);
 
 //# sourceMappingURL=eval-worker.js.map

package/dist/cjs/eval-worker.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/eval-worker.ts"],"sourcesContent":["// eslint-disable-next-line import/no-unassigned-import\nimport 'ses/lockdown';\n\nimport { readFileSync } from 'fs';\n\nimport type { HandlerType } from './handler-types';\nimport { SNAP_EXPORT_NAMES } from './handler-types';\nimport { generateMockEndowments } from './mock';\n\ndeclare let lockdown: any, Compartment: any;\n\nlockdown({\n  consoleTaming: 'unsafe',\n  errorTaming: 'unsafe',\n  mathTaming: 'unsafe',\n  dateTaming: 'unsafe',\n  overrideTaming: 'severe',\n\n  // We disable domain taming, because it does not work in certain cases when\n  // running tests. This is unlikely to be a problem in production, because\n  // Node.js domains are deprecated.\n  domainTaming: 'unsafe',\n});\n\nconst snapFilePath = process.argv[2];\n\nconst snapModule: { exports?: any } = { exports: {} };\n\nconst compartment = new Compartment({\n  ...generateMockEndowments(),\n  module: snapModule,\n  exports: snapModule.exports,\n});\n\n// Mirror BaseSnapExecutor\ncompartment.globalThis.self = compartment.globalThis;\ncompartment.globalThis.global = compartment.globalThis;\ncompartment.globalThis.window = compartment.globalThis;\n\ncompartment.evaluate(readFileSync(snapFilePath, 'utf8'));\n\nconst invalidExports = Object.keys(snapModule.exports).filter(\n  (snapExport) => !SNAP_EXPORT_NAMES.includes(snapExport as HandlerType),\n);\n\nif (invalidExports.length > 0) {\n  // eslint-disable-next-line no-console\n  console.warn(`Invalid snap exports detected:\\n${invalidExports.join('\\n')}`);\n}\n\nsetTimeout(() => process.exit(0), 1000); // Hack to ensure worker exits\n"],"names":["lockdown","consoleTaming","errorTaming","mathTaming","dateTaming","overrideTaming","domainTaming","snapFilePath","process","argv","snapModule","exports","compartment","Compartment","generateMockEndowments","module","globalThis","self","global","window","evaluate","readFileSync","invalidExports","Object","keys","filter","snapExport","SNAP_EXPORT_NAMES","includes","length","console","warn","join","setTimeout","exit"],"mappings":"AAAA,uDAAuD;;;;;QAChD;oBAEsB;8BAGK;sBACK;AAIvCA,SAAS;IACPC,eAAe;IACfC,aAAa;IACbC,YAAY;IACZC,YAAY;IACZC,gBAAgB;IAEhB,2EAA2E;IAC3E,yEAAyE;IACzE,kCAAkC;IAClCC,cAAc;AAChB;AAEA,MAAMC,eAAeC,QAAQC,IAAI,CAAC,EAAE;AAEpC,MAAMC,aAAgC;IAAEC,SAAS,CAAC;AAAE;AAEpD,MAAMC,cAAc,IAAIC,YAAY;IAClC,GAAGC,IAAAA,4BAAsB,GAAE;IAC3BC,QAAQL;IACRC,SAASD,WAAWC,OAAO;AAC7B;AAEA,0BAA0B;AAC1BC,YAAYI,UAAU,CAACC,IAAI,GAAGL,YAAYI,UAAU;AACpDJ,YAAYI,UAAU,CAACE,MAAM,GAAGN,YAAYI,UAAU;AACtDJ,YAAYI,UAAU,CAACG,MAAM,GAAGP,YAAYI,UAAU;AAEtDJ,YAAYQ,QAAQ,CAACC,IAAAA,gBAAY,EAACd,cAAc;AAEhD,MAAMe,iBAAiBC,OAAOC,IAAI,CAACd,WAAWC,OAAO,EAAEc,MAAM,CAC3D,CAACC,aAAe,CAACC,+BAAiB,CAACC,QAAQ,CAACF;AAG9C,IAAIJ,eAAeO,MAAM,GAAG,GAAG;IAC7B,sCAAsC;IACtCC,QAAQC,IAAI,CAAC,CAAC,gCAAgC,EAAET,eAAeU,IAAI,CAAC,MAAM,CAAC;AAC7E;AAEAC,WAAW,IAAMzB,QAAQ0B,IAAI,CAAC,IAAI,OAAO,8BAA8B"}
+{"version":3,"sources":["../../src/eval-worker.ts"],"sourcesContent":["// eslint-disable-next-line import/no-unassigned-import\nimport 'ses/lockdown';\n\nimport { readFileSync } from 'fs';\n\nimport type { HandlerType } from './handler-types';\nimport { SNAP_EXPORT_NAMES } from './handler-types';\nimport { generateMockEndowments } from './mock';\n\ndeclare let lockdown: any, Compartment: any;\n\nlockdown({\n  consoleTaming: 'unsafe',\n  errorTaming: 'unsafe',\n  mathTaming: 'unsafe',\n  dateTaming: 'unsafe',\n  overrideTaming: 'severe',\n\n  // We disable domain taming, because it does not work in certain cases when\n  // running tests. This is unlikely to be a problem in production, because\n  // Node.js domains are deprecated.\n  domainTaming: 'unsafe',\n});\n\nconst snapFilePath = process.argv[2];\n\nconst snapModule: { exports?: any } = { exports: {} };\n\nconst compartment = new Compartment({\n  ...generateMockEndowments(),\n  module: snapModule,\n  exports: snapModule.exports,\n});\n\n// Mirror BaseSnapExecutor\ncompartment.globalThis.self = compartment.globalThis;\ncompartment.globalThis.global = compartment.globalThis;\ncompartment.globalThis.window = compartment.globalThis;\n\ncompartment.evaluate(readFileSync(snapFilePath, 'utf8'));\n\nconst invalidExports = Object.keys(snapModule.exports).filter(\n  (snapExport) => !SNAP_EXPORT_NAMES.includes(snapExport as HandlerType),\n);\n\nif (invalidExports.length > 0) {\n  // eslint-disable-next-line no-console\n  console.warn(`Invalid snap exports detected:\\n${invalidExports.join('\\n')}`);\n}\n\n// To ensure the worker exits we explicitly call exit here\n// If we didn't the eval would wait for timers set during Compartment eval\nprocess.exit(0);\n"],"names":["lockdown","consoleTaming","errorTaming","mathTaming","dateTaming","overrideTaming","domainTaming","snapFilePath","process","argv","snapModule","exports","compartment","Compartment","generateMockEndowments","module","globalThis","self","global","window","evaluate","readFileSync","invalidExports","Object","keys","filter","snapExport","SNAP_EXPORT_NAMES","includes","length","console","warn","join","exit"],"mappings":"AAAA,uDAAuD;;;;;QAChD;oBAEsB;8BAGK;sBACK;AAIvCA,SAAS;IACPC,eAAe;IACfC,aAAa;IACbC,YAAY;IACZC,YAAY;IACZC,gBAAgB;IAEhB,2EAA2E;IAC3E,yEAAyE;IACzE,kCAAkC;IAClCC,cAAc;AAChB;AAEA,MAAMC,eAAeC,QAAQC,IAAI,CAAC,EAAE;AAEpC,MAAMC,aAAgC;IAAEC,SAAS,CAAC;AAAE;AAEpD,MAAMC,cAAc,IAAIC,YAAY;IAClC,GAAGC,IAAAA,4BAAsB,GAAE;IAC3BC,QAAQL;IACRC,SAASD,WAAWC,OAAO;AAC7B;AAEA,0BAA0B;AAC1BC,YAAYI,UAAU,CAACC,IAAI,GAAGL,YAAYI,UAAU;AACpDJ,YAAYI,UAAU,CAACE,MAAM,GAAGN,YAAYI,UAAU;AACtDJ,YAAYI,UAAU,CAACG,MAAM,GAAGP,YAAYI,UAAU;AAEtDJ,YAAYQ,QAAQ,CAACC,IAAAA,gBAAY,EAACd,cAAc;AAEhD,MAAMe,iBAAiBC,OAAOC,IAAI,CAACd,WAAWC,OAAO,EAAEc,MAAM,CAC3D,CAACC,aAAe,CAACC,+BAAiB,CAACC,QAAQ,CAACF;AAG9C,IAAIJ,eAAeO,MAAM,GAAG,GAAG;IAC7B,sCAAsC;IACtCC,QAAQC,IAAI,CAAC,CAAC,gCAAgC,EAAET,eAAeU,IAAI,CAAC,MAAM,CAAC;AAC7E;AAEA,0DAA0D;AAC1D,0EAA0E;AAC1ExB,QAAQyB,IAAI,CAAC"}

package/dist/cjs/handler-types.js

@@ -19,6 +19,7 @@ _export(exports, {
 var HandlerType;
 (function(HandlerType) {
     HandlerType["OnRpcRequest"] = 'onRpcRequest';
+    HandlerType["OnSignature"] = 'onSignature';
     HandlerType["OnTransaction"] = 'onTransaction';
     HandlerType["OnCronjob"] = 'onCronjob';
     HandlerType["OnInstall"] = 'onInstall';
@@ -26,6 +27,7 @@ var HandlerType;
     HandlerType["OnNameLookup"] = 'onNameLookup';
     HandlerType["OnKeyringRequest"] = 'onKeyringRequest';
     HandlerType["OnHomePage"] = 'onHomePage';
+    HandlerType["OnUserInput"] = 'onUserInput';
 })(HandlerType || (HandlerType = {}));
 const SNAP_EXPORT_NAMES = Object.values(HandlerType);
 

package/dist/cjs/handler-types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/handler-types.ts"],"sourcesContent":["export enum HandlerType {\n  OnRpcRequest = 'onRpcRequest',\n  OnTransaction = 'onTransaction',\n  OnCronjob = 'onCronjob',\n  OnInstall = 'onInstall',\n  OnUpdate = 'onUpdate',\n  OnNameLookup = 'onNameLookup',\n  OnKeyringRequest = 'onKeyringRequest',\n  OnHomePage = 'onHomePage',\n}\n\nexport type SnapHandler = {\n  /**\n   * The type of handler.\n   */\n  type: HandlerType;\n\n  /**\n   * Whether the handler is required, i.e., whether the request will fail if the\n   * handler is called, but the snap does not export it.\n   *\n   * This is primarily used for the lifecycle handlers, which are optional.\n   */\n  required: boolean;\n\n  /**\n   * Validate the given snap export. This should return a type guard for the\n   * handler type.\n   *\n   * @param snapExport - The export to validate.\n   * @returns Whether the export is valid.\n   */\n  validator: (snapExport: unknown) => boolean;\n};\n\nexport const SNAP_EXPORT_NAMES = Object.values(HandlerType);\n"],"names":["SNAP_EXPORT_NAMES","HandlerType","OnRpcRequest","OnTransaction","OnCronjob","OnInstall","OnUpdate","OnNameLookup","OnKeyringRequest","OnHomePage","Object","values"],"mappings":";;;;;;;;;;;;;;IAmCaA,iBAAiB;eAAjBA;;;IAnCN;UAAKC,WAAW;IAAXA,YACVC,kBAAe;IADLD,YAEVE,mBAAgB;IAFNF,YAGVG,eAAY;IAHFH,YAIVI,eAAY;IAJFJ,YAKVK,cAAW;IALDL,YAMVM,kBAAe;IANLN,YAOVO,sBAAmB;IAPTP,YAQVQ,gBAAa;GARHR,gBAAAA;AAmCL,MAAMD,oBAAoBU,OAAOC,MAAM,CAACV"}
+{"version":3,"sources":["../../src/handler-types.ts"],"sourcesContent":["export enum HandlerType {\n  OnRpcRequest = 'onRpcRequest',\n  OnSignature = 'onSignature',\n  OnTransaction = 'onTransaction',\n  OnCronjob = 'onCronjob',\n  OnInstall = 'onInstall',\n  OnUpdate = 'onUpdate',\n  OnNameLookup = 'onNameLookup',\n  OnKeyringRequest = 'onKeyringRequest',\n  OnHomePage = 'onHomePage',\n  OnUserInput = 'onUserInput',\n}\n\nexport type SnapHandler = {\n  /**\n   * The type of handler.\n   */\n  type: HandlerType;\n\n  /**\n   * Whether the handler is required, i.e., whether the request will fail if the\n   * handler is called, but the snap does not export it.\n   *\n   * This is primarily used for the lifecycle handlers, which are optional.\n   */\n  required: boolean;\n\n  /**\n   * Validate the given snap export. This should return a type guard for the\n   * handler type.\n   *\n   * @param snapExport - The export to validate.\n   * @returns Whether the export is valid.\n   */\n  validator: (snapExport: unknown) => boolean;\n};\n\nexport const SNAP_EXPORT_NAMES = Object.values(HandlerType);\n"],"names":["SNAP_EXPORT_NAMES","HandlerType","OnRpcRequest","OnSignature","OnTransaction","OnCronjob","OnInstall","OnUpdate","OnNameLookup","OnKeyringRequest","OnHomePage","OnUserInput","Object","values"],"mappings":";;;;;;;;;;;;;;IAqCaA,iBAAiB;eAAjBA;;;IArCN;UAAKC,WAAW;IAAXA,YACVC,kBAAe;IADLD,YAEVE,iBAAc;IAFJF,YAGVG,mBAAgB;IAHNH,YAIVI,eAAY;IAJFJ,YAKVK,eAAY;IALFL,YAMVM,cAAW;IANDN,YAOVO,kBAAe;IAPLP,YAQVQ,sBAAmB;IARTR,YASVS,gBAAa;IATHT,YAUVU,iBAAc;GAVJV,gBAAAA;AAqCL,MAAMD,oBAAoBY,OAAOC,MAAM,CAACZ"}

package/dist/cjs/handlers.js

@@ -12,11 +12,44 @@ _export(exports, {
     SNAP_EXPORTS: function() {
         return SNAP_EXPORTS;
     },
+    OnTransactionSeverityResponseStruct: function() {
+        return OnTransactionSeverityResponseStruct;
+    },
+    OnTransactionResponseWithIdStruct: function() {
+        return OnTransactionResponseWithIdStruct;
+    },
+    OnTransactionResponseWithContentStruct: function() {
+        return OnTransactionResponseWithContentStruct;
+    },
     OnTransactionResponseStruct: function() {
         return OnTransactionResponseStruct;
     },
+    OnSignatureResponseStruct: function() {
+        return OnSignatureResponseStruct;
+    },
+    OnHomePageResponseWithContentStruct: function() {
+        return OnHomePageResponseWithContentStruct;
+    },
+    OnHomePageResponseWithIdStruct: function() {
+        return OnHomePageResponseWithIdStruct;
+    },
     OnHomePageResponseStruct: function() {
         return OnHomePageResponseStruct;
+    },
+    AddressResolutionStruct: function() {
+        return AddressResolutionStruct;
+    },
+    DomainResolutionStruct: function() {
+        return DomainResolutionStruct;
+    },
+    AddressResolutionResponseStruct: function() {
+        return AddressResolutionResponseStruct;
+    },
+    DomainResolutionResponseStruct: function() {
+        return DomainResolutionResponseStruct;
+    },
+    OnNameLookupResponseStruct: function() {
+        return OnNameLookupResponseStruct;
     }
 });
 const _snapssdk = require("@metamask/snaps-sdk");
@@ -78,14 +111,63 @@ const SNAP_EXPORTS = {
         validator: (snapExport)=>{
             return typeof snapExport === 'function';
         }
+    },
+    [_handlertypes.HandlerType.OnSignature]: {
+        type: _handlertypes.HandlerType.OnSignature,
+        required: true,
+        validator: (snapExport)=>{
+            return typeof snapExport === 'function';
+        }
+    },
+    [_handlertypes.HandlerType.OnUserInput]: {
+        type: _handlertypes.HandlerType.OnUserInput,
+        required: true,
+        validator: (snapExport)=>{
+            return typeof snapExport === 'function';
+        }
     }
 };
-const OnTransactionResponseStruct = (0, _superstruct.nullable)((0, _superstruct.object)({
-    content: _snapssdk.ComponentStruct,
+const OnTransactionSeverityResponseStruct = (0, _superstruct.object)({
     severity: (0, _superstruct.optional)((0, _superstruct.literal)(_snapssdk.SeverityLevel.Critical))
+});
+const OnTransactionResponseWithIdStruct = (0, _superstruct.assign)(OnTransactionSeverityResponseStruct, (0, _superstruct.object)({
+    id: (0, _superstruct.string)()
 }));
-const OnHomePageResponseStruct = (0, _superstruct.object)({
+const OnTransactionResponseWithContentStruct = (0, _superstruct.assign)(OnTransactionSeverityResponseStruct, (0, _superstruct.object)({
     content: _snapssdk.ComponentStruct
+}));
+const OnTransactionResponseStruct = (0, _superstruct.nullable)((0, _superstruct.union)([
+    OnTransactionResponseWithContentStruct,
+    OnTransactionResponseWithIdStruct
+]));
+const OnSignatureResponseStruct = OnTransactionResponseStruct;
+const OnHomePageResponseWithContentStruct = (0, _superstruct.object)({
+    content: _snapssdk.ComponentStruct
+});
+const OnHomePageResponseWithIdStruct = (0, _superstruct.object)({
+    id: (0, _superstruct.string)()
+});
+const OnHomePageResponseStruct = (0, _superstruct.union)([
+    OnHomePageResponseWithContentStruct,
+    OnHomePageResponseWithIdStruct
+]);
+const AddressResolutionStruct = (0, _superstruct.object)({
+    protocol: (0, _superstruct.string)(),
+    resolvedDomain: (0, _superstruct.string)()
+});
+const DomainResolutionStruct = (0, _superstruct.object)({
+    protocol: (0, _superstruct.string)(),
+    resolvedAddress: (0, _superstruct.string)()
+});
+const AddressResolutionResponseStruct = (0, _superstruct.object)({
+    resolvedDomains: (0, _superstruct.size)((0, _superstruct.array)(AddressResolutionStruct), 1, Infinity)
+});
+const DomainResolutionResponseStruct = (0, _superstruct.object)({
+    resolvedAddresses: (0, _superstruct.size)((0, _superstruct.array)(DomainResolutionStruct), 1, Infinity)
 });
+const OnNameLookupResponseStruct = (0, _superstruct.nullable)((0, _superstruct.union)([
+    AddressResolutionResponseStruct,
+    DomainResolutionResponseStruct
+]));
 
 //# sourceMappingURL=handlers.js.map

package/dist/cjs/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  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} as const;\n\nexport const OnTransactionResponseStruct = nullable(\n  object({\n    content: ComponentStruct,\n    severity: optional(literal(SeverityLevel.Critical)),\n  }),\n);\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":["SNAP_EXPORTS","OnTransactionResponseStruct","OnHomePageResponseStruct","HandlerType","OnRpcRequest","type","required","validator","snapExport","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","nullable","object","content","ComponentStruct","severity","optional","literal","SeverityLevel","Critical"],"mappings":";;;;;;;;;;;IAsBaA,YAAY;eAAZA;;IA2DAC,2BAA2B;eAA3BA;;IAOAC,wBAAwB;eAAxBA;;;0BA9EkC;6BACK;8BAGxB;AAQrB,MAAMF,eAAe;IAC1B,CAACG,yBAAW,CAACC,YAAY,CAAC,EAAE;QAC1BC,MAAMF,yBAAW,CAACC,YAAY;QAC9BE,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACM,aAAa,CAAC,EAAE;QAC3BJ,MAAMF,yBAAW,CAACM,aAAa;QAC/BH,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACO,SAAS,CAAC,EAAE;QACvBL,MAAMF,yBAAW,CAACO,SAAS;QAC3BJ,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACQ,YAAY,CAAC,EAAE;QAC1BN,MAAMF,yBAAW,CAACQ,YAAY;QAC9BL,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACS,SAAS,CAAC,EAAE;QACvBP,MAAMF,yBAAW,CAACS,SAAS;QAC3BN,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACU,QAAQ,CAAC,EAAE;QACtBR,MAAMF,yBAAW,CAACU,QAAQ;QAC1BP,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACW,gBAAgB,CAAC,EAAE;QAC9BT,MAAMF,yBAAW,CAACW,gBAAgB;QAClCR,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACY,UAAU,CAAC,EAAE;QACxBV,MAAMF,yBAAW,CAACY,UAAU;QAC5BT,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;AACF;AAEO,MAAMP,8BAA8Be,IAAAA,qBAAQ,EACjDC,IAAAA,mBAAM,EAAC;IACLC,SAASC,yBAAe;IACxBC,UAAUC,IAAAA,qBAAQ,EAACC,IAAAA,oBAAO,EAACC,uBAAa,CAACC,QAAQ;AACnD;AAGK,MAAMtB,2BAA2Be,IAAAA,mBAAM,EAAC;IAC7CC,SAASC,yBAAe;AAC1B"}
+{"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":["SNAP_EXPORTS","OnTransactionSeverityResponseStruct","OnTransactionResponseWithIdStruct","OnTransactionResponseWithContentStruct","OnTransactionResponseStruct","OnSignatureResponseStruct","OnHomePageResponseWithContentStruct","OnHomePageResponseWithIdStruct","OnHomePageResponseStruct","AddressResolutionStruct","DomainResolutionStruct","AddressResolutionResponseStruct","DomainResolutionResponseStruct","OnNameLookupResponseStruct","HandlerType","OnRpcRequest","type","required","validator","snapExport","OnTransaction","OnCronjob","OnNameLookup","OnInstall","OnUpdate","OnKeyringRequest","OnHomePage","OnSignature","OnUserInput","object","severity","optional","literal","SeverityLevel","Critical","assign","id","string","content","ComponentStruct","nullable","union","protocol","resolvedDomain","resolvedAddress","resolvedDomains","size","array","Infinity","resolvedAddresses"],"mappings":";;;;;;;;;;;IAkCaA,YAAY;eAAZA;;IAyEAC,mCAAmC;eAAnCA;;IAIAC,iCAAiC;eAAjCA;;IAOAC,sCAAsC;eAAtCA;;IAOAC,2BAA2B;eAA3BA;;IAOAC,yBAAyB;eAAzBA;;IAEAC,mCAAmC;eAAnCA;;IAIAC,8BAA8B;eAA9BA;;IAIAC,wBAAwB;eAAxBA;;IAKAC,uBAAuB;eAAvBA;;IAKAC,sBAAsB;eAAtBA;;IAKAC,+BAA+B;eAA/BA;;IAIAC,8BAA8B;eAA9BA;;IAIAC,0BAA0B;eAA1BA;;;0BAzJkC;6BAWxC;8BAGqB;AAQrB,MAAMb,eAAe;IAC1B,CAACc,yBAAW,CAACC,YAAY,CAAC,EAAE;QAC1BC,MAAMF,yBAAW,CAACC,YAAY;QAC9BE,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACM,aAAa,CAAC,EAAE;QAC3BJ,MAAMF,yBAAW,CAACM,aAAa;QAC/BH,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACO,SAAS,CAAC,EAAE;QACvBL,MAAMF,yBAAW,CAACO,SAAS;QAC3BJ,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACQ,YAAY,CAAC,EAAE;QAC1BN,MAAMF,yBAAW,CAACQ,YAAY;QAC9BL,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACS,SAAS,CAAC,EAAE;QACvBP,MAAMF,yBAAW,CAACS,SAAS;QAC3BN,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACU,QAAQ,CAAC,EAAE;QACtBR,MAAMF,yBAAW,CAACU,QAAQ;QAC1BP,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACW,gBAAgB,CAAC,EAAE;QAC9BT,MAAMF,yBAAW,CAACW,gBAAgB;QAClCR,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACY,UAAU,CAAC,EAAE;QACxBV,MAAMF,yBAAW,CAACY,UAAU;QAC5BT,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACa,WAAW,CAAC,EAAE;QACzBX,MAAMF,yBAAW,CAACa,WAAW;QAC7BV,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;IACA,CAACL,yBAAW,CAACc,WAAW,CAAC,EAAE;QACzBZ,MAAMF,yBAAW,CAACc,WAAW;QAC7BX,UAAU;QACVC,WAAW,CAACC;YACV,OAAO,OAAOA,eAAe;QAC/B;IACF;AACF;AAEO,MAAMlB,sCAAsC4B,IAAAA,mBAAM,EAAC;IACxDC,UAAUC,IAAAA,qBAAQ,EAACC,IAAAA,oBAAO,EAACC,uBAAa,CAACC,QAAQ;AACnD;AAEO,MAAMhC,oCAAoCiC,IAAAA,mBAAM,EACrDlC,qCACA4B,IAAAA,mBAAM,EAAC;IACLO,IAAIC,IAAAA,mBAAM;AACZ;AAGK,MAAMlC,yCAAyCgC,IAAAA,mBAAM,EAC1DlC,qCACA4B,IAAAA,mBAAM,EAAC;IACLS,SAASC,yBAAe;AAC1B;AAGK,MAAMnC,8BAA8BoC,IAAAA,qBAAQ,EACjDC,IAAAA,kBAAK,EAAC;IACJtC;IACAD;CACD;AAGI,MAAMG,4BAA4BD;AAElC,MAAME,sCAAsCuB,IAAAA,mBAAM,EAAC;IACxDS,SAASC,yBAAe;AAC1B;AAEO,MAAMhC,iCAAiCsB,IAAAA,mBAAM,EAAC;IACnDO,IAAIC,IAAAA,mBAAM;AACZ;AAEO,MAAM7B,2BAA2BiC,IAAAA,kBAAK,EAAC;IAC5CnC;IACAC;CACD;AAEM,MAAME,0BAA0BoB,IAAAA,mBAAM,EAAC;IAC5Ca,UAAUL,IAAAA,mBAAM;IAChBM,gBAAgBN,IAAAA,mBAAM;AACxB;AAEO,MAAM3B,yBAAyBmB,IAAAA,mBAAM,EAAC;IAC3Ca,UAAUL,IAAAA,mBAAM;IAChBO,iBAAiBP,IAAAA,mBAAM;AACzB;AAEO,MAAM1B,kCAAkCkB,IAAAA,mBAAM,EAAC;IACpDgB,iBAAiBC,IAAAA,iBAAI,EAACC,IAAAA,kBAAK,EAACtC,0BAA0B,GAAGuC;AAC3D;AAEO,MAAMpC,iCAAiCiB,IAAAA,mBAAM,EAAC;IACnDoB,mBAAmBH,IAAAA,iBAAI,EAACC,IAAAA,kBAAK,EAACrC,yBAAyB,GAAGsC;AAC5D;AAEO,MAAMnC,6BAA6B2B,IAAAA,qBAAQ,EAChDC,IAAAA,kBAAK,EAAC;IAAC9B;IAAiCC;CAA+B"}

package/dist/cjs/manifest/manifest.js

@@ -57,8 +57,9 @@ const MANIFEST_SORT_ORDER = {
     proposedName: 4,
     repository: 5,
     source: 6,
-    initialPermissions: 7,
-    manifestVersion: 8
+    initialConnections: 7,
+    initialPermissions: 8,
+    manifestVersion: 9
 };
 async function checkManifest(basePath, writeManifest = true, sourceCode, writeFileFn = _fs.promises.writeFile) {
     const warnings = [];

package/dist/cjs/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  initialPermissions: 7,\n  manifestVersion: 8,\n};\n\n/**\n * The result from the `checkManifest` function.\n *\n * @property manifest - The fixed manifest object.\n * @property updated - Whether the manifest was updated.\n * @property warnings - An array of warnings that were encountered during\n * processing of the manifest files. These warnings are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n * @property errors - An array of errors that were encountered during\n * processing of the manifest files. These errors are not logged to the\n * console automatically, so depending on the environment the function is called\n * in, a different method for logging can be used.\n */\nexport type CheckManifestResult = {\n  manifest: SnapManifest;\n  updated?: boolean;\n  warnings: string[];\n  errors: string[];\n};\n\nexport type WriteFileFunction = (path: string, data: string) => Promise<void>;\n\n/**\n * Validates a snap.manifest.json file. Attempts to fix the manifest and write\n * the fixed version to disk if `writeManifest` is true. Throws if validation\n * fails.\n *\n * @param basePath - The path to the folder with the manifest files.\n * @param writeManifest - Whether to write the fixed manifest to disk.\n * @param sourceCode - The source code of the Snap.\n * @param writeFileFn - The function to use to write the manifest to disk.\n * @returns Whether the manifest was updated, and an array of warnings that\n * were encountered during processing of the manifest files.\n */\nexport async function checkManifest(\n  basePath: string,\n  writeManifest = true,\n  sourceCode?: string,\n  writeFileFn: WriteFileFunction = fs.writeFile,\n): Promise<CheckManifestResult> {\n  const warnings: string[] = [];\n  const errors: string[] = [];\n\n  let updated = false;\n\n  const manifestPath = pathUtils.join(basePath, NpmSnapFileNames.Manifest);\n  const manifestFile = await readJsonFile(manifestPath);\n  const unvalidatedManifest = manifestFile.result;\n\n  const packageFile = await readJsonFile(\n    pathUtils.join(basePath, NpmSnapFileNames.PackageJson),\n  );\n\n  const 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":["checkManifest","fixManifest","getSnapSourceCode","getSnapIcon","getSnapFilePaths","getSnapFiles","getWritableManifest","validateNpmSnapManifest","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialPermissions","manifestVersion","basePath","writeManifest","sourceCode","writeFileFn","fs","writeFile","warnings","errors","updated","manifestPath","pathUtils","join","NpmSnapFileNames","Manifest","manifestFile","readJsonFile","unvalidatedManifest","result","packageFile","PackageJson","auxiliaryFilePaths","manifest","files","localizationFilePaths","locales","snapFiles","packageJson","svgIcon","auxiliaryFiles","localizationFiles","validateNpmSnap","error","ProgrammaticallyFixableSnapError","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","SnapValidationFailureReason","length","attempts","nextValidationError","Error","assert","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","newManifest","JSON","stringify","value","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","deepClone","undefined","ShasumMismatch","shasum","getSnapChecksum","assertExhaustive","isPlainObject","sourceFilePath","filePath","VirtualFile","path","virtualFile","readVirtualFile","getErrorMessage","iconPath","selector","snapManifest","paths","Array","isArray","encoding","Promise","all","map","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository","deepEqual","validateSnapShasum"],"mappings":";;;;;;;;;;;IAkEsBA,aAAa;eAAbA;;IA+JAC,WAAW;eAAXA;;IA8CAC,iBAAiB;eAAjBA;;IA4CAC,WAAW;eAAXA;;IAiCNC,gBAAgB;eAAhBA;;IA2BMC,YAAY;eAAZA;;IA2BNC,mBAAmB;eAAnBA;;IAgCMC,uBAAuB;eAAvBA;;;0BAlbU;uBAEwB;sEAClC;oBACS;6DACT;2BAEI;qBACG;qBACG;uBAKzB;uBAEuD;6BACjB;;;;;;AAG7C,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,iBAAiB;AACnB;AAqCO,eAAehB,cACpBiB,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB,EACnBC,cAAiCC,YAAE,CAACC,SAAS;IAE7C,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAeC,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACC,QAAQ;IACvE,MAAMC,eAAe,MAAMC,IAAAA,iBAAY,EAACN;IACxC,MAAMO,sBAAsBF,aAAaG,MAAM;IAE/C,MAAMC,cAAc,MAAMH,IAAAA,iBAAY,EACpCL,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACO,WAAW;IAGvD,MAAMC,qBAAqBjC,iBACzB6B,qBACA,CAACK,WAAaA,UAAUxB,QAAQyB;IAGlC,MAAMC,wBAAwBpC,iBAC5B6B,qBACA,CAACK,WAAaA,UAAUxB,QAAQ2B;IAGlC,MAAMC,YAAkC;QACtCJ,UAAUP;QACVY,aAAaR;QACbhB,YAAY,MAAMjB,kBAChBe,UACAgB,qBACAd;QAEFyB,SAAS,MAAMzC,YAAYc,UAAUgB;QACrC,6EAA6E;QAC7EY,gBACE,AAAC,MAAMxC,aAAaY,UAAUoB,oBAAoB,SAAU,EAAE;QAChES,mBACE,AAAC,MAAMzC,aAAaY,UAAUuB,0BAA2B,EAAE;IAC/D;IAEA,IAAIF;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAG,MAAMS,IAAAA,oBAAe,EAACL,UAAS;IACjD,EAAE,OAAOM,OAAO;QACd,IAAIA,iBAAiBC,uCAAgC,EAAE;YACrDzB,OAAO0B,IAAI,CAACF,MAAMG,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BV;YAEhC,IAAIW,YAAY;YAChB,IAAIC,eAAeN;YACnB,MAAMO,cAAcC,OAAOC,IAAI,CAACC,kCAA2B,EAAEC,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGP,aAAaO,YAAYL,aAAaK,WAAY;gBACvEtB,WAAW,MAAMrC,YACfqC,WACI;oBAAE,GAAGc,uBAAuB;oBAAEd;gBAAS,IACvCc,yBACJE;gBAGF,IAAI;oBACF,MAAM/C,wBAAwB;wBAC5B,GAAG6C,uBAAuB;wBAC1Bd;oBACF;oBAEAe,YAAY;gBACd,EAAE,OAAOQ,qBAAqB;oBAC5BP,eAAeO;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+BZ,uCAAgC,AAAD,KAE/DW,aAAaL,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIS,MACR,CAAC,kFAAkF,EAAEd,MAAMG,OAAO,CAAC,CAAC;oBAExG;oBAEA3B,OAAO0B,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEA1B,UAAU;QACZ,OAAO;YACL,MAAMuB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1Ce,IAAAA,aAAM,EAACzB;IAEP,MAAM0B,oBAAoB1B,SAASJ,MAAM;IAEzC,qCAAqC;IACrC,MAAM+B,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBP,MAAM,GAAG,GAAG;QACvCpC,SAAS2B,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,IAAIrD,eAAe;QACjB,IAAI;YACF,MAAMsD,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnCpE,oBAAoB0D,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAIvC,WAAW+C,gBAAgBzC,aAAa4C,KAAK,EAAE;gBACjD,MAAMvD,YACJO,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACC,QAAQ,GAClD0C;YAEJ;QACF,EAAE,OAAOxB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAMG,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEb,UAAU0B;QAAmBvC;QAASF;QAAUC;IAAO;AAClE;AAWO,eAAevB,YACpByC,SAAoB,EACpBM,KAAuC;IAEvC,MAAM,EAAEV,QAAQ,EAAEK,WAAW,EAAE,GAAGD;IAClC,MAAMkC,aAAatC,SAASuC,KAAK;IACjC,MAAMC,eAAeF,WAAW1C,MAAM;IAEtC,OAAQc,MAAM+B,MAAM;QAClB,KAAKrB,kCAA2B,CAACsB,YAAY;YAC3CF,aAAahE,MAAM,CAACmE,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAGxC,YAAYT,MAAM,CAACkD,IAAI;YACtE;QAEF,KAAK1B,kCAA2B,CAAC2B,eAAe;YAC9CP,aAAapE,OAAO,GAAGiC,YAAYT,MAAM,CAACxB,OAAO;YACjD;QAEF,KAAKgD,kCAA2B,CAAC4B,kBAAkB;YACjDR,aAAajE,UAAU,GAAG8B,YAAYT,MAAM,CAACrB,UAAU,GACnD0E,IAAAA,oBAAS,EAAC5C,YAAYT,MAAM,CAACrB,UAAU,IACvC2E;YACJ;QAEF,KAAK9B,kCAA2B,CAAC+B,cAAc;YAC7CX,aAAahE,MAAM,CAAC4E,MAAM,GAAG,MAAMC,IAAAA,sBAAe,EAACjD;YACnD;QAEF,wBAAwB,GACxB;YACEkD,IAAAA,uBAAgB,EAAC5C,MAAM+B,MAAM;IACjC;IAEAH,WAAW1C,MAAM,GAAG4C;IACpBF,WAAWD,KAAK,GAAGF,KAAKC,SAAS,CAACI;IAClC,OAAOF;AACT;AAWO,eAAe1E,kBACpBe,QAAgB,EAChBqB,QAAc,EACdnB,UAAmB;IAEnB,IAAI,CAAC0E,IAAAA,oBAAa,EAACvD,WAAW;QAC5B,OAAOkD;IACT;IAEA,MAAMM,iBAAiB,AAACxD,SAAmCxB,MAAM,EAAEmE,UAC/DC,KAAKa;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAON;IACT;IAEA,IAAIrE,YAAY;QACd,OAAO,IAAI6E,wBAAW,CAAC;YACrBC,MAAMtE,aAAS,CAACC,IAAI,CAACX,UAAU6E;YAC/BnB,OAAOxD;QACT;IACF;IAEA,IAAI;QACF,MAAM+E,cAAc,MAAMC,IAAAA,4BAAe,EACvCxE,aAAS,CAACC,IAAI,CAACX,UAAU6E,iBACzB;QAEF,OAAOI;IACT,EAAE,OAAOlD,OAAO;QACd,MAAM,IAAIc,MACR,CAAC,iCAAiC,EAAEsC,IAAAA,yBAAe,EAACpD,OAAO,CAAC;IAEhE;AACF;AAUO,eAAe7C,YACpBc,QAAgB,EAChBqB,QAAc;IAEd,IAAI,CAACuD,IAAAA,oBAAa,EAACvD,WAAW;QAC5B,OAAOkD;IACT;IAEA,MAAMa,WAAW,AAAC/D,SAAmCxB,MAAM,EAAEmE,UAAUC,KACnEmB;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOb;IACT;IAEA,IAAI;QACF,MAAMU,cAAc,MAAMC,IAAAA,4BAAe,EACvCxE,aAAS,CAACC,IAAI,CAACX,UAAUoF,WACzB;QAEF,OAAOH;IACT,EAAE,OAAOlD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAEsC,IAAAA,yBAAe,EAACpD,OAAO,CAAC;IAC5E;AACF;AASO,SAAS5C,iBACdkC,QAAc,EACdgE,QAAmE;IAEnE,IAAI,CAACT,IAAAA,oBAAa,EAACvD,WAAW;QAC5B,OAAOkD;IACT;IAEA,MAAMe,eAAejE;IACrB,MAAMkE,QAAQF,SAASC;IAEvB,IAAI,CAACE,MAAMC,OAAO,CAACF,QAAQ;QACzB,OAAOhB;IACT;IAEA,OAAOgB;AACT;AAWO,eAAenG,aACpBY,QAAgB,EAChBuF,KAA2B,EAC3BG,WAAkC,MAAM;IAExC,IAAI,CAACH,OAAO;QACV,OAAOhB;IACT;IAEA,IAAI;QACF,OAAO,MAAMoB,QAAQC,GAAG,CACtBL,MAAMM,GAAG,CAAC,OAAOf,WACfI,IAAAA,4BAAe,EAACxE,aAAS,CAACC,IAAI,CAACX,UAAU8E,WAAWY;IAG1D,EAAE,OAAO3D,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,2BAA2B,EAAEsC,IAAAA,yBAAe,EAACpD,OAAO,CAAC;IACxE;AACF;AASO,SAAS1C,oBAAoBgC,QAAsB;IACxD,MAAM,EAAEzB,UAAU,EAAE,GAAGkG,WAAW,GAAGzE;IAErC,MAAMmB,OAAOD,OAAOC,IAAI,CACtB5C,aAAa;QAAE,GAAGkG,SAAS;QAAElG;IAAW,IAAIkG;IAG9C,MAAMC,mBAAmBvD,KACtBwD,IAAI,CAAC,CAACC,GAAGC,IAAM3G,mBAAmB,CAAC0G,EAAE,GAAG1G,mBAAmB,CAAC2G,EAAE,EAC9D9C,MAAM,CACL,CAACnC,QAAQkC,MAAS,CAAA;YAChB,GAAGlC,MAAM;YACT,CAACkC,IAAI,EAAE9B,QAAQ,CAAC8B,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAO4C;AACT;AAcO,eAAezG,wBAAwB,EAC5C+B,QAAQ,EACRK,WAAW,EACXxB,UAAU,EACVyB,OAAO,EACPC,cAAc,EACdC,iBAAiB,EACP;IACV,MAAMsE,kBAAkBzE,YAAYT,MAAM,CAACkD,IAAI;IAC/C,MAAMiC,qBAAqB1E,YAAYT,MAAM,CAACxB,OAAO;IACrD,MAAM4G,wBAAwB3E,YAAYT,MAAM,CAACrB,UAAU;IAE3D,MAAM0G,sBAAsBjF,SAASJ,MAAM,CAACpB,MAAM,CAACmE,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAMqC,yBAAyBlF,SAASJ,MAAM,CAACxB,OAAO;IACtD,MAAM+G,qBAAqBnF,SAASJ,MAAM,CAACrB,UAAU;IAErD,IAAIuG,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAItE,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,qBAAqB,EAAEyF,oBAAoB,uBAAuB,EAAE1F,uBAAgB,CAACO,WAAW,CAAC,iBAAiB,EAAEgF,gBAAgB,GAAG,CAAC,EACtK1D,kCAA2B,CAACsB,YAAY;IAE5C;IAEA,IAAIqC,uBAAuBG,wBAAwB;QACjD,MAAM,IAAIvE,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,wBAAwB,EAAE0F,uBAAuB,uBAAuB,EAAE3F,uBAAgB,CAACO,WAAW,CAAC,oBAAoB,EAAEiF,mBAAmB,GAAG,CAAC,EAClL3D,kCAA2B,CAAC2B,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvDiC,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACC,IAAAA,sBAAS,EAACJ,uBAAuBG,qBAClC;QACA,MAAM,IAAIxE,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,yCAAyC,EAAED,uBAAgB,CAACO,WAAW,CAAC,qBAAqB,CAAC,EAC5HsB,kCAA2B,CAAC4B,kBAAkB;IAElD;IAEA,MAAMqC,IAAAA,yBAAkB,EACtB;QAAErF;QAAUnB;QAAYyB;QAASC;QAAgBC;IAAkB,GACnE,CAAC,CAAC,EAAEjB,uBAAgB,CAACC,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 { 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":["checkManifest","fixManifest","getSnapSourceCode","getSnapIcon","getSnapFilePaths","getSnapFiles","getWritableManifest","validateNpmSnapManifest","MANIFEST_SORT_ORDER","$schema","version","description","proposedName","repository","source","initialConnections","initialPermissions","manifestVersion","basePath","writeManifest","sourceCode","writeFileFn","fs","writeFile","warnings","errors","updated","manifestPath","pathUtils","join","NpmSnapFileNames","Manifest","manifestFile","readJsonFile","unvalidatedManifest","result","packageFile","PackageJson","auxiliaryFilePaths","manifest","files","localizationFilePaths","locales","snapFiles","packageJson","svgIcon","auxiliaryFiles","localizationFiles","validateNpmSnap","error","ProgrammaticallyFixableSnapError","push","message","partiallyValidatedFiles","isInvalid","currentError","maxAttempts","Object","keys","SnapValidationFailureReason","length","attempts","nextValidationError","Error","assert","validatedManifest","recommendedFields","missingRecommendedFields","filter","key","reduce","allMissing","currentField","newManifest","JSON","stringify","value","clonedFile","clone","manifestCopy","reason","NameMismatch","location","npm","packageName","name","VersionMismatch","RepositoryMismatch","deepClone","undefined","ShasumMismatch","shasum","getSnapChecksum","assertExhaustive","isPlainObject","sourceFilePath","filePath","VirtualFile","path","virtualFile","readVirtualFile","getErrorMessage","iconPath","selector","snapManifest","paths","Array","isArray","encoding","Promise","all","map","remaining","writableManifest","sort","a","b","packageJsonName","packageJsonVersion","packageJsonRepository","manifestPackageName","manifestPackageVersion","manifestRepository","deepEqual","validateSnapShasum"],"mappings":";;;;;;;;;;;IAmEsBA,aAAa;eAAbA;;IA+JAC,WAAW;eAAXA;;IA8CAC,iBAAiB;eAAjBA;;IA4CAC,WAAW;eAAXA;;IAiCNC,gBAAgB;eAAhBA;;IA2BMC,YAAY;eAAZA;;IA2BNC,mBAAmB;eAAnBA;;IAgCMC,uBAAuB;eAAvBA;;;0BAnbU;uBAEwB;sEAClC;oBACS;6DACT;2BAEI;qBACG;qBACG;uBAKzB;uBAEuD;6BACjB;;;;;;AAG7C,MAAMC,sBAA0D;IAC9DC,SAAS;IACTC,SAAS;IACTC,aAAa;IACbC,cAAc;IACdC,YAAY;IACZC,QAAQ;IACRC,oBAAoB;IACpBC,oBAAoB;IACpBC,iBAAiB;AACnB;AAqCO,eAAejB,cACpBkB,QAAgB,EAChBC,gBAAgB,IAAI,EACpBC,UAAmB,EACnBC,cAAiCC,YAAE,CAACC,SAAS;IAE7C,MAAMC,WAAqB,EAAE;IAC7B,MAAMC,SAAmB,EAAE;IAE3B,IAAIC,UAAU;IAEd,MAAMC,eAAeC,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACC,QAAQ;IACvE,MAAMC,eAAe,MAAMC,IAAAA,iBAAY,EAACN;IACxC,MAAMO,sBAAsBF,aAAaG,MAAM;IAE/C,MAAMC,cAAc,MAAMH,IAAAA,iBAAY,EACpCL,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACO,WAAW;IAGvD,MAAMC,qBAAqBlC,iBACzB8B,qBACA,CAACK,WAAaA,UAAUzB,QAAQ0B;IAGlC,MAAMC,wBAAwBrC,iBAC5B8B,qBACA,CAACK,WAAaA,UAAUzB,QAAQ4B;IAGlC,MAAMC,YAAkC;QACtCJ,UAAUP;QACVY,aAAaR;QACbhB,YAAY,MAAMlB,kBAChBgB,UACAgB,qBACAd;QAEFyB,SAAS,MAAM1C,YAAYe,UAAUgB;QACrC,6EAA6E;QAC7EY,gBACE,AAAC,MAAMzC,aAAaa,UAAUoB,oBAAoB,SAAU,EAAE;QAChES,mBACE,AAAC,MAAM1C,aAAaa,UAAUuB,0BAA2B,EAAE;IAC/D;IAEA,IAAIF;IACJ,IAAI;QACD,CAAA,EAAEA,QAAQ,EAAE,GAAG,MAAMS,IAAAA,oBAAe,EAACL,UAAS;IACjD,EAAE,OAAOM,OAAO;QACd,IAAIA,iBAAiBC,uCAAgC,EAAE;YACrDzB,OAAO0B,IAAI,CAACF,MAAMG,OAAO;YAEzB,6DAA6D;YAC7D,MAAMC,0BAA0BV;YAEhC,IAAIW,YAAY;YAChB,IAAIC,eAAeN;YACnB,MAAMO,cAAcC,OAAOC,IAAI,CAACC,kCAA2B,EAAEC,MAAM;YAEnE,0EAA0E;YAC1E,uEAAuE;YACvE,oEAAoE;YACpE,uBAAuB;YACvB,IAAK,IAAIC,WAAW,GAAGP,aAAaO,YAAYL,aAAaK,WAAY;gBACvEtB,WAAW,MAAMtC,YACfsC,WACI;oBAAE,GAAGc,uBAAuB;oBAAEd;gBAAS,IACvCc,yBACJE;gBAGF,IAAI;oBACF,MAAMhD,wBAAwB;wBAC5B,GAAG8C,uBAAuB;wBAC1Bd;oBACF;oBAEAe,YAAY;gBACd,EAAE,OAAOQ,qBAAqB;oBAC5BP,eAAeO;oBACf,mDAAmD,GACnD,IACE,CACEA,CAAAA,+BAA+BZ,uCAAgC,AAAD,KAE/DW,aAAaL,eAAe,CAACF,WAC9B;wBACA,MAAM,IAAIS,MACR,CAAC,kFAAkF,EAAEd,MAAMG,OAAO,CAAC,CAAC;oBAExG;oBAEA3B,OAAO0B,IAAI,CAACI,aAAaH,OAAO;gBAClC;YACF;YAEA1B,UAAU;QACZ,OAAO;YACL,MAAMuB;QACR;IACF;IAEA,8EAA8E;IAC9E,0CAA0C;IAC1Ce,IAAAA,aAAM,EAACzB;IAEP,MAAM0B,oBAAoB1B,SAASJ,MAAM;IAEzC,qCAAqC;IACrC,MAAM+B,oBAAoB;QAAC;KAAa;IAExC,MAAMC,2BAA2BD,kBAAkBE,MAAM,CACvD,CAACC,MAAQ,CAACJ,iBAAiB,CAACI,IAAI;IAGlC,IAAIF,yBAAyBP,MAAM,GAAG,GAAG;QACvCpC,SAAS2B,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,IAAIrD,eAAe;QACjB,IAAI;YACF,MAAMsD,cAAc,CAAC,EAAEC,KAAKC,SAAS,CACnCrE,oBAAoB2D,oBACpB,MACA,GACA,EAAE,CAAC;YAEL,IAAIvC,WAAW+C,gBAAgBzC,aAAa4C,KAAK,EAAE;gBACjD,MAAMvD,YACJO,aAAS,CAACC,IAAI,CAACX,UAAUY,uBAAgB,CAACC,QAAQ,GAClD0C;YAEJ;QACF,EAAE,OAAOxB,OAAO;YACd,yEAAyE;YACzE,gCAAgC;YAChC,MAAM,IAAIc,MAAM,CAAC,qCAAqC,EAAEd,MAAMG,OAAO,CAAC,CAAC;QACzE;IACF;IAEA,OAAO;QAAEb,UAAU0B;QAAmBvC;QAASF;QAAUC;IAAO;AAClE;AAWO,eAAexB,YACpB0C,SAAoB,EACpBM,KAAuC;IAEvC,MAAM,EAAEV,QAAQ,EAAEK,WAAW,EAAE,GAAGD;IAClC,MAAMkC,aAAatC,SAASuC,KAAK;IACjC,MAAMC,eAAeF,WAAW1C,MAAM;IAEtC,OAAQc,MAAM+B,MAAM;QAClB,KAAKrB,kCAA2B,CAACsB,YAAY;YAC3CF,aAAajE,MAAM,CAACoE,QAAQ,CAACC,GAAG,CAACC,WAAW,GAAGxC,YAAYT,MAAM,CAACkD,IAAI;YACtE;QAEF,KAAK1B,kCAA2B,CAAC2B,eAAe;YAC9CP,aAAarE,OAAO,GAAGkC,YAAYT,MAAM,CAACzB,OAAO;YACjD;QAEF,KAAKiD,kCAA2B,CAAC4B,kBAAkB;YACjDR,aAAalE,UAAU,GAAG+B,YAAYT,MAAM,CAACtB,UAAU,GACnD2E,IAAAA,oBAAS,EAAC5C,YAAYT,MAAM,CAACtB,UAAU,IACvC4E;YACJ;QAEF,KAAK9B,kCAA2B,CAAC+B,cAAc;YAC7CX,aAAajE,MAAM,CAAC6E,MAAM,GAAG,MAAMC,IAAAA,sBAAe,EAACjD;YACnD;QAEF,wBAAwB,GACxB;YACEkD,IAAAA,uBAAgB,EAAC5C,MAAM+B,MAAM;IACjC;IAEAH,WAAW1C,MAAM,GAAG4C;IACpBF,WAAWD,KAAK,GAAGF,KAAKC,SAAS,CAACI;IAClC,OAAOF;AACT;AAWO,eAAe3E,kBACpBgB,QAAgB,EAChBqB,QAAc,EACdnB,UAAmB;IAEnB,IAAI,CAAC0E,IAAAA,oBAAa,EAACvD,WAAW;QAC5B,OAAOkD;IACT;IAEA,MAAMM,iBAAiB,AAACxD,SAAmCzB,MAAM,EAAEoE,UAC/DC,KAAKa;IAET,IAAI,CAACD,gBAAgB;QACnB,OAAON;IACT;IAEA,IAAIrE,YAAY;QACd,OAAO,IAAI6E,wBAAW,CAAC;YACrBC,MAAMtE,aAAS,CAACC,IAAI,CAACX,UAAU6E;YAC/BnB,OAAOxD;QACT;IACF;IAEA,IAAI;QACF,MAAM+E,cAAc,MAAMC,IAAAA,4BAAe,EACvCxE,aAAS,CAACC,IAAI,CAACX,UAAU6E,iBACzB;QAEF,OAAOI;IACT,EAAE,OAAOlD,OAAO;QACd,MAAM,IAAIc,MACR,CAAC,iCAAiC,EAAEsC,IAAAA,yBAAe,EAACpD,OAAO,CAAC;IAEhE;AACF;AAUO,eAAe9C,YACpBe,QAAgB,EAChBqB,QAAc;IAEd,IAAI,CAACuD,IAAAA,oBAAa,EAACvD,WAAW;QAC5B,OAAOkD;IACT;IAEA,MAAMa,WAAW,AAAC/D,SAAmCzB,MAAM,EAAEoE,UAAUC,KACnEmB;IAEJ,IAAI,CAACA,UAAU;QACb,OAAOb;IACT;IAEA,IAAI;QACF,MAAMU,cAAc,MAAMC,IAAAA,4BAAe,EACvCxE,aAAS,CAACC,IAAI,CAACX,UAAUoF,WACzB;QAEF,OAAOH;IACT,EAAE,OAAOlD,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,+BAA+B,EAAEsC,IAAAA,yBAAe,EAACpD,OAAO,CAAC;IAC5E;AACF;AASO,SAAS7C,iBACdmC,QAAc,EACdgE,QAAmE;IAEnE,IAAI,CAACT,IAAAA,oBAAa,EAACvD,WAAW;QAC5B,OAAOkD;IACT;IAEA,MAAMe,eAAejE;IACrB,MAAMkE,QAAQF,SAASC;IAEvB,IAAI,CAACE,MAAMC,OAAO,CAACF,QAAQ;QACzB,OAAOhB;IACT;IAEA,OAAOgB;AACT;AAWO,eAAepG,aACpBa,QAAgB,EAChBuF,KAA2B,EAC3BG,WAAkC,MAAM;IAExC,IAAI,CAACH,OAAO;QACV,OAAOhB;IACT;IAEA,IAAI;QACF,OAAO,MAAMoB,QAAQC,GAAG,CACtBL,MAAMM,GAAG,CAAC,OAAOf,WACfI,IAAAA,4BAAe,EAACxE,aAAS,CAACC,IAAI,CAACX,UAAU8E,WAAWY;IAG1D,EAAE,OAAO3D,OAAO;QACd,MAAM,IAAIc,MAAM,CAAC,2BAA2B,EAAEsC,IAAAA,yBAAe,EAACpD,OAAO,CAAC;IACxE;AACF;AASO,SAAS3C,oBAAoBiC,QAAsB;IACxD,MAAM,EAAE1B,UAAU,EAAE,GAAGmG,WAAW,GAAGzE;IAErC,MAAMmB,OAAOD,OAAOC,IAAI,CACtB7C,aAAa;QAAE,GAAGmG,SAAS;QAAEnG;IAAW,IAAImG;IAG9C,MAAMC,mBAAmBvD,KACtBwD,IAAI,CAAC,CAACC,GAAGC,IAAM5G,mBAAmB,CAAC2G,EAAE,GAAG3G,mBAAmB,CAAC4G,EAAE,EAC9D9C,MAAM,CACL,CAACnC,QAAQkC,MAAS,CAAA;YAChB,GAAGlC,MAAM;YACT,CAACkC,IAAI,EAAE9B,QAAQ,CAAC8B,IAAI;QACtB,CAAA,GACA,CAAC;IAGL,OAAO4C;AACT;AAcO,eAAe1G,wBAAwB,EAC5CgC,QAAQ,EACRK,WAAW,EACXxB,UAAU,EACVyB,OAAO,EACPC,cAAc,EACdC,iBAAiB,EACP;IACV,MAAMsE,kBAAkBzE,YAAYT,MAAM,CAACkD,IAAI;IAC/C,MAAMiC,qBAAqB1E,YAAYT,MAAM,CAACzB,OAAO;IACrD,MAAM6G,wBAAwB3E,YAAYT,MAAM,CAACtB,UAAU;IAE3D,MAAM2G,sBAAsBjF,SAASJ,MAAM,CAACrB,MAAM,CAACoE,QAAQ,CAACC,GAAG,CAACC,WAAW;IAC3E,MAAMqC,yBAAyBlF,SAASJ,MAAM,CAACzB,OAAO;IACtD,MAAMgH,qBAAqBnF,SAASJ,MAAM,CAACtB,UAAU;IAErD,IAAIwG,oBAAoBG,qBAAqB;QAC3C,MAAM,IAAItE,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,qBAAqB,EAAEyF,oBAAoB,uBAAuB,EAAE1F,uBAAgB,CAACO,WAAW,CAAC,iBAAiB,EAAEgF,gBAAgB,GAAG,CAAC,EACtK1D,kCAA2B,CAACsB,YAAY;IAE5C;IAEA,IAAIqC,uBAAuBG,wBAAwB;QACjD,MAAM,IAAIvE,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,wBAAwB,EAAE0F,uBAAuB,uBAAuB,EAAE3F,uBAAgB,CAACO,WAAW,CAAC,oBAAoB,EAAEiF,mBAAmB,GAAG,CAAC,EAClL3D,kCAA2B,CAAC2B,eAAe;IAE/C;IAEA,IAGE,AAFA,4EAA4E;IAC5E,wDAAwD;IACvDiC,CAAAA,yBAAyBG,kBAAiB,KAC3C,CAACC,IAAAA,sBAAS,EAACJ,uBAAuBG,qBAClC;QACA,MAAM,IAAIxE,uCAAgC,CACxC,CAAC,CAAC,EAAEpB,uBAAgB,CAACC,QAAQ,CAAC,yCAAyC,EAAED,uBAAgB,CAACO,WAAW,CAAC,qBAAqB,CAAC,EAC5HsB,kCAA2B,CAAC4B,kBAAkB;IAElD;IAEA,MAAMqC,IAAAA,yBAAkB,EACtB;QAAErF;QAAUnB;QAAYyB;QAASC;QAAgBC;IAAkB,GACnE,CAAC,CAAC,EAAEjB,uBAAgB,CAACC,QAAQ,CAAC,gDAAgD,CAAC;AAEnF"}

package/dist/cjs/manifest/validation.js

@@ -33,12 +33,30 @@ _export(exports, {
     ChainIdsStruct: function() {
         return ChainIdsStruct;
     },
+    LookupMatchersStruct: function() {
+        return LookupMatchersStruct;
+    },
+    MINIMUM_REQUEST_TIMEOUT: function() {
+        return MINIMUM_REQUEST_TIMEOUT;
+    },
+    MAXIMUM_REQUEST_TIMEOUT: function() {
+        return MAXIMUM_REQUEST_TIMEOUT;
+    },
+    MaxRequestTimeStruct: function() {
+        return MaxRequestTimeStruct;
+    },
+    HandlerCaveatsStruct: function() {
+        return HandlerCaveatsStruct;
+    },
     PermissionsStruct: function() {
         return PermissionsStruct;
     },
     SnapAuxilaryFilesStruct: function() {
         return SnapAuxilaryFilesStruct;
     },
+    InitialConnectionsStruct: function() {
+        return InitialConnectionsStruct;
+    },
     SnapManifestStruct: function() {
         return SnapManifestStruct;
     },
@@ -125,22 +143,47 @@ const SnapIdsStruct = (0, _superstruct.refine)((0, _superstruct.record)(_snaps.S
     }
     return true;
 });
-const ChainIdsStruct = (0, _superstruct.array)(_namespace.ChainIdStruct);
+const ChainIdsStruct = (0, _superstruct.size)((0, _superstruct.array)(_namespace.ChainIdStruct), 1, Infinity);
+const LookupMatchersStruct = (0, _superstruct.union)([
+    (0, _superstruct.object)({
+        tlds: (0, _superstruct.size)((0, _superstruct.array)((0, _superstruct.string)()), 1, Infinity)
+    }),
+    (0, _superstruct.object)({
+        schemes: (0, _superstruct.size)((0, _superstruct.array)((0, _superstruct.string)()), 1, Infinity)
+    }),
+    (0, _superstruct.object)({
+        tlds: (0, _superstruct.size)((0, _superstruct.array)((0, _superstruct.string)()), 1, Infinity),
+        schemes: (0, _superstruct.size)((0, _superstruct.array)((0, _superstruct.string)()), 1, Infinity)
+    })
+]);
+const MINIMUM_REQUEST_TIMEOUT = (0, _utils.inMilliseconds)(5, _utils.Duration.Second);
+const MAXIMUM_REQUEST_TIMEOUT = (0, _utils.inMilliseconds)(3, _utils.Duration.Minute);
+const MaxRequestTimeStruct = (0, _superstruct.size)((0, _superstruct.integer)(), MINIMUM_REQUEST_TIMEOUT, MAXIMUM_REQUEST_TIMEOUT);
+const HandlerCaveatsStruct = (0, _superstruct.object)({
+    maxRequestTime: (0, _superstruct.optional)(MaxRequestTimeStruct)
+});
 const PermissionsStruct = (0, _superstruct.type)({
-    'endowment:network-access': (0, _superstruct.optional)((0, _superstruct.object)({})),
-    'endowment:webassembly': (0, _superstruct.optional)((0, _superstruct.object)({})),
-    'endowment:transaction-insight': (0, _superstruct.optional)((0, _superstruct.object)({
-        allowTransactionOrigin: (0, _superstruct.optional)((0, _superstruct.boolean)())
-    })),
-    'endowment:cronjob': (0, _superstruct.optional)((0, _superstruct.object)({
+    'endowment:cronjob': (0, _superstruct.optional)((0, _superstruct.assign)(HandlerCaveatsStruct, (0, _superstruct.object)({
         jobs: _cronjob.CronjobSpecificationArrayStruct
-    })),
+    }))),
+    'endowment:ethereum-provider': (0, _superstruct.optional)((0, _superstruct.object)({})),
+    'endowment:keyring': (0, _superstruct.optional)((0, _superstruct.assign)(HandlerCaveatsStruct, _jsonrpc.KeyringOriginsStruct)),
+    'endowment:lifecycle-hooks': (0, _superstruct.optional)(HandlerCaveatsStruct),
+    'endowment:name-lookup': (0, _superstruct.optional)((0, _superstruct.assign)(HandlerCaveatsStruct, (0, _superstruct.object)({
+        chains: (0, _superstruct.optional)(ChainIdsStruct),
+        matchers: (0, _superstruct.optional)(LookupMatchersStruct)
+    }))),
+    'endowment:network-access': (0, _superstruct.optional)((0, _superstruct.object)({})),
+    'endowment:page-home': (0, _superstruct.optional)(HandlerCaveatsStruct),
     'endowment:rpc': (0, _superstruct.optional)(_jsonrpc.RpcOriginsStruct),
-    'endowment:name-lookup': (0, _superstruct.optional)(ChainIdsStruct),
-    'endowment:keyring': (0, _superstruct.optional)(_jsonrpc.KeyringOriginsStruct),
+    'endowment:signature-insight': (0, _superstruct.optional)((0, _superstruct.assign)(HandlerCaveatsStruct, (0, _superstruct.object)({
+        allowSignatureOrigin: (0, _superstruct.optional)((0, _superstruct.boolean)())
+    }))),
+    'endowment:transaction-insight': (0, _superstruct.optional)((0, _superstruct.assign)(HandlerCaveatsStruct, (0, _superstruct.object)({
+        allowTransactionOrigin: (0, _superstruct.optional)((0, _superstruct.boolean)())
+    }))),
+    'endowment:webassembly': (0, _superstruct.optional)((0, _superstruct.object)({})),
     snap_dialog: (0, _superstruct.optional)((0, _superstruct.object)({})),
-    // TODO: Remove
-    snap_confirm: (0, _superstruct.optional)((0, _superstruct.object)({})),
     snap_manageState: (0, _superstruct.optional)((0, _superstruct.object)({})),
     snap_manageAccounts: (0, _superstruct.optional)((0, _superstruct.object)({})),
     snap_notify: (0, _superstruct.optional)((0, _superstruct.object)({})),
@@ -150,9 +193,14 @@ const PermissionsStruct = (0, _superstruct.type)({
         coinType: (0, _superstruct.size)((0, _superstruct.integer)(), 0, 2 ** 32 - 1)
     })), 1, Infinity)),
     snap_getEntropy: (0, _superstruct.optional)((0, _superstruct.object)({})),
+    snap_getLocale: (0, _superstruct.optional)((0, _superstruct.object)({})),
     wallet_snap: (0, _superstruct.optional)(SnapIdsStruct)
 });
 const SnapAuxilaryFilesStruct = (0, _superstruct.array)((0, _superstruct.string)());
+const InitialConnectionsStruct = (0, _superstruct.record)((0, _superstruct.intersection)([
+    (0, _superstruct.string)(),
+    (0, _types.uri)()
+]), (0, _superstruct.object)({}));
 const SnapManifestStruct = (0, _superstruct.object)({
     version: _utils.VersionStruct,
     description: (0, _superstruct.size)((0, _superstruct.string)(), 1, 280),
@@ -177,6 +225,7 @@ const SnapManifestStruct = (0, _superstruct.object)({
         files: (0, _superstruct.optional)(SnapAuxilaryFilesStruct),
         locales: (0, _superstruct.optional)(SnapAuxilaryFilesStruct)
     }),
+    initialConnections: (0, _superstruct.optional)(InitialConnectionsStruct),
     initialPermissions: PermissionsStruct,
     manifestVersion: (0, _superstruct.literal)('0.1'),
     $schema: (0, _superstruct.optional)((0, _superstruct.string)())