@etohq/core-flows 1.3.0 → 1.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 (300) hide show
  1. package/LICENSE +21 -0
  2. package/dist/api-key/steps/create-api-keys.d.ts +17 -0
  3. package/dist/api-key/steps/create-api-keys.d.ts.map +1 -1
  4. package/dist/api-key/steps/create-api-keys.js +11 -0
  5. package/dist/api-key/steps/create-api-keys.js.map +1 -1
  6. package/dist/api-key/steps/delete-api-keys.d.ts +5 -1
  7. package/dist/api-key/steps/delete-api-keys.d.ts.map +1 -1
  8. package/dist/api-key/steps/delete-api-keys.js.map +1 -1
  9. package/dist/api-key/steps/revoke-api-keys.d.ts +19 -0
  10. package/dist/api-key/steps/revoke-api-keys.d.ts.map +1 -1
  11. package/dist/api-key/steps/revoke-api-keys.js +10 -0
  12. package/dist/api-key/steps/revoke-api-keys.js.map +1 -1
  13. package/dist/api-key/steps/update-api-keys.d.ts +19 -0
  14. package/dist/api-key/steps/update-api-keys.d.ts.map +1 -1
  15. package/dist/api-key/steps/update-api-keys.js +10 -0
  16. package/dist/api-key/steps/update-api-keys.js.map +1 -1
  17. package/dist/api-key/workflows/create-api-keys.d.ts +41 -2
  18. package/dist/api-key/workflows/create-api-keys.d.ts.map +1 -1
  19. package/dist/api-key/workflows/create-api-keys.js +30 -2
  20. package/dist/api-key/workflows/create-api-keys.js.map +1 -1
  21. package/dist/api-key/workflows/delete-api-keys.d.ts +23 -1
  22. package/dist/api-key/workflows/delete-api-keys.d.ts.map +1 -1
  23. package/dist/api-key/workflows/delete-api-keys.js +17 -1
  24. package/dist/api-key/workflows/delete-api-keys.js.map +1 -1
  25. package/dist/api-key/workflows/link-sales-channels-to-publishable-key.d.ts +32 -0
  26. package/dist/api-key/workflows/link-sales-channels-to-publishable-key.d.ts.map +1 -0
  27. package/dist/api-key/workflows/link-sales-channels-to-publishable-key.js +33 -0
  28. package/dist/api-key/workflows/link-sales-channels-to-publishable-key.js.map +1 -0
  29. package/dist/api-key/workflows/revoke-api-keys.d.ts +38 -2
  30. package/dist/api-key/workflows/revoke-api-keys.d.ts.map +1 -1
  31. package/dist/api-key/workflows/revoke-api-keys.js +24 -1
  32. package/dist/api-key/workflows/revoke-api-keys.js.map +1 -1
  33. package/dist/api-key/workflows/update-api-keys.d.ts +36 -2
  34. package/dist/api-key/workflows/update-api-keys.d.ts.map +1 -1
  35. package/dist/api-key/workflows/update-api-keys.js +22 -1
  36. package/dist/api-key/workflows/update-api-keys.js.map +1 -1
  37. package/dist/auth/steps/set-auth-app-metadata.d.ts +30 -1
  38. package/dist/auth/steps/set-auth-app-metadata.d.ts.map +1 -1
  39. package/dist/auth/steps/set-auth-app-metadata.js +30 -1
  40. package/dist/auth/steps/set-auth-app-metadata.js.map +1 -1
  41. package/dist/auth/workflows/generate-reset-password-token.d.ts +33 -2
  42. package/dist/auth/workflows/generate-reset-password-token.d.ts.map +1 -1
  43. package/dist/auth/workflows/generate-reset-password-token.js +30 -5
  44. package/dist/auth/workflows/generate-reset-password-token.js.map +1 -1
  45. package/dist/common/index.d.ts +1 -2
  46. package/dist/common/index.d.ts.map +1 -1
  47. package/dist/common/index.js +1 -2
  48. package/dist/common/index.js.map +1 -1
  49. package/dist/common/steps/create-entities.d.ts +33 -1
  50. package/dist/common/steps/create-entities.d.ts.map +1 -1
  51. package/dist/common/steps/create-entities.js +17 -1
  52. package/dist/common/steps/create-entities.js.map +1 -1
  53. package/dist/common/steps/create-remote-links.d.ts +8 -23
  54. package/dist/common/steps/create-remote-links.d.ts.map +1 -1
  55. package/dist/common/steps/create-remote-links.js +8 -23
  56. package/dist/common/steps/create-remote-links.js.map +1 -1
  57. package/dist/common/steps/delete-entities.d.ts +26 -1
  58. package/dist/common/steps/delete-entities.d.ts.map +1 -1
  59. package/dist/common/steps/delete-entities.js +9 -1
  60. package/dist/common/steps/delete-entities.js.map +1 -1
  61. package/dist/common/steps/dismiss-remote-links.d.ts +8 -23
  62. package/dist/common/steps/dismiss-remote-links.d.ts.map +1 -1
  63. package/dist/common/steps/dismiss-remote-links.js +8 -23
  64. package/dist/common/steps/dismiss-remote-links.js.map +1 -1
  65. package/dist/common/steps/emit-event.d.ts +5 -17
  66. package/dist/common/steps/emit-event.d.ts.map +1 -1
  67. package/dist/common/steps/emit-event.js +5 -17
  68. package/dist/common/steps/emit-event.js.map +1 -1
  69. package/dist/common/steps/remove-remote-links.d.ts +5 -20
  70. package/dist/common/steps/remove-remote-links.d.ts.map +1 -1
  71. package/dist/common/steps/remove-remote-links.js +5 -20
  72. package/dist/common/steps/remove-remote-links.js.map +1 -1
  73. package/dist/common/steps/update-remote-links.d.ts +22 -0
  74. package/dist/common/steps/update-remote-links.d.ts.map +1 -1
  75. package/dist/common/steps/update-remote-links.js +22 -0
  76. package/dist/common/steps/update-remote-links.js.map +1 -1
  77. package/dist/common/steps/use-query-graph.d.ts +8 -20
  78. package/dist/common/steps/use-query-graph.d.ts.map +1 -1
  79. package/dist/common/steps/use-query-graph.js +7 -19
  80. package/dist/common/steps/use-query-graph.js.map +1 -1
  81. package/dist/common/steps/use-remote-query.d.ts +34 -70
  82. package/dist/common/steps/use-remote-query.d.ts.map +1 -1
  83. package/dist/common/steps/use-remote-query.js +34 -70
  84. package/dist/common/steps/use-remote-query.js.map +1 -1
  85. package/dist/common/workflows/batch-links.d.ts +51 -0
  86. package/dist/common/workflows/batch-links.d.ts.map +1 -1
  87. package/dist/common/workflows/batch-links.js +51 -0
  88. package/dist/common/workflows/batch-links.js.map +1 -1
  89. package/dist/common/workflows/create-links.d.ts +25 -0
  90. package/dist/common/workflows/create-links.d.ts.map +1 -1
  91. package/dist/common/workflows/create-links.js +25 -0
  92. package/dist/common/workflows/create-links.js.map +1 -1
  93. package/dist/common/workflows/dismiss-links.d.ts +25 -0
  94. package/dist/common/workflows/dismiss-links.d.ts.map +1 -1
  95. package/dist/common/workflows/dismiss-links.js +25 -0
  96. package/dist/common/workflows/dismiss-links.js.map +1 -1
  97. package/dist/common/workflows/update-links.d.ts +30 -0
  98. package/dist/common/workflows/update-links.d.ts.map +1 -1
  99. package/dist/common/workflows/update-links.js +30 -0
  100. package/dist/common/workflows/update-links.js.map +1 -1
  101. package/dist/file/steps/delete-files.d.ts +13 -2
  102. package/dist/file/steps/delete-files.d.ts.map +1 -1
  103. package/dist/file/steps/delete-files.js +8 -1
  104. package/dist/file/steps/delete-files.js.map +1 -1
  105. package/dist/file/steps/upload-files.d.ts +40 -1
  106. package/dist/file/steps/upload-files.d.ts.map +1 -1
  107. package/dist/file/steps/upload-files.js +14 -1
  108. package/dist/file/steps/upload-files.js.map +1 -1
  109. package/dist/file/workflows/delete-files.d.ts +20 -1
  110. package/dist/file/workflows/delete-files.d.ts.map +1 -1
  111. package/dist/file/workflows/delete-files.js +20 -1
  112. package/dist/file/workflows/delete-files.js.map +1 -1
  113. package/dist/file/workflows/upload-files.d.ts +51 -1
  114. package/dist/file/workflows/upload-files.d.ts.map +1 -1
  115. package/dist/file/workflows/upload-files.js +25 -1
  116. package/dist/file/workflows/upload-files.js.map +1 -1
  117. package/dist/invite/index.d.ts +3 -0
  118. package/dist/invite/index.d.ts.map +1 -0
  119. package/dist/invite/index.js +19 -0
  120. package/dist/invite/index.js.map +1 -0
  121. package/dist/invite/steps/create-invites.d.ts +14 -0
  122. package/dist/invite/steps/create-invites.d.ts.map +1 -0
  123. package/dist/invite/steps/create-invites.js +28 -0
  124. package/dist/invite/steps/create-invites.js.map +1 -0
  125. package/dist/invite/steps/delete-invites.d.ts +10 -0
  126. package/dist/invite/steps/delete-invites.d.ts.map +1 -0
  127. package/dist/invite/steps/delete-invites.js +21 -0
  128. package/dist/invite/steps/delete-invites.js.map +1 -0
  129. package/dist/invite/steps/index.d.ts +5 -0
  130. package/dist/invite/steps/index.d.ts.map +1 -0
  131. package/dist/invite/steps/index.js +21 -0
  132. package/dist/invite/steps/index.js.map +1 -0
  133. package/dist/invite/steps/refresh-invite-tokens.d.ts +10 -0
  134. package/dist/invite/steps/refresh-invite-tokens.d.ts.map +1 -0
  135. package/dist/invite/steps/refresh-invite-tokens.js +15 -0
  136. package/dist/invite/steps/refresh-invite-tokens.js.map +1 -0
  137. package/dist/invite/steps/validate-token.d.ts +11 -0
  138. package/dist/invite/steps/validate-token.d.ts.map +1 -0
  139. package/dist/invite/steps/validate-token.js +16 -0
  140. package/dist/invite/steps/validate-token.js.map +1 -0
  141. package/dist/invite/workflows/accept-invite.d.ts +33 -0
  142. package/dist/invite/workflows/accept-invite.d.ts.map +1 -0
  143. package/dist/invite/workflows/accept-invite.js +70 -0
  144. package/dist/invite/workflows/accept-invite.js.map +1 -0
  145. package/dist/invite/workflows/create-invites.d.ts +27 -0
  146. package/dist/invite/workflows/create-invites.d.ts.map +1 -0
  147. package/dist/invite/workflows/create-invites.js +45 -0
  148. package/dist/invite/workflows/create-invites.js.map +1 -0
  149. package/dist/invite/workflows/delete-invites.d.ts +23 -0
  150. package/dist/invite/workflows/delete-invites.d.ts.map +1 -0
  151. package/dist/invite/workflows/delete-invites.js +40 -0
  152. package/dist/invite/workflows/delete-invites.js.map +1 -0
  153. package/dist/invite/workflows/index.d.ts +5 -0
  154. package/dist/invite/workflows/index.d.ts.map +1 -0
  155. package/dist/invite/workflows/index.js +21 -0
  156. package/dist/invite/workflows/index.js.map +1 -0
  157. package/dist/invite/workflows/refresh-invite-tokens.d.ts +27 -0
  158. package/dist/invite/workflows/refresh-invite-tokens.d.ts.map +1 -0
  159. package/dist/invite/workflows/refresh-invite-tokens.js +45 -0
  160. package/dist/invite/workflows/refresh-invite-tokens.js.map +1 -0
  161. package/dist/locking/acquire-lock.d.ts +23 -0
  162. package/dist/locking/acquire-lock.d.ts.map +1 -0
  163. package/dist/locking/acquire-lock.js +61 -0
  164. package/dist/locking/acquire-lock.js.map +1 -0
  165. package/dist/locking/index.d.ts +3 -0
  166. package/dist/locking/index.d.ts.map +1 -0
  167. package/dist/locking/index.js +19 -0
  168. package/dist/locking/index.js.map +1 -0
  169. package/dist/locking/release-lock.d.ts +19 -0
  170. package/dist/locking/release-lock.d.ts.map +1 -0
  171. package/dist/locking/release-lock.js +31 -0
  172. package/dist/locking/release-lock.js.map +1 -0
  173. package/dist/notification/steps/notify-on-failure.d.ts +52 -2
  174. package/dist/notification/steps/notify-on-failure.d.ts.map +1 -1
  175. package/dist/notification/steps/notify-on-failure.js +12 -2
  176. package/dist/notification/steps/notify-on-failure.js.map +1 -1
  177. package/dist/notification/steps/send-notifications.d.ts +38 -0
  178. package/dist/notification/steps/send-notifications.d.ts.map +1 -1
  179. package/dist/notification/steps/send-notifications.js.map +1 -1
  180. package/dist/payment/steps/authorize-payment-session.d.ts +19 -3
  181. package/dist/payment/steps/authorize-payment-session.d.ts.map +1 -1
  182. package/dist/payment/steps/authorize-payment-session.js +10 -1
  183. package/dist/payment/steps/authorize-payment-session.js.map +1 -1
  184. package/dist/payment/steps/cancel-payment.d.ts +6 -0
  185. package/dist/payment/steps/cancel-payment.d.ts.map +1 -1
  186. package/dist/payment/steps/cancel-payment.js.map +1 -1
  187. package/dist/payment/steps/capture-payment.d.ts +14 -2
  188. package/dist/payment/steps/capture-payment.d.ts.map +1 -1
  189. package/dist/payment/steps/capture-payment.js +4 -1
  190. package/dist/payment/steps/capture-payment.js.map +1 -1
  191. package/dist/payment/steps/complete-cart-after-payment.d.ts +15 -0
  192. package/dist/payment/steps/complete-cart-after-payment.d.ts.map +1 -0
  193. package/dist/payment/steps/complete-cart-after-payment.js +20 -0
  194. package/dist/payment/steps/complete-cart-after-payment.js.map +1 -0
  195. package/dist/payment/steps/refund-payment.d.ts +14 -2
  196. package/dist/payment/steps/refund-payment.d.ts.map +1 -1
  197. package/dist/payment/steps/refund-payment.js +4 -1
  198. package/dist/payment/steps/refund-payment.js.map +1 -1
  199. package/dist/payment/steps/refund-payments.d.ts +22 -5
  200. package/dist/payment/steps/refund-payments.d.ts.map +1 -1
  201. package/dist/payment/steps/refund-payments.js.map +1 -1
  202. package/dist/payment-collection/steps/cancel-payment.d.ts +15 -0
  203. package/dist/payment-collection/steps/cancel-payment.d.ts.map +1 -0
  204. package/dist/payment-collection/steps/cancel-payment.js +33 -0
  205. package/dist/payment-collection/steps/cancel-payment.js.map +1 -0
  206. package/dist/payment-collection/steps/create-payment-account-holder.d.ts +18 -0
  207. package/dist/payment-collection/steps/create-payment-account-holder.d.ts.map +1 -0
  208. package/dist/payment-collection/steps/create-payment-account-holder.js +37 -0
  209. package/dist/payment-collection/steps/create-payment-account-holder.js.map +1 -0
  210. package/dist/payment-collection/steps/create-payment-session.d.ts +31 -2
  211. package/dist/payment-collection/steps/create-payment-session.d.ts.map +1 -1
  212. package/dist/payment-collection/steps/create-payment-session.js +1 -0
  213. package/dist/payment-collection/steps/create-payment-session.js.map +1 -1
  214. package/dist/payment-collection/steps/create-refund-reasons.d.ts +6 -2
  215. package/dist/payment-collection/steps/create-refund-reasons.d.ts.map +1 -1
  216. package/dist/payment-collection/steps/create-refund-reasons.js.map +1 -1
  217. package/dist/payment-collection/steps/delete-payment-sessions.d.ts +7 -1
  218. package/dist/payment-collection/steps/delete-payment-sessions.d.ts.map +1 -1
  219. package/dist/payment-collection/steps/delete-payment-sessions.js +1 -1
  220. package/dist/payment-collection/steps/delete-payment-sessions.js.map +1 -1
  221. package/dist/payment-collection/steps/delete-refund-reasons.d.ts +5 -1
  222. package/dist/payment-collection/steps/delete-refund-reasons.d.ts.map +1 -1
  223. package/dist/payment-collection/steps/delete-refund-reasons.js.map +1 -1
  224. package/dist/payment-collection/steps/index.d.ts +1 -0
  225. package/dist/payment-collection/steps/index.d.ts.map +1 -1
  226. package/dist/payment-collection/steps/index.js +1 -0
  227. package/dist/payment-collection/steps/index.js.map +1 -1
  228. package/dist/payment-collection/steps/update-payment-collection.d.ts +21 -2
  229. package/dist/payment-collection/steps/update-payment-collection.d.ts.map +1 -1
  230. package/dist/payment-collection/steps/update-payment-collection.js +10 -0
  231. package/dist/payment-collection/steps/update-payment-collection.js.map +1 -1
  232. package/dist/payment-collection/steps/update-refund-reasons.d.ts +6 -2
  233. package/dist/payment-collection/steps/update-refund-reasons.d.ts.map +1 -1
  234. package/dist/payment-collection/steps/update-refund-reasons.js.map +1 -1
  235. package/dist/payment-collection/steps/validate-deleted-payment-sessions.d.ts +16 -0
  236. package/dist/payment-collection/steps/validate-deleted-payment-sessions.d.ts.map +1 -1
  237. package/dist/payment-collection/steps/validate-deleted-payment-sessions.js +7 -0
  238. package/dist/payment-collection/steps/validate-deleted-payment-sessions.js.map +1 -1
  239. package/dist/payment-collection/workflows/cancel-payment-collection.d.ts +23 -0
  240. package/dist/payment-collection/workflows/cancel-payment-collection.d.ts.map +1 -0
  241. package/dist/payment-collection/workflows/cancel-payment-collection.js +66 -0
  242. package/dist/payment-collection/workflows/cancel-payment-collection.js.map +1 -0
  243. package/dist/payment-collection/workflows/create-payment-session.d.ts +42 -3
  244. package/dist/payment-collection/workflows/create-payment-session.d.ts.map +1 -1
  245. package/dist/payment-collection/workflows/create-payment-session.js +81 -3
  246. package/dist/payment-collection/workflows/create-payment-session.js.map +1 -1
  247. package/dist/payment-collection/workflows/create-refund-reasons.d.ts +32 -5
  248. package/dist/payment-collection/workflows/create-refund-reasons.d.ts.map +1 -1
  249. package/dist/payment-collection/workflows/create-refund-reasons.js +21 -1
  250. package/dist/payment-collection/workflows/create-refund-reasons.js.map +1 -1
  251. package/dist/payment-collection/workflows/delete-payment-sessions.d.ts +23 -1
  252. package/dist/payment-collection/workflows/delete-payment-sessions.d.ts.map +1 -1
  253. package/dist/payment-collection/workflows/delete-payment-sessions.js +17 -1
  254. package/dist/payment-collection/workflows/delete-payment-sessions.js.map +1 -1
  255. package/dist/payment-collection/workflows/delete-refund-reasons.d.ts +27 -4
  256. package/dist/payment-collection/workflows/delete-refund-reasons.d.ts.map +1 -1
  257. package/dist/payment-collection/workflows/delete-refund-reasons.js +17 -1
  258. package/dist/payment-collection/workflows/delete-refund-reasons.js.map +1 -1
  259. package/dist/payment-collection/workflows/index.d.ts +1 -0
  260. package/dist/payment-collection/workflows/index.d.ts.map +1 -1
  261. package/dist/payment-collection/workflows/index.js +1 -0
  262. package/dist/payment-collection/workflows/index.js.map +1 -1
  263. package/dist/payment-collection/workflows/update-refund-reasons.d.ts +30 -3
  264. package/dist/payment-collection/workflows/update-refund-reasons.d.ts.map +1 -1
  265. package/dist/payment-collection/workflows/update-refund-reasons.js +20 -1
  266. package/dist/payment-collection/workflows/update-refund-reasons.js.map +1 -1
  267. package/dist/tsconfig.tsbuildinfo +1 -1
  268. package/dist/user/steps/create-users.d.ts +11 -1
  269. package/dist/user/steps/create-users.d.ts.map +1 -1
  270. package/dist/user/steps/create-users.js +11 -1
  271. package/dist/user/steps/create-users.js.map +1 -1
  272. package/dist/user/steps/delete-users.d.ts +6 -2
  273. package/dist/user/steps/delete-users.d.ts.map +1 -1
  274. package/dist/user/steps/delete-users.js +1 -1
  275. package/dist/user/steps/delete-users.js.map +1 -1
  276. package/dist/user/steps/update-users.d.ts +9 -1
  277. package/dist/user/steps/update-users.d.ts.map +1 -1
  278. package/dist/user/steps/update-users.js +9 -1
  279. package/dist/user/steps/update-users.js.map +1 -1
  280. package/dist/user/workflows/create-user-account.d.ts +33 -1
  281. package/dist/user/workflows/create-user-account.d.ts.map +1 -1
  282. package/dist/user/workflows/create-user-account.js +24 -1
  283. package/dist/user/workflows/create-user-account.js.map +1 -1
  284. package/dist/user/workflows/create-users.d.ts +25 -1
  285. package/dist/user/workflows/create-users.d.ts.map +1 -1
  286. package/dist/user/workflows/create-users.js +25 -1
  287. package/dist/user/workflows/create-users.js.map +1 -1
  288. package/dist/user/workflows/delete-users.d.ts +20 -1
  289. package/dist/user/workflows/delete-users.d.ts.map +1 -1
  290. package/dist/user/workflows/delete-users.js +26 -3
  291. package/dist/user/workflows/delete-users.js.map +1 -1
  292. package/dist/user/workflows/remove-user-account.d.ts +23 -1
  293. package/dist/user/workflows/remove-user-account.d.ts.map +1 -1
  294. package/dist/user/workflows/remove-user-account.js +17 -1
  295. package/dist/user/workflows/remove-user-account.js.map +1 -1
  296. package/dist/user/workflows/update-users.d.ts +22 -1
  297. package/dist/user/workflows/update-users.d.ts.map +1 -1
  298. package/dist/user/workflows/update-users.js +22 -1
  299. package/dist/user/workflows/update-users.js.map +1 -1
  300. package/package.json +26 -24
