@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114
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/dist/dates.generated.js +385 -385
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
- package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
- package/docs/reference/dashboard/page-layout/index.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +4 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/index.mdx +2 -2
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
- package/docs/reference/typescript-api/common/id.mdx +1 -1
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/middleware.mdx +1 -1
- package/docs/reference/typescript-api/common/permission.mdx +1 -1
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/entities/address.mdx +2 -2
- package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
- package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +3 -3
- package/docs/reference/typescript-api/entities/country.mdx +4 -4
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet.mdx +4 -4
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +9 -9
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/payment.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
- package/docs/reference/typescript-api/entities/product.mdx +3 -3
- package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
- package/docs/reference/typescript-api/entities/province.mdx +2 -2
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +4 -4
- package/docs/reference/typescript-api/entities/role.mdx +3 -3
- package/docs/reference/typescript-api/entities/seller.mdx +3 -3
- package/docs/reference/typescript-api/entities/session.mdx +3 -3
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
- package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
- package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
- package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
- package/docs/reference/typescript-api/entities/user.mdx +3 -3
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +2 -2
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
- package/docs/reference/typescript-api/events/event-types.mdx +109 -109
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
- package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
- package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
- package/docs/reference/typescript-api/logger/index.mdx +3 -3
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
- package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
- package/docs/reference/typescript-api/money/round-money.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
- package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
- package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
- package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context.mdx +5 -5
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
- package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
- package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
- package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
- package/docs/reference/typescript-api/services/history-service.mdx +1 -1
- package/docs/reference/typescript-api/services/order-service.mdx +24 -24
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
- package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/session-service.mdx +4 -4
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +8 -8
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
- package/package.json +1 -1
- package/src/dates.generated.ts +385 -385
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/product-option.service.ts" sourceLine="37" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [ProductOption](/reference/typescript-api/entities/product-option#productoption) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ProductOptionService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/product.service.ts" sourceLine="54" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Product](/reference/typescript-api/entities/product#product) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ProductService {
|
|
@@ -84,7 +84,7 @@ Returns all Channels to which the Product is assigned.
|
|
|
84
84
|
Assigns a Product to the specified Channel, and optionally uses a `priceFactor` to set the ProductVariantPrices
|
|
85
85
|
on the new Channel.
|
|
86
86
|
|
|
87
|
-
Internally, this method will also call
|
|
87
|
+
Internally, this method will also call [ProductVariantService](/reference/typescript-api/services/product-variant-service#productvariantservice) `assignProductVariantsToChannel()` for
|
|
88
88
|
each of the Product's variants, and will assign the Product's Assets to the Channel too.
|
|
89
89
|
### removeProductsFromChannel
|
|
90
90
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/product-variant.service.ts" sourceLine="70" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ProductVariantService {
|
|
@@ -66,7 +66,7 @@ class ProductVariantService {
|
|
|
66
66
|
|
|
67
67
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: ListQueryOptions<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>>`} />
|
|
68
68
|
|
|
69
|
-
Returns a
|
|
69
|
+
Returns a [PaginatedList](/reference/typescript-api/common/paginated-list#paginatedlist) of all ProductVariants associated with the given Collection.
|
|
70
70
|
### getProductVariantChannels
|
|
71
71
|
|
|
72
72
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]>`} />
|
|
@@ -81,12 +81,12 @@ Returns all Channels to which the ProductVariant is assigned.
|
|
|
81
81
|
|
|
82
82
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>`} />
|
|
83
83
|
|
|
84
|
-
Returns the ProductVariant associated with the given
|
|
84
|
+
Returns the ProductVariant associated with the given [OrderLine](/reference/typescript-api/entities/order-line#orderline).
|
|
85
85
|
### getOptionsForVariant
|
|
86
86
|
|
|
87
87
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, variantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>>>>`} />
|
|
88
88
|
|
|
89
|
-
Returns the
|
|
89
|
+
Returns the [ProductOption](/reference/typescript-api/entities/product-option#productoption)s for the given ProductVariant.
|
|
90
90
|
### getFacetValuesForVariant
|
|
91
91
|
|
|
92
92
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, variantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>>>`} />
|
|
@@ -111,7 +111,7 @@ as well as the local and global `outOfStockThreshold` settings.
|
|
|
111
111
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, variant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>) => Promise<string>`} />
|
|
112
112
|
|
|
113
113
|
Returns the stockLevel to display to the customer, as specified by the configured
|
|
114
|
-
|
|
114
|
+
[StockDisplayStrategy](/reference/typescript-api/products-stock/stock-display-strategy#stockdisplaystrategy).
|
|
115
115
|
### getFulfillableStockLevel
|
|
116
116
|
|
|
117
117
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, variant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>) => Promise<number>`} />
|
|
@@ -132,7 +132,7 @@ for those variants which are tracking inventory.
|
|
|
132
132
|
|
|
133
133
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, price: number, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, currencyCode?: <a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>, customFields?: CustomFieldsObject) => Promise<<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>>`} />
|
|
134
134
|
|
|
135
|
-
Creates a
|
|
135
|
+
Creates a [ProductVariantPrice](/reference/typescript-api/entities/product-variant-price#productvariantprice) for the given ProductVariant/Channel combination.
|
|
136
136
|
If the `currencyCode` is not specified, the default currency of the Channel will be used.
|
|
137
137
|
### deleteProductVariantPrice
|
|
138
138
|
|
|
@@ -163,7 +163,7 @@ Populates the `price` field with the price for the specified channel.
|
|
|
163
163
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignProductVariantsToChannelInput) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>>`} />
|
|
164
164
|
|
|
165
165
|
Assigns the specified ProductVariants to the specified Channel. In doing so, it will create a new
|
|
166
|
-
|
|
166
|
+
[ProductVariantPrice](/reference/typescript-api/entities/product-variant-price#productvariantprice) and also assign the associated Product and any Assets to the Channel too.
|
|
167
167
|
### removeProductVariantsFromChannel
|
|
168
168
|
|
|
169
169
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveProductVariantsFromChannelInput) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>>`} />
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/promotion.service.ts" sourceLine="57" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Promotion](/reference/typescript-api/entities/promotion#promotion) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class PromotionService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/province.service.ts" sourceLine="32" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Province](/reference/typescript-api/entities/province#province) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ProvinceService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/role.service.ts" sourceLine="55" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Role](/reference/typescript-api/entities/role#role) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class RoleService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/seller.service.ts" sourceLine="26" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Seller](/reference/typescript-api/entities/seller#seller) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class SellerService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/session.service.ts" sourceLine="33" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Session](/reference/typescript-api/entities/session#session) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class SessionService implements EntitySubscriberInterface, OnApplicationBootstrap {
|
|
@@ -43,12 +43,12 @@ class SessionService implements EntitySubscriberInterface, OnApplicationBootstra
|
|
|
43
43
|
|
|
44
44
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>, authenticationStrategyName: string) => Promise<<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>>`} />
|
|
45
45
|
|
|
46
|
-
Creates a new
|
|
46
|
+
Creates a new [AuthenticatedSession](/reference/typescript-api/entities/authenticated-session#authenticatedsession). To be used after successful authentication.
|
|
47
47
|
### createAnonymousSession
|
|
48
48
|
|
|
49
49
|
<MemberInfo kind="method" type={`() => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>>`} />
|
|
50
50
|
|
|
51
|
-
Create an
|
|
51
|
+
Create an [AnonymousSession](/reference/typescript-api/entities/anonymous-session#anonymoussession) and caches it using the configured [SessionCacheStrategy](/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy),
|
|
52
52
|
and returns the cached session object.
|
|
53
53
|
### getSessionFromToken
|
|
54
54
|
|
|
@@ -59,7 +59,7 @@ Returns the cached session object matching the given session token.
|
|
|
59
59
|
|
|
60
60
|
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a> | <a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a>) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>`} />
|
|
61
61
|
|
|
62
|
-
Serializes a
|
|
62
|
+
Serializes a [Session](/reference/typescript-api/entities/session#session) instance into a simplified plain object suitable for caching.
|
|
63
63
|
### setActiveOrder
|
|
64
64
|
|
|
65
65
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, serializedSession: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>>`} />
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/shipping-method.service.ts" sourceLine="45" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [ShippingMethod](/reference/typescript-api/entities/shipping-method#shippingmethod) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ShippingMethodService {
|
|
@@ -30,7 +30,7 @@ class StockLevelService {
|
|
|
30
30
|
|
|
31
31
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>>`} />
|
|
32
32
|
|
|
33
|
-
Returns the StockLevel for the given
|
|
33
|
+
Returns the StockLevel for the given [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) and [StockLocation](/reference/typescript-api/entities/stock-location#stocklocation).
|
|
34
34
|
### getStockLevelsForVariant
|
|
35
35
|
|
|
36
36
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]>`} />
|
|
@@ -40,18 +40,18 @@ Returns the StockLevel for the given <DocsLink href="/reference/typescript-api/e
|
|
|
40
40
|
|
|
41
41
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>>`} />
|
|
42
42
|
|
|
43
|
-
Returns the available stock (on hand and allocated) for the given
|
|
44
|
-
by the configured
|
|
43
|
+
Returns the available stock (on hand and allocated) for the given [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant). This is determined
|
|
44
|
+
by the configured [StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy).
|
|
45
45
|
### updateStockOnHandForLocation
|
|
46
46
|
|
|
47
47
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>, change: number) => `} />
|
|
48
48
|
|
|
49
|
-
Updates the `stockOnHand` for the given
|
|
49
|
+
Updates the `stockOnHand` for the given [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) and [StockLocation](/reference/typescript-api/entities/stock-location#stocklocation).
|
|
50
50
|
### updateStockAllocatedForLocation
|
|
51
51
|
|
|
52
52
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>, change: number) => `} />
|
|
53
53
|
|
|
54
|
-
Updates the `stockAllocated` for the given
|
|
54
|
+
Updates the `stockAllocated` for the given [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) and [StockLocation](/reference/typescript-api/entities/stock-location#stocklocation).
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
</div>
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/stock-location.service.ts" sourceLine="41" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [StockLocation](/reference/typescript-api/entities/stock-location#stocklocation) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class StockLocationService {
|
|
@@ -86,25 +86,25 @@ permission on the target channel. StockLocations cannot be removed from the defa
|
|
|
86
86
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => `} />
|
|
87
87
|
|
|
88
88
|
Returns the locations and quantities to use for allocating stock when an OrderLine is created.
|
|
89
|
-
This uses the configured
|
|
89
|
+
This uses the configured [StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy).
|
|
90
90
|
### getReleaseLocations
|
|
91
91
|
|
|
92
92
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => `} />
|
|
93
93
|
|
|
94
94
|
Returns the locations and quantities to use for releasing allocated stock when an OrderLine is cancelled
|
|
95
|
-
or modified. This uses the configured
|
|
95
|
+
or modified. This uses the configured [StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy).
|
|
96
96
|
### getSaleLocations
|
|
97
97
|
|
|
98
98
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => `} />
|
|
99
99
|
|
|
100
100
|
Returns the locations and quantities to use for creating sales when an Order is fulfilled.
|
|
101
|
-
This uses the configured
|
|
101
|
+
This uses the configured [StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy).
|
|
102
102
|
### getCancellationLocations
|
|
103
103
|
|
|
104
104
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => `} />
|
|
105
105
|
|
|
106
106
|
Returns the locations and quantities to use for cancelling sales when an OrderLine is cancelled
|
|
107
|
-
after fulfillment. This uses the configured
|
|
107
|
+
after fulfillment. This uses the configured [StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy).
|
|
108
108
|
|
|
109
109
|
|
|
110
110
|
</div>
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/stock-movement.service.ts" sourceLine="41" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [StockMovement](/reference/typescript-api/entities/stock-movement#stockmovement) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class StockMovementService {
|
|
@@ -42,32 +42,32 @@ class StockMovementService {
|
|
|
42
42
|
|
|
43
43
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: StockMovementListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/stock-movement#stockmovement'>StockMovement</a>>>`} />
|
|
44
44
|
|
|
45
|
-
Returns a
|
|
45
|
+
Returns a [PaginatedList](/reference/typescript-api/common/paginated-list#paginatedlist) of all StockMovements associated with the specified ProductVariant.
|
|
46
46
|
### adjustProductVariantStock
|
|
47
47
|
|
|
48
48
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockOnHandNumberOrInput: number | StockLevelInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a>[]>`} />
|
|
49
49
|
|
|
50
|
-
Adjusts the stock level of the ProductVariant, creating a new
|
|
50
|
+
Adjusts the stock level of the ProductVariant, creating a new [StockAdjustment](/reference/typescript-api/entities/stock-movement#stockadjustment) entity
|
|
51
51
|
in the process.
|
|
52
52
|
### createAllocationsForOrder
|
|
53
53
|
|
|
54
54
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]>`} />
|
|
55
55
|
|
|
56
|
-
Creates a new
|
|
56
|
+
Creates a new [Allocation](/reference/typescript-api/entities/stock-movement#allocation) for each OrderLine in the Order. For ProductVariants
|
|
57
57
|
which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
|
|
58
58
|
increased, indicating that this quantity of stock is allocated and cannot be sold.
|
|
59
59
|
### createAllocationsForOrderLines
|
|
60
60
|
|
|
61
61
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lines: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]>`} />
|
|
62
62
|
|
|
63
|
-
Creates a new
|
|
63
|
+
Creates a new [Allocation](/reference/typescript-api/entities/stock-movement#allocation) for each of the given OrderLines. For ProductVariants
|
|
64
64
|
which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
|
|
65
65
|
increased, indicating that this quantity of stock is allocated and cannot be sold.
|
|
66
66
|
### createSalesForOrder
|
|
67
67
|
|
|
68
68
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lines: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>[]>`} />
|
|
69
69
|
|
|
70
|
-
Creates
|
|
70
|
+
Creates [Sale](/reference/typescript-api/entities/stock-movement#sale)s for each OrderLine in the Order. For ProductVariants
|
|
71
71
|
which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
|
|
72
72
|
reduced and the `stockOnHand` value is also reduced by the OrderLine quantity, indicating
|
|
73
73
|
that the stock is no longer allocated, but is actually sold and no longer available.
|
|
@@ -75,14 +75,14 @@ that the stock is no longer allocated, but is actually sold and no longer availa
|
|
|
75
75
|
|
|
76
76
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lineInputs: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>[]>`} />
|
|
77
77
|
|
|
78
|
-
Creates a
|
|
78
|
+
Creates a [Cancellation](/reference/typescript-api/entities/stock-movement#cancellation) for each of the specified OrderItems. For ProductVariants
|
|
79
79
|
which are configured to track stock levels, the `ProductVariant.stockOnHand` value is
|
|
80
80
|
increased for each Cancellation, allowing that stock to be sold again.
|
|
81
81
|
### createReleasesForOrderLines
|
|
82
82
|
|
|
83
83
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lineInputs: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#release'>Release</a>[]>`} />
|
|
84
84
|
|
|
85
|
-
Creates a
|
|
85
|
+
Creates a [Release](/reference/typescript-api/entities/stock-movement#release) for each of the specified OrderItems. For ProductVariants
|
|
86
86
|
which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
|
|
87
87
|
reduced, indicating that this stock is once again available to buy.
|
|
88
88
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/tag.service.ts" sourceLine="25" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Tag](/reference/typescript-api/entities/tag#tag) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class TagService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/tax-category.service.ts" sourceLine="29" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [TaxCategory](/reference/typescript-api/entities/tax-category#taxcategory) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class TaxCategoryService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/tax-rate.service.ts" sourceLine="37" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [TaxRate](/reference/typescript-api/entities/tax-rate#taxrate) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class TaxRateService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/user.service.ts" sourceLine="38" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [User](/reference/typescript-api/entities/user#user) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class UserService {
|
|
@@ -53,19 +53,19 @@ class UserService {
|
|
|
53
53
|
|
|
54
54
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string, password?: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | PasswordValidationError>`} />
|
|
55
55
|
|
|
56
|
-
Creates a new User with the special `customer` Role and using the
|
|
56
|
+
Creates a new User with the special `customer` Role and using the [NativeAuthenticationStrategy](/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy).
|
|
57
57
|
### addNativeAuthenticationMethod
|
|
58
58
|
|
|
59
59
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>, identifier: string, password?: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | PasswordValidationError>`} />
|
|
60
60
|
|
|
61
|
-
Adds a new
|
|
61
|
+
Adds a new [NativeAuthenticationMethod](/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) to the User. If the [AuthOptions](/reference/typescript-api/auth/auth-options#authoptions) `requireVerification`
|
|
62
62
|
is set to `true` (as is the default), the User will be marked as unverified until the email verification
|
|
63
63
|
flow is completed.
|
|
64
64
|
### createAdminUser
|
|
65
65
|
|
|
66
66
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string, password: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
|
|
67
67
|
|
|
68
|
-
Creates a new verified User using the
|
|
68
|
+
Creates a new verified User using the [NativeAuthenticationStrategy](/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy).
|
|
69
69
|
### softDelete
|
|
70
70
|
|
|
71
71
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => `} />
|
|
@@ -75,7 +75,7 @@ Creates a new verified User using the <DocsLink href="/reference/typescript-api/
|
|
|
75
75
|
|
|
76
76
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
|
|
77
77
|
|
|
78
|
-
Sets the
|
|
78
|
+
Sets the [NativeAuthenticationMethod](/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) `verificationToken` as part of the User email verification
|
|
79
79
|
flow.
|
|
80
80
|
### verifyUserByToken
|
|
81
81
|
|
|
@@ -89,7 +89,7 @@ If valid, the User will be set to `verified: true`.
|
|
|
89
89
|
|
|
90
90
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
|
|
91
91
|
|
|
92
|
-
Sets the
|
|
92
|
+
Sets the [NativeAuthenticationMethod](/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) `passwordResetToken` as part of the User password reset
|
|
93
93
|
flow.
|
|
94
94
|
### resetPasswordByToken
|
|
95
95
|
|
|
@@ -109,7 +109,7 @@ an Administrator is setting a new email address.
|
|
|
109
109
|
|
|
110
110
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
|
|
111
111
|
|
|
112
|
-
Sets the
|
|
112
|
+
Sets the [NativeAuthenticationMethod](/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) `identifierChangeToken` as part of the User email address change
|
|
113
113
|
flow.
|
|
114
114
|
### changeIdentifierByToken
|
|
115
115
|
|
|
@@ -121,7 +121,7 @@ new email address, with the token previously set using the `setIdentifierChangeT
|
|
|
121
121
|
|
|
122
122
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, currentPassword: string, newPassword: string) => Promise<boolean | InvalidCredentialsError | PasswordValidationError>`} />
|
|
123
123
|
|
|
124
|
-
Updates the password for a User with the
|
|
124
|
+
Updates the password for a User with the [NativeAuthenticationMethod](/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod).
|
|
125
125
|
|
|
126
126
|
|
|
127
127
|
</div>
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/services/zone.service.ts" sourceLine="38" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Contains methods relating to
|
|
7
|
+
Contains methods relating to [Zone](/reference/typescript-api/entities/zone#zone) entities.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ZoneService {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/settings-store/clean-orphaned-settings-store-task.ts" sourceLine="39" packageName="@vendure/core" since="3.4.0" />
|
|
6
6
|
|
|
7
|
-
A
|
|
7
|
+
A [ScheduledTask](/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask) that cleans up orphaned settings store entries from the database.
|
|
8
8
|
Orphaned entries are entries that no longer have corresponding field definitions
|
|
9
9
|
in the settings store configuration.
|
|
10
10
|
|
|
@@ -4,13 +4,13 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-eligibility-checker.ts" sourceLine="138" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A function which implements logic to determine whether a given
|
|
7
|
+
A function which implements logic to determine whether a given [Order](/reference/typescript-api/entities/order#order) is eligible for
|
|
8
8
|
a particular shipping method. Once a ShippingMethod has been assigned to an Order, this
|
|
9
9
|
function will be called on every change to the Order (e.g. updating quantities, adding/removing
|
|
10
10
|
items etc).
|
|
11
11
|
|
|
12
12
|
If the code running in this function is expensive, then consider also defining
|
|
13
|
-
a
|
|
13
|
+
a [ShouldRunCheckFn](/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn) to avoid unnecessary calls.
|
|
14
14
|
|
|
15
15
|
```ts title="Signature"
|
|
16
16
|
type CheckShippingEligibilityCheckerFn<T extends ConfigArgs> = (
|
package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx
CHANGED
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/shipping-method/default-shipping-line-assignment-strategy.ts" sourceLine="16" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
|
-
This is the default
|
|
7
|
+
This is the default [ShippingLineAssignmentStrategy](/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy) which simply assigns all OrderLines to the
|
|
8
8
|
ShippingLine, and is suitable for the most common scenario of a single shipping method per Order.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -12,7 +12,7 @@ class DefaultShippingLineAssignmentStrategy implements ShippingLineAssignmentStr
|
|
|
12
12
|
assignShippingLineToOrderLines(ctx: RequestContext, shippingLine: ShippingLine, order: Order) => OrderLine[] | Promise<OrderLine[]>;
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Implements:
|
|
15
|
+
* Implements: [`ShippingLineAssignmentStrategy`](/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-calculator.ts" sourceLine="48" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
The ShippingCalculator is used by a
|
|
7
|
+
The ShippingCalculator is used by a [ShippingMethod](/reference/typescript-api/entities/shipping-method#shippingmethod) to calculate the price of shipping on a given [Order](/reference/typescript-api/entities/order#order).
|
|
8
8
|
|
|
9
9
|
*Example*
|
|
10
10
|
|
|
@@ -37,7 +37,7 @@ class ShippingCalculator<T extends ConfigArgs = ConfigArgs> extends Configurable
|
|
|
37
37
|
constructor(config: ShippingCalculatorConfig<T>)
|
|
38
38
|
}
|
|
39
39
|
```
|
|
40
|
-
* Extends:
|
|
40
|
+
* Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
|
|
@@ -53,7 +53,7 @@ class ShippingCalculator<T extends ConfigArgs = ConfigArgs> extends Configurable
|
|
|
53
53
|
</div>
|
|
54
54
|
<GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-calculator.ts" sourceLine="79" packageName="@vendure/core" />
|
|
55
55
|
|
|
56
|
-
The return value of the
|
|
56
|
+
The return value of the [CalculateShippingFn](/reference/typescript-api/shipping/shipping-calculator#calculateshippingfn).
|
|
57
57
|
|
|
58
58
|
```ts title="Signature"
|
|
59
59
|
interface ShippingCalculationResult {
|
|
@@ -93,10 +93,10 @@ needed in the storefront application when listing eligible shipping methods.
|
|
|
93
93
|
</div>
|
|
94
94
|
<GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-calculator.ts" sourceLine="119" packageName="@vendure/core" />
|
|
95
95
|
|
|
96
|
-
A function which implements the specific shipping calculation logic. It takes an
|
|
96
|
+
A function which implements the specific shipping calculation logic. It takes an [Order](/reference/typescript-api/entities/order#order) and
|
|
97
97
|
an arguments object and should return the shipping price as an integer in cents.
|
|
98
98
|
|
|
99
|
-
Should return a
|
|
99
|
+
Should return a [ShippingCalculationResult](/reference/typescript-api/shipping/shipping-calculator#shippingcalculationresult) object.
|
|
100
100
|
|
|
101
101
|
```ts title="Signature"
|
|
102
102
|
type CalculateShippingFn<T extends ConfigArgs> = (
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-eligibility-checker.ts" sourceLine="23" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Configuration passed into the constructor of a
|
|
7
|
+
Configuration passed into the constructor of a [ShippingEligibilityChecker](/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker) to
|
|
8
8
|
configure its behavior.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -13,7 +13,7 @@ interface ShippingEligibilityCheckerConfig<T extends ConfigArgs> extends Configu
|
|
|
13
13
|
shouldRunCheck?: ShouldRunCheckFn<T>;
|
|
14
14
|
}
|
|
15
15
|
```
|
|
16
|
-
* Extends:
|
|
16
|
+
* Extends: [`ConfigurableOperationDefOptions`](/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions)`<T>`
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-eligibility-checker.ts" sourceLine="50" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
The ShippingEligibilityChecker class is used to check whether an order qualifies for a
|
|
8
|
-
given
|
|
8
|
+
given [ShippingMethod](/reference/typescript-api/entities/shipping-method#shippingmethod).
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
11
11
|
|
|
@@ -29,7 +29,7 @@ class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends Conf
|
|
|
29
29
|
toJSON() => ;
|
|
30
30
|
}
|
|
31
31
|
```
|
|
32
|
-
* Extends:
|
|
32
|
+
* Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -4,11 +4,11 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/shipping-method/shipping-line-assignment-strategy.ts" sourceLine="52" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
|
-
This strategy is used to assign a given
|
|
7
|
+
This strategy is used to assign a given [ShippingLine](/reference/typescript-api/entities/shipping-line#shippingline) to one or more [OrderLine](/reference/typescript-api/entities/order-line#orderline)s of the Order.
|
|
8
8
|
This allows you to set multiple shipping methods for a single order, each assigned a different subset of
|
|
9
9
|
OrderLines.
|
|
10
10
|
|
|
11
|
-
The
|
|
11
|
+
The [DefaultShippingLineAssignmentStrategy](/reference/typescript-api/shipping/default-shipping-line-assignment-strategy#defaultshippinglineassignmentstrategy) simply assigns _all_ OrderLines, so is suitable for the
|
|
12
12
|
most common scenario of a single shipping method per Order.
|
|
13
13
|
|
|
14
14
|
:::info
|
|
@@ -54,7 +54,7 @@ interface ShippingLineAssignmentStrategy extends InjectableStrategy {
|
|
|
54
54
|
): OrderLine[] | Promise<OrderLine[]>;
|
|
55
55
|
}
|
|
56
56
|
```
|
|
57
|
-
* Extends:
|
|
57
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
58
58
|
|
|
59
59
|
|
|
60
60
|
|