@metamask/snaps-controllers 9.4.0 → 9.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/CHANGELOG.md +11 -2
  2. package/dist/{chunk-OJBUUQ5D.js → chunk-2D5PGL7S.js} +7 -7
  3. package/dist/chunk-2D5PGL7S.js.map +1 -0
  4. package/dist/{chunk-6GMWL4JR.mjs → chunk-2SRKMEUV.mjs} +2 -2
  5. package/dist/chunk-2SRKMEUV.mjs.map +1 -0
  6. package/dist/{chunk-5O4O4BI5.js → chunk-36QDTCDZ.js} +1 -1
  7. package/dist/chunk-36QDTCDZ.js.map +1 -0
  8. package/dist/{chunk-POQSARDG.js → chunk-3WWZDKQL.js} +7 -7
  9. package/dist/{chunk-FKQTV3LO.js → chunk-6K4MATNG.js} +4 -4
  10. package/dist/chunk-6K4MATNG.js.map +1 -0
  11. package/dist/{chunk-LWBPKSU2.js → chunk-6Z4WDAVC.js} +3 -3
  12. package/dist/{chunk-WKQRCGUW.mjs → chunk-BAUQWPSP.mjs} +2 -2
  13. package/dist/chunk-BAUQWPSP.mjs.map +1 -0
  14. package/dist/{chunk-XFUP7RFI.js → chunk-DSOZPX7I.js} +1 -1
  15. package/dist/chunk-DSOZPX7I.js.map +1 -0
  16. package/dist/{chunk-UMVUXQ3B.mjs → chunk-F3ZMDQ52.mjs} +1 -1
  17. package/dist/chunk-F3ZMDQ52.mjs.map +1 -0
  18. package/dist/{chunk-3WEWHK2I.mjs → chunk-HULNFJMA.mjs} +7 -3
  19. package/dist/chunk-HULNFJMA.mjs.map +1 -0
  20. package/dist/{chunk-CPUUURMT.js → chunk-I25KLPIS.js} +2 -2
  21. package/dist/chunk-I25KLPIS.js.map +1 -0
  22. package/dist/{chunk-6M4XK4PN.mjs → chunk-I5V56NYO.mjs} +2 -2
  23. package/dist/chunk-I5V56NYO.mjs.map +1 -0
  24. package/dist/{chunk-XWDEGRM5.js → chunk-K3TNQEM5.js} +2 -2
  25. package/dist/chunk-K3TNQEM5.js.map +1 -0
  26. package/dist/{chunk-2MH7QYBP.mjs → chunk-QWN3UOMA.mjs} +3 -3
  27. package/dist/chunk-QWN3UOMA.mjs.map +1 -0
  28. package/dist/{chunk-EVKVZUYY.js → chunk-RZ2NHZXH.js} +7 -3
  29. package/dist/chunk-RZ2NHZXH.js.map +1 -0
  30. package/dist/{chunk-RDBT3ZJQ.js → chunk-TIURYSSR.js} +2 -2
  31. package/dist/{chunk-RDBT3ZJQ.js.map → chunk-TIURYSSR.js.map} +1 -1
  32. package/dist/{chunk-B3UTLNYS.mjs → chunk-UM4NFNEI.mjs} +2 -2
  33. package/dist/{chunk-33RRV7F4.mjs → chunk-Z4BUMSH3.mjs} +1 -1
  34. package/dist/chunk-Z4BUMSH3.mjs.map +1 -0
  35. package/dist/{chunk-CJY2LYEL.mjs → chunk-Z5QWRDUN.mjs} +2 -2
  36. package/dist/chunk-Z5QWRDUN.mjs.map +1 -0
  37. package/dist/{chunk-2AEM5R2M.mjs → chunk-ZKG6FRKN.mjs} +4 -4
  38. package/dist/cronjob/CronjobController.js +11 -11
  39. package/dist/cronjob/CronjobController.mjs +10 -10
  40. package/dist/cronjob/index.js +11 -11
  41. package/dist/cronjob/index.mjs +10 -10
  42. package/dist/index.js +11 -11
  43. package/dist/index.mjs +10 -10
  44. package/dist/insights/SnapInsightsController.js +8 -8
  45. package/dist/insights/SnapInsightsController.mjs +7 -7
  46. package/dist/insights/index.js +8 -8
  47. package/dist/insights/index.mjs +7 -7
  48. package/dist/interface/SnapInterfaceController.js +3 -3
  49. package/dist/interface/SnapInterfaceController.mjs +2 -2
  50. package/dist/interface/index.js +3 -3
  51. package/dist/interface/index.mjs +2 -2
  52. package/dist/interface/utils.js +2 -2
  53. package/dist/interface/utils.mjs +1 -1
  54. package/dist/node.js +11 -11
  55. package/dist/node.mjs +10 -10
  56. package/dist/react-native.js +11 -11
  57. package/dist/react-native.mjs +10 -10
  58. package/dist/snaps/SnapController.js +7 -7
  59. package/dist/snaps/SnapController.mjs +6 -6
  60. package/dist/snaps/index.js +7 -7
  61. package/dist/snaps/index.mjs +6 -6
  62. package/dist/snaps/location/http.js +2 -2
  63. package/dist/snaps/location/http.mjs +1 -1
  64. package/dist/snaps/location/index.js +5 -5
  65. package/dist/snaps/location/index.mjs +4 -4
  66. package/dist/snaps/location/local.js +3 -3
  67. package/dist/snaps/location/local.mjs +2 -2
  68. package/dist/snaps/location/location.js +5 -5
  69. package/dist/snaps/location/location.mjs +4 -4
  70. package/dist/snaps/location/npm.js +2 -2
  71. package/dist/snaps/location/npm.mjs +1 -1
  72. package/dist/snaps/registry/index.js +2 -2
  73. package/dist/snaps/registry/index.mjs +1 -1
  74. package/dist/snaps/registry/json.js +2 -2
  75. package/dist/snaps/registry/json.mjs +1 -1
  76. package/dist/tsconfig.build.tsbuildinfo +1 -1
  77. package/dist/types/cronjob/CronjobController.d.ts +6 -4
  78. package/dist/types/insights/SnapInsightsController.d.ts +6 -3
  79. package/dist/types/interface/SnapInterfaceController.d.ts +6 -3
  80. package/dist/types/snaps/SnapController.d.ts +8 -3
  81. package/dist/types/snaps/registry/json.d.ts +5 -3
  82. package/dist/types/utils.d.ts +1 -1
  83. package/package.json +3 -3
  84. package/dist/chunk-2MH7QYBP.mjs.map +0 -1
  85. package/dist/chunk-33RRV7F4.mjs.map +0 -1
  86. package/dist/chunk-3WEWHK2I.mjs.map +0 -1
  87. package/dist/chunk-5O4O4BI5.js.map +0 -1
  88. package/dist/chunk-6GMWL4JR.mjs.map +0 -1
  89. package/dist/chunk-6M4XK4PN.mjs.map +0 -1
  90. package/dist/chunk-CJY2LYEL.mjs.map +0 -1
  91. package/dist/chunk-CPUUURMT.js.map +0 -1
  92. package/dist/chunk-EVKVZUYY.js.map +0 -1
  93. package/dist/chunk-FKQTV3LO.js.map +0 -1
  94. package/dist/chunk-OJBUUQ5D.js.map +0 -1
  95. package/dist/chunk-UMVUXQ3B.mjs.map +0 -1
  96. package/dist/chunk-WKQRCGUW.mjs.map +0 -1
  97. package/dist/chunk-XFUP7RFI.js.map +0 -1
  98. package/dist/chunk-XWDEGRM5.js.map +0 -1
  99. /package/dist/{chunk-POQSARDG.js.map → chunk-3WWZDKQL.js.map} +0 -0
  100. /package/dist/{chunk-LWBPKSU2.js.map → chunk-6Z4WDAVC.js.map} +0 -0
  101. /package/dist/{chunk-B3UTLNYS.mjs.map → chunk-UM4NFNEI.mjs.map} +0 -0
  102. /package/dist/{chunk-2AEM5R2M.mjs.map → chunk-ZKG6FRKN.mjs.map} +0 -0
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/interface/SnapInterfaceController.ts"],"names":[],"mappings":";;;;;;;;;;;AAKA,SAAS,sBAAsB;AAY/B,SAAS,mBAAmB,wBAAwB;AAEpD,SAAS,cAAc;AACvB,SAAS,cAAc;AAQvB,IAAM,sBAAsB;AAE5B,IAAM,iBAAiB;AA9BvB;AAuGO,IAAM,0BAAN,cAAsC,eAI3C;AAAA,EACA,YAAY,EAAE,WAAW,MAAM,GAAgC;AAC7D,UAAM;AAAA,MACJ;AAAA,MACA,UAAU;AAAA,QACR,YAAY,EAAE,SAAS,OAAO,WAAW,MAAM;AAAA,MACjD;AAAA,MACA,MAAM;AAAA,MACN,OAAO,EAAE,YAAY,CAAC,GAAG,GAAG,MAAM;AAAA,IACpC,CAAC;AASH;AAAA;AAAA;AAAA;AAAA;AAsJA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkBA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA;AAAA;AAAA;AAAA,uBAAM;AAUN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAcN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AAzOJ,0BAAK,sDAAL;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA8CA,MAAM,gBACJ,QACA,SACA,SACA;AACA,UAAM,UAAU,gBAAgB,OAAO;AACvC,UAAM,sBAAK,sCAAL,WAAsB;AAC5B,6BAAyB,OAAO;AAEhC,UAAM,KAAK,OAAO;AAClB,UAAM,iBAAiB,eAAe,CAAC,GAAG,OAAO;AAEjD,SAAK,OAAO,CAAC,eAAe;AAG1B,iBAAW,WAAW,EAAE,IAAI;AAAA,QAC1B;AAAA,QACA,SAAS;AAAA,QACT,OAAO;AAAA,QACP,SAAS,WAAW;AAAA,MACtB;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,aAAa,QAAgB,IAAY;AACvC,0BAAK,gCAAL,WAAmB,QAAQ;AAE3B,WAAO,KAAK,MAAM,WAAW,EAAE;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,gBACJ,QACA,IACA,SACA;AACA,0BAAK,gCAAL,WAAmB,QAAQ;AAC3B,UAAM,UAAU,gBAAgB,OAAO;AACvC,UAAM,sBAAK,sCAAL,WAAsB;AAE5B,UAAM,WAAW,KAAK,MAAM,WAAW,EAAE,EAAE;AAC3C,UAAM,WAAW,eAAe,UAAU,OAAO;AAEjD,SAAK,OAAO,CAAC,eAAe;AAC1B,iBAAW,WAAW,EAAE,EAAE,QAAQ;AAClC,iBAAW,WAAW,EAAE,EAAE,UAAU;AAAA,IACtC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,gBAAgB,IAAY;AAC1B,SAAK,OAAO,CAAC,eAAe;AAC1B,aAAO,WAAW,WAAW,EAAE;AAAA,IACjC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,qBAAqB,IAAY,OAAuB;AACtD,SAAK,OAAO,CAAC,eAAe;AAC1B,iBAAW,WAAW,EAAE,EAAE,QAAQ;AAAA,IACpC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,iBAAiB,QAAgB,IAAY,OAAa;AAC9D,0BAAK,gCAAL,WAAmB,QAAQ;AAC3B,0BAAK,wCAAL,WAAuB;AAEvB,UAAM,sBAAK,kDAAL,WAA4B,IAAI;AAEtC,SAAK,gBAAgB,EAAE;AAAA,EACzB;AAgGF;AA9OE;AAAA,6BAAwB,WAAG;AACzB,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,gBAAgB,KAAK,IAAI;AAAA,EAChC;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,aAAa,KAAK,IAAI;AAAA,EAC7B;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,gBAAgB,KAAK,IAAI;AAAA,EAChC;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,gBAAgB,KAAK,IAAI;AAAA,EAChC;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,qBAAqB,KAAK,IAAI;AAAA,EACrC;AAEA,OAAK,gBAAgB;AAAA,IACnB,GAAG,cAAc;AAAA,IACjB,KAAK,iBAAiB,KAAK,IAAI;AAAA,EACjC;AACF;AAwHA;AAAA,kBAAa,SAAC,QAAgB,IAAY;AACxC,QAAM,oBAAoB,KAAK,MAAM,WAAW,EAAE;AAElD;AAAA,IACE,sBAAsB;AAAA,IACtB,sBAAsB,EAAE;AAAA,EAC1B;AACA;AAAA,IACE,kBAAkB,WAAW;AAAA,IAC7B,4BAA4B,MAAM;AAAA,EACpC;AACF;AAOA;AAAA,sBAAiB,SAAC,IAAY;AAC5B;AAAA,IACE,sBAAK,4CAAL,WAAyB;AAAA,IACzB,6BAA6B,EAAE;AAAA,EACjC;AACF;AAKM;AAAA,+BAA0B,iBAAG;AACjC,QAAM,KAAK,gBAAgB,KAAK,qCAAqC;AACvE;AAQA;AAAA,uBAAkB,SAAC,QAAgB;AACjC,SAAO,KAAK,gBAAgB,KAAK,iCAAiC,MAAM,EACrE;AACL;AASA;AAAA,wBAAmB,SAAC,IAAY;AAC9B,SAAO,KAAK,gBAAgB,KAAK,iCAAiC;AAAA,IAChE;AAAA,EACF,CAAC;AACH;AAQM;AAAA,2BAAsB,eAAC,IAAY,OAAa;AACpD,QAAM,KAAK,gBAAgB;AAAA,IACzB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAQM;AAAA,qBAAgB,eAAC,SAAqB;AAG1C,QAAM,OAAO,kBAAkB,OAAO;AACtC;AAAA,IACE,QAAQ;AAAA,IACR,oCAAoC,sBAAsB,GAAO;AAAA,EACnE;AAEA,QAAM,sBAAK,0DAAL;AACN,mBAAiB,SAAS,sBAAK,0CAAmB,KAAK,IAAI,CAAC;AAC9D","sourcesContent":["import type {\n AcceptRequest,\n HasApprovalRequest,\n} from '@metamask/approval-controller';\nimport type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n MaybeUpdateState,\n TestOrigin,\n} from '@metamask/phishing-controller';\nimport type {\n InterfaceState,\n SnapId,\n ComponentOrElement,\n InterfaceContext,\n} from '@metamask/snaps-sdk';\nimport type { JSXElement } from '@metamask/snaps-sdk/jsx';\nimport { getJsonSizeUnsafe, validateJsxLinks } from '@metamask/snaps-utils';\nimport type { Json } from '@metamask/utils';\nimport { assert } from '@metamask/utils';\nimport { nanoid } from 'nanoid';\n\nimport {\n constructState,\n getJsxInterface,\n validateInterfaceContext,\n} from './utils';\n\nconst MAX_UI_CONTENT_SIZE = 10_000_000; // 10 mb\n\nconst controllerName = 'SnapInterfaceController';\n\nexport type CreateInterface = {\n type: `${typeof controllerName}:createInterface`;\n handler: SnapInterfaceController['createInterface'];\n};\n\nexport type GetInterface = {\n type: `${typeof controllerName}:getInterface`;\n handler: SnapInterfaceController['getInterface'];\n};\n\nexport type UpdateInterface = {\n type: `${typeof controllerName}:updateInterface`;\n handler: SnapInterfaceController['updateInterface'];\n};\n\nexport type DeleteInterface = {\n type: `${typeof controllerName}:deleteInterface`;\n handler: SnapInterfaceController['deleteInterface'];\n};\n\nexport type UpdateInterfaceState = {\n type: `${typeof controllerName}:updateInterfaceState`;\n handler: SnapInterfaceController['updateInterfaceState'];\n};\n\nexport type ResolveInterface = {\n type: `${typeof controllerName}:resolveInterface`;\n handler: SnapInterfaceController['resolveInterface'];\n};\n\nexport type SnapInterfaceControllerAllowedActions =\n | TestOrigin\n | MaybeUpdateState\n | HasApprovalRequest\n | AcceptRequest;\n\nexport type SnapInterfaceControllerActions =\n | CreateInterface\n | GetInterface\n | UpdateInterface\n | DeleteInterface\n | UpdateInterfaceState\n | ResolveInterface;\n\nexport type SnapInterfaceControllerMessenger = RestrictedControllerMessenger<\n typeof controllerName,\n SnapInterfaceControllerActions | SnapInterfaceControllerAllowedActions,\n never,\n SnapInterfaceControllerAllowedActions['type'],\n never\n>;\n\nexport type StoredInterface = {\n snapId: SnapId;\n content: JSXElement;\n state: InterfaceState;\n context: InterfaceContext | null;\n};\n\nexport type SnapInterfaceControllerState = {\n interfaces: Record<string, StoredInterface>;\n};\n\nexport type SnapInterfaceControllerArgs = {\n messenger: SnapInterfaceControllerMessenger;\n state?: SnapInterfaceControllerState;\n};\n\n/**\n * Use this controller to manage snaps UI interfaces using RPC method hooks.\n */\nexport class SnapInterfaceController extends BaseController<\n typeof controllerName,\n SnapInterfaceControllerState,\n SnapInterfaceControllerMessenger\n> {\n constructor({ messenger, state }: SnapInterfaceControllerArgs) {\n super({\n messenger,\n metadata: {\n interfaces: { persist: false, anonymous: false },\n },\n name: controllerName,\n state: { interfaces: {}, ...state },\n });\n\n this.#registerMessageHandlers();\n }\n\n /**\n * Constructor helper for registering this controller's messaging system\n * actions.\n */\n #registerMessageHandlers() {\n this.messagingSystem.registerActionHandler(\n `${controllerName}:createInterface`,\n this.createInterface.bind(this),\n );\n\n this.messagingSystem.registerActionHandler(\n `${controllerName}:getInterface`,\n this.getInterface.bind(this),\n );\n\n this.messagingSystem.registerActionHandler(\n `${controllerName}:updateInterface`,\n this.updateInterface.bind(this),\n );\n\n this.messagingSystem.registerActionHandler(\n `${controllerName}:deleteInterface`,\n this.deleteInterface.bind(this),\n );\n\n this.messagingSystem.registerActionHandler(\n `${controllerName}:updateInterfaceState`,\n this.updateInterfaceState.bind(this),\n );\n\n this.messagingSystem.registerActionHandler(\n `${controllerName}:resolveInterface`,\n this.resolveInterface.bind(this),\n );\n }\n\n /**\n * Create an interface in the controller state with the associated data.\n *\n * @param snapId - The snap id that created the interface.\n * @param content - The interface content.\n * @param context - An optional interface context object.\n * @returns The newly interface id.\n */\n async createInterface(\n snapId: SnapId,\n content: ComponentOrElement,\n context?: InterfaceContext,\n ) {\n const element = getJsxInterface(content);\n await this.#validateContent(element);\n validateInterfaceContext(context);\n\n const id = nanoid();\n const componentState = constructState({}, element);\n\n this.update((draftState) => {\n // @ts-expect-error - TS2589: Type instantiation is excessively deep and\n // possibly infinite.\n draftState.interfaces[id] = {\n snapId,\n content: element,\n state: componentState,\n context: context ?? null,\n };\n });\n\n return id;\n }\n\n /**\n * Get the data of a given interface id.\n *\n * @param snapId - The snap id requesting the interface data.\n * @param id - The interface id.\n * @returns The interface state.\n */\n getInterface(snapId: SnapId, id: string) {\n this.#validateArgs(snapId, id);\n\n return this.state.interfaces[id];\n }\n\n /**\n * Update the interface with the given content.\n *\n * @param snapId - The snap id requesting the update.\n * @param id - The interface id.\n * @param content - The new content.\n */\n async updateInterface(\n snapId: SnapId,\n id: string,\n content: ComponentOrElement,\n ) {\n this.#validateArgs(snapId, id);\n const element = getJsxInterface(content);\n await this.#validateContent(element);\n\n const oldState = this.state.interfaces[id].state;\n const newState = constructState(oldState, element);\n\n this.update((draftState) => {\n draftState.interfaces[id].state = newState;\n draftState.interfaces[id].content = element;\n });\n }\n\n /**\n * Delete an interface from state.\n *\n * @param id - The interface id.\n */\n deleteInterface(id: string) {\n this.update((draftState) => {\n delete draftState.interfaces[id];\n });\n }\n\n /**\n * Update the interface state.\n *\n * @param id - The interface id.\n * @param state - The new state.\n */\n updateInterfaceState(id: string, state: InterfaceState) {\n this.update((draftState) => {\n draftState.interfaces[id].state = state;\n });\n }\n\n /**\n * Resolve the promise of a given interface approval request.\n * The approval needs to have the same ID as the interface.\n *\n * @param snapId - The snap id.\n * @param id - The interface id.\n * @param value - The value to resolve the promise with.\n */\n async resolveInterface(snapId: SnapId, id: string, value: Json) {\n this.#validateArgs(snapId, id);\n this.#validateApproval(id);\n\n await this.#acceptApprovalRequest(id, value);\n\n this.deleteInterface(id);\n }\n\n /**\n * Utility function to validate the args passed to the other methods.\n *\n * @param snapId - The snap id.\n * @param id - The interface id.\n */\n #validateArgs(snapId: SnapId, id: string) {\n const existingInterface = this.state.interfaces[id];\n\n assert(\n existingInterface !== undefined,\n `Interface with id '${id}' not found.`,\n );\n assert(\n existingInterface.snapId === snapId,\n `Interface not created by ${snapId}.`,\n );\n }\n\n /**\n * Utility function to validate that the approval request exists.\n *\n * @param id - The interface id.\n */\n #validateApproval(id: string) {\n assert(\n this.#hasApprovalRequest(id),\n `Approval request with id '${id}' not found.`,\n );\n }\n\n /**\n * Trigger a Phishing list update if needed.\n */\n async #triggerPhishingListUpdate() {\n await this.messagingSystem.call('PhishingController:maybeUpdateState');\n }\n\n /**\n * Check an origin against the phishing list.\n *\n * @param origin - The origin to check.\n * @returns True if the origin is on the phishing list, otherwise false.\n */\n #checkPhishingList(origin: string) {\n return this.messagingSystem.call('PhishingController:testOrigin', origin)\n .result;\n }\n\n /**\n * Check if an approval request exists for a given interface by looking up\n * if the ApprovalController has a request with the given interface ID.\n *\n * @param id - The interface id.\n * @returns True if an approval request exists, otherwise false.\n */\n #hasApprovalRequest(id: string) {\n return this.messagingSystem.call('ApprovalController:hasRequest', {\n id,\n });\n }\n\n /**\n * Accept an approval request for a given interface.\n *\n * @param id - The interface id.\n * @param value - The value to resolve the promise with.\n */\n async #acceptApprovalRequest(id: string, value: Json) {\n await this.messagingSystem.call(\n 'ApprovalController:acceptRequest',\n id,\n value,\n );\n }\n\n /**\n * Utility function to validate the components of an interface.\n * Throws if something is invalid.\n *\n * @param element - The JSX element to verify.\n */\n async #validateContent(element: JSXElement) {\n // We assume the validity of this JSON to be validated by the caller.\n // E.g., in the RPC method implementation.\n const size = getJsonSizeUnsafe(element);\n assert(\n size <= MAX_UI_CONTENT_SIZE,\n `A Snap UI may not be larger than ${MAX_UI_CONTENT_SIZE / 1000000} MB.`,\n );\n\n await this.#triggerPhishingListUpdate();\n validateJsxLinks(element, this.#checkPhishingList.bind(this));\n }\n}\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/insights/SnapInsightsController.ts"],"sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type {\n Caveat,\n GetPermissions,\n ValidPermission,\n} from '@metamask/permission-controller';\nimport {\n getSignatureOriginCaveat,\n getTransactionOriginCaveat,\n SnapEndowments,\n} from '@metamask/snaps-rpc-methods';\nimport type { Json, SnapId } from '@metamask/snaps-sdk';\nimport { HandlerType } from '@metamask/snaps-utils';\nimport { hasProperty } from '@metamask/utils';\n\nimport type { DeleteInterface } from '../interface';\nimport type { GetAllSnaps, HandleSnapRequest } from '../snaps';\nimport { getRunnableSnaps } from '../snaps';\nimport type {\n TransactionControllerUnapprovedTransactionAddedEvent,\n TransactionMeta,\n SignatureStateChange,\n SignatureControllerState,\n StateSignature,\n TransactionControllerTransactionStatusUpdatedEvent,\n} from '../types';\n\nconst controllerName = 'SnapInsightsController';\n\nexport type SnapInsightsControllerAllowedActions =\n | HandleSnapRequest\n | GetAllSnaps\n | GetPermissions\n | DeleteInterface;\n\nexport type SnapInsightsControllerActions = never;\n\nexport type SnapInsightsControllerAllowedEvents =\n | TransactionControllerUnapprovedTransactionAddedEvent\n | TransactionControllerTransactionStatusUpdatedEvent\n | SignatureStateChange;\n\nexport type SnapInsightsControllerMessenger = RestrictedControllerMessenger<\n typeof controllerName,\n SnapInsightsControllerActions | SnapInsightsControllerAllowedActions,\n SnapInsightsControllerAllowedEvents,\n SnapInsightsControllerAllowedActions['type'],\n SnapInsightsControllerAllowedEvents['type']\n>;\n\nexport type SnapInsight = {\n snapId: SnapId;\n interfaceId?: string | null;\n error?: string;\n loading: boolean;\n severity?: string;\n};\n\nexport type SnapInsightsControllerState = {\n insights: Record<string, Record<SnapId, SnapInsight>>;\n};\n\nexport type SnapInsightsControllerArgs = {\n messenger: SnapInsightsControllerMessenger;\n state?: SnapInsightsControllerState;\n};\n\ntype SnapWithPermission = {\n snapId: SnapId;\n permission: ValidPermission<string, Caveat<string, Json>>;\n};\n\n/**\n * Controller for monitoring for new transactions and signatures to provide insight for.\n */\nexport class SnapInsightsController extends BaseController<\n typeof controllerName,\n SnapInsightsControllerState,\n SnapInsightsControllerMessenger\n> {\n constructor({ messenger, state }: SnapInsightsControllerArgs) {\n super({\n messenger,\n metadata: {\n insights: { persist: false, anonymous: false },\n },\n name: controllerName,\n state: { insights: {}, ...state },\n });\n\n this.messagingSystem.subscribe(\n 'TransactionController:unapprovedTransactionAdded',\n this.#handleTransaction.bind(this),\n );\n\n this.messagingSystem.subscribe(\n 'TransactionController:transactionStatusUpdated',\n this.#handleTransactionStatusUpdate.bind(this),\n );\n\n this.messagingSystem.subscribe(\n 'SignatureController:stateChange',\n this.#handleSignatureStateChange.bind(this),\n );\n }\n\n /**\n * Check if an insight already exists for a given ID.\n *\n * @param id - The ID.\n * @returns True if the insight already exists, otherwise false.\n */\n #hasInsight(id: string) {\n return hasProperty(this.state.insights, id);\n }\n\n /**\n * Get a list of runnable Snaps that have a given permission.\n * Also includes the permission object itself.\n *\n * @param permissionName - The permission name.\n * @returns A list of objects containing Snap IDs and the permission object.\n */\n #getSnapsWithPermission(permissionName: string) {\n const allSnaps = this.messagingSystem.call('SnapController:getAll');\n const filteredSnaps = getRunnableSnaps(allSnaps);\n\n return filteredSnaps.reduce<SnapWithPermission[]>((accumulator, snap) => {\n const permissions = this.messagingSystem.call(\n 'PermissionController:getPermissions',\n snap.id,\n );\n if (permissions && hasProperty(permissions, permissionName)) {\n accumulator.push({\n snapId: snap.id,\n permission: permissions[permissionName],\n });\n }\n\n return accumulator;\n }, []);\n }\n\n /**\n * Handle a newly added unapproved transaction.\n * This function fetches insights from all available Snaps\n * and populates the insights state blob with the responses.\n *\n * @param transaction - The transaction object.\n */\n #handleTransaction(transaction: TransactionMeta) {\n const { id, txParams, chainId, origin } = transaction;\n\n // This assumes that the transactions are EVM-compatible for now.\n const caipChainId = `eip155:${parseInt(chainId, 16)}`;\n\n const snaps = this.#getSnapsWithPermission(\n SnapEndowments.TransactionInsight,\n );\n\n snaps.forEach(({ snapId, permission }) => {\n const hasTransactionOriginCaveat = getTransactionOriginCaveat(permission);\n const transactionOrigin =\n hasTransactionOriginCaveat && origin ? origin : null;\n\n this.update((state) => {\n state.insights[id] ??= {};\n state.insights[id][snapId] = { snapId, loading: true };\n });\n\n this.#handleSnapRequest({\n snapId,\n handler: HandlerType.OnTransaction,\n params: {\n transaction: txParams,\n chainId: caipChainId,\n transactionOrigin,\n },\n })\n .then((response) =>\n this.#handleSnapResponse({\n id,\n snapId,\n response: response as Record<string, Json>,\n }),\n )\n .catch((error) => this.#handleSnapResponse({ id, snapId, error }));\n });\n }\n\n /**\n * Handle the stateChange event emitted by the SignatureController.\n * This function will remove existing insights from the state when applicable, as well as\n * trigger insight fetching for newly added signatures.\n *\n * @param state - The SignatureController state blob.\n */\n #handleSignatureStateChange(state: SignatureControllerState) {\n // If any IDs have disappeared since the last state update, the insight may be cleaned up.\n for (const id of Object.keys(this.state.insights)) {\n if (\n !hasProperty(state.unapprovedTypedMessages, id) &&\n !hasProperty(state.unapprovedPersonalMsgs, id)\n ) {\n this.#handleInsightCleanup(id);\n }\n }\n\n if (\n state.unapprovedPersonalMsgCount > 0 ||\n state.unapprovedTypedMessagesCount > 0\n ) {\n const snaps = this.#getSnapsWithPermission(\n SnapEndowments.SignatureInsight,\n );\n\n // This isn't very efficient, but SignatureController doesn't expose a better event for us to use yet.\n for (const personalSignature of Object.values(\n state.unapprovedPersonalMsgs,\n )) {\n this.#handleSignature(snaps, personalSignature);\n }\n\n for (const typedMessage of Object.values(state.unapprovedTypedMessages)) {\n this.#handleSignature(snaps, typedMessage);\n }\n }\n }\n\n /**\n * Handle a newly added unapproved signature.\n * This function fetches insights from all available Snaps\n * and populates the insights state blob with the responses.\n *\n * @param snaps - A list of Snaps to invoke.\n * @param signature - The signature object.\n */\n #handleSignature(snaps: SnapWithPermission[], signature: StateSignature) {\n const { id, msgParams } = signature;\n\n if (this.#hasInsight(id)) {\n return;\n }\n\n const { from, data, signatureMethod, origin } = msgParams;\n\n /**\n * Both eth_signTypedData_v3 and eth_signTypedData_v4 methods\n * need to be parsed because their data is stringified. All other\n * signature methods do not, so they are ignored.\n */\n const shouldParse =\n signatureMethod === 'eth_signTypedData_v3' ||\n signatureMethod === 'eth_signTypedData_v4';\n\n const payload = {\n from,\n data: shouldParse ? JSON.parse(data as string) : data,\n signatureMethod,\n };\n\n snaps.forEach(({ snapId, permission }) => {\n const hasSignatureOriginCaveat = getSignatureOriginCaveat(permission);\n const signatureOrigin =\n origin && hasSignatureOriginCaveat ? origin : null;\n\n this.update((state) => {\n state.insights[id] ??= {};\n state.insights[id][snapId] = { snapId, loading: true };\n });\n\n this.#handleSnapRequest({\n snapId,\n handler: HandlerType.OnSignature,\n params: { signature: payload, signatureOrigin },\n })\n .then((response) =>\n this.#handleSnapResponse({\n id,\n snapId,\n response: response as Record<string, Json>,\n }),\n )\n .catch((error) => this.#handleSnapResponse({ id, snapId, error }));\n });\n }\n\n /**\n * Handle the transactionStatusUpdated event emitted by the TransactionController.\n * This function will remove insights for the transaction in question\n * once the transaction status has changed from unapproved.\n *\n * @param args - An options bag.\n * @param args.transactionMeta - The transaction.\n */\n #handleTransactionStatusUpdate({\n transactionMeta,\n }: {\n transactionMeta: TransactionMeta;\n }) {\n if (transactionMeta.status !== 'unapproved') {\n this.#handleInsightCleanup(transactionMeta.id);\n }\n }\n\n #handleInsightCleanup(id: string) {\n if (!this.#hasInsight(id)) {\n return;\n }\n\n // Delete interfaces from interface controller.\n Object.values(this.state.insights[id])\n .filter((insight) => insight.interfaceId)\n .forEach((insight) => {\n this.messagingSystem.call(\n 'SnapInterfaceController:deleteInterface',\n insight.interfaceId as string,\n );\n });\n\n this.update((state) => {\n delete state.insights[id];\n });\n }\n\n /**\n * Handle sending a request to a given Snap with a given payload.\n *\n * @param args - An options bag.\n * @param args.snapId - The Snap ID.\n * @param args.handler - The handler to invoke.\n * @param args.params - The JSON-RPC params to send.\n * @returns The response from the Snap.\n */\n async #handleSnapRequest({\n snapId,\n handler,\n params,\n }: {\n snapId: SnapId;\n handler: HandlerType.OnTransaction | HandlerType.OnSignature;\n params: Record<string, Json>;\n }) {\n return this.messagingSystem.call('SnapController:handleRequest', {\n snapId,\n origin: '',\n handler,\n request: {\n method: '',\n params,\n },\n });\n }\n\n /**\n * Handle response from a given Snap by persisting the response or error in state.\n *\n * @param args - An options bag.\n * @param args.id - The transaction or signature ID.\n * @param args.snapId - The Snap ID.\n * @param args.response - An optional response object returned by the Snap.\n * @param args.error - An optional error returned by the Snap.\n */\n #handleSnapResponse({\n id,\n snapId,\n response,\n error,\n }: {\n id: string;\n snapId: SnapId;\n response?: Record<string, Json>;\n error?: Error;\n }) {\n this.update((state) => {\n state.insights[id][snapId].loading = false;\n state.insights[id][snapId].interfaceId = response?.id as string;\n state.insights[id][snapId].severity = response?.severity as string;\n state.insights[id][snapId].error = error?.message;\n });\n }\n}\n"],"mappings":";;;;;;;;;AACA,SAAS,sBAAsB;AAM/B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,mBAAmB;AAC5B,SAAS,mBAAmB;AAc5B,IAAM,iBAAiB;AA5BvB;AA4EO,IAAM,yBAAN,cAAqC,eAI1C;AAAA,EACA,YAAY,EAAE,WAAW,MAAM,GAA+B;AAC5D,UAAM;AAAA,MACJ;AAAA,MACA,UAAU;AAAA,QACR,UAAU,EAAE,SAAS,OAAO,WAAW,MAAM;AAAA,MAC/C;AAAA,MACA,MAAM;AAAA,MACN,OAAO,EAAE,UAAU,CAAC,GAAG,GAAG,MAAM;AAAA,IAClC,CAAC;AAwBH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAWA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA2BA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA+CA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAwCA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA0DA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA;AA6BA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uBAAM;AA6BN;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAjRE,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,sBAAK,0CAAmB,KAAK,IAAI;AAAA,IACnC;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,sBAAK,kEAA+B,KAAK,IAAI;AAAA,IAC/C;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,sBAAK,4DAA4B,KAAK,IAAI;AAAA,IAC5C;AAAA,EACF;AAqRF;AA7QE;AAAA,gBAAW,SAAC,IAAY;AACtB,SAAO,YAAY,KAAK,MAAM,UAAU,EAAE;AAC5C;AASA;AAAA,4BAAuB,SAAC,gBAAwB;AAC9C,QAAM,WAAW,KAAK,gBAAgB,KAAK,uBAAuB;AAClE,QAAM,gBAAgB,iBAAiB,QAAQ;AAE/C,SAAO,cAAc,OAA6B,CAAC,aAAa,SAAS;AACvE,UAAM,cAAc,KAAK,gBAAgB;AAAA,MACvC;AAAA,MACA,KAAK;AAAA,IACP;AACA,QAAI,eAAe,YAAY,aAAa,cAAc,GAAG;AAC3D,kBAAY,KAAK;AAAA,QACf,QAAQ,KAAK;AAAA,QACb,YAAY,YAAY,cAAc;AAAA,MACxC,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AACP;AASA;AAAA,uBAAkB,SAAC,aAA8B;AAC/C,QAAM,EAAE,IAAI,UAAU,SAAS,OAAO,IAAI;AAG1C,QAAM,cAAc,UAAU,SAAS,SAAS,EAAE,CAAC;AAEnD,QAAM,QAAQ,sBAAK,oDAAL,WACZ,eAAe;AAGjB,QAAM,QAAQ,CAAC,EAAE,QAAQ,WAAW,MAAM;AACxC,UAAM,6BAA6B,2BAA2B,UAAU;AACxE,UAAM,oBACJ,8BAA8B,SAAS,SAAS;AAElD,SAAK,OAAO,CAAC,UAAU;AAtK7B;AAuKQ,kBAAM,UAAN,iBAAuB,CAAC;AACxB,YAAM,SAAS,EAAE,EAAE,MAAM,IAAI,EAAE,QAAQ,SAAS,KAAK;AAAA,IACvD,CAAC;AAED,0BAAK,0CAAL,WAAwB;AAAA,MACtB;AAAA,MACA,SAAS,YAAY;AAAA,MACrB,QAAQ;AAAA,QACN,aAAa;AAAA,QACb,SAAS;AAAA,QACT;AAAA,MACF;AAAA,IACF,GACG;AAAA,MAAK,CAAC,aACL,sBAAK,4CAAL,WAAyB;AAAA,QACvB;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF,EACC,MAAM,CAAC,UAAU,sBAAK,4CAAL,WAAyB,EAAE,IAAI,QAAQ,MAAM,EAAE;AAAA,EACrE,CAAC;AACH;AASA;AAAA,gCAA2B,SAAC,OAAiC;AAE3D,aAAW,MAAM,OAAO,KAAK,KAAK,MAAM,QAAQ,GAAG;AACjD,QACE,CAAC,YAAY,MAAM,yBAAyB,EAAE,KAC9C,CAAC,YAAY,MAAM,wBAAwB,EAAE,GAC7C;AACA,4BAAK,gDAAL,WAA2B;AAAA,IAC7B;AAAA,EACF;AAEA,MACE,MAAM,6BAA6B,KACnC,MAAM,+BAA+B,GACrC;AACA,UAAM,QAAQ,sBAAK,oDAAL,WACZ,eAAe;AAIjB,eAAW,qBAAqB,OAAO;AAAA,MACrC,MAAM;AAAA,IACR,GAAG;AACD,4BAAK,sCAAL,WAAsB,OAAO;AAAA,IAC/B;AAEA,eAAW,gBAAgB,OAAO,OAAO,MAAM,uBAAuB,GAAG;AACvE,4BAAK,sCAAL,WAAsB,OAAO;AAAA,IAC/B;AAAA,EACF;AACF;AAUA;AAAA,qBAAgB,SAAC,OAA6B,WAA2B;AACvE,QAAM,EAAE,IAAI,UAAU,IAAI;AAE1B,MAAI,sBAAK,4BAAL,WAAiB,KAAK;AACxB;AAAA,EACF;AAEA,QAAM,EAAE,MAAM,MAAM,iBAAiB,OAAO,IAAI;AAOhD,QAAM,cACJ,oBAAoB,0BACpB,oBAAoB;AAEtB,QAAM,UAAU;AAAA,IACd;AAAA,IACA,MAAM,cAAc,KAAK,MAAM,IAAc,IAAI;AAAA,IACjD;AAAA,EACF;AAEA,QAAM,QAAQ,CAAC,EAAE,QAAQ,WAAW,MAAM;AACxC,UAAM,2BAA2B,yBAAyB,UAAU;AACpE,UAAM,kBACJ,UAAU,2BAA2B,SAAS;AAEhD,SAAK,OAAO,CAAC,UAAU;AA3Q7B;AA4QQ,kBAAM,UAAN,iBAAuB,CAAC;AACxB,YAAM,SAAS,EAAE,EAAE,MAAM,IAAI,EAAE,QAAQ,SAAS,KAAK;AAAA,IACvD,CAAC;AAED,0BAAK,0CAAL,WAAwB;AAAA,MACtB;AAAA,MACA,SAAS,YAAY;AAAA,MACrB,QAAQ,EAAE,WAAW,SAAS,gBAAgB;AAAA,IAChD,GACG;AAAA,MAAK,CAAC,aACL,sBAAK,4CAAL,WAAyB;AAAA,QACvB;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF,EACC,MAAM,CAAC,UAAU,sBAAK,4CAAL,WAAyB,EAAE,IAAI,QAAQ,MAAM,EAAE;AAAA,EACrE,CAAC;AACH;AAUA;AAAA,mCAA8B,SAAC;AAAA,EAC7B;AACF,GAEG;AACD,MAAI,gBAAgB,WAAW,cAAc;AAC3C,0BAAK,gDAAL,WAA2B,gBAAgB;AAAA,EAC7C;AACF;AAEA;AAAA,0BAAqB,SAAC,IAAY;AAChC,MAAI,CAAC,sBAAK,4BAAL,WAAiB,KAAK;AACzB;AAAA,EACF;AAGA,SAAO,OAAO,KAAK,MAAM,SAAS,EAAE,CAAC,EAClC,OAAO,CAAC,YAAY,QAAQ,WAAW,EACvC,QAAQ,CAAC,YAAY;AACpB,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,QAAQ;AAAA,IACV;AAAA,EACF,CAAC;AAEH,OAAK,OAAO,CAAC,UAAU;AACrB,WAAO,MAAM,SAAS,EAAE;AAAA,EAC1B,CAAC;AACH;AAWM;AAAA,uBAAkB,eAAC;AAAA,EACvB;AAAA,EACA;AAAA,EACA;AACF,GAIG;AACD,SAAO,KAAK,gBAAgB,KAAK,gCAAgC;AAAA,IAC/D;AAAA,IACA,QAAQ;AAAA,IACR;AAAA,IACA,SAAS;AAAA,MACP,QAAQ;AAAA,MACR;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAWA;AAAA,wBAAmB,SAAC;AAAA,EAClB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAKG;AACD,OAAK,OAAO,CAAC,UAAU;AACrB,UAAM,SAAS,EAAE,EAAE,MAAM,EAAE,UAAU;AACrC,UAAM,SAAS,EAAE,EAAE,MAAM,EAAE,cAAc,UAAU;AACnD,UAAM,SAAS,EAAE,EAAE,MAAM,EAAE,WAAW,UAAU;AAChD,UAAM,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,OAAO;AAAA,EAC5C,CAAC;AACH;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/snaps/location/npm.ts"],"sourcesContent":["import type { SnapManifest } from '@metamask/snaps-utils';\nimport {\n createSnapManifest,\n DEFAULT_REQUESTED_SNAP_VERSION,\n getTargetVersion,\n isValidUrl,\n NpmSnapIdStruct,\n VirtualFile,\n normalizeRelative,\n parseJson,\n} from '@metamask/snaps-utils';\nimport type { SemVerRange, SemVerVersion } from '@metamask/utils';\nimport {\n assert,\n assertIsSemVerVersion,\n assertStruct,\n isObject,\n isValidSemVerVersion,\n} from '@metamask/utils';\nimport { createGunzip } from 'browserify-zlib';\nimport concat from 'concat-stream';\nimport getNpmTarballUrl from 'get-npm-tarball-url';\nimport { pipeline } from 'readable-stream';\nimport type { Readable, Writable } from 'readable-stream';\nimport { ReadableWebToNodeStream } from 'readable-web-to-node-stream';\nimport { extract as tarExtract } from 'tar-stream';\n\nimport type { DetectSnapLocationOptions, SnapLocation } from './location';\n\nexport const DEFAULT_NPM_REGISTRY = new URL('https://registry.npmjs.org');\n\ninterface NpmMeta {\n registry: URL;\n packageName: string;\n requestedRange: SemVerRange;\n version?: string;\n fetch: typeof fetch;\n resolveVersion: (range: SemVerRange) => Promise<SemVerRange>;\n}\nexport interface NpmOptions {\n /**\n * @default DEFAULT_REQUESTED_SNAP_VERSION\n */\n versionRange?: SemVerRange;\n /**\n * Whether to allow custom NPM registries outside of {@link DEFAULT_NPM_REGISTRY}.\n *\n * @default false\n */\n allowCustomRegistries?: boolean;\n}\n\n// Base class for NPM implementation, useful for extending with custom NPM fetching logic\nexport abstract class BaseNpmLocation implements SnapLocation {\n protected readonly meta: NpmMeta;\n\n #validatedManifest?: VirtualFile<SnapManifest>;\n\n #files?: Map<string, VirtualFile>;\n\n constructor(url: URL, opts: DetectSnapLocationOptions = {}) {\n const allowCustomRegistries = opts.allowCustomRegistries ?? false;\n const fetchFunction = opts.fetch ?? globalThis.fetch.bind(globalThis);\n const requestedRange = opts.versionRange ?? DEFAULT_REQUESTED_SNAP_VERSION;\n const defaultResolve = async (range: SemVerRange) => range;\n const resolveVersion = opts.resolveVersion ?? defaultResolve;\n\n assertStruct(url.toString(), NpmSnapIdStruct, 'Invalid Snap Id: ');\n\n let registry: string | URL;\n if (\n url.host === '' &&\n url.port === '' &&\n url.username === '' &&\n url.password === ''\n ) {\n registry = DEFAULT_NPM_REGISTRY;\n } else {\n registry = 'https://';\n if (url.username) {\n registry += url.username;\n if (url.password) {\n registry += `:${url.password}`;\n }\n registry += '@';\n }\n registry += url.host;\n registry = new URL(registry);\n assert(\n allowCustomRegistries,\n new TypeError(\n `Custom NPM registries are disabled, tried to use \"${registry.toString()}\".`,\n ),\n );\n }\n\n assert(\n registry.pathname === '/' &&\n registry.search === '' &&\n registry.hash === '',\n );\n\n assert(\n url.pathname !== '' && url.pathname !== '/',\n new TypeError('The package name in NPM location is empty.'),\n );\n let packageName = url.pathname;\n if (packageName.startsWith('/')) {\n packageName = packageName.slice(1);\n }\n\n this.meta = {\n requestedRange,\n registry,\n packageName,\n fetch: fetchFunction,\n resolveVersion,\n };\n }\n\n async manifest(): Promise<VirtualFile<SnapManifest>> {\n if (this.#validatedManifest) {\n return this.#validatedManifest.clone();\n }\n\n const vfile = await this.fetch('snap.manifest.json');\n const result = parseJson(vfile.toString());\n vfile.result = createSnapManifest(result);\n this.#validatedManifest = vfile as VirtualFile<SnapManifest>;\n\n return this.manifest();\n }\n\n async fetch(path: string): Promise<VirtualFile> {\n const relativePath = normalizeRelative(path);\n if (!this.#files) {\n await this.#lazyInit();\n assert(this.#files !== undefined);\n }\n const vfile = this.#files.get(relativePath);\n assert(\n vfile !== undefined,\n new TypeError(`File \"${path}\" not found in package.`),\n );\n return vfile.clone();\n }\n\n get packageName(): string {\n return this.meta.packageName;\n }\n\n get version(): string {\n assert(\n this.meta.version !== undefined,\n 'Tried to access version without first fetching NPM package.',\n );\n return this.meta.version;\n }\n\n get registry(): URL {\n return this.meta.registry;\n }\n\n get versionRange(): SemVerRange {\n return this.meta.requestedRange;\n }\n\n async #lazyInit() {\n assert(this.#files === undefined);\n const resolvedVersion = await this.meta.resolveVersion(\n this.meta.requestedRange,\n );\n\n const { tarballURL, targetVersion } = await resolveNpmVersion(\n this.meta.packageName,\n resolvedVersion,\n this.meta.registry,\n this.meta.fetch,\n );\n\n if (!isValidUrl(tarballURL) || !tarballURL.toString().endsWith('.tgz')) {\n throw new Error(\n `Failed to find valid tarball URL in NPM metadata for package \"${this.meta.packageName}\".`,\n );\n }\n\n // Override the tarball hostname/protocol with registryUrl hostname/protocol\n const newTarballUrl = new URL(tarballURL);\n newTarballUrl.hostname = this.meta.registry.hostname;\n newTarballUrl.protocol = this.meta.registry.protocol;\n\n const files = await this.fetchNpmTarball(newTarballUrl);\n\n this.#files = files;\n this.meta.version = targetVersion;\n }\n\n /**\n * Fetches and unpacks the tarball (`.tgz` file) from the specified URL.\n *\n * @param tarballUrl - The tarball URL to fetch and unpack.\n * @returns A the files for the package tarball.\n * @throws If fetching the tarball fails.\n */\n abstract fetchNpmTarball(tarballUrl: URL): Promise<Map<string, VirtualFile>>;\n}\n\n// Safety limit for tarballs, 250 MB in bytes\nexport const TARBALL_SIZE_SAFETY_LIMIT = 262144000;\n\n// Main NPM implementation, contains a browser tarball fetching implementation.\nexport class NpmLocation extends BaseNpmLocation {\n /**\n * Fetches and unpacks the tarball (`.tgz` file) from the specified URL.\n *\n * @param tarballUrl - The tarball URL to fetch and unpack.\n * @returns A the files for the package tarball.\n * @throws If fetching the tarball fails.\n */\n async fetchNpmTarball(\n tarballUrl: URL,\n ): Promise<Map<string, VirtualFile<unknown>>> {\n // Perform a raw fetch because we want the Response object itself.\n const tarballResponse = await this.meta.fetch(tarballUrl.toString());\n if (!tarballResponse.ok || !tarballResponse.body) {\n throw new Error(\n `Failed to fetch tarball for package \"${this.meta.packageName}\".`,\n );\n }\n\n // We assume that NPM is a good actor and provides us with a valid `content-length` header.\n const tarballSizeString = tarballResponse.headers.get('content-length');\n assert(tarballSizeString, 'Snap tarball has invalid content-length');\n const tarballSize = parseInt(tarballSizeString, 10);\n assert(\n tarballSize <= TARBALL_SIZE_SAFETY_LIMIT,\n 'Snap tarball exceeds size limit',\n );\n return new Promise((resolve, reject) => {\n const files = new Map();\n\n const tarballStream = createTarballStream(\n getNpmCanonicalBasePath(this.meta.registry, this.meta.packageName),\n files,\n );\n\n // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n const body = tarballResponse.body!;\n\n // The \"gz\" in \"tgz\" stands for \"gzip\". The tarball needs to be decompressed\n // before we can actually grab any files from it.\n // To prevent recursion-based zip bombs, we should not allow recursion here.\n\n // If native decompression stream is available we use that, otherwise fallback to zlib.\n if ('pipeThrough' in body && 'DecompressionStream' in globalThis) {\n const decompressionStream = new DecompressionStream('gzip');\n const decompressedStream = body.pipeThrough(decompressionStream);\n\n pipeline(\n getNodeStream(decompressedStream),\n tarballStream,\n (error: unknown) => {\n error ? reject(error) : resolve(files);\n },\n );\n return;\n }\n\n pipeline(\n getNodeStream(body),\n createGunzip(),\n tarballStream,\n (error: unknown) => {\n error ? reject(error) : resolve(files);\n },\n );\n });\n }\n}\n\n// Incomplete type\nexport type PartialNpmMetadata = {\n versions: Record<string, { dist: { tarball: string } }>;\n};\n\n/**\n * Fetches the NPM metadata of the specified package from\n * the public npm registry.\n *\n * @param packageName - The name of the package whose metadata to fetch.\n * @param registryUrl - The URL of the npm registry to fetch the metadata from.\n * @param fetchFunction - The fetch function to use. Defaults to the global\n * {@link fetch}. Useful for Node.js compatibility.\n * @returns The NPM metadata object.\n * @throws If fetching the metadata fails.\n */\nexport async function fetchNpmMetadata(\n packageName: string,\n registryUrl: URL,\n fetchFunction: typeof fetch,\n): Promise<PartialNpmMetadata> {\n const packageResponse = await fetchFunction(\n new URL(packageName, registryUrl).toString(),\n {\n headers: {\n // Corgi format is slightly smaller: https://github.com/npm/pacote/blob/main/lib/registry.js#L71\n accept: isNPM(registryUrl)\n ? 'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*'\n : 'application/json',\n },\n },\n );\n if (!packageResponse.ok) {\n throw new Error(\n `Failed to fetch NPM registry entry. Status code: ${packageResponse.status}.`,\n );\n }\n const packageMetadata = await packageResponse.json();\n\n if (!isObject(packageMetadata)) {\n throw new Error(\n `Failed to fetch package \"${packageName}\" metadata from npm.`,\n );\n }\n\n return packageMetadata as PartialNpmMetadata;\n}\n\n/**\n * Gets the canonical base path for an NPM snap.\n *\n * @param registryUrl - A registry URL.\n * @param packageName - A package name.\n * @returns The canonical base path.\n */\nexport function getNpmCanonicalBasePath(registryUrl: URL, packageName: string) {\n let canonicalBase = 'npm://';\n if (registryUrl.username !== '') {\n canonicalBase += registryUrl.username;\n if (registryUrl.password !== '') {\n canonicalBase += `:${registryUrl.password}`;\n }\n canonicalBase += '@';\n }\n return `${canonicalBase}${registryUrl.host}/${packageName}/`;\n}\n\n/**\n * Determine if a registry URL is NPM.\n *\n * @param registryUrl - A registry url.\n * @returns True if the registry is the NPM registry, otherwise false.\n */\nfunction isNPM(registryUrl: URL) {\n return registryUrl.toString() === DEFAULT_NPM_REGISTRY.toString();\n}\n\n/**\n * Resolves a version range to a version using the NPM registry.\n *\n * Unless the version range is already a version, then the NPM registry is skipped.\n *\n * @param packageName - The name of the package whose metadata to fetch.\n * @param versionRange - The version range of the package.\n * @param registryUrl - The URL of the npm registry to fetch the metadata from.\n * @param fetchFunction - The fetch function to use. Defaults to the global\n * {@link fetch}. Useful for Node.js compatibility.\n * @returns An object containing the resolved version and a URL for its tarball.\n * @throws If fetching the metadata fails.\n */\nasync function resolveNpmVersion(\n packageName: string,\n versionRange: SemVerRange,\n registryUrl: URL,\n fetchFunction: typeof fetch,\n): Promise<{ tarballURL: string; targetVersion: SemVerVersion }> {\n // If the version range is already a static version we don't need to look for the metadata.\n if (isNPM(registryUrl) && isValidSemVerVersion(versionRange)) {\n return {\n tarballURL: getNpmTarballUrl(packageName, versionRange),\n targetVersion: versionRange,\n };\n }\n\n const packageMetadata = await fetchNpmMetadata(\n packageName,\n registryUrl,\n fetchFunction,\n );\n\n const versions = Object.keys(packageMetadata?.versions ?? {}).map(\n (version) => {\n assertIsSemVerVersion(version);\n return version;\n },\n );\n\n const targetVersion = getTargetVersion(versions, versionRange);\n\n if (targetVersion === null) {\n throw new Error(\n `Failed to find a matching version in npm metadata for package \"${packageName}\" and requested semver range \"${versionRange}\".`,\n );\n }\n\n const tarballURL = packageMetadata?.versions?.[targetVersion]?.dist?.tarball;\n\n return { tarballURL, targetVersion };\n}\n\n/**\n * The paths of files within npm tarballs appear to always be prefixed with\n * \"package/\".\n */\nconst NPM_TARBALL_PATH_PREFIX = /^package\\//u;\n\n/**\n * Converts a {@link ReadableStream} to a Node.js {@link Readable}\n * stream. Returns the stream directly if it is already a Node.js stream.\n * We can't use the native Web {@link ReadableStream} directly because the\n * other stream libraries we use expect Node.js streams.\n *\n * @param stream - The stream to convert.\n * @returns The given stream as a Node.js Readable stream.\n */\nfunction getNodeStream(stream: ReadableStream): Readable {\n if (typeof stream.getReader !== 'function') {\n return stream as unknown as Readable;\n }\n\n return new ReadableWebToNodeStream(stream);\n}\n\n/**\n * Creates a `tar-stream` that will get the necessary files from an npm Snap\n * package tarball (`.tgz` file).\n *\n * @param canonicalBase - A base URI as specified in {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8}. Starting with 'npm:'. Will be used for canonicalPath vfile argument.\n * @param files - An object to write target file contents to.\n * @returns The {@link Writable} tarball extraction stream.\n */\nfunction createTarballStream(\n canonicalBase: string,\n files: Map<string, VirtualFile>,\n): Writable {\n assert(\n canonicalBase.endsWith('/'),\n \"Base needs to end with '/' for relative paths to be added as children instead of siblings.\",\n );\n\n assert(\n canonicalBase.startsWith('npm:'),\n 'Protocol mismatch, expected \"npm:\".',\n );\n // `tar-stream` is pretty old-school, so we create it first and then\n // instrument it by adding event listeners.\n const extractStream = tarExtract();\n\n let totalSize = 0;\n\n // \"entry\" is fired for every discreet entity in the tarball. This includes\n // files and folders.\n extractStream.on('entry', (header, entryStream, next) => {\n const { name: headerName, type: headerType } = header;\n if (headerType === 'file') {\n // The name is a path if the header type is \"file\".\n const path = headerName.replace(NPM_TARBALL_PATH_PREFIX, '');\n return entryStream.pipe(\n concat({ encoding: 'uint8array' }, (data) => {\n try {\n totalSize += data.byteLength;\n // To prevent zip bombs, we set a safety limit for the total size of tarballs.\n assert(\n totalSize < TARBALL_SIZE_SAFETY_LIMIT,\n `Snap tarball exceeds limit of ${TARBALL_SIZE_SAFETY_LIMIT} bytes.`,\n );\n const vfile = new VirtualFile({\n value: data,\n path,\n data: {\n canonicalPath: new URL(path, canonicalBase).toString(),\n },\n });\n // We disallow files having identical paths as it may confuse our checksum calculations.\n assert(\n !files.has(path),\n 'Malformed tarball, multiple files with the same path.',\n );\n files.set(path, vfile);\n return next();\n } catch (error) {\n return extractStream.destroy(error);\n }\n }),\n );\n }\n\n // If we get here, the entry is not a file, and we want to ignore. The entry\n // stream must be drained, or the extractStream will stop reading. This is\n // effectively a no-op for the current entry.\n entryStream.on('end', () => next());\n return entryStream.resume();\n });\n return extractStream;\n}\n"],"mappings":";;;;;;;;AACA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,oBAAoB;AAC7B,OAAO,YAAY;AACnB,OAAO,sBAAsB;AAC7B,SAAS,gBAAgB;AAEzB,SAAS,+BAA+B;AACxC,SAAS,WAAW,kBAAkB;AAI/B,IAAM,uBAAuB,IAAI,IAAI,4BAA4B;AA7BxE;AAqDO,IAAe,kBAAf,MAAuD;AAAA,EAO5D,YAAY,KAAU,OAAkC,CAAC,GAAG;AA2G5D,uBAAM;AA/GN;AAEA;AAGE,UAAM,wBAAwB,KAAK,yBAAyB;AAC5D,UAAM,gBAAgB,KAAK,SAAS,WAAW,MAAM,KAAK,UAAU;AACpE,UAAM,iBAAiB,KAAK,gBAAgB;AAC5C,UAAM,iBAAiB,OAAO,UAAuB;AACrD,UAAM,iBAAiB,KAAK,kBAAkB;AAE9C,iBAAa,IAAI,SAAS,GAAG,iBAAiB,mBAAmB;AAEjE,QAAI;AACJ,QACE,IAAI,SAAS,MACb,IAAI,SAAS,MACb,IAAI,aAAa,MACjB,IAAI,aAAa,IACjB;AACA,iBAAW;AAAA,IACb,OAAO;AACL,iBAAW;AACX,UAAI,IAAI,UAAU;AAChB,oBAAY,IAAI;AAChB,YAAI,IAAI,UAAU;AAChB,sBAAY,IAAI,IAAI,QAAQ;AAAA,QAC9B;AACA,oBAAY;AAAA,MACd;AACA,kBAAY,IAAI;AAChB,iBAAW,IAAI,IAAI,QAAQ;AAC3B;AAAA,QACE;AAAA,QACA,IAAI;AAAA,UACF,qDAAqD,SAAS,SAAS,CAAC;AAAA,QAC1E;AAAA,MACF;AAAA,IACF;AAEA;AAAA,MACE,SAAS,aAAa,OACpB,SAAS,WAAW,MACpB,SAAS,SAAS;AAAA,IACtB;AAEA;AAAA,MACE,IAAI,aAAa,MAAM,IAAI,aAAa;AAAA,MACxC,IAAI,UAAU,4CAA4C;AAAA,IAC5D;AACA,QAAI,cAAc,IAAI;AACtB,QAAI,YAAY,WAAW,GAAG,GAAG;AAC/B,oBAAc,YAAY,MAAM,CAAC;AAAA,IACnC;AAEA,SAAK,OAAO;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,WAA+C;AACnD,QAAI,mBAAK,qBAAoB;AAC3B,aAAO,mBAAK,oBAAmB,MAAM;AAAA,IACvC;AAEA,UAAM,QAAQ,MAAM,KAAK,MAAM,oBAAoB;AACnD,UAAM,SAAS,UAAU,MAAM,SAAS,CAAC;AACzC,UAAM,SAAS,mBAAmB,MAAM;AACxC,uBAAK,oBAAqB;AAE1B,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,MAAM,MAAM,MAAoC;AAC9C,UAAM,eAAe,kBAAkB,IAAI;AAC3C,QAAI,CAAC,mBAAK,SAAQ;AAChB,YAAM,sBAAK,wBAAL;AACN,aAAO,mBAAK,YAAW,MAAS;AAAA,IAClC;AACA,UAAM,QAAQ,mBAAK,QAAO,IAAI,YAAY;AAC1C;AAAA,MACE,UAAU;AAAA,MACV,IAAI,UAAU,SAAS,IAAI,yBAAyB;AAAA,IACtD;AACA,WAAO,MAAM,MAAM;AAAA,EACrB;AAAA,EAEA,IAAI,cAAsB;AACxB,WAAO,KAAK,KAAK;AAAA,EACnB;AAAA,EAEA,IAAI,UAAkB;AACpB;AAAA,MACE,KAAK,KAAK,YAAY;AAAA,MACtB;AAAA,IACF;AACA,WAAO,KAAK,KAAK;AAAA,EACnB;AAAA,EAEA,IAAI,WAAgB;AAClB,WAAO,KAAK,KAAK;AAAA,EACnB;AAAA,EAEA,IAAI,eAA4B;AAC9B,WAAO,KAAK,KAAK;AAAA,EACnB;AAwCF;AArJE;AAEA;AA6GM;AAAA,cAAS,iBAAG;AAChB,SAAO,mBAAK,YAAW,MAAS;AAChC,QAAM,kBAAkB,MAAM,KAAK,KAAK;AAAA,IACtC,KAAK,KAAK;AAAA,EACZ;AAEA,QAAM,EAAE,YAAY,cAAc,IAAI,MAAM;AAAA,IAC1C,KAAK,KAAK;AAAA,IACV;AAAA,IACA,KAAK,KAAK;AAAA,IACV,KAAK,KAAK;AAAA,EACZ;AAEA,MAAI,CAAC,WAAW,UAAU,KAAK,CAAC,WAAW,SAAS,EAAE,SAAS,MAAM,GAAG;AACtE,UAAM,IAAI;AAAA,MACR,iEAAiE,KAAK,KAAK,WAAW;AAAA,IACxF;AAAA,EACF;AAGA,QAAM,gBAAgB,IAAI,IAAI,UAAU;AACxC,gBAAc,WAAW,KAAK,KAAK,SAAS;AAC5C,gBAAc,WAAW,KAAK,KAAK,SAAS;AAE5C,QAAM,QAAQ,MAAM,KAAK,gBAAgB,aAAa;AAEtD,qBAAK,QAAS;AACd,OAAK,KAAK,UAAU;AACtB;AAaK,IAAM,4BAA4B;AAGlC,IAAM,cAAN,cAA0B,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ/C,MAAM,gBACJ,YAC4C;AAE5C,UAAM,kBAAkB,MAAM,KAAK,KAAK,MAAM,WAAW,SAAS,CAAC;AACnE,QAAI,CAAC,gBAAgB,MAAM,CAAC,gBAAgB,MAAM;AAChD,YAAM,IAAI;AAAA,QACR,wCAAwC,KAAK,KAAK,WAAW;AAAA,MAC/D;AAAA,IACF;AAGA,UAAM,oBAAoB,gBAAgB,QAAQ,IAAI,gBAAgB;AACtE,WAAO,mBAAmB,yCAAyC;AACnE,UAAM,cAAc,SAAS,mBAAmB,EAAE;AAClD;AAAA,MACE,eAAe;AAAA,MACf;AAAA,IACF;AACA,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,QAAQ,oBAAI,IAAI;AAEtB,YAAM,gBAAgB;AAAA,QACpB,wBAAwB,KAAK,KAAK,UAAU,KAAK,KAAK,WAAW;AAAA,QACjE;AAAA,MACF;AAGA,YAAM,OAAO,gBAAgB;AAO7B,UAAI,iBAAiB,QAAQ,yBAAyB,YAAY;AAChE,cAAM,sBAAsB,IAAI,oBAAoB,MAAM;AAC1D,cAAM,qBAAqB,KAAK,YAAY,mBAAmB;AAE/D;AAAA,UACE,cAAc,kBAAkB;AAAA,UAChC;AAAA,UACA,CAAC,UAAmB;AAClB,oBAAQ,OAAO,KAAK,IAAI,QAAQ,KAAK;AAAA,UACvC;AAAA,QACF;AACA;AAAA,MACF;AAEA;AAAA,QACE,cAAc,IAAI;AAAA,QAClB,aAAa;AAAA,QACb;AAAA,QACA,CAAC,UAAmB;AAClB,kBAAQ,OAAO,KAAK,IAAI,QAAQ,KAAK;AAAA,QACvC;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAkBA,eAAsB,iBACpB,aACA,aACA,eAC6B;AAC7B,QAAM,kBAAkB,MAAM;AAAA,IAC5B,IAAI,IAAI,aAAa,WAAW,EAAE,SAAS;AAAA,IAC3C;AAAA,MACE,SAAS;AAAA;AAAA,QAEP,QAAQ,MAAM,WAAW,IACrB,6EACA;AAAA,MACN;AAAA,IACF;AAAA,EACF;AACA,MAAI,CAAC,gBAAgB,IAAI;AACvB,UAAM,IAAI;AAAA,MACR,oDAAoD,gBAAgB,MAAM;AAAA,IAC5E;AAAA,EACF;AACA,QAAM,kBAAkB,MAAM,gBAAgB,KAAK;AAEnD,MAAI,CAAC,SAAS,eAAe,GAAG;AAC9B,UAAM,IAAI;AAAA,MACR,4BAA4B,WAAW;AAAA,IACzC;AAAA,EACF;AAEA,SAAO;AACT;AASO,SAAS,wBAAwB,aAAkB,aAAqB;AAC7E,MAAI,gBAAgB;AACpB,MAAI,YAAY,aAAa,IAAI;AAC/B,qBAAiB,YAAY;AAC7B,QAAI,YAAY,aAAa,IAAI;AAC/B,uBAAiB,IAAI,YAAY,QAAQ;AAAA,IAC3C;AACA,qBAAiB;AAAA,EACnB;AACA,SAAO,GAAG,aAAa,GAAG,YAAY,IAAI,IAAI,WAAW;AAC3D;AAQA,SAAS,MAAM,aAAkB;AAC/B,SAAO,YAAY,SAAS,MAAM,qBAAqB,SAAS;AAClE;AAeA,eAAe,kBACb,aACA,cACA,aACA,eAC+D;AAE/D,MAAI,MAAM,WAAW,KAAK,qBAAqB,YAAY,GAAG;AAC5D,WAAO;AAAA,MACL,YAAY,iBAAiB,aAAa,YAAY;AAAA,MACtD,eAAe;AAAA,IACjB;AAAA,EACF;AAEA,QAAM,kBAAkB,MAAM;AAAA,IAC5B;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,WAAW,OAAO,KAAK,iBAAiB,YAAY,CAAC,CAAC,EAAE;AAAA,IAC5D,CAAC,YAAY;AACX,4BAAsB,OAAO;AAC7B,aAAO;AAAA,IACT;AAAA,EACF;AAEA,QAAM,gBAAgB,iBAAiB,UAAU,YAAY;AAE7D,MAAI,kBAAkB,MAAM;AAC1B,UAAM,IAAI;AAAA,MACR,kEAAkE,WAAW,iCAAiC,YAAY;AAAA,IAC5H;AAAA,EACF;AAEA,QAAM,aAAa,iBAAiB,WAAW,aAAa,GAAG,MAAM;AAErE,SAAO,EAAE,YAAY,cAAc;AACrC;AAMA,IAAM,0BAA0B;AAWhC,SAAS,cAAc,QAAkC;AACvD,MAAI,OAAO,OAAO,cAAc,YAAY;AAC1C,WAAO;AAAA,EACT;AAEA,SAAO,IAAI,wBAAwB,MAAM;AAC3C;AAUA,SAAS,oBACP,eACA,OACU;AACV;AAAA,IACE,cAAc,SAAS,GAAG;AAAA,IAC1B;AAAA,EACF;AAEA;AAAA,IACE,cAAc,WAAW,MAAM;AAAA,IAC/B;AAAA,EACF;AAGA,QAAM,gBAAgB,WAAW;AAEjC,MAAI,YAAY;AAIhB,gBAAc,GAAG,SAAS,CAAC,QAAQ,aAAa,SAAS;AACvD,UAAM,EAAE,MAAM,YAAY,MAAM,WAAW,IAAI;AAC/C,QAAI,eAAe,QAAQ;AAEzB,YAAM,OAAO,WAAW,QAAQ,yBAAyB,EAAE;AAC3D,aAAO,YAAY;AAAA,QACjB,OAAO,EAAE,UAAU,aAAa,GAAG,CAAC,SAAS;AAC3C,cAAI;AACF,yBAAa,KAAK;AAElB;AAAA,cACE,YAAY;AAAA,cACZ,iCAAiC,yBAAyB;AAAA,YAC5D;AACA,kBAAM,QAAQ,IAAI,YAAY;AAAA,cAC5B,OAAO;AAAA,cACP;AAAA,cACA,MAAM;AAAA,gBACJ,eAAe,IAAI,IAAI,MAAM,aAAa,EAAE,SAAS;AAAA,cACvD;AAAA,YACF,CAAC;AAED;AAAA,cACE,CAAC,MAAM,IAAI,IAAI;AAAA,cACf;AAAA,YACF;AACA,kBAAM,IAAI,MAAM,KAAK;AACrB,mBAAO,KAAK;AAAA,UACd,SAAS,OAAO;AACd,mBAAO,cAAc,QAAQ,KAAK;AAAA,UACpC;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAKA,gBAAY,GAAG,OAAO,MAAM,KAAK,CAAC;AAClC,WAAO,YAAY,OAAO;AAAA,EAC5B,CAAC;AACD,SAAO;AACT;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/cronjob/CronjobController.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,SAAS,sBAAsB;AAE/B;AAAA,EACE;AAAA,EACA;AAAA,OACK;AAMP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,UAAU,sBAAsB;AAkClC,IAAM,gBAAgB,eAAe,IAAI,SAAS,IAAI;AAwB7D,IAAM,iBAAiB;AA3EvB;AAiFO,IAAM,oBAAN,cAAgC,eAIrC;AAAA,EAUA,YAAY,EAAE,WAAW,MAAM,GAA0B;AACvD,UAAM;AAAA,MACJ;AAAA,MACA,UAAU;AAAA,QACR,MAAM,EAAE,SAAS,MAAM,WAAW,MAAM;AAAA,MAC1C;AAAA,MACA,MAAM;AAAA,MACN,OAAO;AAAA,QACL,MAAM,CAAC;AAAA,QACP,GAAG;AAAA,MACL;AAAA,IACF,CAAC;AApBH;AAEA;AAEA;AAGA;AAAA;AAcE,uBAAK,SAAU,oBAAI,IAAI;AACvB,uBAAK,UAAW,oBAAI,IAAI;AACxB,uBAAK,YAAa;AAElB,SAAK,2BAA2B,KAAK,yBAAyB,KAAK,IAAI;AACvE,SAAK,6BACH,KAAK,2BAA2B,KAAK,IAAI;AAC3C,SAAK,0BAA0B,KAAK,wBAAwB,KAAK,IAAI;AAIrE,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAGA,SAAK,aAAa,EAAE,MAAM,CAAC,UAAU;AACnC,eAAS,KAAK;AAAA,IAChB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,aAAwB;AAC9B,UAAM,QAAQ,KAAK,gBAAgB,KAAK,uBAAuB;AAC/D,UAAM,gBAAgB,iBAAiB,KAAK;AAE5C,UAAM,OAAO,cAAc,IAAI,CAAC,SAAS,KAAK,YAAY,KAAK,EAAE,CAAC;AAElE,WAAO,KAAK,KAAK,EAAE,OAAO,CAAC,QAAQ,QAAQ,MAAS;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,YAAY,QAAuC;AACzD,UAAM,cAAc,mBAAK,YAAW;AAAA,MAClC;AAAA,MACA;AAAA,IACF;AAEA,UAAM,aAAa,cAAc,eAAe,OAAO;AACvD,UAAM,cAAc,qBAAqB,UAAU;AAEnD,WAAO,aAAa,IAAI,CAAC,YAAY,QAAQ;AAC3C,aAAO,EAAE,GAAG,YAAY,IAAI,GAAG,MAAM,IAAI,GAAG,IAAI,OAAO;AAAA,IACzD,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,SAAS,QAAgB;AACvB,UAAM,OAAO,KAAK,YAAY,MAAM;AACpC,UAAM,QAAQ,CAAC,QAAQ,KAAK,SAAS,GAAG,CAAC;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaQ,SAAS,KAAc;AAC7B,QAAI,mBAAK,SAAQ,IAAI,IAAI,EAAE,GAAG;AAC5B;AAAA,IACF;AAEA,UAAM,SAAS,oBAAoB,IAAI,UAAU;AACjD,UAAM,OAAO,OAAO,KAAK;AACzB,UAAM,MAAM,oBAAI,KAAK;AACrB,UAAM,KAAK,KAAK,QAAQ,IAAI,IAAI,QAAQ;AAGxC,QAAI,KAAK,eAAe;AACtB;AAAA,IACF;AAEA,UAAM,QAAQ,IAAI,MAAM,EAAE;AAC1B,UAAM,MAAM,MAAM;AAChB,WAAK,eAAe,GAAG,EAAE,MAAM,CAAC,UAAU;AAExC,iBAAS,KAAK;AAAA,MAChB,CAAC;AAED,yBAAK,SAAQ,OAAO,IAAI,EAAE;AAC1B,WAAK,SAAS,GAAG;AAAA,IACnB,CAAC;AAED,QAAI,CAAC,KAAK,MAAM,KAAK,IAAI,EAAE,GAAG,SAAS;AACrC,WAAK,sBAAsB,IAAI,IAAI,CAAC;AAAA,IACtC;AAEA,uBAAK,SAAQ,IAAI,IAAI,IAAI,KAAK;AAC9B,uBAAK,UAAS,IAAI,IAAI,IAAI,IAAI,MAAM;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAc,eAAe,KAAc;AACzC,SAAK,sBAAsB,IAAI,IAAI,KAAK,IAAI,CAAC;AAC7C,UAAM,mBAAK,YAAW,KAAK,gCAAgC;AAAA,MACzD,QAAQ,IAAI;AAAA,MACZ,QAAQ;AAAA,MACR,SAAS,YAAY;AAAA,MACrB,SAAS,IAAI;AAAA,IACf,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW,QAAgB;AACzB,UAAM,OAAO,CAAC,GAAG,mBAAK,UAAS,QAAQ,CAAC,EAAE;AAAA,MACxC,CAAC,CAAC,GAAG,SAAS,MAAM,cAAc;AAAA,IACpC;AAEA,QAAI,KAAK,QAAQ;AACf,WAAK,QAAQ,CAAC,CAAC,EAAE,MAAM;AACrB,cAAM,QAAQ,mBAAK,SAAQ,IAAI,EAAE;AACjC,YAAI,OAAO;AACT,gBAAM,OAAO;AACb,6BAAK,SAAQ,OAAO,EAAE;AACtB,6BAAK,UAAS,OAAO,EAAE;AAAA,QACzB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,sBAAsB,OAAe,SAAiB;AAC5D,SAAK,OAAO,CAAC,UAAU;AACrB,YAAM,KAAK,KAAK,IAAI;AAAA,QAClB;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,eAAe;AACnB,UAAM,OAAO,KAAK,WAAW;AAE7B,eAAW,OAAO,MAAM;AACtB,YAAM,SAAS,oBAAoB,IAAI,UAAU;AACjD,YAAM,UAAU,KAAK,MAAM,KAAK,IAAI,EAAE,GAAG;AAEzC,UACE,YAAY,UACZ,OAAO,QAAQ,KACf,OAAO,KAAK,EAAE,QAAQ,IAAI,SAC1B;AACA,cAAM,KAAK,eAAe,GAAG;AAAA,MAC/B;AAGA,WAAK,SAAS,GAAG;AAAA,IACnB;AAEA,uBAAK,aAAc,IAAI,MAAM,aAAa;AAC1C,uBAAK,aAAY,MAAM,MAAM;AAC3B,WAAK,aAAa,EAAE,MAAM,CAAC,UAAU;AAEnC,iBAAS,KAAK;AAAA,MAChB,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU;AACR,UAAM,QAAQ;AAGd,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAEA,SAAK,gBAAgB;AAAA,MACnB;AAAA,MACA,KAAK;AAAA,IACP;AAGA,uBAAK,UAAS,QAAQ,CAAC,WAAW;AAChC,WAAK,WAAW,MAAM;AAAA,IACxB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,yBAAyB,MAAqB;AACpD,SAAK,SAAS,KAAK,EAAE;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,2BAA2B,MAAqB;AACtD,SAAK,WAAW,KAAK,EAAE;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,wBAAwB,MAAqB;AACnD,SAAK,WAAW,KAAK,EAAE;AACvB,SAAK,SAAS,KAAK,EAAE;AAAA,EACvB;AACF;AA9SE;AAEA;AAEA;AAGA","sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { GetPermissions } from '@metamask/permission-controller';\nimport {\n getCronjobCaveatJobs,\n SnapEndowments,\n} from '@metamask/snaps-rpc-methods';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport type {\n TruncatedSnap,\n CronjobSpecification,\n} from '@metamask/snaps-utils';\nimport {\n HandlerType,\n parseCronExpression,\n logError,\n} from '@metamask/snaps-utils';\nimport { Duration, inMilliseconds } from '@metamask/utils';\n\nimport type {\n GetAllSnaps,\n HandleSnapRequest,\n SnapDisabled,\n SnapEnabled,\n SnapInstalled,\n SnapUninstalled,\n SnapUpdated,\n} from '..';\nimport { getRunnableSnaps } from '..';\nimport { Timer } from '../snaps/Timer';\n\nexport type CronjobControllerActions =\n | GetAllSnaps\n | HandleSnapRequest\n | GetPermissions;\n\nexport type CronjobControllerEvents =\n | SnapInstalled\n | SnapUninstalled\n | SnapUpdated\n | SnapEnabled\n | SnapDisabled;\n\nexport type CronjobControllerMessenger = RestrictedControllerMessenger<\n 'CronjobController',\n CronjobControllerActions,\n CronjobControllerEvents,\n CronjobControllerActions['type'],\n CronjobControllerEvents['type']\n>;\n\nexport const DAILY_TIMEOUT = inMilliseconds(24, Duration.Hour);\n\nexport type CronjobControllerArgs = {\n messenger: CronjobControllerMessenger;\n /**\n * Persisted state that will be used for rehydration.\n */\n state?: CronjobControllerState;\n};\n\nexport type Cronjob = {\n timer?: Timer;\n id: string;\n snapId: SnapId;\n} & CronjobSpecification;\n\nexport type StoredJobInformation = {\n lastRun: number;\n};\n\nexport type CronjobControllerState = {\n jobs: Record<string, StoredJobInformation>;\n};\n\nconst controllerName = 'CronjobController';\n\n/**\n * Use this controller to register and schedule periodically executed jobs\n * using RPC method hooks.\n */\nexport class CronjobController extends BaseController<\n typeof controllerName,\n CronjobControllerState,\n CronjobControllerMessenger\n> {\n #messenger: CronjobControllerMessenger;\n\n #dailyTimer!: Timer;\n\n #timers: Map<string, Timer>;\n\n // Mapping from jobId to snapId\n #snapIds: Map<string, string>;\n\n constructor({ messenger, state }: CronjobControllerArgs) {\n super({\n messenger,\n metadata: {\n jobs: { persist: true, anonymous: false },\n },\n name: controllerName,\n state: {\n jobs: {},\n ...state,\n },\n });\n this.#timers = new Map();\n this.#snapIds = new Map();\n this.#messenger = messenger;\n\n this._handleSnapRegisterEvent = this._handleSnapRegisterEvent.bind(this);\n this._handleSnapUnregisterEvent =\n this._handleSnapUnregisterEvent.bind(this);\n this._handleEventSnapUpdated = this._handleEventSnapUpdated.bind(this);\n\n // Subscribe to Snap events\n /* eslint-disable @typescript-eslint/unbound-method */\n this.messagingSystem.subscribe(\n 'SnapController:snapInstalled',\n this._handleSnapRegisterEvent,\n );\n\n this.messagingSystem.subscribe(\n 'SnapController:snapUninstalled',\n this._handleSnapUnregisterEvent,\n );\n\n this.messagingSystem.subscribe(\n 'SnapController:snapEnabled',\n this._handleSnapRegisterEvent,\n );\n\n this.messagingSystem.subscribe(\n 'SnapController:snapDisabled',\n this._handleSnapUnregisterEvent,\n );\n\n this.messagingSystem.subscribe(\n 'SnapController:snapUpdated',\n this._handleEventSnapUpdated,\n );\n /* eslint-enable @typescript-eslint/unbound-method */\n\n this.dailyCheckIn().catch((error) => {\n logError(error);\n });\n }\n\n /**\n * Retrieve all cronjob specifications for all runnable snaps.\n *\n * @returns Array of Cronjob specifications.\n */\n private getAllJobs(): Cronjob[] {\n const snaps = this.messagingSystem.call('SnapController:getAll');\n const filteredSnaps = getRunnableSnaps(snaps);\n\n const jobs = filteredSnaps.map((snap) => this.getSnapJobs(snap.id));\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion\n return jobs.flat().filter((job) => job !== undefined) as Cronjob[];\n }\n\n /**\n * Retrieve all Cronjob specifications for a Snap.\n *\n * @param snapId - ID of a Snap.\n * @returns Array of Cronjob specifications.\n */\n private getSnapJobs(snapId: SnapId): Cronjob[] | undefined {\n const permissions = this.#messenger.call(\n 'PermissionController:getPermissions',\n snapId,\n );\n\n const permission = permissions?.[SnapEndowments.Cronjob];\n const definitions = getCronjobCaveatJobs(permission);\n\n return definitions?.map((definition, idx) => {\n return { ...definition, id: `${snapId}-${idx}`, snapId };\n });\n }\n\n /**\n * Register cron jobs for a given snap by getting specification from a permission caveats.\n * Once registered, each job will be scheduled.\n *\n * @param snapId - ID of a snap.\n */\n register(snapId: SnapId) {\n const jobs = this.getSnapJobs(snapId);\n jobs?.forEach((job) => this.schedule(job));\n }\n\n /**\n * Schedule a new job.\n * This will interpret the cron expression and tell the timer to execute the job\n * at the next suitable point in time.\n * Job last run state will be initialized afterwards.\n *\n * Note: Schedule will be skipped if the job's execution time is too far in the future and\n * will be revisited on a daily check.\n *\n * @param job - Cronjob specification.\n */\n private schedule(job: Cronjob) {\n if (this.#timers.has(job.id)) {\n return;\n }\n\n const parsed = parseCronExpression(job.expression);\n const next = parsed.next();\n const now = new Date();\n const ms = next.getTime() - now.getTime();\n\n // Don't schedule this job yet as it is too far in the future\n if (ms > DAILY_TIMEOUT) {\n return;\n }\n\n const timer = new Timer(ms);\n timer.start(() => {\n this.executeCronjob(job).catch((error) => {\n // TODO: Decide how to handle errors.\n logError(error);\n });\n\n this.#timers.delete(job.id);\n this.schedule(job);\n });\n\n if (!this.state.jobs[job.id]?.lastRun) {\n this.updateJobLastRunState(job.id, 0); // 0 for init, never ran actually\n }\n\n this.#timers.set(job.id, timer);\n this.#snapIds.set(job.id, job.snapId);\n }\n\n /**\n * Execute job.\n *\n * @param job - Cronjob specification.\n */\n private async executeCronjob(job: Cronjob) {\n this.updateJobLastRunState(job.id, Date.now());\n await this.#messenger.call('SnapController:handleRequest', {\n snapId: job.snapId,\n origin: '',\n handler: HandlerType.OnCronjob,\n request: job.request,\n });\n }\n\n /**\n * Unregister all jobs related to the given snapId.\n *\n * @param snapId - ID of a snap.\n */\n unregister(snapId: string) {\n const jobs = [...this.#snapIds.entries()].filter(\n ([_, jobSnapId]) => jobSnapId === snapId,\n );\n\n if (jobs.length) {\n jobs.forEach(([id]) => {\n const timer = this.#timers.get(id);\n if (timer) {\n timer.cancel();\n this.#timers.delete(id);\n this.#snapIds.delete(id);\n }\n });\n }\n }\n\n /**\n * Update time of a last run for the Cronjob specified by ID.\n *\n * @param jobId - ID of a cron job.\n * @param lastRun - Unix timestamp when the job was last ran.\n */\n private updateJobLastRunState(jobId: string, lastRun: number) {\n this.update((state) => {\n state.jobs[jobId] = {\n lastRun,\n };\n });\n }\n\n /**\n * Runs every 24 hours to check if new jobs need to be scheduled.\n *\n * This is necessary for longer running jobs that execute with more than 24 hours between them.\n */\n async dailyCheckIn() {\n const jobs = this.getAllJobs();\n\n for (const job of jobs) {\n const parsed = parseCronExpression(job.expression);\n const lastRun = this.state.jobs[job.id]?.lastRun;\n // If a job was supposed to run while we were shut down but wasn't we run it now\n if (\n lastRun !== undefined &&\n parsed.hasPrev() &&\n parsed.prev().getTime() > lastRun\n ) {\n await this.executeCronjob(job);\n }\n\n // Try scheduling, will fail if an existing scheduled job is found\n this.schedule(job);\n }\n\n this.#dailyTimer = new Timer(DAILY_TIMEOUT);\n this.#dailyTimer.start(() => {\n this.dailyCheckIn().catch((error) => {\n // TODO: Decide how to handle errors.\n logError(error);\n });\n });\n }\n\n /**\n * Run controller teardown process and unsubscribe from Snap events.\n */\n destroy() {\n super.destroy();\n\n /* eslint-disable @typescript-eslint/unbound-method */\n this.messagingSystem.unsubscribe(\n 'SnapController:snapInstalled',\n this._handleSnapRegisterEvent,\n );\n\n this.messagingSystem.unsubscribe(\n 'SnapController:snapUninstalled',\n this._handleSnapUnregisterEvent,\n );\n\n this.messagingSystem.unsubscribe(\n 'SnapController:snapEnabled',\n this._handleSnapRegisterEvent,\n );\n\n this.messagingSystem.unsubscribe(\n 'SnapController:snapDisabled',\n this._handleSnapUnregisterEvent,\n );\n\n this.messagingSystem.unsubscribe(\n 'SnapController:snapUpdated',\n this._handleEventSnapUpdated,\n );\n /* eslint-enable @typescript-eslint/unbound-method */\n\n this.#snapIds.forEach((snapId) => {\n this.unregister(snapId);\n });\n }\n\n /**\n * Handle events that should cause cronjobs to be registered.\n *\n * @param snap - Basic Snap information.\n */\n private _handleSnapRegisterEvent(snap: TruncatedSnap) {\n this.register(snap.id);\n }\n\n /**\n * Handle events that should cause cronjobs to be unregistered.\n *\n * @param snap - Basic Snap information.\n */\n private _handleSnapUnregisterEvent(snap: TruncatedSnap) {\n this.unregister(snap.id);\n }\n\n /**\n * Handle cron jobs on 'snapUpdated' event.\n *\n * @param snap - Basic Snap information.\n */\n private _handleEventSnapUpdated(snap: TruncatedSnap) {\n this.unregister(snap.id);\n this.register(snap.id);\n }\n}\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/snaps/location/npm.ts"],"names":[],"mappings":";;;;;;;;AACA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,oBAAoB;AAC7B,OAAO,YAAY;AACnB,OAAO,sBAAsB;AAC7B,SAAS,gBAAgB;AAEzB,SAAS,+BAA+B;AACxC,SAAS,WAAW,kBAAkB;AAI/B,IAAM,uBAAuB,IAAI,IAAI,4BAA4B;AA7BxE;AAqDO,IAAe,kBAAf,MAAuD;AAAA,EAO5D,YAAY,KAAU,OAAkC,CAAC,GAAG;AA2G5D,uBAAM;AA/GN;AAEA;AAGE,UAAM,wBAAwB,KAAK,yBAAyB;AAC5D,UAAM,gBAAgB,KAAK,SAAS,WAAW,MAAM,KAAK,UAAU;AACpE,UAAM,iBAAiB,KAAK,gBAAgB;AAC5C,UAAM,iBAAiB,OAAO,UAAuB;AACrD,UAAM,iBAAiB,KAAK,kBAAkB;AAE9C,iBAAa,IAAI,SAAS,GAAG,iBAAiB,mBAAmB;AAEjE,QAAI;AACJ,QACE,IAAI,SAAS,MACb,IAAI,SAAS,MACb,IAAI,aAAa,MACjB,IAAI,aAAa,IACjB;AACA,iBAAW;AAAA,IACb,OAAO;AACL,iBAAW;AACX,UAAI,IAAI,UAAU;AAChB,oBAAY,IAAI;AAChB,YAAI,IAAI,UAAU;AAChB,sBAAY,IAAI,IAAI,QAAQ;AAAA,QAC9B;AACA,oBAAY;AAAA,MACd;AACA,kBAAY,IAAI;AAChB,iBAAW,IAAI,IAAI,QAAQ;AAC3B;AAAA,QACE;AAAA,QACA,IAAI;AAAA,UACF,qDAAqD,SAAS,SAAS,CAAC;AAAA,QAC1E;AAAA,MACF;AAAA,IACF;AAEA;AAAA,MACE,SAAS,aAAa,OACpB,SAAS,WAAW,MACpB,SAAS,SAAS;AAAA,IACtB;AAEA;AAAA,MACE,IAAI,aAAa,MAAM,IAAI,aAAa;AAAA,MACxC,IAAI,UAAU,4CAA4C;AAAA,IAC5D;AACA,QAAI,cAAc,IAAI;AACtB,QAAI,YAAY,WAAW,GAAG,GAAG;AAC/B,oBAAc,YAAY,MAAM,CAAC;AAAA,IACnC;AAEA,SAAK,OAAO;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,WAA+C;AACnD,QAAI,mBAAK,qBAAoB;AAC3B,aAAO,mBAAK,oBAAmB,MAAM;AAAA,IACvC;AAEA,UAAM,QAAQ,MAAM,KAAK,MAAM,oBAAoB;AACnD,UAAM,SAAS,UAAU,MAAM,SAAS,CAAC;AACzC,UAAM,SAAS,mBAAmB,MAAM;AACxC,uBAAK,oBAAqB;AAE1B,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,MAAM,MAAM,MAAoC;AAC9C,UAAM,eAAe,kBAAkB,IAAI;AAC3C,QAAI,CAAC,mBAAK,SAAQ;AAChB,YAAM,sBAAK,wBAAL;AACN,aAAO,mBAAK,YAAW,MAAS;AAAA,IAClC;AACA,UAAM,QAAQ,mBAAK,QAAO,IAAI,YAAY;AAC1C;AAAA,MACE,UAAU;AAAA,MACV,IAAI,UAAU,SAAS,IAAI,yBAAyB;AAAA,IACtD;AACA,WAAO,MAAM,MAAM;AAAA,EACrB;AAAA,EAEA,IAAI,cAAsB;AACxB,WAAO,KAAK,KAAK;AAAA,EACnB;AAAA,EAEA,IAAI,UAAkB;AACpB;AAAA,MACE,KAAK,KAAK,YAAY;AAAA,MACtB;AAAA,IACF;AACA,WAAO,KAAK,KAAK;AAAA,EACnB;AAAA,EAEA,IAAI,WAAgB;AAClB,WAAO,KAAK,KAAK;AAAA,EACnB;AAAA,EAEA,IAAI,eAA4B;AAC9B,WAAO,KAAK,KAAK;AAAA,EACnB;AAwCF;AArJE;AAEA;AA6GM;AAAA,cAAS,iBAAG;AAChB,SAAO,mBAAK,YAAW,MAAS;AAChC,QAAM,kBAAkB,MAAM,KAAK,KAAK;AAAA,IACtC,KAAK,KAAK;AAAA,EACZ;AAEA,QAAM,EAAE,YAAY,cAAc,IAAI,MAAM;AAAA,IAC1C,KAAK,KAAK;AAAA,IACV;AAAA,IACA,KAAK,KAAK;AAAA,IACV,KAAK,KAAK;AAAA,EACZ;AAEA,MAAI,CAAC,WAAW,UAAU,KAAK,CAAC,WAAW,SAAS,EAAE,SAAS,MAAM,GAAG;AACtE,UAAM,IAAI;AAAA,MACR,iEAAiE,KAAK,KAAK,WAAW;AAAA,IACxF;AAAA,EACF;AAGA,QAAM,gBAAgB,IAAI,IAAI,UAAU;AACxC,gBAAc,WAAW,KAAK,KAAK,SAAS;AAC5C,gBAAc,WAAW,KAAK,KAAK,SAAS;AAE5C,QAAM,QAAQ,MAAM,KAAK,gBAAgB,aAAa;AAEtD,qBAAK,QAAS;AACd,OAAK,KAAK,UAAU;AACtB;AAaK,IAAM,4BAA4B;AAGlC,IAAM,cAAN,cAA0B,gBAAgB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ/C,MAAM,gBACJ,YAC4C;AAE5C,UAAM,kBAAkB,MAAM,KAAK,KAAK,MAAM,WAAW,SAAS,CAAC;AACnE,QAAI,CAAC,gBAAgB,MAAM,CAAC,gBAAgB,MAAM;AAChD,YAAM,IAAI;AAAA,QACR,wCAAwC,KAAK,KAAK,WAAW;AAAA,MAC/D;AAAA,IACF;AAGA,UAAM,oBAAoB,gBAAgB,QAAQ,IAAI,gBAAgB;AACtE,WAAO,mBAAmB,yCAAyC;AACnE,UAAM,cAAc,SAAS,mBAAmB,EAAE;AAClD;AAAA,MACE,eAAe;AAAA,MACf;AAAA,IACF;AACA,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,YAAM,QAAQ,oBAAI,IAAI;AAEtB,YAAM,gBAAgB;AAAA,QACpB,wBAAwB,KAAK,KAAK,UAAU,KAAK,KAAK,WAAW;AAAA,QACjE;AAAA,MACF;AAGA,YAAM,OAAO,gBAAgB;AAO7B,UAAI,iBAAiB,QAAQ,yBAAyB,YAAY;AAChE,cAAM,sBAAsB,IAAI,oBAAoB,MAAM;AAC1D,cAAM,qBAAqB,KAAK,YAAY,mBAAmB;AAE/D;AAAA,UACE,cAAc,kBAAkB;AAAA,UAChC;AAAA,UACA,CAAC,UAAmB;AAClB,oBAAQ,OAAO,KAAK,IAAI,QAAQ,KAAK;AAAA,UACvC;AAAA,QACF;AACA;AAAA,MACF;AAEA;AAAA,QACE,cAAc,IAAI;AAAA,QAClB,aAAa;AAAA,QACb;AAAA,QACA,CAAC,UAAmB;AAClB,kBAAQ,OAAO,KAAK,IAAI,QAAQ,KAAK;AAAA,QACvC;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAkBA,eAAsB,iBACpB,aACA,aACA,eAC6B;AAC7B,QAAM,kBAAkB,MAAM;AAAA,IAC5B,IAAI,IAAI,aAAa,WAAW,EAAE,SAAS;AAAA,IAC3C;AAAA,MACE,SAAS;AAAA;AAAA,QAEP,QAAQ,MAAM,WAAW,IACrB,6EACA;AAAA,MACN;AAAA,IACF;AAAA,EACF;AACA,MAAI,CAAC,gBAAgB,IAAI;AACvB,UAAM,IAAI;AAAA,MACR,oDAAoD,gBAAgB,MAAM;AAAA,IAC5E;AAAA,EACF;AACA,QAAM,kBAAkB,MAAM,gBAAgB,KAAK;AAEnD,MAAI,CAAC,SAAS,eAAe,GAAG;AAC9B,UAAM,IAAI;AAAA,MACR,4BAA4B,WAAW;AAAA,IACzC;AAAA,EACF;AAEA,SAAO;AACT;AASO,SAAS,wBAAwB,aAAkB,aAAqB;AAC7E,MAAI,gBAAgB;AACpB,MAAI,YAAY,aAAa,IAAI;AAC/B,qBAAiB,YAAY;AAC7B,QAAI,YAAY,aAAa,IAAI;AAC/B,uBAAiB,IAAI,YAAY,QAAQ;AAAA,IAC3C;AACA,qBAAiB;AAAA,EACnB;AACA,SAAO,GAAG,aAAa,GAAG,YAAY,IAAI,IAAI,WAAW;AAC3D;AAQA,SAAS,MAAM,aAAkB;AAC/B,SAAO,YAAY,SAAS,MAAM,qBAAqB,SAAS;AAClE;AAeA,eAAe,kBACb,aACA,cACA,aACA,eAC+D;AAE/D,MAAI,MAAM,WAAW,KAAK,qBAAqB,YAAY,GAAG;AAC5D,WAAO;AAAA,MACL,YAAY,iBAAiB,aAAa,YAAY;AAAA,MACtD,eAAe;AAAA,IACjB;AAAA,EACF;AAEA,QAAM,kBAAkB,MAAM;AAAA,IAC5B;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,QAAM,WAAW,OAAO,KAAK,iBAAiB,YAAY,CAAC,CAAC,EAAE;AAAA,IAC5D,CAAC,YAAY;AACX,4BAAsB,OAAO;AAC7B,aAAO;AAAA,IACT;AAAA,EACF;AAEA,QAAM,gBAAgB,iBAAiB,UAAU,YAAY;AAE7D,MAAI,kBAAkB,MAAM;AAC1B,UAAM,IAAI;AAAA,MACR,kEAAkE,WAAW,iCAAiC,YAAY;AAAA,IAC5H;AAAA,EACF;AAEA,QAAM,aAAa,iBAAiB,WAAW,aAAa,GAAG,MAAM;AAErE,SAAO,EAAE,YAAY,cAAc;AACrC;AAMA,IAAM,0BAA0B;AAWhC,SAAS,cAAc,QAAkC;AACvD,MAAI,OAAO,OAAO,cAAc,YAAY;AAC1C,WAAO;AAAA,EACT;AAEA,SAAO,IAAI,wBAAwB,MAAM;AAC3C;AAUA,SAAS,oBACP,eACA,OACU;AACV;AAAA,IACE,cAAc,SAAS,GAAG;AAAA,IAC1B;AAAA,EACF;AAEA;AAAA,IACE,cAAc,WAAW,MAAM;AAAA,IAC/B;AAAA,EACF;AAGA,QAAM,gBAAgB,WAAW;AAEjC,MAAI,YAAY;AAIhB,gBAAc,GAAG,SAAS,CAAC,QAAQ,aAAa,SAAS;AACvD,UAAM,EAAE,MAAM,YAAY,MAAM,WAAW,IAAI;AAC/C,QAAI,eAAe,QAAQ;AAEzB,YAAM,OAAO,WAAW,QAAQ,yBAAyB,EAAE;AAC3D,aAAO,YAAY;AAAA,QACjB,OAAO,EAAE,UAAU,aAAa,GAAG,CAAC,SAAS;AAC3C,cAAI;AACF,yBAAa,KAAK;AAElB;AAAA,cACE,YAAY;AAAA,cACZ,iCAAiC,yBAAyB;AAAA,YAC5D;AACA,kBAAM,QAAQ,IAAI,YAAY;AAAA,cAC5B,OAAO;AAAA,cACP;AAAA,cACA,MAAM;AAAA,gBACJ,eAAe,IAAI,IAAI,MAAM,aAAa,EAAE,SAAS;AAAA,cACvD;AAAA,YACF,CAAC;AAED;AAAA,cACE,CAAC,MAAM,IAAI,IAAI;AAAA,cACf;AAAA,YACF;AACA,kBAAM,IAAI,MAAM,KAAK;AACrB,mBAAO,KAAK;AAAA,UACd,SAAS,OAAO;AACd,mBAAO,cAAc,QAAQ,KAAK;AAAA,UACpC;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAKA,gBAAY,GAAG,OAAO,MAAM,KAAK,CAAC;AAClC,WAAO,YAAY,OAAO;AAAA,EAC5B,CAAC;AACD,SAAO;AACT","sourcesContent":["import type { SnapManifest } from '@metamask/snaps-utils';\nimport {\n createSnapManifest,\n DEFAULT_REQUESTED_SNAP_VERSION,\n getTargetVersion,\n isValidUrl,\n NpmSnapIdStruct,\n VirtualFile,\n normalizeRelative,\n parseJson,\n} from '@metamask/snaps-utils';\nimport type { SemVerRange, SemVerVersion } from '@metamask/utils';\nimport {\n assert,\n assertIsSemVerVersion,\n assertStruct,\n isObject,\n isValidSemVerVersion,\n} from '@metamask/utils';\nimport { createGunzip } from 'browserify-zlib';\nimport concat from 'concat-stream';\nimport getNpmTarballUrl from 'get-npm-tarball-url';\nimport { pipeline } from 'readable-stream';\nimport type { Readable, Writable } from 'readable-stream';\nimport { ReadableWebToNodeStream } from 'readable-web-to-node-stream';\nimport { extract as tarExtract } from 'tar-stream';\n\nimport type { DetectSnapLocationOptions, SnapLocation } from './location';\n\nexport const DEFAULT_NPM_REGISTRY = new URL('https://registry.npmjs.org');\n\ninterface NpmMeta {\n registry: URL;\n packageName: string;\n requestedRange: SemVerRange;\n version?: string;\n fetch: typeof fetch;\n resolveVersion: (range: SemVerRange) => Promise<SemVerRange>;\n}\nexport interface NpmOptions {\n /**\n * @default DEFAULT_REQUESTED_SNAP_VERSION\n */\n versionRange?: SemVerRange;\n /**\n * Whether to allow custom NPM registries outside of {@link DEFAULT_NPM_REGISTRY}.\n *\n * @default false\n */\n allowCustomRegistries?: boolean;\n}\n\n// Base class for NPM implementation, useful for extending with custom NPM fetching logic\nexport abstract class BaseNpmLocation implements SnapLocation {\n protected readonly meta: NpmMeta;\n\n #validatedManifest?: VirtualFile<SnapManifest>;\n\n #files?: Map<string, VirtualFile>;\n\n constructor(url: URL, opts: DetectSnapLocationOptions = {}) {\n const allowCustomRegistries = opts.allowCustomRegistries ?? false;\n const fetchFunction = opts.fetch ?? globalThis.fetch.bind(globalThis);\n const requestedRange = opts.versionRange ?? DEFAULT_REQUESTED_SNAP_VERSION;\n const defaultResolve = async (range: SemVerRange) => range;\n const resolveVersion = opts.resolveVersion ?? defaultResolve;\n\n assertStruct(url.toString(), NpmSnapIdStruct, 'Invalid Snap Id: ');\n\n let registry: string | URL;\n if (\n url.host === '' &&\n url.port === '' &&\n url.username === '' &&\n url.password === ''\n ) {\n registry = DEFAULT_NPM_REGISTRY;\n } else {\n registry = 'https://';\n if (url.username) {\n registry += url.username;\n if (url.password) {\n registry += `:${url.password}`;\n }\n registry += '@';\n }\n registry += url.host;\n registry = new URL(registry);\n assert(\n allowCustomRegistries,\n new TypeError(\n `Custom NPM registries are disabled, tried to use \"${registry.toString()}\".`,\n ),\n );\n }\n\n assert(\n registry.pathname === '/' &&\n registry.search === '' &&\n registry.hash === '',\n );\n\n assert(\n url.pathname !== '' && url.pathname !== '/',\n new TypeError('The package name in NPM location is empty.'),\n );\n let packageName = url.pathname;\n if (packageName.startsWith('/')) {\n packageName = packageName.slice(1);\n }\n\n this.meta = {\n requestedRange,\n registry,\n packageName,\n fetch: fetchFunction,\n resolveVersion,\n };\n }\n\n async manifest(): Promise<VirtualFile<SnapManifest>> {\n if (this.#validatedManifest) {\n return this.#validatedManifest.clone();\n }\n\n const vfile = await this.fetch('snap.manifest.json');\n const result = parseJson(vfile.toString());\n vfile.result = createSnapManifest(result);\n this.#validatedManifest = vfile as VirtualFile<SnapManifest>;\n\n return this.manifest();\n }\n\n async fetch(path: string): Promise<VirtualFile> {\n const relativePath = normalizeRelative(path);\n if (!this.#files) {\n await this.#lazyInit();\n assert(this.#files !== undefined);\n }\n const vfile = this.#files.get(relativePath);\n assert(\n vfile !== undefined,\n new TypeError(`File \"${path}\" not found in package.`),\n );\n return vfile.clone();\n }\n\n get packageName(): string {\n return this.meta.packageName;\n }\n\n get version(): string {\n assert(\n this.meta.version !== undefined,\n 'Tried to access version without first fetching NPM package.',\n );\n return this.meta.version;\n }\n\n get registry(): URL {\n return this.meta.registry;\n }\n\n get versionRange(): SemVerRange {\n return this.meta.requestedRange;\n }\n\n async #lazyInit() {\n assert(this.#files === undefined);\n const resolvedVersion = await this.meta.resolveVersion(\n this.meta.requestedRange,\n );\n\n const { tarballURL, targetVersion } = await resolveNpmVersion(\n this.meta.packageName,\n resolvedVersion,\n this.meta.registry,\n this.meta.fetch,\n );\n\n if (!isValidUrl(tarballURL) || !tarballURL.toString().endsWith('.tgz')) {\n throw new Error(\n `Failed to find valid tarball URL in NPM metadata for package \"${this.meta.packageName}\".`,\n );\n }\n\n // Override the tarball hostname/protocol with registryUrl hostname/protocol\n const newTarballUrl = new URL(tarballURL);\n newTarballUrl.hostname = this.meta.registry.hostname;\n newTarballUrl.protocol = this.meta.registry.protocol;\n\n const files = await this.fetchNpmTarball(newTarballUrl);\n\n this.#files = files;\n this.meta.version = targetVersion;\n }\n\n /**\n * Fetches and unpacks the tarball (`.tgz` file) from the specified URL.\n *\n * @param tarballUrl - The tarball URL to fetch and unpack.\n * @returns A the files for the package tarball.\n * @throws If fetching the tarball fails.\n */\n abstract fetchNpmTarball(tarballUrl: URL): Promise<Map<string, VirtualFile>>;\n}\n\n// Safety limit for tarballs, 250 MB in bytes\nexport const TARBALL_SIZE_SAFETY_LIMIT = 262144000;\n\n// Main NPM implementation, contains a browser tarball fetching implementation.\nexport class NpmLocation extends BaseNpmLocation {\n /**\n * Fetches and unpacks the tarball (`.tgz` file) from the specified URL.\n *\n * @param tarballUrl - The tarball URL to fetch and unpack.\n * @returns A the files for the package tarball.\n * @throws If fetching the tarball fails.\n */\n async fetchNpmTarball(\n tarballUrl: URL,\n ): Promise<Map<string, VirtualFile<unknown>>> {\n // Perform a raw fetch because we want the Response object itself.\n const tarballResponse = await this.meta.fetch(tarballUrl.toString());\n if (!tarballResponse.ok || !tarballResponse.body) {\n throw new Error(\n `Failed to fetch tarball for package \"${this.meta.packageName}\".`,\n );\n }\n\n // We assume that NPM is a good actor and provides us with a valid `content-length` header.\n const tarballSizeString = tarballResponse.headers.get('content-length');\n assert(tarballSizeString, 'Snap tarball has invalid content-length');\n const tarballSize = parseInt(tarballSizeString, 10);\n assert(\n tarballSize <= TARBALL_SIZE_SAFETY_LIMIT,\n 'Snap tarball exceeds size limit',\n );\n return new Promise((resolve, reject) => {\n const files = new Map();\n\n const tarballStream = createTarballStream(\n getNpmCanonicalBasePath(this.meta.registry, this.meta.packageName),\n files,\n );\n\n // eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n const body = tarballResponse.body!;\n\n // The \"gz\" in \"tgz\" stands for \"gzip\". The tarball needs to be decompressed\n // before we can actually grab any files from it.\n // To prevent recursion-based zip bombs, we should not allow recursion here.\n\n // If native decompression stream is available we use that, otherwise fallback to zlib.\n if ('pipeThrough' in body && 'DecompressionStream' in globalThis) {\n const decompressionStream = new DecompressionStream('gzip');\n const decompressedStream = body.pipeThrough(decompressionStream);\n\n pipeline(\n getNodeStream(decompressedStream),\n tarballStream,\n (error: unknown) => {\n error ? reject(error) : resolve(files);\n },\n );\n return;\n }\n\n pipeline(\n getNodeStream(body),\n createGunzip(),\n tarballStream,\n (error: unknown) => {\n error ? reject(error) : resolve(files);\n },\n );\n });\n }\n}\n\n// Incomplete type\nexport type PartialNpmMetadata = {\n versions: Record<string, { dist: { tarball: string } }>;\n};\n\n/**\n * Fetches the NPM metadata of the specified package from\n * the public npm registry.\n *\n * @param packageName - The name of the package whose metadata to fetch.\n * @param registryUrl - The URL of the npm registry to fetch the metadata from.\n * @param fetchFunction - The fetch function to use. Defaults to the global\n * {@link fetch}. Useful for Node.js compatibility.\n * @returns The NPM metadata object.\n * @throws If fetching the metadata fails.\n */\nexport async function fetchNpmMetadata(\n packageName: string,\n registryUrl: URL,\n fetchFunction: typeof fetch,\n): Promise<PartialNpmMetadata> {\n const packageResponse = await fetchFunction(\n new URL(packageName, registryUrl).toString(),\n {\n headers: {\n // Corgi format is slightly smaller: https://github.com/npm/pacote/blob/main/lib/registry.js#L71\n accept: isNPM(registryUrl)\n ? 'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*'\n : 'application/json',\n },\n },\n );\n if (!packageResponse.ok) {\n throw new Error(\n `Failed to fetch NPM registry entry. Status code: ${packageResponse.status}.`,\n );\n }\n const packageMetadata = await packageResponse.json();\n\n if (!isObject(packageMetadata)) {\n throw new Error(\n `Failed to fetch package \"${packageName}\" metadata from npm.`,\n );\n }\n\n return packageMetadata as PartialNpmMetadata;\n}\n\n/**\n * Gets the canonical base path for an NPM snap.\n *\n * @param registryUrl - A registry URL.\n * @param packageName - A package name.\n * @returns The canonical base path.\n */\nexport function getNpmCanonicalBasePath(registryUrl: URL, packageName: string) {\n let canonicalBase = 'npm://';\n if (registryUrl.username !== '') {\n canonicalBase += registryUrl.username;\n if (registryUrl.password !== '') {\n canonicalBase += `:${registryUrl.password}`;\n }\n canonicalBase += '@';\n }\n return `${canonicalBase}${registryUrl.host}/${packageName}/`;\n}\n\n/**\n * Determine if a registry URL is NPM.\n *\n * @param registryUrl - A registry url.\n * @returns True if the registry is the NPM registry, otherwise false.\n */\nfunction isNPM(registryUrl: URL) {\n return registryUrl.toString() === DEFAULT_NPM_REGISTRY.toString();\n}\n\n/**\n * Resolves a version range to a version using the NPM registry.\n *\n * Unless the version range is already a version, then the NPM registry is skipped.\n *\n * @param packageName - The name of the package whose metadata to fetch.\n * @param versionRange - The version range of the package.\n * @param registryUrl - The URL of the npm registry to fetch the metadata from.\n * @param fetchFunction - The fetch function to use. Defaults to the global\n * {@link fetch}. Useful for Node.js compatibility.\n * @returns An object containing the resolved version and a URL for its tarball.\n * @throws If fetching the metadata fails.\n */\nasync function resolveNpmVersion(\n packageName: string,\n versionRange: SemVerRange,\n registryUrl: URL,\n fetchFunction: typeof fetch,\n): Promise<{ tarballURL: string; targetVersion: SemVerVersion }> {\n // If the version range is already a static version we don't need to look for the metadata.\n if (isNPM(registryUrl) && isValidSemVerVersion(versionRange)) {\n return {\n tarballURL: getNpmTarballUrl(packageName, versionRange),\n targetVersion: versionRange,\n };\n }\n\n const packageMetadata = await fetchNpmMetadata(\n packageName,\n registryUrl,\n fetchFunction,\n );\n\n const versions = Object.keys(packageMetadata?.versions ?? {}).map(\n (version) => {\n assertIsSemVerVersion(version);\n return version;\n },\n );\n\n const targetVersion = getTargetVersion(versions, versionRange);\n\n if (targetVersion === null) {\n throw new Error(\n `Failed to find a matching version in npm metadata for package \"${packageName}\" and requested semver range \"${versionRange}\".`,\n );\n }\n\n const tarballURL = packageMetadata?.versions?.[targetVersion]?.dist?.tarball;\n\n return { tarballURL, targetVersion };\n}\n\n/**\n * The paths of files within npm tarballs appear to always be prefixed with\n * \"package/\".\n */\nconst NPM_TARBALL_PATH_PREFIX = /^package\\//u;\n\n/**\n * Converts a {@link ReadableStream} to a Node.js {@link Readable}\n * stream. Returns the stream directly if it is already a Node.js stream.\n * We can't use the native Web {@link ReadableStream} directly because the\n * other stream libraries we use expect Node.js streams.\n *\n * @param stream - The stream to convert.\n * @returns The given stream as a Node.js Readable stream.\n */\nfunction getNodeStream(stream: ReadableStream): Readable {\n if (typeof stream.getReader !== 'function') {\n return stream as unknown as Readable;\n }\n\n return new ReadableWebToNodeStream(stream);\n}\n\n/**\n * Creates a `tar-stream` that will get the necessary files from an npm Snap\n * package tarball (`.tgz` file).\n *\n * @param canonicalBase - A base URI as specified in {@link https://github.com/MetaMask/SIPs/blob/main/SIPS/sip-8.md SIP-8}. Starting with 'npm:'. Will be used for canonicalPath vfile argument.\n * @param files - An object to write target file contents to.\n * @returns The {@link Writable} tarball extraction stream.\n */\nfunction createTarballStream(\n canonicalBase: string,\n files: Map<string, VirtualFile>,\n): Writable {\n assert(\n canonicalBase.endsWith('/'),\n \"Base needs to end with '/' for relative paths to be added as children instead of siblings.\",\n );\n\n assert(\n canonicalBase.startsWith('npm:'),\n 'Protocol mismatch, expected \"npm:\".',\n );\n // `tar-stream` is pretty old-school, so we create it first and then\n // instrument it by adding event listeners.\n const extractStream = tarExtract();\n\n let totalSize = 0;\n\n // \"entry\" is fired for every discreet entity in the tarball. This includes\n // files and folders.\n extractStream.on('entry', (header, entryStream, next) => {\n const { name: headerName, type: headerType } = header;\n if (headerType === 'file') {\n // The name is a path if the header type is \"file\".\n const path = headerName.replace(NPM_TARBALL_PATH_PREFIX, '');\n return entryStream.pipe(\n concat({ encoding: 'uint8array' }, (data) => {\n try {\n totalSize += data.byteLength;\n // To prevent zip bombs, we set a safety limit for the total size of tarballs.\n assert(\n totalSize < TARBALL_SIZE_SAFETY_LIMIT,\n `Snap tarball exceeds limit of ${TARBALL_SIZE_SAFETY_LIMIT} bytes.`,\n );\n const vfile = new VirtualFile({\n value: data,\n path,\n data: {\n canonicalPath: new URL(path, canonicalBase).toString(),\n },\n });\n // We disallow files having identical paths as it may confuse our checksum calculations.\n assert(\n !files.has(path),\n 'Malformed tarball, multiple files with the same path.',\n );\n files.set(path, vfile);\n return next();\n } catch (error) {\n return extractStream.destroy(error);\n }\n }),\n );\n }\n\n // If we get here, the entry is not a file, and we want to ignore. The entry\n // stream must be drained, or the extractStream will stop reading. This is\n // effectively a no-op for the current entry.\n entryStream.on('end', () => next());\n return entryStream.resume();\n });\n return extractStream;\n}\n"]}