@salesforce/b2c-tooling-sdk 0.2.1 → 0.4.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 (578) hide show
  1. package/README.md +180 -13
  2. package/data/scaffolds/cartridge/files/.project.ejs +17 -0
  3. package/data/scaffolds/cartridge/files/cartridge/cartridge.properties.ejs +4 -0
  4. package/data/scaffolds/cartridge/files/cartridge/controllers/Example.js.ejs +19 -0
  5. package/data/scaffolds/cartridge/files/cartridge/models/example.js.ejs +14 -0
  6. package/data/scaffolds/cartridge/files/cartridge/scripts/helpers/exampleHelpers.js.ejs +18 -0
  7. package/data/scaffolds/cartridge/files/cartridge/static/default/css/example.css +6 -0
  8. package/data/scaffolds/cartridge/files/cartridge/templates/default/example/show.isml.ejs +11 -0
  9. package/data/scaffolds/cartridge/scaffold.json +88 -0
  10. package/data/scaffolds/controller/files/controller.js.ejs +134 -0
  11. package/data/scaffolds/controller/files/template.isml.ejs +22 -0
  12. package/data/scaffolds/controller/scaffold.json +64 -0
  13. package/data/scaffolds/custom-api/files/api.json.ejs +11 -0
  14. package/data/scaffolds/custom-api/files/schema.yaml.ejs +188 -0
  15. package/data/scaffolds/custom-api/files/script.js.ejs +95 -0
  16. package/data/scaffolds/custom-api/scaffold.json +65 -0
  17. package/data/scaffolds/hook/files/hook.js.ejs +99 -0
  18. package/data/scaffolds/hook/files/hooks-entry.json.ejs +6 -0
  19. package/data/scaffolds/hook/scaffold.json +60 -0
  20. package/data/scaffolds/job-step/files/step-chunk.js.ejs +136 -0
  21. package/data/scaffolds/job-step/files/step-task.js.ejs +47 -0
  22. package/data/scaffolds/job-step/files/steptypes-entry.json.ejs +41 -0
  23. package/data/scaffolds/job-step/scaffold.json +64 -0
  24. package/data/scaffolds/page-designer-component/files/component.isml.ejs +23 -0
  25. package/data/scaffolds/page-designer-component/files/component.js.ejs +35 -0
  26. package/data/scaffolds/page-designer-component/files/component.json.ejs +50 -0
  27. package/data/scaffolds/page-designer-component/scaffold.json +66 -0
  28. package/data/scaffolds/service/files/service-http.js.ejs +245 -0
  29. package/data/scaffolds/service/files/service-sftp.js.ejs +371 -0
  30. package/data/scaffolds/service/files/service-soap.js.ejs +230 -0
  31. package/data/scaffolds/service/scaffold.json +83 -0
  32. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +48 -0
  33. package/data/script-api/dw.system.Request.md +5 -0
  34. package/data/script-api/dw.web.Cookie.md +108 -31
  35. package/data/script-api/index.json +2 -2
  36. package/data/script-api/index.md +1 -1
  37. package/dist/cjs/auth/api-key.d.ts +2 -2
  38. package/dist/cjs/auth/api-key.js +1 -0
  39. package/dist/cjs/auth/api-key.js.map +1 -1
  40. package/dist/cjs/auth/basic.d.ts +2 -2
  41. package/dist/cjs/auth/basic.js +2 -0
  42. package/dist/cjs/auth/basic.js.map +1 -1
  43. package/dist/cjs/auth/index.d.ts +1 -1
  44. package/dist/cjs/auth/index.js.map +1 -1
  45. package/dist/cjs/auth/oauth-implicit.d.ts +3 -2
  46. package/dist/cjs/auth/oauth-implicit.js +9 -3
  47. package/dist/cjs/auth/oauth-implicit.js.map +1 -1
  48. package/dist/cjs/auth/oauth.d.ts +3 -2
  49. package/dist/cjs/auth/oauth.js +10 -3
  50. package/dist/cjs/auth/oauth.js.map +1 -1
  51. package/dist/cjs/auth/types.d.ts +15 -1
  52. package/dist/cjs/auth/types.js +5 -0
  53. package/dist/cjs/auth/types.js.map +1 -1
  54. package/dist/cjs/cli/am-command.d.ts +74 -0
  55. package/dist/cjs/cli/am-command.js +189 -0
  56. package/dist/cjs/cli/am-command.js.map +1 -0
  57. package/dist/cjs/cli/base-command.d.ts +61 -0
  58. package/dist/cjs/cli/base-command.js +171 -4
  59. package/dist/cjs/cli/base-command.js.map +1 -1
  60. package/dist/cjs/cli/config.d.ts +80 -0
  61. package/dist/cjs/cli/config.js +122 -2
  62. package/dist/cjs/cli/config.js.map +1 -1
  63. package/dist/cjs/cli/index.d.ts +3 -2
  64. package/dist/cjs/cli/index.js +4 -1
  65. package/dist/cjs/cli/index.js.map +1 -1
  66. package/dist/cjs/cli/instance-command.d.ts +5 -0
  67. package/dist/cjs/cli/instance-command.js +24 -23
  68. package/dist/cjs/cli/instance-command.js.map +1 -1
  69. package/dist/cjs/cli/mrt-command.d.ts +0 -6
  70. package/dist/cjs/cli/mrt-command.js +5 -29
  71. package/dist/cjs/cli/mrt-command.js.map +1 -1
  72. package/dist/cjs/cli/oauth-command.d.ts +25 -6
  73. package/dist/cjs/cli/oauth-command.js +65 -42
  74. package/dist/cjs/cli/oauth-command.js.map +1 -1
  75. package/dist/cjs/cli/ods-command.d.ts +23 -1
  76. package/dist/cjs/cli/ods-command.js +61 -4
  77. package/dist/cjs/cli/ods-command.js.map +1 -1
  78. package/dist/cjs/cli/webdav-command.d.ts +5 -0
  79. package/dist/cjs/clients/am-api.d.ts +491 -0
  80. package/dist/cjs/clients/am-api.js +944 -0
  81. package/dist/cjs/clients/am-api.js.map +1 -0
  82. package/dist/cjs/clients/am-apiclients-api.generated.d.ts +803 -0
  83. package/dist/cjs/clients/am-apiclients-api.generated.js +6 -0
  84. package/dist/cjs/clients/am-apiclients-api.generated.js.map +1 -0
  85. package/dist/cjs/clients/am-roles-api.generated.d.ts +298 -0
  86. package/dist/cjs/clients/am-roles-api.generated.js +6 -0
  87. package/dist/cjs/clients/am-roles-api.generated.js.map +1 -0
  88. package/dist/cjs/clients/am-users-api.generated.d.ts +891 -0
  89. package/dist/cjs/clients/am-users-api.generated.js +6 -0
  90. package/dist/cjs/clients/am-users-api.generated.js.map +1 -0
  91. package/dist/cjs/clients/cdn-zones.d.ts +33 -1
  92. package/dist/cjs/clients/cdn-zones.js.map +1 -1
  93. package/dist/cjs/clients/custom-apis.d.ts +30 -1
  94. package/dist/cjs/clients/custom-apis.js.map +1 -1
  95. package/dist/cjs/clients/index.d.ts +6 -2
  96. package/dist/cjs/clients/index.js +3 -1
  97. package/dist/cjs/clients/index.js.map +1 -1
  98. package/dist/cjs/clients/middleware-registry.d.ts +1 -1
  99. package/dist/cjs/clients/middleware-registry.js.map +1 -1
  100. package/dist/cjs/clients/middleware.d.ts +49 -2
  101. package/dist/cjs/clients/middleware.js +214 -2
  102. package/dist/cjs/clients/middleware.js.map +1 -1
  103. package/dist/cjs/clients/mrt-b2c.d.ts +25 -1
  104. package/dist/cjs/clients/mrt-b2c.js.map +1 -1
  105. package/dist/cjs/clients/mrt.d.ts +24 -1
  106. package/dist/cjs/clients/mrt.js +5 -1
  107. package/dist/cjs/clients/mrt.js.map +1 -1
  108. package/dist/cjs/clients/ocapi.d.ts +22 -2
  109. package/dist/cjs/clients/ocapi.js +0 -2
  110. package/dist/cjs/clients/ocapi.js.map +1 -1
  111. package/dist/cjs/clients/ods.d.ts +28 -1
  112. package/dist/cjs/clients/ods.js.map +1 -1
  113. package/dist/cjs/clients/scapi-schemas.d.ts +30 -1
  114. package/dist/cjs/clients/scapi-schemas.js.map +1 -1
  115. package/dist/cjs/clients/slas-admin.d.ts +28 -0
  116. package/dist/cjs/clients/slas-admin.js.map +1 -1
  117. package/dist/cjs/clients/tls-dispatcher.d.ts +42 -0
  118. package/dist/cjs/clients/tls-dispatcher.js +107 -0
  119. package/dist/cjs/clients/tls-dispatcher.js.map +1 -0
  120. package/dist/cjs/clients/webdav.d.ts +8 -1
  121. package/dist/cjs/clients/webdav.js +5 -1
  122. package/dist/cjs/clients/webdav.js.map +1 -1
  123. package/dist/cjs/config/dw-json.d.ts +106 -21
  124. package/dist/cjs/config/dw-json.js +170 -4
  125. package/dist/cjs/config/dw-json.js.map +1 -1
  126. package/dist/cjs/config/index.d.ts +7 -5
  127. package/dist/cjs/config/index.js +7 -3
  128. package/dist/cjs/config/index.js.map +1 -1
  129. package/dist/cjs/config/instance-manager.d.ts +97 -0
  130. package/dist/cjs/config/instance-manager.js +166 -0
  131. package/dist/cjs/config/instance-manager.js.map +1 -0
  132. package/dist/cjs/config/mapping.d.ts +63 -5
  133. package/dist/cjs/config/mapping.js +179 -18
  134. package/dist/cjs/config/mapping.js.map +1 -1
  135. package/dist/cjs/config/resolved-config.d.ts +1 -3
  136. package/dist/cjs/config/resolved-config.js +0 -8
  137. package/dist/cjs/config/resolved-config.js.map +1 -1
  138. package/dist/cjs/config/resolver.d.ts +1 -1
  139. package/dist/cjs/config/resolver.js +19 -3
  140. package/dist/cjs/config/resolver.js.map +1 -1
  141. package/dist/cjs/config/sources/dw-json-source.d.ts +17 -1
  142. package/dist/cjs/config/sources/dw-json-source.js +70 -3
  143. package/dist/cjs/config/sources/dw-json-source.js.map +1 -1
  144. package/dist/cjs/config/sources/mobify-source.js +3 -2
  145. package/dist/cjs/config/sources/mobify-source.js.map +1 -1
  146. package/dist/cjs/config/sources/package-json-source.js +9 -4
  147. package/dist/cjs/config/sources/package-json-source.js.map +1 -1
  148. package/dist/cjs/config/types.d.ts +78 -18
  149. package/dist/cjs/defaults.d.ts +6 -0
  150. package/dist/cjs/defaults.js +6 -0
  151. package/dist/cjs/defaults.js.map +1 -1
  152. package/dist/{esm/operations → cjs}/docs/download.d.ts +1 -1
  153. package/dist/cjs/{operations/docs → docs}/download.js +2 -2
  154. package/dist/cjs/docs/download.js.map +1 -0
  155. package/dist/{esm/operations → cjs}/docs/index.d.ts +4 -4
  156. package/dist/cjs/docs/index.js.map +1 -0
  157. package/dist/cjs/docs/schema.js.map +1 -0
  158. package/dist/cjs/docs/search.js.map +1 -0
  159. package/dist/cjs/docs/types.js.map +1 -0
  160. package/dist/cjs/i18n/index.js +3 -0
  161. package/dist/cjs/i18n/index.js.map +1 -1
  162. package/dist/cjs/index.d.ts +11 -12
  163. package/dist/cjs/index.js +12 -10
  164. package/dist/cjs/index.js.map +1 -1
  165. package/dist/cjs/instance/index.d.ts +4 -0
  166. package/dist/cjs/instance/index.js +6 -1
  167. package/dist/cjs/instance/index.js.map +1 -1
  168. package/dist/cjs/logging/index.d.ts +1 -1
  169. package/dist/cjs/logging/logger.js +27 -0
  170. package/dist/cjs/logging/logger.js.map +1 -1
  171. package/dist/cjs/logging/types.d.ts +9 -0
  172. package/dist/cjs/operations/content/asset-query.d.ts +22 -0
  173. package/dist/cjs/operations/content/asset-query.js +77 -0
  174. package/dist/cjs/operations/content/asset-query.js.map +1 -0
  175. package/dist/cjs/operations/content/export.d.ts +57 -0
  176. package/dist/cjs/operations/content/export.js +224 -0
  177. package/dist/cjs/operations/content/export.js.map +1 -0
  178. package/dist/cjs/operations/content/index.d.ts +43 -0
  179. package/dist/cjs/operations/content/index.js +48 -0
  180. package/dist/cjs/operations/content/index.js.map +1 -0
  181. package/dist/cjs/operations/content/library.d.ts +137 -0
  182. package/dist/cjs/operations/content/library.js +392 -0
  183. package/dist/cjs/operations/content/library.js.map +1 -0
  184. package/dist/cjs/operations/content/types.d.ts +144 -0
  185. package/dist/cjs/operations/content/types.js +7 -0
  186. package/dist/cjs/operations/content/types.js.map +1 -0
  187. package/dist/cjs/operations/logs/index.d.ts +65 -0
  188. package/dist/cjs/operations/logs/index.js +73 -0
  189. package/dist/cjs/operations/logs/index.js.map +1 -0
  190. package/dist/cjs/operations/logs/list.d.ts +35 -0
  191. package/dist/cjs/operations/logs/list.js +144 -0
  192. package/dist/cjs/operations/logs/list.js.map +1 -0
  193. package/dist/cjs/operations/logs/path-normalizer.d.ts +82 -0
  194. package/dist/cjs/operations/logs/path-normalizer.js +190 -0
  195. package/dist/cjs/operations/logs/path-normalizer.js.map +1 -0
  196. package/dist/cjs/operations/logs/tail.d.ts +92 -0
  197. package/dist/cjs/operations/logs/tail.js +525 -0
  198. package/dist/cjs/operations/logs/tail.js.map +1 -0
  199. package/dist/cjs/operations/logs/types.d.ts +132 -0
  200. package/dist/cjs/operations/logs/types.js +7 -0
  201. package/dist/cjs/operations/logs/types.js.map +1 -0
  202. package/dist/cjs/operations/mrt/b2c-config.js +19 -4
  203. package/dist/cjs/operations/mrt/b2c-config.js.map +1 -1
  204. package/dist/cjs/operations/mrt/index.d.ts +2 -0
  205. package/dist/cjs/operations/mrt/index.js +2 -0
  206. package/dist/cjs/operations/mrt/index.js.map +1 -1
  207. package/dist/cjs/operations/mrt/push.js +3 -0
  208. package/dist/cjs/operations/mrt/push.js.map +1 -1
  209. package/dist/cjs/operations/mrt/tail-logs.d.ts +130 -0
  210. package/dist/cjs/operations/mrt/tail-logs.js +223 -0
  211. package/dist/cjs/operations/mrt/tail-logs.js.map +1 -0
  212. package/dist/cjs/operations/ods/index.d.ts +8 -0
  213. package/dist/cjs/operations/ods/index.js +13 -0
  214. package/dist/cjs/operations/ods/index.js.map +1 -0
  215. package/dist/cjs/operations/ods/sandbox-lookup.d.ts +63 -0
  216. package/dist/cjs/operations/ods/sandbox-lookup.js +130 -0
  217. package/dist/cjs/operations/ods/sandbox-lookup.js.map +1 -0
  218. package/dist/cjs/operations/ods/wait-for-sandbox.d.ts +64 -0
  219. package/dist/cjs/operations/ods/wait-for-sandbox.js +114 -0
  220. package/dist/cjs/operations/ods/wait-for-sandbox.js.map +1 -0
  221. package/dist/cjs/operations/orgs/index.d.ts +74 -0
  222. package/dist/cjs/operations/orgs/index.js +33 -0
  223. package/dist/cjs/operations/orgs/index.js.map +1 -0
  224. package/dist/cjs/operations/roles/index.d.ts +43 -0
  225. package/dist/cjs/operations/roles/index.js +48 -0
  226. package/dist/cjs/operations/roles/index.js.map +1 -0
  227. package/dist/cjs/operations/users/index.d.ts +143 -0
  228. package/dist/cjs/operations/users/index.js +141 -0
  229. package/dist/cjs/operations/users/index.js.map +1 -0
  230. package/dist/cjs/scaffold/engine.d.ts +68 -0
  231. package/dist/cjs/scaffold/engine.js +149 -0
  232. package/dist/cjs/scaffold/engine.js.map +1 -0
  233. package/dist/cjs/scaffold/executor.d.ts +36 -0
  234. package/dist/cjs/scaffold/executor.js +285 -0
  235. package/dist/cjs/scaffold/executor.js.map +1 -0
  236. package/dist/cjs/scaffold/index.d.ts +74 -0
  237. package/dist/cjs/scaffold/index.js +23 -0
  238. package/dist/cjs/scaffold/index.js.map +1 -0
  239. package/dist/cjs/scaffold/merge.d.ts +56 -0
  240. package/dist/cjs/scaffold/merge.js +183 -0
  241. package/dist/cjs/scaffold/merge.js.map +1 -0
  242. package/dist/cjs/scaffold/parameter-resolver.d.ts +86 -0
  243. package/dist/cjs/scaffold/parameter-resolver.js +179 -0
  244. package/dist/cjs/scaffold/parameter-resolver.js.map +1 -0
  245. package/dist/cjs/scaffold/registry.d.ts +45 -0
  246. package/dist/cjs/scaffold/registry.js +219 -0
  247. package/dist/cjs/scaffold/registry.js.map +1 -0
  248. package/dist/cjs/scaffold/sources.d.ts +45 -0
  249. package/dist/cjs/scaffold/sources.js +113 -0
  250. package/dist/cjs/scaffold/sources.js.map +1 -0
  251. package/dist/cjs/scaffold/types.d.ts +280 -0
  252. package/dist/cjs/scaffold/types.js +14 -0
  253. package/dist/cjs/scaffold/types.js.map +1 -0
  254. package/dist/cjs/scaffold/validation.d.ts +81 -0
  255. package/dist/cjs/scaffold/validation.js +250 -0
  256. package/dist/cjs/scaffold/validation.js.map +1 -0
  257. package/dist/cjs/scaffold/validators.d.ts +33 -0
  258. package/dist/cjs/scaffold/validators.js +334 -0
  259. package/dist/cjs/scaffold/validators.js.map +1 -0
  260. package/dist/{esm/operations/scapi-schemas → cjs/schemas}/collapse.d.ts +1 -1
  261. package/dist/cjs/schemas/collapse.js.map +1 -0
  262. package/dist/cjs/{operations/scapi-schemas → schemas}/index.d.ts +5 -5
  263. package/dist/cjs/{operations/scapi-schemas → schemas}/index.js +5 -5
  264. package/dist/cjs/schemas/index.js.map +1 -0
  265. package/dist/cjs/telemetry/index.d.ts +26 -0
  266. package/dist/cjs/telemetry/index.js +32 -0
  267. package/dist/cjs/telemetry/index.js.map +1 -0
  268. package/dist/cjs/telemetry/telemetry.d.ts +90 -0
  269. package/dist/cjs/telemetry/telemetry.js +283 -0
  270. package/dist/cjs/telemetry/telemetry.js.map +1 -0
  271. package/dist/cjs/telemetry/types.d.ts +62 -0
  272. package/dist/cjs/telemetry/types.js +7 -0
  273. package/dist/cjs/telemetry/types.js.map +1 -0
  274. package/dist/cjs/test-utils/config-isolation.js +7 -0
  275. package/dist/cjs/test-utils/config-isolation.js.map +1 -1
  276. package/dist/esm/auth/api-key.d.ts +2 -2
  277. package/dist/esm/auth/api-key.js +1 -0
  278. package/dist/esm/auth/api-key.js.map +1 -1
  279. package/dist/esm/auth/basic.d.ts +2 -2
  280. package/dist/esm/auth/basic.js +2 -0
  281. package/dist/esm/auth/basic.js.map +1 -1
  282. package/dist/esm/auth/index.d.ts +1 -1
  283. package/dist/esm/auth/index.js.map +1 -1
  284. package/dist/esm/auth/oauth-implicit.d.ts +3 -2
  285. package/dist/esm/auth/oauth-implicit.js +9 -3
  286. package/dist/esm/auth/oauth-implicit.js.map +1 -1
  287. package/dist/esm/auth/oauth.d.ts +3 -2
  288. package/dist/esm/auth/oauth.js +10 -3
  289. package/dist/esm/auth/oauth.js.map +1 -1
  290. package/dist/esm/auth/types.d.ts +15 -1
  291. package/dist/esm/auth/types.js +5 -0
  292. package/dist/esm/auth/types.js.map +1 -1
  293. package/dist/esm/cli/am-command.d.ts +74 -0
  294. package/dist/esm/cli/am-command.js +196 -0
  295. package/dist/esm/cli/am-command.js.map +1 -0
  296. package/dist/esm/cli/base-command.d.ts +61 -0
  297. package/dist/esm/cli/base-command.js +171 -4
  298. package/dist/esm/cli/base-command.js.map +1 -1
  299. package/dist/esm/cli/config.d.ts +80 -0
  300. package/dist/esm/cli/config.js +122 -2
  301. package/dist/esm/cli/config.js.map +1 -1
  302. package/dist/esm/cli/index.d.ts +3 -2
  303. package/dist/esm/cli/index.js +4 -1
  304. package/dist/esm/cli/index.js.map +1 -1
  305. package/dist/esm/cli/instance-command.d.ts +5 -0
  306. package/dist/esm/cli/instance-command.js +24 -23
  307. package/dist/esm/cli/instance-command.js.map +1 -1
  308. package/dist/esm/cli/mrt-command.d.ts +0 -6
  309. package/dist/esm/cli/mrt-command.js +5 -29
  310. package/dist/esm/cli/mrt-command.js.map +1 -1
  311. package/dist/esm/cli/oauth-command.d.ts +25 -6
  312. package/dist/esm/cli/oauth-command.js +65 -42
  313. package/dist/esm/cli/oauth-command.js.map +1 -1
  314. package/dist/esm/cli/ods-command.d.ts +23 -1
  315. package/dist/esm/cli/ods-command.js +61 -4
  316. package/dist/esm/cli/ods-command.js.map +1 -1
  317. package/dist/esm/cli/webdav-command.d.ts +5 -0
  318. package/dist/esm/clients/am-api.d.ts +491 -0
  319. package/dist/esm/clients/am-api.js +944 -0
  320. package/dist/esm/clients/am-api.js.map +1 -0
  321. package/dist/esm/clients/am-apiclients-api.generated.d.ts +803 -0
  322. package/dist/esm/clients/am-apiclients-api.generated.js +6 -0
  323. package/dist/esm/clients/am-apiclients-api.generated.js.map +1 -0
  324. package/dist/esm/clients/am-roles-api.generated.d.ts +298 -0
  325. package/dist/esm/clients/am-roles-api.generated.js +6 -0
  326. package/dist/esm/clients/am-roles-api.generated.js.map +1 -0
  327. package/dist/esm/clients/am-users-api.generated.d.ts +891 -0
  328. package/dist/esm/clients/am-users-api.generated.js +6 -0
  329. package/dist/esm/clients/am-users-api.generated.js.map +1 -0
  330. package/dist/esm/clients/cdn-zones.d.ts +33 -1
  331. package/dist/esm/clients/cdn-zones.js.map +1 -1
  332. package/dist/esm/clients/custom-apis.d.ts +30 -1
  333. package/dist/esm/clients/custom-apis.js.map +1 -1
  334. package/dist/esm/clients/index.d.ts +6 -2
  335. package/dist/esm/clients/index.js +3 -1
  336. package/dist/esm/clients/index.js.map +1 -1
  337. package/dist/esm/clients/middleware-registry.d.ts +1 -1
  338. package/dist/esm/clients/middleware-registry.js.map +1 -1
  339. package/dist/esm/clients/middleware.d.ts +49 -2
  340. package/dist/esm/clients/middleware.js +214 -2
  341. package/dist/esm/clients/middleware.js.map +1 -1
  342. package/dist/esm/clients/mrt-b2c.d.ts +25 -1
  343. package/dist/esm/clients/mrt-b2c.js.map +1 -1
  344. package/dist/esm/clients/mrt.d.ts +24 -1
  345. package/dist/esm/clients/mrt.js +5 -1
  346. package/dist/esm/clients/mrt.js.map +1 -1
  347. package/dist/esm/clients/ocapi.d.ts +22 -2
  348. package/dist/esm/clients/ocapi.js +0 -2
  349. package/dist/esm/clients/ocapi.js.map +1 -1
  350. package/dist/esm/clients/ods.d.ts +28 -1
  351. package/dist/esm/clients/ods.js.map +1 -1
  352. package/dist/esm/clients/scapi-schemas.d.ts +30 -1
  353. package/dist/esm/clients/scapi-schemas.js.map +1 -1
  354. package/dist/esm/clients/slas-admin.d.ts +28 -0
  355. package/dist/esm/clients/slas-admin.js.map +1 -1
  356. package/dist/esm/clients/tls-dispatcher.d.ts +42 -0
  357. package/dist/esm/clients/tls-dispatcher.js +107 -0
  358. package/dist/esm/clients/tls-dispatcher.js.map +1 -0
  359. package/dist/esm/clients/webdav.d.ts +8 -1
  360. package/dist/esm/clients/webdav.js +5 -1
  361. package/dist/esm/clients/webdav.js.map +1 -1
  362. package/dist/esm/config/dw-json.d.ts +106 -21
  363. package/dist/esm/config/dw-json.js +170 -4
  364. package/dist/esm/config/dw-json.js.map +1 -1
  365. package/dist/esm/config/index.d.ts +7 -5
  366. package/dist/esm/config/index.js +7 -3
  367. package/dist/esm/config/index.js.map +1 -1
  368. package/dist/esm/config/instance-manager.d.ts +97 -0
  369. package/dist/esm/config/instance-manager.js +166 -0
  370. package/dist/esm/config/instance-manager.js.map +1 -0
  371. package/dist/esm/config/mapping.d.ts +63 -5
  372. package/dist/esm/config/mapping.js +179 -18
  373. package/dist/esm/config/mapping.js.map +1 -1
  374. package/dist/esm/config/resolved-config.d.ts +1 -3
  375. package/dist/esm/config/resolved-config.js +0 -8
  376. package/dist/esm/config/resolved-config.js.map +1 -1
  377. package/dist/esm/config/resolver.d.ts +1 -1
  378. package/dist/esm/config/resolver.js +19 -3
  379. package/dist/esm/config/resolver.js.map +1 -1
  380. package/dist/esm/config/sources/dw-json-source.d.ts +17 -1
  381. package/dist/esm/config/sources/dw-json-source.js +70 -3
  382. package/dist/esm/config/sources/dw-json-source.js.map +1 -1
  383. package/dist/esm/config/sources/mobify-source.js +3 -2
  384. package/dist/esm/config/sources/mobify-source.js.map +1 -1
  385. package/dist/esm/config/sources/package-json-source.js +9 -4
  386. package/dist/esm/config/sources/package-json-source.js.map +1 -1
  387. package/dist/esm/config/types.d.ts +78 -18
  388. package/dist/esm/defaults.d.ts +6 -0
  389. package/dist/esm/defaults.js +6 -0
  390. package/dist/esm/defaults.js.map +1 -1
  391. package/dist/{cjs/operations → esm}/docs/download.d.ts +1 -1
  392. package/dist/esm/{operations/docs → docs}/download.js +2 -2
  393. package/dist/esm/docs/download.js.map +1 -0
  394. package/dist/{cjs/operations → esm}/docs/index.d.ts +4 -4
  395. package/dist/esm/docs/index.js.map +1 -0
  396. package/dist/esm/docs/schema.js.map +1 -0
  397. package/dist/esm/docs/search.js.map +1 -0
  398. package/dist/esm/docs/types.js.map +1 -0
  399. package/dist/esm/i18n/index.js +3 -0
  400. package/dist/esm/i18n/index.js.map +1 -1
  401. package/dist/esm/index.d.ts +11 -12
  402. package/dist/esm/index.js +12 -10
  403. package/dist/esm/index.js.map +1 -1
  404. package/dist/esm/instance/index.d.ts +4 -0
  405. package/dist/esm/instance/index.js +6 -1
  406. package/dist/esm/instance/index.js.map +1 -1
  407. package/dist/esm/logging/index.d.ts +1 -1
  408. package/dist/esm/logging/logger.js +27 -0
  409. package/dist/esm/logging/logger.js.map +1 -1
  410. package/dist/esm/logging/types.d.ts +9 -0
  411. package/dist/esm/operations/content/asset-query.d.ts +22 -0
  412. package/dist/esm/operations/content/asset-query.js +77 -0
  413. package/dist/esm/operations/content/asset-query.js.map +1 -0
  414. package/dist/esm/operations/content/export.d.ts +57 -0
  415. package/dist/esm/operations/content/export.js +224 -0
  416. package/dist/esm/operations/content/export.js.map +1 -0
  417. package/dist/esm/operations/content/index.d.ts +43 -0
  418. package/dist/esm/operations/content/index.js +48 -0
  419. package/dist/esm/operations/content/index.js.map +1 -0
  420. package/dist/esm/operations/content/library.d.ts +137 -0
  421. package/dist/esm/operations/content/library.js +392 -0
  422. package/dist/esm/operations/content/library.js.map +1 -0
  423. package/dist/esm/operations/content/types.d.ts +144 -0
  424. package/dist/esm/operations/content/types.js +7 -0
  425. package/dist/esm/operations/content/types.js.map +1 -0
  426. package/dist/esm/operations/logs/index.d.ts +65 -0
  427. package/dist/esm/operations/logs/index.js +73 -0
  428. package/dist/esm/operations/logs/index.js.map +1 -0
  429. package/dist/esm/operations/logs/list.d.ts +35 -0
  430. package/dist/esm/operations/logs/list.js +144 -0
  431. package/dist/esm/operations/logs/list.js.map +1 -0
  432. package/dist/esm/operations/logs/path-normalizer.d.ts +82 -0
  433. package/dist/esm/operations/logs/path-normalizer.js +190 -0
  434. package/dist/esm/operations/logs/path-normalizer.js.map +1 -0
  435. package/dist/esm/operations/logs/tail.d.ts +92 -0
  436. package/dist/esm/operations/logs/tail.js +525 -0
  437. package/dist/esm/operations/logs/tail.js.map +1 -0
  438. package/dist/esm/operations/logs/types.d.ts +132 -0
  439. package/dist/esm/operations/logs/types.js +7 -0
  440. package/dist/esm/operations/logs/types.js.map +1 -0
  441. package/dist/esm/operations/mrt/b2c-config.js +19 -4
  442. package/dist/esm/operations/mrt/b2c-config.js.map +1 -1
  443. package/dist/esm/operations/mrt/index.d.ts +2 -0
  444. package/dist/esm/operations/mrt/index.js +2 -0
  445. package/dist/esm/operations/mrt/index.js.map +1 -1
  446. package/dist/esm/operations/mrt/push.js +3 -0
  447. package/dist/esm/operations/mrt/push.js.map +1 -1
  448. package/dist/esm/operations/mrt/tail-logs.d.ts +130 -0
  449. package/dist/esm/operations/mrt/tail-logs.js +223 -0
  450. package/dist/esm/operations/mrt/tail-logs.js.map +1 -0
  451. package/dist/esm/operations/ods/index.d.ts +8 -0
  452. package/dist/esm/operations/ods/index.js +13 -0
  453. package/dist/esm/operations/ods/index.js.map +1 -0
  454. package/dist/esm/operations/ods/sandbox-lookup.d.ts +63 -0
  455. package/dist/esm/operations/ods/sandbox-lookup.js +130 -0
  456. package/dist/esm/operations/ods/sandbox-lookup.js.map +1 -0
  457. package/dist/esm/operations/ods/wait-for-sandbox.d.ts +64 -0
  458. package/dist/esm/operations/ods/wait-for-sandbox.js +114 -0
  459. package/dist/esm/operations/ods/wait-for-sandbox.js.map +1 -0
  460. package/dist/esm/operations/orgs/index.d.ts +74 -0
  461. package/dist/esm/operations/orgs/index.js +33 -0
  462. package/dist/esm/operations/orgs/index.js.map +1 -0
  463. package/dist/esm/operations/roles/index.d.ts +43 -0
  464. package/dist/esm/operations/roles/index.js +48 -0
  465. package/dist/esm/operations/roles/index.js.map +1 -0
  466. package/dist/esm/operations/users/index.d.ts +143 -0
  467. package/dist/esm/operations/users/index.js +141 -0
  468. package/dist/esm/operations/users/index.js.map +1 -0
  469. package/dist/esm/scaffold/engine.d.ts +68 -0
  470. package/dist/esm/scaffold/engine.js +149 -0
  471. package/dist/esm/scaffold/engine.js.map +1 -0
  472. package/dist/esm/scaffold/executor.d.ts +36 -0
  473. package/dist/esm/scaffold/executor.js +285 -0
  474. package/dist/esm/scaffold/executor.js.map +1 -0
  475. package/dist/esm/scaffold/index.d.ts +74 -0
  476. package/dist/esm/scaffold/index.js +23 -0
  477. package/dist/esm/scaffold/index.js.map +1 -0
  478. package/dist/esm/scaffold/merge.d.ts +56 -0
  479. package/dist/esm/scaffold/merge.js +183 -0
  480. package/dist/esm/scaffold/merge.js.map +1 -0
  481. package/dist/esm/scaffold/parameter-resolver.d.ts +86 -0
  482. package/dist/esm/scaffold/parameter-resolver.js +179 -0
  483. package/dist/esm/scaffold/parameter-resolver.js.map +1 -0
  484. package/dist/esm/scaffold/registry.d.ts +45 -0
  485. package/dist/esm/scaffold/registry.js +219 -0
  486. package/dist/esm/scaffold/registry.js.map +1 -0
  487. package/dist/esm/scaffold/sources.d.ts +45 -0
  488. package/dist/esm/scaffold/sources.js +113 -0
  489. package/dist/esm/scaffold/sources.js.map +1 -0
  490. package/dist/esm/scaffold/types.d.ts +280 -0
  491. package/dist/esm/scaffold/types.js +14 -0
  492. package/dist/esm/scaffold/types.js.map +1 -0
  493. package/dist/esm/scaffold/validation.d.ts +81 -0
  494. package/dist/esm/scaffold/validation.js +250 -0
  495. package/dist/esm/scaffold/validation.js.map +1 -0
  496. package/dist/esm/scaffold/validators.d.ts +33 -0
  497. package/dist/esm/scaffold/validators.js +334 -0
  498. package/dist/esm/scaffold/validators.js.map +1 -0
  499. package/dist/{cjs/operations/scapi-schemas → esm/schemas}/collapse.d.ts +1 -1
  500. package/dist/esm/schemas/collapse.js.map +1 -0
  501. package/dist/esm/{operations/scapi-schemas → schemas}/index.d.ts +5 -5
  502. package/dist/esm/{operations/scapi-schemas → schemas}/index.js +5 -5
  503. package/dist/esm/schemas/index.js.map +1 -0
  504. package/dist/esm/telemetry/index.d.ts +26 -0
  505. package/dist/esm/telemetry/index.js +32 -0
  506. package/dist/esm/telemetry/index.js.map +1 -0
  507. package/dist/esm/telemetry/telemetry.d.ts +90 -0
  508. package/dist/esm/telemetry/telemetry.js +283 -0
  509. package/dist/esm/telemetry/telemetry.js.map +1 -0
  510. package/dist/esm/telemetry/types.d.ts +62 -0
  511. package/dist/esm/telemetry/types.js +7 -0
  512. package/dist/esm/telemetry/types.js.map +1 -0
  513. package/dist/esm/test-utils/config-isolation.js +7 -0
  514. package/dist/esm/test-utils/config-isolation.js.map +1 -1
  515. package/package.json +112 -50
  516. package/specs/am-apiclients-api-v1.yaml +965 -0
  517. package/specs/am-roles-api-v1.yaml +316 -0
  518. package/specs/am-users-api-v1.yaml +1102 -0
  519. package/dist/cjs/logger.d.ts +0 -66
  520. package/dist/cjs/logger.js +0 -80
  521. package/dist/cjs/logger.js.map +0 -1
  522. package/dist/cjs/operations/docs/download.js.map +0 -1
  523. package/dist/cjs/operations/docs/index.js.map +0 -1
  524. package/dist/cjs/operations/docs/schema.js.map +0 -1
  525. package/dist/cjs/operations/docs/search.js.map +0 -1
  526. package/dist/cjs/operations/docs/types.js.map +0 -1
  527. package/dist/cjs/operations/scapi-schemas/collapse.js.map +0 -1
  528. package/dist/cjs/operations/scapi-schemas/index.js.map +0 -1
  529. package/dist/cjs/operations/sites/index.d.ts +0 -56
  530. package/dist/cjs/operations/sites/index.js +0 -19
  531. package/dist/cjs/operations/sites/index.js.map +0 -1
  532. package/dist/cjs/platform/index.d.ts +0 -38
  533. package/dist/cjs/platform/index.js +0 -42
  534. package/dist/cjs/platform/index.js.map +0 -1
  535. package/dist/cjs/platform/mrt.d.ts +0 -19
  536. package/dist/cjs/platform/mrt.js +0 -22
  537. package/dist/cjs/platform/mrt.js.map +0 -1
  538. package/dist/cjs/platform/ods.d.ts +0 -17
  539. package/dist/cjs/platform/ods.js +0 -22
  540. package/dist/cjs/platform/ods.js.map +0 -1
  541. package/dist/esm/logger.d.ts +0 -66
  542. package/dist/esm/logger.js +0 -80
  543. package/dist/esm/logger.js.map +0 -1
  544. package/dist/esm/operations/docs/download.js.map +0 -1
  545. package/dist/esm/operations/docs/index.js.map +0 -1
  546. package/dist/esm/operations/docs/schema.js.map +0 -1
  547. package/dist/esm/operations/docs/search.js.map +0 -1
  548. package/dist/esm/operations/docs/types.js.map +0 -1
  549. package/dist/esm/operations/scapi-schemas/collapse.js.map +0 -1
  550. package/dist/esm/operations/scapi-schemas/index.js.map +0 -1
  551. package/dist/esm/operations/sites/index.d.ts +0 -56
  552. package/dist/esm/operations/sites/index.js +0 -67
  553. package/dist/esm/operations/sites/index.js.map +0 -1
  554. package/dist/esm/platform/index.d.ts +0 -38
  555. package/dist/esm/platform/index.js +0 -42
  556. package/dist/esm/platform/index.js.map +0 -1
  557. package/dist/esm/platform/mrt.d.ts +0 -19
  558. package/dist/esm/platform/mrt.js +0 -22
  559. package/dist/esm/platform/mrt.js.map +0 -1
  560. package/dist/esm/platform/ods.d.ts +0 -17
  561. package/dist/esm/platform/ods.js +0 -22
  562. package/dist/esm/platform/ods.js.map +0 -1
  563. /package/dist/cjs/{operations/docs → docs}/index.js +0 -0
  564. /package/dist/cjs/{operations/docs → docs}/schema.d.ts +0 -0
  565. /package/dist/cjs/{operations/docs → docs}/schema.js +0 -0
  566. /package/dist/cjs/{operations/docs → docs}/search.d.ts +0 -0
  567. /package/dist/cjs/{operations/docs → docs}/search.js +0 -0
  568. /package/dist/cjs/{operations/docs → docs}/types.d.ts +0 -0
  569. /package/dist/cjs/{operations/docs → docs}/types.js +0 -0
  570. /package/dist/cjs/{operations/scapi-schemas → schemas}/collapse.js +0 -0
  571. /package/dist/esm/{operations/docs → docs}/index.js +0 -0
  572. /package/dist/esm/{operations/docs → docs}/schema.d.ts +0 -0
  573. /package/dist/esm/{operations/docs → docs}/schema.js +0 -0
  574. /package/dist/esm/{operations/docs → docs}/search.d.ts +0 -0
  575. /package/dist/esm/{operations/docs → docs}/search.js +0 -0
  576. /package/dist/esm/{operations/docs → docs}/types.d.ts +0 -0
  577. /package/dist/esm/{operations/docs → docs}/types.js +0 -0
  578. /package/dist/esm/{operations/scapi-schemas → schemas}/collapse.js +0 -0
