@oronts/vendure-data-hub-plugin 0.1.2 → 0.1.4
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/CHANGELOG.md +33 -1
- package/README.md +36 -10
- package/dashboard/components/pipelines/PipelineEditor.tsx +159 -5
- package/dashboard/components/pipelines/ReactFlowPipelineEditor.tsx +3 -3
- package/dashboard/components/pipelines/shared/NodePropertiesPanel.tsx +42 -4
- package/dashboard/components/pipelines/shared/StepListItem.tsx +2 -2
- package/dashboard/components/shared/CodeEditor.tsx +289 -0
- package/dashboard/components/shared/schema-form/fields/TextareaField.tsx +19 -4
- package/dashboard/components/shared/step-config/AdapterSelector.tsx +2 -2
- package/dashboard/components/shared/step-config/OperatorFieldInput.tsx +19 -0
- package/dashboard/components/shared/step-config/RouteConfigComponent.tsx +218 -29
- package/dashboard/components/shared/step-config/StepConfigPanel.tsx +24 -10
- package/dashboard/constants/ui-dimensions.ts +2 -1
- package/dashboard/constants/ui-states.ts +1 -0
- package/dashboard/gql/gql.ts +6 -6
- package/dashboard/gql/graphql.ts +9 -4
- package/dashboard/hooks/api/use-pipeline-runs.ts +1 -0
- package/dashboard/hooks/api/use-queues.ts +1 -0
- package/dashboard/hooks/use-adapter-catalog.ts +4 -32
- package/dashboard/routes/connections/ConnectionDetail.tsx +7 -1
- package/dashboard/routes/pipelines/RunDetailsPanel.tsx +1 -1
- package/dashboard/routes/pipelines/components/PipelineActionButtons.tsx +3 -3
- package/dashboard/routes/pipelines/utils/pipeline-conversion.ts +3 -5
- package/dashboard/utils/formatters.ts +6 -4
- package/dist/dashboard/components/pipelines/PipelineEditor.tsx +159 -5
- package/dist/dashboard/components/pipelines/ReactFlowPipelineEditor.tsx +3 -3
- package/dist/dashboard/components/pipelines/shared/NodePropertiesPanel.tsx +42 -4
- package/dist/dashboard/components/pipelines/shared/StepListItem.tsx +2 -2
- package/dist/dashboard/components/shared/CodeEditor.tsx +289 -0
- package/dist/dashboard/components/shared/schema-form/fields/TextareaField.tsx +19 -4
- package/dist/dashboard/components/shared/step-config/AdapterSelector.tsx +2 -2
- package/dist/dashboard/components/shared/step-config/OperatorFieldInput.tsx +19 -0
- package/dist/dashboard/components/shared/step-config/RouteConfigComponent.tsx +218 -29
- package/dist/dashboard/components/shared/step-config/StepConfigPanel.tsx +24 -10
- package/dist/dashboard/constants/ui-dimensions.ts +2 -1
- package/dist/dashboard/constants/ui-states.ts +1 -0
- package/dist/dashboard/gql/gql.ts +6 -6
- package/dist/dashboard/gql/graphql.ts +9 -4
- package/dist/dashboard/hooks/api/use-pipeline-runs.ts +1 -0
- package/dist/dashboard/hooks/api/use-queues.ts +1 -0
- package/dist/dashboard/hooks/use-adapter-catalog.ts +4 -32
- package/dist/dashboard/routes/connections/ConnectionDetail.tsx +7 -1
- package/dist/dashboard/routes/pipelines/RunDetailsPanel.tsx +1 -1
- package/dist/dashboard/routes/pipelines/components/PipelineActionButtons.tsx +3 -3
- package/dist/dashboard/routes/pipelines/utils/pipeline-conversion.ts +3 -5
- package/dist/dashboard/utils/formatters.ts +6 -4
- package/dist/shared/types/adapter-config.types.d.ts +400 -13
- package/dist/shared/types/adapter-config.types.d.ts.map +1 -1
- package/dist/shared/types/index.d.ts +1 -1
- package/dist/shared/types/index.d.ts.map +1 -1
- package/dist/shared/types/index.js.map +1 -1
- package/dist/shared/types/loader.types.d.ts +4 -0
- package/dist/shared/types/loader.types.d.ts.map +1 -1
- package/dist/shared/types/step.types.d.ts +6 -0
- package/dist/shared/types/step.types.d.ts.map +1 -1
- package/dist/shared/utils/error.d.ts +5 -0
- package/dist/shared/utils/error.d.ts.map +1 -1
- package/dist/shared/utils/error.js +11 -0
- package/dist/shared/utils/error.js.map +1 -1
- package/dist/src/adapters/registry.d.ts.map +1 -1
- package/dist/src/adapters/registry.js +2 -1
- package/dist/src/adapters/registry.js.map +1 -1
- package/dist/src/api/controllers/webhook.controller.d.ts +10 -0
- package/dist/src/api/controllers/webhook.controller.d.ts.map +1 -1
- package/dist/src/api/controllers/webhook.controller.js +50 -10
- package/dist/src/api/controllers/webhook.controller.js.map +1 -1
- package/dist/src/api/resolvers/queue.resolver.d.ts +3 -1
- package/dist/src/api/resolvers/queue.resolver.d.ts.map +1 -1
- package/dist/src/api/resolvers/queue.resolver.js +6 -5
- package/dist/src/api/resolvers/queue.resolver.js.map +1 -1
- package/dist/src/api/schema/pipeline.schema.d.ts +1 -1
- package/dist/src/api/schema/pipeline.schema.d.ts.map +1 -1
- package/dist/src/api/schema/pipeline.schema.js +6 -0
- package/dist/src/api/schema/pipeline.schema.js.map +1 -1
- package/dist/src/api/schema/test.schema.d.ts +1 -1
- package/dist/src/api/schema/test.schema.d.ts.map +1 -1
- package/dist/src/api/schema/test.schema.js +5 -1
- package/dist/src/api/schema/test.schema.js.map +1 -1
- package/dist/src/bootstrap/initialization.d.ts.map +1 -1
- package/dist/src/bootstrap/initialization.js +6 -0
- package/dist/src/bootstrap/initialization.js.map +1 -1
- package/dist/src/constants/adapter-schema-options.d.ts +65 -0
- package/dist/src/constants/adapter-schema-options.d.ts.map +1 -1
- package/dist/src/constants/adapter-schema-options.js +79 -3
- package/dist/src/constants/adapter-schema-options.js.map +1 -1
- package/dist/src/constants/builtin-adapters.d.ts +1 -1
- package/dist/src/constants/builtin-adapters.d.ts.map +1 -1
- package/dist/src/constants/builtin-adapters.js +19 -1
- package/dist/src/constants/builtin-adapters.js.map +1 -1
- package/dist/src/constants/core.d.ts +10 -0
- package/dist/src/constants/core.d.ts.map +1 -1
- package/dist/src/constants/core.js +10 -0
- package/dist/src/constants/core.js.map +1 -1
- package/dist/src/constants/defaults/webhook-defaults.d.ts +2 -0
- package/dist/src/constants/defaults/webhook-defaults.d.ts.map +1 -1
- package/dist/src/constants/defaults/webhook-defaults.js +2 -0
- package/dist/src/constants/defaults/webhook-defaults.js.map +1 -1
- package/dist/src/constants/enum-metadata.d.ts.map +1 -1
- package/dist/src/constants/enum-metadata.js +3 -0
- package/dist/src/constants/enum-metadata.js.map +1 -1
- package/dist/src/constants/hook-stage-metadata.d.ts.map +1 -1
- package/dist/src/constants/hook-stage-metadata.js +42 -0
- package/dist/src/constants/hook-stage-metadata.js.map +1 -1
- package/dist/src/constants/services.d.ts.map +1 -1
- package/dist/src/constants/services.js +7 -0
- package/dist/src/constants/services.js.map +1 -1
- package/dist/src/constants/time.d.ts +2 -0
- package/dist/src/constants/time.d.ts.map +1 -1
- package/dist/src/constants/time.js +2 -0
- package/dist/src/constants/time.js.map +1 -1
- package/dist/src/entities/data/error-record.entity.d.ts +1 -0
- package/dist/src/entities/data/error-record.entity.d.ts.map +1 -1
- package/dist/src/entities/data/error-record.entity.js +4 -0
- package/dist/src/entities/data/error-record.entity.js.map +1 -1
- package/dist/src/entities/pipeline/pipeline-run.entity.d.ts +4 -0
- package/dist/src/entities/pipeline/pipeline-run.entity.d.ts.map +1 -1
- package/dist/src/entities/pipeline/pipeline-run.entity.js +8 -0
- package/dist/src/entities/pipeline/pipeline-run.entity.js.map +1 -1
- package/dist/src/extractors/cdc/cdc.extractor.d.ts.map +1 -1
- package/dist/src/extractors/cdc/cdc.extractor.js +7 -2
- package/dist/src/extractors/cdc/cdc.extractor.js.map +1 -1
- package/dist/src/extractors/cdc/types.d.ts +1 -1
- package/dist/src/extractors/cdc/types.d.ts.map +1 -1
- package/dist/src/extractors/extractor-handler-registry.d.ts.map +1 -1
- package/dist/src/extractors/extractor-handler-registry.js +3 -0
- package/dist/src/extractors/extractor-handler-registry.js.map +1 -1
- package/dist/src/extractors/vendure-query/helpers.d.ts +9 -4
- package/dist/src/extractors/vendure-query/helpers.d.ts.map +1 -1
- package/dist/src/extractors/vendure-query/helpers.js +98 -32
- package/dist/src/extractors/vendure-query/helpers.js.map +1 -1
- package/dist/src/extractors/vendure-query/schema.d.ts.map +1 -1
- package/dist/src/extractors/vendure-query/schema.js +13 -0
- package/dist/src/extractors/vendure-query/schema.js.map +1 -1
- package/dist/src/feeds/generators/csv-feed.generator.d.ts.map +1 -1
- package/dist/src/feeds/generators/csv-feed.generator.js +5 -4
- package/dist/src/feeds/generators/csv-feed.generator.js.map +1 -1
- package/dist/src/feeds/generators/facebook-catalog.generator.d.ts.map +1 -1
- package/dist/src/feeds/generators/facebook-catalog.generator.js +83 -114
- package/dist/src/feeds/generators/facebook-catalog.generator.js.map +1 -1
- package/dist/src/feeds/generators/feed-constants.d.ts +1 -0
- package/dist/src/feeds/generators/feed-constants.d.ts.map +1 -1
- package/dist/src/feeds/generators/feed-constants.js +1 -0
- package/dist/src/feeds/generators/feed-constants.js.map +1 -1
- package/dist/src/feeds/generators/feed-helpers.d.ts +10 -8
- package/dist/src/feeds/generators/feed-helpers.d.ts.map +1 -1
- package/dist/src/feeds/generators/feed-helpers.js +23 -3
- package/dist/src/feeds/generators/feed-helpers.js.map +1 -1
- package/dist/src/feeds/generators/feed-item-builder.d.ts +59 -0
- package/dist/src/feeds/generators/feed-item-builder.d.ts.map +1 -0
- package/dist/src/feeds/generators/feed-item-builder.js +93 -0
- package/dist/src/feeds/generators/feed-item-builder.js.map +1 -0
- package/dist/src/feeds/generators/google-shopping.generator.d.ts.map +1 -1
- package/dist/src/feeds/generators/google-shopping.generator.js +52 -64
- package/dist/src/feeds/generators/google-shopping.generator.js.map +1 -1
- package/dist/src/feeds/generators/json-feed.generator.d.ts.map +1 -1
- package/dist/src/feeds/generators/json-feed.generator.js +4 -3
- package/dist/src/feeds/generators/json-feed.generator.js.map +1 -1
- package/dist/src/feeds/generators/xml-feed.generator.d.ts.map +1 -1
- package/dist/src/feeds/generators/xml-feed.generator.js +6 -5
- package/dist/src/feeds/generators/xml-feed.generator.js.map +1 -1
- package/dist/src/gql/generated.d.ts +5 -0
- package/dist/src/gql/generated.d.ts.map +1 -1
- package/dist/src/gql/generated.js.map +1 -1
- package/dist/src/index.d.ts +3 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +7 -4
- package/dist/src/index.js.map +1 -1
- package/dist/src/loaders/asset/asset.loader.d.ts.map +1 -1
- package/dist/src/loaders/asset/asset.loader.js +5 -1
- package/dist/src/loaders/asset/asset.loader.js.map +1 -1
- package/dist/src/loaders/base/validation-builder.d.ts +128 -3
- package/dist/src/loaders/base/validation-builder.d.ts.map +1 -1
- package/dist/src/loaders/base/validation-builder.js +177 -6
- package/dist/src/loaders/base/validation-builder.js.map +1 -1
- package/dist/src/loaders/collection/collection.loader.d.ts.map +1 -1
- package/dist/src/loaders/collection/collection.loader.js +22 -1
- package/dist/src/loaders/collection/collection.loader.js.map +1 -1
- package/dist/src/loaders/collection/helpers.d.ts +16 -1
- package/dist/src/loaders/collection/helpers.d.ts.map +1 -1
- package/dist/src/loaders/collection/helpers.js +37 -0
- package/dist/src/loaders/collection/helpers.js.map +1 -1
- package/dist/src/loaders/customer/customer.loader.d.ts.map +1 -1
- package/dist/src/loaders/customer/customer.loader.js +13 -1
- package/dist/src/loaders/customer/customer.loader.js.map +1 -1
- package/dist/src/loaders/customer/helpers.d.ts +15 -3
- package/dist/src/loaders/customer/helpers.d.ts.map +1 -1
- package/dist/src/loaders/customer/helpers.js +188 -7
- package/dist/src/loaders/customer/helpers.js.map +1 -1
- package/dist/src/loaders/facet-value/facet-value.loader.d.ts.map +1 -1
- package/dist/src/loaders/facet-value/facet-value.loader.js +18 -0
- package/dist/src/loaders/facet-value/facet-value.loader.js.map +1 -1
- package/dist/src/loaders/facet-value/types.d.ts +1 -1
- package/dist/src/loaders/facet-value/types.js +1 -1
- package/dist/src/loaders/facet-value/types.js.map +1 -1
- package/dist/src/loaders/inventory/inventory.loader.d.ts.map +1 -1
- package/dist/src/loaders/inventory/inventory.loader.js +1 -2
- package/dist/src/loaders/inventory/inventory.loader.js.map +1 -1
- package/dist/src/loaders/order/helpers.d.ts +16 -2
- package/dist/src/loaders/order/helpers.d.ts.map +1 -1
- package/dist/src/loaders/order/helpers.js +108 -0
- package/dist/src/loaders/order/helpers.js.map +1 -1
- package/dist/src/loaders/order/order.loader.d.ts +38 -0
- package/dist/src/loaders/order/order.loader.d.ts.map +1 -1
- package/dist/src/loaders/order/order.loader.js +238 -24
- package/dist/src/loaders/order/order.loader.js.map +1 -1
- package/dist/src/loaders/order/types.d.ts +10 -3
- package/dist/src/loaders/order/types.d.ts.map +1 -1
- package/dist/src/loaders/order/types.js +13 -2
- package/dist/src/loaders/order/types.js.map +1 -1
- package/dist/src/loaders/product/product.loader.d.ts.map +1 -1
- package/dist/src/loaders/product/product.loader.js +18 -2
- package/dist/src/loaders/product/product.loader.js.map +1 -1
- package/dist/src/loaders/product-variant/helpers.d.ts +20 -0
- package/dist/src/loaders/product-variant/helpers.d.ts.map +1 -0
- package/dist/src/loaders/product-variant/helpers.js +103 -0
- package/dist/src/loaders/product-variant/helpers.js.map +1 -0
- package/dist/src/loaders/product-variant/product-variant.loader.d.ts.map +1 -1
- package/dist/src/loaders/product-variant/product-variant.loader.js +76 -10
- package/dist/src/loaders/product-variant/product-variant.loader.js.map +1 -1
- package/dist/src/loaders/product-variant/types.d.ts +7 -0
- package/dist/src/loaders/product-variant/types.d.ts.map +1 -1
- package/dist/src/loaders/product-variant/types.js.map +1 -1
- package/dist/src/loaders/promotion/helpers.d.ts +29 -0
- package/dist/src/loaders/promotion/helpers.d.ts.map +1 -1
- package/dist/src/loaders/promotion/helpers.js +68 -0
- package/dist/src/loaders/promotion/helpers.js.map +1 -1
- package/dist/src/loaders/promotion/promotion.loader.d.ts.map +1 -1
- package/dist/src/loaders/promotion/promotion.loader.js +12 -2
- package/dist/src/loaders/promotion/promotion.loader.js.map +1 -1
- package/dist/src/loaders/shared-helpers.d.ts +42 -2
- package/dist/src/loaders/shared-helpers.d.ts.map +1 -1
- package/dist/src/loaders/shared-helpers.js +384 -5
- package/dist/src/loaders/shared-helpers.js.map +1 -1
- package/dist/src/operators/data/copy.operator.js +2 -2
- package/dist/src/operators/data/copy.operator.js.map +1 -1
- package/dist/src/operators/data/rename.operator.js +1 -1
- package/dist/src/operators/data/rename.operator.js.map +1 -1
- package/dist/src/operators/helpers.d.ts.map +1 -1
- package/dist/src/operators/helpers.js +11 -1
- package/dist/src/operators/helpers.js.map +1 -1
- package/dist/src/operators/operator-runtime-registry.d.ts +2 -2
- package/dist/src/operators/operator-runtime-registry.d.ts.map +1 -1
- package/dist/src/operators/operator-runtime-registry.js +1 -1
- package/dist/src/operators/operator-runtime-registry.js.map +1 -1
- package/dist/src/operators/script/script.operators.d.ts.map +1 -1
- package/dist/src/operators/script/script.operators.js +9 -3
- package/dist/src/operators/script/script.operators.js.map +1 -1
- package/dist/src/runtime/config-types.d.ts +6 -0
- package/dist/src/runtime/config-types.d.ts.map +1 -1
- package/dist/src/runtime/executor-helpers.d.ts +77 -0
- package/dist/src/runtime/executor-helpers.d.ts.map +1 -0
- package/dist/src/runtime/executor-helpers.js +143 -0
- package/dist/src/runtime/executor-helpers.js.map +1 -0
- package/dist/src/runtime/executor-types.d.ts +3 -2
- package/dist/src/runtime/executor-types.d.ts.map +1 -1
- package/dist/src/runtime/executors/export.executor.d.ts +3 -1
- package/dist/src/runtime/executors/export.executor.d.ts.map +1 -1
- package/dist/src/runtime/executors/export.executor.js +15 -3
- package/dist/src/runtime/executors/export.executor.js.map +1 -1
- package/dist/src/runtime/executors/exporters/export-handler-registry.d.ts.map +1 -1
- package/dist/src/runtime/executors/exporters/export-handler-registry.js +5 -0
- package/dist/src/runtime/executors/exporters/export-handler-registry.js.map +1 -1
- package/dist/src/runtime/executors/exporters/export-handler.types.d.ts +3 -0
- package/dist/src/runtime/executors/exporters/export-handler.types.d.ts.map +1 -1
- package/dist/src/runtime/executors/exporters/export-handler.types.js.map +1 -1
- package/dist/src/runtime/executors/exporters/export-helpers.d.ts +1 -0
- package/dist/src/runtime/executors/exporters/export-helpers.d.ts.map +1 -1
- package/dist/src/runtime/executors/exporters/export-helpers.js +33 -4
- package/dist/src/runtime/executors/exporters/export-helpers.js.map +1 -1
- package/dist/src/runtime/executors/exporters/http-export.handler.js +4 -4
- package/dist/src/runtime/executors/exporters/http-export.handler.js.map +1 -1
- package/dist/src/runtime/executors/extractors/file-extract.handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/extractors/file-extract.handler.js +33 -13
- package/dist/src/runtime/executors/extractors/file-extract.handler.js.map +1 -1
- package/dist/src/runtime/executors/extractors/memory-extract.handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/extractors/memory-extract.handler.js +17 -9
- package/dist/src/runtime/executors/extractors/memory-extract.handler.js.map +1 -1
- package/dist/src/runtime/executors/feed.executor.d.ts.map +1 -1
- package/dist/src/runtime/executors/feed.executor.js +11 -2
- package/dist/src/runtime/executors/feed.executor.js.map +1 -1
- package/dist/src/runtime/executors/feeds/feed-handler-registry.d.ts.map +1 -1
- package/dist/src/runtime/executors/feeds/feed-handler-registry.js +4 -0
- package/dist/src/runtime/executors/feeds/feed-handler-registry.js.map +1 -1
- package/dist/src/runtime/executors/gate.executor.d.ts +3 -1
- package/dist/src/runtime/executors/gate.executor.d.ts.map +1 -1
- package/dist/src/runtime/executors/gate.executor.js +47 -26
- package/dist/src/runtime/executors/gate.executor.js.map +1 -1
- package/dist/src/runtime/executors/loaders/asset-handler.js +1 -1
- package/dist/src/runtime/executors/loaders/asset-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/asset-import-handler.js +1 -1
- package/dist/src/runtime/executors/loaders/asset-import-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/channel-handler.d.ts +3 -1
- package/dist/src/runtime/executors/loaders/channel-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/channel-handler.js +28 -5
- package/dist/src/runtime/executors/loaders/channel-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/collection-handler.d.ts +14 -2
- package/dist/src/runtime/executors/loaders/collection-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/collection-handler.js +113 -23
- package/dist/src/runtime/executors/loaders/collection-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/customer-group-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/customer-group-handler.js +2 -20
- package/dist/src/runtime/executors/loaders/customer-group-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/customer-handler.d.ts +6 -1
- package/dist/src/runtime/executors/loaders/customer-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/customer-handler.js +128 -15
- package/dist/src/runtime/executors/loaders/customer-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/deletion-handler.d.ts +39 -0
- package/dist/src/runtime/executors/loaders/deletion-handler.d.ts.map +1 -0
- package/dist/src/runtime/executors/loaders/deletion-handler.js +414 -0
- package/dist/src/runtime/executors/loaders/deletion-handler.js.map +1 -0
- package/dist/src/runtime/executors/loaders/facet-handler.d.ts +18 -3
- package/dist/src/runtime/executors/loaders/facet-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/facet-handler.js +161 -28
- package/dist/src/runtime/executors/loaders/facet-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/graphql-mutation-handler.js +1 -1
- package/dist/src/runtime/executors/loaders/graphql-mutation-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/index.d.ts +2 -0
- package/dist/src/runtime/executors/loaders/index.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/index.js +5 -1
- package/dist/src/runtime/executors/loaders/index.js.map +1 -1
- package/dist/src/runtime/executors/loaders/inventory-adjust-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/inventory-adjust-handler.js +2 -21
- package/dist/src/runtime/executors/loaders/inventory-adjust-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/inventory-handler.d.ts +2 -1
- package/dist/src/runtime/executors/loaders/inventory-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/inventory-handler.js +11 -9
- package/dist/src/runtime/executors/loaders/inventory-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/loader-handler-registry.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/loader-handler-registry.js +150 -11
- package/dist/src/runtime/executors/loaders/loader-handler-registry.js.map +1 -1
- package/dist/src/runtime/executors/loaders/order-handler.d.ts +32 -4
- package/dist/src/runtime/executors/loaders/order-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/order-handler.js +201 -18
- package/dist/src/runtime/executors/loaders/order-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/order-upsert-handler.d.ts +15 -0
- package/dist/src/runtime/executors/loaders/order-upsert-handler.d.ts.map +1 -0
- package/dist/src/runtime/executors/loaders/order-upsert-handler.js +89 -0
- package/dist/src/runtime/executors/loaders/order-upsert-handler.js.map +1 -0
- package/dist/src/runtime/executors/loaders/payment-method-handler.d.ts +11 -2
- package/dist/src/runtime/executors/loaders/payment-method-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/payment-method-handler.js +92 -34
- package/dist/src/runtime/executors/loaders/payment-method-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/product-handler.d.ts +20 -0
- package/dist/src/runtime/executors/loaders/product-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/product-handler.js +121 -31
- package/dist/src/runtime/executors/loaders/product-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/promotion-handler.d.ts +9 -2
- package/dist/src/runtime/executors/loaders/promotion-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/promotion-handler.js +134 -68
- package/dist/src/runtime/executors/loaders/promotion-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/rest-handler.js +1 -1
- package/dist/src/runtime/executors/loaders/rest-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/shared-lookups.d.ts +62 -1
- package/dist/src/runtime/executors/loaders/shared-lookups.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/shared-lookups.js +238 -0
- package/dist/src/runtime/executors/loaders/shared-lookups.js.map +1 -1
- package/dist/src/runtime/executors/loaders/shipping-method-handler.d.ts +11 -6
- package/dist/src/runtime/executors/loaders/shipping-method-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/shipping-method-handler.js +168 -54
- package/dist/src/runtime/executors/loaders/shipping-method-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/stock-location-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/stock-location-handler.js +2 -20
- package/dist/src/runtime/executors/loaders/stock-location-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/tax-rate-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/tax-rate-handler.js +14 -1
- package/dist/src/runtime/executors/loaders/tax-rate-handler.js.map +1 -1
- package/dist/src/runtime/executors/loaders/types.d.ts +2 -0
- package/dist/src/runtime/executors/loaders/types.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/variant-handler.d.ts +24 -2
- package/dist/src/runtime/executors/loaders/variant-handler.d.ts.map +1 -1
- package/dist/src/runtime/executors/loaders/variant-handler.js +266 -47
- package/dist/src/runtime/executors/loaders/variant-handler.js.map +1 -1
- package/dist/src/runtime/executors/sink-handler-registry.d.ts +7 -11
- package/dist/src/runtime/executors/sink-handler-registry.d.ts.map +1 -1
- package/dist/src/runtime/executors/sink-handler-registry.js +376 -10
- package/dist/src/runtime/executors/sink-handler-registry.js.map +1 -1
- package/dist/src/runtime/executors/sink.executor.d.ts +1 -0
- package/dist/src/runtime/executors/sink.executor.d.ts.map +1 -1
- package/dist/src/runtime/executors/sink.executor.js +82 -12
- package/dist/src/runtime/executors/sink.executor.js.map +1 -1
- package/dist/src/runtime/executors/transform.executor.d.ts.map +1 -1
- package/dist/src/runtime/executors/transform.executor.js +31 -2
- package/dist/src/runtime/executors/transform.executor.js.map +1 -1
- package/dist/src/runtime/orchestration/graph-executor.d.ts.map +1 -1
- package/dist/src/runtime/orchestration/graph-executor.js +3 -2
- package/dist/src/runtime/orchestration/graph-executor.js.map +1 -1
- package/dist/src/runtime/orchestration/helpers.d.ts +4 -1
- package/dist/src/runtime/orchestration/helpers.d.ts.map +1 -1
- package/dist/src/runtime/orchestration/helpers.js +7 -2
- package/dist/src/runtime/orchestration/helpers.js.map +1 -1
- package/dist/src/runtime/orchestration/linear-executor.d.ts.map +1 -1
- package/dist/src/runtime/orchestration/linear-executor.js +3 -2
- package/dist/src/runtime/orchestration/linear-executor.js.map +1 -1
- package/dist/src/runtime/orchestration/replay-executor.d.ts.map +1 -1
- package/dist/src/runtime/orchestration/replay-executor.js +3 -2
- package/dist/src/runtime/orchestration/replay-executor.js.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/export-step.strategy.d.ts.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/export-step.strategy.js +12 -12
- package/dist/src/runtime/orchestration/step-strategies/export-step.strategy.js.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/feed-step.strategy.d.ts.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/feed-step.strategy.js +12 -12
- package/dist/src/runtime/orchestration/step-strategies/feed-step.strategy.js.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/load-step.strategy.js +2 -2
- package/dist/src/runtime/orchestration/step-strategies/load-step.strategy.js.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/sink-step.strategy.d.ts.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/sink-step.strategy.js +12 -12
- package/dist/src/runtime/orchestration/step-strategies/sink-step.strategy.js.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/step-dispatcher.d.ts.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/step-dispatcher.js +4 -3
- package/dist/src/runtime/orchestration/step-strategies/step-dispatcher.js.map +1 -1
- package/dist/src/runtime/orchestration/step-strategies/transform-step.strategy.js +4 -4
- package/dist/src/runtime/orchestration/step-strategies/transform-step.strategy.js.map +1 -1
- package/dist/src/runtime/orchestration/types.d.ts +1 -0
- package/dist/src/runtime/orchestration/types.d.ts.map +1 -1
- package/dist/src/runtime/utils.d.ts.map +1 -1
- package/dist/src/runtime/utils.js +8 -1
- package/dist/src/runtime/utils.js.map +1 -1
- package/dist/src/sdk/adapters/queue/index.d.ts +1 -0
- package/dist/src/sdk/adapters/queue/index.d.ts.map +1 -1
- package/dist/src/sdk/adapters/queue/index.js +1 -0
- package/dist/src/sdk/adapters/queue/index.js.map +1 -1
- package/dist/src/sdk/adapters/queue/internal.adapter.d.ts +32 -0
- package/dist/src/sdk/adapters/queue/internal.adapter.d.ts.map +1 -0
- package/dist/src/sdk/adapters/queue/internal.adapter.js +68 -0
- package/dist/src/sdk/adapters/queue/internal.adapter.js.map +1 -0
- package/dist/src/sdk/adapters/queue/queue-adapter.registry.d.ts.map +1 -1
- package/dist/src/sdk/adapters/queue/queue-adapter.registry.js +3 -0
- package/dist/src/sdk/adapters/queue/queue-adapter.registry.js.map +1 -1
- package/dist/src/sdk/adapters/queue/rabbitmq.adapter.d.ts.map +1 -1
- package/dist/src/sdk/adapters/queue/rabbitmq.adapter.js +2 -1
- package/dist/src/sdk/adapters/queue/rabbitmq.adapter.js.map +1 -1
- package/dist/src/sdk/constants.d.ts +2 -2
- package/dist/src/sdk/constants.d.ts.map +1 -1
- package/dist/src/sdk/dsl/pipeline-builder.d.ts +8 -2
- package/dist/src/sdk/dsl/pipeline-builder.d.ts.map +1 -1
- package/dist/src/sdk/dsl/pipeline-builder.js +115 -19
- package/dist/src/sdk/dsl/pipeline-builder.js.map +1 -1
- package/dist/src/sdk/dsl/step-configs.d.ts +24 -0
- package/dist/src/sdk/dsl/step-configs.d.ts.map +1 -1
- package/dist/src/services/data/record-error.service.d.ts +1 -1
- package/dist/src/services/data/record-error.service.d.ts.map +1 -1
- package/dist/src/services/data/record-error.service.js +4 -1
- package/dist/src/services/data/record-error.service.js.map +1 -1
- package/dist/src/services/events/consumer-discovery.d.ts.map +1 -1
- package/dist/src/services/events/consumer-discovery.js +2 -1
- package/dist/src/services/events/consumer-discovery.js.map +1 -1
- package/dist/src/services/events/consumer-lifecycle.d.ts.map +1 -1
- package/dist/src/services/events/consumer-lifecycle.js +19 -15
- package/dist/src/services/events/consumer-lifecycle.js.map +1 -1
- package/dist/src/services/events/event-trigger.service.d.ts.map +1 -1
- package/dist/src/services/events/event-trigger.service.js +9 -3
- package/dist/src/services/events/event-trigger.service.js.map +1 -1
- package/dist/src/services/events/hook.service.d.ts.map +1 -1
- package/dist/src/services/events/hook.service.js +7 -3
- package/dist/src/services/events/hook.service.js.map +1 -1
- package/dist/src/services/events/message-processing.d.ts.map +1 -1
- package/dist/src/services/events/message-processing.js +13 -8
- package/dist/src/services/events/message-processing.js.map +1 -1
- package/dist/src/services/logger/datahub-logger.d.ts +7 -0
- package/dist/src/services/logger/datahub-logger.d.ts.map +1 -1
- package/dist/src/services/logger/datahub-logger.js +9 -0
- package/dist/src/services/logger/datahub-logger.js.map +1 -1
- package/dist/src/services/logger/execution-logger.d.ts +1 -1
- package/dist/src/services/logger/execution-logger.d.ts.map +1 -1
- package/dist/src/services/logger/execution-logger.js +8 -4
- package/dist/src/services/logger/execution-logger.js.map +1 -1
- package/dist/src/services/pipeline/pipeline-runner.service.d.ts +3 -1
- package/dist/src/services/pipeline/pipeline-runner.service.d.ts.map +1 -1
- package/dist/src/services/pipeline/pipeline-runner.service.js +17 -7
- package/dist/src/services/pipeline/pipeline-runner.service.js.map +1 -1
- package/dist/src/services/pipeline/pipeline.service.d.ts.map +1 -1
- package/dist/src/services/pipeline/pipeline.service.js +8 -2
- package/dist/src/services/pipeline/pipeline.service.js.map +1 -1
- package/dist/src/services/storage/retention.service.d.ts.map +1 -1
- package/dist/src/services/storage/retention.service.js +22 -0
- package/dist/src/services/storage/retention.service.js.map +1 -1
- package/dist/src/services/testing/step-test.service.d.ts.map +1 -1
- package/dist/src/services/testing/step-test.service.js +17 -1
- package/dist/src/services/testing/step-test.service.js.map +1 -1
- package/dist/src/services/validation/definition-validation.service.d.ts.map +1 -1
- package/dist/src/services/validation/definition-validation.service.js +4 -1
- package/dist/src/services/validation/definition-validation.service.js.map +1 -1
- package/dist/src/services/validation/trigger-validation.d.ts.map +1 -1
- package/dist/src/services/validation/trigger-validation.js +76 -2
- package/dist/src/services/validation/trigger-validation.js.map +1 -1
- package/dist/src/types/index.d.ts +1 -0
- package/dist/src/types/index.d.ts.map +1 -1
- package/dist/src/types/index.js.map +1 -1
- package/dist/src/types/loader-configs.d.ts +1071 -0
- package/dist/src/types/loader-configs.d.ts.map +1 -0
- package/dist/src/types/loader-configs.js +54 -0
- package/dist/src/types/loader-configs.js.map +1 -0
- package/dist/src/types/step-configs.d.ts +1 -0
- package/dist/src/types/step-configs.d.ts.map +1 -1
- package/dist/src/types/step-configs.js +3 -0
- package/dist/src/types/step-configs.js.map +1 -1
- package/dist/src/utils/code-security.utils.d.ts +18 -0
- package/dist/src/utils/code-security.utils.d.ts.map +1 -1
- package/dist/src/utils/code-security.utils.js +125 -9
- package/dist/src/utils/code-security.utils.js.map +1 -1
- package/dist/src/utils/error.utils.d.ts +1 -1
- package/dist/src/utils/error.utils.d.ts.map +1 -1
- package/dist/src/utils/error.utils.js +2 -1
- package/dist/src/utils/error.utils.js.map +1 -1
- package/dist/src/utils/url-security.utils.d.ts +5 -3
- package/dist/src/utils/url-security.utils.d.ts.map +1 -1
- package/dist/src/utils/url-security.utils.js +20 -4
- package/dist/src/utils/url-security.utils.js.map +1 -1
- package/dist/src/validation/pipeline-definition.validator.js +2 -1
- package/dist/src/validation/pipeline-definition.validator.js.map +1 -1
- package/docs/developer-guide/README.md +2 -0
- package/docs/developer-guide/dsl/pipeline-builder.md +12 -0
- package/docs/developer-guide/extending/README.md +230 -10
- package/docs/developer-guide/extending/custom-sinks.md +87 -0
- package/docs/developer-guide/extending/events.md +4 -1
- package/docs/examples/validation-error-messages.md +246 -0
- package/docs/guides/multi-channel.md +1190 -0
- package/docs/guides/multi-currency.md +881 -0
- package/docs/guides/multi-entity.md +597 -0
- package/docs/guides/multi-language.md +957 -0
- package/docs/reference/README.md +11 -4
- package/docs/reference/extractors.md +30 -0
- package/docs/reference/loaders.md +396 -21
- package/docs/reference/operators-complete.md +1251 -0
- package/docs/reference/operators.md +36 -2
- package/docs/reference/sinks.md +7 -6
- package/docs/reference/step-types.md +12 -5
- package/docs/user-guide/pipelines.md +82 -13
- package/package.json +1 -1
- package/shared/types/adapter-config.types.ts +439 -10
- package/shared/types/index.ts +25 -0
- package/shared/types/loader.types.ts +4 -0
- package/shared/types/step.types.ts +6 -0
- package/shared/utils/error.ts +11 -0
|
@@ -0,0 +1,1071 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Auto-generated Loader Configuration Types
|
|
3
|
+
*
|
|
4
|
+
* DO NOT EDIT THIS FILE MANUALLY!
|
|
5
|
+
* Generated by: scripts/generate-loader-types.ts
|
|
6
|
+
* Generated at: 2026-02-28T16:38:27.739Z
|
|
7
|
+
*
|
|
8
|
+
* This file provides TypeScript interfaces for all loader configurations,
|
|
9
|
+
* enabling IDE auto-complete and compile-time validation.
|
|
10
|
+
*
|
|
11
|
+
* Usage:
|
|
12
|
+
* ```typescript
|
|
13
|
+
* import type { ProductUpsertConfig, LoaderConfig } from "./types/loader-configs";
|
|
14
|
+
*
|
|
15
|
+
* const config: ProductUpsertConfig = {
|
|
16
|
+
* adapterCode: "productUpsert",
|
|
17
|
+
* nameField: "name", // ← IDE auto-complete available!
|
|
18
|
+
* slugField: "slug",
|
|
19
|
+
* };
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
/**
|
|
23
|
+
* Upsert Products and default Variants by slug/SKU. Supports channel, multi-currency prices, tax category, stock and inventory flags.
|
|
24
|
+
* @requires UpdateCatalog
|
|
25
|
+
* @entityType product
|
|
26
|
+
*/
|
|
27
|
+
export interface ProductUpsertConfig {
|
|
28
|
+
/** Loader adapter code (discriminator) */
|
|
29
|
+
adapterCode: 'productUpsert';
|
|
30
|
+
/** Channel code */
|
|
31
|
+
channel: string;
|
|
32
|
+
/** Load strategy */
|
|
33
|
+
strategy: string;
|
|
34
|
+
/** Conflict strategy */
|
|
35
|
+
conflictStrategy: string;
|
|
36
|
+
/** Name field (from record) */
|
|
37
|
+
nameField?: string;
|
|
38
|
+
/** Slug field (from record) */
|
|
39
|
+
slugField?: string;
|
|
40
|
+
/** Description field (from record) */
|
|
41
|
+
descriptionField?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Enabled field (from record)
|
|
44
|
+
* Record field containing product enabled/published flag (defaults to "enabled")
|
|
45
|
+
*/
|
|
46
|
+
enabledField?: string;
|
|
47
|
+
/** SKU field (from record) */
|
|
48
|
+
skuField?: string;
|
|
49
|
+
/** Price field (from record) */
|
|
50
|
+
priceField?: string;
|
|
51
|
+
/** Tax category name */
|
|
52
|
+
taxCategoryName?: string;
|
|
53
|
+
/** Track inventory */
|
|
54
|
+
trackInventory?: string;
|
|
55
|
+
/** Stock on hand field */
|
|
56
|
+
stockField?: string;
|
|
57
|
+
/** Stock by location field (object) */
|
|
58
|
+
stockByLocationField?: string;
|
|
59
|
+
/**
|
|
60
|
+
* Custom fields field (object)
|
|
61
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
62
|
+
*/
|
|
63
|
+
customFieldsField?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Create variants
|
|
66
|
+
* Create/update a default variant alongside the product. Set to false when variants are handled by a separate variantUpsert step.
|
|
67
|
+
*/
|
|
68
|
+
createVariants?: boolean;
|
|
69
|
+
/**
|
|
70
|
+
* Channels field (array/string)
|
|
71
|
+
* Record field containing channel codes for dynamic per-record channel assignment (array or comma-separated)
|
|
72
|
+
*/
|
|
73
|
+
channelsField?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Translations field
|
|
76
|
+
* Record field containing multi-language translations (array or object map). Overrides name/slug/description fields.
|
|
77
|
+
*/
|
|
78
|
+
translationsField?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Facet values mode
|
|
81
|
+
* How to handle product facet values on update
|
|
82
|
+
*/
|
|
83
|
+
facetValuesMode?: string;
|
|
84
|
+
/**
|
|
85
|
+
* Assets mode
|
|
86
|
+
* How to handle product assets on update
|
|
87
|
+
*/
|
|
88
|
+
assetsMode?: string;
|
|
89
|
+
/**
|
|
90
|
+
* Featured asset mode
|
|
91
|
+
* How to handle product featured asset on update
|
|
92
|
+
*/
|
|
93
|
+
featuredAssetMode?: string;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Upsert ProductVariant by SKU. Supports create/update/upsert strategy, channel, prices, stock, tax, option groups, and custom fields. For creation, record must contain productSlug, productId, or productName to resolve the parent product.
|
|
97
|
+
* @requires UpdateCatalog
|
|
98
|
+
* @entityType product-variant
|
|
99
|
+
*/
|
|
100
|
+
export interface VariantUpsertConfig {
|
|
101
|
+
/** Loader adapter code (discriminator) */
|
|
102
|
+
adapterCode: 'variantUpsert';
|
|
103
|
+
/** Channel code */
|
|
104
|
+
channel?: string;
|
|
105
|
+
/**
|
|
106
|
+
* Load strategy
|
|
107
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
108
|
+
*/
|
|
109
|
+
strategy: string;
|
|
110
|
+
/** SKU field (from record) */
|
|
111
|
+
skuField: string;
|
|
112
|
+
/** Name field (from record) */
|
|
113
|
+
nameField?: string;
|
|
114
|
+
/** Price field (from record) */
|
|
115
|
+
priceField?: string;
|
|
116
|
+
/** Price map field (object) */
|
|
117
|
+
priceByCurrencyField?: string;
|
|
118
|
+
/** Tax category name */
|
|
119
|
+
taxCategoryName?: string;
|
|
120
|
+
/** Stock on hand field */
|
|
121
|
+
stockField?: string;
|
|
122
|
+
/** Stock by location field (object) */
|
|
123
|
+
stockByLocationField?: string;
|
|
124
|
+
/**
|
|
125
|
+
* Custom fields field (object)
|
|
126
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
127
|
+
*/
|
|
128
|
+
customFieldsField?: string;
|
|
129
|
+
/** Option groups field (object) */
|
|
130
|
+
optionGroupsField?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Option IDs field (array)
|
|
133
|
+
* Record field containing pre-existing Vendure option IDs (e.g. [1, 2, 3]). Passed directly without lookup.
|
|
134
|
+
*/
|
|
135
|
+
optionIdsField?: string;
|
|
136
|
+
/**
|
|
137
|
+
* Option codes field (array)
|
|
138
|
+
* Record field containing option codes (e.g. ["size-s", "color-blue"]). Resolved to IDs by code lookup.
|
|
139
|
+
*/
|
|
140
|
+
optionCodesField?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Enabled field (from record)
|
|
143
|
+
* Record field containing variant enabled/published flag (defaults to "enabled")
|
|
144
|
+
*/
|
|
145
|
+
enabledField?: string;
|
|
146
|
+
/**
|
|
147
|
+
* Channels field (array/string)
|
|
148
|
+
* Record field containing channel codes for dynamic per-record channel assignment (array or comma-separated)
|
|
149
|
+
*/
|
|
150
|
+
channelsField?: string;
|
|
151
|
+
/**
|
|
152
|
+
* Translations field
|
|
153
|
+
* Record field containing multi-language translations (array or object map). Overrides name field.
|
|
154
|
+
*/
|
|
155
|
+
translationsField?: string;
|
|
156
|
+
/**
|
|
157
|
+
* Facet values mode
|
|
158
|
+
* How to handle variant facet values on update
|
|
159
|
+
*/
|
|
160
|
+
facetValuesMode?: string;
|
|
161
|
+
/**
|
|
162
|
+
* Assets mode
|
|
163
|
+
* How to handle variant assets on update
|
|
164
|
+
*/
|
|
165
|
+
assetsMode?: string;
|
|
166
|
+
/**
|
|
167
|
+
* Featured asset mode
|
|
168
|
+
* How to handle variant featured asset on update
|
|
169
|
+
*/
|
|
170
|
+
featuredAssetMode?: string;
|
|
171
|
+
/**
|
|
172
|
+
* Options mode
|
|
173
|
+
* How to handle variant options on update
|
|
174
|
+
*/
|
|
175
|
+
optionsMode?: string;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* Upsert Customer by email or externalId; merge addresses; assign groups.
|
|
179
|
+
* @requires UpdateCustomer
|
|
180
|
+
* @entityType customer
|
|
181
|
+
*/
|
|
182
|
+
export interface CustomerUpsertConfig {
|
|
183
|
+
/** Loader adapter code (discriminator) */
|
|
184
|
+
adapterCode: 'customerUpsert';
|
|
185
|
+
/**
|
|
186
|
+
* Load strategy
|
|
187
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
188
|
+
*/
|
|
189
|
+
strategy?: string;
|
|
190
|
+
/** Email field */
|
|
191
|
+
emailField: string;
|
|
192
|
+
/** First name field */
|
|
193
|
+
firstNameField?: string;
|
|
194
|
+
/** Last name field */
|
|
195
|
+
lastNameField?: string;
|
|
196
|
+
/** Phone number field */
|
|
197
|
+
phoneNumberField?: string;
|
|
198
|
+
/** Addresses array field */
|
|
199
|
+
addressesField?: string;
|
|
200
|
+
/**
|
|
201
|
+
* Addresses mode
|
|
202
|
+
* How to handle customer addresses on update (UPSERT_BY_MATCH prevents duplicates)
|
|
203
|
+
*/
|
|
204
|
+
addressesMode?: string;
|
|
205
|
+
/**
|
|
206
|
+
* Address match fields
|
|
207
|
+
* Comma-separated fields to match existing addresses (for UPSERT_BY_MATCH mode)
|
|
208
|
+
* @default streetLine1,city,countryCode
|
|
209
|
+
*/
|
|
210
|
+
addressMatchFields?: string;
|
|
211
|
+
/** Group codes array field */
|
|
212
|
+
groupsField?: string;
|
|
213
|
+
/** Groups mode */
|
|
214
|
+
groupsMode?: string;
|
|
215
|
+
/**
|
|
216
|
+
* Custom fields field (object)
|
|
217
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
218
|
+
*/
|
|
219
|
+
customFieldsField?: string;
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* Upsert Order by code for system migrations. Creates order with customer, line items, addresses, and state transitions.
|
|
223
|
+
* @requires UpdateOrder
|
|
224
|
+
* @entityType order
|
|
225
|
+
*/
|
|
226
|
+
export interface OrderUpsertConfig {
|
|
227
|
+
/** Loader adapter code (discriminator) */
|
|
228
|
+
adapterCode: 'orderUpsert';
|
|
229
|
+
/** Load strategy */
|
|
230
|
+
strategy?: string;
|
|
231
|
+
/**
|
|
232
|
+
* Lookup fields
|
|
233
|
+
* Comma-separated fields for existing entity lookup (default: code)
|
|
234
|
+
*/
|
|
235
|
+
lookupFields?: string;
|
|
236
|
+
/**
|
|
237
|
+
* Order code field
|
|
238
|
+
* Record field for order code (default: code)
|
|
239
|
+
*/
|
|
240
|
+
codeField?: string;
|
|
241
|
+
/**
|
|
242
|
+
* Customer email field
|
|
243
|
+
* Record field for customer email (default: customerEmail)
|
|
244
|
+
*/
|
|
245
|
+
customerEmailField?: string;
|
|
246
|
+
/**
|
|
247
|
+
* Lines field
|
|
248
|
+
* Record field for order lines array (default: lines)
|
|
249
|
+
*/
|
|
250
|
+
linesField?: string;
|
|
251
|
+
/**
|
|
252
|
+
* Lines mode
|
|
253
|
+
* How to handle order lines on update
|
|
254
|
+
*/
|
|
255
|
+
linesMode?: string;
|
|
256
|
+
/**
|
|
257
|
+
* Lines match by
|
|
258
|
+
* Field to match order lines by (for MERGE_BY_SKU and UPDATE_BY_ID modes)
|
|
259
|
+
* @default sku
|
|
260
|
+
*/
|
|
261
|
+
linesMatchBy?: string;
|
|
262
|
+
/** Shipping address field */
|
|
263
|
+
shippingAddressField?: string;
|
|
264
|
+
/** Billing address field */
|
|
265
|
+
billingAddressField?: string;
|
|
266
|
+
/** Shipping method code field */
|
|
267
|
+
shippingMethodCodeField?: string;
|
|
268
|
+
/**
|
|
269
|
+
* Payment method code
|
|
270
|
+
* Payment method code for state transitions (auto-resolved if not set)
|
|
271
|
+
*/
|
|
272
|
+
paymentMethodCode?: string;
|
|
273
|
+
/**
|
|
274
|
+
* Payment method code field
|
|
275
|
+
* Record field for dynamic payment method code
|
|
276
|
+
*/
|
|
277
|
+
paymentMethodCodeField?: string;
|
|
278
|
+
/**
|
|
279
|
+
* Target state
|
|
280
|
+
* State to transition order to after creation (e.g. ArrangingPayment, PaymentSettled)
|
|
281
|
+
*/
|
|
282
|
+
state?: string;
|
|
283
|
+
/**
|
|
284
|
+
* State field
|
|
285
|
+
* Record field for dynamic state (default: state)
|
|
286
|
+
*/
|
|
287
|
+
stateField?: string;
|
|
288
|
+
/**
|
|
289
|
+
* Order placed at field
|
|
290
|
+
* Record field for backdated order date
|
|
291
|
+
*/
|
|
292
|
+
orderPlacedAtField?: string;
|
|
293
|
+
/** Custom fields field (object) */
|
|
294
|
+
customFieldsField?: string;
|
|
295
|
+
}
|
|
296
|
+
/**
|
|
297
|
+
* Attach a note to an Order by code or id.
|
|
298
|
+
* @requires UpdateOrder
|
|
299
|
+
* @entityType order
|
|
300
|
+
*/
|
|
301
|
+
export interface OrderNoteConfig {
|
|
302
|
+
/** Loader adapter code (discriminator) */
|
|
303
|
+
adapterCode: 'orderNote';
|
|
304
|
+
/** Order code field */
|
|
305
|
+
orderCodeField?: string;
|
|
306
|
+
/** Order id field */
|
|
307
|
+
orderIdField?: string;
|
|
308
|
+
/** Note text field */
|
|
309
|
+
noteField: string;
|
|
310
|
+
/** Private note */
|
|
311
|
+
isPrivate?: boolean;
|
|
312
|
+
}
|
|
313
|
+
/**
|
|
314
|
+
* Adjust stock levels by SKU and stock location code map.
|
|
315
|
+
* @requires UpdateCatalog
|
|
316
|
+
* @entityType inventory
|
|
317
|
+
*/
|
|
318
|
+
export interface StockAdjustConfig {
|
|
319
|
+
/** Loader adapter code (discriminator) */
|
|
320
|
+
adapterCode: 'stockAdjust';
|
|
321
|
+
/** SKU field */
|
|
322
|
+
skuField: string;
|
|
323
|
+
/** Stock by location map (code->qty) */
|
|
324
|
+
stockByLocationField: string;
|
|
325
|
+
/** Set absolute (else delta) */
|
|
326
|
+
absolute?: boolean;
|
|
327
|
+
}
|
|
328
|
+
/**
|
|
329
|
+
* Apply a coupon code to an Order by id/code.
|
|
330
|
+
* @requires UpdateOrder
|
|
331
|
+
* @entityType order
|
|
332
|
+
*/
|
|
333
|
+
export interface ApplyCouponConfig {
|
|
334
|
+
/** Loader adapter code (discriminator) */
|
|
335
|
+
adapterCode: 'applyCoupon';
|
|
336
|
+
/** Order id field */
|
|
337
|
+
orderIdField?: string;
|
|
338
|
+
/** Order code field */
|
|
339
|
+
orderCodeField?: string;
|
|
340
|
+
/** Coupon code field */
|
|
341
|
+
couponField: string;
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* Upsert Collection by slug/code; supports create/update/upsert strategy, channel, multi-language, multi-channel, and custom fields.
|
|
345
|
+
* @requires UpdateCatalog
|
|
346
|
+
* @entityType collection
|
|
347
|
+
*/
|
|
348
|
+
export interface CollectionUpsertConfig {
|
|
349
|
+
/** Loader adapter code (discriminator) */
|
|
350
|
+
adapterCode: 'collectionUpsert';
|
|
351
|
+
/** Channel code */
|
|
352
|
+
channel?: string;
|
|
353
|
+
/**
|
|
354
|
+
* Load strategy
|
|
355
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
356
|
+
*/
|
|
357
|
+
strategy?: string;
|
|
358
|
+
/** Slug field */
|
|
359
|
+
slugField: string;
|
|
360
|
+
/** Name field */
|
|
361
|
+
nameField: string;
|
|
362
|
+
/** Parent slug field */
|
|
363
|
+
parentSlugField?: string;
|
|
364
|
+
/** Description field */
|
|
365
|
+
descriptionField?: string;
|
|
366
|
+
/** Apply filters job */
|
|
367
|
+
applyFilters?: boolean;
|
|
368
|
+
/**
|
|
369
|
+
* Custom fields field (object)
|
|
370
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
371
|
+
*/
|
|
372
|
+
customFieldsField?: string;
|
|
373
|
+
/**
|
|
374
|
+
* Translations field
|
|
375
|
+
* Record field containing multi-language translations (array or object map). Overrides name/slug/description fields.
|
|
376
|
+
*/
|
|
377
|
+
translationsField?: string;
|
|
378
|
+
/**
|
|
379
|
+
* Channels field (array/string)
|
|
380
|
+
* Record field containing channel codes for dynamic per-record channel assignment (array or comma-separated)
|
|
381
|
+
*/
|
|
382
|
+
channelsField?: string;
|
|
383
|
+
/**
|
|
384
|
+
* Private flag field
|
|
385
|
+
* Record field containing isPrivate boolean flag
|
|
386
|
+
*/
|
|
387
|
+
isPrivateField?: string;
|
|
388
|
+
/**
|
|
389
|
+
* Assets mode
|
|
390
|
+
* How to handle collection assets on update
|
|
391
|
+
*/
|
|
392
|
+
assetsMode?: string;
|
|
393
|
+
/**
|
|
394
|
+
* Filters mode
|
|
395
|
+
* How to handle collection filters on update
|
|
396
|
+
*/
|
|
397
|
+
filtersMode?: string;
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* Upsert Promotion by couponCode; create/update enabled dates/actions/conditions. Supports custom fields.
|
|
401
|
+
* @requires UpdatePromotion
|
|
402
|
+
* @entityType promotion
|
|
403
|
+
*/
|
|
404
|
+
export interface PromotionUpsertConfig {
|
|
405
|
+
/** Loader adapter code (discriminator) */
|
|
406
|
+
adapterCode: 'promotionUpsert';
|
|
407
|
+
/**
|
|
408
|
+
* Load strategy
|
|
409
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
410
|
+
*/
|
|
411
|
+
strategy?: string;
|
|
412
|
+
/** Coupon code field */
|
|
413
|
+
codeField: string;
|
|
414
|
+
/** Name field */
|
|
415
|
+
nameField?: string;
|
|
416
|
+
/** Enabled field */
|
|
417
|
+
enabledField?: string;
|
|
418
|
+
/** Starts at field */
|
|
419
|
+
startsAtField?: string;
|
|
420
|
+
/** Ends at field */
|
|
421
|
+
endsAtField?: string;
|
|
422
|
+
/** Conditions field (JSON) */
|
|
423
|
+
conditionsField?: string;
|
|
424
|
+
/**
|
|
425
|
+
* Conditions mode
|
|
426
|
+
* How to handle promotion conditions on update
|
|
427
|
+
*/
|
|
428
|
+
conditionsMode?: string;
|
|
429
|
+
/** Actions field (JSON) */
|
|
430
|
+
actionsField?: string;
|
|
431
|
+
/**
|
|
432
|
+
* Actions mode
|
|
433
|
+
* How to handle promotion actions on update
|
|
434
|
+
*/
|
|
435
|
+
actionsMode?: string;
|
|
436
|
+
/** Channel code */
|
|
437
|
+
channel?: string;
|
|
438
|
+
/**
|
|
439
|
+
* Custom fields field (object)
|
|
440
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
441
|
+
*/
|
|
442
|
+
customFieldsField?: string;
|
|
443
|
+
/**
|
|
444
|
+
* Description field
|
|
445
|
+
* Record field containing promotion description (defaults to "description")
|
|
446
|
+
*/
|
|
447
|
+
descriptionField?: string;
|
|
448
|
+
/**
|
|
449
|
+
* Per-customer usage limit field
|
|
450
|
+
* Record field containing the per-customer usage limit (integer)
|
|
451
|
+
*/
|
|
452
|
+
perCustomerUsageLimitField?: string;
|
|
453
|
+
/**
|
|
454
|
+
* Translations field
|
|
455
|
+
* Record field containing multi-language translations (array or object map). Overrides name/description fields.
|
|
456
|
+
*/
|
|
457
|
+
translationsField?: string;
|
|
458
|
+
/**
|
|
459
|
+
* Channels field (array/string)
|
|
460
|
+
* Record field containing channel codes for dynamic per-record channel assignment (array or comma-separated)
|
|
461
|
+
*/
|
|
462
|
+
channelsField?: string;
|
|
463
|
+
}
|
|
464
|
+
/**
|
|
465
|
+
* Transition an order to a new state by id/code.
|
|
466
|
+
* @requires UpdateOrder
|
|
467
|
+
* @entityType order
|
|
468
|
+
*/
|
|
469
|
+
export interface OrderTransitionConfig {
|
|
470
|
+
/** Loader adapter code (discriminator) */
|
|
471
|
+
adapterCode: 'orderTransition';
|
|
472
|
+
/** Order id field */
|
|
473
|
+
orderIdField?: string;
|
|
474
|
+
/** Order code field */
|
|
475
|
+
orderCodeField?: string;
|
|
476
|
+
/** Target state */
|
|
477
|
+
state: string;
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* Attach existing Asset (by id) as featured asset to a Product/Collection by slug.
|
|
481
|
+
* @requires UpdateCatalog
|
|
482
|
+
* @entityType asset
|
|
483
|
+
*/
|
|
484
|
+
export interface AssetAttachConfig {
|
|
485
|
+
/** Loader adapter code (discriminator) */
|
|
486
|
+
adapterCode: 'assetAttach';
|
|
487
|
+
/** Entity type */
|
|
488
|
+
entity: string;
|
|
489
|
+
/** Slug field */
|
|
490
|
+
slugField: string;
|
|
491
|
+
/** Asset ID field */
|
|
492
|
+
assetIdField: string;
|
|
493
|
+
/** Channel code */
|
|
494
|
+
channel?: string;
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* Import Asset from URL. Downloads file and creates asset in Vendure.
|
|
498
|
+
* @requires UpdateCatalog
|
|
499
|
+
* @entityType asset
|
|
500
|
+
*/
|
|
501
|
+
export interface AssetImportConfig {
|
|
502
|
+
/** Loader adapter code (discriminator) */
|
|
503
|
+
adapterCode: 'assetImport';
|
|
504
|
+
/** Source URL field */
|
|
505
|
+
sourceUrlField: string;
|
|
506
|
+
/** Filename field */
|
|
507
|
+
filenameField?: string;
|
|
508
|
+
/** Name field */
|
|
509
|
+
nameField?: string;
|
|
510
|
+
/** Tags field (array) */
|
|
511
|
+
tagsField?: string;
|
|
512
|
+
/** Channel code */
|
|
513
|
+
channel?: string;
|
|
514
|
+
}
|
|
515
|
+
/**
|
|
516
|
+
* Upsert Facet by code; create or update facet. Supports custom fields.
|
|
517
|
+
* @requires UpdateCatalog
|
|
518
|
+
* @entityType facet
|
|
519
|
+
*/
|
|
520
|
+
export interface FacetUpsertConfig {
|
|
521
|
+
/** Loader adapter code (discriminator) */
|
|
522
|
+
adapterCode: 'facetUpsert';
|
|
523
|
+
/**
|
|
524
|
+
* Load strategy
|
|
525
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
526
|
+
*/
|
|
527
|
+
strategy?: string;
|
|
528
|
+
/** Code field */
|
|
529
|
+
codeField: string;
|
|
530
|
+
/** Name field */
|
|
531
|
+
nameField: string;
|
|
532
|
+
/** Private field */
|
|
533
|
+
privateField?: string;
|
|
534
|
+
/** Channel code */
|
|
535
|
+
channel?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Custom fields field (object)
|
|
538
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
539
|
+
*/
|
|
540
|
+
customFieldsField?: string;
|
|
541
|
+
/**
|
|
542
|
+
* Translations field
|
|
543
|
+
* Record field containing multi-language translations (array or object map). Overrides name field.
|
|
544
|
+
*/
|
|
545
|
+
translationsField?: string;
|
|
546
|
+
/**
|
|
547
|
+
* Channels field (array/string)
|
|
548
|
+
* Record field containing channel codes for dynamic per-record channel assignment (array or comma-separated)
|
|
549
|
+
*/
|
|
550
|
+
channelsField?: string;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Upsert FacetValue by code; requires facet to exist. Supports custom fields.
|
|
554
|
+
* @requires UpdateCatalog
|
|
555
|
+
* @entityType facet-value
|
|
556
|
+
*/
|
|
557
|
+
export interface FacetValueUpsertConfig {
|
|
558
|
+
/** Loader adapter code (discriminator) */
|
|
559
|
+
adapterCode: 'facetValueUpsert';
|
|
560
|
+
/**
|
|
561
|
+
* Load strategy
|
|
562
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
563
|
+
*/
|
|
564
|
+
strategy?: string;
|
|
565
|
+
/** Facet code field */
|
|
566
|
+
facetCodeField: string;
|
|
567
|
+
/** Value code field */
|
|
568
|
+
codeField: string;
|
|
569
|
+
/** Value name field */
|
|
570
|
+
nameField: string;
|
|
571
|
+
/** Channel code */
|
|
572
|
+
channel?: string;
|
|
573
|
+
/**
|
|
574
|
+
* Custom fields field (object)
|
|
575
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
576
|
+
*/
|
|
577
|
+
customFieldsField?: string;
|
|
578
|
+
/**
|
|
579
|
+
* Translations field
|
|
580
|
+
* Record field containing multi-language translations (array or object map). Overrides name field.
|
|
581
|
+
*/
|
|
582
|
+
translationsField?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Channels field (array/string)
|
|
585
|
+
* Record field containing channel codes for dynamic per-record channel assignment (array or comma-separated)
|
|
586
|
+
*/
|
|
587
|
+
channelsField?: string;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* POST/PUT records to an external REST endpoint. Supports auth and per-record POST or array batch.
|
|
591
|
+
* @requires UpdateDataHubSettings
|
|
592
|
+
*/
|
|
593
|
+
export interface RestPostConfig {
|
|
594
|
+
/** Loader adapter code (discriminator) */
|
|
595
|
+
adapterCode: 'restPost';
|
|
596
|
+
/** Endpoint */
|
|
597
|
+
endpoint: string;
|
|
598
|
+
/** Method */
|
|
599
|
+
method: string;
|
|
600
|
+
/** Headers (JSON) */
|
|
601
|
+
headers?: Record<string, unknown>;
|
|
602
|
+
/** Auth preset */
|
|
603
|
+
auth?: string;
|
|
604
|
+
/** Bearer token secret code */
|
|
605
|
+
bearerTokenSecretCode?: string;
|
|
606
|
+
/** Basic auth secret code */
|
|
607
|
+
basicSecretCode?: string;
|
|
608
|
+
/** HMAC secret code */
|
|
609
|
+
hmacSecretCode?: string;
|
|
610
|
+
/** HMAC header name */
|
|
611
|
+
hmacHeader?: string;
|
|
612
|
+
/** HMAC payload template */
|
|
613
|
+
hmacPayloadTemplate?: string;
|
|
614
|
+
/** Batch mode */
|
|
615
|
+
batchMode?: string;
|
|
616
|
+
/**
|
|
617
|
+
* Max batch size (array mode)
|
|
618
|
+
* Chunk size when batchMode=array
|
|
619
|
+
*/
|
|
620
|
+
maxBatchSize?: number;
|
|
621
|
+
/**
|
|
622
|
+
* Retries
|
|
623
|
+
* Number of retries for failed requests
|
|
624
|
+
*/
|
|
625
|
+
retries?: number;
|
|
626
|
+
/**
|
|
627
|
+
* Retry delay (ms)
|
|
628
|
+
* Delay between retries
|
|
629
|
+
*/
|
|
630
|
+
retryDelayMs?: number;
|
|
631
|
+
/**
|
|
632
|
+
* Timeout (ms)
|
|
633
|
+
* Request timeout in milliseconds
|
|
634
|
+
*/
|
|
635
|
+
timeoutMs?: number;
|
|
636
|
+
}
|
|
637
|
+
/**
|
|
638
|
+
* Send records as GraphQL mutations to an external API endpoint. Supports variable mapping, auth, batching, and retries.
|
|
639
|
+
* @requires UpdateDataHubSettings
|
|
640
|
+
*/
|
|
641
|
+
export interface GraphqlMutationConfig {
|
|
642
|
+
/** Loader adapter code (discriminator) */
|
|
643
|
+
adapterCode: 'graphqlMutation';
|
|
644
|
+
/** Endpoint URL */
|
|
645
|
+
endpoint: string;
|
|
646
|
+
/** GraphQL mutation */
|
|
647
|
+
mutation: Record<string, unknown>;
|
|
648
|
+
/** Variable mapping (JSON) */
|
|
649
|
+
variableMapping: Record<string, unknown>;
|
|
650
|
+
/** Headers (JSON) */
|
|
651
|
+
headers?: Record<string, unknown>;
|
|
652
|
+
/** Auth preset */
|
|
653
|
+
auth?: string;
|
|
654
|
+
/** Bearer token secret code */
|
|
655
|
+
bearerTokenSecretCode?: string;
|
|
656
|
+
/** Basic auth secret code */
|
|
657
|
+
basicSecretCode?: string;
|
|
658
|
+
/** Batch mode */
|
|
659
|
+
batchMode?: string;
|
|
660
|
+
/**
|
|
661
|
+
* Max batch size
|
|
662
|
+
* Chunk size when batchMode=batch
|
|
663
|
+
*/
|
|
664
|
+
maxBatchSize?: number;
|
|
665
|
+
/**
|
|
666
|
+
* Retries
|
|
667
|
+
* Number of retries for failed requests
|
|
668
|
+
*/
|
|
669
|
+
retries?: number;
|
|
670
|
+
/**
|
|
671
|
+
* Retry delay (ms)
|
|
672
|
+
* Delay between retries
|
|
673
|
+
*/
|
|
674
|
+
retryDelayMs?: number;
|
|
675
|
+
/**
|
|
676
|
+
* Timeout (ms)
|
|
677
|
+
* Request timeout in milliseconds
|
|
678
|
+
*/
|
|
679
|
+
timeoutMs?: number;
|
|
680
|
+
}
|
|
681
|
+
/**
|
|
682
|
+
* Upsert TaxRate by name; resolves tax category and zone by code.
|
|
683
|
+
* @requires UpdateSettings
|
|
684
|
+
* @entityType tax-rate
|
|
685
|
+
*/
|
|
686
|
+
export interface TaxRateUpsertConfig {
|
|
687
|
+
/** Loader adapter code (discriminator) */
|
|
688
|
+
adapterCode: 'taxRateUpsert';
|
|
689
|
+
/**
|
|
690
|
+
* Load strategy
|
|
691
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
692
|
+
*/
|
|
693
|
+
strategy?: string;
|
|
694
|
+
/**
|
|
695
|
+
* Name field
|
|
696
|
+
* Field containing tax rate name
|
|
697
|
+
*/
|
|
698
|
+
nameField: string;
|
|
699
|
+
/**
|
|
700
|
+
* Value field
|
|
701
|
+
* Field containing tax rate percentage (0-100)
|
|
702
|
+
*/
|
|
703
|
+
valueField: string;
|
|
704
|
+
/**
|
|
705
|
+
* Enabled field
|
|
706
|
+
* Field indicating if rate is active
|
|
707
|
+
*/
|
|
708
|
+
enabledField?: string;
|
|
709
|
+
/**
|
|
710
|
+
* Tax category code field
|
|
711
|
+
* Field containing tax category code/name
|
|
712
|
+
*/
|
|
713
|
+
taxCategoryCodeField: string;
|
|
714
|
+
/**
|
|
715
|
+
* Tax category ID field
|
|
716
|
+
* Alternative: field containing tax category ID
|
|
717
|
+
*/
|
|
718
|
+
taxCategoryIdField?: string;
|
|
719
|
+
/**
|
|
720
|
+
* Zone code field
|
|
721
|
+
* Field containing zone code/name
|
|
722
|
+
*/
|
|
723
|
+
zoneCodeField: string;
|
|
724
|
+
/**
|
|
725
|
+
* Zone ID field
|
|
726
|
+
* Alternative: field containing zone ID
|
|
727
|
+
*/
|
|
728
|
+
zoneIdField?: string;
|
|
729
|
+
}
|
|
730
|
+
/**
|
|
731
|
+
* Upsert PaymentMethod by code; configure handler and eligibility checker.
|
|
732
|
+
* @requires UpdateSettings
|
|
733
|
+
* @entityType payment-method
|
|
734
|
+
*/
|
|
735
|
+
export interface PaymentMethodUpsertConfig {
|
|
736
|
+
/** Loader adapter code (discriminator) */
|
|
737
|
+
adapterCode: 'paymentMethodUpsert';
|
|
738
|
+
/**
|
|
739
|
+
* Load strategy
|
|
740
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
741
|
+
*/
|
|
742
|
+
strategy?: string;
|
|
743
|
+
/**
|
|
744
|
+
* Name field
|
|
745
|
+
* Field containing payment method name
|
|
746
|
+
*/
|
|
747
|
+
nameField: string;
|
|
748
|
+
/**
|
|
749
|
+
* Code field
|
|
750
|
+
* Field containing unique payment method code
|
|
751
|
+
*/
|
|
752
|
+
codeField: string;
|
|
753
|
+
/**
|
|
754
|
+
* Description field
|
|
755
|
+
* Field containing description shown to customers
|
|
756
|
+
*/
|
|
757
|
+
descriptionField?: string;
|
|
758
|
+
/**
|
|
759
|
+
* Enabled field
|
|
760
|
+
* Field indicating if method is active
|
|
761
|
+
*/
|
|
762
|
+
enabledField?: string;
|
|
763
|
+
/** Handler field */
|
|
764
|
+
handlerField: string;
|
|
765
|
+
/** Checker field */
|
|
766
|
+
checkerField?: string;
|
|
767
|
+
/**
|
|
768
|
+
* Custom fields field (object)
|
|
769
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
770
|
+
*/
|
|
771
|
+
customFieldsField?: string;
|
|
772
|
+
/**
|
|
773
|
+
* Translations field
|
|
774
|
+
* Record field containing multi-language translations (array or object map). Overrides name/description fields.
|
|
775
|
+
*/
|
|
776
|
+
translationsField?: string;
|
|
777
|
+
/**
|
|
778
|
+
* Channels field (array/string)
|
|
779
|
+
* Record field containing channel codes for dynamic per-record channel assignment (array or comma-separated)
|
|
780
|
+
*/
|
|
781
|
+
channelsField?: string;
|
|
782
|
+
}
|
|
783
|
+
/**
|
|
784
|
+
* Upsert Channel by code; configure currencies, languages, and zones.
|
|
785
|
+
* @requires UpdateSettings
|
|
786
|
+
* @entityType channel
|
|
787
|
+
*/
|
|
788
|
+
export interface ChannelUpsertConfig {
|
|
789
|
+
/** Loader adapter code (discriminator) */
|
|
790
|
+
adapterCode: 'channelUpsert';
|
|
791
|
+
/**
|
|
792
|
+
* Load strategy
|
|
793
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
794
|
+
*/
|
|
795
|
+
strategy?: string;
|
|
796
|
+
/**
|
|
797
|
+
* Code field
|
|
798
|
+
* Field containing unique channel code
|
|
799
|
+
*/
|
|
800
|
+
codeField: string;
|
|
801
|
+
/**
|
|
802
|
+
* Token field
|
|
803
|
+
* Field containing channel token (auto-generated if not provided)
|
|
804
|
+
*/
|
|
805
|
+
tokenField?: string;
|
|
806
|
+
/**
|
|
807
|
+
* Default language code field
|
|
808
|
+
* Field containing default language (e.g., "en")
|
|
809
|
+
*/
|
|
810
|
+
defaultLanguageCodeField: string;
|
|
811
|
+
/**
|
|
812
|
+
* Available languages field
|
|
813
|
+
* Field containing array of language codes
|
|
814
|
+
*/
|
|
815
|
+
availableLanguageCodesField?: string;
|
|
816
|
+
/**
|
|
817
|
+
* Default currency code field
|
|
818
|
+
* Field containing default currency (e.g., "USD")
|
|
819
|
+
*/
|
|
820
|
+
defaultCurrencyCodeField: string;
|
|
821
|
+
/**
|
|
822
|
+
* Available currencies field
|
|
823
|
+
* Field containing array of currency codes
|
|
824
|
+
*/
|
|
825
|
+
availableCurrencyCodesField?: string;
|
|
826
|
+
/**
|
|
827
|
+
* Prices include tax field
|
|
828
|
+
* Field indicating if prices include tax
|
|
829
|
+
*/
|
|
830
|
+
pricesIncludeTaxField?: string;
|
|
831
|
+
/**
|
|
832
|
+
* Default tax zone code field
|
|
833
|
+
* Field containing default tax zone code
|
|
834
|
+
*/
|
|
835
|
+
defaultTaxZoneCodeField?: string;
|
|
836
|
+
/**
|
|
837
|
+
* Default shipping zone code field
|
|
838
|
+
* Field containing default shipping zone code
|
|
839
|
+
*/
|
|
840
|
+
defaultShippingZoneCodeField?: string;
|
|
841
|
+
/**
|
|
842
|
+
* Seller ID field
|
|
843
|
+
* Field containing seller ID (for multi-vendor)
|
|
844
|
+
*/
|
|
845
|
+
sellerIdField?: string;
|
|
846
|
+
/**
|
|
847
|
+
* Custom fields field (object)
|
|
848
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
849
|
+
*/
|
|
850
|
+
customFieldsField?: string;
|
|
851
|
+
}
|
|
852
|
+
/**
|
|
853
|
+
* Upsert ShippingMethod by code; configure calculator, checker, and fulfillment handler. Supports multi-language translations and multi-channel assignment.
|
|
854
|
+
* @requires UpdateShippingMethod
|
|
855
|
+
* @entityType shipping-method
|
|
856
|
+
*/
|
|
857
|
+
export interface ShippingMethodUpsertConfig {
|
|
858
|
+
/** Loader adapter code (discriminator) */
|
|
859
|
+
adapterCode: 'shippingMethodUpsert';
|
|
860
|
+
/**
|
|
861
|
+
* Load strategy
|
|
862
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
863
|
+
*/
|
|
864
|
+
strategy?: string;
|
|
865
|
+
/**
|
|
866
|
+
* Name field
|
|
867
|
+
* Field containing shipping method display name
|
|
868
|
+
*/
|
|
869
|
+
nameField: string;
|
|
870
|
+
/**
|
|
871
|
+
* Code field
|
|
872
|
+
* Field containing unique shipping method code
|
|
873
|
+
*/
|
|
874
|
+
codeField: string;
|
|
875
|
+
/**
|
|
876
|
+
* Description field
|
|
877
|
+
* Field containing description shown to customers
|
|
878
|
+
*/
|
|
879
|
+
descriptionField?: string;
|
|
880
|
+
/**
|
|
881
|
+
* Fulfillment handler field
|
|
882
|
+
* Field containing fulfillment handler code (e.g., "manual-fulfillment")
|
|
883
|
+
*/
|
|
884
|
+
fulfillmentHandlerField: string;
|
|
885
|
+
/** Calculator field */
|
|
886
|
+
calculatorField: string;
|
|
887
|
+
/** Checker field */
|
|
888
|
+
checkerField?: string;
|
|
889
|
+
/**
|
|
890
|
+
* Custom fields field (object)
|
|
891
|
+
* Record field containing custom field values (defaults to "customFields")
|
|
892
|
+
*/
|
|
893
|
+
customFieldsField?: string;
|
|
894
|
+
/**
|
|
895
|
+
* Translations field
|
|
896
|
+
* Record field containing multi-language translations (array or object map). Overrides name/description fields.
|
|
897
|
+
*/
|
|
898
|
+
translationsField?: string;
|
|
899
|
+
/**
|
|
900
|
+
* Channels field (array/string)
|
|
901
|
+
* Record field containing channel codes for dynamic per-record channel assignment (array or comma-separated)
|
|
902
|
+
*/
|
|
903
|
+
channelsField?: string;
|
|
904
|
+
}
|
|
905
|
+
/**
|
|
906
|
+
* Upsert CustomerGroup by name; assign customers by email.
|
|
907
|
+
* @requires UpdateCustomer
|
|
908
|
+
* @entityType customer-group
|
|
909
|
+
*/
|
|
910
|
+
export interface CustomerGroupUpsertConfig {
|
|
911
|
+
/** Loader adapter code (discriminator) */
|
|
912
|
+
adapterCode: 'customerGroupUpsert';
|
|
913
|
+
/**
|
|
914
|
+
* Load strategy
|
|
915
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
916
|
+
*/
|
|
917
|
+
strategy?: string;
|
|
918
|
+
/**
|
|
919
|
+
* Name field
|
|
920
|
+
* Field containing unique customer group name
|
|
921
|
+
*/
|
|
922
|
+
nameField: string;
|
|
923
|
+
/**
|
|
924
|
+
* Customer emails field
|
|
925
|
+
* Field containing array of customer email addresses to add
|
|
926
|
+
*/
|
|
927
|
+
customerEmailsField?: string;
|
|
928
|
+
}
|
|
929
|
+
/**
|
|
930
|
+
* Upsert StockLocation by name; manage inventory locations and warehouses.
|
|
931
|
+
* @requires UpdateCatalog
|
|
932
|
+
* @entityType stock-location
|
|
933
|
+
*/
|
|
934
|
+
export interface StockLocationUpsertConfig {
|
|
935
|
+
/** Loader adapter code (discriminator) */
|
|
936
|
+
adapterCode: 'stockLocationUpsert';
|
|
937
|
+
/**
|
|
938
|
+
* Load strategy
|
|
939
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
940
|
+
*/
|
|
941
|
+
strategy?: string;
|
|
942
|
+
/**
|
|
943
|
+
* Name field
|
|
944
|
+
* Field containing stock location name
|
|
945
|
+
*/
|
|
946
|
+
nameField: string;
|
|
947
|
+
/**
|
|
948
|
+
* Description field
|
|
949
|
+
* Field containing location description
|
|
950
|
+
*/
|
|
951
|
+
descriptionField?: string;
|
|
952
|
+
}
|
|
953
|
+
/**
|
|
954
|
+
* Adjust stock levels for product variants by SKU. Supports stock location targeting.
|
|
955
|
+
* @requires UpdateCatalog
|
|
956
|
+
* @entityType inventory
|
|
957
|
+
*/
|
|
958
|
+
export interface InventoryAdjustConfig {
|
|
959
|
+
/** Loader adapter code (discriminator) */
|
|
960
|
+
adapterCode: 'inventoryAdjust';
|
|
961
|
+
/**
|
|
962
|
+
* Load strategy
|
|
963
|
+
* UPSERT: create or update. CREATE: only create new. UPDATE: only update existing.
|
|
964
|
+
*/
|
|
965
|
+
strategy?: string;
|
|
966
|
+
/**
|
|
967
|
+
* SKU field
|
|
968
|
+
* Field containing the product variant SKU
|
|
969
|
+
*/
|
|
970
|
+
skuField: string;
|
|
971
|
+
/**
|
|
972
|
+
* Stock on hand field
|
|
973
|
+
* Field containing the new absolute stock level
|
|
974
|
+
*/
|
|
975
|
+
stockOnHandField: string;
|
|
976
|
+
/**
|
|
977
|
+
* Stock location name field
|
|
978
|
+
* Field containing stock location name (uses default if not specified)
|
|
979
|
+
*/
|
|
980
|
+
stockLocationNameField?: string;
|
|
981
|
+
/**
|
|
982
|
+
* Stock location ID field
|
|
983
|
+
* Field containing stock location ID (alternative to name)
|
|
984
|
+
*/
|
|
985
|
+
stockLocationIdField?: string;
|
|
986
|
+
/**
|
|
987
|
+
* Reason field
|
|
988
|
+
* Field containing the adjustment reason
|
|
989
|
+
*/
|
|
990
|
+
reasonField?: string;
|
|
991
|
+
}
|
|
992
|
+
/**
|
|
993
|
+
* Delete entities (Product, Variant, Collection, Promotion, ShippingMethod, Customer, PaymentMethod, Facet, FacetValue, CustomerGroup, TaxRate, Asset, StockLocation) by slug, SKU, code, email, name, or ID.
|
|
994
|
+
* @requires UpdateCatalog
|
|
995
|
+
* @entityType product
|
|
996
|
+
*/
|
|
997
|
+
export interface EntityDeletionConfig {
|
|
998
|
+
/** Loader adapter code (discriminator) */
|
|
999
|
+
adapterCode: 'entityDeletion';
|
|
1000
|
+
/** Entity type */
|
|
1001
|
+
entityType?: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* Identifier field
|
|
1004
|
+
* Record field containing the identifier to match (default depends on entity type)
|
|
1005
|
+
*/
|
|
1006
|
+
identifierField?: string;
|
|
1007
|
+
/** Match by */
|
|
1008
|
+
matchBy?: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* Cascade delete variants
|
|
1011
|
+
* Delete all variants when deleting a product (default: true)
|
|
1012
|
+
*/
|
|
1013
|
+
cascadeVariants?: boolean;
|
|
1014
|
+
/** Channel code */
|
|
1015
|
+
channel?: string;
|
|
1016
|
+
}
|
|
1017
|
+
/**
|
|
1018
|
+
* Union type of all loader configurations.
|
|
1019
|
+
* Use this for type-safe loader config handling with discriminated unions.
|
|
1020
|
+
*/
|
|
1021
|
+
export type LoaderConfig = ProductUpsertConfig | VariantUpsertConfig | CustomerUpsertConfig | OrderUpsertConfig | OrderNoteConfig | StockAdjustConfig | ApplyCouponConfig | CollectionUpsertConfig | PromotionUpsertConfig | OrderTransitionConfig | AssetAttachConfig | AssetImportConfig | FacetUpsertConfig | FacetValueUpsertConfig | RestPostConfig | GraphqlMutationConfig | TaxRateUpsertConfig | PaymentMethodUpsertConfig | ChannelUpsertConfig | ShippingMethodUpsertConfig | CustomerGroupUpsertConfig | StockLocationUpsertConfig | InventoryAdjustConfig | EntityDeletionConfig | GenericLoaderConfig;
|
|
1022
|
+
/**
|
|
1023
|
+
* Generic fallback config for custom loaders not in the registry
|
|
1024
|
+
*/
|
|
1025
|
+
export interface GenericLoaderConfig {
|
|
1026
|
+
adapterCode: string;
|
|
1027
|
+
[key: string]: unknown;
|
|
1028
|
+
}
|
|
1029
|
+
/**
|
|
1030
|
+
* Extract config type by adapter code.
|
|
1031
|
+
* Example: ConfigByCode<"productUpsert"> = ProductUpsertConfig
|
|
1032
|
+
*/
|
|
1033
|
+
export type ConfigByCode<T extends string> = T extends keyof LoaderConfigMap ? LoaderConfigMap[T] : GenericLoaderConfig;
|
|
1034
|
+
/**
|
|
1035
|
+
* Mapping of adapter codes to their config types
|
|
1036
|
+
*/
|
|
1037
|
+
export interface LoaderConfigMap {
|
|
1038
|
+
productUpsert: ProductUpsertConfig;
|
|
1039
|
+
variantUpsert: VariantUpsertConfig;
|
|
1040
|
+
customerUpsert: CustomerUpsertConfig;
|
|
1041
|
+
orderUpsert: OrderUpsertConfig;
|
|
1042
|
+
orderNote: OrderNoteConfig;
|
|
1043
|
+
stockAdjust: StockAdjustConfig;
|
|
1044
|
+
applyCoupon: ApplyCouponConfig;
|
|
1045
|
+
collectionUpsert: CollectionUpsertConfig;
|
|
1046
|
+
promotionUpsert: PromotionUpsertConfig;
|
|
1047
|
+
orderTransition: OrderTransitionConfig;
|
|
1048
|
+
assetAttach: AssetAttachConfig;
|
|
1049
|
+
assetImport: AssetImportConfig;
|
|
1050
|
+
facetUpsert: FacetUpsertConfig;
|
|
1051
|
+
facetValueUpsert: FacetValueUpsertConfig;
|
|
1052
|
+
restPost: RestPostConfig;
|
|
1053
|
+
graphqlMutation: GraphqlMutationConfig;
|
|
1054
|
+
taxRateUpsert: TaxRateUpsertConfig;
|
|
1055
|
+
paymentMethodUpsert: PaymentMethodUpsertConfig;
|
|
1056
|
+
channelUpsert: ChannelUpsertConfig;
|
|
1057
|
+
shippingMethodUpsert: ShippingMethodUpsertConfig;
|
|
1058
|
+
customerGroupUpsert: CustomerGroupUpsertConfig;
|
|
1059
|
+
stockLocationUpsert: StockLocationUpsertConfig;
|
|
1060
|
+
inventoryAdjust: InventoryAdjustConfig;
|
|
1061
|
+
entityDeletion: EntityDeletionConfig;
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* All loader adapter codes (for runtime validation)
|
|
1065
|
+
*/
|
|
1066
|
+
export declare const LOADER_CODES: readonly ["productUpsert", "variantUpsert", "customerUpsert", "orderUpsert", "orderNote", "stockAdjust", "applyCoupon", "collectionUpsert", "promotionUpsert", "orderTransition", "assetAttach", "assetImport", "facetUpsert", "facetValueUpsert", "restPost", "graphqlMutation", "taxRateUpsert", "paymentMethodUpsert", "channelUpsert", "shippingMethodUpsert", "customerGroupUpsert", "stockLocationUpsert", "inventoryAdjust", "entityDeletion"];
|
|
1067
|
+
/**
|
|
1068
|
+
* Type-safe loader code literal type
|
|
1069
|
+
*/
|
|
1070
|
+
export type LoaderCode = typeof LOADER_CODES[number];
|
|
1071
|
+
//# sourceMappingURL=loader-configs.d.ts.map
|