@salesforce/b2c-tooling-sdk 1.24.2 → 2.1.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.
- package/data/content-schemas/componenttype.json +0 -30
- package/data/scapi-snippets/campaign-promotions.js +40 -0
- package/data/scapi-snippets/code-version-inspect.js +31 -0
- package/data/scapi-snippets/create-product.js +108 -0
- package/data/scapi-snippets/failed-job-triage.js +37 -0
- package/data/scapi-snippets/job-execution-inspect.js +52 -0
- package/data/scapi-snippets/job-execution-review.js +46 -0
- package/data/scapi-snippets/manifest.json +220 -0
- package/data/scapi-snippets/site-cartridge-inspect.js +27 -0
- package/data/tooling/index.json +83 -119
- package/dist/esm/auth/index.d.ts +2 -2
- package/dist/esm/auth/index.js +1 -1
- package/dist/esm/auth/index.js.map +1 -1
- package/dist/esm/auth/oauth-implicit.d.ts +1 -0
- package/dist/esm/auth/oauth-implicit.js +1 -0
- package/dist/esm/auth/oauth-implicit.js.map +1 -1
- package/dist/esm/auth/oauth-jwt.d.ts +18 -4
- package/dist/esm/auth/oauth-jwt.js +67 -17
- package/dist/esm/auth/oauth-jwt.js.map +1 -1
- package/dist/esm/auth/oauth-pkce-fallback.d.ts +1 -0
- package/dist/esm/auth/oauth-pkce-fallback.js +1 -0
- package/dist/esm/auth/oauth-pkce-fallback.js.map +1 -1
- package/dist/esm/auth/oauth-pkce.d.ts +1 -0
- package/dist/esm/auth/oauth-pkce.js +1 -0
- package/dist/esm/auth/oauth-pkce.js.map +1 -1
- package/dist/esm/auth/oauth.d.ts +55 -6
- package/dist/esm/auth/oauth.js +139 -21
- package/dist/esm/auth/oauth.js.map +1 -1
- package/dist/esm/auth/resolve.d.ts +37 -0
- package/dist/esm/auth/resolve.js +48 -0
- package/dist/esm/auth/resolve.js.map +1 -1
- package/dist/esm/auth/types.d.ts +44 -0
- package/dist/esm/auth/types.js.map +1 -1
- package/dist/esm/cli/base-command.d.ts +9 -0
- package/dist/esm/cli/base-command.js +31 -0
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/cli/bm-command.d.ts +15 -0
- package/dist/esm/cli/bm-command.js +25 -0
- package/dist/esm/cli/bm-command.js.map +1 -0
- package/dist/esm/cli/code-command.d.ts +14 -0
- package/dist/esm/cli/code-command.js +22 -0
- package/dist/esm/cli/code-command.js.map +1 -0
- package/dist/esm/cli/config.js +10 -1
- package/dist/esm/cli/config.js.map +1 -1
- package/dist/esm/cli/index.d.ts +5 -1
- package/dist/esm/cli/index.js +7 -1
- package/dist/esm/cli/index.js.map +1 -1
- package/dist/esm/cli/instance-command.d.ts +45 -0
- package/dist/esm/cli/instance-command.js +66 -1
- package/dist/esm/cli/instance-command.js.map +1 -1
- package/dist/esm/cli/job-command.d.ts +37 -16
- package/dist/esm/cli/job-command.js +73 -23
- package/dist/esm/cli/job-command.js.map +1 -1
- package/dist/esm/cli/mrt-command.d.ts +154 -9
- package/dist/esm/cli/mrt-command.js +299 -16
- package/dist/esm/cli/mrt-command.js.map +1 -1
- package/dist/esm/cli/oauth-command.d.ts +1 -1
- package/dist/esm/cli/oauth-command.js +2 -0
- package/dist/esm/cli/oauth-command.js.map +1 -1
- package/dist/esm/cli/webdav-command.d.ts +2 -0
- package/dist/esm/cli/webdav-command.js +1 -0
- package/dist/esm/cli/webdav-command.js.map +1 -1
- package/dist/esm/clients/cdn-zones.js +2 -5
- package/dist/esm/clients/cdn-zones.js.map +1 -1
- package/dist/esm/clients/cip.d.ts +12 -3
- package/dist/esm/clients/cip.js +85 -30
- package/dist/esm/clients/cip.js.map +1 -1
- package/dist/esm/clients/custom-apis.js +2 -5
- package/dist/esm/clients/custom-apis.js.map +1 -1
- package/dist/esm/clients/dual-backend-factory.d.ts +70 -0
- package/dist/esm/clients/dual-backend-factory.js +48 -0
- package/dist/esm/clients/dual-backend-factory.js.map +1 -0
- package/dist/esm/clients/error-utils.d.ts +62 -0
- package/dist/esm/clients/error-utils.js +98 -0
- package/dist/esm/clients/error-utils.js.map +1 -1
- package/dist/esm/clients/granular-replications.js +2 -5
- package/dist/esm/clients/granular-replications.js.map +1 -1
- package/dist/esm/clients/index.d.ts +30 -3
- package/dist/esm/clients/index.js +25 -2
- package/dist/esm/clients/index.js.map +1 -1
- package/dist/esm/clients/metrics.js +2 -5
- package/dist/esm/clients/metrics.js.map +1 -1
- package/dist/esm/clients/middleware-registry.d.ts +4 -2
- package/dist/esm/clients/middleware-registry.js +3 -1
- package/dist/esm/clients/middleware-registry.js.map +1 -1
- package/dist/esm/clients/middleware.d.ts +39 -0
- package/dist/esm/clients/middleware.js +126 -25
- package/dist/esm/clients/middleware.js.map +1 -1
- package/dist/esm/clients/mrt-b2c.js +3 -0
- package/dist/esm/clients/mrt-b2c.js.map +1 -1
- package/dist/esm/clients/mrt.d.ts +27 -10
- package/dist/esm/clients/mrt.generated.d.ts +77 -0
- package/dist/esm/clients/mrt.js +68 -0
- package/dist/esm/clients/mrt.js.map +1 -1
- package/dist/esm/clients/preferences.js +2 -5
- package/dist/esm/clients/preferences.js.map +1 -1
- package/dist/esm/clients/scapi-backend-utils.d.ts +163 -0
- package/dist/esm/clients/scapi-backend-utils.js +180 -0
- package/dist/esm/clients/scapi-backend-utils.js.map +1 -0
- package/dist/esm/clients/scapi-catalogs.d.ts +12 -0
- package/dist/esm/clients/scapi-catalogs.generated.d.ts +104 -0
- package/dist/esm/clients/scapi-catalogs.generated.js +6 -0
- package/dist/esm/clients/scapi-catalogs.generated.js.map +1 -0
- package/dist/esm/clients/scapi-catalogs.js +14 -0
- package/dist/esm/clients/scapi-catalogs.js.map +1 -0
- package/dist/esm/clients/scapi-client-factory.d.ts +81 -0
- package/dist/esm/clients/scapi-client-factory.js +84 -0
- package/dist/esm/clients/scapi-client-factory.js.map +1 -0
- package/dist/esm/clients/scapi-fallback-backend.d.ts +34 -0
- package/dist/esm/clients/scapi-fallback-backend.js +132 -0
- package/dist/esm/clients/scapi-fallback-backend.js.map +1 -0
- package/dist/esm/clients/scapi-jobs.d.ts +32 -0
- package/dist/esm/clients/scapi-jobs.generated.d.ts +535 -0
- package/dist/esm/clients/scapi-jobs.generated.js +6 -0
- package/dist/esm/clients/scapi-jobs.generated.js.map +1 -0
- package/dist/esm/clients/scapi-jobs.js +24 -0
- package/dist/esm/clients/scapi-jobs.js.map +1 -0
- package/dist/esm/clients/scapi-merchant-roles.d.ts +19 -0
- package/dist/esm/clients/scapi-merchant-roles.generated.d.ts +726 -0
- package/dist/esm/clients/scapi-merchant-roles.generated.js +6 -0
- package/dist/esm/clients/scapi-merchant-roles.generated.js.map +1 -0
- package/dist/esm/clients/scapi-merchant-roles.js +12 -0
- package/dist/esm/clients/scapi-merchant-roles.js.map +1 -0
- package/dist/esm/clients/scapi-merchant-users.d.ts +19 -0
- package/dist/esm/clients/scapi-merchant-users.generated.d.ts +300 -0
- package/dist/esm/clients/scapi-merchant-users.generated.js +6 -0
- package/dist/esm/clients/scapi-merchant-users.generated.js.map +1 -0
- package/dist/esm/clients/scapi-merchant-users.js +12 -0
- package/dist/esm/clients/scapi-merchant-users.js.map +1 -0
- package/dist/esm/clients/scapi-schemas.js +2 -5
- package/dist/esm/clients/scapi-schemas.js.map +1 -1
- package/dist/esm/clients/scapi-scope-tier.d.ts +78 -0
- package/dist/esm/clients/scapi-scope-tier.js +113 -0
- package/dist/esm/clients/scapi-scope-tier.js.map +1 -0
- package/dist/esm/clients/scapi-scripts.d.ts +17 -0
- package/dist/esm/clients/scapi-scripts.generated.d.ts +392 -0
- package/dist/esm/clients/scapi-scripts.generated.js +6 -0
- package/dist/esm/clients/scapi-scripts.generated.js.map +1 -0
- package/dist/esm/clients/scapi-scripts.js +12 -0
- package/dist/esm/clients/scapi-scripts.js.map +1 -0
- package/dist/esm/clients/scapi-sites.d.ts +26 -0
- package/dist/esm/clients/scapi-sites.generated.d.ts +500 -0
- package/dist/esm/clients/scapi-sites.generated.js +6 -0
- package/dist/esm/clients/scapi-sites.generated.js.map +1 -0
- package/dist/esm/clients/scapi-sites.js +25 -0
- package/dist/esm/clients/scapi-sites.js.map +1 -0
- package/dist/esm/clients/slas-shopper.d.ts +19 -0
- package/dist/esm/clients/slas-shopper.generated.d.ts +165 -0
- package/dist/esm/clients/slas-shopper.generated.js +6 -0
- package/dist/esm/clients/slas-shopper.generated.js.map +1 -0
- package/dist/esm/clients/slas-shopper.js +35 -0
- package/dist/esm/clients/slas-shopper.js.map +1 -0
- package/dist/esm/clients/storefront-deployments.d.ts +57 -0
- package/dist/esm/clients/storefront-deployments.generated.d.ts +558 -0
- package/dist/esm/clients/storefront-deployments.generated.js +6 -0
- package/dist/esm/clients/storefront-deployments.generated.js.map +1 -0
- package/dist/esm/clients/storefront-deployments.js +24 -0
- package/dist/esm/clients/storefront-deployments.js.map +1 -0
- package/dist/esm/clients/storefront-environments.d.ts +56 -0
- package/dist/esm/clients/storefront-environments.generated.d.ts +208 -0
- package/dist/esm/clients/storefront-environments.generated.js +6 -0
- package/dist/esm/clients/storefront-environments.generated.js.map +1 -0
- package/dist/esm/clients/storefront-environments.js +24 -0
- package/dist/esm/clients/storefront-environments.js.map +1 -0
- package/dist/esm/clients/webdav.js +4 -1
- package/dist/esm/clients/webdav.js.map +1 -1
- package/dist/esm/compat/dispatcher.d.ts +49 -0
- package/dist/esm/compat/dispatcher.js +124 -0
- package/dist/esm/compat/dispatcher.js.map +1 -0
- package/dist/esm/compat/index.d.ts +10 -0
- package/dist/esm/compat/index.js +15 -0
- package/dist/esm/compat/index.js.map +1 -0
- package/dist/esm/compat/jobs-backend.d.ts +31 -0
- package/dist/esm/compat/jobs-backend.js +76 -0
- package/dist/esm/compat/jobs-backend.js.map +1 -0
- package/dist/esm/config/dw-json.d.ts +4 -0
- package/dist/esm/config/dw-json.js.map +1 -1
- package/dist/esm/config/index.d.ts +1 -1
- package/dist/esm/config/index.js.map +1 -1
- package/dist/esm/config/mapping.d.ts +2 -5
- package/dist/esm/config/mapping.js +25 -1
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/resolved-config.d.ts +2 -2
- package/dist/esm/config/resolved-config.js.map +1 -1
- package/dist/esm/config/resolver.js +12 -0
- package/dist/esm/config/resolver.js.map +1 -1
- package/dist/esm/config/sources/env-source.d.ts +10 -1
- package/dist/esm/config/sources/env-source.js +46 -1
- package/dist/esm/config/sources/env-source.js.map +1 -1
- package/dist/esm/config/types.d.ts +22 -3
- package/dist/esm/docs/search.js +2 -25
- package/dist/esm/docs/search.js.map +1 -1
- package/dist/esm/guidance/catalog.d.ts +37 -0
- package/dist/esm/guidance/catalog.js +282 -0
- package/dist/esm/guidance/catalog.js.map +1 -0
- package/dist/esm/guidance/index.d.ts +8 -0
- package/dist/esm/guidance/index.js +14 -0
- package/dist/esm/guidance/index.js.map +1 -0
- package/dist/esm/guidance/markdown.d.ts +10 -0
- package/dist/esm/guidance/markdown.js +52 -0
- package/dist/esm/guidance/markdown.js.map +1 -0
- package/dist/esm/guidance/types.d.ts +96 -0
- package/dist/esm/guidance/types.js +17 -0
- package/dist/esm/guidance/types.js.map +1 -0
- package/dist/esm/index.d.ts +14 -5
- package/dist/esm/index.js +14 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/instance/index.d.ts +96 -2
- package/dist/esm/instance/index.js +98 -5
- package/dist/esm/instance/index.js.map +1 -1
- package/dist/esm/operations/bm-roles/backend.d.ts +4 -0
- package/dist/esm/operations/bm-roles/backend.js +11 -0
- package/dist/esm/operations/bm-roles/backend.js.map +1 -0
- package/dist/esm/operations/bm-roles/index.d.ts +6 -0
- package/dist/esm/operations/bm-roles/index.js +4 -0
- package/dist/esm/operations/bm-roles/index.js.map +1 -1
- package/dist/esm/operations/bm-roles/ocapi-backend.d.ts +17 -0
- package/dist/esm/operations/bm-roles/ocapi-backend.js +151 -0
- package/dist/esm/operations/bm-roles/ocapi-backend.js.map +1 -0
- package/dist/esm/operations/bm-roles/roles.js +13 -17
- package/dist/esm/operations/bm-roles/roles.js.map +1 -1
- package/dist/esm/operations/bm-roles/scapi-backend.d.ts +27 -0
- package/dist/esm/operations/bm-roles/scapi-backend.js +138 -0
- package/dist/esm/operations/bm-roles/scapi-backend.js.map +1 -0
- package/dist/esm/operations/bm-roles/types.d.ts +49 -0
- package/dist/esm/operations/bm-roles/types.js +2 -0
- package/dist/esm/operations/bm-roles/types.js.map +1 -0
- package/dist/esm/operations/bm-users/backend.d.ts +4 -0
- package/dist/esm/operations/bm-users/backend.js +11 -0
- package/dist/esm/operations/bm-users/backend.js.map +1 -0
- package/dist/esm/operations/bm-users/index.d.ts +11 -3
- package/dist/esm/operations/bm-users/index.js +9 -3
- package/dist/esm/operations/bm-users/index.js.map +1 -1
- package/dist/esm/operations/bm-users/ocapi-backend.d.ts +13 -0
- package/dist/esm/operations/bm-users/ocapi-backend.js +92 -0
- package/dist/esm/operations/bm-users/ocapi-backend.js.map +1 -0
- package/dist/esm/operations/bm-users/scapi-backend.d.ts +23 -0
- package/dist/esm/operations/bm-users/scapi-backend.js +199 -0
- package/dist/esm/operations/bm-users/scapi-backend.js.map +1 -0
- package/dist/esm/operations/bm-users/types.d.ts +99 -0
- package/dist/esm/operations/bm-users/types.js +2 -0
- package/dist/esm/operations/bm-users/types.js.map +1 -0
- package/dist/esm/operations/bm-users/users.d.ts +4 -3
- package/dist/esm/operations/bm-users/users.js +23 -19
- package/dist/esm/operations/bm-users/users.js.map +1 -1
- package/dist/esm/operations/cap/install.js +23 -45
- package/dist/esm/operations/cap/install.js.map +1 -1
- package/dist/esm/operations/cap/list.js +4 -8
- package/dist/esm/operations/cap/list.js.map +1 -1
- package/dist/esm/operations/cap/uninstall.js +17 -37
- package/dist/esm/operations/cap/uninstall.js.map +1 -1
- package/dist/esm/operations/catalogs/catalogs-backend.d.ts +4 -0
- package/dist/esm/operations/catalogs/catalogs-backend.js +16 -0
- package/dist/esm/operations/catalogs/catalogs-backend.js.map +1 -0
- package/dist/esm/operations/catalogs/catalogs-types.d.ts +14 -0
- package/dist/esm/operations/catalogs/catalogs-types.js +2 -0
- package/dist/esm/operations/catalogs/catalogs-types.js.map +1 -0
- package/dist/esm/operations/catalogs/index.d.ts +7 -0
- package/dist/esm/operations/catalogs/index.js +10 -0
- package/dist/esm/operations/catalogs/index.js.map +1 -0
- package/dist/esm/operations/catalogs/ocapi-catalogs-backend.d.ts +8 -0
- package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js +36 -0
- package/dist/esm/operations/catalogs/ocapi-catalogs-backend.js.map +1 -0
- package/dist/esm/operations/catalogs/scapi-catalogs-backend.d.ts +15 -0
- package/dist/esm/operations/catalogs/scapi-catalogs-backend.js +42 -0
- package/dist/esm/operations/catalogs/scapi-catalogs-backend.js.map +1 -0
- package/dist/esm/operations/cip/index.js +10 -2
- package/dist/esm/operations/cip/index.js.map +1 -1
- package/dist/esm/operations/cip/reports.js +19 -3
- package/dist/esm/operations/cip/reports.js.map +1 -1
- package/dist/esm/operations/cip/types.d.ts +8 -4
- package/dist/esm/operations/code/deploy.d.ts +3 -0
- package/dist/esm/operations/code/deploy.js +9 -3
- package/dist/esm/operations/code/deploy.js.map +1 -1
- package/dist/esm/operations/code/download.d.ts +3 -0
- package/dist/esm/operations/code/download.js +5 -5
- package/dist/esm/operations/code/download.js.map +1 -1
- package/dist/esm/operations/code/index.d.ts +7 -1
- package/dist/esm/operations/code/index.js +5 -1
- package/dist/esm/operations/code/index.js.map +1 -1
- package/dist/esm/operations/code/ocapi-scripts-backend.d.ts +12 -0
- package/dist/esm/operations/code/ocapi-scripts-backend.js +40 -0
- package/dist/esm/operations/code/ocapi-scripts-backend.js.map +1 -0
- package/dist/esm/operations/code/scapi-scripts-backend.d.ts +22 -0
- package/dist/esm/operations/code/scapi-scripts-backend.js +94 -0
- package/dist/esm/operations/code/scapi-scripts-backend.js.map +1 -0
- package/dist/esm/operations/code/scripts-backend.d.ts +17 -0
- package/dist/esm/operations/code/scripts-backend.js +40 -0
- package/dist/esm/operations/code/scripts-backend.js.map +1 -0
- package/dist/esm/operations/code/scripts-types.d.ts +43 -0
- package/dist/esm/operations/code/scripts-types.js +2 -0
- package/dist/esm/operations/code/scripts-types.js.map +1 -0
- package/dist/esm/operations/code/upload-files.d.ts +6 -0
- package/dist/esm/operations/code/upload-files.js +58 -7
- package/dist/esm/operations/code/upload-files.js.map +1 -1
- package/dist/esm/operations/code/versions.d.ts +0 -20
- package/dist/esm/operations/code/versions.js +16 -51
- package/dist/esm/operations/code/versions.js.map +1 -1
- package/dist/esm/operations/code/watch.d.ts +3 -0
- package/dist/esm/operations/code/watch.js +3 -2
- package/dist/esm/operations/code/watch.js.map +1 -1
- package/dist/esm/operations/jobs/discover.d.ts +1 -1
- package/dist/esm/operations/jobs/discover.js +51 -21
- package/dist/esm/operations/jobs/discover.js.map +1 -1
- package/dist/esm/operations/jobs/index.d.ts +14 -57
- package/dist/esm/operations/jobs/index.js +15 -59
- package/dist/esm/operations/jobs/index.js.map +1 -1
- package/dist/esm/operations/jobs/ocapi-mapping.d.ts +34 -0
- package/dist/esm/operations/jobs/ocapi-mapping.js +100 -0
- package/dist/esm/operations/jobs/ocapi-mapping.js.map +1 -0
- package/dist/esm/operations/jobs/run-system-job.d.ts +81 -0
- package/dist/esm/operations/jobs/run-system-job.js +137 -0
- package/dist/esm/operations/jobs/run-system-job.js.map +1 -0
- package/dist/esm/operations/jobs/run.js +16 -4
- package/dist/esm/operations/jobs/run.js.map +1 -1
- package/dist/esm/operations/jobs/scapi-ops.d.ts +61 -0
- package/dist/esm/operations/jobs/scapi-ops.js +214 -0
- package/dist/esm/operations/jobs/scapi-ops.js.map +1 -0
- package/dist/esm/operations/jobs/site-archive.d.ts +7 -0
- package/dist/esm/operations/jobs/site-archive.js +28 -66
- package/dist/esm/operations/jobs/site-archive.js.map +1 -1
- package/dist/esm/operations/jobs/types.d.ts +46 -0
- package/dist/esm/operations/jobs/types.js +2 -0
- package/dist/esm/operations/jobs/types.js.map +1 -0
- package/dist/esm/operations/jobs/wait-canonical.d.ts +28 -0
- package/dist/esm/operations/jobs/wait-canonical.js +48 -0
- package/dist/esm/operations/jobs/wait-canonical.js.map +1 -0
- package/dist/esm/operations/mrt/bundle.d.ts +164 -2
- package/dist/esm/operations/mrt/bundle.js +315 -9
- package/dist/esm/operations/mrt/bundle.js.map +1 -1
- package/dist/esm/operations/mrt/deployment.d.ts +248 -0
- package/dist/esm/operations/mrt/deployment.js +252 -0
- package/dist/esm/operations/mrt/deployment.js.map +1 -1
- package/dist/esm/operations/mrt/env-var.d.ts +135 -0
- package/dist/esm/operations/mrt/env-var.js +203 -0
- package/dist/esm/operations/mrt/env-var.js.map +1 -1
- package/dist/esm/operations/mrt/index.d.ts +10 -8
- package/dist/esm/operations/mrt/index.js +6 -4
- package/dist/esm/operations/mrt/index.js.map +1 -1
- package/dist/esm/operations/mrt/mrt-backend.d.ts +117 -0
- package/dist/esm/operations/mrt/mrt-backend.js +84 -0
- package/dist/esm/operations/mrt/mrt-backend.js.map +1 -0
- package/dist/esm/operations/mrt/push.d.ts +285 -1
- package/dist/esm/operations/mrt/push.js +382 -1
- package/dist/esm/operations/mrt/push.js.map +1 -1
- package/dist/esm/operations/sites/cartridges.d.ts +10 -8
- package/dist/esm/operations/sites/cartridges.js +35 -67
- package/dist/esm/operations/sites/cartridges.js.map +1 -1
- package/dist/esm/operations/sites/index.d.ts +10 -6
- package/dist/esm/operations/sites/index.js +9 -6
- package/dist/esm/operations/sites/index.js.map +1 -1
- package/dist/esm/operations/sites/ocapi-sites-backend.d.ts +20 -0
- package/dist/esm/operations/sites/ocapi-sites-backend.js +98 -0
- package/dist/esm/operations/sites/ocapi-sites-backend.js.map +1 -0
- package/dist/esm/operations/sites/scapi-sites-backend.d.ts +33 -0
- package/dist/esm/operations/sites/scapi-sites-backend.js +166 -0
- package/dist/esm/operations/sites/scapi-sites-backend.js.map +1 -0
- package/dist/esm/operations/sites/sites-backend.d.ts +9 -0
- package/dist/esm/operations/sites/sites-backend.js +16 -0
- package/dist/esm/operations/sites/sites-backend.js.map +1 -0
- package/dist/esm/operations/sites/sites-scopes.d.ts +2 -0
- package/dist/esm/operations/sites/sites-scopes.js +16 -0
- package/dist/esm/operations/sites/sites-scopes.js.map +1 -0
- package/dist/esm/operations/sites/sites-types.d.ts +50 -0
- package/dist/esm/operations/sites/sites-types.js +2 -0
- package/dist/esm/operations/sites/sites-types.js.map +1 -0
- package/dist/esm/safety/safety-guard.d.ts +1 -0
- package/dist/esm/safety/safety-guard.js +2 -1
- package/dist/esm/safety/safety-guard.js.map +1 -1
- package/dist/esm/safety/safety-middleware.d.ts +7 -3
- package/dist/esm/safety/safety-middleware.js +13 -9
- package/dist/esm/safety/safety-middleware.js.map +1 -1
- package/dist/esm/safety/types.d.ts +2 -2
- package/dist/esm/scaffold/sources.js +6 -9
- package/dist/esm/scaffold/sources.js.map +1 -1
- package/dist/esm/scapi/auth-primitives.d.ts +3 -0
- package/dist/esm/scapi/auth-primitives.js +104 -0
- package/dist/esm/scapi/auth-primitives.js.map +1 -0
- package/dist/esm/scapi/authentication.d.ts +30 -0
- package/dist/esm/scapi/authentication.js +136 -0
- package/dist/esm/scapi/authentication.js.map +1 -0
- package/dist/esm/scapi/catalog.d.ts +29 -0
- package/dist/esm/scapi/catalog.js +81 -0
- package/dist/esm/scapi/catalog.js.map +1 -0
- package/dist/esm/scapi/index.d.ts +12 -0
- package/dist/esm/scapi/index.js +13 -0
- package/dist/esm/scapi/index.js.map +1 -0
- package/dist/esm/scapi/request.d.ts +28 -0
- package/dist/esm/scapi/request.js +273 -0
- package/dist/esm/scapi/request.js.map +1 -0
- package/dist/esm/scapi/runtime.d.ts +27 -0
- package/dist/esm/scapi/runtime.js +161 -0
- package/dist/esm/scapi/runtime.js.map +1 -0
- package/dist/esm/scapi/snippets.d.ts +22 -0
- package/dist/esm/scapi/snippets.js +140 -0
- package/dist/esm/scapi/snippets.js.map +1 -0
- package/dist/esm/scapi/worker-source.d.ts +2 -0
- package/dist/esm/scapi/worker-source.js +101 -0
- package/dist/esm/scapi/worker-source.js.map +1 -0
- package/dist/esm/search/ranking.d.ts +12 -0
- package/dist/esm/search/ranking.js +28 -0
- package/dist/esm/search/ranking.js.map +1 -0
- package/dist/esm/skills/sources.d.ts +2 -2
- package/dist/esm/skills/sources.js +18 -2
- package/dist/esm/skills/sources.js.map +1 -1
- package/dist/esm/skills/types.d.ts +1 -1
- package/dist/esm/slas/token.js +33 -94
- package/dist/esm/slas/token.js.map +1 -1
- package/dist/esm/slas/types.d.ts +5 -0
- package/dist/esm/test-utils/config-isolation.js +2 -2
- package/dist/esm/test-utils/config-isolation.js.map +1 -1
- package/node_modules/@salesforce/b2c-api-schemas/README.md +23 -0
- package/node_modules/@salesforce/b2c-api-schemas/manifest.json +576 -0
- package/node_modules/@salesforce/b2c-api-schemas/package.json +15 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +11490 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +3589 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +6544 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +7148 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +4411 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +643 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +295 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +2036 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +327 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +234 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +1542 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +405 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +2531 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +7944 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +292 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +2537 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +517 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +589 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +3600 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +2319 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +658 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +2649 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +6615 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +2103 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1760 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +640 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1263 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1259 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +760 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +1047 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1929 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +1542 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +1093 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +1324 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +325 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +631 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +1036 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +5175 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +866 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +747 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +5076 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +509 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +517 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +2961 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1889 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +7014 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1898 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +622 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +192 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +913 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +630 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +223 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +423 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +1088 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +798 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +607 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1418 -0
- package/package.json +24 -3
- package/specs/dx-scripts-v1.yaml +409 -0
- package/specs/merchant-roles-v1.yaml +1085 -0
- package/specs/merchant-users-v1.yaml +398 -0
- package/specs/mrt-api-v1.json +105 -0
- package/specs/operations-jobs-v1.yaml +793 -0
- package/specs/product-catalogs-v1.yaml +111 -0
- package/specs/site-sites-v1.yaml +667 -0
- package/specs/slas-shopper-v1.yaml +83 -0
- package/specs/storefront-deployments-v1.yaml +630 -0
- package/specs/storefront-environments-v1.yaml +272 -0
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { throwOcapiError } from '../../clients/error-utils.js';
|
|
2
|
+
import { SCAPI_MERCHANT_ROLES_READ_SCOPES, SCAPI_MERCHANT_ROLES_RW_SCOPES } from '../../clients/scapi-merchant-roles.js';
|
|
3
|
+
// SCAPI Merchant Roles scopes named in the OCAPI-deprecation message.
|
|
4
|
+
const ROLES_READ_SCOPES = [...SCAPI_MERCHANT_ROLES_READ_SCOPES, ...SCAPI_MERCHANT_ROLES_RW_SCOPES];
|
|
5
|
+
const ROLES_RW_SCOPES = SCAPI_MERCHANT_ROLES_RW_SCOPES;
|
|
2
6
|
/**
|
|
3
7
|
* Lists all access roles on a B2C Commerce instance.
|
|
4
8
|
*
|
|
@@ -20,7 +24,7 @@ export async function listBmRoles(instance, options = {}) {
|
|
|
20
24
|
params: { query: { start, count, select: '(**)' } },
|
|
21
25
|
});
|
|
22
26
|
if (error) {
|
|
23
|
-
|
|
27
|
+
throwOcapiError(error, response, 'Failed to list roles', ROLES_READ_SCOPES);
|
|
24
28
|
}
|
|
25
29
|
return data;
|
|
26
30
|
}
|
|
@@ -44,7 +48,7 @@ export async function getBmRole(instance, roleId, options = {}) {
|
|
|
44
48
|
params: { path: { id: roleId }, query: { expand } },
|
|
45
49
|
});
|
|
46
50
|
if (error) {
|
|
47
|
-
|
|
51
|
+
throwOcapiError(error, response, `Failed to get role ${roleId}`, ROLES_READ_SCOPES);
|
|
48
52
|
}
|
|
49
53
|
return data;
|
|
50
54
|
}
|
|
@@ -67,7 +71,7 @@ export async function createBmRole(instance, roleId, role = {}) {
|
|
|
67
71
|
body: { id: roleId, ...role },
|
|
68
72
|
});
|
|
69
73
|
if (error) {
|
|
70
|
-
|
|
74
|
+
throwOcapiError(error, response, `Failed to create role ${roleId}`, ROLES_RW_SCOPES);
|
|
71
75
|
}
|
|
72
76
|
return data;
|
|
73
77
|
}
|
|
@@ -89,7 +93,7 @@ export async function deleteBmRole(instance, roleId) {
|
|
|
89
93
|
params: { path: { id: roleId } },
|
|
90
94
|
});
|
|
91
95
|
if (error) {
|
|
92
|
-
|
|
96
|
+
throwOcapiError(error, response, `Failed to delete role ${roleId}`, ROLES_RW_SCOPES);
|
|
93
97
|
}
|
|
94
98
|
}
|
|
95
99
|
/**
|
|
@@ -110,9 +114,7 @@ export async function grantBmRole(instance, roleId, login) {
|
|
|
110
114
|
params: { path: { id: roleId, login } },
|
|
111
115
|
});
|
|
112
116
|
if (error) {
|
|
113
|
-
|
|
114
|
-
cause: error,
|
|
115
|
-
});
|
|
117
|
+
throwOcapiError(error, response, `Failed to grant role ${roleId} to ${login}`, ROLES_RW_SCOPES);
|
|
116
118
|
}
|
|
117
119
|
return data;
|
|
118
120
|
}
|
|
@@ -133,9 +135,7 @@ export async function revokeBmRole(instance, roleId, login) {
|
|
|
133
135
|
params: { path: { id: roleId, login } },
|
|
134
136
|
});
|
|
135
137
|
if (error) {
|
|
136
|
-
|
|
137
|
-
cause: error,
|
|
138
|
-
});
|
|
138
|
+
throwOcapiError(error, response, `Failed to revoke role ${roleId} from ${login}`, ROLES_RW_SCOPES);
|
|
139
139
|
}
|
|
140
140
|
}
|
|
141
141
|
/**
|
|
@@ -156,9 +156,7 @@ export async function getBmRolePermissions(instance, roleId) {
|
|
|
156
156
|
params: { path: { id: roleId } },
|
|
157
157
|
});
|
|
158
158
|
if (error) {
|
|
159
|
-
|
|
160
|
-
cause: error,
|
|
161
|
-
});
|
|
159
|
+
throwOcapiError(error, response, `Failed to get permissions for role ${roleId}`, ROLES_READ_SCOPES);
|
|
162
160
|
}
|
|
163
161
|
return data;
|
|
164
162
|
}
|
|
@@ -185,9 +183,7 @@ export async function setBmRolePermissions(instance, roleId, permissions) {
|
|
|
185
183
|
body: permissions,
|
|
186
184
|
});
|
|
187
185
|
if (error) {
|
|
188
|
-
|
|
189
|
-
cause: error,
|
|
190
|
-
});
|
|
186
|
+
throwOcapiError(error, response, `Failed to set permissions for role ${roleId}`, ROLES_RW_SCOPES);
|
|
191
187
|
}
|
|
192
188
|
return data;
|
|
193
189
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"roles.js","sourceRoot":"","sources":["../../../../src/operations/bm-roles/roles.ts"],"names":[],"mappings":"AAYA,OAAO,EAAC,
|
|
1
|
+
{"version":3,"file":"roles.js","sourceRoot":"","sources":["../../../../src/operations/bm-roles/roles.ts"],"names":[],"mappings":"AAYA,OAAO,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAC,gCAAgC,EAAE,8BAA8B,EAAC,MAAM,uCAAuC,CAAC;AAEvH,sEAAsE;AACtE,MAAM,iBAAiB,GAAG,CAAC,GAAG,gCAAgC,EAAE,GAAG,8BAA8B,CAAC,CAAC;AACnG,MAAM,eAAe,GAAG,8BAA8B,CAAC;AAmCvD;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,QAAqB,EAAE,UAA8B,EAAE;IACvF,MAAM,EAAC,KAAK,EAAE,KAAK,EAAC,GAAG,OAAO,CAAC;IAE/B,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;QACjE,MAAM,EAAE,EAAC,KAAK,EAAE,EAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAC,EAAC;KAChD,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,sBAAsB,EAAE,iBAAiB,CAAC,CAAC;IAC9E,CAAC;IAED,OAAO,IAAe,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,QAAqB,EACrB,MAAc,EACd,UAA4B,EAAE;IAE9B,MAAM,EAAC,MAAM,EAAC,GAAG,OAAO,CAAC;IAEzB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE;QACtE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAE,KAAK,EAAE,EAAC,MAAM,EAAC,EAAC;KAC9C,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,sBAAsB,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC;IACtF,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAqB,EACrB,MAAc,EACd,OAA+B,EAAE;IAEjC,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,aAAa,EAAE;QACtE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;QAC5B,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAkC;KAC7D,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,yBAAyB,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,IAAc,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB,EAAE,MAAc;IACtE,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,EAAE;QACnE,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;KAC7B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,yBAAyB,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC;IACvF,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,QAAqB,EACrB,MAAc,EACd,KAAa;IAEb,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,EAAE;QACpF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAC,EAAC;KACpC,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,wBAAwB,MAAM,OAAO,KAAK,EAAE,EAAE,eAAe,CAAC,CAAC;IAClG,CAAC;IAED,OAAO,IAAqC,CAAC;AAC/C,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAqB,EAAE,MAAc,EAAE,KAAa;IACrF,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,2BAA2B,EAAE;QACjF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAC,EAAC;KACpC,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,yBAAyB,MAAM,SAAS,KAAK,EAAE,EAAE,eAAe,CAAC,CAAC;IACrG,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,QAAqB,EAAE,MAAc;IAC9E,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,EAAE;QAClF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;KAC7B,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,sCAAsC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC;IACtG,CAAC;IAED,OAAO,IAAyB,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,QAAqB,EACrB,MAAc,EACd,WAA8B;IAE9B,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,yBAAyB,EAAE;QAClF,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,EAAE,EAAE,MAAM,EAAC,EAAC;QAC5B,IAAI,EAAE,WAAwD;KAC/D,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,sCAAsC,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC;IACpG,CAAC;IAED,OAAO,IAAyB,CAAC;AACnC,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { AuthStrategy } from '../../auth/types.js';
|
|
2
|
+
import type { RolesBackend, RoleInfo, ListRolesResult, ListRolesOptions, RolePermissionsInfo, CreateRoleInput } from './types.js';
|
|
3
|
+
export interface ScapiRolesBackendConfig {
|
|
4
|
+
shortCode: string;
|
|
5
|
+
tenantId: string;
|
|
6
|
+
auth: AuthStrategy;
|
|
7
|
+
/** Unused by Roles; accepted for compatibility with the dual-backend factory. */
|
|
8
|
+
instance?: unknown;
|
|
9
|
+
}
|
|
10
|
+
export declare class ScapiRolesBackend implements RolesBackend {
|
|
11
|
+
private config;
|
|
12
|
+
readonly name: "scapi";
|
|
13
|
+
private organizationId;
|
|
14
|
+
private scopeTier;
|
|
15
|
+
constructor(config: ScapiRolesBackendConfig);
|
|
16
|
+
listRoles(options?: ListRolesOptions): Promise<ListRolesResult>;
|
|
17
|
+
getRole(roleId: string, options?: {
|
|
18
|
+
expand?: ('users' | 'permissions')[];
|
|
19
|
+
}): Promise<RoleInfo>;
|
|
20
|
+
createRole(roleId: string, input?: CreateRoleInput): Promise<RoleInfo>;
|
|
21
|
+
deleteRole(roleId: string): Promise<void>;
|
|
22
|
+
getPermissions(roleId: string): Promise<RolePermissionsInfo>;
|
|
23
|
+
setPermissions(roleId: string, permissions: RolePermissionsInfo): Promise<RolePermissionsInfo>;
|
|
24
|
+
grantRole(roleId: string, login: string): Promise<void>;
|
|
25
|
+
revokeRole(roleId: string, login: string): Promise<void>;
|
|
26
|
+
private buildClient;
|
|
27
|
+
}
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { createScapiMerchantRolesClient, SCAPI_MERCHANT_ROLES_RW_SCOPES, SCAPI_MERCHANT_ROLES_READ_SCOPES, } from '../../clients/scapi-merchant-roles.js';
|
|
2
|
+
import { buildTenantScope, toOrganizationId } from '../../clients/custom-apis.js';
|
|
3
|
+
import { ScopeTierManager } from '../../clients/scapi-scope-tier.js';
|
|
4
|
+
import { createScapiRequestError } from '../../clients/scapi-backend-utils.js';
|
|
5
|
+
function mapScapiRole(scapi) {
|
|
6
|
+
return {
|
|
7
|
+
id: scapi.id ?? '',
|
|
8
|
+
description: scapi.description,
|
|
9
|
+
userCount: scapi.userCount,
|
|
10
|
+
userManager: scapi.userManager,
|
|
11
|
+
permissions: scapi.permissions,
|
|
12
|
+
_raw: scapi,
|
|
13
|
+
};
|
|
14
|
+
}
|
|
15
|
+
export class ScapiRolesBackend {
|
|
16
|
+
config;
|
|
17
|
+
name = 'scapi';
|
|
18
|
+
organizationId;
|
|
19
|
+
scopeTier;
|
|
20
|
+
constructor(config) {
|
|
21
|
+
this.config = config;
|
|
22
|
+
this.organizationId = toOrganizationId(config.tenantId);
|
|
23
|
+
this.scopeTier = new ScopeTierManager({
|
|
24
|
+
buildClient: (scopes) => this.buildClient(scopes),
|
|
25
|
+
rwScopes: SCAPI_MERCHANT_ROLES_RW_SCOPES,
|
|
26
|
+
readScopes: SCAPI_MERCHANT_ROLES_READ_SCOPES,
|
|
27
|
+
domainName: 'Roles',
|
|
28
|
+
});
|
|
29
|
+
}
|
|
30
|
+
async listRoles(options = {}) {
|
|
31
|
+
const { start = 0, count = 25, expand } = options;
|
|
32
|
+
return this.scopeTier.tryRead(async (client) => {
|
|
33
|
+
const { data, error, response } = await client.GET('/organizations/{organizationId}/roles', {
|
|
34
|
+
params: {
|
|
35
|
+
path: { organizationId: this.organizationId },
|
|
36
|
+
query: { limit: count, offset: start, expand },
|
|
37
|
+
},
|
|
38
|
+
});
|
|
39
|
+
if (error || !data) {
|
|
40
|
+
throw createScapiRequestError(error, response, 'Failed to list roles');
|
|
41
|
+
}
|
|
42
|
+
const result = data;
|
|
43
|
+
return {
|
|
44
|
+
total: result.total ?? 0,
|
|
45
|
+
start: result.offset ?? start,
|
|
46
|
+
count: result.limit ?? count,
|
|
47
|
+
hits: (result.data ?? []).map(mapScapiRole),
|
|
48
|
+
};
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
async getRole(roleId, options) {
|
|
52
|
+
return this.scopeTier.tryRead(async (client) => {
|
|
53
|
+
const { data, error, response } = await client.GET('/organizations/{organizationId}/roles/{roleId}', {
|
|
54
|
+
params: {
|
|
55
|
+
path: { organizationId: this.organizationId, roleId },
|
|
56
|
+
query: { expand: options?.expand },
|
|
57
|
+
},
|
|
58
|
+
});
|
|
59
|
+
if (error || !data) {
|
|
60
|
+
throw createScapiRequestError(error, response, `Failed to get role ${roleId}`);
|
|
61
|
+
}
|
|
62
|
+
return mapScapiRole(data);
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
async createRole(roleId, input) {
|
|
66
|
+
const client = this.scopeTier.getClientForWrite();
|
|
67
|
+
const body = {
|
|
68
|
+
id: roleId,
|
|
69
|
+
description: input?.description,
|
|
70
|
+
};
|
|
71
|
+
const { data, error, response } = await client.PUT('/organizations/{organizationId}/roles/{roleId}', {
|
|
72
|
+
params: { path: { organizationId: this.organizationId, roleId } },
|
|
73
|
+
body,
|
|
74
|
+
});
|
|
75
|
+
if (error || !data) {
|
|
76
|
+
throw createScapiRequestError(error, response, `Failed to create role ${roleId}`);
|
|
77
|
+
}
|
|
78
|
+
return mapScapiRole(data);
|
|
79
|
+
}
|
|
80
|
+
async deleteRole(roleId) {
|
|
81
|
+
const client = this.scopeTier.getClientForWrite();
|
|
82
|
+
const { error, response } = await client.DELETE('/organizations/{organizationId}/roles/{roleId}', {
|
|
83
|
+
params: { path: { organizationId: this.organizationId, roleId } },
|
|
84
|
+
});
|
|
85
|
+
if (error) {
|
|
86
|
+
throw createScapiRequestError(error, response, `Failed to delete role ${roleId}`);
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
async getPermissions(roleId) {
|
|
90
|
+
return this.scopeTier.tryRead(async (client) => {
|
|
91
|
+
const { data, error, response } = await client.GET('/organizations/{organizationId}/roles/{roleId}/permissions', {
|
|
92
|
+
params: { path: { organizationId: this.organizationId, roleId } },
|
|
93
|
+
});
|
|
94
|
+
if (error || !data) {
|
|
95
|
+
throw createScapiRequestError(error, response, `Failed to get permissions for role ${roleId}`);
|
|
96
|
+
}
|
|
97
|
+
return data;
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
async setPermissions(roleId, permissions) {
|
|
101
|
+
const client = this.scopeTier.getClientForWrite();
|
|
102
|
+
const { data, error, response } = await client.PUT('/organizations/{organizationId}/roles/{roleId}/permissions', {
|
|
103
|
+
params: { path: { organizationId: this.organizationId, roleId } },
|
|
104
|
+
body: permissions,
|
|
105
|
+
});
|
|
106
|
+
if (error || !data) {
|
|
107
|
+
throw createScapiRequestError(error, response, `Failed to set permissions for role ${roleId}`);
|
|
108
|
+
}
|
|
109
|
+
return data;
|
|
110
|
+
}
|
|
111
|
+
async grantRole(roleId, login) {
|
|
112
|
+
const client = this.scopeTier.getClientForWrite();
|
|
113
|
+
const { error, response } = await client.PUT('/organizations/{organizationId}/roles/{roleId}/users/{login}', {
|
|
114
|
+
params: { path: { organizationId: this.organizationId, roleId, login } },
|
|
115
|
+
});
|
|
116
|
+
if (error) {
|
|
117
|
+
throw createScapiRequestError(error, response, `Failed to grant role ${roleId} to ${login}`);
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
async revokeRole(roleId, login) {
|
|
121
|
+
const client = this.scopeTier.getClientForWrite();
|
|
122
|
+
const { error, response } = await client.DELETE('/organizations/{organizationId}/roles/{roleId}/users/{login}', {
|
|
123
|
+
params: { path: { organizationId: this.organizationId, roleId, login } },
|
|
124
|
+
});
|
|
125
|
+
if (error) {
|
|
126
|
+
throw createScapiRequestError(error, response, `Failed to revoke role ${roleId} from ${login}`);
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
buildClient(scopes) {
|
|
130
|
+
const clientConfig = {
|
|
131
|
+
shortCode: this.config.shortCode,
|
|
132
|
+
tenantId: this.config.tenantId,
|
|
133
|
+
scopes: [...scopes, buildTenantScope(this.config.tenantId)],
|
|
134
|
+
};
|
|
135
|
+
return createScapiMerchantRolesClient(clientConfig, this.config.auth);
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
//# sourceMappingURL=scapi-backend.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scapi-backend.js","sourceRoot":"","sources":["../../../../src/operations/bm-roles/scapi-backend.ts"],"names":[],"mappings":"AAcA,OAAO,EACL,8BAA8B,EAC9B,8BAA8B,EAC9B,gCAAgC,GAKjC,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAC,gBAAgB,EAAE,gBAAgB,EAAC,MAAM,8BAA8B,CAAC;AAChF,OAAO,EAAC,gBAAgB,EAAC,MAAM,mCAAmC,CAAC;AACnE,OAAO,EAAC,uBAAuB,EAAC,MAAM,sCAAsC,CAAC;AAE7E,SAAS,YAAY,CAAC,KAAgB;IACpC,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE;QAClB,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,IAAI,EAAE,KAAK;KACZ,CAAC;AACJ,CAAC;AAUD,MAAM,OAAO,iBAAiB;IAMR;IALX,IAAI,GAAG,OAAgB,CAAC;IAEzB,cAAc,CAAS;IACvB,SAAS,CAA6C;IAE9D,YAAoB,MAA+B;QAA/B,WAAM,GAAN,MAAM,CAAyB;QACjD,IAAI,CAAC,cAAc,GAAG,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAA2B;YAC9D,WAAW,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;YACjD,QAAQ,EAAE,8BAA8B;YACxC,UAAU,EAAE,gCAAgC;YAC5C,UAAU,EAAE,OAAO;SACpB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,UAA4B,EAAE;QAC5C,MAAM,EAAC,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,EAAE,EAAE,MAAM,EAAC,GAAG,OAAO,CAAC;QAEhD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC7C,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,uCAAuC,EAAE;gBACxF,MAAM,EAAE;oBACN,IAAI,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC;oBAC3C,KAAK,EAAE,EAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAC;iBAC7C;aACF,CAAC,CAAC;YACH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnB,MAAM,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YACzE,CAAC;YACD,MAAM,MAAM,GAAG,IAAkB,CAAC;YAClC,OAAO;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;gBACxB,KAAK,EAAE,MAAM,CAAC,MAAM,IAAI,KAAK;gBAC7B,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,KAAK;gBAC5B,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC;aAC5C,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAc,EAAE,OAAgD;QAC5E,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC7C,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,gDAAgD,EAAE;gBACjG,MAAM,EAAE;oBACN,IAAI,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAC;oBACnD,KAAK,EAAE,EAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAC;iBACjC;aACF,CAAC,CAAC;YACH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnB,MAAM,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,sBAAsB,MAAM,EAAE,CAAC,CAAC;YACjF,CAAC;YACD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,KAAuB;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAClD,MAAM,IAAI,GAAc;YACtB,EAAE,EAAE,MAAM;YACV,WAAW,EAAE,KAAK,EAAE,WAAW;SAChC,CAAC;QACF,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,gDAAgD,EAAE;YACjG,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAC,EAAC;YAC7D,IAAI;SACL,CAAC,CAAC;QACH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,yBAAyB,MAAM,EAAE,CAAC,CAAC;QACpF,CAAC;QACD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAAc;QAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAClD,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,gDAAgD,EAAE;YAC9F,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAC,EAAC;SAC9D,CAAC,CAAC;QACH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,yBAAyB,MAAM,EAAE,CAAC,CAAC;QACpF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,MAAc;QACjC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC7C,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,4DAA4D,EAAE;gBAC7G,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAC,EAAC;aAC9D,CAAC,CAAC;YACH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnB,MAAM,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,sCAAsC,MAAM,EAAE,CAAC,CAAC;YACjG,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,WAAgC;QACnE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAClD,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,4DAA4D,EAAE;YAC7G,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAC,EAAC;YAC7D,IAAI,EAAE,WAAW;SAClB,CAAC,CAAC;QACH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,sCAAsC,MAAM,EAAE,CAAC,CAAC;QACjG,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,MAAc,EAAE,KAAa;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAClD,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,8DAA8D,EAAE;YACzG,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAC,EAAC;SACrE,CAAC,CAAC;QACH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,wBAAwB,MAAM,OAAO,KAAK,EAAE,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,KAAa;QAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAClD,MAAM,EAAC,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,8DAA8D,EAAE;YAC5G,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAC,EAAC;SACrE,CAAC,CAAC;QACH,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,yBAAyB,MAAM,SAAS,KAAK,EAAE,CAAC,CAAC;QAClG,CAAC;IACH,CAAC;IAEO,WAAW,CAAC,MAAgB;QAClC,MAAM,YAAY,GAAmC;YACnD,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;YAChC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;YAC9B,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;SAC5D,CAAC;QACF,OAAO,8BAA8B,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;CACF"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Canonical types and backend interface for Business Manager role operations.
|
|
3
|
+
*
|
|
4
|
+
* The OCAPI Data API and the SCAPI Merchant Roles API both manage instance-
|
|
5
|
+
* level access roles. Permission shapes are virtually identical across the
|
|
6
|
+
* two APIs — module/functional/locale/webdav permission groups — so the
|
|
7
|
+
* canonical type re-exports the SCAPI shape and the OCAPI backend converts.
|
|
8
|
+
*
|
|
9
|
+
* @module operations/bm-roles/types
|
|
10
|
+
*/
|
|
11
|
+
import type { BackendBase } from '../../clients/scapi-backend-utils.js';
|
|
12
|
+
import type { RolePermissions as ScapiRolePermissions } from '../../clients/scapi-merchant-roles.js';
|
|
13
|
+
export type RolePermissionsInfo = ScapiRolePermissions;
|
|
14
|
+
export interface RoleInfo {
|
|
15
|
+
id: string;
|
|
16
|
+
description?: string;
|
|
17
|
+
userCount?: number;
|
|
18
|
+
userManager?: boolean;
|
|
19
|
+
permissions?: RolePermissionsInfo;
|
|
20
|
+
/** Original backend response, for advanced consumers. */
|
|
21
|
+
_raw?: unknown;
|
|
22
|
+
}
|
|
23
|
+
export interface ListRolesResult {
|
|
24
|
+
total: number;
|
|
25
|
+
start: number;
|
|
26
|
+
count: number;
|
|
27
|
+
hits: RoleInfo[];
|
|
28
|
+
}
|
|
29
|
+
export interface ListRolesOptions {
|
|
30
|
+
start?: number;
|
|
31
|
+
count?: number;
|
|
32
|
+
expand?: ('users' | 'permissions')[];
|
|
33
|
+
}
|
|
34
|
+
export interface CreateRoleInput {
|
|
35
|
+
description?: string;
|
|
36
|
+
}
|
|
37
|
+
export interface RolesBackend extends BackendBase {
|
|
38
|
+
listRoles(options?: ListRolesOptions): Promise<ListRolesResult>;
|
|
39
|
+
getRole(roleId: string, options?: {
|
|
40
|
+
expand?: ('users' | 'permissions')[];
|
|
41
|
+
}): Promise<RoleInfo>;
|
|
42
|
+
createRole(roleId: string, input?: CreateRoleInput): Promise<RoleInfo>;
|
|
43
|
+
deleteRole(roleId: string): Promise<void>;
|
|
44
|
+
getPermissions(roleId: string): Promise<RolePermissionsInfo>;
|
|
45
|
+
setPermissions(roleId: string, permissions: RolePermissionsInfo): Promise<RolePermissionsInfo>;
|
|
46
|
+
/** Assigns a user to a role. Returns void; OCAPI returns the user but we don't surface that. */
|
|
47
|
+
grantRole(roleId: string, login: string): Promise<void>;
|
|
48
|
+
revokeRole(roleId: string, login: string): Promise<void>;
|
|
49
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/operations/bm-roles/types.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { OcapiUsersBackend } from './ocapi-backend.js';
|
|
2
|
+
import { ScapiUsersBackend } from './scapi-backend.js';
|
|
3
|
+
import { createDualBackend } from '../../clients/dual-backend-factory.js';
|
|
4
|
+
export function createUsersBackend(config) {
|
|
5
|
+
return createDualBackend(config, {
|
|
6
|
+
domainName: 'Users',
|
|
7
|
+
Scapi: ScapiUsersBackend,
|
|
8
|
+
Ocapi: OcapiUsersBackend,
|
|
9
|
+
});
|
|
10
|
+
}
|
|
11
|
+
//# sourceMappingURL=backend.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"backend.js","sourceRoot":"","sources":["../../../../src/operations/bm-users/backend.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAC,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAC,iBAAiB,EAAyB,MAAM,uCAAuC,CAAC;AAIhG,MAAM,UAAU,kBAAkB,CAAC,MAA0B;IAC3D,OAAO,iBAAiB,CAAe,MAAM,EAAE;QAC7C,UAAU,EAAE,OAAO;QACnB,KAAK,EAAE,iBAAiB;QACxB,KAAK,EAAE,iBAAiB;KACzB,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -4,9 +4,11 @@
|
|
|
4
4
|
* Provides functions for querying and managing instance-level users via OCAPI Data API.
|
|
5
5
|
* These are distinct from Account Manager users managed via {@link @salesforce/b2c-tooling-sdk/operations/users | operations/users}.
|
|
6
6
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
7
|
+
* Create-or-replace is supported via the backend's `createOrReplaceUser` method (PUT), obtained
|
|
8
|
+
* from {@link createUsersBackend}. On instances using SSO with Account Manager (the default for
|
|
9
|
+
* production) this is rejected with `LocalUserCreationException` — local user creation must be
|
|
10
|
+
* enabled on the instance for it to succeed; otherwise provision users in Account Manager and
|
|
11
|
+
* use these operations for read/search/update/delete plus access-key administration.
|
|
10
12
|
*
|
|
11
13
|
* ## Core User Functions
|
|
12
14
|
*
|
|
@@ -48,3 +50,9 @@
|
|
|
48
50
|
*/
|
|
49
51
|
export { ACCESS_KEY_SCOPES, listBmUsers, getBmUser, whoamiBmUser, searchBmUsers, updateBmUser, deleteBmUser, getBmUserAccessKey, createBmUserAccessKey, setBmUserAccessKeyEnabled, deleteBmUserAccessKey, } from './users.js';
|
|
50
52
|
export type { AccessKeyScope, BmUser, BmUsers, BmUserSearchResult, BmAccessKeyDetails, ListBmUsersOptions, SearchBmUsersOptions, UpdateBmUserChanges, } from './users.js';
|
|
53
|
+
export { createUsersBackend } from './backend.js';
|
|
54
|
+
export type { UsersBackendConfig } from './backend.js';
|
|
55
|
+
export { OcapiUsersBackend } from './ocapi-backend.js';
|
|
56
|
+
export { ScapiUsersBackend } from './scapi-backend.js';
|
|
57
|
+
export type { ScapiUsersBackendConfig } from './scapi-backend.js';
|
|
58
|
+
export type { UsersBackend, UserInfo, ListUsersResult, ListUsersOptions, SearchUsersOptions, CreateUserInput, UpdateUserChanges, } from './types.js';
|
|
@@ -9,9 +9,11 @@
|
|
|
9
9
|
* Provides functions for querying and managing instance-level users via OCAPI Data API.
|
|
10
10
|
* These are distinct from Account Manager users managed via {@link @salesforce/b2c-tooling-sdk/operations/users | operations/users}.
|
|
11
11
|
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
12
|
+
* Create-or-replace is supported via the backend's `createOrReplaceUser` method (PUT), obtained
|
|
13
|
+
* from {@link createUsersBackend}. On instances using SSO with Account Manager (the default for
|
|
14
|
+
* production) this is rejected with `LocalUserCreationException` — local user creation must be
|
|
15
|
+
* enabled on the instance for it to succeed; otherwise provision users in Account Manager and
|
|
16
|
+
* use these operations for read/search/update/delete plus access-key administration.
|
|
15
17
|
*
|
|
16
18
|
* ## Core User Functions
|
|
17
19
|
*
|
|
@@ -52,4 +54,8 @@
|
|
|
52
54
|
* @module operations/bm-users
|
|
53
55
|
*/
|
|
54
56
|
export { ACCESS_KEY_SCOPES, listBmUsers, getBmUser, whoamiBmUser, searchBmUsers, updateBmUser, deleteBmUser, getBmUserAccessKey, createBmUserAccessKey, setBmUserAccessKeyEnabled, deleteBmUserAccessKey, } from './users.js';
|
|
57
|
+
// Users backend abstraction — supports OCAPI + SCAPI
|
|
58
|
+
export { createUsersBackend } from './backend.js';
|
|
59
|
+
export { OcapiUsersBackend } from './ocapi-backend.js';
|
|
60
|
+
export { ScapiUsersBackend } from './scapi-backend.js';
|
|
55
61
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/bm-users/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/bm-users/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,OAAO,EACL,iBAAiB,EACjB,WAAW,EACX,SAAS,EACT,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,qBAAqB,EACrB,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AAapB,qDAAqD;AACrD,OAAO,EAAC,kBAAkB,EAAC,MAAM,cAAc,CAAC;AAEhD,OAAO,EAAC,iBAAiB,EAAC,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAC,iBAAiB,EAAC,MAAM,oBAAoB,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { B2CInstance } from '../../instance/index.js';
|
|
2
|
+
import type { UsersBackend, UserInfo, ListUsersResult, ListUsersOptions, UpdateUserChanges, CreateUserInput, SearchUsersOptions } from './types.js';
|
|
3
|
+
export declare class OcapiUsersBackend implements UsersBackend {
|
|
4
|
+
private instance;
|
|
5
|
+
readonly name: "ocapi";
|
|
6
|
+
constructor(instance: B2CInstance);
|
|
7
|
+
listUsers(options?: ListUsersOptions): Promise<ListUsersResult>;
|
|
8
|
+
getUser(login: string): Promise<UserInfo>;
|
|
9
|
+
searchUsers(options?: SearchUsersOptions): Promise<ListUsersResult>;
|
|
10
|
+
createOrReplaceUser(login: string, input: CreateUserInput): Promise<UserInfo>;
|
|
11
|
+
updateUser(login: string, changes: UpdateUserChanges): Promise<UserInfo>;
|
|
12
|
+
deleteUser(login: string): Promise<void>;
|
|
13
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { listBmUsers as ocapiListBmUsers, getBmUser as ocapiGetBmUser, updateBmUser as ocapiUpdateBmUser, deleteBmUser as ocapiDeleteBmUser, searchBmUsers as ocapiSearchBmUsers, } from './users.js';
|
|
2
|
+
import { throwOcapiError } from '../../clients/error-utils.js';
|
|
3
|
+
import { SCAPI_MERCHANT_USERS_RW_SCOPES } from '../../clients/scapi-merchant-users.js';
|
|
4
|
+
function mapOcapiUser(ocapi) {
|
|
5
|
+
return {
|
|
6
|
+
login: ocapi.login ?? '',
|
|
7
|
+
email: ocapi.email,
|
|
8
|
+
firstName: ocapi.first_name,
|
|
9
|
+
lastName: ocapi.last_name,
|
|
10
|
+
externalId: ocapi.external_id,
|
|
11
|
+
disabled: ocapi.disabled,
|
|
12
|
+
locked: ocapi.locked,
|
|
13
|
+
lastLoginDate: ocapi.last_login_date,
|
|
14
|
+
passwordExpirationDate: ocapi.password_expiration_date,
|
|
15
|
+
passwordModificationDate: ocapi.password_modification_date,
|
|
16
|
+
preferredDataLocale: ocapi.preferred_data_locale,
|
|
17
|
+
preferredUiLocale: ocapi.preferred_ui_locale,
|
|
18
|
+
roles: ocapi.roles,
|
|
19
|
+
_raw: ocapi,
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
export class OcapiUsersBackend {
|
|
23
|
+
instance;
|
|
24
|
+
name = 'ocapi';
|
|
25
|
+
constructor(instance) {
|
|
26
|
+
this.instance = instance;
|
|
27
|
+
}
|
|
28
|
+
async listUsers(options = {}) {
|
|
29
|
+
const result = await ocapiListBmUsers(this.instance, options);
|
|
30
|
+
const users = (result.data ?? []);
|
|
31
|
+
return {
|
|
32
|
+
total: result.total ?? 0,
|
|
33
|
+
start: result.start ?? 0,
|
|
34
|
+
count: result.count ?? users.length,
|
|
35
|
+
hits: users.map(mapOcapiUser),
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
async getUser(login) {
|
|
39
|
+
const user = await ocapiGetBmUser(this.instance, login);
|
|
40
|
+
return mapOcapiUser(user);
|
|
41
|
+
}
|
|
42
|
+
async searchUsers(options = {}) {
|
|
43
|
+
const result = await ocapiSearchBmUsers(this.instance, options);
|
|
44
|
+
const users = (result.hits ?? []);
|
|
45
|
+
return {
|
|
46
|
+
total: result.total ?? 0,
|
|
47
|
+
start: result.start ?? options.start ?? 0,
|
|
48
|
+
count: result.count ?? users.length,
|
|
49
|
+
hits: users.map(mapOcapiUser),
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
async createOrReplaceUser(login, input) {
|
|
53
|
+
// Map canonical camelCase → OCAPI snake_case.
|
|
54
|
+
const body = {
|
|
55
|
+
login: input.login,
|
|
56
|
+
email: input.email,
|
|
57
|
+
first_name: input.firstName,
|
|
58
|
+
last_name: input.lastName,
|
|
59
|
+
external_id: input.externalId,
|
|
60
|
+
password: input.password,
|
|
61
|
+
disabled: input.disabled,
|
|
62
|
+
preferred_data_locale: input.preferredDataLocale,
|
|
63
|
+
preferred_ui_locale: input.preferredUiLocale,
|
|
64
|
+
roles: input.roles,
|
|
65
|
+
};
|
|
66
|
+
const { data, error, response } = await this.instance.ocapi.PUT('/users/{login}', {
|
|
67
|
+
params: { path: { login } },
|
|
68
|
+
body: body,
|
|
69
|
+
});
|
|
70
|
+
if (error) {
|
|
71
|
+
throwOcapiError(error, response, `Failed to create user ${login}`, SCAPI_MERCHANT_USERS_RW_SCOPES);
|
|
72
|
+
}
|
|
73
|
+
return mapOcapiUser(data);
|
|
74
|
+
}
|
|
75
|
+
async updateUser(login, changes) {
|
|
76
|
+
const ocapiChanges = {
|
|
77
|
+
email: changes.email,
|
|
78
|
+
first_name: changes.firstName,
|
|
79
|
+
last_name: changes.lastName,
|
|
80
|
+
external_id: changes.externalId,
|
|
81
|
+
disabled: changes.disabled,
|
|
82
|
+
preferred_data_locale: changes.preferredDataLocale,
|
|
83
|
+
preferred_ui_locale: changes.preferredUiLocale,
|
|
84
|
+
};
|
|
85
|
+
const updated = await ocapiUpdateBmUser(this.instance, login, ocapiChanges);
|
|
86
|
+
return mapOcapiUser(updated);
|
|
87
|
+
}
|
|
88
|
+
async deleteUser(login) {
|
|
89
|
+
await ocapiDeleteBmUser(this.instance, login);
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
//# sourceMappingURL=ocapi-backend.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ocapi-backend.js","sourceRoot":"","sources":["../../../../src/operations/bm-users/ocapi-backend.ts"],"names":[],"mappings":"AAeA,OAAO,EACL,WAAW,IAAI,gBAAgB,EAC/B,SAAS,IAAI,cAAc,EAC3B,YAAY,IAAI,iBAAiB,EACjC,YAAY,IAAI,iBAAiB,EAEjC,aAAa,IAAI,kBAAkB,GACpC,MAAM,YAAY,CAAC;AACpB,OAAO,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAC,8BAA8B,EAAC,MAAM,uCAAuC,CAAC;AAGrF,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE;QACxB,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,SAAS,EAAE,KAAK,CAAC,UAAU;QAC3B,QAAQ,EAAE,KAAK,CAAC,SAAS;QACzB,UAAU,EAAE,KAAK,CAAC,WAAW;QAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,aAAa,EAAE,KAAK,CAAC,eAAe;QACpC,sBAAsB,EAAE,KAAK,CAAC,wBAAwB;QACtD,wBAAwB,EAAE,KAAK,CAAC,0BAA0B;QAC1D,mBAAmB,EAAE,KAAK,CAAC,qBAAqB;QAChD,iBAAiB,EAAE,KAAK,CAAC,mBAAmB;QAC5C,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,IAAI,EAAE,KAAK;KACZ,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,iBAAiB;IAGR;IAFX,IAAI,GAAG,OAAgB,CAAC;IAEjC,YAAoB,QAAqB;QAArB,aAAQ,GAAR,QAAQ,CAAa;IAAG,CAAC;IAE7C,KAAK,CAAC,SAAS,CAAC,UAA4B,EAAE;QAC5C,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9D,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAa,CAAC;QAC9C,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;YACxB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;YACxB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM;YACnC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,KAAa;QACzB,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACxD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,UAA8B,EAAE;QAChD,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChE,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAa,CAAC;QAC9C,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;YACxB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,IAAI,CAAC;YACzC,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM;YACnC,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,KAAa,EAAE,KAAsB;QAC7D,8CAA8C;QAC9C,MAAM,IAAI,GAA4B;YACpC,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,UAAU,EAAE,KAAK,CAAC,SAAS;YAC3B,SAAS,EAAE,KAAK,CAAC,QAAQ;YACzB,WAAW,EAAE,KAAK,CAAC,UAAU;YAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,qBAAqB,EAAE,KAAK,CAAC,mBAAmB;YAChD,mBAAmB,EAAE,KAAK,CAAC,iBAAiB;YAC5C,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB,CAAC;QACF,MAAM,EAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAC,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,gBAAgB,EAAE;YAC9E,MAAM,EAAE,EAAC,IAAI,EAAE,EAAC,KAAK,EAAC,EAAC;YACvB,IAAI,EAAE,IAAqC;SAC5C,CAAC,CAAC;QACH,IAAI,KAAK,EAAE,CAAC;YACV,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,yBAAyB,KAAK,EAAE,EAAE,8BAA8B,CAAC,CAAC;QACrG,CAAC;QACD,OAAO,YAAY,CAAC,IAAc,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAa,EAAE,OAA0B;QACxD,MAAM,YAAY,GAA4B;YAC5C,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,UAAU,EAAE,OAAO,CAAC,SAAS;YAC7B,SAAS,EAAE,OAAO,CAAC,QAAQ;YAC3B,WAAW,EAAE,OAAO,CAAC,UAAU;YAC/B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,qBAAqB,EAAE,OAAO,CAAC,mBAAmB;YAClD,mBAAmB,EAAE,OAAO,CAAC,iBAAiB;SAC/C,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QAC5E,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAa;QAC5B,MAAM,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;CACF"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { AuthStrategy } from '../../auth/types.js';
|
|
2
|
+
import type { UsersBackend, UserInfo, ListUsersResult, ListUsersOptions, UpdateUserChanges, CreateUserInput, SearchUsersOptions } from './types.js';
|
|
3
|
+
export interface ScapiUsersBackendConfig {
|
|
4
|
+
shortCode: string;
|
|
5
|
+
tenantId: string;
|
|
6
|
+
auth: AuthStrategy;
|
|
7
|
+
/** Unused by Users; accepted for compatibility with the dual-backend factory. */
|
|
8
|
+
instance?: unknown;
|
|
9
|
+
}
|
|
10
|
+
export declare class ScapiUsersBackend implements UsersBackend {
|
|
11
|
+
private config;
|
|
12
|
+
readonly name: "scapi";
|
|
13
|
+
private organizationId;
|
|
14
|
+
private scopeTier;
|
|
15
|
+
constructor(config: ScapiUsersBackendConfig);
|
|
16
|
+
listUsers(options?: ListUsersOptions): Promise<ListUsersResult>;
|
|
17
|
+
searchUsers(options?: SearchUsersOptions): Promise<ListUsersResult>;
|
|
18
|
+
getUser(login: string): Promise<UserInfo>;
|
|
19
|
+
createOrReplaceUser(login: string, input: CreateUserInput): Promise<UserInfo>;
|
|
20
|
+
updateUser(login: string, changes: UpdateUserChanges): Promise<UserInfo>;
|
|
21
|
+
deleteUser(login: string): Promise<void>;
|
|
22
|
+
private buildClient;
|
|
23
|
+
}
|