@@ -0,0 +1,130 @@
1
+ /**
2
+ * UUID regex pattern (standard 8-4-4-4-12 format).
3
+ */
4
+ const UUID_REGEX = /^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/i;
5
+ /**
6
+ * Friendly sandbox ID pattern: realm-instance or realm_instance
7
+ * - realm: 4 alphanumeric characters
8
+ * - separator: dash or underscore
9
+ * - instance: 1+ alphanumeric characters
10
+ */
11
+ const FRIENDLY_ID_REGEX = /^([a-z\d]{4})[-_]([a-z\d]+)$/i;
12
+ /**
13
+ * Prefix used in organization ID format (e.g., f_ecom_zzpq_013).
14
+ */
15
+ const ECOM_PREFIX = 'f_ecom_';
16
+ /**
17
+ * Strips the f_ecom_ prefix if present.
18
+ */
19
+ function normalizeIdentifier(value) {
20
+ if (value.toLowerCase().startsWith(ECOM_PREFIX)) {
21
+ return value.slice(ECOM_PREFIX.length);
22
+ }
23
+ return value;
24
+ }
25
+ /**
26
+ * Error thrown when a sandbox cannot be found by its friendly identifier.
27
+ */
28
+ export class SandboxNotFoundError extends Error {
29
+ identifier;
30
+ realm;
31
+ instance;
32
+ constructor(identifier, realm, instance) {
33
+ const message = realm && instance
34
+ ? `Sandbox not found: ${identifier} (realm=${realm}, instance=${instance})`
35
+ : `Sandbox not found: ${identifier}`;
36
+ super(message);
37
+ this.identifier = identifier;
38
+ this.realm = realm;
39
+ this.instance = instance;
40
+ this.name = 'SandboxNotFoundError';
41
+ }
42
+ }
43
+ /**
44
+ * Checks if a string is a valid UUID.
45
+ *
46
+ * @param value - The string to check
47
+ * @returns true if the value is a valid UUID
48
+ */
49
+ export function isUuid(value) {
50
+ return UUID_REGEX.test(value);
51
+ }
52
+ /**
53
+ * Checks if a string matches the friendly sandbox ID format (realm-instance or realm_instance).
54
+ *
55
+ * @param value - The string to check
56
+ * @returns true if the value matches the friendly format
57
+ */
58
+ export function isFriendlySandboxId(value) {
59
+ return FRIENDLY_ID_REGEX.test(normalizeIdentifier(value));
60
+ }
61
+ /**
62
+ * Parses a friendly sandbox ID into its realm and instance components.
63
+ *
64
+ * @param value - The friendly ID to parse (e.g., "abcd-123" or "abcd_123")
65
+ * @returns Object with realm and instance, or null if not a valid friendly ID
66
+ */
67
+ export function parseFriendlySandboxId(value) {
68
+ const normalized = normalizeIdentifier(value);
69
+ const match = normalized.match(FRIENDLY_ID_REGEX);
70
+ if (!match) {
71
+ return null;
72
+ }
73
+ return {
74
+ realm: match[1].toLowerCase(),
75
+ instance: match[2].toLowerCase(),
76
+ };
77
+ }
78
+ /**
79
+ * Resolves a sandbox identifier to a UUID.
80
+ *
81
+ * If the identifier is already a UUID, it is returned directly without making an API call.
82
+ * If the identifier is a friendly format (realm-instance), it queries the ODS API to find
83
+ * the matching sandbox and returns its UUID.
84
+ *
85
+ * @param client - The ODS API client
86
+ * @param identifier - Sandbox identifier (UUID or friendly format like "abcd-123")
87
+ * @returns The sandbox UUID
88
+ * @throws {SandboxNotFoundError} If the sandbox cannot be found
89
+ *
90
+ * @example
91
+ * ```typescript
92
+ * // UUID is returned directly
93
+ * const uuid = await resolveSandboxId(client, 'abc12345-1234-1234-1234-abc123456789');
94
+ * // => 'abc12345-1234-1234-1234-abc123456789'
95
+ *
96
+ * // Friendly ID is looked up
97
+ * const uuid = await resolveSandboxId(client, 'zzzv-123');
98
+ * // => 'abc12345-1234-1234-1234-abc123456789' (actual UUID from API)
99
+ * ```
100
+ */
101
+ export async function resolveSandboxId(client, identifier) {
102
+ // If already a UUID, return directly
103
+ if (isUuid(identifier)) {
104
+ return identifier;
105
+ }
106
+ // Try to parse as friendly ID
107
+ const parsed = parseFriendlySandboxId(identifier);
108
+ if (!parsed) {
109
+ // Not a UUID and not a friendly ID - treat as UUID and let API return 404
110
+ return identifier;
111
+ }
112
+ // Query sandboxes filtered by realm
113
+ const { data, error } = await client.GET('/sandboxes', {
114
+ params: {
115
+ query: {
116
+ filter_params: `realm=${parsed.realm}`,
117
+ },
118
+ },
119
+ });
120
+ if (error || !data?.data) {
121
+ throw new SandboxNotFoundError(identifier, parsed.realm, parsed.instance);
122
+ }
123
+ // Find sandbox with matching instance
124
+ const sandbox = data.data.find((s) => s.instance?.toLowerCase() === parsed.instance);
125
+ if (!sandbox?.id) {
126
+ throw new SandboxNotFoundError(identifier, parsed.realm, parsed.instance);
127
+ }
128
+ return sandbox.id;
129
+ }
130
+ //# sourceMappingURL=sandbox-lookup.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sandbox-lookup.js","sourceRoot":"","sources":["../../../../src/operations/ods/sandbox-lookup.ts"],"names":[],"mappings":"AAYA;;GAEG;AACH,MAAM,UAAU,GAAG,4DAA4D,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,+BAA+B,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,GAAG,SAAS,CAAC;AAE9B;;GAEG;AACH,SAAS,mBAAmB,CAAC,KAAa;IACxC,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAE3B;IACA;IACA;IAHlB,YACkB,UAAkB,EAClB,KAAc,EACd,QAAiB;QAEjC,MAAM,OAAO,GACX,KAAK,IAAI,QAAQ;YACf,CAAC,CAAC,sBAAsB,UAAU,WAAW,KAAK,cAAc,QAAQ,GAAG;YAC3E,CAAC,CAAC,sBAAsB,UAAU,EAAE,CAAC;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC;QARC,eAAU,GAAV,UAAU,CAAQ;QAClB,UAAK,GAAL,KAAK,CAAS;QACd,aAAQ,GAAR,QAAQ,CAAS;QAOjC,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa;IAClC,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAa;IAC/C,OAAO,iBAAiB,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAa;IAClD,MAAM,UAAU,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAClD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;QAC7B,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;KACjC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAAiB,EAAE,UAAkB;IAC1E,qCAAqC;IACrC,IAAI,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,8BAA8B;IAC9B,MAAM,MAAM,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,0EAA0E;QAC1E,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,oCAAoC;IACpC,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE;QACnD,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,aAAa,EAAE,SAAS,MAAM,CAAC,KAAK,EAAE;aACvC;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QACzB,MAAM,IAAI,oBAAoB,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC5E,CAAC;IAED,sCAAsC;IACtC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,MAAM,CAAC,QAAQ,CAAC,CAAC;IAErF,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,oBAAoB,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO,OAAO,CAAC,EAAE,CAAC;AACpB,CAAC"}
@@ -0,0 +1,64 @@
1
+ import type { OdsClient } from '../../clients/ods.js';
2
+ export type SandboxState = 'deleted' | 'failed' | 'started' | 'stopped' | (string & {});
3
+ export declare class SandboxPollingTimeoutError extends Error {
4
+ readonly sandboxId: string;
5
+ readonly targetState: SandboxState;
6
+ readonly timeoutSeconds: number;
7
+ readonly lastState?: SandboxState | undefined;
8
+ constructor(sandboxId: string, targetState: SandboxState, timeoutSeconds: number, lastState?: SandboxState | undefined);
9
+ }
10
+ export declare class SandboxPollingError extends Error {
11
+ readonly sandboxId: string;
12
+ readonly message: string;
13
+ constructor(sandboxId: string, message: string);
14
+ }
15
+ export declare class SandboxTerminalStateError extends Error {
16
+ readonly sandboxId: string;
17
+ readonly targetState: SandboxState;
18
+ readonly state: SandboxState;
19
+ constructor(sandboxId: string, targetState: SandboxState, state: SandboxState);
20
+ }
21
+ export interface WaitForSandboxPollInfo {
22
+ sandboxId: string;
23
+ elapsedSeconds: number;
24
+ state: SandboxState;
25
+ }
26
+ export interface WaitForSandboxOptions {
27
+ sandboxId: string;
28
+ targetState: SandboxState;
29
+ pollIntervalSeconds: number;
30
+ timeoutSeconds: number;
31
+ onPoll?: (info: WaitForSandboxPollInfo) => void;
32
+ sleep?: (ms: number) => Promise<void>;
33
+ }
34
+ /**
35
+ * Waits for a sandbox to reach a target state by polling its status.
36
+ *
37
+ * This function polls the ODS API at regular intervals until the sandbox reaches the desired state,
38
+ * times out, or enters a terminal error state (failed/deleted).
39
+ *
40
+ * @param client - ODS client for API calls
41
+ * @param options - Polling configuration options
42
+ * @param options.sandboxId - ID of the sandbox to monitor
43
+ * @param options.targetState - Desired sandbox state (e.g., 'started', 'stopped', 'deleted')
44
+ * @param options.pollIntervalSeconds - Seconds between status checks
45
+ * @param options.timeoutSeconds - Maximum seconds to wait (0 = no timeout)
46
+ * @param options.onPoll - Optional callback invoked on each poll with current state
47
+ * @param options.sleep - Optional custom sleep function (primarily for testing)
48
+ *
49
+ * @throws {SandboxPollingTimeoutError} If the timeout is exceeded before reaching target state
50
+ * @throws {SandboxPollingError} If the API request fails
51
+ * @throws {SandboxTerminalStateError} If the sandbox enters a terminal error state
52
+ *
53
+ * @example
54
+ * ```typescript
55
+ * await waitForSandbox(odsClient, {
56
+ * sandboxId: 'abc-123',
57
+ * targetState: 'started',
58
+ * pollIntervalSeconds: 5,
59
+ * timeoutSeconds: 300,
60
+ * onPoll: (info) => console.log(`State: ${info.state} (${info.elapsedSeconds}s)`),
61
+ * });
62
+ * ```
63
+ */
64
+ export declare function waitForSandbox(client: OdsClient, options: WaitForSandboxOptions): Promise<void>;
@@ -0,0 +1,114 @@
1
+ /*
2
+ * Copyright (c) 2025, Salesforce, Inc.
3
+ * SPDX-License-Identifier: Apache-2
4
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
5
+ */
6
+ import { getLogger } from '../../logging/logger.js';
7
+ export class SandboxPollingTimeoutError extends Error {
8
+ sandboxId;
9
+ targetState;
10
+ timeoutSeconds;
11
+ lastState;
12
+ constructor(sandboxId, targetState, timeoutSeconds, lastState) {
13
+ super(`Timeout waiting for sandbox ${sandboxId} to reach state ${targetState} after ${timeoutSeconds} seconds${lastState ? ` (lastState=${lastState})` : ''}`);
14
+ this.sandboxId = sandboxId;
15
+ this.targetState = targetState;
16
+ this.timeoutSeconds = timeoutSeconds;
17
+ this.lastState = lastState;
18
+ this.name = 'SandboxPollingTimeoutError';
19
+ }
20
+ }
21
+ export class SandboxPollingError extends Error {
22
+ sandboxId;
23
+ message;
24
+ constructor(sandboxId, message) {
25
+ super(`Failed to fetch sandbox status for ${sandboxId}: ${message}`);
26
+ this.sandboxId = sandboxId;
27
+ this.message = message;
28
+ this.name = 'SandboxPollingError';
29
+ }
30
+ }
31
+ export class SandboxTerminalStateError extends Error {
32
+ sandboxId;
33
+ targetState;
34
+ state;
35
+ constructor(sandboxId, targetState, state) {
36
+ super(`Sandbox ${sandboxId} reached terminal state ${state} while waiting for ${targetState}`);
37
+ this.sandboxId = sandboxId;
38
+ this.targetState = targetState;
39
+ this.state = state;
40
+ this.name = 'SandboxTerminalStateError';
41
+ }
42
+ }
43
+ async function defaultSleep(ms) {
44
+ await new Promise((resolve) => {
45
+ setTimeout(resolve, ms);
46
+ });
47
+ }
48
+ /**
49
+ * Waits for a sandbox to reach a target state by polling its status.
50
+ *
51
+ * This function polls the ODS API at regular intervals until the sandbox reaches the desired state,
52
+ * times out, or enters a terminal error state (failed/deleted).
53
+ *
54
+ * @param client - ODS client for API calls
55
+ * @param options - Polling configuration options
56
+ * @param options.sandboxId - ID of the sandbox to monitor
57
+ * @param options.targetState - Desired sandbox state (e.g., 'started', 'stopped', 'deleted')
58
+ * @param options.pollIntervalSeconds - Seconds between status checks
59
+ * @param options.timeoutSeconds - Maximum seconds to wait (0 = no timeout)
60
+ * @param options.onPoll - Optional callback invoked on each poll with current state
61
+ * @param options.sleep - Optional custom sleep function (primarily for testing)
62
+ *
63
+ * @throws {SandboxPollingTimeoutError} If the timeout is exceeded before reaching target state
64
+ * @throws {SandboxPollingError} If the API request fails
65
+ * @throws {SandboxTerminalStateError} If the sandbox enters a terminal error state
66
+ *
67
+ * @example
68
+ * ```typescript
69
+ * await waitForSandbox(odsClient, {
70
+ * sandboxId: 'abc-123',
71
+ * targetState: 'started',
72
+ * pollIntervalSeconds: 5,
73
+ * timeoutSeconds: 300,
74
+ * onPoll: (info) => console.log(`State: ${info.state} (${info.elapsedSeconds}s)`),
75
+ * });
76
+ * ```
77
+ */
78
+ export async function waitForSandbox(client, options) {
79
+ const logger = getLogger();
80
+ const { sandboxId, targetState, pollIntervalSeconds, timeoutSeconds } = options;
81
+ const sleepFn = options.sleep ?? defaultSleep;
82
+ const startTime = Date.now();
83
+ const pollIntervalMs = pollIntervalSeconds * 1000;
84
+ const timeoutMs = timeoutSeconds * 1000;
85
+ await sleepFn(pollIntervalMs);
86
+ let lastState;
87
+ while (true) {
88
+ const elapsedSeconds = Math.round((Date.now() - startTime) / 1000);
89
+ if (timeoutSeconds > 0 && Date.now() - startTime > timeoutMs) {
90
+ throw new SandboxPollingTimeoutError(sandboxId, targetState, timeoutSeconds, lastState);
91
+ }
92
+ const result = await client.GET('/sandboxes/{sandboxId}', {
93
+ params: {
94
+ path: { sandboxId },
95
+ },
96
+ });
97
+ if (!result.data?.data) {
98
+ throw new SandboxPollingError(sandboxId, result.response?.statusText || 'Unknown error');
99
+ }
100
+ const sandbox = result.data.data;
101
+ const currentState = sandbox.state || 'unknown';
102
+ lastState = currentState;
103
+ logger.trace({ sandboxId, elapsedSeconds, state: currentState }, '[ODS] Sandbox poll');
104
+ options.onPoll?.({ sandboxId, elapsedSeconds, state: currentState });
105
+ if (currentState === targetState) {
106
+ return;
107
+ }
108
+ if (currentState === 'failed' || currentState === 'deleted') {
109
+ throw new SandboxTerminalStateError(sandboxId, targetState, currentState);
110
+ }
111
+ await sleepFn(pollIntervalMs);
112
+ }
113
+ }
114
+ //# sourceMappingURL=wait-for-sandbox.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"wait-for-sandbox.js","sourceRoot":"","sources":["../../../../src/operations/ods/wait-for-sandbox.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAIlD,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IAEjC;IACA;IACA;IACA;IAJlB,YACkB,SAAiB,EACjB,WAAyB,EACzB,cAAsB,EACtB,SAAwB;QAExC,KAAK,CACH,+BAA+B,SAAS,mBAAmB,WAAW,UAAU,cAAc,WAC5F,SAAS,CAAC,CAAC,CAAC,eAAe,SAAS,GAAG,CAAC,CAAC,CAAC,EAC5C,EAAE,CACH,CAAC;QATc,cAAS,GAAT,SAAS,CAAQ;QACjB,gBAAW,GAAX,WAAW,CAAc;QACzB,mBAAc,GAAd,cAAc,CAAQ;QACtB,cAAS,GAAT,SAAS,CAAe;QAOxC,IAAI,CAAC,IAAI,GAAG,4BAA4B,CAAC;IAC3C,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAE1B;IACA;IAFlB,YACkB,SAAiB,EACjB,OAAe;QAE/B,KAAK,CAAC,sCAAsC,SAAS,KAAK,OAAO,EAAE,CAAC,CAAC;QAHrD,cAAS,GAAT,SAAS,CAAQ;QACjB,YAAO,GAAP,OAAO,CAAQ;QAG/B,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,KAAK;IAEhC;IACA;IACA;IAHlB,YACkB,SAAiB,EACjB,WAAyB,EACzB,KAAmB;QAEnC,KAAK,CAAC,WAAW,SAAS,2BAA2B,KAAK,sBAAsB,WAAW,EAAE,CAAC,CAAC;QAJ/E,cAAS,GAAT,SAAS,CAAQ;QACjB,gBAAW,GAAX,WAAW,CAAc;QACzB,UAAK,GAAL,KAAK,CAAc;QAGnC,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;IAC1C,CAAC;CACF;AAiBD,KAAK,UAAU,YAAY,CAAC,EAAU;IACpC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC5B,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,MAAiB,EAAE,OAA8B;IACpF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAC,SAAS,EAAE,WAAW,EAAE,mBAAmB,EAAE,cAAc,EAAC,GAAG,OAAO,CAAC;IAE9E,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,YAAY,CAAC;IAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,cAAc,GAAG,mBAAmB,GAAG,IAAI,CAAC;IAClD,MAAM,SAAS,GAAG,cAAc,GAAG,IAAI,CAAC;IAExC,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;IAE9B,IAAI,SAAmC,CAAC;IAExC,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;QAEnE,IAAI,cAAc,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC;YAC7D,MAAM,IAAI,0BAA0B,CAAC,SAAS,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,CAAC,CAAC;QAC1F,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;YACxD,MAAM,EAAE;gBACN,IAAI,EAAE,EAAC,SAAS,EAAC;aAClB;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;YACvB,MAAM,IAAI,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,EAAE,UAAU,IAAI,eAAe,CAAC,CAAC;QAC3F,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,MAAM,YAAY,GAAI,OAAO,CAAC,KAAsB,IAAI,SAAS,CAAC;QAClE,SAAS,GAAG,YAAY,CAAC;QAEzB,MAAM,CAAC,KAAK,CAAC,EAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAC,EAAE,oBAAoB,CAAC,CAAC;QACrF,OAAO,CAAC,MAAM,EAAE,CAAC,EAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAC,CAAC,CAAC;QAEnE,IAAI,YAAY,KAAK,WAAW,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QAED,IAAI,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC5D,MAAM,IAAI,yBAAyB,CAAC,SAAS,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;IAChC,CAAC;AACH,CAAC"}
@@ -0,0 +1,74 @@
1
+ /**
2
+ * Account Manager organization management operations.
3
+ *
4
+ * This module provides high-level functions for managing organizations in Account Manager,
5
+ * including retrieving organization details.
6
+ *
7
+ * ## Core Organization Functions
8
+ *
9
+ * - {@link getOrg} - Get organization details by ID
10
+ * - {@link getOrgByName} - Get organization details by name
11
+ * - {@link listOrgs} - List organizations with pagination
12
+ *
13
+ * ## Usage
14
+ *
15
+ * ```typescript
16
+ * import {
17
+ * getOrg,
18
+ * getOrgByName,
19
+ * listOrgs,
20
+ * } from '@salesforce/b2c-tooling-sdk/operations/orgs';
21
+ * import {createAccountManagerOrgsClient} from '@salesforce/b2c-tooling-sdk/clients';
22
+ * import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
23
+ *
24
+ * const auth = new OAuthStrategy({
25
+ * clientId: 'your-client-id',
26
+ * clientSecret: 'your-client-secret',
27
+ * });
28
+ *
29
+ * const client = createAccountManagerOrgsClient({}, auth);
30
+ *
31
+ * // Get an organization by ID
32
+ * const org = await getOrg(client, 'org-id');
33
+ *
34
+ * // Get an organization by name
35
+ * const org = await getOrgByName(client, 'My Organization');
36
+ *
37
+ * // List organizations
38
+ * const orgs = await listOrgs(client, {size: 25, page: 0});
39
+ * ```
40
+ *
41
+ * ## Authentication
42
+ *
43
+ * Organization operations require OAuth authentication with appropriate Account Manager permissions.
44
+ *
45
+ * @module operations/orgs
46
+ */
47
+ import type { AccountManagerOrgsClient, AccountManagerOrganization, OrganizationCollection, ListOrgsOptions } from '../../clients/am-api.js';
48
+ export type { AccountManagerOrganization, OrganizationCollection, ListOrgsOptions } from '../../clients/am-api.js';
49
+ /**
50
+ * Gets an organization by ID.
51
+ *
52
+ * @param client - Account Manager Organizations client
53
+ * @param orgId - Organization ID
54
+ * @returns Organization details
55
+ * @throws Error if organization is not found
56
+ */
57
+ export declare function getOrg(client: AccountManagerOrgsClient, orgId: string): Promise<AccountManagerOrganization>;
58
+ /**
59
+ * Gets an organization by name (searches for exact or partial match).
60
+ *
61
+ * @param client - Account Manager Organizations client
62
+ * @param name - Organization name
63
+ * @returns Organization details
64
+ * @throws Error if organization is not found or ambiguous
65
+ */
66
+ export declare function getOrgByName(client: AccountManagerOrgsClient, name: string): Promise<AccountManagerOrganization>;
67
+ /**
68
+ * Lists organizations with pagination.
69
+ *
70
+ * @param client - Account Manager Organizations client
71
+ * @param options - List options (size, page, all)
72
+ * @returns Organization collection
73
+ */
74
+ export declare function listOrgs(client: AccountManagerOrgsClient, options?: ListOrgsOptions): Promise<OrganizationCollection>;
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Gets an organization by ID.
3
+ *
4
+ * @param client - Account Manager Organizations client
5
+ * @param orgId - Organization ID
6
+ * @returns Organization details
7
+ * @throws Error if organization is not found
8
+ */
9
+ export async function getOrg(client, orgId) {
10
+ return client.getOrg(orgId);
11
+ }
12
+ /**
13
+ * Gets an organization by name (searches for exact or partial match).
14
+ *
15
+ * @param client - Account Manager Organizations client
16
+ * @param name - Organization name
17
+ * @returns Organization details
18
+ * @throws Error if organization is not found or ambiguous
19
+ */
20
+ export async function getOrgByName(client, name) {
21
+ return client.getOrgByName(name);
22
+ }
23
+ /**
24
+ * Lists organizations with pagination.
25
+ *
26
+ * @param client - Account Manager Organizations client
27
+ * @param options - List options (size, page, all)
28
+ * @returns Organization collection
29
+ */
30
+ export async function listOrgs(client, options) {
31
+ return client.listOrgs(options);
32
+ }
33
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/orgs/index.ts"],"names":[],"mappings":"AA6DA;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,MAAgC,EAAE,KAAa;IAC1E,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAgC,EAChC,IAAY;IAEZ,OAAO,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,MAAgC,EAChC,OAAyB;IAEzB,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC"}
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Account Manager role management operations.
3
+ *
4
+ * This module provides high-level functions for retrieving role information
5
+ * in Account Manager, including listing roles and getting role details.
6
+ *
7
+ * ## Core Role Functions
8
+ *
9
+ * - {@link getRole} - Get role details by ID
10
+ * - {@link listRoles} - List roles with pagination
11
+ *
12
+ * ## Usage
13
+ *
14
+ * ```typescript
15
+ * import {getRole, listRoles} from '@salesforce/b2c-tooling-sdk/operations/roles';
16
+ * import {createAccountManagerRolesClient} from '@salesforce/b2c-tooling-sdk/clients';
17
+ * import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
18
+ *
19
+ * const auth = new OAuthStrategy({
20
+ * clientId: 'your-client-id',
21
+ * clientSecret: 'your-client-secret',
22
+ * });
23
+ *
24
+ * const client = createAccountManagerRolesClient({}, auth);
25
+ *
26
+ * // Get a role by ID
27
+ * const role = await getRole(client, 'bm-admin');
28
+ *
29
+ * // List roles
30
+ * const roles = await listRoles(client, {size: 25, page: 0});
31
+ *
32
+ * // List roles filtered by target type
33
+ * const userRoles = await listRoles(client, {size: 25, page: 0, roleTargetType: 'User'});
34
+ * ```
35
+ *
36
+ * ## Authentication
37
+ *
38
+ * Role operations require OAuth authentication with appropriate Account Manager permissions.
39
+ *
40
+ * @module operations/roles
41
+ */
42
+ export { getRole, listRoles } from '../../clients/am-api.js';
43
+ export type { AccountManagerRole, RoleCollection, ListRolesOptions } from '../../clients/am-api.js';
@@ -0,0 +1,48 @@
1
+ /*
2
+ * Copyright (c) 2025, Salesforce, Inc.
3
+ * SPDX-License-Identifier: Apache-2
4
+ * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
5
+ */
6
+ /**
7
+ * Account Manager role management operations.
8
+ *
9
+ * This module provides high-level functions for retrieving role information
10
+ * in Account Manager, including listing roles and getting role details.
11
+ *
12
+ * ## Core Role Functions
13
+ *
14
+ * - {@link getRole} - Get role details by ID
15
+ * - {@link listRoles} - List roles with pagination
16
+ *
17
+ * ## Usage
18
+ *
19
+ * ```typescript
20
+ * import {getRole, listRoles} from '@salesforce/b2c-tooling-sdk/operations/roles';
21
+ * import {createAccountManagerRolesClient} from '@salesforce/b2c-tooling-sdk/clients';
22
+ * import {OAuthStrategy} from '@salesforce/b2c-tooling-sdk/auth';
23
+ *
24
+ * const auth = new OAuthStrategy({
25
+ * clientId: 'your-client-id',
26
+ * clientSecret: 'your-client-secret',
27
+ * });
28
+ *
29
+ * const client = createAccountManagerRolesClient({}, auth);
30
+ *
31
+ * // Get a role by ID
32
+ * const role = await getRole(client, 'bm-admin');
33
+ *
34
+ * // List roles
35
+ * const roles = await listRoles(client, {size: 25, page: 0});
36
+ *
37
+ * // List roles filtered by target type
38
+ * const userRoles = await listRoles(client, {size: 25, page: 0, roleTargetType: 'User'});
39
+ * ```
40
+ *
41
+ * ## Authentication
42
+ *
43
+ * Role operations require OAuth authentication with appropriate Account Manager permissions.
44
+ *
45
+ * @module operations/roles
46
+ */
47
+ export { getRole, listRoles } from '../../clients/am-api.js';
48
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/roles/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,OAAO,EAAC,OAAO,EAAE,SAAS,EAAC,MAAM,yBAAyB,CAAC"}
@@ -0,0 +1,143 @@
1
+ /**
2
+ * Account Manager user management operations.
3
+ *
4
+ * This module provides high-level functions for managing users in Account Manager,
5
+ * including CRUD operations, role management, and user lifecycle operations.
6
+ *
7
+ * ## Core User Functions
8
+ *
9
+ * - {@link getUser} - Get user details by ID
10
+ * - {@link getUserByLogin} - Get user details by login (email)
11
+ * - {@link listUsers} - List users with pagination
12
+ * - {@link createUser} - Create a new user
13
+ * - {@link updateUser} - Update an existing user
14
+ * - {@link deleteUser} - Disable a user (soft delete)
15
+ * - {@link purgeUser} - Purge a disabled user (hard delete)
16
+ * - {@link resetUser} - Reset a user to INITIAL state
17
+ *
18
+ * ## Usage
19
+ *
20
+ * ```typescript
21
+ * import {
22
+ * getUserByLogin,
23
+ * listUsers,
24
+ * createUser,
25
+ * grantRole,
26
+ * } from '@salesforce/b2c-tooling-sdk/operations/users';
27
+ * import { createAccountManagerUsersClient } from '@salesforce/b2c-tooling-sdk/clients';
28
+ * import { OAuthStrategy } from '@salesforce/b2c-tooling-sdk/auth';
29
+ *
30
+ * const auth = new OAuthStrategy({
31
+ * clientId: 'your-client-id',
32
+ * clientSecret: 'your-client-secret',
33
+ * });
34
+ *
35
+ * const client = createAccountManagerUsersClient({}, auth);
36
+ *
37
+ * // Get a user by login
38
+ * const user = await getUserByLogin(client, 'user@example.com');
39
+ *
40
+ * // List users
41
+ * const users = await listUsers(client, { size: 25, page: 0 });
42
+ *
43
+ * // Create a new user
44
+ * const newUser = await createUser(client, {
45
+ * mail: 'newuser@example.com',
46
+ * firstName: 'John',
47
+ * lastName: 'Doe',
48
+ * organizations: ['org-id'],
49
+ * primaryOrganization: 'org-id',
50
+ * });
51
+ * ```
52
+ *
53
+ * ## Authentication
54
+ *
55
+ * User operations require OAuth authentication with appropriate Account Manager permissions.
56
+ *
57
+ * @module operations/users
58
+ */
59
+ import type { AccountManagerUsersClient, AccountManagerUser, UserCreate, UserUpdate } from '../../clients/am-api.js';
60
+ import { getUser, listUsers, deleteUser, purgeUser, resetUser } from '../../clients/am-api.js';
61
+ /**
62
+ * Options for creating a user.
63
+ */
64
+ export interface CreateUserOptions {
65
+ /** User details */
66
+ user: UserCreate;
67
+ }
68
+ /**
69
+ * Options for updating a user.
70
+ */
71
+ export interface UpdateUserOptions {
72
+ /** User ID */
73
+ userId: string;
74
+ /** Changes to apply */
75
+ changes: UserUpdate;
76
+ }
77
+ /**
78
+ * Options for granting a role.
79
+ */
80
+ export interface GrantRoleOptions {
81
+ /** User ID */
82
+ userId: string;
83
+ /** Role to grant */
84
+ role: string;
85
+ /** Optional scope for the role (tenant IDs, comma-separated) */
86
+ scope?: string;
87
+ }
88
+ /**
89
+ * Options for revoking a role.
90
+ */
91
+ export interface RevokeRoleOptions {
92
+ /** User ID */
93
+ userId: string;
94
+ /** Role to revoke */
95
+ role: string;
96
+ /** Optional scope to remove (if not provided, removes entire role) */
97
+ scope?: string;
98
+ }
99
+ export { getUser, listUsers, deleteUser, purgeUser, resetUser };
100
+ /**
101
+ * Retrieves details of a user by login (email).
102
+ * This searches through paginated results to find the user.
103
+ *
104
+ * @param client - Account Manager client
105
+ * @param login - User login (email)
106
+ * @returns User details
107
+ * @throws Error if user is not found
108
+ */
109
+ export declare function getUserByLogin(client: AccountManagerUsersClient, login: string): Promise<AccountManagerUser>;
110
+ /**
111
+ * Creates a new user.
112
+ *
113
+ * @param client - Account Manager client
114
+ * @param options - Create options (user details)
115
+ * @returns Created user
116
+ */
117
+ export declare function createUser(client: AccountManagerUsersClient, options: CreateUserOptions): Promise<AccountManagerUser>;
118
+ /**
119
+ * Updates an existing user.
120
+ *
121
+ * @param client - Account Manager client
122
+ * @param options - Update options (userId, changes)
123
+ * @returns Updated user
124
+ */
125
+ export declare function updateUser(client: AccountManagerUsersClient, options: UpdateUserOptions): Promise<AccountManagerUser>;
126
+ /**
127
+ * Grants a role to a user, optionally with scope.
128
+ * This updates the user's roles and roleTenantFilter.
129
+ *
130
+ * @param client - Account Manager client
131
+ * @param options - Grant options (userId, role, optional scope)
132
+ * @returns Updated user
133
+ */
134
+ export declare function grantRole(client: AccountManagerUsersClient, options: GrantRoleOptions): Promise<AccountManagerUser>;
135
+ /**
136
+ * Revokes a role from a user, optionally removing specific scope.
137
+ *
138
+ * @param client - Account Manager client
139
+ * @param options - Revoke options (userId, role, optional scope)
140
+ * @returns Updated user
141
+ */
142
+ export declare function revokeRole(client: AccountManagerUsersClient, options: RevokeRoleOptions): Promise<AccountManagerUser>;
143
+ export type { AccountManagerUser, UserCreate, UserUpdate, UserCollection } from '../../clients/am-api.js';