@metamask/snaps-jest 8.2.0 → 8.3.1

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 (632) hide show
  1. package/CHANGELOG.md +20 -1
  2. package/README.md +2 -2
  3. package/dist/environment.cjs +96 -0
  4. package/dist/environment.cjs.map +1 -0
  5. package/dist/{types/environment.d.ts → environment.d.cts} +5 -4
  6. package/dist/environment.d.cts.map +1 -0
  7. package/dist/environment.d.mts +53 -0
  8. package/dist/environment.d.mts.map +1 -0
  9. package/dist/environment.mjs +94 -44
  10. package/dist/environment.mjs.map +1 -1
  11. package/dist/global.cjs +4 -0
  12. package/dist/global.cjs.map +1 -0
  13. package/dist/{types/global.d.ts → global.d.cts} +2 -1
  14. package/dist/global.d.cts.map +1 -0
  15. package/dist/global.d.mts +70 -0
  16. package/dist/global.d.mts.map +1 -0
  17. package/dist/global.mjs +2 -1
  18. package/dist/global.mjs.map +1 -1
  19. package/dist/helpers.cjs +240 -0
  20. package/dist/helpers.cjs.map +1 -0
  21. package/dist/{types/helpers.d.ts → helpers.d.cts} +47 -4
  22. package/dist/helpers.d.cts.map +1 -0
  23. package/dist/helpers.d.mts +132 -0
  24. package/dist/helpers.d.mts.map +1 -0
  25. package/dist/helpers.mjs +228 -42
  26. package/dist/helpers.mjs.map +1 -1
  27. package/dist/index.cjs +29 -0
  28. package/dist/index.cjs.map +1 -0
  29. package/dist/index.d.cts +6 -0
  30. package/dist/index.d.cts.map +1 -0
  31. package/dist/index.d.mts +6 -0
  32. package/dist/index.d.mts.map +1 -0
  33. package/dist/index.mjs +6 -53
  34. package/dist/index.mjs.map +1 -1
  35. package/dist/internals/environment.cjs +18 -0
  36. package/dist/internals/environment.cjs.map +1 -0
  37. package/dist/{types/internals/environment.d.ts → internals/environment.d.cts} +1 -0
  38. package/dist/internals/environment.d.cts.map +1 -0
  39. package/dist/internals/environment.d.mts +8 -0
  40. package/dist/internals/environment.d.mts.map +1 -0
  41. package/dist/internals/environment.mjs +13 -7
  42. package/dist/internals/environment.mjs.map +1 -1
  43. package/dist/internals/index.cjs +23 -0
  44. package/dist/internals/index.cjs.map +1 -0
  45. package/dist/internals/index.d.cts +7 -0
  46. package/dist/internals/index.d.cts.map +1 -0
  47. package/dist/internals/index.d.mts +7 -0
  48. package/dist/internals/index.d.mts.map +1 -0
  49. package/dist/internals/index.mjs +6 -141
  50. package/dist/internals/index.mjs.map +1 -1
  51. package/dist/internals/logger.cjs +6 -0
  52. package/dist/internals/logger.cjs.map +1 -0
  53. package/dist/{types/internals/logger.d.ts → internals/logger.d.cts} +1 -0
  54. package/dist/internals/logger.d.cts.map +1 -0
  55. package/dist/internals/logger.d.mts +3 -0
  56. package/dist/internals/logger.d.mts.map +1 -0
  57. package/dist/internals/logger.mjs +2 -7
  58. package/dist/internals/logger.mjs.map +1 -1
  59. package/dist/internals/request.cjs +143 -0
  60. package/dist/internals/request.cjs.map +1 -0
  61. package/dist/{types/internals/request.d.ts → internals/request.d.cts} +8 -7
  62. package/dist/internals/request.d.cts.map +1 -0
  63. package/dist/internals/request.d.mts +56 -0
  64. package/dist/internals/request.d.mts.map +1 -0
  65. package/dist/internals/request.mjs +137 -41
  66. package/dist/internals/request.mjs.map +1 -1
  67. package/dist/internals/server.cjs +74 -0
  68. package/dist/internals/server.cjs.map +1 -0
  69. package/dist/{types/internals/server.d.ts → internals/server.d.cts} +4 -3
  70. package/dist/internals/server.d.cts.map +1 -0
  71. package/dist/internals/server.d.mts +15 -0
  72. package/dist/internals/server.d.mts.map +1 -0
  73. package/dist/internals/server.mjs +73 -8
  74. package/dist/internals/server.mjs.map +1 -1
  75. package/dist/internals/simulation/constants.cjs +21 -0
  76. package/dist/internals/simulation/constants.cjs.map +1 -0
  77. package/dist/{types/internals/simulation/constants.d.ts → internals/simulation/constants.d.cts} +5 -0
  78. package/dist/internals/simulation/constants.d.cts.map +1 -0
  79. package/dist/internals/simulation/constants.d.mts +18 -0
  80. package/dist/internals/simulation/constants.d.mts.map +1 -0
  81. package/dist/internals/simulation/constants.mjs +17 -11
  82. package/dist/internals/simulation/constants.mjs.map +1 -1
  83. package/dist/internals/simulation/controllers.cjs +101 -0
  84. package/dist/internals/simulation/controllers.cjs.map +1 -0
  85. package/dist/{types/internals/simulation/controllers.d.ts → internals/simulation/controllers.d.cts} +15 -14
  86. package/dist/internals/simulation/controllers.d.cts.map +1 -0
  87. package/dist/internals/simulation/controllers.d.mts +41 -0
  88. package/dist/internals/simulation/controllers.d.mts.map +1 -0
  89. package/dist/internals/simulation/controllers.mjs +95 -24
  90. package/dist/internals/simulation/controllers.mjs.map +1 -1
  91. package/dist/internals/simulation/files.cjs +94 -0
  92. package/dist/internals/simulation/files.cjs.map +1 -0
  93. package/dist/{types/internals/simulation/files.d.ts → internals/simulation/files.d.cts} +6 -4
  94. package/dist/internals/simulation/files.d.cts.map +1 -0
  95. package/dist/internals/simulation/files.d.mts +49 -0
  96. package/dist/internals/simulation/files.d.mts.map +1 -0
  97. package/dist/internals/simulation/files.mjs +90 -13
  98. package/dist/internals/simulation/files.mjs.map +1 -1
  99. package/dist/internals/simulation/index.cjs +22 -0
  100. package/dist/internals/simulation/index.cjs.map +1 -0
  101. package/dist/internals/simulation/index.d.cts +6 -0
  102. package/dist/internals/simulation/index.d.cts.map +1 -0
  103. package/dist/internals/simulation/index.d.mts +6 -0
  104. package/dist/internals/simulation/index.d.mts.map +1 -0
  105. package/dist/internals/simulation/index.mjs +5 -102
  106. package/dist/internals/simulation/index.mjs.map +1 -1
  107. package/dist/internals/simulation/interface.cjs +527 -0
  108. package/dist/internals/simulation/interface.cjs.map +1 -0
  109. package/dist/{types/internals/simulation/interface.d.ts → internals/simulation/interface.d.cts} +38 -10
  110. package/dist/internals/simulation/interface.d.cts.map +1 -0
  111. package/dist/internals/simulation/interface.d.mts +152 -0
  112. package/dist/internals/simulation/interface.d.mts.map +1 -0
  113. package/dist/internals/simulation/interface.mjs +512 -30
  114. package/dist/internals/simulation/interface.mjs.map +1 -1
  115. package/dist/internals/simulation/methods/constants.cjs +72 -0
  116. package/dist/internals/simulation/methods/constants.cjs.map +1 -0
  117. package/dist/{types/internals/simulation/methods/constants.d.ts → internals/simulation/methods/constants.d.cts} +1 -0
  118. package/dist/internals/simulation/methods/constants.d.cts.map +1 -0
  119. package/dist/internals/simulation/methods/constants.d.mts +11 -0
  120. package/dist/internals/simulation/methods/constants.d.mts.map +1 -0
  121. package/dist/internals/simulation/methods/constants.mjs +68 -11
  122. package/dist/internals/simulation/methods/constants.mjs.map +1 -1
  123. package/dist/internals/simulation/methods/hooks/get-preferences.cjs +18 -0
  124. package/dist/internals/simulation/methods/hooks/get-preferences.cjs.map +1 -0
  125. package/dist/internals/simulation/methods/hooks/get-preferences.d.cts +14 -0
  126. package/dist/internals/simulation/methods/hooks/get-preferences.d.cts.map +1 -0
  127. package/dist/internals/simulation/methods/hooks/get-preferences.d.mts +14 -0
  128. package/dist/internals/simulation/methods/hooks/get-preferences.d.mts.map +1 -0
  129. package/dist/internals/simulation/methods/hooks/get-preferences.mjs +14 -0
  130. package/dist/internals/simulation/methods/hooks/get-preferences.mjs.map +1 -0
  131. package/dist/internals/simulation/methods/hooks/index.cjs +22 -0
  132. package/dist/internals/simulation/methods/hooks/index.cjs.map +1 -0
  133. package/dist/internals/simulation/methods/hooks/index.d.cts +6 -0
  134. package/dist/internals/simulation/methods/hooks/index.d.cts.map +1 -0
  135. package/dist/internals/simulation/methods/hooks/index.d.mts +6 -0
  136. package/dist/internals/simulation/methods/hooks/index.d.mts.map +1 -0
  137. package/dist/internals/simulation/methods/hooks/index.mjs +5 -38
  138. package/dist/internals/simulation/methods/hooks/index.mjs.map +1 -1
  139. package/dist/internals/simulation/methods/hooks/interface.cjs +24 -0
  140. package/dist/internals/simulation/methods/hooks/interface.cjs.map +1 -0
  141. package/dist/{types/internals/simulation/methods/hooks/interface.d.ts → internals/simulation/methods/hooks/interface.d.cts} +3 -2
  142. package/dist/internals/simulation/methods/hooks/interface.d.cts.map +1 -0
  143. package/dist/internals/simulation/methods/hooks/interface.d.mts +17 -0
  144. package/dist/internals/simulation/methods/hooks/interface.d.mts.map +1 -0
  145. package/dist/internals/simulation/methods/hooks/interface.mjs +18 -9
  146. package/dist/internals/simulation/methods/hooks/interface.mjs.map +1 -1
  147. package/dist/internals/simulation/methods/hooks/notifications.cjs +58 -0
  148. package/dist/internals/simulation/methods/hooks/notifications.cjs.map +1 -0
  149. package/dist/{types/internals/simulation/methods/hooks/notifications.d.ts → internals/simulation/methods/hooks/notifications.d.cts} +5 -4
  150. package/dist/internals/simulation/methods/hooks/notifications.d.cts.map +1 -0
  151. package/dist/internals/simulation/methods/hooks/notifications.d.mts +17 -0
  152. package/dist/internals/simulation/methods/hooks/notifications.d.mts.map +1 -0
  153. package/dist/internals/simulation/methods/hooks/notifications.mjs +54 -15
  154. package/dist/internals/simulation/methods/hooks/notifications.mjs.map +1 -1
  155. package/dist/internals/simulation/methods/hooks/request-user-approval.cjs +38 -0
  156. package/dist/internals/simulation/methods/hooks/request-user-approval.cjs.map +1 -0
  157. package/dist/internals/simulation/methods/hooks/request-user-approval.d.cts +16 -0
  158. package/dist/internals/simulation/methods/hooks/request-user-approval.d.cts.map +1 -0
  159. package/dist/internals/simulation/methods/hooks/request-user-approval.d.mts +16 -0
  160. package/dist/internals/simulation/methods/hooks/request-user-approval.d.mts.map +1 -0
  161. package/dist/internals/simulation/methods/hooks/request-user-approval.mjs +35 -0
  162. package/dist/internals/simulation/methods/hooks/request-user-approval.mjs.map +1 -0
  163. package/dist/internals/simulation/methods/hooks/state.cjs +84 -0
  164. package/dist/internals/simulation/methods/hooks/state.cjs.map +1 -0
  165. package/dist/{types/internals/simulation/methods/hooks/state.d.ts → internals/simulation/methods/hooks/state.d.cts} +3 -2
  166. package/dist/internals/simulation/methods/hooks/state.d.cts.map +1 -0
  167. package/dist/internals/simulation/methods/hooks/state.d.mts +24 -0
  168. package/dist/internals/simulation/methods/hooks/state.d.mts.map +1 -0
  169. package/dist/internals/simulation/methods/hooks/state.mjs +78 -17
  170. package/dist/internals/simulation/methods/hooks/state.mjs.map +1 -1
  171. package/dist/internals/simulation/methods/index.cjs +18 -0
  172. package/dist/internals/simulation/methods/index.cjs.map +1 -0
  173. package/dist/internals/simulation/methods/index.d.cts +2 -0
  174. package/dist/internals/simulation/methods/index.d.cts.map +1 -0
  175. package/dist/internals/simulation/methods/index.d.mts +2 -0
  176. package/dist/internals/simulation/methods/index.d.mts.map +1 -0
  177. package/dist/internals/simulation/methods/index.mjs +1 -27
  178. package/dist/internals/simulation/methods/index.mjs.map +1 -1
  179. package/dist/internals/simulation/methods/specifications.cjs +85 -0
  180. package/dist/internals/simulation/methods/specifications.cjs.map +1 -0
  181. package/dist/{types/internals/simulation/methods/specifications.d.ts → internals/simulation/methods/specifications.d.cts} +8 -7
  182. package/dist/internals/simulation/methods/specifications.d.cts.map +1 -0
  183. package/dist/internals/simulation/methods/specifications.d.mts +57 -0
  184. package/dist/internals/simulation/methods/specifications.d.mts.map +1 -0
  185. package/dist/internals/simulation/methods/specifications.mjs +77 -26
  186. package/dist/internals/simulation/methods/specifications.mjs.map +1 -1
  187. package/dist/internals/simulation/middleware/engine.cjs +37 -0
  188. package/dist/internals/simulation/middleware/engine.cjs.map +1 -0
  189. package/dist/{types/internals/simulation/middleware/engine.d.ts → internals/simulation/middleware/engine.d.cts} +8 -7
  190. package/dist/internals/simulation/middleware/engine.d.cts.map +1 -0
  191. package/dist/internals/simulation/middleware/engine.d.mts +27 -0
  192. package/dist/internals/simulation/middleware/engine.d.mts.map +1 -0
  193. package/dist/internals/simulation/middleware/engine.mjs +33 -14
  194. package/dist/internals/simulation/middleware/engine.mjs.map +1 -1
  195. package/dist/internals/simulation/middleware/index.cjs +18 -0
  196. package/dist/internals/simulation/middleware/index.cjs.map +1 -0
  197. package/dist/internals/simulation/middleware/index.d.cts +2 -0
  198. package/dist/internals/simulation/middleware/index.d.cts.map +1 -0
  199. package/dist/internals/simulation/middleware/index.d.mts +2 -0
  200. package/dist/internals/simulation/middleware/index.d.mts.map +1 -0
  201. package/dist/internals/simulation/middleware/index.mjs +1 -15
  202. package/dist/internals/simulation/middleware/index.mjs.map +1 -1
  203. package/dist/internals/simulation/middleware/internal-methods/accounts.cjs +34 -0
  204. package/dist/internals/simulation/middleware/internal-methods/accounts.cjs.map +1 -0
  205. package/dist/{types/internals/simulation/middleware/internal-methods/accounts.d.ts → internals/simulation/middleware/internal-methods/accounts.d.cts} +5 -3
  206. package/dist/internals/simulation/middleware/internal-methods/accounts.d.cts.map +1 -0
  207. package/dist/internals/simulation/middleware/internal-methods/accounts.d.mts +20 -0
  208. package/dist/internals/simulation/middleware/internal-methods/accounts.d.mts.map +1 -0
  209. package/dist/internals/simulation/middleware/internal-methods/accounts.mjs +29 -7
  210. package/dist/internals/simulation/middleware/internal-methods/accounts.mjs.map +1 -1
  211. package/dist/internals/simulation/middleware/internal-methods/index.cjs +18 -0
  212. package/dist/internals/simulation/middleware/internal-methods/index.cjs.map +1 -0
  213. package/dist/internals/simulation/middleware/internal-methods/index.d.cts +2 -0
  214. package/dist/internals/simulation/middleware/internal-methods/index.d.cts.map +1 -0
  215. package/dist/internals/simulation/middleware/internal-methods/index.d.mts +2 -0
  216. package/dist/internals/simulation/middleware/internal-methods/index.d.mts.map +1 -0
  217. package/dist/internals/simulation/middleware/internal-methods/index.mjs +1 -10
  218. package/dist/internals/simulation/middleware/internal-methods/index.mjs.map +1 -1
  219. package/dist/internals/simulation/middleware/internal-methods/middleware.cjs +44 -0
  220. package/dist/internals/simulation/middleware/internal-methods/middleware.cjs.map +1 -0
  221. package/dist/{types/internals/simulation/middleware/internal-methods/middleware.d.ts → internals/simulation/middleware/internal-methods/middleware.d.cts} +4 -3
  222. package/dist/internals/simulation/middleware/internal-methods/middleware.d.cts.map +1 -0
  223. package/dist/internals/simulation/middleware/internal-methods/middleware.d.mts +23 -0
  224. package/dist/internals/simulation/middleware/internal-methods/middleware.d.mts.map +1 -0
  225. package/dist/internals/simulation/middleware/internal-methods/middleware.mjs +38 -8
  226. package/dist/internals/simulation/middleware/internal-methods/middleware.mjs.map +1 -1
  227. package/dist/internals/simulation/middleware/internal-methods/provider-state.cjs +28 -0
  228. package/dist/internals/simulation/middleware/internal-methods/provider-state.cjs.map +1 -0
  229. package/dist/{types/internals/simulation/middleware/internal-methods/provider-state.d.ts → internals/simulation/middleware/internal-methods/provider-state.d.cts} +4 -2
  230. package/dist/internals/simulation/middleware/internal-methods/provider-state.d.cts.map +1 -0
  231. package/dist/internals/simulation/middleware/internal-methods/provider-state.d.mts +16 -0
  232. package/dist/internals/simulation/middleware/internal-methods/provider-state.d.mts.map +1 -0
  233. package/dist/internals/simulation/middleware/internal-methods/provider-state.mjs +23 -7
  234. package/dist/internals/simulation/middleware/internal-methods/provider-state.mjs.map +1 -1
  235. package/dist/internals/simulation/middleware/mock.cjs +22 -0
  236. package/dist/internals/simulation/middleware/mock.cjs.map +1 -0
  237. package/dist/{types/internals/simulation/middleware/mock.d.ts → internals/simulation/middleware/mock.d.cts} +4 -3
  238. package/dist/internals/simulation/middleware/mock.d.cts.map +1 -0
  239. package/dist/internals/simulation/middleware/mock.d.mts +11 -0
  240. package/dist/internals/simulation/middleware/mock.d.mts.map +1 -0
  241. package/dist/internals/simulation/middleware/mock.mjs +17 -8
  242. package/dist/internals/simulation/middleware/mock.mjs.map +1 -1
  243. package/dist/internals/simulation/options.cjs +25 -0
  244. package/dist/internals/simulation/options.cjs.map +1 -0
  245. package/dist/{types/internals/simulation/options.d.ts → internals/simulation/options.d.cts} +11 -8
  246. package/dist/internals/simulation/options.d.cts.map +1 -0
  247. package/dist/internals/simulation/options.d.mts +40 -0
  248. package/dist/internals/simulation/options.d.mts.map +1 -0
  249. package/dist/internals/simulation/options.mjs +20 -8
  250. package/dist/internals/simulation/options.mjs.map +1 -1
  251. package/dist/internals/simulation/simulation.cjs +155 -0
  252. package/dist/internals/simulation/simulation.cjs.map +1 -0
  253. package/dist/{types/internals/simulation/simulation.d.ts → internals/simulation/simulation.d.cts} +18 -13
  254. package/dist/internals/simulation/simulation.d.cts.map +1 -0
  255. package/dist/internals/simulation/simulation.d.mts +103 -0
  256. package/dist/internals/simulation/simulation.d.mts.map +1 -0
  257. package/dist/internals/simulation/simulation.mjs +149 -37
  258. package/dist/internals/simulation/simulation.mjs.map +1 -1
  259. package/dist/internals/simulation/store/index.cjs +21 -0
  260. package/dist/internals/simulation/store/index.cjs.map +1 -0
  261. package/dist/internals/simulation/store/index.d.cts +5 -0
  262. package/dist/internals/simulation/store/index.d.cts.map +1 -0
  263. package/dist/internals/simulation/store/index.d.mts +5 -0
  264. package/dist/internals/simulation/store/index.d.mts.map +1 -0
  265. package/dist/internals/simulation/store/index.mjs +4 -43
  266. package/dist/internals/simulation/store/index.mjs.map +1 -1
  267. package/dist/internals/simulation/store/mocks.cjs +39 -0
  268. package/dist/internals/simulation/store/mocks.cjs.map +1 -0
  269. package/dist/{types/internals/simulation/store/mocks.d.ts → internals/simulation/store/mocks.d.cts} +8 -7
  270. package/dist/internals/simulation/store/mocks.d.cts.map +1 -0
  271. package/dist/internals/simulation/store/mocks.d.mts +36 -0
  272. package/dist/internals/simulation/store/mocks.d.mts.map +1 -0
  273. package/dist/internals/simulation/store/mocks.mjs +33 -14
  274. package/dist/internals/simulation/store/mocks.mjs.map +1 -1
  275. package/dist/internals/simulation/store/notifications.cjs +35 -0
  276. package/dist/internals/simulation/store/notifications.cjs.map +1 -0
  277. package/dist/{types/internals/simulation/store/notifications.d.ts → internals/simulation/store/notifications.d.cts} +8 -7
  278. package/dist/internals/simulation/store/notifications.d.cts.map +1 -0
  279. package/dist/internals/simulation/store/notifications.d.mts +45 -0
  280. package/dist/internals/simulation/store/notifications.d.mts.map +1 -0
  281. package/dist/internals/simulation/store/notifications.mjs +30 -14
  282. package/dist/internals/simulation/store/notifications.mjs.map +1 -1
  283. package/dist/internals/simulation/store/state.cjs +54 -0
  284. package/dist/internals/simulation/store/state.cjs.map +1 -0
  285. package/dist/{types/internals/simulation/store/state.d.ts → internals/simulation/store/state.d.cts} +7 -6
  286. package/dist/internals/simulation/store/state.d.cts.map +1 -0
  287. package/dist/internals/simulation/store/state.d.mts +56 -0
  288. package/dist/internals/simulation/store/state.d.mts.map +1 -0
  289. package/dist/internals/simulation/store/state.mjs +48 -12
  290. package/dist/internals/simulation/store/state.mjs.map +1 -1
  291. package/dist/internals/simulation/store/store.cjs +51 -0
  292. package/dist/internals/simulation/store/store.cjs.map +1 -0
  293. package/dist/{types/internals/simulation/store/store.d.ts → internals/simulation/store/store.d.cts} +6 -5
  294. package/dist/internals/simulation/store/store.d.cts.map +1 -0
  295. package/dist/internals/simulation/store/store.d.mts +22 -0
  296. package/dist/internals/simulation/store/store.d.mts.map +1 -0
  297. package/dist/internals/simulation/store/store.mjs +44 -11
  298. package/dist/internals/simulation/store/store.mjs.map +1 -1
  299. package/dist/internals/simulation/store/ui.cjs +24 -0
  300. package/dist/internals/simulation/store/ui.cjs.map +1 -0
  301. package/dist/{types/internals/simulation/store/ui.d.ts → internals/simulation/store/ui.d.cts} +9 -7
  302. package/dist/internals/simulation/store/ui.d.cts.map +1 -0
  303. package/dist/internals/simulation/store/ui.d.mts +27 -0
  304. package/dist/internals/simulation/store/ui.d.mts.map +1 -0
  305. package/dist/internals/simulation/store/ui.mjs +19 -14
  306. package/dist/internals/simulation/store/ui.mjs.map +1 -1
  307. package/dist/internals/structs.cjs +157 -0
  308. package/dist/internals/structs.cjs.map +1 -0
  309. package/dist/{types/internals/structs.d.ts → internals/structs.d.cts} +67 -66
  310. package/dist/internals/structs.d.cts.map +1 -0
  311. package/dist/internals/structs.d.mts +205 -0
  312. package/dist/internals/structs.d.mts.map +1 -0
  313. package/dist/internals/structs.mjs +153 -21
  314. package/dist/internals/structs.mjs.map +1 -1
  315. package/dist/matchers.cjs +160 -0
  316. package/dist/matchers.cjs.map +1 -0
  317. package/dist/{types/matchers.d.ts → matchers.d.cts} +4 -13
  318. package/dist/matchers.d.cts.map +1 -0
  319. package/dist/matchers.d.mts +28 -0
  320. package/dist/matchers.d.mts.map +1 -0
  321. package/dist/matchers.mjs +152 -49
  322. package/dist/matchers.mjs.map +1 -1
  323. package/dist/options.cjs +24 -0
  324. package/dist/options.cjs.map +1 -0
  325. package/dist/{types/options.d.ts → options.d.cts} +8 -7
  326. package/dist/options.d.cts.map +1 -0
  327. package/dist/options.d.mts +61 -0
  328. package/dist/options.d.mts.map +1 -0
  329. package/dist/options.mjs +19 -7
  330. package/dist/options.mjs.map +1 -1
  331. package/dist/setup.cjs +7 -0
  332. package/dist/setup.cjs.map +1 -0
  333. package/dist/setup.d.cts +2 -0
  334. package/dist/setup.d.cts.map +1 -0
  335. package/dist/setup.d.mts +2 -0
  336. package/dist/setup.d.mts.map +1 -0
  337. package/dist/setup.mjs +4 -37
  338. package/dist/setup.mjs.map +1 -1
  339. package/dist/types/index.cjs +18 -0
  340. package/dist/types/index.cjs.map +1 -0
  341. package/dist/types/index.d.cts +2 -0
  342. package/dist/types/index.d.cts.map +1 -0
  343. package/dist/types/index.d.mts +2 -0
  344. package/dist/types/index.d.mts.map +1 -0
  345. package/dist/types/index.mjs +2 -0
  346. package/dist/types/index.mjs.map +1 -0
  347. package/dist/types/types.cjs +3 -0
  348. package/dist/types/types.cjs.map +1 -0
  349. package/dist/types/{types.d.ts → types.d.cts} +66 -26
  350. package/dist/types/types.d.cts.map +1 -0
  351. package/dist/types/types.d.mts +386 -0
  352. package/dist/types/types.d.mts.map +1 -0
  353. package/dist/types/types.mjs +2 -0
  354. package/dist/types/types.mjs.map +1 -0
  355. package/jest-preset.js +1 -1
  356. package/package.json +32 -30
  357. package/dist/chunk-265BMFM5.js +0 -13
  358. package/dist/chunk-265BMFM5.js.map +0 -1
  359. package/dist/chunk-2JTGBHPR.js +0 -14
  360. package/dist/chunk-2JTGBHPR.js.map +0 -1
  361. package/dist/chunk-2YE2P5BZ.js +0 -36
  362. package/dist/chunk-2YE2P5BZ.js.map +0 -1
  363. package/dist/chunk-3FNLFVV2.js +0 -15
  364. package/dist/chunk-3FNLFVV2.js.map +0 -1
  365. package/dist/chunk-3M4GRUMH.mjs +0 -54
  366. package/dist/chunk-3M4GRUMH.mjs.map +0 -1
  367. package/dist/chunk-43HRTFLS.mjs +0 -421
  368. package/dist/chunk-43HRTFLS.mjs.map +0 -1
  369. package/dist/chunk-44ARQBXS.js +0 -95
  370. package/dist/chunk-44ARQBXS.js.map +0 -1
  371. package/dist/chunk-4MAA7WGJ.js +0 -153
  372. package/dist/chunk-4MAA7WGJ.js.map +0 -1
  373. package/dist/chunk-55J6XMHW.js +0 -1
  374. package/dist/chunk-55J6XMHW.js.map +0 -1
  375. package/dist/chunk-57SGDM5B.mjs +0 -69
  376. package/dist/chunk-57SGDM5B.mjs.map +0 -1
  377. package/dist/chunk-5SGLRSWR.mjs +0 -153
  378. package/dist/chunk-5SGLRSWR.mjs.map +0 -1
  379. package/dist/chunk-5U5WB3SM.mjs +0 -41
  380. package/dist/chunk-5U5WB3SM.mjs.map +0 -1
  381. package/dist/chunk-5ZFHFICZ.mjs +0 -1
  382. package/dist/chunk-5ZFHFICZ.mjs.map +0 -1
  383. package/dist/chunk-6HHV6YFQ.mjs +0 -1
  384. package/dist/chunk-6HHV6YFQ.mjs.map +0 -1
  385. package/dist/chunk-6KXCBUNZ.mjs +0 -11
  386. package/dist/chunk-6KXCBUNZ.mjs.map +0 -1
  387. package/dist/chunk-74TIKA2T.mjs +0 -34
  388. package/dist/chunk-74TIKA2T.mjs.map +0 -1
  389. package/dist/chunk-7Y27L2EV.js +0 -211
  390. package/dist/chunk-7Y27L2EV.js.map +0 -1
  391. package/dist/chunk-ALRZENWP.mjs +0 -42
  392. package/dist/chunk-ALRZENWP.mjs.map +0 -1
  393. package/dist/chunk-B73P64TE.mjs +0 -28
  394. package/dist/chunk-B73P64TE.mjs.map +0 -1
  395. package/dist/chunk-CKRORVDW.js +0 -1
  396. package/dist/chunk-CKRORVDW.js.map +0 -1
  397. package/dist/chunk-CYPP66I7.mjs +0 -163
  398. package/dist/chunk-CYPP66I7.mjs.map +0 -1
  399. package/dist/chunk-DR6Y7IVX.js +0 -1
  400. package/dist/chunk-DR6Y7IVX.js.map +0 -1
  401. package/dist/chunk-DVDAOXO7.js +0 -134
  402. package/dist/chunk-DVDAOXO7.js.map +0 -1
  403. package/dist/chunk-EMTW3H54.js +0 -20
  404. package/dist/chunk-EMTW3H54.js.map +0 -1
  405. package/dist/chunk-FP4H3ADT.mjs +0 -20
  406. package/dist/chunk-FP4H3ADT.mjs.map +0 -1
  407. package/dist/chunk-FQWOVTBB.mjs +0 -22
  408. package/dist/chunk-FQWOVTBB.mjs.map +0 -1
  409. package/dist/chunk-GECE47HW.js +0 -1
  410. package/dist/chunk-GECE47HW.js.map +0 -1
  411. package/dist/chunk-GG2BCPQH.mjs +0 -95
  412. package/dist/chunk-GG2BCPQH.mjs.map +0 -1
  413. package/dist/chunk-GMTKFAWO.js +0 -42
  414. package/dist/chunk-GMTKFAWO.js.map +0 -1
  415. package/dist/chunk-GVTDUKXK.js +0 -421
  416. package/dist/chunk-GVTDUKXK.js.map +0 -1
  417. package/dist/chunk-H2464AXT.mjs +0 -33
  418. package/dist/chunk-H2464AXT.mjs.map +0 -1
  419. package/dist/chunk-HOI6FPLR.mjs +0 -240
  420. package/dist/chunk-HOI6FPLR.mjs.map +0 -1
  421. package/dist/chunk-HROOL3VI.js +0 -1
  422. package/dist/chunk-HROOL3VI.js.map +0 -1
  423. package/dist/chunk-IH7UNS5A.mjs +0 -36
  424. package/dist/chunk-IH7UNS5A.mjs.map +0 -1
  425. package/dist/chunk-IVFVB4VR.js +0 -163
  426. package/dist/chunk-IVFVB4VR.js.map +0 -1
  427. package/dist/chunk-IWJ4HKDR.mjs +0 -50
  428. package/dist/chunk-IWJ4HKDR.mjs.map +0 -1
  429. package/dist/chunk-IXKO6X55.mjs +0 -15
  430. package/dist/chunk-IXKO6X55.mjs.map +0 -1
  431. package/dist/chunk-J3I5KZIF.js +0 -22
  432. package/dist/chunk-J3I5KZIF.js.map +0 -1
  433. package/dist/chunk-J4ZPUCLX.mjs +0 -8
  434. package/dist/chunk-J4ZPUCLX.mjs.map +0 -1
  435. package/dist/chunk-JMDSN227.mjs +0 -25
  436. package/dist/chunk-JMDSN227.mjs.map +0 -1
  437. package/dist/chunk-KIQOUUEZ.mjs +0 -1
  438. package/dist/chunk-KIQOUUEZ.mjs.map +0 -1
  439. package/dist/chunk-KNJNL723.mjs +0 -39
  440. package/dist/chunk-KNJNL723.mjs.map +0 -1
  441. package/dist/chunk-KSIBNOB2.mjs +0 -13
  442. package/dist/chunk-KSIBNOB2.mjs.map +0 -1
  443. package/dist/chunk-LACTK6EO.js +0 -33
  444. package/dist/chunk-LACTK6EO.js.map +0 -1
  445. package/dist/chunk-LB4R3BUA.mjs +0 -36
  446. package/dist/chunk-LB4R3BUA.mjs.map +0 -1
  447. package/dist/chunk-LBC2OGSN.js +0 -48
  448. package/dist/chunk-LBC2OGSN.js.map +0 -1
  449. package/dist/chunk-MAT5SBM7.mjs +0 -211
  450. package/dist/chunk-MAT5SBM7.mjs.map +0 -1
  451. package/dist/chunk-MBQHVBLA.js +0 -89
  452. package/dist/chunk-MBQHVBLA.js.map +0 -1
  453. package/dist/chunk-MF43OG3Z.mjs +0 -1
  454. package/dist/chunk-MF43OG3Z.mjs.map +0 -1
  455. package/dist/chunk-MPZOXW6I.mjs +0 -48
  456. package/dist/chunk-MPZOXW6I.mjs.map +0 -1
  457. package/dist/chunk-N6MAO223.js +0 -60
  458. package/dist/chunk-N6MAO223.js.map +0 -1
  459. package/dist/chunk-NSMTFK33.mjs +0 -104
  460. package/dist/chunk-NSMTFK33.mjs.map +0 -1
  461. package/dist/chunk-NTOY6Y4Q.mjs +0 -1
  462. package/dist/chunk-NTOY6Y4Q.mjs.map +0 -1
  463. package/dist/chunk-O24GTINW.mjs +0 -134
  464. package/dist/chunk-O24GTINW.mjs.map +0 -1
  465. package/dist/chunk-ORO3T6BU.mjs +0 -24
  466. package/dist/chunk-ORO3T6BU.mjs.map +0 -1
  467. package/dist/chunk-PHUTP7NB.js +0 -25
  468. package/dist/chunk-PHUTP7NB.js.map +0 -1
  469. package/dist/chunk-PZDTZGSI.js +0 -34
  470. package/dist/chunk-PZDTZGSI.js.map +0 -1
  471. package/dist/chunk-Q2OQXAUM.mjs +0 -35
  472. package/dist/chunk-Q2OQXAUM.mjs.map +0 -1
  473. package/dist/chunk-RAMAN5RM.js +0 -24
  474. package/dist/chunk-RAMAN5RM.js.map +0 -1
  475. package/dist/chunk-RQKT6BQ2.mjs +0 -1
  476. package/dist/chunk-RQKT6BQ2.mjs.map +0 -1
  477. package/dist/chunk-S2HLITUN.js +0 -1
  478. package/dist/chunk-S2HLITUN.js.map +0 -1
  479. package/dist/chunk-SB5EPHE3.js +0 -41
  480. package/dist/chunk-SB5EPHE3.js.map +0 -1
  481. package/dist/chunk-SLU4FNKX.mjs +0 -60
  482. package/dist/chunk-SLU4FNKX.mjs.map +0 -1
  483. package/dist/chunk-SW65QYFV.js +0 -50
  484. package/dist/chunk-SW65QYFV.js.map +0 -1
  485. package/dist/chunk-T2PHS5FY.js +0 -28
  486. package/dist/chunk-T2PHS5FY.js.map +0 -1
  487. package/dist/chunk-TGZ7WOTJ.mjs +0 -1
  488. package/dist/chunk-TGZ7WOTJ.mjs.map +0 -1
  489. package/dist/chunk-TMAWGVZP.mjs +0 -89
  490. package/dist/chunk-TMAWGVZP.mjs.map +0 -1
  491. package/dist/chunk-TZB4LBT7.js +0 -8
  492. package/dist/chunk-TZB4LBT7.js.map +0 -1
  493. package/dist/chunk-UDOXICJK.mjs +0 -1
  494. package/dist/chunk-UDOXICJK.mjs.map +0 -1
  495. package/dist/chunk-VHJZERIC.js +0 -1
  496. package/dist/chunk-VHJZERIC.js.map +0 -1
  497. package/dist/chunk-VOYBI6T4.mjs +0 -22
  498. package/dist/chunk-VOYBI6T4.mjs.map +0 -1
  499. package/dist/chunk-VXPCUDBI.js +0 -36
  500. package/dist/chunk-VXPCUDBI.js.map +0 -1
  501. package/dist/chunk-WDYPMEZB.js +0 -22
  502. package/dist/chunk-WDYPMEZB.js.map +0 -1
  503. package/dist/chunk-WHGYMK5B.js +0 -1
  504. package/dist/chunk-WHGYMK5B.js.map +0 -1
  505. package/dist/chunk-WMLSD6B5.js +0 -54
  506. package/dist/chunk-WMLSD6B5.js.map +0 -1
  507. package/dist/chunk-WRKY2DLV.js +0 -104
  508. package/dist/chunk-WRKY2DLV.js.map +0 -1
  509. package/dist/chunk-XAOCS6ZD.js +0 -69
  510. package/dist/chunk-XAOCS6ZD.js.map +0 -1
  511. package/dist/chunk-XK5HPZZC.mjs +0 -14
  512. package/dist/chunk-XK5HPZZC.mjs.map +0 -1
  513. package/dist/chunk-XKJHFUHE.js +0 -11
  514. package/dist/chunk-XKJHFUHE.js.map +0 -1
  515. package/dist/chunk-XWGECIXI.js +0 -39
  516. package/dist/chunk-XWGECIXI.js.map +0 -1
  517. package/dist/chunk-Y3JC4WGW.js +0 -35
  518. package/dist/chunk-Y3JC4WGW.js.map +0 -1
  519. package/dist/chunk-YNUVT3HC.js +0 -240
  520. package/dist/chunk-YNUVT3HC.js.map +0 -1
  521. package/dist/chunk-ZG33OGC3.mjs +0 -1
  522. package/dist/chunk-ZG33OGC3.mjs.map +0 -1
  523. package/dist/chunk-ZTX624YO.js +0 -1
  524. package/dist/chunk-ZTX624YO.js.map +0 -1
  525. package/dist/environment.js +0 -46
  526. package/dist/environment.js.map +0 -1
  527. package/dist/global.js +0 -2
  528. package/dist/global.js.map +0 -1
  529. package/dist/helpers.js +0 -43
  530. package/dist/helpers.js.map +0 -1
  531. package/dist/index.js +0 -54
  532. package/dist/index.js.map +0 -1
  533. package/dist/internals/environment.js +0 -8
  534. package/dist/internals/environment.js.map +0 -1
  535. package/dist/internals/index.js +0 -142
  536. package/dist/internals/index.js.map +0 -1
  537. package/dist/internals/logger.js +0 -8
  538. package/dist/internals/logger.js.map +0 -1
  539. package/dist/internals/request.js +0 -42
  540. package/dist/internals/request.js.map +0 -1
  541. package/dist/internals/server.js +0 -9
  542. package/dist/internals/server.js.map +0 -1
  543. package/dist/internals/simulation/constants.js +0 -12
  544. package/dist/internals/simulation/constants.js.map +0 -1
  545. package/dist/internals/simulation/controllers.js +0 -25
  546. package/dist/internals/simulation/controllers.js.map +0 -1
  547. package/dist/internals/simulation/files.js +0 -14
  548. package/dist/internals/simulation/files.js.map +0 -1
  549. package/dist/internals/simulation/index.js +0 -103
  550. package/dist/internals/simulation/index.js.map +0 -1
  551. package/dist/internals/simulation/interface.js +0 -31
  552. package/dist/internals/simulation/interface.js.map +0 -1
  553. package/dist/internals/simulation/methods/constants.js +0 -12
  554. package/dist/internals/simulation/methods/constants.js.map +0 -1
  555. package/dist/internals/simulation/methods/hooks/get-locale.js +0 -8
  556. package/dist/internals/simulation/methods/hooks/get-locale.js.map +0 -1
  557. package/dist/internals/simulation/methods/hooks/get-locale.mjs +0 -8
  558. package/dist/internals/simulation/methods/hooks/get-locale.mjs.map +0 -1
  559. package/dist/internals/simulation/methods/hooks/index.js +0 -39
  560. package/dist/internals/simulation/methods/hooks/index.js.map +0 -1
  561. package/dist/internals/simulation/methods/hooks/interface.js +0 -10
  562. package/dist/internals/simulation/methods/hooks/interface.js.map +0 -1
  563. package/dist/internals/simulation/methods/hooks/notifications.js +0 -16
  564. package/dist/internals/simulation/methods/hooks/notifications.js.map +0 -1
  565. package/dist/internals/simulation/methods/hooks/show-dialog.js +0 -14
  566. package/dist/internals/simulation/methods/hooks/show-dialog.js.map +0 -1
  567. package/dist/internals/simulation/methods/hooks/show-dialog.mjs +0 -14
  568. package/dist/internals/simulation/methods/hooks/show-dialog.mjs.map +0 -1
  569. package/dist/internals/simulation/methods/hooks/state.js +0 -18
  570. package/dist/internals/simulation/methods/hooks/state.js.map +0 -1
  571. package/dist/internals/simulation/methods/index.js +0 -28
  572. package/dist/internals/simulation/methods/index.js.map +0 -1
  573. package/dist/internals/simulation/methods/specifications.js +0 -27
  574. package/dist/internals/simulation/methods/specifications.js.map +0 -1
  575. package/dist/internals/simulation/middleware/engine.js +0 -15
  576. package/dist/internals/simulation/middleware/engine.js.map +0 -1
  577. package/dist/internals/simulation/middleware/index.js +0 -16
  578. package/dist/internals/simulation/middleware/index.js.map +0 -1
  579. package/dist/internals/simulation/middleware/internal-methods/accounts.js +0 -8
  580. package/dist/internals/simulation/middleware/internal-methods/accounts.js.map +0 -1
  581. package/dist/internals/simulation/middleware/internal-methods/index.js +0 -11
  582. package/dist/internals/simulation/middleware/internal-methods/index.js.map +0 -1
  583. package/dist/internals/simulation/middleware/internal-methods/middleware.js +0 -10
  584. package/dist/internals/simulation/middleware/internal-methods/middleware.js.map +0 -1
  585. package/dist/internals/simulation/middleware/internal-methods/provider-state.js +0 -8
  586. package/dist/internals/simulation/middleware/internal-methods/provider-state.js.map +0 -1
  587. package/dist/internals/simulation/middleware/mock.js +0 -9
  588. package/dist/internals/simulation/middleware/mock.js.map +0 -1
  589. package/dist/internals/simulation/options.js +0 -9
  590. package/dist/internals/simulation/options.js.map +0 -1
  591. package/dist/internals/simulation/simulation.js +0 -38
  592. package/dist/internals/simulation/simulation.js.map +0 -1
  593. package/dist/internals/simulation/store/index.js +0 -44
  594. package/dist/internals/simulation/store/index.js.map +0 -1
  595. package/dist/internals/simulation/store/mocks.js +0 -16
  596. package/dist/internals/simulation/store/mocks.js.map +0 -1
  597. package/dist/internals/simulation/store/notifications.js +0 -16
  598. package/dist/internals/simulation/store/notifications.js.map +0 -1
  599. package/dist/internals/simulation/store/state.js +0 -14
  600. package/dist/internals/simulation/store/state.js.map +0 -1
  601. package/dist/internals/simulation/store/store.js +0 -12
  602. package/dist/internals/simulation/store/store.js.map +0 -1
  603. package/dist/internals/simulation/store/ui.js +0 -16
  604. package/dist/internals/simulation/store/ui.js.map +0 -1
  605. package/dist/internals/structs.js +0 -22
  606. package/dist/internals/structs.js.map +0 -1
  607. package/dist/matchers.js +0 -51
  608. package/dist/matchers.js.map +0 -1
  609. package/dist/options.js +0 -8
  610. package/dist/options.js.map +0 -1
  611. package/dist/setup.js +0 -38
  612. package/dist/setup.js.map +0 -1
  613. package/dist/tsconfig.build.tsbuildinfo +0 -1
  614. package/dist/types/index.d.ts +0 -5
  615. package/dist/types/internals/index.d.ts +0 -6
  616. package/dist/types/internals/simulation/index.d.ts +0 -5
  617. package/dist/types/internals/simulation/methods/hooks/get-locale.d.ts +0 -9
  618. package/dist/types/internals/simulation/methods/hooks/index.d.ts +0 -5
  619. package/dist/types/internals/simulation/methods/hooks/show-dialog.d.ts +0 -9
  620. package/dist/types/internals/simulation/methods/index.d.ts +0 -1
  621. package/dist/types/internals/simulation/middleware/index.d.ts +0 -1
  622. package/dist/types/internals/simulation/middleware/internal-methods/index.d.ts +0 -1
  623. package/dist/types/internals/simulation/store/index.d.ts +0 -4
  624. package/dist/types/setup.d.ts +0 -1
  625. package/dist/types/vendor/readable-stream.d.js +0 -1
  626. package/dist/types/vendor/readable-stream.d.js.map +0 -1
  627. package/dist/types/vendor/readable-stream.d.mjs +0 -1
  628. package/dist/types/vendor/readable-stream.d.mjs.map +0 -1
  629. package/dist/types.js +0 -2
  630. package/dist/types.js.map +0 -1
  631. package/dist/types.mjs +0 -2
  632. package/dist/types.mjs.map +0 -1
