@vendure/docs 0.0.0-202601271334 → 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 +393 -393
- package/docs/guides/extending-the-admin-ui/getting-started/index.mdx +1 -1
- package/docs/guides/extending-the-dashboard/custom-form-components/index.mdx +2 -2
- package/docs/guides/extending-the-dashboard/customizing-pages/page-blocks.mdx +1 -1
- package/docs/guides/extending-the-dashboard/deployment/index.mdx +2 -2
- package/docs/guides/extending-the-dashboard/getting-started/index.mdx +1 -1
- package/docs/guides/extending-the-dashboard/navigation/index.mdx +2 -2
- package/docs/guides/how-to/cms-integration-plugin/index.mdx +7 -7
- package/docs/guides/how-to/codegen/index.mdx +1 -1
- 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/admin-ui-plugin/index.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 +2 -2
- package/src/dates.generated.ts +393 -393
|
@@ -4,11 +4,11 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/job-queue/polling-job-queue-strategy.ts" sourceLine="242" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
This class allows easier implementation of
|
|
8
|
-
Instead of providing
|
|
7
|
+
This class allows easier implementation of [JobQueueStrategy](/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy) in a polling style.
|
|
8
|
+
Instead of providing [JobQueueStrategy](/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy) `start()` you should provide a `next` method.
|
|
9
9
|
|
|
10
10
|
This class should be extended by any strategy which does not support a push-based system
|
|
11
|
-
to notify on new jobs. It is used by the
|
|
11
|
+
to notify on new jobs. It is used by the [SqlJobQueueStrategy](/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy) and [InMemoryJobQueueStrategy](/reference/typescript-api/job-queue/in-memory-job-queue-strategy#inmemoryjobqueuestrategy).
|
|
12
12
|
|
|
13
13
|
```ts title="Signature"
|
|
14
14
|
class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/sql-job-queue-strategy.ts" sourceLine="22" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A
|
|
8
|
-
This strategy is used by the
|
|
7
|
+
A [JobQueueStrategy](/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy) which uses the configured SQL database to persist jobs in the queue.
|
|
8
|
+
This strategy is used by the [DefaultJobQueuePlugin](/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class SqlJobQueueStrategy extends PollingJobQueueStrategy implements InspectableJobQueueStrategy {
|
|
@@ -20,10 +20,10 @@ class SqlJobQueueStrategy extends PollingJobQueueStrategy implements Inspectable
|
|
|
20
20
|
removeSettledJobs(queueNames: string[] = [], olderThan?: Date) => ;
|
|
21
21
|
}
|
|
22
22
|
```
|
|
23
|
-
* Extends:
|
|
23
|
+
* Extends: [`PollingJobQueueStrategy`](/reference/typescript-api/job-queue/polling-job-queue-strategy#pollingjobqueuestrategy)
|
|
24
24
|
|
|
25
25
|
|
|
26
|
-
* Implements:
|
|
26
|
+
* Implements: [`InspectableJobQueueStrategy`](/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy)
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
|
|
@@ -5,9 +5,9 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="59" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
This is a type of Job object that allows you to subscribe to updates to the Job. It is returned
|
|
8
|
-
by the
|
|
9
|
-
if the
|
|
10
|
-
the
|
|
8
|
+
by the [JobQueue](/reference/typescript-api/job-queue/#jobqueue)'s `add()` method. Note that the subscription capability is only supported
|
|
9
|
+
if the [JobQueueStrategy](/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy) implements the [InspectableJobQueueStrategy](/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy) interface (e.g.
|
|
10
|
+
the [SqlJobQueueStrategy](/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy) does support this).
|
|
11
11
|
|
|
12
12
|
```ts title="Signature"
|
|
13
13
|
class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
|
|
@@ -15,7 +15,7 @@ class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
|
|
|
15
15
|
updates(options?: JobUpdateOptions) => Observable<JobUpdate<T>>;
|
|
16
16
|
}
|
|
17
17
|
```
|
|
18
|
-
* Extends:
|
|
18
|
+
* Extends: [`Job`](/reference/typescript-api/job-queue/job#job)`<T>`
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|
|
@@ -33,7 +33,7 @@ class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
|
|
|
33
33
|
Returns an Observable stream of updates to the Job. Works by polling the current JobQueueStrategy's `findOne()` method
|
|
34
34
|
to obtain updates. If the updates are not subscribed to, then no polling occurs.
|
|
35
35
|
|
|
36
|
-
Polling interval, timeout and other options may be configured with an options arguments
|
|
36
|
+
Polling interval, timeout and other options may be configured with an options arguments [JobUpdateOptions](/reference/typescript-api/job-queue/types#jobupdateoptions).
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
</div>
|
|
@@ -12,7 +12,7 @@ type BackoffStrategy = (queueName: string, attemptsMade: number, job: Job) => nu
|
|
|
12
12
|
```
|
|
13
13
|
<GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="23" packageName="@vendure/core" />
|
|
14
14
|
|
|
15
|
-
Job update status as returned from the
|
|
15
|
+
Job update status as returned from the [SubscribableJob](/reference/typescript-api/job-queue/subscribable-job#subscribablejob)'s `update()` method.
|
|
16
16
|
|
|
17
17
|
```ts title="Signature"
|
|
18
18
|
type JobUpdate<T extends JobData<T>> = Pick<
|
|
@@ -22,7 +22,7 @@ type JobUpdate<T extends JobData<T>> = Pick<
|
|
|
22
22
|
```
|
|
23
23
|
<GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="35" packageName="@vendure/core" />
|
|
24
24
|
|
|
25
|
-
Job update options, that you can specify by calling
|
|
25
|
+
Job update options, that you can specify by calling [SubscribableJob](/reference/typescript-api/job-queue/subscribable-job#subscribablejob) `updates` method.
|
|
26
26
|
|
|
27
27
|
```ts title="Signature"
|
|
28
28
|
type JobUpdateOptions = {
|
|
@@ -54,7 +54,7 @@ type JobUpdateOptions = {
|
|
|
54
54
|
</div>
|
|
55
55
|
<GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="15" packageName="@vendure/core" />
|
|
56
56
|
|
|
57
|
-
Used to configure a new
|
|
57
|
+
Used to configure a new [JobQueue](/reference/typescript-api/job-queue/#jobqueue) instance.
|
|
58
58
|
|
|
59
59
|
```ts title="Signature"
|
|
60
60
|
interface CreateQueueOptions<T extends JobData<T>> {
|
|
@@ -81,14 +81,14 @@ should resolve when the job is complete, or be rejected in case of an error.
|
|
|
81
81
|
</div>
|
|
82
82
|
<GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="37" packageName="@vendure/core" />
|
|
83
83
|
|
|
84
|
-
A JSON-serializable data type which provides a
|
|
84
|
+
A JSON-serializable data type which provides a [Job](/reference/typescript-api/job-queue/job#job)with the data it needs to be processed.
|
|
85
85
|
|
|
86
86
|
```ts title="Signature"
|
|
87
87
|
type JobData<T> = JsonCompatible<T>
|
|
88
88
|
```
|
|
89
89
|
<GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="46" packageName="@vendure/core" />
|
|
90
90
|
|
|
91
|
-
Used to instantiate a new
|
|
91
|
+
Used to instantiate a new [Job](/reference/typescript-api/job-queue/job#job)
|
|
92
92
|
|
|
93
93
|
```ts title="Signature"
|
|
94
94
|
interface JobConfig<T extends JobData<T>> {
|
|
@@ -30,7 +30,7 @@ class DefaultLogger implements VendureLogger {
|
|
|
30
30
|
debug(message: string, context?: string) => void;
|
|
31
31
|
}
|
|
32
32
|
```
|
|
33
|
-
* Implements:
|
|
33
|
+
* Implements: [`VendureLogger`](/reference/typescript-api/logger/vendure-logger#vendurelogger)
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
|
|
@@ -16,14 +16,14 @@ import { Logger } from '@vendure/core';
|
|
|
16
16
|
Logger.info(`Some log message`, 'My Vendure Plugin');
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
The actual implementation - where the logs are written to - is defined by the
|
|
20
|
-
instance configured in the
|
|
19
|
+
The actual implementation - where the logs are written to - is defined by the [VendureLogger](/reference/typescript-api/logger/vendure-logger#vendurelogger)
|
|
20
|
+
instance configured in the [VendureConfig](/reference/typescript-api/configuration/vendure-config#vendureconfig). By default, the [DefaultLogger](/reference/typescript-api/logger/default-logger#defaultlogger) is used, which
|
|
21
21
|
logs to the console.
|
|
22
22
|
|
|
23
23
|
## Implementing a custom logger
|
|
24
24
|
|
|
25
25
|
A custom logger can be passed to the `logger` config option by creating a class which implements the
|
|
26
|
-
|
|
26
|
+
[VendureLogger](/reference/typescript-api/logger/vendure-logger#vendurelogger) interface. For example, here is how you might go about implementing a logger which
|
|
27
27
|
logs to a file:
|
|
28
28
|
|
|
29
29
|
*Example*
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="19" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Configuration for generating a new migration script via
|
|
7
|
+
Configuration for generating a new migration script via [generateMigration](/reference/typescript-api/migration/generate-migration#generatemigration).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface MigrationOptions {
|
|
@@ -4,11 +4,11 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/entity/bigint-money-strategy.ts" sourceLine="18" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
|
-
A
|
|
7
|
+
A [MoneyStrategy](/reference/typescript-api/money/money-strategy#moneystrategy) that stores monetary values as a `bigint` type in the database, which
|
|
8
8
|
allows values up to ~9 quadrillion to be stored (limited by JavaScript's `MAX_SAFE_INTEGER` limit).
|
|
9
9
|
|
|
10
10
|
This strategy also slightly differs in the way rounding is performed, with rounding being done _after_
|
|
11
|
-
multiplying the unit price, rather than before (as is the case with the
|
|
11
|
+
multiplying the unit price, rather than before (as is the case with the [DefaultMoneyStrategy](/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy).
|
|
12
12
|
|
|
13
13
|
```ts title="Signature"
|
|
14
14
|
class BigIntMoneyStrategy implements MoneyStrategy {
|
|
@@ -37,7 +37,7 @@ class BigIntMoneyStrategy implements MoneyStrategy {
|
|
|
37
37
|
round(value: number, quantity: = 1) => number;
|
|
38
38
|
}
|
|
39
39
|
```
|
|
40
|
-
* Implements:
|
|
40
|
+
* Implements: [`MoneyStrategy`](/reference/typescript-api/money/money-strategy#moneystrategy)
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/entity/default-money-strategy.ts" sourceLine="14" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
|
-
A
|
|
7
|
+
A [MoneyStrategy](/reference/typescript-api/money/money-strategy#moneystrategy) that stores monetary values as a `int` type in the database.
|
|
8
8
|
The storage configuration and rounding logic replicates the behaviour of Vendure pre-2.0.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -16,7 +16,7 @@ class DefaultMoneyStrategy implements MoneyStrategy {
|
|
|
16
16
|
round(value: number, quantity: = 1) => number;
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Implements:
|
|
19
|
+
* Implements: [`MoneyStrategy`](/reference/typescript-api/money/money-strategy#moneystrategy)
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/money.decorator.ts" sourceLine="26" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
7
|
Use this decorator for any entity field that is storing a monetary value.
|
|
8
|
-
This allows the column type to be defined by the configured
|
|
8
|
+
This allows the column type to be defined by the configured [MoneyStrategy](/reference/typescript-api/money/money-strategy#moneystrategy).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
function Money(options?: MoneyColumnOptions): void
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/entity/money-strategy.ts" sourceLine="63" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
7
|
The MoneyStrategy defines how monetary values are stored and manipulated. The MoneyStrategy
|
|
8
|
-
is defined in
|
|
8
|
+
is defined in [EntityOptions](/reference/typescript-api/configuration/entity-options#entityoptions):
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
11
11
|
|
|
@@ -19,11 +19,11 @@ const config: VendureConfig = {
|
|
|
19
19
|
|
|
20
20
|
## Range
|
|
21
21
|
|
|
22
|
-
The
|
|
22
|
+
The [DefaultMoneyStrategy](/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy) uses an `int` field in the database, which puts an
|
|
23
23
|
effective limit of ~21.4 million on any stored value. For certain use cases
|
|
24
24
|
(e.g. business sales with very high amounts, or currencies with very large
|
|
25
25
|
denominations), this may cause issues. In this case, you can use the
|
|
26
|
-
|
|
26
|
+
[BigIntMoneyStrategy](/reference/typescript-api/money/big-int-money-strategy#bigintmoneystrategy) which will use the `bigint` type to store monetary values,
|
|
27
27
|
giving an effective upper limit of over 9 quadrillion.
|
|
28
28
|
|
|
29
29
|
## Precision
|
|
@@ -66,7 +66,7 @@ interface MoneyStrategy extends InjectableStrategy {
|
|
|
66
66
|
round(value: number, quantity?: number): number;
|
|
67
67
|
}
|
|
68
68
|
```
|
|
69
|
-
* Extends:
|
|
69
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
70
70
|
|
|
71
71
|
|
|
72
72
|
|
|
@@ -94,7 +94,7 @@ UI as to how many decimal places to display.
|
|
|
94
94
|
<MemberInfo kind="method" type={`(value: number, quantity?: number) => number`} />
|
|
95
95
|
|
|
96
96
|
Defines the logic used to round monetary values. For instance, the default behavior
|
|
97
|
-
in the
|
|
97
|
+
in the [DefaultMoneyStrategy](/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy) is to round the value, then multiply.
|
|
98
98
|
|
|
99
99
|
```ts
|
|
100
100
|
return Math.round(value * quantity);
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/common/round-money.ts" sourceLine="13" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
|
-
Rounds a monetary value according to the configured
|
|
7
|
+
Rounds a monetary value according to the configured [MoneyStrategy](/reference/typescript-api/money/money-strategy#moneystrategy).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
function roundMoney(value: number, quantity: = 1): number
|
|
@@ -48,7 +48,7 @@ being present.
|
|
|
48
48
|
|
|
49
49
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`} since="1.9.0" />
|
|
50
50
|
|
|
51
|
-
Retrieves the active Order based on the configured
|
|
51
|
+
Retrieves the active Order based on the configured [ActiveOrderStrategy](/reference/typescript-api/orders/active-order-strategy#activeorderstrategy).
|
|
52
52
|
### getActiveOrder
|
|
53
53
|
|
|
54
54
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined, createIfNotExists: true) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
|
|
@@ -8,7 +8,7 @@ This strategy is used to determine the active Order for all order-related operat
|
|
|
8
8
|
the Shop API. By default, all the Shop API operations that relate to the active Order (e.g.
|
|
9
9
|
`activeOrder`, `addItemToOrder`, `applyCouponCode` etc.) will implicitly create a new Order
|
|
10
10
|
and set it on the current Session, and then read the session to obtain the active Order.
|
|
11
|
-
This behaviour is defined by the
|
|
11
|
+
This behaviour is defined by the [DefaultActiveOrderStrategy](/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy).
|
|
12
12
|
|
|
13
13
|
The `InputType` generic argument should correspond to the input type defined by the
|
|
14
14
|
`defineInputType()` method.
|
|
@@ -127,7 +127,7 @@ interface ActiveOrderStrategy<InputType extends Record<string, any> | void = voi
|
|
|
127
127
|
determineActiveOrder(ctx: RequestContext, input: InputType): Promise<Order | undefined>;
|
|
128
128
|
}
|
|
129
129
|
```
|
|
130
|
-
* Extends:
|
|
130
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
131
131
|
|
|
132
132
|
|
|
133
133
|
|
|
@@ -27,7 +27,7 @@ interface ChangedPriceHandlingStrategy extends InjectableStrategy {
|
|
|
27
27
|
): PriceCalculationResult | Promise<PriceCalculationResult>;
|
|
28
28
|
}
|
|
29
29
|
```
|
|
30
|
-
* Extends:
|
|
30
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
|
|
@@ -39,7 +39,7 @@ interface ChangedPriceHandlingStrategy extends InjectableStrategy {
|
|
|
39
39
|
|
|
40
40
|
This method is called when adding to or adjusting OrderLines, if the latest price
|
|
41
41
|
(as determined by the ProductVariant price, potentially modified by the configured
|
|
42
|
-
|
|
42
|
+
[OrderItemPriceCalculationStrategy](/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy)) differs from the initial price at the time
|
|
43
43
|
that the OrderLine was created.
|
|
44
44
|
|
|
45
45
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="11" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
An interface to extend standard
|
|
7
|
+
An interface to extend standard [OrderState](/reference/typescript-api/orders/order-process#orderstate).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface CustomOrderStates {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/order/default-active-order-strategy.ts" sourceLine="18" packageName="@vendure/core" since="1.9.0" />
|
|
6
6
|
|
|
7
|
-
The default
|
|
7
|
+
The default [ActiveOrderStrategy](/reference/typescript-api/orders/active-order-strategy#activeorderstrategy), which uses the current [Session](/reference/typescript-api/entities/session#session) to determine
|
|
8
8
|
the active Order, and requires no additional input in the Shop API since it is based on the
|
|
9
9
|
session which is part of the RequestContext.
|
|
10
10
|
|
|
@@ -16,7 +16,7 @@ class DefaultActiveOrderStrategy implements ActiveOrderStrategy {
|
|
|
16
16
|
determineActiveOrder(ctx: RequestContext) => ;
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Implements:
|
|
19
|
+
* Implements: [`ActiveOrderStrategy`](/reference/typescript-api/orders/active-order-strategy#activeorderstrategy)
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/order/default-guest-checkout-strategy.ts" sourceLine="64" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
|
-
The default implementation of the
|
|
7
|
+
The default implementation of the [GuestCheckoutStrategy](/reference/typescript-api/orders/guest-checkout-strategy#guestcheckoutstrategy). This strategy allows
|
|
8
8
|
guest checkouts by default, but can be configured to disallow them.
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
@@ -30,7 +30,7 @@ class DefaultGuestCheckoutStrategy implements GuestCheckoutStrategy {
|
|
|
30
30
|
setCustomerForOrder(ctx: RequestContext, order: Order, input: CreateCustomerInput) => Promise<ErrorResultUnion<SetCustomerForOrderResult, Customer>>;
|
|
31
31
|
}
|
|
32
32
|
```
|
|
33
|
-
* Implements:
|
|
33
|
+
* Implements: [`GuestCheckoutStrategy`](/reference/typescript-api/orders/guest-checkout-strategy#guestcheckoutstrategy)
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
|
|
@@ -56,7 +56,7 @@ class DefaultGuestCheckoutStrategy implements GuestCheckoutStrategy {
|
|
|
56
56
|
</div>
|
|
57
57
|
<GenerationInfo sourceFile="packages/core/src/config/order/default-guest-checkout-strategy.ts" sourceLine="20" packageName="@vendure/core" since="2.0.0" />
|
|
58
58
|
|
|
59
|
-
Options available for the
|
|
59
|
+
Options available for the [DefaultGuestCheckoutStrategy](/reference/typescript-api/orders/default-guest-checkout-strategy#defaultguestcheckoutstrategy).
|
|
60
60
|
|
|
61
61
|
```ts title="Signature"
|
|
62
62
|
interface DefaultGuestCheckoutStrategyOptions {
|
package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx
CHANGED
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/order/default-order-item-price-calculation-strategy.ts" sourceLine="14" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
The default
|
|
7
|
+
The default [OrderItemPriceCalculationStrategy](/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy), which simply passes through the price of
|
|
8
8
|
the ProductVariant without performing any calculations
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -12,7 +12,7 @@ class DefaultOrderItemPriceCalculationStrategy implements OrderItemPriceCalculat
|
|
|
12
12
|
calculateUnitPrice(ctx: RequestContext, productVariant: ProductVariant) => PriceCalculationResult | Promise<PriceCalculationResult>;
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Implements:
|
|
15
|
+
* Implements: [`OrderItemPriceCalculationStrategy`](/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/order/default-order-placed-strategy.ts" sourceLine="14" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
The default
|
|
7
|
+
The default [OrderPlacedStrategy](/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy). The order is set as "placed" when it transitions from
|
|
8
8
|
'ArrangingPayment' to either 'PaymentAuthorized' or 'PaymentSettled'.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -12,7 +12,7 @@ class DefaultOrderPlacedStrategy implements OrderPlacedStrategy {
|
|
|
12
12
|
shouldSetAsPlaced(ctx: RequestContext, fromState: OrderState, toState: OrderState, order: Order) => boolean;
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Implements:
|
|
15
|
+
* Implements: [`OrderPlacedStrategy`](/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -12,7 +12,7 @@ class DefaultStockAllocationStrategy implements StockAllocationStrategy {
|
|
|
12
12
|
shouldAllocateStock(ctx: RequestContext, fromState: OrderState, toState: OrderState, order: Order) => boolean | Promise<boolean>;
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Implements:
|
|
15
|
+
* Implements: [`StockAllocationStrategy`](/reference/typescript-api/orders/stock-allocation-strategy#stockallocationstrategy)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -34,7 +34,7 @@ interface GuestCheckoutStrategy extends InjectableStrategy {
|
|
|
34
34
|
| Promise<ErrorResultUnion<SetCustomerForOrderResult, Customer>>;
|
|
35
35
|
}
|
|
36
36
|
```
|
|
37
|
-
* Extends:
|
|
37
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
|
|
@@ -12,7 +12,7 @@ class MergeOrdersStrategy implements OrderMergeStrategy {
|
|
|
12
12
|
merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order) => MergedOrderLine[];
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Implements:
|
|
15
|
+
* Implements: [`OrderMergeStrategy`](/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -35,7 +35,7 @@ class UseExistingStrategy implements OrderMergeStrategy {
|
|
|
35
35
|
merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order) => MergedOrderLine[];
|
|
36
36
|
}
|
|
37
37
|
```
|
|
38
|
-
* Implements:
|
|
38
|
+
* Implements: [`OrderMergeStrategy`](/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy)
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
|
|
@@ -58,7 +58,7 @@ class UseGuestIfExistingEmptyStrategy implements OrderMergeStrategy {
|
|
|
58
58
|
merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order) => MergedOrderLine[];
|
|
59
59
|
}
|
|
60
60
|
```
|
|
61
|
-
* Implements:
|
|
61
|
+
* Implements: [`OrderMergeStrategy`](/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy)
|
|
62
62
|
|
|
63
63
|
|
|
64
64
|
|
|
@@ -81,7 +81,7 @@ class UseGuestStrategy implements OrderMergeStrategy {
|
|
|
81
81
|
merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order) => MergedOrderLine[];
|
|
82
82
|
}
|
|
83
83
|
```
|
|
84
|
-
* Implements:
|
|
84
|
+
* Implements: [`OrderMergeStrategy`](/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy)
|
|
85
85
|
|
|
86
86
|
|
|
87
87
|
|
|
@@ -35,7 +35,7 @@ interface OrderByCodeAccessStrategy extends InjectableStrategy {
|
|
|
35
35
|
canAccessOrder(ctx: RequestContext, order: Order): boolean | Promise<boolean>;
|
|
36
36
|
}
|
|
37
37
|
```
|
|
38
|
-
* Extends:
|
|
38
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
|
|
@@ -61,7 +61,7 @@ class DefaultOrderByCodeAccessStrategy implements OrderByCodeAccessStrategy {
|
|
|
61
61
|
canAccessOrder(ctx: RequestContext, order: Order) => boolean;
|
|
62
62
|
}
|
|
63
63
|
```
|
|
64
|
-
* Implements:
|
|
64
|
+
* Implements: [`OrderByCodeAccessStrategy`](/reference/typescript-api/orders/order-by-code-access-strategy#orderbycodeaccessstrategy)
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
|
|
@@ -39,7 +39,7 @@ interface OrderCodeStrategy extends InjectableStrategy {
|
|
|
39
39
|
generate(ctx: RequestContext): string | Promise<string>;
|
|
40
40
|
}
|
|
41
41
|
```
|
|
42
|
-
* Extends:
|
|
42
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
|
|
@@ -63,7 +63,7 @@ class DefaultOrderCodeStrategy implements OrderCodeStrategy {
|
|
|
63
63
|
generate(ctx: RequestContext) => string;
|
|
64
64
|
}
|
|
65
65
|
```
|
|
66
|
-
* Implements:
|
|
66
|
+
* Implements: [`OrderCodeStrategy`](/reference/typescript-api/orders/order-code-strategy#ordercodestrategy)
|
|
67
67
|
|
|
68
68
|
|
|
69
69
|
|
|
@@ -31,7 +31,7 @@ OrderInterceptors are executed when the following mutations are called:
|
|
|
31
31
|
- `adjustOrderLine`
|
|
32
32
|
- `removeItemFromOrder`
|
|
33
33
|
|
|
34
|
-
Additionally, if you are working directly with the
|
|
34
|
+
Additionally, if you are working directly with the [OrderService](/reference/typescript-api/services/order-service#orderservice), the following methods will trigger
|
|
35
35
|
any registered OrderInterceptors:
|
|
36
36
|
|
|
37
37
|
- `addItemToOrder`
|
|
@@ -213,7 +213,7 @@ interface OrderInterceptor extends InjectableStrategy {
|
|
|
213
213
|
): Promise<void | string> | void | string;
|
|
214
214
|
}
|
|
215
215
|
```
|
|
216
|
-
* Extends:
|
|
216
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
217
217
|
|
|
218
218
|
|
|
219
219
|
|
|
@@ -225,21 +225,21 @@ interface OrderInterceptor extends InjectableStrategy {
|
|
|
225
225
|
|
|
226
226
|
Called when a new item is about to be added to the order,
|
|
227
227
|
as in the `addItemToOrder` mutation or the `addItemToOrder()` / `addItemsToOrder()` method
|
|
228
|
-
of the
|
|
228
|
+
of the [OrderService](/reference/typescript-api/services/order-service#orderservice).
|
|
229
229
|
### willAdjustOrderLine
|
|
230
230
|
|
|
231
231
|
<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>, input: WillAdjustOrderLineInput) => Promise<void | string> | void | string`} />
|
|
232
232
|
|
|
233
233
|
Called when an existing order line is about to be adjusted,
|
|
234
234
|
as in the `adjustOrderLine` mutation or the `adjustOrderLine()` / `adjustOrderLines()` method
|
|
235
|
-
of the
|
|
235
|
+
of the [OrderService](/reference/typescript-api/services/order-service#orderservice).
|
|
236
236
|
### willRemoveItemFromOrder
|
|
237
237
|
|
|
238
238
|
<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>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => Promise<void | string> | void | string`} />
|
|
239
239
|
|
|
240
240
|
Called when an item is about to be removed from the order,
|
|
241
241
|
as in the `removeItemFromOrder` mutation or the `removeItemFromOrder()` / `removeItemsFromOrder()` method
|
|
242
|
-
of the
|
|
242
|
+
of the [OrderService](/reference/typescript-api/services/order-service#orderservice).
|
|
243
243
|
|
|
244
244
|
|
|
245
245
|
</div>
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/order/order-item-price-calculation-strategy.ts" sourceLine="60" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
The OrderItemPriceCalculationStrategy defines the listPrice of an OrderLine when adding an item to an Order. By default the
|
|
8
|
-
|
|
8
|
+
[DefaultOrderItemPriceCalculationStrategy](/reference/typescript-api/orders/default-order-item-price-calculation-strategy#defaultorderitempricecalculationstrategy) is used.
|
|
9
9
|
|
|
10
10
|
:::info
|
|
11
11
|
|
|
@@ -64,7 +64,7 @@ interface OrderItemPriceCalculationStrategy extends InjectableStrategy {
|
|
|
64
64
|
): PriceCalculationResult | Promise<PriceCalculationResult>;
|
|
65
65
|
}
|
|
66
66
|
```
|
|
67
|
-
* Extends:
|
|
67
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
68
68
|
|
|
69
69
|
|
|
70
70
|
|
|
@@ -78,7 +78,7 @@ Receives the ProductVariant to be added to the Order as well as any OrderLine cu
|
|
|
78
78
|
the price for a single unit.
|
|
79
79
|
|
|
80
80
|
Note: if you have any `relation` type custom fields defined on the OrderLine entity, they will only be
|
|
81
|
-
passed in to this method if they are set to `eager: true`. Otherwise, you can use the
|
|
81
|
+
passed in to this method if they are set to `eager: true`. Otherwise, you can use the [EntityHydrator](/reference/typescript-api/data-access/entity-hydrator#entityhydrator)to join the missing relations.
|
|
82
82
|
|
|
83
83
|
Note: the `quantity` argument was added in v2.0.0
|
|
84
84
|
|
|
@@ -22,7 +22,7 @@ interface OrderMergeStrategy extends InjectableStrategy {
|
|
|
22
22
|
merge(ctx: RequestContext, guestOrder: Order, existingOrder: Order): MergedOrderLine[];
|
|
23
23
|
}
|
|
24
24
|
```
|
|
25
|
-
* Extends:
|
|
25
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
@@ -39,7 +39,7 @@ with the active customer.
|
|
|
39
39
|
</div>
|
|
40
40
|
<GenerationInfo sourceFile="packages/core/src/config/order/order-merge-strategy.ts" sourceLine="15" packageName="@vendure/core" />
|
|
41
41
|
|
|
42
|
-
The result of the
|
|
42
|
+
The result of the [OrderMergeStrategy](/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy) `merge` method.
|
|
43
43
|
|
|
44
44
|
```ts title="Signature"
|
|
45
45
|
interface MergedOrderLine {
|