@salesforce/b2c-tooling-sdk 1.9.0 → 1.11.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 +37 -0
- package/dist/esm/config/dw-json.d.ts +9 -2
- package/dist/esm/config/dw-json.js.map +1 -1
- package/dist/esm/config/index.d.ts +2 -2
- package/dist/esm/config/index.js +1 -1
- package/dist/esm/config/index.js.map +1 -1
- package/dist/esm/config/mapping.d.ts +7 -1
- package/dist/esm/config/mapping.js +10 -0
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/sources/package-json-source.js +1 -0
- package/dist/esm/config/sources/package-json-source.js.map +1 -1
- package/dist/esm/config/types.d.ts +23 -2
- package/dist/esm/operations/content/validate.js +46 -4
- package/dist/esm/operations/content/validate.js.map +1 -1
- package/dist/esm/operations/jobs/site-archive.d.ts +12 -0
- package/dist/esm/operations/jobs/site-archive.js +107 -3
- package/dist/esm/operations/jobs/site-archive.js.map +1 -1
- package/package.json +73 -285
- package/dist/cjs/auth/api-key.d.ts +0 -28
- package/dist/cjs/auth/api-key.js +0 -45
- package/dist/cjs/auth/api-key.js.map +0 -1
- package/dist/cjs/auth/basic.d.ts +0 -7
- package/dist/cjs/auth/basic.js +0 -20
- package/dist/cjs/auth/basic.js.map +0 -1
- package/dist/cjs/auth/index.d.ts +0 -74
- package/dist/cjs/auth/index.js +0 -76
- package/dist/cjs/auth/index.js.map +0 -1
- package/dist/cjs/auth/jwt-utils.d.ts +0 -25
- package/dist/cjs/auth/jwt-utils.js +0 -66
- package/dist/cjs/auth/jwt-utils.js.map +0 -1
- package/dist/cjs/auth/middleware.d.ts +0 -196
- package/dist/cjs/auth/middleware.js +0 -190
- package/dist/cjs/auth/middleware.js.map +0 -1
- package/dist/cjs/auth/oauth-implicit.d.ts +0 -89
- package/dist/cjs/auth/oauth-implicit.js +0 -350
- package/dist/cjs/auth/oauth-implicit.js.map +0 -1
- package/dist/cjs/auth/oauth-jwt.d.ts +0 -99
- package/dist/cjs/auth/oauth-jwt.js +0 -343
- package/dist/cjs/auth/oauth-jwt.js.map +0 -1
- package/dist/cjs/auth/oauth.d.ts +0 -88
- package/dist/cjs/auth/oauth.js +0 -252
- package/dist/cjs/auth/oauth.js.map +0 -1
- package/dist/cjs/auth/resolve.d.ts +0 -100
- package/dist/cjs/auth/resolve.js +0 -175
- package/dist/cjs/auth/resolve.js.map +0 -1
- package/dist/cjs/auth/stateful-oauth-strategy.d.ts +0 -39
- package/dist/cjs/auth/stateful-oauth-strategy.js +0 -130
- package/dist/cjs/auth/stateful-oauth-strategy.js.map +0 -1
- package/dist/cjs/auth/stateful-store.d.ts +0 -49
- package/dist/cjs/auth/stateful-store.js +0 -166
- package/dist/cjs/auth/stateful-store.js.map +0 -1
- package/dist/cjs/auth/types.d.ts +0 -124
- package/dist/cjs/auth/types.js +0 -8
- package/dist/cjs/auth/types.js.map +0 -1
- package/dist/cjs/cli/am-command.d.ts +0 -74
- package/dist/cjs/cli/am-command.js +0 -199
- package/dist/cjs/cli/am-command.js.map +0 -1
- package/dist/cjs/cli/base-command.d.ts +0 -232
- package/dist/cjs/cli/base-command.js +0 -695
- package/dist/cjs/cli/base-command.js.map +0 -1
- package/dist/cjs/cli/cartridge-command.d.ts +0 -67
- package/dist/cjs/cli/cartridge-command.js +0 -146
- package/dist/cjs/cli/cartridge-command.js.map +0 -1
- package/dist/cjs/cli/cartridge-providers.d.ts +0 -149
- package/dist/cjs/cli/cartridge-providers.js +0 -103
- package/dist/cjs/cli/cartridge-providers.js.map +0 -1
- package/dist/cjs/cli/columns.d.ts +0 -128
- package/dist/cjs/cli/columns.js +0 -128
- package/dist/cjs/cli/columns.js.map +0 -1
- package/dist/cjs/cli/config.d.ts +0 -159
- package/dist/cjs/cli/config.js +0 -185
- package/dist/cjs/cli/config.js.map +0 -1
- package/dist/cjs/cli/details.d.ts +0 -69
- package/dist/cjs/cli/details.js +0 -72
- package/dist/cjs/cli/details.js.map +0 -1
- package/dist/cjs/cli/hooks.d.ts +0 -324
- package/dist/cjs/cli/hooks.js +0 -3
- package/dist/cjs/cli/hooks.js.map +0 -1
- package/dist/cjs/cli/index.d.ts +0 -108
- package/dist/cjs/cli/index.js +0 -111
- package/dist/cjs/cli/index.js.map +0 -1
- package/dist/cjs/cli/instance-command.d.ts +0 -131
- package/dist/cjs/cli/instance-command.js +0 -214
- package/dist/cjs/cli/instance-command.js.map +0 -1
- package/dist/cjs/cli/job-command.d.ts +0 -32
- package/dist/cjs/cli/job-command.js +0 -60
- package/dist/cjs/cli/job-command.js.map +0 -1
- package/dist/cjs/cli/lifecycle.d.ts +0 -189
- package/dist/cjs/cli/lifecycle.js +0 -130
- package/dist/cjs/cli/lifecycle.js.map +0 -1
- package/dist/cjs/cli/mrt-command.d.ts +0 -57
- package/dist/cjs/cli/mrt-command.js +0 -95
- package/dist/cjs/cli/mrt-command.js.map +0 -1
- package/dist/cjs/cli/oauth-command.d.ts +0 -122
- package/dist/cjs/cli/oauth-command.js +0 -311
- package/dist/cjs/cli/oauth-command.js.map +0 -1
- package/dist/cjs/cli/ods-command.d.ts +0 -97
- package/dist/cjs/cli/ods-command.js +0 -136
- package/dist/cjs/cli/ods-command.js.map +0 -1
- package/dist/cjs/cli/table.d.ts +0 -113
- package/dist/cjs/cli/table.js +0 -175
- package/dist/cjs/cli/table.js.map +0 -1
- package/dist/cjs/cli/webdav-command.d.ts +0 -110
- package/dist/cjs/cli/webdav-command.js +0 -106
- package/dist/cjs/cli/webdav-command.js.map +0 -1
- package/dist/cjs/clients/am-api.d.ts +0 -521
- package/dist/cjs/clients/am-api.js +0 -992
- package/dist/cjs/clients/am-api.js.map +0 -1
- package/dist/cjs/clients/am-apiclients-api.generated.d.ts +0 -803
- package/dist/cjs/clients/am-apiclients-api.generated.js +0 -6
- package/dist/cjs/clients/am-apiclients-api.generated.js.map +0 -1
- package/dist/cjs/clients/am-roles-api.generated.d.ts +0 -298
- package/dist/cjs/clients/am-roles-api.generated.js +0 -6
- package/dist/cjs/clients/am-roles-api.generated.js.map +0 -1
- package/dist/cjs/clients/am-users-api.generated.d.ts +0 -954
- package/dist/cjs/clients/am-users-api.generated.js +0 -6
- package/dist/cjs/clients/am-users-api.generated.js.map +0 -1
- package/dist/cjs/clients/cdn-zones.d.ts +0 -186
- package/dist/cjs/clients/cdn-zones.generated.d.ts +0 -8330
- package/dist/cjs/clients/cdn-zones.generated.js +0 -6
- package/dist/cjs/clients/cdn-zones.generated.js.map +0 -1
- package/dist/cjs/clients/cdn-zones.js +0 -103
- package/dist/cjs/clients/cdn-zones.js.map +0 -1
- package/dist/cjs/clients/cip.d.ts +0 -162
- package/dist/cjs/clients/cip.js +0 -572
- package/dist/cjs/clients/cip.js.map +0 -1
- package/dist/cjs/clients/custom-apis.d.ts +0 -174
- package/dist/cjs/clients/custom-apis.generated.d.ts +0 -202
- package/dist/cjs/clients/custom-apis.generated.js +0 -6
- package/dist/cjs/clients/custom-apis.generated.js.map +0 -1
- package/dist/cjs/clients/custom-apis.js +0 -140
- package/dist/cjs/clients/custom-apis.js.map +0 -1
- package/dist/cjs/clients/error-utils.d.ts +0 -35
- package/dist/cjs/clients/error-utils.js +0 -69
- package/dist/cjs/clients/error-utils.js.map +0 -1
- package/dist/cjs/clients/granular-replications.d.ts +0 -70
- package/dist/cjs/clients/granular-replications.generated.d.ts +0 -416
- package/dist/cjs/clients/granular-replications.generated.js +0 -6
- package/dist/cjs/clients/granular-replications.generated.js.map +0 -1
- package/dist/cjs/clients/granular-replications.js +0 -73
- package/dist/cjs/clients/granular-replications.js.map +0 -1
- package/dist/cjs/clients/index.d.ts +0 -145
- package/dist/cjs/clients/index.js +0 -137
- package/dist/cjs/clients/index.js.map +0 -1
- package/dist/cjs/clients/middleware-registry.d.ts +0 -184
- package/dist/cjs/clients/middleware-registry.js +0 -104
- package/dist/cjs/clients/middleware-registry.js.map +0 -1
- package/dist/cjs/clients/middleware.d.ts +0 -183
- package/dist/cjs/clients/middleware.js +0 -465
- package/dist/cjs/clients/middleware.js.map +0 -1
- package/dist/cjs/clients/mrt-b2c.d.ts +0 -138
- package/dist/cjs/clients/mrt-b2c.generated.d.ts +0 -176
- package/dist/cjs/clients/mrt-b2c.generated.js +0 -6
- package/dist/cjs/clients/mrt-b2c.generated.js.map +0 -1
- package/dist/cjs/clients/mrt-b2c.js +0 -86
- package/dist/cjs/clients/mrt-b2c.js.map +0 -1
- package/dist/cjs/clients/mrt.d.ts +0 -143
- package/dist/cjs/clients/mrt.generated.d.ts +0 -3806
- package/dist/cjs/clients/mrt.generated.js +0 -6
- package/dist/cjs/clients/mrt.generated.js.map +0 -1
- package/dist/cjs/clients/mrt.js +0 -93
- package/dist/cjs/clients/mrt.js.map +0 -1
- package/dist/cjs/clients/ocapi.d.ts +0 -128
- package/dist/cjs/clients/ocapi.generated.d.ts +0 -26052
- package/dist/cjs/clients/ocapi.generated.js +0 -6
- package/dist/cjs/clients/ocapi.generated.js.map +0 -1
- package/dist/cjs/clients/ocapi.js +0 -78
- package/dist/cjs/clients/ocapi.js.map +0 -1
- package/dist/cjs/clients/ods.d.ts +0 -160
- package/dist/cjs/clients/ods.generated.d.ts +0 -2860
- package/dist/cjs/clients/ods.generated.js +0 -6
- package/dist/cjs/clients/ods.generated.js.map +0 -1
- package/dist/cjs/clients/ods.js +0 -103
- package/dist/cjs/clients/ods.js.map +0 -1
- package/dist/cjs/clients/scapi-schemas.d.ts +0 -161
- package/dist/cjs/clients/scapi-schemas.generated.d.ts +0 -328
- package/dist/cjs/clients/scapi-schemas.generated.js +0 -6
- package/dist/cjs/clients/scapi-schemas.generated.js.map +0 -1
- package/dist/cjs/clients/scapi-schemas.js +0 -98
- package/dist/cjs/clients/scapi-schemas.js.map +0 -1
- package/dist/cjs/clients/slas-admin.d.ts +0 -132
- package/dist/cjs/clients/slas-admin.generated.d.ts +0 -1434
- package/dist/cjs/clients/slas-admin.generated.js +0 -6
- package/dist/cjs/clients/slas-admin.generated.js.map +0 -1
- package/dist/cjs/clients/slas-admin.js +0 -79
- package/dist/cjs/clients/slas-admin.js.map +0 -1
- package/dist/cjs/clients/tls-dispatcher.d.ts +0 -42
- package/dist/cjs/clients/tls-dispatcher.js +0 -107
- package/dist/cjs/clients/tls-dispatcher.js.map +0 -1
- package/dist/cjs/clients/user-agent.d.ts +0 -43
- package/dist/cjs/clients/user-agent.js +0 -87
- package/dist/cjs/clients/user-agent.js.map +0 -1
- package/dist/cjs/clients/webdav.d.ts +0 -186
- package/dist/cjs/clients/webdav.js +0 -395
- package/dist/cjs/clients/webdav.js.map +0 -1
- package/dist/cjs/config/config-source-registry.d.ts +0 -115
- package/dist/cjs/config/config-source-registry.js +0 -103
- package/dist/cjs/config/config-source-registry.js.map +0 -1
- package/dist/cjs/config/dw-json.d.ts +0 -267
- package/dist/cjs/config/dw-json.js +0 -333
- package/dist/cjs/config/dw-json.js.map +0 -1
- package/dist/cjs/config/index.d.ts +0 -100
- package/dist/cjs/config/index.js +0 -110
- package/dist/cjs/config/index.js.map +0 -1
- package/dist/cjs/config/instance-manager.d.ts +0 -97
- package/dist/cjs/config/instance-manager.js +0 -166
- package/dist/cjs/config/instance-manager.js.map +0 -1
- package/dist/cjs/config/mapping.d.ts +0 -193
- package/dist/cjs/config/mapping.js +0 -530
- package/dist/cjs/config/mapping.js.map +0 -1
- package/dist/cjs/config/resolved-config.d.ts +0 -29
- package/dist/cjs/config/resolved-config.js +0 -81
- package/dist/cjs/config/resolved-config.js.map +0 -1
- package/dist/cjs/config/resolver.d.ts +0 -191
- package/dist/cjs/config/resolver.js +0 -406
- package/dist/cjs/config/resolver.js.map +0 -1
- package/dist/cjs/config/sources/dw-json-source.d.ts +0 -27
- package/dist/cjs/config/sources/dw-json-source.js +0 -106
- package/dist/cjs/config/sources/dw-json-source.js.map +0 -1
- package/dist/cjs/config/sources/env-source.d.ts +0 -32
- package/dist/cjs/config/sources/env-source.js +0 -116
- package/dist/cjs/config/sources/env-source.js.map +0 -1
- package/dist/cjs/config/sources/index.d.ts +0 -9
- package/dist/cjs/config/sources/index.js +0 -15
- package/dist/cjs/config/sources/index.js.map +0 -1
- package/dist/cjs/config/sources/mobify-source.d.ts +0 -25
- package/dist/cjs/config/sources/mobify-source.js +0 -84
- package/dist/cjs/config/sources/mobify-source.js.map +0 -1
- package/dist/cjs/config/sources/package-json-source.d.ts +0 -14
- package/dist/cjs/config/sources/package-json-source.js +0 -96
- package/dist/cjs/config/sources/package-json-source.js.map +0 -1
- package/dist/cjs/config/types.d.ts +0 -407
- package/dist/cjs/config/types.js +0 -2
- package/dist/cjs/config/types.js.map +0 -1
- package/dist/cjs/defaults.d.ts +0 -36
- package/dist/cjs/defaults.js +0 -54
- package/dist/cjs/defaults.js.map +0 -1
- package/dist/cjs/discovery/detector.d.ts +0 -75
- package/dist/cjs/discovery/detector.js +0 -108
- package/dist/cjs/discovery/detector.js.map +0 -1
- package/dist/cjs/discovery/index.d.ts +0 -63
- package/dist/cjs/discovery/index.js +0 -70
- package/dist/cjs/discovery/index.js.map +0 -1
- package/dist/cjs/discovery/patterns/cartridges.d.ts +0 -16
- package/dist/cjs/discovery/patterns/cartridges.js +0 -16
- package/dist/cjs/discovery/patterns/cartridges.js.map +0 -1
- package/dist/cjs/discovery/patterns/index.d.ts +0 -21
- package/dist/cjs/discovery/patterns/index.js +0 -16
- package/dist/cjs/discovery/patterns/index.js.map +0 -1
- package/dist/cjs/discovery/patterns/pwa-kit.d.ts +0 -15
- package/dist/cjs/discovery/patterns/pwa-kit.js +0 -26
- package/dist/cjs/discovery/patterns/pwa-kit.js.map +0 -1
- package/dist/cjs/discovery/patterns/sfra.d.ts +0 -34
- package/dist/cjs/discovery/patterns/sfra.js +0 -50
- package/dist/cjs/discovery/patterns/sfra.js.map +0 -1
- package/dist/cjs/discovery/patterns/storefront-next.d.ts +0 -10
- package/dist/cjs/discovery/patterns/storefront-next.js +0 -65
- package/dist/cjs/discovery/patterns/storefront-next.js.map +0 -1
- package/dist/cjs/discovery/types.d.ts +0 -47
- package/dist/cjs/discovery/types.js +0 -12
- package/dist/cjs/discovery/types.js.map +0 -1
- package/dist/cjs/discovery/utils.d.ts +0 -44
- package/dist/cjs/discovery/utils.js +0 -82
- package/dist/cjs/discovery/utils.js.map +0 -1
- package/dist/cjs/docs/download.d.ts +0 -45
- package/dist/cjs/docs/download.js +0 -96
- package/dist/cjs/docs/download.js.map +0 -1
- package/dist/cjs/docs/index.d.ts +0 -44
- package/dist/cjs/docs/index.js +0 -12
- package/dist/cjs/docs/index.js.map +0 -1
- package/dist/cjs/docs/schema.d.ts +0 -26
- package/dist/cjs/docs/schema.js +0 -92
- package/dist/cjs/docs/schema.js.map +0 -1
- package/dist/cjs/docs/search.d.ts +0 -67
- package/dist/cjs/docs/search.js +0 -128
- package/dist/cjs/docs/search.js.map +0 -1
- package/dist/cjs/docs/types.d.ts +0 -64
- package/dist/cjs/docs/types.js +0 -15
- package/dist/cjs/docs/types.js.map +0 -1
- package/dist/cjs/errors/http-error.d.ts +0 -34
- package/dist/cjs/errors/http-error.js +0 -45
- package/dist/cjs/errors/http-error.js.map +0 -1
- package/dist/cjs/errors/index.d.ts +0 -12
- package/dist/cjs/errors/index.js +0 -18
- package/dist/cjs/errors/index.js.map +0 -1
- package/dist/cjs/i18n/index.d.ts +0 -144
- package/dist/cjs/i18n/index.js +0 -245
- package/dist/cjs/i18n/index.js.map +0 -1
- package/dist/cjs/i18n/locales/de.d.ts +0 -13
- package/dist/cjs/i18n/locales/de.js +0 -19
- package/dist/cjs/i18n/locales/de.js.map +0 -1
- package/dist/cjs/i18n/locales/index.d.ts +0 -28
- package/dist/cjs/i18n/locales/index.js +0 -25
- package/dist/cjs/i18n/locales/index.js.map +0 -1
- package/dist/cjs/index.d.ts +0 -33
- package/dist/cjs/index.js +0 -41
- package/dist/cjs/index.js.map +0 -1
- package/dist/cjs/instance/index.d.ts +0 -136
- package/dist/cjs/instance/index.js +0 -131
- package/dist/cjs/instance/index.js.map +0 -1
- package/dist/cjs/logging/index.d.ts +0 -116
- package/dist/cjs/logging/index.js +0 -121
- package/dist/cjs/logging/index.js.map +0 -1
- package/dist/cjs/logging/logger.d.ts +0 -9
- package/dist/cjs/logging/logger.js +0 -138
- package/dist/cjs/logging/logger.js.map +0 -1
- package/dist/cjs/logging/types.d.ts +0 -45
- package/dist/cjs/logging/types.js +0 -10
- package/dist/cjs/logging/types.js.map +0 -1
- package/dist/cjs/operations/bm-roles/index.d.ts +0 -52
- package/dist/cjs/operations/bm-roles/index.js +0 -57
- package/dist/cjs/operations/bm-roles/index.js.map +0 -1
- package/dist/cjs/operations/bm-roles/roles.d.ts +0 -155
- package/dist/cjs/operations/bm-roles/roles.js +0 -194
- package/dist/cjs/operations/bm-roles/roles.js.map +0 -1
- package/dist/cjs/operations/bm-users/index.d.ts +0 -50
- package/dist/cjs/operations/bm-users/index.js +0 -55
- package/dist/cjs/operations/bm-users/index.js.map +0 -1
- package/dist/cjs/operations/bm-users/users.d.ts +0 -189
- package/dist/cjs/operations/bm-users/users.js +0 -229
- package/dist/cjs/operations/bm-users/users.js.map +0 -1
- package/dist/cjs/operations/cap/index.d.ts +0 -56
- package/dist/cjs/operations/cap/index.js +0 -57
- package/dist/cjs/operations/cap/index.js.map +0 -1
- package/dist/cjs/operations/cap/install.d.ts +0 -53
- package/dist/cjs/operations/cap/install.js +0 -181
- package/dist/cjs/operations/cap/install.js.map +0 -1
- package/dist/cjs/operations/cap/list.d.ts +0 -92
- package/dist/cjs/operations/cap/list.js +0 -230
- package/dist/cjs/operations/cap/list.js.map +0 -1
- package/dist/cjs/operations/cap/package.d.ts +0 -39
- package/dist/cjs/operations/cap/package.js +0 -77
- package/dist/cjs/operations/cap/package.js.map +0 -1
- package/dist/cjs/operations/cap/pull.d.ts +0 -21
- package/dist/cjs/operations/cap/pull.js +0 -77
- package/dist/cjs/operations/cap/pull.js.map +0 -1
- package/dist/cjs/operations/cap/uninstall.d.ts +0 -46
- package/dist/cjs/operations/cap/uninstall.js +0 -87
- package/dist/cjs/operations/cap/uninstall.js.map +0 -1
- package/dist/cjs/operations/cap/validate.d.ts +0 -47
- package/dist/cjs/operations/cap/validate.js +0 -235
- package/dist/cjs/operations/cap/validate.js.map +0 -1
- package/dist/cjs/operations/cip/index.d.ts +0 -35
- package/dist/cjs/operations/cip/index.js +0 -128
- package/dist/cjs/operations/cip/index.js.map +0 -1
- package/dist/cjs/operations/cip/reports.d.ts +0 -2
- package/dist/cjs/operations/cip/reports.js +0 -210
- package/dist/cjs/operations/cip/reports.js.map +0 -1
- package/dist/cjs/operations/cip/types.d.ts +0 -97
- package/dist/cjs/operations/cip/types.js +0 -7
- package/dist/cjs/operations/cip/types.js.map +0 -1
- package/dist/cjs/operations/code/cartridges.d.ts +0 -46
- package/dist/cjs/operations/code/cartridges.js +0 -69
- package/dist/cjs/operations/code/cartridges.js.map +0 -1
- package/dist/cjs/operations/code/deploy.d.ts +0 -121
- package/dist/cjs/operations/code/deploy.js +0 -255
- package/dist/cjs/operations/code/deploy.js.map +0 -1
- package/dist/cjs/operations/code/download.d.ts +0 -77
- package/dist/cjs/operations/code/download.js +0 -300
- package/dist/cjs/operations/code/download.js.map +0 -1
- package/dist/cjs/operations/code/index.d.ts +0 -74
- package/dist/cjs/operations/code/index.js +0 -80
- package/dist/cjs/operations/code/index.js.map +0 -1
- package/dist/cjs/operations/code/upload-files.d.ts +0 -47
- package/dist/cjs/operations/code/upload-files.js +0 -116
- package/dist/cjs/operations/code/upload-files.js.map +0 -1
- package/dist/cjs/operations/code/versions.d.ts +0 -99
- package/dist/cjs/operations/code/versions.js +0 -156
- package/dist/cjs/operations/code/versions.js.map +0 -1
- package/dist/cjs/operations/code/watch.d.ts +0 -58
- package/dist/cjs/operations/code/watch.js +0 -175
- package/dist/cjs/operations/code/watch.js.map +0 -1
- package/dist/cjs/operations/content/asset-query.d.ts +0 -22
- package/dist/cjs/operations/content/asset-query.js +0 -77
- package/dist/cjs/operations/content/asset-query.js.map +0 -1
- package/dist/cjs/operations/content/export.d.ts +0 -57
- package/dist/cjs/operations/content/export.js +0 -221
- package/dist/cjs/operations/content/export.js.map +0 -1
- package/dist/cjs/operations/content/index.d.ts +0 -56
- package/dist/cjs/operations/content/index.js +0 -60
- package/dist/cjs/operations/content/index.js.map +0 -1
- package/dist/cjs/operations/content/library.d.ts +0 -137
- package/dist/cjs/operations/content/library.js +0 -396
- package/dist/cjs/operations/content/library.js.map +0 -1
- package/dist/cjs/operations/content/types.d.ts +0 -144
- package/dist/cjs/operations/content/types.js +0 -7
- package/dist/cjs/operations/content/types.js.map +0 -1
- package/dist/cjs/operations/content/validate.d.ts +0 -64
- package/dist/cjs/operations/content/validate.js +0 -170
- package/dist/cjs/operations/content/validate.js.map +0 -1
- package/dist/cjs/operations/debug/dap-adapter.d.ts +0 -72
- package/dist/cjs/operations/debug/dap-adapter.js +0 -505
- package/dist/cjs/operations/debug/dap-adapter.js.map +0 -1
- package/dist/cjs/operations/debug/debug-session.d.ts +0 -51
- package/dist/cjs/operations/debug/debug-session.js +0 -234
- package/dist/cjs/operations/debug/debug-session.js.map +0 -1
- package/dist/cjs/operations/debug/index.d.ts +0 -20
- package/dist/cjs/operations/debug/index.js +0 -21
- package/dist/cjs/operations/debug/index.js.map +0 -1
- package/dist/cjs/operations/debug/projections.d.ts +0 -72
- package/dist/cjs/operations/debug/projections.js +0 -84
- package/dist/cjs/operations/debug/projections.js.map +0 -1
- package/dist/cjs/operations/debug/resolve-path.d.ts +0 -15
- package/dist/cjs/operations/debug/resolve-path.js +0 -52
- package/dist/cjs/operations/debug/resolve-path.js.map +0 -1
- package/dist/cjs/operations/debug/sdapi-client.d.ts +0 -44
- package/dist/cjs/operations/debug/sdapi-client.js +0 -169
- package/dist/cjs/operations/debug/sdapi-client.js.map +0 -1
- package/dist/cjs/operations/debug/source-mapping.d.ts +0 -13
- package/dist/cjs/operations/debug/source-mapping.js +0 -57
- package/dist/cjs/operations/debug/source-mapping.js.map +0 -1
- package/dist/cjs/operations/debug/types.d.ts +0 -95
- package/dist/cjs/operations/debug/types.js +0 -2
- package/dist/cjs/operations/debug/types.js.map +0 -1
- package/dist/cjs/operations/debug/variable-store.d.ts +0 -35
- package/dist/cjs/operations/debug/variable-store.js +0 -52
- package/dist/cjs/operations/debug/variable-store.js.map +0 -1
- package/dist/cjs/operations/jobs/index.d.ts +0 -66
- package/dist/cjs/operations/jobs/index.js +0 -72
- package/dist/cjs/operations/jobs/index.js.map +0 -1
- package/dist/cjs/operations/jobs/run.d.ts +0 -239
- package/dist/cjs/operations/jobs/run.js +0 -324
- package/dist/cjs/operations/jobs/run.js.map +0 -1
- package/dist/cjs/operations/jobs/site-archive.d.ts +0 -267
- package/dist/cjs/operations/jobs/site-archive.js +0 -423
- package/dist/cjs/operations/jobs/site-archive.js.map +0 -1
- package/dist/cjs/operations/logs/index.d.ts +0 -65
- package/dist/cjs/operations/logs/index.js +0 -73
- package/dist/cjs/operations/logs/index.js.map +0 -1
- package/dist/cjs/operations/logs/list.d.ts +0 -35
- package/dist/cjs/operations/logs/list.js +0 -144
- package/dist/cjs/operations/logs/list.js.map +0 -1
- package/dist/cjs/operations/logs/path-normalizer.d.ts +0 -82
- package/dist/cjs/operations/logs/path-normalizer.js +0 -190
- package/dist/cjs/operations/logs/path-normalizer.js.map +0 -1
- package/dist/cjs/operations/logs/tail.d.ts +0 -92
- package/dist/cjs/operations/logs/tail.js +0 -525
- package/dist/cjs/operations/logs/tail.js.map +0 -1
- package/dist/cjs/operations/logs/types.d.ts +0 -132
- package/dist/cjs/operations/logs/types.js +0 -7
- package/dist/cjs/operations/logs/types.js.map +0 -1
- package/dist/cjs/operations/mrt/access-control.d.ts +0 -192
- package/dist/cjs/operations/mrt/access-control.js +0 -152
- package/dist/cjs/operations/mrt/access-control.js.map +0 -1
- package/dist/cjs/operations/mrt/b2c-config.d.ts +0 -201
- package/dist/cjs/operations/mrt/b2c-config.js +0 -210
- package/dist/cjs/operations/mrt/b2c-config.js.map +0 -1
- package/dist/cjs/operations/mrt/bundle.d.ts +0 -114
- package/dist/cjs/operations/mrt/bundle.js +0 -166
- package/dist/cjs/operations/mrt/bundle.js.map +0 -1
- package/dist/cjs/operations/mrt/cache.d.ts +0 -80
- package/dist/cjs/operations/mrt/cache.js +0 -65
- package/dist/cjs/operations/mrt/cache.js.map +0 -1
- package/dist/cjs/operations/mrt/certificate.d.ts +0 -60
- package/dist/cjs/operations/mrt/certificate.js +0 -76
- package/dist/cjs/operations/mrt/certificate.js.map +0 -1
- package/dist/cjs/operations/mrt/deployment.d.ts +0 -157
- package/dist/cjs/operations/mrt/deployment.js +0 -109
- package/dist/cjs/operations/mrt/deployment.js.map +0 -1
- package/dist/cjs/operations/mrt/env-var.d.ts +0 -176
- package/dist/cjs/operations/mrt/env-var.js +0 -231
- package/dist/cjs/operations/mrt/env-var.js.map +0 -1
- package/dist/cjs/operations/mrt/env.d.ts +0 -491
- package/dist/cjs/operations/mrt/env.js +0 -425
- package/dist/cjs/operations/mrt/env.js.map +0 -1
- package/dist/cjs/operations/mrt/index.d.ts +0 -75
- package/dist/cjs/operations/mrt/index.js +0 -81
- package/dist/cjs/operations/mrt/index.js.map +0 -1
- package/dist/cjs/operations/mrt/member.d.ts +0 -281
- package/dist/cjs/operations/mrt/member.js +0 -244
- package/dist/cjs/operations/mrt/member.js.map +0 -1
- package/dist/cjs/operations/mrt/notification.d.ts +0 -252
- package/dist/cjs/operations/mrt/notification.js +0 -206
- package/dist/cjs/operations/mrt/notification.js.map +0 -1
- package/dist/cjs/operations/mrt/organization-member.d.ts +0 -68
- package/dist/cjs/operations/mrt/organization-member.js +0 -88
- package/dist/cjs/operations/mrt/organization-member.js.map +0 -1
- package/dist/cjs/operations/mrt/organization.d.ts +0 -80
- package/dist/cjs/operations/mrt/organization.js +0 -53
- package/dist/cjs/operations/mrt/organization.js.map +0 -1
- package/dist/cjs/operations/mrt/project.d.ts +0 -261
- package/dist/cjs/operations/mrt/project.js +0 -232
- package/dist/cjs/operations/mrt/project.js.map +0 -1
- package/dist/cjs/operations/mrt/push.d.ts +0 -290
- package/dist/cjs/operations/mrt/push.js +0 -288
- package/dist/cjs/operations/mrt/push.js.map +0 -1
- package/dist/cjs/operations/mrt/redirect.d.ts +0 -337
- package/dist/cjs/operations/mrt/redirect.js +0 -256
- package/dist/cjs/operations/mrt/redirect.js.map +0 -1
- package/dist/cjs/operations/mrt/tail-logs.d.ts +0 -130
- package/dist/cjs/operations/mrt/tail-logs.js +0 -224
- package/dist/cjs/operations/mrt/tail-logs.js.map +0 -1
- package/dist/cjs/operations/mrt/user.d.ts +0 -135
- package/dist/cjs/operations/mrt/user.js +0 -153
- package/dist/cjs/operations/mrt/user.js.map +0 -1
- package/dist/cjs/operations/ods/index.d.ts +0 -10
- package/dist/cjs/operations/ods/index.js +0 -14
- package/dist/cjs/operations/ods/index.js.map +0 -1
- package/dist/cjs/operations/ods/sandbox-lookup.d.ts +0 -63
- package/dist/cjs/operations/ods/sandbox-lookup.js +0 -130
- package/dist/cjs/operations/ods/sandbox-lookup.js.map +0 -1
- package/dist/cjs/operations/ods/wait-for-clone.d.ts +0 -46
- package/dist/cjs/operations/ods/wait-for-clone.js +0 -100
- package/dist/cjs/operations/ods/wait-for-clone.js.map +0 -1
- package/dist/cjs/operations/ods/wait-for-sandbox.d.ts +0 -64
- package/dist/cjs/operations/ods/wait-for-sandbox.js +0 -114
- package/dist/cjs/operations/ods/wait-for-sandbox.js.map +0 -1
- package/dist/cjs/operations/orgs/index.d.ts +0 -74
- package/dist/cjs/operations/orgs/index.js +0 -33
- package/dist/cjs/operations/orgs/index.js.map +0 -1
- package/dist/cjs/operations/roles/index.d.ts +0 -43
- package/dist/cjs/operations/roles/index.js +0 -48
- package/dist/cjs/operations/roles/index.js.map +0 -1
- package/dist/cjs/operations/sites/cartridges.d.ts +0 -114
- package/dist/cjs/operations/sites/cartridges.js +0 -378
- package/dist/cjs/operations/sites/cartridges.js.map +0 -1
- package/dist/cjs/operations/sites/index.d.ts +0 -46
- package/dist/cjs/operations/sites/index.js +0 -51
- package/dist/cjs/operations/sites/index.js.map +0 -1
- package/dist/cjs/operations/users/index.d.ts +0 -153
- package/dist/cjs/operations/users/index.js +0 -139
- package/dist/cjs/operations/users/index.js.map +0 -1
- package/dist/cjs/operations/util/zip.d.ts +0 -5
- package/dist/cjs/operations/util/zip.js +0 -25
- package/dist/cjs/operations/util/zip.js.map +0 -1
- package/dist/cjs/package.json +0 -1
- package/dist/cjs/plugins/discovery.d.ts +0 -46
- package/dist/cjs/plugins/discovery.js +0 -122
- package/dist/cjs/plugins/discovery.js.map +0 -1
- package/dist/cjs/plugins/index.d.ts +0 -26
- package/dist/cjs/plugins/index.js +0 -32
- package/dist/cjs/plugins/index.js.map +0 -1
- package/dist/cjs/plugins/loader.d.ts +0 -34
- package/dist/cjs/plugins/loader.js +0 -59
- package/dist/cjs/plugins/loader.js.map +0 -1
- package/dist/cjs/plugins/manager.d.ts +0 -70
- package/dist/cjs/plugins/manager.js +0 -173
- package/dist/cjs/plugins/manager.js.map +0 -1
- package/dist/cjs/safety/index.d.ts +0 -12
- package/dist/cjs/safety/index.js +0 -11
- package/dist/cjs/safety/index.js.map +0 -1
- package/dist/cjs/safety/safety-guard.d.ts +0 -92
- package/dist/cjs/safety/safety-guard.js +0 -270
- package/dist/cjs/safety/safety-guard.js.map +0 -1
- package/dist/cjs/safety/safety-middleware.d.ts +0 -130
- package/dist/cjs/safety/safety-middleware.js +0 -248
- package/dist/cjs/safety/safety-middleware.js.map +0 -1
- package/dist/cjs/safety/types.d.ts +0 -81
- package/dist/cjs/safety/types.js +0 -16
- package/dist/cjs/safety/types.js.map +0 -1
- package/dist/cjs/safety/with-confirmation.d.ts +0 -58
- package/dist/cjs/safety/with-confirmation.js +0 -67
- package/dist/cjs/safety/with-confirmation.js.map +0 -1
- package/dist/cjs/scaffold/engine.d.ts +0 -68
- package/dist/cjs/scaffold/engine.js +0 -149
- package/dist/cjs/scaffold/engine.js.map +0 -1
- package/dist/cjs/scaffold/executor.d.ts +0 -36
- package/dist/cjs/scaffold/executor.js +0 -293
- package/dist/cjs/scaffold/executor.js.map +0 -1
- package/dist/cjs/scaffold/index.d.ts +0 -76
- package/dist/cjs/scaffold/index.js +0 -23
- package/dist/cjs/scaffold/index.js.map +0 -1
- package/dist/cjs/scaffold/merge.d.ts +0 -63
- package/dist/cjs/scaffold/merge.js +0 -192
- package/dist/cjs/scaffold/merge.js.map +0 -1
- package/dist/cjs/scaffold/parameter-resolver.d.ts +0 -86
- package/dist/cjs/scaffold/parameter-resolver.js +0 -191
- package/dist/cjs/scaffold/parameter-resolver.js.map +0 -1
- package/dist/cjs/scaffold/registry.d.ts +0 -60
- package/dist/cjs/scaffold/registry.js +0 -225
- package/dist/cjs/scaffold/registry.js.map +0 -1
- package/dist/cjs/scaffold/sources.d.ts +0 -83
- package/dist/cjs/scaffold/sources.js +0 -236
- package/dist/cjs/scaffold/sources.js.map +0 -1
- package/dist/cjs/scaffold/types.d.ts +0 -282
- package/dist/cjs/scaffold/types.js +0 -14
- package/dist/cjs/scaffold/types.js.map +0 -1
- package/dist/cjs/scaffold/validation.d.ts +0 -81
- package/dist/cjs/scaffold/validation.js +0 -250
- package/dist/cjs/scaffold/validation.js.map +0 -1
- package/dist/cjs/scaffold/validators.d.ts +0 -33
- package/dist/cjs/scaffold/validators.js +0 -340
- package/dist/cjs/scaffold/validators.js.map +0 -1
- package/dist/cjs/schemas/collapse.d.ts +0 -150
- package/dist/cjs/schemas/collapse.js +0 -180
- package/dist/cjs/schemas/collapse.js.map +0 -1
- package/dist/cjs/schemas/index.d.ts +0 -58
- package/dist/cjs/schemas/index.js +0 -65
- package/dist/cjs/schemas/index.js.map +0 -1
- package/dist/cjs/schemas/security-schemes.d.ts +0 -26
- package/dist/cjs/schemas/security-schemes.js +0 -44
- package/dist/cjs/schemas/security-schemes.js.map +0 -1
- package/dist/cjs/skills/agents.d.ts +0 -42
- package/dist/cjs/skills/agents.js +0 -200
- package/dist/cjs/skills/agents.js.map +0 -1
- package/dist/cjs/skills/github.d.ts +0 -31
- package/dist/cjs/skills/github.js +0 -450
- package/dist/cjs/skills/github.js.map +0 -1
- package/dist/cjs/skills/index.d.ts +0 -43
- package/dist/cjs/skills/index.js +0 -16
- package/dist/cjs/skills/index.js.map +0 -1
- package/dist/cjs/skills/installer.d.ts +0 -35
- package/dist/cjs/skills/installer.js +0 -182
- package/dist/cjs/skills/installer.js.map +0 -1
- package/dist/cjs/skills/parser.d.ts +0 -39
- package/dist/cjs/skills/parser.js +0 -126
- package/dist/cjs/skills/parser.js.map +0 -1
- package/dist/cjs/skills/sources.d.ts +0 -4
- package/dist/cjs/skills/sources.js +0 -52
- package/dist/cjs/skills/sources.js.map +0 -1
- package/dist/cjs/skills/types.d.ts +0 -153
- package/dist/cjs/skills/types.js +0 -7
- package/dist/cjs/skills/types.js.map +0 -1
- package/dist/cjs/slas/index.d.ts +0 -12
- package/dist/cjs/slas/index.js +0 -8
- package/dist/cjs/slas/index.js.map +0 -1
- package/dist/cjs/slas/pkce.d.ts +0 -13
- package/dist/cjs/slas/pkce.js +0 -35
- package/dist/cjs/slas/pkce.js.map +0 -1
- package/dist/cjs/slas/token.d.ts +0 -24
- package/dist/cjs/slas/token.js +0 -261
- package/dist/cjs/slas/token.js.map +0 -1
- package/dist/cjs/slas/types.d.ts +0 -43
- package/dist/cjs/slas/types.js +0 -7
- package/dist/cjs/slas/types.js.map +0 -1
- package/dist/cjs/telemetry/index.d.ts +0 -34
- package/dist/cjs/telemetry/index.js +0 -32
- package/dist/cjs/telemetry/index.js.map +0 -1
- package/dist/cjs/telemetry/telemetry.d.ts +0 -88
- package/dist/cjs/telemetry/telemetry.js +0 -298
- package/dist/cjs/telemetry/telemetry.js.map +0 -1
- package/dist/cjs/telemetry/types.d.ts +0 -62
- package/dist/cjs/telemetry/types.js +0 -7
- package/dist/cjs/telemetry/types.js.map +0 -1
- package/dist/cjs/test-utils/config-isolation.d.ts +0 -2
- package/dist/cjs/test-utils/config-isolation.js +0 -48
- package/dist/cjs/test-utils/config-isolation.js.map +0 -1
- package/dist/cjs/test-utils/index.d.ts +0 -1
- package/dist/cjs/test-utils/index.js +0 -7
- package/dist/cjs/test-utils/index.js.map +0 -1
- package/dist/cjs/ux/confirm.d.ts +0 -14
- package/dist/cjs/ux/confirm.js +0 -36
- package/dist/cjs/ux/confirm.js.map +0 -1
- package/dist/cjs/ux/index.d.ts +0 -1
- package/dist/cjs/ux/index.js +0 -7
- package/dist/cjs/ux/index.js.map +0 -1
- package/dist/cjs/version.d.ts +0 -14
- package/dist/cjs/version.js +0 -29
- package/dist/cjs/version.js.map +0 -1
|
@@ -1,267 +0,0 @@
|
|
|
1
|
-
import { B2CInstance } from '../../instance/index.js';
|
|
2
|
-
import { type JobExecution, type WaitForJobOptions } from './run.js';
|
|
3
|
-
/**
|
|
4
|
-
* Options for site archive import.
|
|
5
|
-
*/
|
|
6
|
-
export interface SiteArchiveImportOptions {
|
|
7
|
-
/** Keep archive on instance after import (default: false) */
|
|
8
|
-
keepArchive?: boolean;
|
|
9
|
-
/** Whether to wait for job completion (default: true) */
|
|
10
|
-
wait?: boolean;
|
|
11
|
-
/** Wait options for job completion */
|
|
12
|
-
waitOptions?: WaitForJobOptions;
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* Result of a site archive import.
|
|
16
|
-
*/
|
|
17
|
-
export interface SiteArchiveImportResult {
|
|
18
|
-
/** Job execution details */
|
|
19
|
-
execution: JobExecution;
|
|
20
|
-
/** Archive filename on instance */
|
|
21
|
-
archiveFilename: string;
|
|
22
|
-
/** Whether archive was kept on instance */
|
|
23
|
-
archiveKept: boolean;
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* Imports a site archive to a B2C Commerce instance.
|
|
27
|
-
*
|
|
28
|
-
* Supports importing from:
|
|
29
|
-
* - A local directory (will be zipped automatically)
|
|
30
|
-
* - A local zip file
|
|
31
|
-
* - A Buffer containing zip data
|
|
32
|
-
* - A filename already on the instance (in Impex/src/instance/)
|
|
33
|
-
*
|
|
34
|
-
* **Buffer handling:** When passing a Buffer, the `archiveName` option controls
|
|
35
|
-
* the contract:
|
|
36
|
-
* - **Without `archiveName`:** The buffer should contain archive entries without
|
|
37
|
-
* a root directory (e.g. `libraries/mylib/library.xml`). The SDK generates
|
|
38
|
-
* an archive name and wraps the contents under it.
|
|
39
|
-
* - **With `archiveName`:** The buffer must already be correctly structured with
|
|
40
|
-
* `archiveName/` as the top-level directory. It is uploaded as-is.
|
|
41
|
-
*
|
|
42
|
-
* @param instance - B2C instance to import to
|
|
43
|
-
* @param target - Source to import (directory path, zip file path, Buffer, or remote filename)
|
|
44
|
-
* @param options - Import options
|
|
45
|
-
* @returns Import result with execution details
|
|
46
|
-
* @throws JobExecutionError if import job fails
|
|
47
|
-
*
|
|
48
|
-
* @example
|
|
49
|
-
* ```typescript
|
|
50
|
-
* // Import from a local directory
|
|
51
|
-
* const result = await siteArchiveImport(instance, './my-site-data');
|
|
52
|
-
*
|
|
53
|
-
* // Import from a zip file
|
|
54
|
-
* const result = await siteArchiveImport(instance, './export.zip');
|
|
55
|
-
*
|
|
56
|
-
* // Import from a buffer (SDK wraps contents automatically)
|
|
57
|
-
* const zip = new JSZip();
|
|
58
|
-
* zip.file('libraries/mylib/library.xml', xmlContent);
|
|
59
|
-
* const buffer = await zip.generateAsync({type: 'nodebuffer'});
|
|
60
|
-
* const result = await siteArchiveImport(instance, buffer);
|
|
61
|
-
*
|
|
62
|
-
* // Import from a buffer with explicit archive name (caller owns structure)
|
|
63
|
-
* const zip = new JSZip();
|
|
64
|
-
* zip.file('my-import/libraries/mylib/library.xml', xmlContent);
|
|
65
|
-
* const buffer = await zip.generateAsync({type: 'nodebuffer'});
|
|
66
|
-
* const result = await siteArchiveImport(instance, buffer, {
|
|
67
|
-
* archiveName: 'my-import'
|
|
68
|
-
* });
|
|
69
|
-
*
|
|
70
|
-
* // Import from existing file on instance
|
|
71
|
-
* const result = await siteArchiveImport(instance, {
|
|
72
|
-
* remoteFilename: 'existing-archive.zip'
|
|
73
|
-
* });
|
|
74
|
-
* ```
|
|
75
|
-
*/
|
|
76
|
-
export declare function siteArchiveImport(instance: B2CInstance, target: string | Buffer | {
|
|
77
|
-
remoteFilename: string;
|
|
78
|
-
archiveName?: string;
|
|
79
|
-
}, options?: SiteArchiveImportOptions & {
|
|
80
|
-
archiveName?: string;
|
|
81
|
-
}): Promise<SiteArchiveImportResult>;
|
|
82
|
-
/**
|
|
83
|
-
* Configuration for sites in export.
|
|
84
|
-
*/
|
|
85
|
-
export interface ExportSitesConfiguration {
|
|
86
|
-
ab_tests?: boolean;
|
|
87
|
-
active_data_feeds?: boolean;
|
|
88
|
-
all?: boolean;
|
|
89
|
-
cache_settings?: boolean;
|
|
90
|
-
campaigns_and_promotions?: boolean;
|
|
91
|
-
commerce_feature_states?: boolean;
|
|
92
|
-
content?: boolean;
|
|
93
|
-
coupons?: boolean;
|
|
94
|
-
custom_objects?: boolean;
|
|
95
|
-
customer_cdn_settings?: boolean;
|
|
96
|
-
customer_groups?: boolean;
|
|
97
|
-
distributed_commerce_extensions?: boolean;
|
|
98
|
-
dynamic_file_resources?: boolean;
|
|
99
|
-
gift_certificates?: boolean;
|
|
100
|
-
ocapi_settings?: boolean;
|
|
101
|
-
payment_methods?: boolean;
|
|
102
|
-
payment_processors?: boolean;
|
|
103
|
-
redirect_urls?: boolean;
|
|
104
|
-
search_settings?: boolean;
|
|
105
|
-
shipping?: boolean;
|
|
106
|
-
site_descriptor?: boolean;
|
|
107
|
-
site_preferences?: boolean;
|
|
108
|
-
sitemap_settings?: boolean;
|
|
109
|
-
slots?: boolean;
|
|
110
|
-
sorting_rules?: boolean;
|
|
111
|
-
source_codes?: boolean;
|
|
112
|
-
static_dynamic_alias_mappings?: boolean;
|
|
113
|
-
stores?: boolean;
|
|
114
|
-
tax?: boolean;
|
|
115
|
-
url_rules?: boolean;
|
|
116
|
-
}
|
|
117
|
-
/**
|
|
118
|
-
* Configuration for global data in export.
|
|
119
|
-
*/
|
|
120
|
-
export interface ExportGlobalDataConfiguration {
|
|
121
|
-
access_roles?: boolean;
|
|
122
|
-
all?: boolean;
|
|
123
|
-
csc_settings?: boolean;
|
|
124
|
-
csrf_whitelists?: boolean;
|
|
125
|
-
custom_preference_groups?: boolean;
|
|
126
|
-
custom_quota_settings?: boolean;
|
|
127
|
-
custom_types?: boolean;
|
|
128
|
-
geolocations?: boolean;
|
|
129
|
-
global_custom_objects?: boolean;
|
|
130
|
-
job_schedules?: boolean;
|
|
131
|
-
job_schedules_deprecated?: boolean;
|
|
132
|
-
locales?: boolean;
|
|
133
|
-
meta_data?: boolean;
|
|
134
|
-
oauth_providers?: boolean;
|
|
135
|
-
ocapi_settings?: boolean;
|
|
136
|
-
page_meta_tags?: boolean;
|
|
137
|
-
preferences?: boolean;
|
|
138
|
-
price_adjustment_limits?: boolean;
|
|
139
|
-
services?: boolean;
|
|
140
|
-
sorting_rules?: boolean;
|
|
141
|
-
static_resources?: boolean;
|
|
142
|
-
system_type_definitions?: boolean;
|
|
143
|
-
users?: boolean;
|
|
144
|
-
webdav_client_permissions?: boolean;
|
|
145
|
-
}
|
|
146
|
-
/**
|
|
147
|
-
* Data units configuration for export.
|
|
148
|
-
*/
|
|
149
|
-
export interface ExportDataUnitsConfiguration {
|
|
150
|
-
/** Catalog static resources to export (catalog_id: true) */
|
|
151
|
-
catalog_static_resources?: Record<string, boolean>;
|
|
152
|
-
/** Catalogs to export (catalog_id: true) */
|
|
153
|
-
catalogs?: Record<string, boolean>;
|
|
154
|
-
/** Customer lists to export (list_id: true) */
|
|
155
|
-
customer_lists?: Record<string, boolean>;
|
|
156
|
-
/** Inventory lists to export (list_id: true) */
|
|
157
|
-
inventory_lists?: Record<string, boolean>;
|
|
158
|
-
/** Library static resources to export (library_id: true) */
|
|
159
|
-
library_static_resources?: Record<string, boolean>;
|
|
160
|
-
/** Libraries to export (library_id: true) */
|
|
161
|
-
libraries?: Record<string, boolean>;
|
|
162
|
-
/** Price books to export (pricebook_id: true) */
|
|
163
|
-
price_books?: Record<string, boolean>;
|
|
164
|
-
/** Sites to export (site_id: ExportSitesConfiguration) */
|
|
165
|
-
sites?: Record<string, Partial<ExportSitesConfiguration> | boolean>;
|
|
166
|
-
/** Global data to export */
|
|
167
|
-
global_data?: Partial<ExportGlobalDataConfiguration>;
|
|
168
|
-
}
|
|
169
|
-
/**
|
|
170
|
-
* Options for site archive export.
|
|
171
|
-
*/
|
|
172
|
-
export interface SiteArchiveExportOptions {
|
|
173
|
-
/** Wait options for job completion */
|
|
174
|
-
waitOptions?: WaitForJobOptions;
|
|
175
|
-
}
|
|
176
|
-
/**
|
|
177
|
-
* Result of a site archive export.
|
|
178
|
-
*/
|
|
179
|
-
export interface SiteArchiveExportResult {
|
|
180
|
-
/** Job execution details */
|
|
181
|
-
execution: JobExecution;
|
|
182
|
-
/** Archive filename on instance */
|
|
183
|
-
archiveFilename: string;
|
|
184
|
-
}
|
|
185
|
-
/**
|
|
186
|
-
* Exports a site archive from a B2C Commerce instance.
|
|
187
|
-
*
|
|
188
|
-
* @param instance - B2C instance to export from
|
|
189
|
-
* @param dataUnits - Data units configuration specifying what to export
|
|
190
|
-
* @param options - Export options
|
|
191
|
-
* @returns Export result with archive data
|
|
192
|
-
* @throws JobExecutionError if export job fails
|
|
193
|
-
*
|
|
194
|
-
* @example
|
|
195
|
-
* ```typescript
|
|
196
|
-
* // Export global meta data
|
|
197
|
-
* const result = await siteArchiveExport(instance, {
|
|
198
|
-
* global_data: { meta_data: true }
|
|
199
|
-
* });
|
|
200
|
-
*
|
|
201
|
-
* // Export a site's content
|
|
202
|
-
* const result = await siteArchiveExport(instance, {
|
|
203
|
-
* sites: {
|
|
204
|
-
* 'RefArch': { content: true, site_preferences: true }
|
|
205
|
-
* }
|
|
206
|
-
* });
|
|
207
|
-
*
|
|
208
|
-
* // Export catalogs
|
|
209
|
-
* const result = await siteArchiveExport(instance, {
|
|
210
|
-
* catalogs: { 'storefront-catalog': true }
|
|
211
|
-
* });
|
|
212
|
-
* ```
|
|
213
|
-
*/
|
|
214
|
-
export declare function siteArchiveExport(instance: B2CInstance, dataUnits: Partial<ExportDataUnitsConfiguration>, options?: SiteArchiveExportOptions): Promise<SiteArchiveExportResult>;
|
|
215
|
-
/**
|
|
216
|
-
* Exports a site archive and downloads it to memory.
|
|
217
|
-
*
|
|
218
|
-
* Runs the export job on the instance, downloads the archive via WebDAV,
|
|
219
|
-
* and returns the data as a Buffer. Optionally keeps the archive on the instance.
|
|
220
|
-
*
|
|
221
|
-
* @param instance - B2C instance to export from
|
|
222
|
-
* @param dataUnits - Data units configuration specifying what to export
|
|
223
|
-
* @param options - Export and download options
|
|
224
|
-
* @returns Export result with archive data buffer
|
|
225
|
-
*
|
|
226
|
-
* @example
|
|
227
|
-
* ```typescript
|
|
228
|
-
* const result = await siteArchiveExportDownload(instance, {
|
|
229
|
-
* global_data: { meta_data: true }
|
|
230
|
-
* });
|
|
231
|
-
* const zip = await JSZip.loadAsync(result.data);
|
|
232
|
-
* ```
|
|
233
|
-
*/
|
|
234
|
-
export declare function siteArchiveExportToBuffer(instance: B2CInstance, dataUnits: Partial<ExportDataUnitsConfiguration>, options?: SiteArchiveExportOptions & {
|
|
235
|
-
keepArchive?: boolean;
|
|
236
|
-
}): Promise<SiteArchiveExportResult & {
|
|
237
|
-
data: Buffer;
|
|
238
|
-
archiveKept: boolean;
|
|
239
|
-
}>;
|
|
240
|
-
/**
|
|
241
|
-
* Exports a site archive, downloads it, and saves it to a local path.
|
|
242
|
-
*
|
|
243
|
-
* Runs the export job on the instance, downloads the archive via WebDAV,
|
|
244
|
-
* and saves it locally. Optionally keeps the archive on the instance.
|
|
245
|
-
*
|
|
246
|
-
* @param instance - B2C instance to export from
|
|
247
|
-
* @param dataUnits - Data units configuration
|
|
248
|
-
* @param outputPath - Local path to save the archive
|
|
249
|
-
* @param options - Export and download options
|
|
250
|
-
* @returns Export result with local path
|
|
251
|
-
*
|
|
252
|
-
* @example
|
|
253
|
-
* ```typescript
|
|
254
|
-
* // Export and save to a directory (extracts zip)
|
|
255
|
-
* await siteArchiveExportToPath(instance, { global_data: { meta_data: true } }, './exports');
|
|
256
|
-
*
|
|
257
|
-
* // Export and save as zip
|
|
258
|
-
* await siteArchiveExportToPath(instance, { global_data: { meta_data: true } }, './exports/archive.zip');
|
|
259
|
-
* ```
|
|
260
|
-
*/
|
|
261
|
-
export declare function siteArchiveExportToPath(instance: B2CInstance, dataUnits: Partial<ExportDataUnitsConfiguration>, outputPath: string, options?: SiteArchiveExportOptions & {
|
|
262
|
-
keepArchive?: boolean;
|
|
263
|
-
extractZip?: boolean;
|
|
264
|
-
}): Promise<SiteArchiveExportResult & {
|
|
265
|
-
localPath: string;
|
|
266
|
-
archiveKept: boolean;
|
|
267
|
-
}>;
|
|
@@ -1,423 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2025, Salesforce, Inc.
|
|
3
|
-
* SPDX-License-Identifier: Apache-2
|
|
4
|
-
* For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
|
|
5
|
-
*/
|
|
6
|
-
/**
|
|
7
|
-
* Site archive import/export operations for B2C Commerce.
|
|
8
|
-
*
|
|
9
|
-
* Provides functions for importing and exporting site archives using
|
|
10
|
-
* the sfcc-site-archive-import and sfcc-site-archive-export system jobs.
|
|
11
|
-
*/
|
|
12
|
-
import * as fs from 'node:fs';
|
|
13
|
-
import * as path from 'node:path';
|
|
14
|
-
import JSZip from 'jszip';
|
|
15
|
-
import { getLogger } from '../../logging/logger.js';
|
|
16
|
-
import { addDirectoryToZip } from '../util/zip.js';
|
|
17
|
-
import { waitForJob, JobExecutionError, getJobLog } from './run.js';
|
|
18
|
-
const IMPORT_JOB_ID = 'sfcc-site-archive-import';
|
|
19
|
-
const EXPORT_JOB_ID = 'sfcc-site-archive-export';
|
|
20
|
-
/**
|
|
21
|
-
* Imports a site archive to a B2C Commerce instance.
|
|
22
|
-
*
|
|
23
|
-
* Supports importing from:
|
|
24
|
-
* - A local directory (will be zipped automatically)
|
|
25
|
-
* - A local zip file
|
|
26
|
-
* - A Buffer containing zip data
|
|
27
|
-
* - A filename already on the instance (in Impex/src/instance/)
|
|
28
|
-
*
|
|
29
|
-
* **Buffer handling:** When passing a Buffer, the `archiveName` option controls
|
|
30
|
-
* the contract:
|
|
31
|
-
* - **Without `archiveName`:** The buffer should contain archive entries without
|
|
32
|
-
* a root directory (e.g. `libraries/mylib/library.xml`). The SDK generates
|
|
33
|
-
* an archive name and wraps the contents under it.
|
|
34
|
-
* - **With `archiveName`:** The buffer must already be correctly structured with
|
|
35
|
-
* `archiveName/` as the top-level directory. It is uploaded as-is.
|
|
36
|
-
*
|
|
37
|
-
* @param instance - B2C instance to import to
|
|
38
|
-
* @param target - Source to import (directory path, zip file path, Buffer, or remote filename)
|
|
39
|
-
* @param options - Import options
|
|
40
|
-
* @returns Import result with execution details
|
|
41
|
-
* @throws JobExecutionError if import job fails
|
|
42
|
-
*
|
|
43
|
-
* @example
|
|
44
|
-
* ```typescript
|
|
45
|
-
* // Import from a local directory
|
|
46
|
-
* const result = await siteArchiveImport(instance, './my-site-data');
|
|
47
|
-
*
|
|
48
|
-
* // Import from a zip file
|
|
49
|
-
* const result = await siteArchiveImport(instance, './export.zip');
|
|
50
|
-
*
|
|
51
|
-
* // Import from a buffer (SDK wraps contents automatically)
|
|
52
|
-
* const zip = new JSZip();
|
|
53
|
-
* zip.file('libraries/mylib/library.xml', xmlContent);
|
|
54
|
-
* const buffer = await zip.generateAsync({type: 'nodebuffer'});
|
|
55
|
-
* const result = await siteArchiveImport(instance, buffer);
|
|
56
|
-
*
|
|
57
|
-
* // Import from a buffer with explicit archive name (caller owns structure)
|
|
58
|
-
* const zip = new JSZip();
|
|
59
|
-
* zip.file('my-import/libraries/mylib/library.xml', xmlContent);
|
|
60
|
-
* const buffer = await zip.generateAsync({type: 'nodebuffer'});
|
|
61
|
-
* const result = await siteArchiveImport(instance, buffer, {
|
|
62
|
-
* archiveName: 'my-import'
|
|
63
|
-
* });
|
|
64
|
-
*
|
|
65
|
-
* // Import from existing file on instance
|
|
66
|
-
* const result = await siteArchiveImport(instance, {
|
|
67
|
-
* remoteFilename: 'existing-archive.zip'
|
|
68
|
-
* });
|
|
69
|
-
* ```
|
|
70
|
-
*/
|
|
71
|
-
export async function siteArchiveImport(instance, target, options = {}) {
|
|
72
|
-
const logger = getLogger();
|
|
73
|
-
const { keepArchive = false, wait = true, waitOptions, archiveName } = options;
|
|
74
|
-
let zipFilename;
|
|
75
|
-
let needsUpload = true;
|
|
76
|
-
let archiveContent;
|
|
77
|
-
// Handle different input types
|
|
78
|
-
if (typeof target === 'object' && 'remoteFilename' in target) {
|
|
79
|
-
// Remote filename - no upload needed
|
|
80
|
-
zipFilename = target.remoteFilename;
|
|
81
|
-
needsUpload = false;
|
|
82
|
-
}
|
|
83
|
-
else if (Buffer.isBuffer(target)) {
|
|
84
|
-
if (archiveName) {
|
|
85
|
-
// Caller provides name — buffer must already contain the correct
|
|
86
|
-
// top-level directory structure (archiveName/...).
|
|
87
|
-
const baseName = archiveName.endsWith('.zip') ? archiveName.slice(0, -4) : archiveName;
|
|
88
|
-
zipFilename = `${baseName}.zip`;
|
|
89
|
-
archiveContent = target;
|
|
90
|
-
}
|
|
91
|
-
else {
|
|
92
|
-
// No name — SDK generates one and wraps the buffer contents under it.
|
|
93
|
-
// The buffer should contain archive entries without a root directory
|
|
94
|
-
// (e.g. libraries/mylib/library.xml, sites/RefArch/site.xml).
|
|
95
|
-
const archiveDirName = `import-${Date.now()}`;
|
|
96
|
-
zipFilename = `${archiveDirName}.zip`;
|
|
97
|
-
archiveContent = await wrapArchiveContents(target, archiveDirName, logger);
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
else {
|
|
101
|
-
// File path - check if directory or zip file
|
|
102
|
-
const targetPath = target;
|
|
103
|
-
if (!fs.existsSync(targetPath)) {
|
|
104
|
-
throw new Error(`Target not found: ${targetPath}`);
|
|
105
|
-
}
|
|
106
|
-
const stat = await fs.promises.stat(targetPath);
|
|
107
|
-
if (stat.isFile()) {
|
|
108
|
-
// Existing zip file
|
|
109
|
-
archiveContent = await fs.promises.readFile(targetPath);
|
|
110
|
-
zipFilename = path.basename(targetPath);
|
|
111
|
-
}
|
|
112
|
-
else if (stat.isDirectory()) {
|
|
113
|
-
// Directory - create zip archive
|
|
114
|
-
const timestamp = Date.now();
|
|
115
|
-
const archiveDirName = archiveName || `import-${timestamp}`;
|
|
116
|
-
zipFilename = `${archiveDirName}.zip`;
|
|
117
|
-
logger.debug({ path: targetPath }, `Creating archive from directory: ${targetPath}`);
|
|
118
|
-
archiveContent = await createArchiveFromDirectory(targetPath, archiveDirName);
|
|
119
|
-
}
|
|
120
|
-
else {
|
|
121
|
-
throw new Error(`Target must be a file or directory: ${targetPath}`);
|
|
122
|
-
}
|
|
123
|
-
}
|
|
124
|
-
// Upload archive if needed
|
|
125
|
-
const uploadPath = `Impex/src/instance/${zipFilename}`;
|
|
126
|
-
if (needsUpload && archiveContent) {
|
|
127
|
-
logger.debug({ path: uploadPath }, `Uploading archive to ${uploadPath}`);
|
|
128
|
-
await instance.webdav.put(uploadPath, archiveContent, 'application/zip');
|
|
129
|
-
logger.debug({ path: uploadPath }, `Archive uploaded: ${uploadPath}`);
|
|
130
|
-
}
|
|
131
|
-
// Execute the import job with file_name parameter
|
|
132
|
-
logger.debug({ jobId: IMPORT_JOB_ID, file: zipFilename }, `Executing ${IMPORT_JOB_ID} job with file_name: ${zipFilename}`);
|
|
133
|
-
let execution;
|
|
134
|
-
// Try file_name format first (standard OCAPI format)
|
|
135
|
-
const { data, error } = await instance.ocapi.POST('/jobs/{job_id}/executions', {
|
|
136
|
-
params: { path: { job_id: IMPORT_JOB_ID } },
|
|
137
|
-
body: { file_name: zipFilename },
|
|
138
|
-
});
|
|
139
|
-
if (error?.fault?.type === 'UnknownPropertyException' &&
|
|
140
|
-
error.fault.arguments?.document === 'job_execution_request') {
|
|
141
|
-
// Retry with parameters format (internal/support users)
|
|
142
|
-
logger.warn('Retrying with parameters format for internal users');
|
|
143
|
-
const { data: retryData, error: retryError } = await instance.ocapi.POST('/jobs/{job_id}/executions', {
|
|
144
|
-
params: { path: { job_id: IMPORT_JOB_ID } },
|
|
145
|
-
body: {
|
|
146
|
-
parameters: [{ name: 'ImportFile', value: zipFilename }],
|
|
147
|
-
},
|
|
148
|
-
});
|
|
149
|
-
if (retryError || !retryData) {
|
|
150
|
-
throw new Error(retryError?.fault?.message ?? 'Failed to execute import job');
|
|
151
|
-
}
|
|
152
|
-
execution = retryData;
|
|
153
|
-
}
|
|
154
|
-
else if (error || !data) {
|
|
155
|
-
throw new Error(error?.fault?.message ?? 'Failed to execute import job');
|
|
156
|
-
}
|
|
157
|
-
else {
|
|
158
|
-
execution = data;
|
|
159
|
-
}
|
|
160
|
-
logger.debug({ jobId: IMPORT_JOB_ID, executionId: execution.id }, `Import job started: ${execution.id}`);
|
|
161
|
-
if (wait) {
|
|
162
|
-
// Wait for completion
|
|
163
|
-
try {
|
|
164
|
-
execution = await waitForJob(instance, IMPORT_JOB_ID, execution.id, waitOptions);
|
|
165
|
-
}
|
|
166
|
-
catch (error) {
|
|
167
|
-
if (error instanceof JobExecutionError) {
|
|
168
|
-
// Try to get log file
|
|
169
|
-
try {
|
|
170
|
-
const log = await getJobLog(instance, error.execution);
|
|
171
|
-
logger.error({ jobId: IMPORT_JOB_ID, logFile: error.execution.log_file_path, log }, `Job log:\n${log}`);
|
|
172
|
-
}
|
|
173
|
-
catch {
|
|
174
|
-
logger.error({ jobId: IMPORT_JOB_ID }, 'Could not retrieve job log');
|
|
175
|
-
}
|
|
176
|
-
}
|
|
177
|
-
throw error;
|
|
178
|
-
}
|
|
179
|
-
// Clean up archive if not keeping
|
|
180
|
-
if (!keepArchive && needsUpload) {
|
|
181
|
-
await instance.webdav.delete(uploadPath);
|
|
182
|
-
logger.debug({ path: uploadPath }, `Archive deleted: ${uploadPath}`);
|
|
183
|
-
}
|
|
184
|
-
}
|
|
185
|
-
return {
|
|
186
|
-
execution,
|
|
187
|
-
archiveFilename: zipFilename,
|
|
188
|
-
archiveKept: wait ? keepArchive : true,
|
|
189
|
-
};
|
|
190
|
-
}
|
|
191
|
-
/**
|
|
192
|
-
* Creates a zip archive from a directory.
|
|
193
|
-
*/
|
|
194
|
-
async function createArchiveFromDirectory(dirPath, archiveDirName) {
|
|
195
|
-
const zip = new JSZip();
|
|
196
|
-
const rootFolder = zip.folder(archiveDirName);
|
|
197
|
-
await addDirectoryToZip(rootFolder, dirPath);
|
|
198
|
-
return zip.generateAsync({
|
|
199
|
-
type: 'nodebuffer',
|
|
200
|
-
compression: 'DEFLATE',
|
|
201
|
-
compressionOptions: { level: 9 },
|
|
202
|
-
});
|
|
203
|
-
}
|
|
204
|
-
/**
|
|
205
|
-
* Wraps the contents of a zip buffer under a new top-level directory.
|
|
206
|
-
*
|
|
207
|
-
* The input buffer should contain archive entries without a root directory
|
|
208
|
-
* (e.g. `libraries/mylib/library.xml`). The output will have all entries
|
|
209
|
-
* nested under `archiveDirName/` (e.g. `archiveDirName/libraries/mylib/library.xml`).
|
|
210
|
-
*/
|
|
211
|
-
async function wrapArchiveContents(buffer, archiveDirName, logger) {
|
|
212
|
-
const zip = await JSZip.loadAsync(buffer);
|
|
213
|
-
logger.debug({ archiveDirName }, `Wrapping archive contents under ${archiveDirName}/`);
|
|
214
|
-
const newZip = new JSZip();
|
|
215
|
-
const rootFolder = newZip.folder(archiveDirName);
|
|
216
|
-
for (const [filePath, entry] of Object.entries(zip.files)) {
|
|
217
|
-
if (!entry.dir) {
|
|
218
|
-
const content = await entry.async('nodebuffer');
|
|
219
|
-
rootFolder.file(filePath, content);
|
|
220
|
-
}
|
|
221
|
-
}
|
|
222
|
-
return newZip.generateAsync({
|
|
223
|
-
type: 'nodebuffer',
|
|
224
|
-
compression: 'DEFLATE',
|
|
225
|
-
compressionOptions: { level: 9 },
|
|
226
|
-
});
|
|
227
|
-
}
|
|
228
|
-
/**
|
|
229
|
-
* Exports a site archive from a B2C Commerce instance.
|
|
230
|
-
*
|
|
231
|
-
* @param instance - B2C instance to export from
|
|
232
|
-
* @param dataUnits - Data units configuration specifying what to export
|
|
233
|
-
* @param options - Export options
|
|
234
|
-
* @returns Export result with archive data
|
|
235
|
-
* @throws JobExecutionError if export job fails
|
|
236
|
-
*
|
|
237
|
-
* @example
|
|
238
|
-
* ```typescript
|
|
239
|
-
* // Export global meta data
|
|
240
|
-
* const result = await siteArchiveExport(instance, {
|
|
241
|
-
* global_data: { meta_data: true }
|
|
242
|
-
* });
|
|
243
|
-
*
|
|
244
|
-
* // Export a site's content
|
|
245
|
-
* const result = await siteArchiveExport(instance, {
|
|
246
|
-
* sites: {
|
|
247
|
-
* 'RefArch': { content: true, site_preferences: true }
|
|
248
|
-
* }
|
|
249
|
-
* });
|
|
250
|
-
*
|
|
251
|
-
* // Export catalogs
|
|
252
|
-
* const result = await siteArchiveExport(instance, {
|
|
253
|
-
* catalogs: { 'storefront-catalog': true }
|
|
254
|
-
* });
|
|
255
|
-
* ```
|
|
256
|
-
*/
|
|
257
|
-
export async function siteArchiveExport(instance, dataUnits, options = {}) {
|
|
258
|
-
const logger = getLogger();
|
|
259
|
-
const { waitOptions } = options;
|
|
260
|
-
// Generate archive filename
|
|
261
|
-
const timestamp = new Date().toISOString().replace(/[:.-]+/g, '');
|
|
262
|
-
const archiveDirName = `${timestamp}_export`;
|
|
263
|
-
const zipFilename = `${archiveDirName}.zip`;
|
|
264
|
-
logger.debug({ jobId: EXPORT_JOB_ID, dataUnits }, `Executing ${EXPORT_JOB_ID} job`);
|
|
265
|
-
let execution;
|
|
266
|
-
// Execute export job - try export_file format first
|
|
267
|
-
{
|
|
268
|
-
const { data, error } = await instance.ocapi.POST('/jobs/{job_id}/executions', {
|
|
269
|
-
params: { path: { job_id: EXPORT_JOB_ID } },
|
|
270
|
-
body: {
|
|
271
|
-
export_file: zipFilename,
|
|
272
|
-
data_units: dataUnits,
|
|
273
|
-
},
|
|
274
|
-
});
|
|
275
|
-
if (error?.fault?.type === 'UnknownPropertyException' &&
|
|
276
|
-
error.fault.arguments?.document === 'job_execution_request') {
|
|
277
|
-
// Retry with parameters format (internal/support users)
|
|
278
|
-
logger.warn('Retrying with parameters format for internal users');
|
|
279
|
-
const { data: retryData, error: retryError } = await instance.ocapi.POST('/jobs/{job_id}/executions', {
|
|
280
|
-
params: { path: { job_id: EXPORT_JOB_ID } },
|
|
281
|
-
body: {
|
|
282
|
-
parameters: [
|
|
283
|
-
{ name: 'ExportFile', value: zipFilename },
|
|
284
|
-
{ name: 'DataUnits', value: JSON.stringify(dataUnits) },
|
|
285
|
-
],
|
|
286
|
-
},
|
|
287
|
-
});
|
|
288
|
-
if (retryError || !retryData) {
|
|
289
|
-
throw new Error(retryError?.fault?.message ?? 'Failed to execute export job');
|
|
290
|
-
}
|
|
291
|
-
execution = retryData;
|
|
292
|
-
}
|
|
293
|
-
else if (error || !data) {
|
|
294
|
-
throw new Error(error?.fault?.message ?? 'Failed to execute export job');
|
|
295
|
-
}
|
|
296
|
-
else {
|
|
297
|
-
execution = data;
|
|
298
|
-
}
|
|
299
|
-
}
|
|
300
|
-
logger.debug({ jobId: EXPORT_JOB_ID, executionId: execution.id }, `Export job started: ${execution.id}`);
|
|
301
|
-
// Wait for completion
|
|
302
|
-
try {
|
|
303
|
-
execution = await waitForJob(instance, EXPORT_JOB_ID, execution.id, waitOptions);
|
|
304
|
-
}
|
|
305
|
-
catch (error) {
|
|
306
|
-
if (error instanceof JobExecutionError) {
|
|
307
|
-
// Try to get log file
|
|
308
|
-
try {
|
|
309
|
-
const log = await getJobLog(instance, error.execution);
|
|
310
|
-
logger.error({ jobId: EXPORT_JOB_ID, logFile: error.execution.log_file_path, log }, `Job log:\n${log}`);
|
|
311
|
-
}
|
|
312
|
-
catch {
|
|
313
|
-
logger.error({ jobId: EXPORT_JOB_ID }, 'Could not retrieve job log');
|
|
314
|
-
}
|
|
315
|
-
}
|
|
316
|
-
throw error;
|
|
317
|
-
}
|
|
318
|
-
return {
|
|
319
|
-
execution,
|
|
320
|
-
archiveFilename: zipFilename,
|
|
321
|
-
};
|
|
322
|
-
}
|
|
323
|
-
/**
|
|
324
|
-
* Exports a site archive and downloads it to memory.
|
|
325
|
-
*
|
|
326
|
-
* Runs the export job on the instance, downloads the archive via WebDAV,
|
|
327
|
-
* and returns the data as a Buffer. Optionally keeps the archive on the instance.
|
|
328
|
-
*
|
|
329
|
-
* @param instance - B2C instance to export from
|
|
330
|
-
* @param dataUnits - Data units configuration specifying what to export
|
|
331
|
-
* @param options - Export and download options
|
|
332
|
-
* @returns Export result with archive data buffer
|
|
333
|
-
*
|
|
334
|
-
* @example
|
|
335
|
-
* ```typescript
|
|
336
|
-
* const result = await siteArchiveExportDownload(instance, {
|
|
337
|
-
* global_data: { meta_data: true }
|
|
338
|
-
* });
|
|
339
|
-
* const zip = await JSZip.loadAsync(result.data);
|
|
340
|
-
* ```
|
|
341
|
-
*/
|
|
342
|
-
export async function siteArchiveExportToBuffer(instance, dataUnits, options = {}) {
|
|
343
|
-
const logger = getLogger();
|
|
344
|
-
const { keepArchive = false, ...exportOptions } = options;
|
|
345
|
-
const result = await siteArchiveExport(instance, dataUnits, exportOptions);
|
|
346
|
-
// Download archive from instance via WebDAV
|
|
347
|
-
const webdavPath = `Impex/src/instance/${result.archiveFilename}`;
|
|
348
|
-
logger.debug({ path: webdavPath }, `Downloading archive: ${webdavPath}`);
|
|
349
|
-
const data = Buffer.from(await instance.webdav.get(webdavPath));
|
|
350
|
-
// Clean up from instance if not keeping
|
|
351
|
-
if (!keepArchive) {
|
|
352
|
-
await instance.webdav.delete(webdavPath);
|
|
353
|
-
logger.debug({ path: webdavPath }, `Archive deleted: ${webdavPath}`);
|
|
354
|
-
}
|
|
355
|
-
return {
|
|
356
|
-
...result,
|
|
357
|
-
data,
|
|
358
|
-
archiveKept: keepArchive,
|
|
359
|
-
};
|
|
360
|
-
}
|
|
361
|
-
/**
|
|
362
|
-
* Exports a site archive, downloads it, and saves it to a local path.
|
|
363
|
-
*
|
|
364
|
-
* Runs the export job on the instance, downloads the archive via WebDAV,
|
|
365
|
-
* and saves it locally. Optionally keeps the archive on the instance.
|
|
366
|
-
*
|
|
367
|
-
* @param instance - B2C instance to export from
|
|
368
|
-
* @param dataUnits - Data units configuration
|
|
369
|
-
* @param outputPath - Local path to save the archive
|
|
370
|
-
* @param options - Export and download options
|
|
371
|
-
* @returns Export result with local path
|
|
372
|
-
*
|
|
373
|
-
* @example
|
|
374
|
-
* ```typescript
|
|
375
|
-
* // Export and save to a directory (extracts zip)
|
|
376
|
-
* await siteArchiveExportToPath(instance, { global_data: { meta_data: true } }, './exports');
|
|
377
|
-
*
|
|
378
|
-
* // Export and save as zip
|
|
379
|
-
* await siteArchiveExportToPath(instance, { global_data: { meta_data: true } }, './exports/archive.zip');
|
|
380
|
-
* ```
|
|
381
|
-
*/
|
|
382
|
-
export async function siteArchiveExportToPath(instance, dataUnits, outputPath, options = {}) {
|
|
383
|
-
const logger = getLogger();
|
|
384
|
-
const { extractZip = true, ...downloadOptions } = options;
|
|
385
|
-
const result = await siteArchiveExportToBuffer(instance, dataUnits, downloadOptions);
|
|
386
|
-
// Determine output handling
|
|
387
|
-
const isZipPath = outputPath.endsWith('.zip');
|
|
388
|
-
if (isZipPath || !extractZip) {
|
|
389
|
-
// Save as zip file
|
|
390
|
-
const zipPath = isZipPath ? outputPath : path.join(outputPath, result.archiveFilename);
|
|
391
|
-
// Ensure directory exists
|
|
392
|
-
await fs.promises.mkdir(path.dirname(zipPath), { recursive: true });
|
|
393
|
-
await fs.promises.writeFile(zipPath, result.data);
|
|
394
|
-
logger.debug({ path: zipPath }, `Archive saved to: ${zipPath}`);
|
|
395
|
-
return {
|
|
396
|
-
...result,
|
|
397
|
-
localPath: zipPath,
|
|
398
|
-
};
|
|
399
|
-
}
|
|
400
|
-
else {
|
|
401
|
-
// Extract to directory
|
|
402
|
-
await fs.promises.mkdir(outputPath, { recursive: true });
|
|
403
|
-
const zip = await JSZip.loadAsync(result.data);
|
|
404
|
-
for (const [relativePath, zipEntry] of Object.entries(zip.files)) {
|
|
405
|
-
const fullPath = path.join(outputPath, relativePath);
|
|
406
|
-
if (zipEntry.dir) {
|
|
407
|
-
await fs.promises.mkdir(fullPath, { recursive: true });
|
|
408
|
-
}
|
|
409
|
-
else {
|
|
410
|
-
// Ensure parent directory exists
|
|
411
|
-
await fs.promises.mkdir(path.dirname(fullPath), { recursive: true });
|
|
412
|
-
const content = await zipEntry.async('nodebuffer');
|
|
413
|
-
await fs.promises.writeFile(fullPath, content);
|
|
414
|
-
}
|
|
415
|
-
}
|
|
416
|
-
logger.debug({ path: outputPath }, `Archive extracted to: ${outputPath}`);
|
|
417
|
-
return {
|
|
418
|
-
...result,
|
|
419
|
-
localPath: outputPath,
|
|
420
|
-
};
|
|
421
|
-
}
|
|
422
|
-
}
|
|
423
|
-
//# sourceMappingURL=site-archive.js.map
|