@@ -0,0 +1,240 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.installSnap = exports.assertCustomDialogHasNoFooter = exports.assertCustomDialogHasPartialFooter = exports.assertCustomDialogHasFooter = exports.assertIsCustomDialog = exports.assertIsPromptDialog = exports.assertIsConfirmationDialog = exports.assertIsAlertDialog = void 0;
4
+ const snaps_sdk_1 = require("@metamask/snaps-sdk");
5
+ const snaps_utils_1 = require("@metamask/snaps-utils");
6
+ const superstruct_1 = require("@metamask/superstruct");
7
+ const utils_1 = require("@metamask/utils");
8
+ const internals_1 = require("./internals/index.cjs");
9
+ const mocks_1 = require("./internals/simulation/store/mocks.cjs");
10
+ const log = (0, utils_1.createModuleLogger)(internals_1.rootLogger, 'helpers');
11
+ /**
12
+ * Get the options for {@link installSnap}.
13
+ *
14
+ * @param snapId - The ID of the Snap, or the options.
15
+ * @param options - The options, if any.
16
+ * @returns The options.
17
+ */
18
+ function getOptions(snapId, options) {
19
+ if (typeof snapId === 'object') {
20
+ return [undefined, snapId];
21
+ }
22
+ return [snapId, options];
23
+ }
24
+ /**
25
+ * Ensure that the actual response contains `getInterface`.
26
+ *
27
+ * @param response - The response of the handler.
28
+ */
29
+ function assertIsResponseWithInterface(response) {
30
+ (0, utils_1.assertStruct)(response, internals_1.SnapResponseWithInterfaceStruct);
31
+ }
32
+ /**
33
+ * Ensure that the actual interface is an alert dialog.
34
+ *
35
+ * @param ui - The interface to verify.
36
+ */
37
+ function assertIsAlertDialog(ui) {
38
+ (0, utils_1.assert)((0, utils_1.hasProperty)(ui, 'type') && ui.type === snaps_sdk_1.DialogType.Alert);
39
+ }
40
+ exports.assertIsAlertDialog = assertIsAlertDialog;
41
+ /**
42
+ * Ensure that the actual interface is a confirmation dialog.
43
+ *
44
+ * @param ui - The interface to verify.
45
+ */
46
+ function assertIsConfirmationDialog(ui) {
47
+ (0, utils_1.assert)((0, utils_1.hasProperty)(ui, 'type') && ui.type === snaps_sdk_1.DialogType.Confirmation);
48
+ }
49
+ exports.assertIsConfirmationDialog = assertIsConfirmationDialog;
50
+ /**
51
+ * Ensure that the actual interface is a Prompt dialog.
52
+ *
53
+ * @param ui - The interface to verify.
54
+ */
55
+ function assertIsPromptDialog(ui) {
56
+ (0, utils_1.assert)((0, utils_1.hasProperty)(ui, 'type') && ui.type === snaps_sdk_1.DialogType.Prompt);
57
+ }
58
+ exports.assertIsPromptDialog = assertIsPromptDialog;
59
+ /**
60
+ * Ensure that the actual interface is a custom dialog.
61
+ *
62
+ * @param ui - The interface to verify.
63
+ */
64
+ function assertIsCustomDialog(ui) {
65
+ (0, utils_1.assert)(!(0, utils_1.hasProperty)(ui, 'type'));
66
+ }
67
+ exports.assertIsCustomDialog = assertIsCustomDialog;
68
+ /**
69
+ * Ensure that the actual interface is a custom dialog with a complete footer.
70
+ *
71
+ * @param ui - The interface to verify.
72
+ */
73
+ function assertCustomDialogHasFooter(ui) {
74
+ const footer = (0, internals_1.getElementByType)(ui.content, 'Footer');
75
+ (0, utils_1.assert)(footer && (0, snaps_utils_1.getJsxChildren)(footer).length === 2);
76
+ }
77
+ exports.assertCustomDialogHasFooter = assertCustomDialogHasFooter;
78
+ /**
79
+ * Ensure that the actual interface is a custom dialog with a partial footer.
80
+ *
81
+ * @param ui - The interface to verify.
82
+ */
83
+ function assertCustomDialogHasPartialFooter(ui) {
84
+ const footer = (0, internals_1.getElementByType)(ui.content, 'Footer');
85
+ (0, utils_1.assert)(footer && (0, snaps_utils_1.getJsxChildren)(footer).length === 1);
86
+ }
87
+ exports.assertCustomDialogHasPartialFooter = assertCustomDialogHasPartialFooter;
88
+ /**
89
+ * Ensure that the actual interface is a custom dialog without a footer.
90
+ *
91
+ * @param ui - The interface to verify.
92
+ */
93
+ function assertCustomDialogHasNoFooter(ui) {
94
+ const footer = (0, internals_1.getElementByType)(ui.content, 'Footer');
95
+ (0, utils_1.assert)(!footer);
96
+ }
97
+ exports.assertCustomDialogHasNoFooter = assertCustomDialogHasNoFooter;
98
+ /**
99
+ * Load a snap into the environment. This is the main entry point for testing
100
+ * snaps: It returns a {@link Snap} object that can be used to interact with the
101
+ * snap.
102
+ *
103
+ * @example
104
+ * import { installSnap } from '@metamask/snaps-jest';
105
+ *
106
+ * describe('My Snap', () => {
107
+ * it('should do something', async () => {
108
+ * const { request } = await installSnap('local:my-snap');
109
+ * const response = await request({
110
+ * method: 'foo',
111
+ * params: ['bar'],
112
+ * });
113
+ * expect(response).toRespondWith('bar');
114
+ * });
115
+ * });
116
+ * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults
117
+ * to the URL of the built-in server, if it is running. This supports both
118
+ * local snap IDs and NPM snap IDs.
119
+ * @param options - The options to use.
120
+ * @param options.executionService - The execution service to use. Defaults to
121
+ * {@link NodeThreadExecutionService}. You do not need to provide this unless
122
+ * you are testing a custom execution service.
123
+ * @param options.executionServiceOptions - The options to use when creating the
124
+ * execution service, if any. This should only include options specific to the
125
+ * provided execution service.
126
+ * @param options.options - The simulation options.
127
+ * @returns The snap.
128
+ * @throws If the built-in server is not running, and no snap ID is provided.
129
+ */
130
+ async function installSnap(snapId, options = {}) {
131
+ const resolvedOptions = getOptions(snapId, options);
132
+ const { snapId: installedSnapId, store, executionService, runSaga, controllerMessenger, } = await (0, internals_1.getEnvironment)().installSnap(...resolvedOptions);
133
+ const onTransaction = async (request) => {
134
+ log('Sending transaction %o.', request);
135
+ const { origin: transactionOrigin, chainId, ...transaction } = (0, superstruct_1.create)(request, internals_1.TransactionOptionsStruct);
136
+ const response = await (0, internals_1.handleRequest)({
137
+ snapId: installedSnapId,
138
+ store,
139
+ executionService,
140
+ runSaga,
141
+ controllerMessenger,
142
+ handler: snaps_utils_1.HandlerType.OnTransaction,
143
+ request: {
144
+ method: '',
145
+ params: {
146
+ chainId,
147
+ transaction,
148
+ transactionOrigin,
149
+ },
150
+ },
151
+ });
152
+ assertIsResponseWithInterface(response);
153
+ return response;
154
+ };
155
+ const onCronjob = (request) => {
156
+ log('Running cronjob %o.', options);
157
+ return (0, internals_1.handleRequest)({
158
+ snapId: installedSnapId,
159
+ store,
160
+ executionService,
161
+ controllerMessenger,
162
+ runSaga,
163
+ handler: snaps_utils_1.HandlerType.OnCronjob,
164
+ request,
165
+ });
166
+ };
167
+ return {
168
+ request: (request) => {
169
+ log('Sending request %o.', request);
170
+ return (0, internals_1.handleRequest)({
171
+ snapId: installedSnapId,
172
+ store,
173
+ executionService,
174
+ controllerMessenger,
175
+ runSaga,
176
+ handler: snaps_utils_1.HandlerType.OnRpcRequest,
177
+ request,
178
+ });
179
+ },
180
+ onTransaction,
181
+ sendTransaction: onTransaction,
182
+ onSignature: async (request) => {
183
+ log('Requesting signature %o.', request);
184
+ const { origin: signatureOrigin, ...signature } = (0, superstruct_1.create)(request, internals_1.SignatureOptionsStruct);
185
+ const response = await (0, internals_1.handleRequest)({
186
+ snapId: installedSnapId,
187
+ store,
188
+ executionService,
189
+ controllerMessenger,
190
+ runSaga,
191
+ handler: snaps_utils_1.HandlerType.OnSignature,
192
+ request: {
193
+ method: '',
194
+ params: {
195
+ signature,
196
+ signatureOrigin,
197
+ },
198
+ },
199
+ });
200
+ assertIsResponseWithInterface(response);
201
+ return response;
202
+ },
203
+ onCronjob,
204
+ runCronjob: onCronjob,
205
+ onHomePage: async () => {
206
+ log('Rendering home page.');
207
+ const response = await (0, internals_1.handleRequest)({
208
+ snapId: installedSnapId,
209
+ store,
210
+ executionService,
211
+ controllerMessenger,
212
+ runSaga,
213
+ handler: snaps_utils_1.HandlerType.OnHomePage,
214
+ request: {
215
+ method: '',
216
+ },
217
+ });
218
+ assertIsResponseWithInterface(response);
219
+ return response;
220
+ },
221
+ mockJsonRpc(mock) {
222
+ log('Mocking JSON-RPC request %o.', mock);
223
+ const { method, result } = (0, superstruct_1.create)(mock, internals_1.JsonRpcMockOptionsStruct);
224
+ store.dispatch((0, mocks_1.addJsonRpcMock)({ method, result }));
225
+ return {
226
+ unmock() {
227
+ log('Unmocking JSON-RPC request %o.', mock);
228
+ store.dispatch((0, mocks_1.removeJsonRpcMock)(method));
229
+ },
230
+ };
231
+ },
232
+ close: async () => {
233
+ log('Closing execution service.');
234
+ (0, snaps_utils_1.logInfo)('Calling `snap.close()` is deprecated, and will be removed in a future release. Snaps are now automatically closed when the test ends.');
235
+ await executionService.terminateAllSnaps();
236
+ },
237
+ };
238
+ }
239
+ exports.installSnap = installSnap;
240
+ //# sourceMappingURL=helpers.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.cjs","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;AAEA,mDAAiD;AAEjD,uDAA6E;AAC7E,uDAA+C;AAC/C,2CAKyB;AAEzB,qDASqB;AAErB,kEAG4C;AAmB5C,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAU,EAAE,SAAS,CAAC,CAAC;AAEtD;;;;;;GAMG;AACH,SAAS,UAAU,CAKjB,MAAiE,EACjE,OAA6C;IAE7C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,SAAS,6BAA6B,CACpC,QAAsB;IAEtB,IAAA,oBAAY,EAAC,QAAQ,EAAE,2CAA+B,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CACjC,EAAiB;IAEjB,IAAA,cAAM,EAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,sBAAU,CAAC,KAAK,CAAC,CAAC;AAClE,CAAC;AAJD,kDAIC;AAED;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,EAAiB;IAEjB,IAAA,cAAM,EAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,sBAAU,CAAC,YAAY,CAAC,CAAC;AACzE,CAAC;AAJD,gEAIC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,EAAiB;IAEjB,IAAA,cAAM,EAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,KAAK,sBAAU,CAAC,MAAM,CAAC,CAAC;AACnE,CAAC;AAJD,oDAIC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,EAAiB;IAEjB,IAAA,cAAM,EAAC,CAAC,IAAA,mBAAW,EAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;AACnC,CAAC;AAJD,oDAIC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CACzC,EAA+C;IAE/C,MAAM,MAAM,GAAG,IAAA,4BAAgB,EAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,IAAA,cAAM,EAAC,MAAM,IAAI,IAAA,4BAAc,EAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC;AAND,kEAMC;AAED;;;;GAIG;AACH,SAAgB,kCAAkC,CAChD,EAA+C;IAE/C,MAAM,MAAM,GAAG,IAAA,4BAAgB,EAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,IAAA,cAAM,EAAC,MAAM,IAAI,IAAA,4BAAc,EAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC;AAND,gFAMC;AAED;;;;GAIG;AACH,SAAgB,6BAA6B,CAC3C,EAA+C;IAE/C,MAAM,MAAM,GAAG,IAAA,4BAAgB,EAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAErE,IAAA,cAAM,EAAC,CAAC,MAAM,CAAC,CAAC;AAClB,CAAC;AAND,sEAMC;AAqGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,KAAK,UAAU,WAAW,CAK/B,MAAsD,EACtD,UAAgD,EAAE;IAElD,MAAM,eAAe,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,MAAM,EACJ,MAAM,EAAE,eAAe,EACvB,KAAK,EACL,gBAAgB,EAChB,OAAO,EACP,mBAAmB,GACpB,GAAG,MAAM,IAAA,0BAAc,GAAE,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,CAAC;IAE3D,MAAM,aAAa,GAAG,KAAK,EACzB,OAA2B,EACS,EAAE;QACtC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;QAExC,MAAM,EACJ,MAAM,EAAE,iBAAiB,EACzB,OAAO,EACP,GAAG,WAAW,EACf,GAAG,IAAA,oBAAM,EAAC,OAAO,EAAE,oCAAwB,CAAC,CAAC;QAE9C,MAAM,QAAQ,GAAG,MAAM,IAAA,yBAAa,EAAC;YACnC,MAAM,EAAE,eAAe;YACvB,KAAK;YACL,gBAAgB;YAChB,OAAO;YACP,mBAAmB;YACnB,OAAO,EAAE,yBAAW,CAAC,aAAa;YAClC,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE;gBACV,MAAM,EAAE;oBACN,OAAO;oBACP,WAAW;oBACX,iBAAiB;iBAClB;aACF;SACF,CAAC,CAAC;QAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,OAAuB,EAAE,EAAE;QAC5C,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAA,yBAAa,EAAC;YACnB,MAAM,EAAE,eAAe;YACvB,KAAK;YACL,gBAAgB;YAChB,mBAAmB;YACnB,OAAO;YACP,OAAO,EAAE,yBAAW,CAAC,SAAS;YAC9B,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;YACnB,GAAG,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;YAEpC,OAAO,IAAA,yBAAa,EAAC;gBACnB,MAAM,EAAE,eAAe;gBACvB,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,YAAY;gBACjC,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,aAAa;QACb,eAAe,EAAE,aAAa;QAE9B,WAAW,EAAE,KAAK,EAChB,OAAgB,EACoB,EAAE;YACtC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;YAEzC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,SAAS,EAAE,GAAG,IAAA,oBAAM,EACtD,OAAO,EACP,kCAAsB,CACvB,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,yBAAa,EAAC;gBACnC,MAAM,EAAE,eAAe;gBACvB,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,WAAW;gBAChC,OAAO,EAAE;oBACP,MAAM,EAAE,EAAE;oBACV,MAAM,EAAE;wBACN,SAAS;wBACT,eAAe;qBAChB;iBACF;aACF,CAAC,CAAC;YAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;YAExC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,SAAS;QACT,UAAU,EAAE,SAAS;QAErB,UAAU,EAAE,KAAK,IAAwC,EAAE;YACzD,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAE5B,MAAM,QAAQ,GAAG,MAAM,IAAA,yBAAa,EAAC;gBACnC,MAAM,EAAE,eAAe;gBACvB,KAAK;gBACL,gBAAgB;gBAChB,mBAAmB;gBACnB,OAAO;gBACP,OAAO,EAAE,yBAAW,CAAC,UAAU;gBAC/B,OAAO,EAAE;oBACP,MAAM,EAAE,EAAE;iBACX;aACF,CAAC,CAAC;YAEH,6BAA6B,CAAC,QAAQ,CAAC,CAAC;YAExC,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,WAAW,CAAC,IAAwB;YAClC,GAAG,CAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC;YAE1C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,oBAAM,EAAC,IAAI,EAAE,oCAAwB,CAAC,CAAC;YAClE,KAAK,CAAC,QAAQ,CAAC,IAAA,sBAAc,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YAEnD,OAAO;gBACL,MAAM;oBACJ,GAAG,CAAC,gCAAgC,EAAE,IAAI,CAAC,CAAC;oBAE5C,KAAK,CAAC,QAAQ,CAAC,IAAA,yBAAiB,EAAC,MAAM,CAAC,CAAC,CAAC;gBAC5C,CAAC;aACF,CAAC;QACJ,CAAC;QAED,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAClC,IAAA,qBAAO,EACL,uIAAuI,CACxI,CAAC;YAEF,MAAM,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAC7C,CAAC;KACF,CAAC;AACJ,CAAC;AAhKD,kCAgKC","sourcesContent":["import type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { DialogType } from '@metamask/snaps-sdk';\nimport type { FooterElement } from '@metamask/snaps-sdk/jsx';\nimport { HandlerType, getJsxChildren, logInfo } from '@metamask/snaps-utils';\nimport { create } from '@metamask/superstruct';\nimport {\n assert,\n assertStruct,\n createModuleLogger,\n hasProperty,\n} from '@metamask/utils';\n\nimport {\n rootLogger,\n handleRequest,\n TransactionOptionsStruct,\n getEnvironment,\n JsonRpcMockOptionsStruct,\n SignatureOptionsStruct,\n SnapResponseWithInterfaceStruct,\n getElementByType,\n} from './internals';\nimport type { InstallSnapOptions } from './internals';\nimport {\n addJsonRpcMock,\n removeJsonRpcMock,\n} from './internals/simulation/store/mocks';\nimport type {\n SnapResponseWithInterface,\n CronjobOptions,\n JsonRpcMockOptions,\n Snap,\n SnapResponse,\n TransactionOptions,\n SnapInterface,\n SnapAlertInterface,\n SnapInterfaceActions,\n SnapConfirmationInterface,\n SnapPromptInterface,\n DefaultSnapInterface,\n DefaultSnapInterfaceWithFooter,\n DefaultSnapInterfaceWithPartialFooter,\n DefaultSnapInterfaceWithoutFooter,\n} from './types';\n\nconst log = createModuleLogger(rootLogger, 'helpers');\n\n/**\n * Get the options for {@link installSnap}.\n *\n * @param snapId - The ID of the Snap, or the options.\n * @param options - The options, if any.\n * @returns The options.\n */\nfunction getOptions<\n Service extends new (...args: any[]) => InstanceType<\n typeof AbstractExecutionService\n >,\n>(\n snapId: SnapId | Partial<InstallSnapOptions<Service>> | undefined,\n options: Partial<InstallSnapOptions<Service>>,\n): [SnapId | undefined, Partial<InstallSnapOptions<Service>>] {\n if (typeof snapId === 'object') {\n return [undefined, snapId];\n }\n\n return [snapId, options];\n}\n\n/**\n * Ensure that the actual response contains `getInterface`.\n *\n * @param response - The response of the handler.\n */\nfunction assertIsResponseWithInterface(\n response: SnapResponse,\n): asserts response is SnapResponseWithInterface {\n assertStruct(response, SnapResponseWithInterfaceStruct);\n}\n\n/**\n * Ensure that the actual interface is an alert dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsAlertDialog(\n ui: SnapInterface,\n): asserts ui is SnapAlertInterface & SnapInterfaceActions {\n assert(hasProperty(ui, 'type') && ui.type === DialogType.Alert);\n}\n\n/**\n * Ensure that the actual interface is a confirmation dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsConfirmationDialog(\n ui: SnapInterface,\n): asserts ui is SnapConfirmationInterface & SnapInterfaceActions {\n assert(hasProperty(ui, 'type') && ui.type === DialogType.Confirmation);\n}\n\n/**\n * Ensure that the actual interface is a Prompt dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsPromptDialog(\n ui: SnapInterface,\n): asserts ui is SnapPromptInterface & SnapInterfaceActions {\n assert(hasProperty(ui, 'type') && ui.type === DialogType.Prompt);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog.\n *\n * @param ui - The interface to verify.\n */\nexport function assertIsCustomDialog(\n ui: SnapInterface,\n): asserts ui is DefaultSnapInterface & SnapInterfaceActions {\n assert(!hasProperty(ui, 'type'));\n}\n\n/**\n * Ensure that the actual interface is a custom dialog with a complete footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasFooter(\n ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithFooter & SnapInterfaceActions {\n const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n assert(footer && getJsxChildren(footer).length === 2);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog with a partial footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasPartialFooter(\n ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithPartialFooter & SnapInterfaceActions {\n const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n assert(footer && getJsxChildren(footer).length === 1);\n}\n\n/**\n * Ensure that the actual interface is a custom dialog without a footer.\n *\n * @param ui - The interface to verify.\n */\nexport function assertCustomDialogHasNoFooter(\n ui: DefaultSnapInterface & SnapInterfaceActions,\n): asserts ui is DefaultSnapInterfaceWithoutFooter & SnapInterfaceActions {\n const footer = getElementByType<FooterElement>(ui.content, 'Footer');\n\n assert(!footer);\n}\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n * it('should do something', async () => {\n * const { request } = await installSnap('local:my-snap');\n * const response = await request({\n * method: 'foo',\n * params: ['bar'],\n * });\n * expect(response).toRespondWith('bar');\n * });\n * });\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap(): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n * it('should do something', async () => {\n * const { request } = await installSnap('local:my-snap');\n * const response = await request({\n * method: 'foo',\n * params: ['bar'],\n * });\n * expect(response).toRespondWith('bar');\n * });\n * });\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n Service extends new (...args: any[]) => InstanceType<\n typeof AbstractExecutionService\n >,\n>(options: Partial<InstallSnapOptions<Service>>): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n * it('should do something', async () => {\n * const { request } = await installSnap('local:my-snap');\n * const response = await request({\n * method: 'foo',\n * params: ['bar'],\n * });\n * expect(response).toRespondWith('bar');\n * });\n * });\n * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults\n * to the URL of the built-in server, if it is running. This supports both\n * local snap IDs and NPM snap IDs.\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n Service extends new (...args: any[]) => InstanceType<\n typeof AbstractExecutionService\n >,\n>(\n snapId: SnapId,\n options?: Partial<InstallSnapOptions<Service>>,\n): Promise<Snap>;\n\n/**\n * Load a snap into the environment. This is the main entry point for testing\n * snaps: It returns a {@link Snap} object that can be used to interact with the\n * snap.\n *\n * @example\n * import { installSnap } from '@metamask/snaps-jest';\n *\n * describe('My Snap', () => {\n * it('should do something', async () => {\n * const { request } = await installSnap('local:my-snap');\n * const response = await request({\n * method: 'foo',\n * params: ['bar'],\n * });\n * expect(response).toRespondWith('bar');\n * });\n * });\n * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults\n * to the URL of the built-in server, if it is running. This supports both\n * local snap IDs and NPM snap IDs.\n * @param options - The options to use.\n * @param options.executionService - The execution service to use. Defaults to\n * {@link NodeThreadExecutionService}. You do not need to provide this unless\n * you are testing a custom execution service.\n * @param options.executionServiceOptions - The options to use when creating the\n * execution service, if any. This should only include options specific to the\n * provided execution service.\n * @param options.options - The simulation options.\n * @returns The snap.\n * @throws If the built-in server is not running, and no snap ID is provided.\n */\nexport async function installSnap<\n Service extends new (...args: any[]) => InstanceType<\n typeof AbstractExecutionService\n >,\n>(\n snapId?: SnapId | Partial<InstallSnapOptions<Service>>,\n options: Partial<InstallSnapOptions<Service>> = {},\n): Promise<Snap> {\n const resolvedOptions = getOptions(snapId, options);\n const {\n snapId: installedSnapId,\n store,\n executionService,\n runSaga,\n controllerMessenger,\n } = await getEnvironment().installSnap(...resolvedOptions);\n\n const onTransaction = async (\n request: TransactionOptions,\n ): Promise<SnapResponseWithInterface> => {\n log('Sending transaction %o.', request);\n\n const {\n origin: transactionOrigin,\n chainId,\n ...transaction\n } = create(request, TransactionOptionsStruct);\n\n const response = await handleRequest({\n snapId: installedSnapId,\n store,\n executionService,\n runSaga,\n controllerMessenger,\n handler: HandlerType.OnTransaction,\n request: {\n method: '',\n params: {\n chainId,\n transaction,\n transactionOrigin,\n },\n },\n });\n\n assertIsResponseWithInterface(response);\n\n return response;\n };\n\n const onCronjob = (request: CronjobOptions) => {\n log('Running cronjob %o.', options);\n\n return handleRequest({\n snapId: installedSnapId,\n store,\n executionService,\n controllerMessenger,\n runSaga,\n handler: HandlerType.OnCronjob,\n request,\n });\n };\n\n return {\n request: (request) => {\n log('Sending request %o.', request);\n\n return handleRequest({\n snapId: installedSnapId,\n store,\n executionService,\n controllerMessenger,\n runSaga,\n handler: HandlerType.OnRpcRequest,\n request,\n });\n },\n\n onTransaction,\n sendTransaction: onTransaction,\n\n onSignature: async (\n request: unknown,\n ): Promise<SnapResponseWithInterface> => {\n log('Requesting signature %o.', request);\n\n const { origin: signatureOrigin, ...signature } = create(\n request,\n SignatureOptionsStruct,\n );\n\n const response = await handleRequest({\n snapId: installedSnapId,\n store,\n executionService,\n controllerMessenger,\n runSaga,\n handler: HandlerType.OnSignature,\n request: {\n method: '',\n params: {\n signature,\n signatureOrigin,\n },\n },\n });\n\n assertIsResponseWithInterface(response);\n\n return response;\n },\n\n onCronjob,\n runCronjob: onCronjob,\n\n onHomePage: async (): Promise<SnapResponseWithInterface> => {\n log('Rendering home page.');\n\n const response = await handleRequest({\n snapId: installedSnapId,\n store,\n executionService,\n controllerMessenger,\n runSaga,\n handler: HandlerType.OnHomePage,\n request: {\n method: '',\n },\n });\n\n assertIsResponseWithInterface(response);\n\n return response;\n },\n\n mockJsonRpc(mock: JsonRpcMockOptions) {\n log('Mocking JSON-RPC request %o.', mock);\n\n const { method, result } = create(mock, JsonRpcMockOptionsStruct);\n store.dispatch(addJsonRpcMock({ method, result }));\n\n return {\n unmock() {\n log('Unmocking JSON-RPC request %o.', mock);\n\n store.dispatch(removeJsonRpcMock(method));\n },\n };\n },\n\n close: async () => {\n log('Closing execution service.');\n logInfo(\n 'Calling `snap.close()` is deprecated, and will be removed in a future release. Snaps are now automatically closed when the test ends.',\n );\n\n await executionService.terminateAllSnaps();\n },\n };\n}\n"]}
@@ -1,7 +1,49 @@
1
- import type { AbstractExecutionService } from '@metamask/snaps-controllers';
2
- import type { SnapId } from '@metamask/snaps-sdk';
3
- import type { InstallSnapOptions } from './internals';
4
- import type { Snap } from './types';
1
+ import type { AbstractExecutionService } from "@metamask/snaps-controllers";
2
+ import type { SnapId } from "@metamask/snaps-sdk";
3
+ import type { InstallSnapOptions } from "./internals/index.cjs";
4
+ import type { Snap, SnapInterface, SnapAlertInterface, SnapInterfaceActions, SnapConfirmationInterface, SnapPromptInterface, DefaultSnapInterface, DefaultSnapInterfaceWithFooter, DefaultSnapInterfaceWithPartialFooter, DefaultSnapInterfaceWithoutFooter } from "./types/index.cjs";
5
+ /**
6
+ * Ensure that the actual interface is an alert dialog.
7
+ *
8
+ * @param ui - The interface to verify.
9
+ */
10
+ export declare function assertIsAlertDialog(ui: SnapInterface): asserts ui is SnapAlertInterface & SnapInterfaceActions;
11
+ /**
12
+ * Ensure that the actual interface is a confirmation dialog.
13
+ *
14
+ * @param ui - The interface to verify.
15
+ */
16
+ export declare function assertIsConfirmationDialog(ui: SnapInterface): asserts ui is SnapConfirmationInterface & SnapInterfaceActions;
17
+ /**
18
+ * Ensure that the actual interface is a Prompt dialog.
19
+ *
20
+ * @param ui - The interface to verify.
21
+ */
22
+ export declare function assertIsPromptDialog(ui: SnapInterface): asserts ui is SnapPromptInterface & SnapInterfaceActions;
23
+ /**
24
+ * Ensure that the actual interface is a custom dialog.
25
+ *
26
+ * @param ui - The interface to verify.
27
+ */
28
+ export declare function assertIsCustomDialog(ui: SnapInterface): asserts ui is DefaultSnapInterface & SnapInterfaceActions;
29
+ /**
30
+ * Ensure that the actual interface is a custom dialog with a complete footer.
31
+ *
32
+ * @param ui - The interface to verify.
33
+ */
34
+ export declare function assertCustomDialogHasFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithFooter & SnapInterfaceActions;
35
+ /**
36
+ * Ensure that the actual interface is a custom dialog with a partial footer.
37
+ *
38
+ * @param ui - The interface to verify.
39
+ */
40
+ export declare function assertCustomDialogHasPartialFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithPartialFooter & SnapInterfaceActions;
41
+ /**
42
+ * Ensure that the actual interface is a custom dialog without a footer.
43
+ *
44
+ * @param ui - The interface to verify.
45
+ */
46
+ export declare function assertCustomDialogHasNoFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithoutFooter & SnapInterfaceActions;
5
47
  /**
6
48
  * Load a snap into the environment. This is the main entry point for testing
7
49
  * snaps: It returns a {@link Snap} object that can be used to interact with the
@@ -87,3 +129,4 @@ export declare function installSnap<Service extends new (...args: any[]) => Inst
87
129
  * @throws If the built-in server is not running, and no snap ID is provided.
88
130
  */
