@salesforce/b2c-tooling-sdk 1.24.1 → 2.0.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 +81 -117
- 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 +7 -0
- package/dist/esm/auth/oauth-implicit.js +2 -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 +3 -0
- package/dist/esm/auth/oauth-pkce-fallback.js +27 -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 +2 -1
- 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/session-store.d.ts +7 -0
- package/dist/esm/auth/session-store.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 +3 -0
- 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 +138 -9
- package/dist/esm/cli/mrt-command.js +277 -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 +1 -0
- 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 +28 -3
- package/dist/esm/clients/index.js +24 -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 +56 -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/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/sources/env-source.js +17 -0
- package/dist/esm/config/sources/env-source.js.map +1 -1
- package/dist/esm/config/types.d.ts +21 -2
- 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 +92 -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 +5 -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/debug/debug-session.js +0 -8
- package/dist/esm/operations/debug/debug-session.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.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 +221 -0
- package/dist/esm/operations/mrt/deployment.js +239 -0
- package/dist/esm/operations/mrt/deployment.js.map +1 -1
- package/dist/esm/operations/mrt/index.d.ts +8 -6
- package/dist/esm/operations/mrt/index.js +5 -3
- 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 +83 -1
- package/dist/esm/operations/mrt/push.js +102 -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-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/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 +15 -0
- package/dist/esm/scapi/request.js +239 -0
- package/dist/esm/scapi/request.js.map +1 -0
- package/dist/esm/scapi/runtime.d.ts +20 -0
- package/dist/esm/scapi/runtime.js +131 -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 +10 -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/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
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"debug-session.js","sourceRoot":"","sources":["../../../../src/operations/debug/debug-session.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;GAQG;AACH,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAC,WAAW,EAAE,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAS1D,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,0BAA0B,GAAG,MAAM,CAAC;AAE1C,MAAM,OAAO,mBAAmB;IACrB,MAAM,CAAc;IACZ,MAAM,CAAqB;IAC3B,SAAS,CAAwB;IACjC,MAAM,GAAG,SAAS,EAAE,CAAC;IAE9B,SAAS,CAAkC;IAC3C,cAAc,CAAkC;IAExD,kDAAkD;IAC1C,YAAY,GAAG,IAAI,GAAG,EAA6B,CAAC;IACpD,SAAS,GAAG,KAAK,CAAC;IAE1B,YAAY,MAA0B,EAAE,YAAmC,EAAE;QAC3E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC;YAC5B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAC,EAAE,+BAA+B,CAAC,CAAC;QAErF,oEAAoE;QACpE,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QACnC,CAAC;QAAC,MAAM,CAAC;YACP,oCAAoC;QACtC,CAAC;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC;YACH,wBAAwB;YACxB,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,IAAI,0BAA0B,CAAC;YACtF,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,EAAE,iBAAiB,CAAC,CAAC;YAElF,sBAAsB;YACtB,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,qBAAqB,CAAC;YACvE,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE,EAAE,YAAY,CAAC,CAAC;YAE1E,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAE/C,
|
|
1
|
+
{"version":3,"file":"debug-session.js","sourceRoot":"","sources":["../../../../src/operations/debug/debug-session.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;GAQG;AACH,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAC,WAAW,EAAE,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAS1D,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,0BAA0B,GAAG,MAAM,CAAC;AAE1C,MAAM,OAAO,mBAAmB;IACrB,MAAM,CAAc;IACZ,MAAM,CAAqB;IAC3B,SAAS,CAAwB;IACjC,MAAM,GAAG,SAAS,EAAE,CAAC;IAE9B,SAAS,CAAkC;IAC3C,cAAc,CAAkC;IAExD,kDAAkD;IAC1C,YAAY,GAAG,IAAI,GAAG,EAA6B,CAAC;IACpD,SAAS,GAAG,KAAK,CAAC;IAE1B,YAAY,MAA0B,EAAE,YAAmC,EAAE;QAC3E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,CAAC;YAC5B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAC,EAAE,+BAA+B,CAAC,CAAC;QAErF,oEAAoE;QACpE,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QACnC,CAAC;QAAC,MAAM,CAAC;YACP,oCAAoC;QACtC,CAAC;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC;YACH,wBAAwB;YACxB,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,iBAAiB,IAAI,0BAA0B,CAAC;YACtF,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,EAAE,iBAAiB,CAAC,CAAC;YAElF,sBAAsB;YACtB,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,qBAAqB,CAAC;YACvE,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE,EAAE,YAAY,CAAC,CAAC;YAE1E,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAE/C,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,4EAA4E;YAC5E,wDAAwD;YACxD,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACnC,CAAC;YAAC,OAAO,SAAS,EAAE,CAAC;gBACnB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,GAAG,EAAE,SAAS,EAAC,EAAE,wDAAwD,CAAC,CAAC;YAChG,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;YACnC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAC,KAAK,EAAC,EAAE,kDAAkD,CAAC,CAAC;YAChF,CAAC;YACD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,WAA8B;QACjD,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC;QACtC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB;QAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,QAAgB;QAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,QAAgB;QAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,QAAgB;QAC5B,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,eAAe;QACb,OAAO,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,GAAG,OAAO;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,0EAA0E;IAC1E,WAAW;IACX,0EAA0E;IAElE,UAAU;QAChB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC7B,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACnC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAClC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,SAAS;QACrB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QACnC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAC,EAAE,wBAAwB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,IAAuB,EAAE,IAAuB;QAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;QAC/C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO;YAAE,OAAO,OAAO,KAAK,OAAO,CAAC;QACrD,OAAO,OAAO,CAAC,WAAW,KAAK,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC;IACpG,CAAC;IAEO,eAAe,CAAC,MAAyB;QAC/C,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;QACxC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC;YAC9B,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,IAAI,aAAa,CAAC;YAC9C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,EAAE,cAAc,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,KAAK,EAAE,GAAG,CAAC,CAAC;QACnG,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,WAAW;QACvB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/C,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;YAErC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;gBAElD,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,sBAAsB;oBACtB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;oBACzC,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;wBAC/B,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;wBAC7B,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC;oBAC3C,CAAC;gBACH,CAAC;qBAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;oBAC7C,gBAAgB;oBAChB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;oBACzC,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;wBAC/B,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;wBAC7B,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC;oBAC3C,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC;wBACjD,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAChD,CAAC;gBACH,CAAC;qBAAM,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC;oBACpF,+EAA+E;oBAC/E,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;oBACzC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;oBAC7B,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC;gBAC3C,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;gBAC3C,CAAC;YACH,CAAC;YAED,kCAAkC;YAClC,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACrC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;oBACxB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;oBACzC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,UAAU,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACxD,mCAAmC;gBACnC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;gBACrD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;gBACvB,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,EAAE,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,KAAK,EAAC,EAAE,mBAAmB,CAAC,CAAC;gBAChD,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;IACH,CAAC;CACF"}
|
|
@@ -30,7 +30,7 @@ export interface ExportableUnits {
|
|
|
30
30
|
* Discovers the data units that can be exported from an instance.
|
|
31
31
|
*
|
|
32
32
|
* Each category is read independently: a failure in one (e.g. the OCAPI client
|
|
33
|
-
* lacks read permission for
|
|
33
|
+
* lacks read permission for a category) records a warning and leaves that list
|
|
34
34
|
* empty rather than failing the whole discovery, so the caller can still offer
|
|
35
35
|
* the categories that succeeded.
|
|
36
36
|
*
|
|
@@ -16,28 +16,27 @@
|
|
|
16
16
|
*/
|
|
17
17
|
import { B2CInstance } from '../../instance/index.js';
|
|
18
18
|
import { getLogger } from '../../logging/logger.js';
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
{ key: 'catalogs', path: '/catalogs', label: 'catalogs' },
|
|
23
|
-
{ key: 'inventoryLists', path: '/inventory_lists', label: 'inventory lists' },
|
|
24
|
-
];
|
|
19
|
+
import { assertOcapiCompatibilityAllowed } from '../../clients/scapi-backend-utils.js';
|
|
20
|
+
import { createCatalogsBackend } from '../catalogs/index.js';
|
|
21
|
+
import { createSitesBackend } from '../sites/index.js';
|
|
25
22
|
/** Page size for paginated list endpoints (OCAPI default is 25). */
|
|
26
23
|
const PAGE_COUNT = 200;
|
|
27
24
|
/**
|
|
28
|
-
* Lists
|
|
25
|
+
* Lists inventory lists through the remaining paginated OCAPI collection,
|
|
26
|
+
* following `start`/`count` until all
|
|
29
27
|
* documents are read. Returns the `id` of each document.
|
|
30
28
|
*/
|
|
31
|
-
async function
|
|
29
|
+
async function listInventoryListIds(instance) {
|
|
30
|
+
assertOcapiCompatibilityAllowed(instance.apiBackend, 'inventory-list enumeration');
|
|
32
31
|
const ids = [];
|
|
33
32
|
let start = 0;
|
|
34
33
|
// OCAPI collections page via start/count; `total` reports the full size.
|
|
35
34
|
for (;;) {
|
|
36
|
-
const { data, error } = await instance.ocapi.GET(
|
|
35
|
+
const { data, error } = await instance.ocapi.GET('/inventory_lists', {
|
|
37
36
|
params: { query: { start, count: PAGE_COUNT } },
|
|
38
37
|
});
|
|
39
38
|
if (error || !data) {
|
|
40
|
-
throw new Error(error?.fault?.message ??
|
|
39
|
+
throw new Error(error?.fault?.message ?? 'Failed to list inventory lists');
|
|
41
40
|
}
|
|
42
41
|
for (const item of data.data ?? []) {
|
|
43
42
|
if (item.id) {
|
|
@@ -56,7 +55,7 @@ async function listIds(instance, path) {
|
|
|
56
55
|
* Discovers the data units that can be exported from an instance.
|
|
57
56
|
*
|
|
58
57
|
* Each category is read independently: a failure in one (e.g. the OCAPI client
|
|
59
|
-
* lacks read permission for
|
|
58
|
+
* lacks read permission for a category) records a warning and leaves that list
|
|
60
59
|
* empty rather than failing the whole discovery, so the caller can still offer
|
|
61
60
|
* the categories that succeeded.
|
|
62
61
|
*
|
|
@@ -72,16 +71,47 @@ async function listIds(instance, path) {
|
|
|
72
71
|
export async function discoverExportableUnits(instance) {
|
|
73
72
|
const logger = getLogger();
|
|
74
73
|
const result = { sites: [], catalogs: [], inventoryLists: [], warnings: [] };
|
|
75
|
-
await Promise.all(
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
74
|
+
await Promise.all([
|
|
75
|
+
// Sites: SCAPI (site/sites) with OCAPI fallback.
|
|
76
|
+
(async () => {
|
|
77
|
+
try {
|
|
78
|
+
const sites = await createSitesBackend({ instance }).listSites();
|
|
79
|
+
result.sites = sites
|
|
80
|
+
.map((s) => s.id)
|
|
81
|
+
.filter((id) => !!id)
|
|
82
|
+
.sort((a, b) => a.localeCompare(b));
|
|
83
|
+
}
|
|
84
|
+
catch (err) {
|
|
85
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
86
|
+
logger.debug({ err: message }, 'Failed to discover sites');
|
|
87
|
+
result.warnings.push(`Could not list sites: ${message}`);
|
|
88
|
+
}
|
|
89
|
+
})(),
|
|
90
|
+
// Catalogs: SCAPI product/catalogs with OCAPI fallback.
|
|
91
|
+
(async () => {
|
|
92
|
+
try {
|
|
93
|
+
const catalogs = await createCatalogsBackend({ instance }).listCatalogs();
|
|
94
|
+
result.catalogs = catalogs.map(({ id }) => id).sort((a, b) => a.localeCompare(b));
|
|
95
|
+
}
|
|
96
|
+
catch (err) {
|
|
97
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
98
|
+
logger.debug({ err: message }, 'Failed to discover catalogs');
|
|
99
|
+
result.warnings.push(`Could not list catalogs: ${message}`);
|
|
100
|
+
}
|
|
101
|
+
})(),
|
|
102
|
+
// The live SCAPI inventory APIs expose list detail/records but no
|
|
103
|
+
// organization-level inventory-list enumeration endpoint yet.
|
|
104
|
+
(async () => {
|
|
105
|
+
try {
|
|
106
|
+
result.inventoryLists = (await listInventoryListIds(instance)).sort((a, b) => a.localeCompare(b));
|
|
107
|
+
}
|
|
108
|
+
catch (err) {
|
|
109
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
110
|
+
logger.debug({ err: message }, 'Failed to discover inventory lists');
|
|
111
|
+
result.warnings.push(`Could not list inventory lists: ${message}`);
|
|
112
|
+
}
|
|
113
|
+
})(),
|
|
114
|
+
]);
|
|
85
115
|
return result;
|
|
86
116
|
}
|
|
87
117
|
//# sourceMappingURL=discover.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"discover.js","sourceRoot":"","sources":["../../../../src/operations/jobs/discover.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;GAUG;AACH,OAAO,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"discover.js","sourceRoot":"","sources":["../../../../src/operations/jobs/discover.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;GAUG;AACH,OAAO,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAC,+BAA+B,EAAC,MAAM,sCAAsC,CAAC;AACrF,OAAO,EAAC,qBAAqB,EAAC,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAC,kBAAkB,EAAC,MAAM,mBAAmB,CAAC;AAmBrD,oEAAoE;AACpE,MAAM,UAAU,GAAG,GAAG,CAAC;AAEvB;;;;GAIG;AACH,KAAK,UAAU,oBAAoB,CAAC,QAAqB;IACvD,+BAA+B,CAAC,QAAQ,CAAC,UAAU,EAAE,4BAA4B,CAAC,CAAC;IACnF,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,IAAI,KAAK,GAAG,CAAC,CAAC;IAEd,yEAAyE;IACzE,SAAS,CAAC;QACR,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,kBAAkB,EAAE;YACjE,MAAM,EAAE,EAAC,KAAK,EAAE,EAAC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAC,EAAC;SAC5C,CAAC,CAAC;QAEH,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,gCAAgC,CAAC,CAAC;QAC7E,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;gBACZ,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC;QACvC,KAAK,IAAI,UAAU,CAAC;QACpB,IAAI,KAAK,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;YACzC,MAAM;QACR,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,QAAqB;IACjE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,MAAM,GAAoB,EAAC,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAC,CAAC;IAE5F,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,iDAAiD;QACjD,CAAC,KAAK,IAAI,EAAE;YACV,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,kBAAkB,CAAC,EAAC,QAAQ,EAAC,CAAC,CAAC,SAAS,EAAE,CAAC;gBAC/D,MAAM,CAAC,KAAK,GAAG,KAAK;qBACjB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;qBAChB,MAAM,CAAC,CAAC,EAAE,EAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;qBAClC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjE,MAAM,CAAC,KAAK,CAAC,EAAC,GAAG,EAAE,OAAO,EAAC,EAAE,0BAA0B,CAAC,CAAC;gBACzD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,yBAAyB,OAAO,EAAE,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CAAC,EAAE;QACJ,wDAAwD;QACxD,CAAC,KAAK,IAAI,EAAE;YACV,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,qBAAqB,CAAC,EAAC,QAAQ,EAAC,CAAC,CAAC,YAAY,EAAE,CAAC;gBACxE,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAC,EAAE,EAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YAClF,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjE,MAAM,CAAC,KAAK,CAAC,EAAC,GAAG,EAAE,OAAO,EAAC,EAAE,6BAA6B,CAAC,CAAC;gBAC5D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC,CAAC,EAAE;QACJ,kEAAkE;QAClE,8DAA8D;QAC9D,CAAC,KAAK,IAAI,EAAE;YACV,IAAI,CAAC;gBACH,MAAM,CAAC,cAAc,GAAG,CAAC,MAAM,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YACpG,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjE,MAAM,CAAC,KAAK,CAAC,EAAC,GAAG,EAAE,OAAO,EAAC,EAAE,oCAAoC,CAAC,CAAC;gBACnE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,mCAAmC,OAAO,EAAE,CAAC,CAAC;YACrE,CAAC;QACH,CAAC,CAAC,EAAE;KACL,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -1,69 +1,26 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Job execution operations for B2C Commerce.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
4
|
+
* SDK consumers should call SCAPI ops directly via the free functions
|
|
5
|
+
* exported from `./scapi-ops` (or, for legacy code, the OCAPI free
|
|
6
|
+
* functions exported from `./run`). The CLI's `BackendDispatcher`
|
|
7
|
+
* arbitrates between them based on the user's `apiBackend` preference;
|
|
8
|
+
* that policy lives in the CLI layer.
|
|
6
9
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* - {@link executeJob} - Start a job execution
|
|
10
|
-
* - {@link getJobExecution} - Get the status of a job execution
|
|
11
|
-
* - {@link waitForJob} - Wait for a job to complete
|
|
12
|
-
* - {@link searchJobExecutions} - Search for job executions
|
|
13
|
-
* - {@link findRunningJobExecution} - Find a running execution
|
|
14
|
-
* - {@link getJobLog} - Retrieve job log file content
|
|
15
|
-
*
|
|
16
|
-
* ## System Jobs
|
|
17
|
-
*
|
|
18
|
-
* - {@link siteArchiveImport} - Import a site archive
|
|
19
|
-
* - {@link siteArchiveImportSet} - Apply an ordered, receipted set of site archives
|
|
20
|
-
* - {@link siteArchiveImportSplit} - Import a large site archive in multiple parts
|
|
21
|
-
* - {@link siteArchiveExport} - Export a site archive
|
|
22
|
-
* - {@link siteArchiveExportToPath} - Export and save to local path
|
|
23
|
-
*
|
|
24
|
-
* ## Usage
|
|
25
|
-
*
|
|
26
|
-
* ```typescript
|
|
27
|
-
* import {
|
|
28
|
-
* executeJob,
|
|
29
|
-
* waitForJob,
|
|
30
|
-
* searchJobExecutions,
|
|
31
|
-
* siteArchiveImport,
|
|
32
|
-
* siteArchiveExport,
|
|
33
|
-
* } from '@salesforce/b2c-tooling-sdk/operations/jobs';
|
|
34
|
-
* import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';
|
|
35
|
-
*
|
|
36
|
-
* const config = resolveConfig();
|
|
37
|
-
* const instance = config.createB2CInstance();
|
|
38
|
-
*
|
|
39
|
-
* // Run a custom job and wait for completion
|
|
40
|
-
* const execution = await executeJob(instance, 'my-job-id');
|
|
41
|
-
* const result = await waitForJob(instance, 'my-job-id', execution.id);
|
|
42
|
-
*
|
|
43
|
-
* // Search for recent job executions
|
|
44
|
-
* const results = await searchJobExecutions(instance, {
|
|
45
|
-
* jobId: 'my-job-id',
|
|
46
|
-
* count: 10
|
|
47
|
-
* });
|
|
48
|
-
*
|
|
49
|
-
* // Import a site archive
|
|
50
|
-
* await siteArchiveImport(instance, './my-import-data');
|
|
51
|
-
*
|
|
52
|
-
* // Export site data
|
|
53
|
-
* const exportResult = await siteArchiveExport(instance, {
|
|
54
|
-
* global_data: { meta_data: true }
|
|
55
|
-
* });
|
|
56
|
-
* ```
|
|
57
|
-
*
|
|
58
|
-
* ## Authentication
|
|
59
|
-
*
|
|
60
|
-
* Job operations require OAuth authentication with appropriate OCAPI permissions
|
|
61
|
-
* for the /jobs and /job_execution_search resources.
|
|
10
|
+
* Ordered import sets are exported from `./import-set` and continue to use
|
|
11
|
+
* the site-archive/WebDAV workflow.
|
|
62
12
|
*
|
|
63
13
|
* @module operations/jobs
|
|
64
14
|
*/
|
|
65
15
|
export { executeJob, getJobExecution, waitForJob, searchJobExecutions, findRunningJobExecution, getJobLog, getJobErrorMessage, JobExecutionError, } from './run.js';
|
|
66
16
|
export type { JobExecution, JobStepExecution, JobExecutionStatus, JobExecutionParameter, ExecuteJobOptions, WaitForJobOptions, WaitForJobPollInfo, SearchJobExecutionsOptions, JobExecutionSearchResult, } from './run.js';
|
|
17
|
+
export { executeJob as scapiExecuteJob, getJobExecution as scapiGetJobExecution, searchJobExecutions as scapiSearchJobExecutions, deleteJobExecution as scapiDeleteJobExecution, getJobLog as scapiGetJobLog, ScapiJobStartError, } from './scapi-ops.js';
|
|
18
|
+
export type { ExecuteJobScapiOptions, SearchJobExecutionsScapiOptions } from './scapi-ops.js';
|
|
19
|
+
export type { JobExecutionInfo, JobStepExecutionResult, JobExecutionSearchResults } from './types.js';
|
|
20
|
+
export { waitForJobExecution, CanonicalJobExecutionError } from './wait-canonical.js';
|
|
21
|
+
export { mapOcapiExecution, mapOcapiSearchResult, mapCanonicalToOcapiExecution } from './ocapi-mapping.js';
|
|
22
|
+
export { runSystemJob } from './run-system-job.js';
|
|
23
|
+
export type { SystemJobSpec } from './run-system-job.js';
|
|
67
24
|
export { siteArchiveImport, siteArchiveImportSplit, siteArchiveExport, siteArchiveExportToBuffer, siteArchiveExportToPath, } from './site-archive.js';
|
|
68
25
|
export { discoverImportSet, siteArchiveImportSet, ImportSetStateError } from './import-set.js';
|
|
69
26
|
export type { DiscoverImportSetOptions, ImportSetItem, ImportSetReceipt, ImportSetItemResult, ImportSetResult, ImportSetEvent, ImportSetLockOwner, SiteArchiveImportSetOptions, } from './import-set.js';
|
|
@@ -6,70 +6,26 @@
|
|
|
6
6
|
/**
|
|
7
7
|
* Job execution operations for B2C Commerce.
|
|
8
8
|
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
9
|
+
* SDK consumers should call SCAPI ops directly via the free functions
|
|
10
|
+
* exported from `./scapi-ops` (or, for legacy code, the OCAPI free
|
|
11
|
+
* functions exported from `./run`). The CLI's `BackendDispatcher`
|
|
12
|
+
* arbitrates between them based on the user's `apiBackend` preference;
|
|
13
|
+
* that policy lives in the CLI layer.
|
|
11
14
|
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* - {@link executeJob} - Start a job execution
|
|
15
|
-
* - {@link getJobExecution} - Get the status of a job execution
|
|
16
|
-
* - {@link waitForJob} - Wait for a job to complete
|
|
17
|
-
* - {@link searchJobExecutions} - Search for job executions
|
|
18
|
-
* - {@link findRunningJobExecution} - Find a running execution
|
|
19
|
-
* - {@link getJobLog} - Retrieve job log file content
|
|
20
|
-
*
|
|
21
|
-
* ## System Jobs
|
|
22
|
-
*
|
|
23
|
-
* - {@link siteArchiveImport} - Import a site archive
|
|
24
|
-
* - {@link siteArchiveImportSet} - Apply an ordered, receipted set of site archives
|
|
25
|
-
* - {@link siteArchiveImportSplit} - Import a large site archive in multiple parts
|
|
26
|
-
* - {@link siteArchiveExport} - Export a site archive
|
|
27
|
-
* - {@link siteArchiveExportToPath} - Export and save to local path
|
|
28
|
-
*
|
|
29
|
-
* ## Usage
|
|
30
|
-
*
|
|
31
|
-
* ```typescript
|
|
32
|
-
* import {
|
|
33
|
-
* executeJob,
|
|
34
|
-
* waitForJob,
|
|
35
|
-
* searchJobExecutions,
|
|
36
|
-
* siteArchiveImport,
|
|
37
|
-
* siteArchiveExport,
|
|
38
|
-
* } from '@salesforce/b2c-tooling-sdk/operations/jobs';
|
|
39
|
-
* import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';
|
|
40
|
-
*
|
|
41
|
-
* const config = resolveConfig();
|
|
42
|
-
* const instance = config.createB2CInstance();
|
|
43
|
-
*
|
|
44
|
-
* // Run a custom job and wait for completion
|
|
45
|
-
* const execution = await executeJob(instance, 'my-job-id');
|
|
46
|
-
* const result = await waitForJob(instance, 'my-job-id', execution.id);
|
|
47
|
-
*
|
|
48
|
-
* // Search for recent job executions
|
|
49
|
-
* const results = await searchJobExecutions(instance, {
|
|
50
|
-
* jobId: 'my-job-id',
|
|
51
|
-
* count: 10
|
|
52
|
-
* });
|
|
53
|
-
*
|
|
54
|
-
* // Import a site archive
|
|
55
|
-
* await siteArchiveImport(instance, './my-import-data');
|
|
56
|
-
*
|
|
57
|
-
* // Export site data
|
|
58
|
-
* const exportResult = await siteArchiveExport(instance, {
|
|
59
|
-
* global_data: { meta_data: true }
|
|
60
|
-
* });
|
|
61
|
-
* ```
|
|
62
|
-
*
|
|
63
|
-
* ## Authentication
|
|
64
|
-
*
|
|
65
|
-
* Job operations require OAuth authentication with appropriate OCAPI permissions
|
|
66
|
-
* for the /jobs and /job_execution_search resources.
|
|
15
|
+
* Ordered import sets are exported from `./import-set` and continue to use
|
|
16
|
+
* the site-archive/WebDAV workflow.
|
|
67
17
|
*
|
|
68
18
|
* @module operations/jobs
|
|
69
19
|
*/
|
|
70
|
-
//
|
|
20
|
+
// OCAPI ops (legacy — will be removed when OCAPI is deprecated)
|
|
71
21
|
export { executeJob, getJobExecution, waitForJob, searchJobExecutions, findRunningJobExecution, getJobLog, getJobErrorMessage, JobExecutionError, } from './run.js';
|
|
72
|
-
//
|
|
22
|
+
// SCAPI ops + canonical types (primary surface)
|
|
23
|
+
export { executeJob as scapiExecuteJob, getJobExecution as scapiGetJobExecution, searchJobExecutions as scapiSearchJobExecutions, deleteJobExecution as scapiDeleteJobExecution, getJobLog as scapiGetJobLog, ScapiJobStartError, } from './scapi-ops.js';
|
|
24
|
+
// Backend-agnostic helpers
|
|
25
|
+
export { waitForJobExecution, CanonicalJobExecutionError } from './wait-canonical.js';
|
|
26
|
+
export { mapOcapiExecution, mapOcapiSearchResult, mapCanonicalToOcapiExecution } from './ocapi-mapping.js';
|
|
27
|
+
export { runSystemJob } from './run-system-job.js';
|
|
28
|
+
// Site archive import/export (uses OCAPI WebDAV path)
|
|
73
29
|
export { siteArchiveImport, siteArchiveImportSplit, siteArchiveExport, siteArchiveExportToBuffer, siteArchiveExportToPath, } from './site-archive.js';
|
|
74
30
|
// Ordered, idempotent import sets
|
|
75
31
|
export { discoverImportSet, siteArchiveImportSet, ImportSetStateError } from './import-set.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/jobs/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/operations/jobs/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH;;;;;;;;;;;;;GAaG;AAEH,gEAAgE;AAChE,OAAO,EACL,UAAU,EACV,eAAe,EACf,UAAU,EACV,mBAAmB,EACnB,uBAAuB,EACvB,SAAS,EACT,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAclB,gDAAgD;AAChD,OAAO,EACL,UAAU,IAAI,eAAe,EAC7B,eAAe,IAAI,oBAAoB,EACvC,mBAAmB,IAAI,wBAAwB,EAC/C,kBAAkB,IAAI,uBAAuB,EAC7C,SAAS,IAAI,cAAc,EAC3B,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AAIxB,2BAA2B;AAC3B,OAAO,EAAC,mBAAmB,EAAE,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAC,iBAAiB,EAAE,oBAAoB,EAAE,4BAA4B,EAAC,MAAM,oBAAoB,CAAC;AACzG,OAAO,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AAGjD,sDAAsD;AACtD,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,yBAAyB,EACzB,uBAAuB,GACxB,MAAM,mBAAmB,CAAC;AAE3B,kCAAkC;AAClC,OAAO,EAAC,iBAAiB,EAAE,oBAAoB,EAAE,mBAAmB,EAAC,MAAM,iBAAiB,CAAC;AA0B7F,iCAAiC;AACjC,OAAO,EAAC,uBAAuB,EAAC,MAAM,eAAe,CAAC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Mapping helpers from raw OCAPI shapes (snake_case) to canonical
|
|
3
|
+
* {@link JobExecutionInfo} (camelCase).
|
|
4
|
+
*
|
|
5
|
+
* These exist as transitional utilities to bridge the two API shapes. They
|
|
6
|
+
* will be deleted along with the OCAPI ops once OCAPI is removed.
|
|
7
|
+
*
|
|
8
|
+
* @module operations/jobs/ocapi-mapping
|
|
9
|
+
*/
|
|
10
|
+
import type { JobExecution } from './run.js';
|
|
11
|
+
import type { JobExecutionInfo, JobExecutionSearchResults } from './types.js';
|
|
12
|
+
/** Map a raw OCAPI {@link JobExecution} into the canonical shape. */
|
|
13
|
+
export declare function mapOcapiExecution(ocapi: JobExecution): JobExecutionInfo;
|
|
14
|
+
/**
|
|
15
|
+
* Map a canonical {@link JobExecutionInfo} back into the raw OCAPI
|
|
16
|
+
* {@link JobExecution} (snake_case) shape.
|
|
17
|
+
*
|
|
18
|
+
* The reverse of {@link mapOcapiExecution}. System-job operations
|
|
19
|
+
* (site-archive import/export, CAP install/uninstall) expose the raw OCAPI
|
|
20
|
+
* `JobExecution` in their public result/error types; when those operations are
|
|
21
|
+
* served over SCAPI, the canonical result is mapped back through this so the
|
|
22
|
+
* public contract stays identical across backends.
|
|
23
|
+
*
|
|
24
|
+
* Prefers the original OCAPI payload when present in `_raw` (lossless
|
|
25
|
+
* round-trip for the OCAPI path); otherwise projects the canonical fields.
|
|
26
|
+
*/
|
|
27
|
+
export declare function mapCanonicalToOcapiExecution(canonical: JobExecutionInfo): JobExecution;
|
|
28
|
+
/** Map a raw OCAPI search result into the canonical shape. */
|
|
29
|
+
export declare function mapOcapiSearchResult(result: {
|
|
30
|
+
total: number;
|
|
31
|
+
count: number;
|
|
32
|
+
start: number;
|
|
33
|
+
hits: JobExecution[];
|
|
34
|
+
}): JobExecutionSearchResults;
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
function mapStepExecution(step) {
|
|
2
|
+
return {
|
|
3
|
+
id: step.id,
|
|
4
|
+
stepId: step.step_id,
|
|
5
|
+
executionStatus: step.execution_status,
|
|
6
|
+
exitStatus: step.exit_status
|
|
7
|
+
? {
|
|
8
|
+
code: step.exit_status.code ?? '',
|
|
9
|
+
message: step.exit_status.message,
|
|
10
|
+
status: step.exit_status.status,
|
|
11
|
+
}
|
|
12
|
+
: undefined,
|
|
13
|
+
duration: step.duration,
|
|
14
|
+
};
|
|
15
|
+
}
|
|
16
|
+
/** Map a raw OCAPI {@link JobExecution} into the canonical shape. */
|
|
17
|
+
export function mapOcapiExecution(ocapi) {
|
|
18
|
+
return {
|
|
19
|
+
id: ocapi.id ?? '',
|
|
20
|
+
jobId: ocapi.job_id ?? '',
|
|
21
|
+
executionStatus: (ocapi.execution_status ?? 'unknown'),
|
|
22
|
+
exitStatus: ocapi.exit_status
|
|
23
|
+
? {
|
|
24
|
+
code: ocapi.exit_status.code ?? '',
|
|
25
|
+
message: ocapi.exit_status.message,
|
|
26
|
+
status: ocapi.exit_status.status,
|
|
27
|
+
}
|
|
28
|
+
: undefined,
|
|
29
|
+
startTime: ocapi.start_time,
|
|
30
|
+
endTime: ocapi.end_time,
|
|
31
|
+
duration: ocapi.duration,
|
|
32
|
+
stepExecutions: ocapi.step_executions?.map(mapStepExecution),
|
|
33
|
+
logFilePath: ocapi.log_file_path,
|
|
34
|
+
isLogFileExisting: ocapi.is_log_file_existing,
|
|
35
|
+
parameters: ocapi.parameters,
|
|
36
|
+
_raw: ocapi,
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
function mapCanonicalStepExecution(step) {
|
|
40
|
+
return {
|
|
41
|
+
id: step.id,
|
|
42
|
+
step_id: step.stepId,
|
|
43
|
+
execution_status: step.executionStatus,
|
|
44
|
+
exit_status: step.exitStatus
|
|
45
|
+
? {
|
|
46
|
+
code: step.exitStatus.code,
|
|
47
|
+
message: step.exitStatus.message,
|
|
48
|
+
status: step.exitStatus.status,
|
|
49
|
+
}
|
|
50
|
+
: undefined,
|
|
51
|
+
duration: step.duration,
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Map a canonical {@link JobExecutionInfo} back into the raw OCAPI
|
|
56
|
+
* {@link JobExecution} (snake_case) shape.
|
|
57
|
+
*
|
|
58
|
+
* The reverse of {@link mapOcapiExecution}. System-job operations
|
|
59
|
+
* (site-archive import/export, CAP install/uninstall) expose the raw OCAPI
|
|
60
|
+
* `JobExecution` in their public result/error types; when those operations are
|
|
61
|
+
* served over SCAPI, the canonical result is mapped back through this so the
|
|
62
|
+
* public contract stays identical across backends.
|
|
63
|
+
*
|
|
64
|
+
* Prefers the original OCAPI payload when present in `_raw` (lossless
|
|
65
|
+
* round-trip for the OCAPI path); otherwise projects the canonical fields.
|
|
66
|
+
*/
|
|
67
|
+
export function mapCanonicalToOcapiExecution(canonical) {
|
|
68
|
+
if (canonical._raw && typeof canonical._raw === 'object' && 'execution_status' in canonical._raw) {
|
|
69
|
+
return canonical._raw;
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
id: canonical.id,
|
|
73
|
+
job_id: canonical.jobId,
|
|
74
|
+
execution_status: canonical.executionStatus,
|
|
75
|
+
exit_status: canonical.exitStatus
|
|
76
|
+
? {
|
|
77
|
+
code: canonical.exitStatus.code,
|
|
78
|
+
message: canonical.exitStatus.message,
|
|
79
|
+
status: canonical.exitStatus.status,
|
|
80
|
+
}
|
|
81
|
+
: undefined,
|
|
82
|
+
start_time: canonical.startTime,
|
|
83
|
+
end_time: canonical.endTime,
|
|
84
|
+
duration: canonical.duration,
|
|
85
|
+
step_executions: canonical.stepExecutions?.map(mapCanonicalStepExecution),
|
|
86
|
+
log_file_path: canonical.logFilePath,
|
|
87
|
+
is_log_file_existing: canonical.isLogFileExisting,
|
|
88
|
+
parameters: canonical.parameters,
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
/** Map a raw OCAPI search result into the canonical shape. */
|
|
92
|
+
export function mapOcapiSearchResult(result) {
|
|
93
|
+
return {
|
|
94
|
+
total: result.total,
|
|
95
|
+
limit: result.count,
|
|
96
|
+
offset: result.start,
|
|
97
|
+
hits: result.hits.map(mapOcapiExecution),
|
|
98
|
+
};
|
|
99
|
+
}
|
|
100
|
+
//# sourceMappingURL=ocapi-mapping.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ocapi-mapping.js","sourceRoot":"","sources":["../../../../src/operations/jobs/ocapi-mapping.ts"],"names":[],"mappings":"AAiBA,SAAS,gBAAgB,CAAC,IAAsB;IAC9C,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,MAAM,EAAE,IAAI,CAAC,OAAO;QACpB,eAAe,EAAE,IAAI,CAAC,gBAAgB;QACtC,UAAU,EAAE,IAAI,CAAC,WAAW;YAC1B,CAAC,CAAC;gBACE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE;gBACjC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;gBACjC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,MAAoC;aAC9D;YACH,CAAC,CAAC,SAAS;QACb,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACxB,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,iBAAiB,CAAC,KAAmB;IACnD,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,EAAE;QAClB,KAAK,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE;QACzB,eAAe,EAAE,CAAC,KAAK,CAAC,gBAAgB,IAAI,SAAS,CAAwC;QAC7F,UAAU,EAAE,KAAK,CAAC,WAAW;YAC3B,CAAC,CAAC;gBACE,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE;gBAClC,OAAO,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO;gBAClC,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,MAAoC;aAC/D;YACH,CAAC,CAAC,SAAS;QACb,SAAS,EAAE,KAAK,CAAC,UAAU;QAC3B,OAAO,EAAE,KAAK,CAAC,QAAQ;QACvB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,cAAc,EAAE,KAAK,CAAC,eAAe,EAAE,GAAG,CAAC,gBAAgB,CAAC;QAC5D,WAAW,EAAE,KAAK,CAAC,aAAa;QAChC,iBAAiB,EAAE,KAAK,CAAC,oBAAoB;QAC7C,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,IAAI,EAAE,KAAK;KACZ,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,IAA4B;IAC7D,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,OAAO,EAAE,IAAI,CAAC,MAAM;QACpB,gBAAgB,EAAE,IAAI,CAAC,eAAuD;QAC9E,WAAW,EAAE,IAAI,CAAC,UAAU;YAC1B,CAAC,CAAC;gBACE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;gBAC1B,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO;gBAChC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM;aAC/B;YACH,CAAC,CAAC,SAAS;QACb,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACJ,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,4BAA4B,CAAC,SAA2B;IACtE,IAAI,SAAS,CAAC,IAAI,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,IAAI,kBAAkB,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;QACjG,OAAO,SAAS,CAAC,IAAoB,CAAC;IACxC,CAAC;IAED,OAAO;QACL,EAAE,EAAE,SAAS,CAAC,EAAE;QAChB,MAAM,EAAE,SAAS,CAAC,KAAK;QACvB,gBAAgB,EAAE,SAAS,CAAC,eAAmD;QAC/E,WAAW,EAAE,SAAS,CAAC,UAAU;YAC/B,CAAC,CAAC;gBACE,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,IAAI;gBAC/B,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,OAAO;gBACrC,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,MAAM;aACpC;YACH,CAAC,CAAC,SAAS;QACb,UAAU,EAAE,SAAS,CAAC,SAAS;QAC/B,QAAQ,EAAE,SAAS,CAAC,OAAO;QAC3B,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,eAAe,EAAE,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,yBAAyB,CAAC;QACzE,aAAa,EAAE,SAAS,CAAC,WAAW;QACpC,oBAAoB,EAAE,SAAS,CAAC,iBAAiB;QACjD,UAAU,EAAE,SAAS,CAAC,UAAU;KACjB,CAAC;AACpB,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,oBAAoB,CAAC,MAKpC;IACC,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,MAAM,EAAE,MAAM,CAAC,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC;KACzC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Dual-backend runner for B2C Commerce **system jobs** (site-archive
|
|
3
|
+
* import/export, CAP install/uninstall).
|
|
4
|
+
*
|
|
5
|
+
* These operations all follow the same shape: trigger a named system job,
|
|
6
|
+
* wait for it to finish, and surface the job log on failure. This module
|
|
7
|
+
* centralizes that flow over either backend so each operation declares only
|
|
8
|
+
* its job ID and request body — not the OCAPI-vs-SCAPI plumbing.
|
|
9
|
+
*
|
|
10
|
+
* ## Contract
|
|
11
|
+
*
|
|
12
|
+
* The public result/error types of every caller expose the **raw OCAPI**
|
|
13
|
+
* {@link JobExecution} (snake_case). To keep that contract identical across
|
|
14
|
+
* backends, the SCAPI path maps its canonical result back to the OCAPI shape
|
|
15
|
+
* via {@link mapCanonicalToOcapiExecution}, and a SCAPI job failure is
|
|
16
|
+
* re-thrown as the raw {@link JobExecutionError} — so a caller's existing
|
|
17
|
+
* `catch (JobExecutionError) → getJobLog(instance, err.execution)` works
|
|
18
|
+
* unchanged regardless of which backend served the job.
|
|
19
|
+
*
|
|
20
|
+
* ## Backend selection & fallback
|
|
21
|
+
*
|
|
22
|
+
* Honors {@link B2CInstance.apiBackend}:
|
|
23
|
+
* - `'ocapi'`: always OCAPI.
|
|
24
|
+
* - `'scapi'`: always SCAPI (throws if the instance can't reach SCAPI).
|
|
25
|
+
* - `'auto'` (default): SCAPI when {@link B2CInstance.scapiClientConfig} is
|
|
26
|
+
* available, else OCAPI. **Fallback to OCAPI happens only when the SCAPI
|
|
27
|
+
* start provably created no job** — an Account Manager scope rejection
|
|
28
|
+
* (before the POST) or a client-side rejection status (the server refused
|
|
29
|
+
* the start). Ambiguous failures (network drop after dispatch, timeout,
|
|
30
|
+
* 5xx) and any post-start failure propagate without a re-run, because
|
|
31
|
+
* re-running a mutating system job over OCAPI could execute it twice. See
|
|
32
|
+
* {@link isSafeStartFallback}.
|
|
33
|
+
*
|
|
34
|
+
* ## Lifecycle
|
|
35
|
+
*
|
|
36
|
+
* Lives alongside the other transitional jobs plumbing. When OCAPI is removed,
|
|
37
|
+
* delete the OCAPI branch and inline the SCAPI calls.
|
|
38
|
+
*
|
|
39
|
+
* @module operations/jobs/run-system-job
|
|
40
|
+
*/
|
|
41
|
+
import type { B2CInstance } from '../../instance/index.js';
|
|
42
|
+
import { type JobExecution, type WaitForJobOptions } from './run.js';
|
|
43
|
+
/**
|
|
44
|
+
* Declarative description of a system job to run. The operation supplies its
|
|
45
|
+
* job ID and the two request-body forms; this module drives the rest.
|
|
46
|
+
*/
|
|
47
|
+
export interface SystemJobSpec {
|
|
48
|
+
/** System job ID, e.g. `sfcc-site-archive-import`. */
|
|
49
|
+
jobId: string;
|
|
50
|
+
/**
|
|
51
|
+
* System-job configuration sent on both APIs (e.g.
|
|
52
|
+
* `{file_name}`, `{export_file, data_units}`, or the CAP `{app_name, ...}`
|
|
53
|
+
* shape). These system jobs retain snake_case fields on SCAPI. When the
|
|
54
|
+
* instance rejects it with `UnknownPropertyException`, the
|
|
55
|
+
* OCAPI path retries with {@link parameters}.
|
|
56
|
+
*/
|
|
57
|
+
body: Record<string, unknown>;
|
|
58
|
+
/**
|
|
59
|
+
* Job parameters (`[{name, value}]`) for the OCAPI internal-user retry.
|
|
60
|
+
* System jobs do not use the generic SCAPI JobExecutionRequest body.
|
|
61
|
+
*/
|
|
62
|
+
parameters: Array<{
|
|
63
|
+
name: string;
|
|
64
|
+
value: string;
|
|
65
|
+
}>;
|
|
66
|
+
/** Scopes named in the OCAPI-deprecation error (the rw jobs scope). */
|
|
67
|
+
deprecatedScopes?: string[];
|
|
68
|
+
/** Whether to wait for completion (default `true`). */
|
|
69
|
+
wait?: boolean;
|
|
70
|
+
/** Wait options forwarded to the poll loop. */
|
|
71
|
+
waitOptions?: WaitForJobOptions;
|
|
72
|
+
/** Human-readable verb for error messages, e.g. `'execute import job'`. */
|
|
73
|
+
failVerb: string;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Starts a system job (waiting for completion unless `spec.wait === false`)
|
|
77
|
+
* and returns the raw OCAPI {@link JobExecution}. Throws {@link JobExecutionError}
|
|
78
|
+
* (raw) when the job fails, or {@link OcapiDeprecatedError} when the only
|
|
79
|
+
* reachable backend is a deprecated OCAPI.
|
|
80
|
+
*/
|
|
81
|
+
export declare function runSystemJob(instance: B2CInstance, spec: SystemJobSpec): Promise<JobExecution>;
|