@@ -1,7 +1,17 @@
1
1
  import { CreateUserDTO } from "@etohq/framework/types";
2
2
  export declare const createUsersStepId = "create-users-step";
3
3
  /**
4
- * This step creates one or more users.
4
+ * This step creates one or more users. To allow these users to log in,
5
+ * you must attach an auth identity to each user using the {@link setAuthAppMetadataStep}.
6
+ *
7
+ * @example
8
+ * const data = createUsersStep([
9
+ * {
10
+ * email: "example@gmail.com",
11
+ * first_name: "John",
12
+ * last_name: "Doe",
13
+ * }
14
+ * ])
5
15
  */
6
16
  export declare const createUsersStep: import("@etohq/framework/workflows-sdk").StepFunction<CreateUserDTO[], import("@etohq/framework/types").UserDTO[]>;
7
17
  //# sourceMappingURL=create-users.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-users.d.ts","sourceRoot":"","sources":["../../../src/user/steps/create-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAsB,MAAM,wBAAwB,CAAA;AAI1E,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,eAAe,oHAc3B,CAAA"}
1
+ {"version":3,"file":"create-users.d.ts","sourceRoot":"","sources":["../../../src/user/steps/create-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAsB,MAAM,wBAAwB,CAAA;AAI1E,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,oHAc3B,CAAA"}
@@ -5,7 +5,17 @@ const utils_1 = require("@etohq/framework/utils");
5
5
  const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
6
6
  exports.createUsersStepId = "create-users-step";
7
7
  /**
8
- * This step creates one or more users.
8
+ * This step creates one or more users. To allow these users to log in,
9
+ * you must attach an auth identity to each user using the {@link setAuthAppMetadataStep}.
10
+ *
11
+ * @example
12
+ * const data = createUsersStep([
13
+ * {
14
+ * email: "example@gmail.com",
15
+ * first_name: "John",
16
+ * last_name: "Doe",
17
+ * }
18
+ * ])
9
19
  */
10
20
  exports.createUsersStep = (0, workflows_sdk_1.createStep)(exports.createUsersStepId, async (input, { container }) => {
11
21
  const service = container.resolve(utils_1.Modules.USER);
@@ -1 +1 @@
1
- {"version":3,"file":"create-users.js","sourceRoot":"","sources":["../../../src/user/steps/create-users.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAE5D,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,KAAsB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC9C,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IACnE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;IAC9C,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAA;AAChC,CAAC,EACD,KAAK,EAAE,YAAY,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;QAC1B,OAAM;IACR,CAAC;IACD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAC/C,MAAM,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;AAChE,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"create-users.js","sourceRoot":"","sources":["../../../src/user/steps/create-users.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAE5D,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;;;;;;;;;;;GAYG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,KAAsB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC9C,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IACnE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;IAC9C,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAA;AAChC,CAAC,EACD,KAAK,EAAE,YAAY,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;QAC1B,OAAM;IACR,CAAC;IACD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAC/C,MAAM,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;AAChE,CAAC,CACF,CAAA"}
@@ -1,6 +1,10 @@
1
+ /**
2
+ * The IDs of the users to delete.
3
+ */
4
+ export type DeleteUsersStepInput = string[];
1
5
  export declare const deleteUsersStepId = "delete-users-step";
2
6
  /**
3
- * This step deletes one or more stores.
7
+ * This step deletes one or more users.
4
8
  */
5
- export declare const deleteUsersStep: import("@etohq/framework/workflows-sdk").StepFunction<string[], undefined>;
9
+ export declare const deleteUsersStep: import("@etohq/framework/workflows-sdk").StepFunction<DeleteUsersStepInput, undefined>;
6
10
  //# sourceMappingURL=delete-users.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"delete-users.d.ts","sourceRoot":"","sources":["../../../src/user/steps/delete-users.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,eAAe,4EAkB3B,CAAA"}
1
+ {"version":3,"file":"delete-users.d.ts","sourceRoot":"","sources":["../../../src/user/steps/delete-users.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,EAAE,CAAA;AAE3C,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,eAAe,wFAkB3B,CAAA"}
@@ -5,7 +5,7 @@ const utils_1 = require("@etohq/framework/utils");
5
5
  const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
6
6
  exports.deleteUsersStepId = "delete-users-step";
7
7
  /**
8
- * This step deletes one or more stores.
8
+ * This step deletes one or more users.
9
9
  */
10
10
  exports.deleteUsersStep = (0, workflows_sdk_1.createStep)(exports.deleteUsersStepId, async (input, { container }) => {
11
11
  const service = container.resolve(utils_1.Modules.USER);
@@ -1 +1 @@
1
- {"version":3,"file":"delete-users.js","sourceRoot":"","sources":["../../../src/user/steps/delete-users.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAE5D,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,KAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;IAEpC,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;AACxC,CAAC,EACD,KAAK,EAAE,WAAW,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACnC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;QACzB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAA;AACzC,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"delete-users.js","sourceRoot":"","sources":["../../../src/user/steps/delete-users.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAO5D,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,KAA2B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACnD,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;IAEpC,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAA;AACxC,CAAC,EACD,KAAK,EAAE,WAAW,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACnC,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;QACzB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,CAAA;AACzC,CAAC,CACF,CAAA"}
@@ -1,7 +1,15 @@
1
1
  import { UpdateUserDTO } from "@etohq/framework/types";
2
2
  export declare const updateUsersStepId = "update-users-step";
3
3
  /**
4
- * This step updates one or more stores.
4
+ * This step updates one or more users.
5
+ *
6
+ * @example
7
+ * const data = updateUsersStep([
8
+ * {
9
+ * id: "user_123",
10
+ * last_name: "Doe",
11
+ * }
12
+ * ])
5
13
  */
6
14
  export declare const updateUsersStep: import("@etohq/framework/workflows-sdk").StepFunction<UpdateUserDTO[], import("@etohq/framework/types").UserDTO[]>;
7
15
  //# sourceMappingURL=update-users.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"update-users.d.ts","sourceRoot":"","sources":["../../../src/user/steps/update-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAI1E,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,eAAe,oHAkC3B,CAAA"}
1
+ {"version":3,"file":"update-users.d.ts","sourceRoot":"","sources":["../../../src/user/steps/update-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAI1E,eAAO,MAAM,iBAAiB,sBAAsB,CAAA;AACpD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,oHAkC3B,CAAA"}
@@ -5,7 +5,15 @@ const utils_1 = require("@etohq/framework/utils");
5
5
  const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
6
6
  exports.updateUsersStepId = "update-users-step";
7
7
  /**
8
- * This step updates one or more stores.
8
+ * This step updates one or more users.
9
+ *
10
+ * @example
11
+ * const data = updateUsersStep([
12
+ * {
13
+ * id: "user_123",
14
+ * last_name: "Doe",
15
+ * }
16
+ * ])
9
17
  */
10
18
  exports.updateUsersStep = (0, workflows_sdk_1.createStep)(exports.updateUsersStepId, async (input, { container }) => {
11
19
  const service = container.resolve(utils_1.Modules.USER);
@@ -1 +1 @@
1
- {"version":3,"file":"update-users.js","sourceRoot":"","sources":["../../../src/user/steps/update-users.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAE5D,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,KAAsB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC9C,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,IAAI,4BAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC;QAC5C,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3B,CAAC,CAAA;IAEF,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;IAC9C,OAAO,IAAI,4BAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAA;AAC/C,CAAC,EACD,KAAK,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrC,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,CAAC;QAC3B,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAE/C,MAAM,OAAO,CAAC,WAAW,CACvB,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACxB,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;KACrB,CAAC,CAAC,CACJ,CAAA;AACH,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"update-users.js","sourceRoot":"","sources":["../../../src/user/steps/update-users.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAE5D,QAAA,iBAAiB,GAAG,mBAAmB,CAAA;AACpD;;;;;;;;;;GAUG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,KAAsB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC9C,MAAM,OAAO,GAAuB,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO,IAAI,4BAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC;QAC5C,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3B,CAAC,CAAA;IAEF,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;IAC9C,OAAO,IAAI,4BAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAA;AAC/C,CAAC,EACD,KAAK,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrC,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,CAAC;QAC3B,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,eAAO,CAAC,IAAI,CAAC,CAAA;IAE/C,MAAM,OAAO,CAAC,WAAW,CACvB,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACxB,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,UAAU,EAAE,CAAC,CAAC,UAAU;QACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ;KACrB,CAAC,CAAC,CACJ,CAAA;AACH,CAAC,CACF,CAAA"}
@@ -1,11 +1,43 @@
1
1
  import { CreateUserDTO, UserDTO } from "@etohq/framework/types";
2
+ /**
3
+ * The details of the user account to create.
4
+ */
2
5
  export type CreateUserAccountWorkflowInput = {
6
+ /**
7
+ * The ID of the auth identity to attach the user to.
8
+ */
3
9
  authIdentityId: string;
10
+ /**
11
+ * The details of the user to create.
12
+ */
4
13
  userData: CreateUserDTO;
5
14
  };
6
15
  export declare const createUserAccountWorkflowId = "create-user-account";
7
16
  /**
8
- * This workflow creates an authentication identity for a user.
17
+ * This workflow creates a user and attaches it to an auth identity.
18
+ *
19
+ * You can create an auth identity first using the [Retrieve Registration JWT Token API Route](https://docs.etohq.com/api/admin#auth_postactor_typeauth_provider_register).
20
+ * Learn more about basic authentication flows in [this documentation](https://docs.etohq.com/resources/commerce-modules/auth/authentication-route).
21
+ *
22
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
23
+ * register or create user accounts within your custom flows.
24
+ *
25
+ * @example
26
+ * const { result } = await createUserAccountWorkflow(container)
27
+ * .run({
28
+ * input: {
29
+ * authIdentityId: "au_123",
30
+ * userData: {
31
+ * email: "example@gmail.com",
32
+ * first_name: "John",
33
+ * last_name: "Doe",
34
+ * }
35
+ * }
36
+ * })
37
+ *
38
+ * @summary
39
+ *
40
+ * Create a user account and attach an auth identity.
9
41
  */
10
42
  export declare const createUserAccountWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<CreateUserAccountWorkflowInput, UserDTO, []>;
11
43
  //# sourceMappingURL=create-user-account.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-user-account.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/create-user-account.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAU/D,MAAM,MAAM,8BAA8B,GAAG;IAC3C,cAAc,EAAE,MAAM,CAAA;IACtB,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,2BAA2B,wBAAwB,CAAA;AAChE;;GAEG;AACH,eAAO,MAAM,yBAAyB,sGAoBrC,CAAA"}
1
+ {"version":3,"file":"create-user-account.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/create-user-account.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAU/D;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,2BAA2B,wBAAwB,CAAA;AAChE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,yBAAyB,sGAoBrC,CAAA"}
@@ -6,7 +6,30 @@ const auth_1 = require("../../auth");
6
6
  const create_users_1 = require("./create-users");
7
7
  exports.createUserAccountWorkflowId = "create-user-account";
8
8
  /**
9
- * This workflow creates an authentication identity for a user.
9
+ * This workflow creates a user and attaches it to an auth identity.
10
+ *
11
+ * You can create an auth identity first using the [Retrieve Registration JWT Token API Route](https://docs.etohq.com/api/admin#auth_postactor_typeauth_provider_register).
12
+ * Learn more about basic authentication flows in [this documentation](https://docs.etohq.com/resources/commerce-modules/auth/authentication-route).
13
+ *
14
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
15
+ * register or create user accounts within your custom flows.
16
+ *
17
+ * @example
18
+ * const { result } = await createUserAccountWorkflow(container)
19
+ * .run({
20
+ * input: {
21
+ * authIdentityId: "au_123",
22
+ * userData: {
23
+ * email: "example@gmail.com",
24
+ * first_name: "John",
25
+ * last_name: "Doe",
26
+ * }
27
+ * }
28
+ * })
29
+ *
30
+ * @summary
31
+ *
32
+ * Create a user account and attach an auth identity.
10
33
  */
11
34
  exports.createUserAccountWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createUserAccountWorkflowId, (input) => {
12
35
  const users = create_users_1.createUsersWorkflow.runAsStep({
@@ -1 +1 @@
1
- {"version":3,"file":"create-user-account.js","sourceRoot":"","sources":["../../../src/user/workflows/create-user-account.ts"],"names":[],"mappings":";;;AACA,kEAKuC;AACvC,qCAAmD;AACnD,iDAAoD;AAOvC,QAAA,2BAA2B,GAAG,qBAAqB,CAAA;AAChE;;GAEG;AACU,QAAA,yBAAyB,GAAG,IAAA,8BAAc,EACrD,mCAA2B,EAC3B,CACE,KAAmD,EACxB,EAAE;IAC7B,MAAM,KAAK,GAAG,kCAAmB,CAAC,SAAS,CAAC;QAC1C,KAAK,EAAE;YACL,KAAK,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC;SACxB;KACF,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,CAAC,KAAgB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAE7D,IAAA,6BAAsB,EAAC;QACrB,cAAc,EAAE,KAAK,CAAC,cAAc;QACpC,SAAS,EAAE,MAAM;QACjB,KAAK,EAAE,IAAI,CAAC,EAAE;KACf,CAAC,CAAA;IACF,OAAO,IAAI,gCAAgB,CAAC,IAAI,CAAC,CAAA;AACnC,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"create-user-account.js","sourceRoot":"","sources":["../../../src/user/workflows/create-user-account.ts"],"names":[],"mappings":";;;AACA,kEAKuC;AACvC,qCAAmD;AACnD,iDAAoD;AAgBvC,QAAA,2BAA2B,GAAG,qBAAqB,CAAA;AAChE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,yBAAyB,GAAG,IAAA,8BAAc,EACrD,mCAA2B,EAC3B,CACE,KAAmD,EACxB,EAAE;IAC7B,MAAM,KAAK,GAAG,kCAAmB,CAAC,SAAS,CAAC;QAC1C,KAAK,EAAE;YACL,KAAK,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC;SACxB;KACF,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,CAAC,KAAgB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAE7D,IAAA,6BAAsB,EAAC;QACrB,cAAc,EAAE,KAAK,CAAC,cAAc;QACpC,SAAS,EAAE,MAAM;QACjB,KAAK,EAAE,IAAI,CAAC,EAAE;KACf,CAAC,CAAA;IACF,OAAO,IAAI,gCAAgB,CAAC,IAAI,CAAC,CAAA;AACnC,CAAC,CACF,CAAA"}
@@ -1,7 +1,31 @@
1
1
  import { UserDTO, UserWorkflow } from "@etohq/framework/types";
2
2
  export declare const createUsersWorkflowId = "create-users-workflow";
3
3
  /**
4
- * This workflow creates one or more users.
4
+ * This workflow creates one or more users. It's used by other workflows, such
5
+ * as {@link acceptInviteWorkflow} to create a user for an invite.
6
+ *
7
+ * You can attach an auth identity to each user to allow the user to log in using the
8
+ * {@link setAuthAppMetadataStep}. Learn more about auth identities in
9
+ * [this documentation](https://docs.etohq.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
10
+ *
11
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
12
+ * create users within your custom flows.
13
+ *
14
+ * @example
15
+ * const { result } = await createUsersWorkflow(container)
16
+ * .run({
17
+ * input: {
18
+ * users: [{
19
+ * email: "example@gmail.com",
20
+ * first_name: "John",
21
+ * last_name: "Doe",
22
+ * }]
23
+ * }
24
+ * })
25
+ *
26
+ * @summary
27
+ *
28
+ * Create one or more users.
5
29
  */
6
30
  export declare const createUsersWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<UserWorkflow.CreateUsersWorkflowInputDTO, UserDTO[], []>;
7
31
  //# sourceMappingURL=create-users.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"create-users.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/create-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAW9D,eAAO,MAAM,qBAAqB,0BAA0B,CAAA;AAC5D;;GAEG;AACH,eAAO,MAAM,mBAAmB,kHAoB/B,CAAA"}
1
+ {"version":3,"file":"create-users.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/create-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAW9D,eAAO,MAAM,qBAAqB,0BAA0B,CAAA;AAC5D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,mBAAmB,kHAoB/B,CAAA"}
@@ -7,7 +7,31 @@ const emit_event_1 = require("../../common/steps/emit-event");
7
7
  const steps_1 = require("../steps");
8
8
  exports.createUsersWorkflowId = "create-users-workflow";
9
9
  /**
10
- * This workflow creates one or more users.
10
+ * This workflow creates one or more users. It's used by other workflows, such
11
+ * as {@link acceptInviteWorkflow} to create a user for an invite.
12
+ *
13
+ * You can attach an auth identity to each user to allow the user to log in using the
14
+ * {@link setAuthAppMetadataStep}. Learn more about auth identities in
15
+ * [this documentation](https://docs.etohq.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
16
+ *
17
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
18
+ * create users within your custom flows.
19
+ *
20
+ * @example
21
+ * const { result } = await createUsersWorkflow(container)
22
+ * .run({
23
+ * input: {
24
+ * users: [{
25
+ * email: "example@gmail.com",
26
+ * first_name: "John",
27
+ * last_name: "Doe",
28
+ * }]
29
+ * }
30
+ * })
31
+ *
32
+ * @summary
33
+ *
34
+ * Create one or more users.
11
35
  */
12
36
  exports.createUsersWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createUsersWorkflowId, (input) => {
13
37
  const createdUsers = (0, steps_1.createUsersStep)(input.users);
@@ -1 +1 @@
1
- {"version":3,"file":"create-users.js","sourceRoot":"","sources":["../../../src/user/workflows/create-users.ts"],"names":[],"mappings":";;;AACA,kDAA2D;AAC3D,kEAKuC;AACvC,8DAA6D;AAC7D,oCAA0C;AAE7B,QAAA,qBAAqB,GAAG,uBAAuB,CAAA;AAC5D;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CACE,KAA6D,EAChC,EAAE;IAC/B,MAAM,YAAY,GAAG,IAAA,uBAAe,EAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAEjD,MAAM,YAAY,GAAG,IAAA,yBAAS,EAAC,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;QACpE,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC5B,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAA;QACrB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,0BAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,OAAO;QACrC,IAAI,EAAE,YAAY;KACnB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,YAAY,CAAC,CAAA;AAC3C,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"create-users.js","sourceRoot":"","sources":["../../../src/user/workflows/create-users.ts"],"names":[],"mappings":";;;AACA,kDAA2D;AAC3D,kEAKuC;AACvC,8DAA6D;AAC7D,oCAA0C;AAE7B,QAAA,qBAAqB,GAAG,uBAAuB,CAAA;AAC5D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CACE,KAA6D,EAChC,EAAE;IAC/B,MAAM,YAAY,GAAG,IAAA,uBAAe,EAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAEjD,MAAM,YAAY,GAAG,IAAA,yBAAS,EAAC,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;QACpE,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC5B,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAA;QACrB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,0BAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,OAAO;QACrC,IAAI,EAAE,YAAY;KACnB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,YAAY,CAAC,CAAA;AAC3C,CAAC,CACF,CAAA"}
@@ -1,7 +1,26 @@
1
1
  import { UserWorkflow } from "@etohq/framework/types";
2
2
  export declare const deleteUsersWorkflowId = "delete-user";
3
3
  /**
4
- * This workflow deletes one or more users.
4
+ * This workflow deletes one or more users. It's used by other workflows
5
+ * like {@link removeUserAccountWorkflow}. If you use this workflow directly,
6
+ * you must also remove the association to the auth identity using the
7
+ * {@link setAuthAppMetadataStep}. Learn more about auth identities in
8
+ * [this documentation](https://docs.etohq.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
9
+ *
10
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
11
+ * delete users within your custom flows.
12
+ *
13
+ * @example
14
+ * const { result } = await deleteUsersWorkflow(container)
15
+ * .run({
16
+ * input: {
17
+ * ids: ["user_123"]
18
+ * }
19
+ * })
20
+ *
21
+ * @summary
22
+ *
23
+ * Delete one or more users.
5
24
  */
6
25
  export declare const deleteUsersWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<UserWorkflow.DeleteUserWorkflowInput, unknown, any[]>;
7
26
  //# sourceMappingURL=delete-users.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"delete-users.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/delete-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAUrD,eAAO,MAAM,qBAAqB,gBAAgB,CAAA;AAClD;;GAEG;AACH,eAAO,MAAM,mBAAmB,+GAkB/B,CAAA"}
1
+ {"version":3,"file":"delete-users.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/delete-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAWrD,eAAO,MAAM,qBAAqB,gBAAgB,CAAA;AAClD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,mBAAmB,+GAyB/B,CAAA"}
@@ -7,7 +7,26 @@ const common_1 = require("../../common");
7
7
  const steps_1 = require("../steps");
8
8
  exports.deleteUsersWorkflowId = "delete-user";
9
9
  /**
10
- * This workflow deletes one or more users.
10
+ * This workflow deletes one or more users. It's used by other workflows
11
+ * like {@link removeUserAccountWorkflow}. If you use this workflow directly,
12
+ * you must also remove the association to the auth identity using the
13
+ * {@link setAuthAppMetadataStep}. Learn more about auth identities in
14
+ * [this documentation](https://docs.etohq.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
15
+ *
16
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
17
+ * delete users within your custom flows.
18
+ *
19
+ * @example
20
+ * const { result } = await deleteUsersWorkflow(container)
21
+ * .run({
22
+ * input: {
23
+ * ids: ["user_123"]
24
+ * }
25
+ * })
26
+ *
27
+ * @summary
28
+ *
29
+ * Delete one or more users.
11
30
  */
12
31
  exports.deleteUsersWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.deleteUsersWorkflowId, (input) => {
13
32
  (0, steps_1.deleteUsersStep)(input.ids);
@@ -16,9 +35,13 @@ exports.deleteUsersWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.delete
16
35
  return { id };
17
36
  });
18
37
  });
19
- (0, common_1.emitEventStep)({
38
+ (0, workflows_sdk_1.parallelize)((0, common_1.removeRemoteLinkStep)({
39
+ [utils_1.Modules.USER]: {
40
+ user_id: input.ids,
41
+ },
42
+ }), (0, common_1.emitEventStep)({
20
43
  eventName: utils_1.UserWorkflowEvents.DELETED,
21
44
  data: userIdEvents,
22
- });
45
+ }));
23
46
  });
24
47
  //# sourceMappingURL=delete-users.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"delete-users.js","sourceRoot":"","sources":["../../../src/user/workflows/delete-users.ts"],"names":[],"mappings":";;;AACA,kDAA2D;AAC3D,kEAIuC;AACvC,yCAA4C;AAC5C,oCAA0C;AAE7B,QAAA,qBAAqB,GAAG,aAAa,CAAA;AAClD;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CACE,KAAyD,EACrC,EAAE;IACtB,IAAA,uBAAe,EAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE1B,MAAM,YAAY,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACtD,OAAO,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YAC3B,OAAO,EAAE,EAAE,EAAE,CAAA;QACf,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,OAAO;QACrC,IAAI,EAAE,YAAY;KACnB,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"delete-users.js","sourceRoot":"","sources":["../../../src/user/workflows/delete-users.ts"],"names":[],"mappings":";;;AACA,kDAAoE;AACpE,kEAKuC;AACvC,yCAAkE;AAClE,oCAA0C;AAE7B,QAAA,qBAAqB,GAAG,aAAa,CAAA;AAClD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CACE,KAAyD,EACrC,EAAE;IACtB,IAAA,uBAAe,EAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE1B,MAAM,YAAY,GAAG,IAAA,yBAAS,EAAC,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QACtD,OAAO,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;YAC3B,OAAO,EAAE,EAAE,EAAE,CAAA;QACf,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,2BAAW,EACT,IAAA,6BAAoB,EAAC;QACnB,CAAC,eAAO,CAAC,IAAI,CAAC,EAAE;YACd,OAAO,EAAE,KAAK,CAAC,GAAG;SACnB;KACF,CAAC,EACF,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,OAAO;QACrC,IAAI,EAAE,YAAY;KACnB,CAAC,CACH,CAAA;AACH,CAAC,CACF,CAAA"}
@@ -1,9 +1,31 @@
1
+ /**
2
+ * The data to remove a user account.
3
+ */
1
4
  export type RemoveUserAccountWorkflowInput = {
5
+ /**
6
+ * The ID of the user to remove.
7
+ */
2
8
  userId: string;
3
9
  };
4
10
  export declare const removeUserAccountWorkflowId = "remove-user-account";
5
11
  /**
6
- * This workflow deletes a user and remove the association in the auth identity.
12
+ * This workflow deletes a user and remove the association to its auth identity. It's used
13
+ * by the [Delete User Admin API Route](https://docs.etohq.com/api/admin#users_deleteusersid).
14
+ *
15
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
16
+ * delete users within your custom flows.
17
+ *
18
+ * @example
19
+ * const { result } = await removeUserAccountWorkflow(container)
20
+ * .run({
21
+ * input: {
22
+ * userId: "user_123"
23
+ * }
24
+ * })
25
+ *
26
+ * @summary
27
+ *
28
+ * Delete a user and remove the association to its auth identity.
7
29
  */
8
30
  export declare const removeUserAccountWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<RemoveUserAccountWorkflowInput, string, []>;
9
31
  //# sourceMappingURL=remove-user-account.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"remove-user-account.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/remove-user-account.ts"],"names":[],"mappings":"AAWA,MAAM,MAAM,8BAA8B,GAAG;IAC3C,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AACD,eAAO,MAAM,2BAA2B,wBAAwB,CAAA;AAChE;;GAEG;AACH,eAAO,MAAM,yBAAyB,qGA0CrC,CAAA"}
1
+ {"version":3,"file":"remove-user-account.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/remove-user-account.ts"],"names":[],"mappings":"AAWA;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AACD,eAAO,MAAM,2BAA2B,wBAAwB,CAAA;AAChE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,yBAAyB,qGA0CrC,CAAA"}
@@ -7,7 +7,23 @@ const common_1 = require("../../common");
7
7
  const delete_users_1 = require("./delete-users");
8
8
  exports.removeUserAccountWorkflowId = "remove-user-account";
9
9
  /**
10
- * This workflow deletes a user and remove the association in the auth identity.
10
+ * This workflow deletes a user and remove the association to its auth identity. It's used
11
+ * by the [Delete User Admin API Route](https://docs.etohq.com/api/admin#users_deleteusersid).
12
+ *
13
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
14
+ * delete users within your custom flows.
15
+ *
16
+ * @example
17
+ * const { result } = await removeUserAccountWorkflow(container)
18
+ * .run({
19
+ * input: {
20
+ * userId: "user_123"
21
+ * }
22
+ * })
23
+ *
24
+ * @summary
25
+ *
26
+ * Delete a user and remove the association to its auth identity.
11
27
  */
12
28
  exports.removeUserAccountWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.removeUserAccountWorkflowId, (input) => {
13
29
  delete_users_1.deleteUsersWorkflow.runAsStep({
@@ -1 +1 @@
1
- {"version":3,"file":"remove-user-account.js","sourceRoot":"","sources":["../../../src/user/workflows/remove-user-account.ts"],"names":[],"mappings":";;;AAAA,kEAMuC;AACvC,qCAAmD;AACnD,yCAAiD;AACjD,iDAAoD;AAKvC,QAAA,2BAA2B,GAAG,qBAAqB,CAAA;AAChE;;GAEG;AACU,QAAA,yBAAyB,GAAG,IAAA,8BAAc,EACrD,mCAA2B,EAC3B,CACE,KAAmD,EACzB,EAAE;IAC5B,kCAAmB,CAAC,SAAS,CAAC;QAC5B,KAAK,EAAE;YACL,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC;SACpB;KACF,CAAC,CAAA;IAEF,MAAM,cAAc,GAAG,IAAA,2BAAkB,EAAC;QACxC,WAAW,EAAE,eAAe;QAC5B,MAAM,EAAE,CAAC,IAAI,CAAC;QACd,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,OAAO,EAAE,KAAK,CAAC,MAAM;iBACtB;aACF;SACF;KACF,CAAC,CAAA;IAEF,MAAM,YAAY,GAAG,IAAA,yBAAS,EAC5B,EAAE,cAAc,EAAE,KAAK,EAAE,EACzB,CAAC,EAAE,cAAc,EAAE,EAAE,EAAE;QACrB,OAAO,cAAc,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC,CACF,CAAA;IAED,IAAA,oBAAI,EAAC,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;QAC1C,OAAO,CAAC,CAAC,YAAY,CAAA;IACvB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,IAAA,6BAAsB,EAAC;YACrB,cAAc,EAAE,YAAY,CAAC,EAAE;YAC/B,SAAS,EAAE,MAAM;YACjB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;AAC3C,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"remove-user-account.js","sourceRoot":"","sources":["../../../src/user/workflows/remove-user-account.ts"],"names":[],"mappings":";;;AAAA,kEAMuC;AACvC,qCAAmD;AACnD,yCAAiD;AACjD,iDAAoD;AAWvC,QAAA,2BAA2B,GAAG,qBAAqB,CAAA;AAChE;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,yBAAyB,GAAG,IAAA,8BAAc,EACrD,mCAA2B,EAC3B,CACE,KAAmD,EACzB,EAAE;IAC5B,kCAAmB,CAAC,SAAS,CAAC;QAC5B,KAAK,EAAE;YACL,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC;SACpB;KACF,CAAC,CAAA;IAEF,MAAM,cAAc,GAAG,IAAA,2BAAkB,EAAC;QACxC,WAAW,EAAE,eAAe;QAC5B,MAAM,EAAE,CAAC,IAAI,CAAC;QACd,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,OAAO,EAAE,KAAK,CAAC,MAAM;iBACtB;aACF;SACF;KACF,CAAC,CAAA;IAEF,MAAM,YAAY,GAAG,IAAA,yBAAS,EAC5B,EAAE,cAAc,EAAE,KAAK,EAAE,EACzB,CAAC,EAAE,cAAc,EAAE,EAAE,EAAE;QACrB,OAAO,cAAc,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC,CACF,CAAA;IAED,IAAA,oBAAI,EAAC,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;QAC1C,OAAO,CAAC,CAAC,YAAY,CAAA;IACvB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACX,IAAA,6BAAsB,EAAC;YACrB,cAAc,EAAE,YAAY,CAAC,EAAE;YAC/B,SAAS,EAAE,MAAM;YACjB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;AAC3C,CAAC,CACF,CAAA"}
@@ -1,7 +1,28 @@
1
1
  import { UserDTO, UserWorkflow } from "@etohq/framework/types";
2
2
  export declare const updateUsersWorkflowId = "update-users-workflow";
3
3
  /**
4
- * This workflow updates one or more users.
4
+ * This workflow updates one or more users. It's used by the
5
+ * [Update User Admin API Route](https://docs.etohq.com/api/admin#users_postusersid).
6
+ *
7
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
8
+ * update users within your custom flows.
9
+ *
10
+ * @example
11
+ * const { result } = await updateUsersWorkflow(container)
12
+ * .run({
13
+ * input: {
14
+ * updates: [
15
+ * {
16
+ * id: "user_123",
17
+ * first_name: "John"
18
+ * }
19
+ * ]
20
+ * }
21
+ * })
22
+ *
23
+ * @summary
24
+ *
25
+ * Update one or more users.
5
26
  */
6
27
  export declare const updateUsersWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<UserWorkflow.UpdateUsersWorkflowInputDTO, UserDTO[], []>;
7
28
  //# sourceMappingURL=update-users.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"update-users.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/update-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAW9D,eAAO,MAAM,qBAAqB,0BAA0B,CAAA;AAC5D;;GAEG;AACH,eAAO,MAAM,mBAAmB,kHAsB/B,CAAA"}
1
+ {"version":3,"file":"update-users.d.ts","sourceRoot":"","sources":["../../../src/user/workflows/update-users.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAW9D,eAAO,MAAM,qBAAqB,0BAA0B,CAAA;AAC5D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,mBAAmB,kHAsB/B,CAAA"}
@@ -7,7 +7,28 @@ const emit_event_1 = require("../../common/steps/emit-event");
7
7
  const steps_1 = require("../steps");
8
8
  exports.updateUsersWorkflowId = "update-users-workflow";
9
9
  /**
10
- * This workflow updates one or more users.
10
+ * This workflow updates one or more users. It's used by the
11
+ * [Update User Admin API Route](https://docs.etohq.com/api/admin#users_postusersid).
12
+ *
13
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
14
+ * update users within your custom flows.
15
+ *
16
+ * @example
17
+ * const { result } = await updateUsersWorkflow(container)
18
+ * .run({
19
+ * input: {
20
+ * updates: [
21
+ * {
22
+ * id: "user_123",
23
+ * first_name: "John"
24
+ * }
25
+ * ]
26
+ * }
27
+ * })
28
+ *
29
+ * @summary
30
+ *
31
+ * Update one or more users.
11
32
  */
12
33
  exports.updateUsersWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.updateUsersWorkflowId, (input) => {
13
34
  const updatedUsers = (0, steps_1.updateUsersStep)(input.updates);
@@ -1 +1 @@
1
- {"version":3,"file":"update-users.js","sourceRoot":"","sources":["../../../src/user/workflows/update-users.ts"],"names":[],"mappings":";;;AACA,kDAA2D;AAC3D,kEAKuC;AACvC,8DAA6D;AAC7D,oCAA0C;AAE7B,QAAA,qBAAqB,GAAG,uBAAuB,CAAA;AAC5D;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CACE,KAA6D,EAChC,EAAE;IAC/B,MAAM,YAAY,GAAG,IAAA,uBAAe,EAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAEnD,MAAM,YAAY,GAAG,IAAA,yBAAS,EAAC,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;QACpE,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;QAEvE,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAA;QACxB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,0BAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,OAAO;QACrC,IAAI,EAAE,YAAY;KACnB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,YAAY,CAAC,CAAA;AAC3C,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"update-users.js","sourceRoot":"","sources":["../../../src/user/workflows/update-users.ts"],"names":[],"mappings":";;;AACA,kDAA2D;AAC3D,kEAKuC;AACvC,8DAA6D;AAC7D,oCAA0C;AAE7B,QAAA,qBAAqB,GAAG,uBAAuB,CAAA;AAC5D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CACE,KAA6D,EAChC,EAAE;IAC/B,MAAM,YAAY,GAAG,IAAA,uBAAe,EAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IAEnD,MAAM,YAAY,GAAG,IAAA,yBAAS,EAAC,EAAE,YAAY,EAAE,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE;QACpE,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;QAEvE,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAA;QACxB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,0BAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,OAAO;QACrC,IAAI,EAAE,YAAY;KACnB,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,YAAY,CAAC,CAAA;AAC3C,CAAC,CACF,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@etohq/core-flows",
3
- "version": "1.3.0",
3
+ "version": "1.5.0",
4
4
  "description": "Set of workflow definitions for commerce",
5
5
  "main": "dist/index.js",
6
6
  "exports": {
@@ -26,35 +26,37 @@
26
26
  "author": "Eto",
27
27
  "license": "MIT",
28
28
  "devDependencies": {
29
- "@etohq/framework": "^1.3.0",
30
- "@etohq/types": "^1.3.0",
31
- "@mikro-orm/core": "5.9.7",
32
- "@mikro-orm/knex": "5.9.7",
33
- "@mikro-orm/migrations": "5.9.7",
34
- "@mikro-orm/postgresql": "5.9.7",
35
- "@swc/core": "^1.7.28",
36
- "@swc/jest": "^0.2.36",
37
- "@types/jest": "^29.5.14",
38
- "awilix": "^8.0.1",
39
- "expect-type": "^0.20.0",
40
- "jest": "^29.7.0",
41
- "pg": "^8.13.0",
42
- "rimraf": "^5.0.2",
43
- "typescript": "^5.8.3"
29
+ "@mikro-orm/core": "6.4.3",
30
+ "@mikro-orm/knex": "6.4.3",
31
+ "@mikro-orm/migrations": "6.4.3",
32
+ "@mikro-orm/postgresql": "6.4.3",
33
+ "@swc/core": "1.7.28",
34
+ "@swc/jest": "0.2.36",
35
+ "@types/jest": "29.5.14",
36
+ "awilix": "8.0.1",
37
+ "expect-type": "0.20.0",
38
+ "jest": "29.7.0",
39
+ "pg": "8.13.0",
40
+ "rimraf": "5.0.2",
41
+ "tsc-alias": "1.8.6",
42
+ "typescript": "5.8.3",
43
+ "@etohq/framework": "1.5.0",
44
+ "@etohq/types": "1.5.0"
44
45
  },
45
46
  "dependencies": {
46
- "@etohq/utils": "^1.3.0",
47
- "@etohq/workflows-sdk": "^1.3.0",
48
- "json-2-csv": "^5.5.4",
49
- "uuid": "^9.0.0"
47
+ "json-2-csv": "5.5.4",
48
+ "uuid": "9.0.0",
49
+ "@etohq/utils": "1.5.0",
50
+ "@etohq/workflows-sdk": "1.5.0"
50
51
  },
51
52
  "peerDependencies": {
52
- "@etohq/framework": "^1.1.0",
53
- "awilix": "^8.0.1"
53
+ "awilix": "8.0.1",
54
+ "@etohq/framework": "1.5.0"
54
55
  },
55
56
  "scripts": {
56
- "build": "rimraf dist && tsc --build",
57
+ "resolve:aliases": "tsc --showConfig -p tsconfig.json > tsconfig.resolved.json && tsc-alias -p tsconfig.resolved.json && rimraf tsconfig.resolved.json",
58
+ "build": "rimraf dist && tsc --build && npm run resolve:aliases",
57
59
  "watch": "tsc --build --watch",
58
60
  "test": "jest --runInBand --bail --forceExit --passWithNoTests"
59
61
  }
60
- }
62
+ }