89
131
  export declare function installSnap<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService>>(snapId: SnapId, options?: Partial<InstallSnapOptions<Service>>): Promise<Snap>;
132
+ //# sourceMappingURL=helpers.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.d.cts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,oCAAoC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAsBlD,OAAO,KAAK,EAAE,kBAAkB,EAAE,8BAAoB;AAKtD,OAAO,KAAK,EAIV,IAAI,EAGJ,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,8BAA8B,EAC9B,qCAAqC,EACrC,iCAAiC,EAClC,0BAAgB;AAqCjB;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,kBAAkB,GAAG,oBAAoB,CAEzD;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,yBAAyB,GAAG,oBAAoB,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,mBAAmB,GAAG,oBAAoB,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,oBAAoB,GAAG,oBAAoB,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,8BAA8B,GAAG,oBAAoB,CAIrE;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAChD,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,qCAAqC,GAAG,oBAAoB,CAI5E;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,iCAAiC,GAAG,oBAAoB,CAIxE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EACD,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EAED,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAC7C,OAAO,CAAC,IAAI,CAAC,CAAC"}
@@ -0,0 +1,132 @@
1
+ import type { AbstractExecutionService } from "@metamask/snaps-controllers";
2
+ import type { SnapId } from "@metamask/snaps-sdk";
3
+ import type { InstallSnapOptions } from "./internals/index.mjs";
4
+ import type { Snap, SnapInterface, SnapAlertInterface, SnapInterfaceActions, SnapConfirmationInterface, SnapPromptInterface, DefaultSnapInterface, DefaultSnapInterfaceWithFooter, DefaultSnapInterfaceWithPartialFooter, DefaultSnapInterfaceWithoutFooter } from "./types/index.mjs";
5
+ /**
6
+ * Ensure that the actual interface is an alert dialog.
7
+ *
8
+ * @param ui - The interface to verify.
9
+ */
10
+ export declare function assertIsAlertDialog(ui: SnapInterface): asserts ui is SnapAlertInterface & SnapInterfaceActions;
11
+ /**
12
+ * Ensure that the actual interface is a confirmation dialog.
13
+ *
14
+ * @param ui - The interface to verify.
15
+ */
16
+ export declare function assertIsConfirmationDialog(ui: SnapInterface): asserts ui is SnapConfirmationInterface & SnapInterfaceActions;
17
+ /**
18
+ * Ensure that the actual interface is a Prompt dialog.
19
+ *
20
+ * @param ui - The interface to verify.
21
+ */
22
+ export declare function assertIsPromptDialog(ui: SnapInterface): asserts ui is SnapPromptInterface & SnapInterfaceActions;
23
+ /**
24
+ * Ensure that the actual interface is a custom dialog.
25
+ *
26
+ * @param ui - The interface to verify.
27
+ */
28
+ export declare function assertIsCustomDialog(ui: SnapInterface): asserts ui is DefaultSnapInterface & SnapInterfaceActions;
29
+ /**
30
+ * Ensure that the actual interface is a custom dialog with a complete footer.
31
+ *
32
+ * @param ui - The interface to verify.
33
+ */
34
+ export declare function assertCustomDialogHasFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithFooter & SnapInterfaceActions;
35
+ /**
36
+ * Ensure that the actual interface is a custom dialog with a partial footer.
37
+ *
38
+ * @param ui - The interface to verify.
39
+ */
40
+ export declare function assertCustomDialogHasPartialFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithPartialFooter & SnapInterfaceActions;
41
+ /**
42
+ * Ensure that the actual interface is a custom dialog without a footer.
43
+ *
44
+ * @param ui - The interface to verify.
45
+ */
46
+ export declare function assertCustomDialogHasNoFooter(ui: DefaultSnapInterface & SnapInterfaceActions): asserts ui is DefaultSnapInterfaceWithoutFooter & SnapInterfaceActions;
47
+ /**
48
+ * Load a snap into the environment. This is the main entry point for testing
49
+ * snaps: It returns a {@link Snap} object that can be used to interact with the
50
+ * snap.
51
+ *
52
+ * @example
53
+ * import { installSnap } from '@metamask/snaps-jest';
54
+ *
55
+ * describe('My Snap', () => {
56
+ * it('should do something', async () => {
57
+ * const { request } = await installSnap('local:my-snap');
58
+ * const response = await request({
59
+ * method: 'foo',
60
+ * params: ['bar'],
61
+ * });
62
+ * expect(response).toRespondWith('bar');
63
+ * });
64
+ * });
65
+ * @returns The snap.
66
+ * @throws If the built-in server is not running, and no snap ID is provided.
67
+ */
68
+ export declare function installSnap(): Promise<Snap>;
69
+ /**
70
+ * Load a snap into the environment. This is the main entry point for testing
71
+ * snaps: It returns a {@link Snap} object that can be used to interact with the
72
+ * snap.
73
+ *
74
+ * @example
75
+ * import { installSnap } from '@metamask/snaps-jest';
76
+ *
77
+ * describe('My Snap', () => {
78
+ * it('should do something', async () => {
79
+ * const { request } = await installSnap('local:my-snap');
80
+ * const response = await request({
81
+ * method: 'foo',
82
+ * params: ['bar'],
83
+ * });
84
+ * expect(response).toRespondWith('bar');
85
+ * });
86
+ * });
87
+ * @param options - The options to use.
88
+ * @param options.executionService - The execution service to use. Defaults to
89
+ * {@link NodeThreadExecutionService}. You do not need to provide this unless
90
+ * you are testing a custom execution service.
91
+ * @param options.executionServiceOptions - The options to use when creating the
92
+ * execution service, if any. This should only include options specific to the
93
+ * provided execution service.
94
+ * @param options.options - The simulation options.
95
+ * @returns The snap.
96
+ * @throws If the built-in server is not running, and no snap ID is provided.
97
+ */
98
+ export declare function installSnap<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService>>(options: Partial<InstallSnapOptions<Service>>): Promise<Snap>;
99
+ /**
100
+ * Load a snap into the environment. This is the main entry point for testing
101
+ * snaps: It returns a {@link Snap} object that can be used to interact with the
102
+ * snap.
103
+ *
104
+ * @example
105
+ * import { installSnap } from '@metamask/snaps-jest';
106
+ *
107
+ * describe('My Snap', () => {
108
+ * it('should do something', async () => {
109
+ * const { request } = await installSnap('local:my-snap');
110
+ * const response = await request({
111
+ * method: 'foo',
112
+ * params: ['bar'],
113
+ * });
114
+ * expect(response).toRespondWith('bar');
115
+ * });
116
+ * });
117
+ * @param snapId - The ID of the snap, including the prefix (`local:`). Defaults
118
+ * to the URL of the built-in server, if it is running. This supports both
119
+ * local snap IDs and NPM snap IDs.
120
+ * @param options - The options to use.
121
+ * @param options.executionService - The execution service to use. Defaults to
122
+ * {@link NodeThreadExecutionService}. You do not need to provide this unless
123
+ * you are testing a custom execution service.
124
+ * @param options.executionServiceOptions - The options to use when creating the
125
+ * execution service, if any. This should only include options specific to the
126
+ * provided execution service.
127
+ * @param options.options - The simulation options.
128
+ * @returns The snap.
129
+ * @throws If the built-in server is not running, and no snap ID is provided.
130
+ */
131
+ export declare function installSnap<Service extends new (...args: any[]) => InstanceType<typeof AbstractExecutionService>>(snapId: SnapId, options?: Partial<InstallSnapOptions<Service>>): Promise<Snap>;
132
+ //# sourceMappingURL=helpers.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"helpers.d.mts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,oCAAoC;AAC5E,OAAO,KAAK,EAAE,MAAM,EAAE,4BAA4B;AAsBlD,OAAO,KAAK,EAAE,kBAAkB,EAAE,8BAAoB;AAKtD,OAAO,KAAK,EAIV,IAAI,EAGJ,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,mBAAmB,EACnB,oBAAoB,EACpB,8BAA8B,EAC9B,qCAAqC,EACrC,iCAAiC,EAClC,0BAAgB;AAqCjB;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,kBAAkB,GAAG,oBAAoB,CAEzD;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,yBAAyB,GAAG,oBAAoB,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,mBAAmB,GAAG,oBAAoB,CAE1D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,aAAa,GAChB,OAAO,CAAC,EAAE,IAAI,oBAAoB,GAAG,oBAAoB,CAE3D;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,8BAA8B,GAAG,oBAAoB,CAIrE;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAChD,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,qCAAqC,GAAG,oBAAoB,CAI5E;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,EAAE,EAAE,oBAAoB,GAAG,oBAAoB,GAC9C,OAAO,CAAC,EAAE,IAAI,iCAAiC,GAAG,oBAAoB,CAIxE;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EACD,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAsB,WAAW,CAC/B,OAAO,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,YAAY,CAClD,OAAO,wBAAwB,CAChC,EAED,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,GAC7C,OAAO,CAAC,IAAI,CAAC,CAAC"}