@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
|
@@ -14,7 +14,7 @@ class DefaultStockDisplayStrategy implements StockDisplayStrategy {
|
|
|
14
14
|
getStockLevel(ctx: RequestContext, productVariant: ProductVariant, saleableStockLevel: number) => string;
|
|
15
15
|
}
|
|
16
16
|
```
|
|
17
|
-
* Implements:
|
|
17
|
+
* Implements: [`StockDisplayStrategy`](/reference/typescript-api/products-stock/stock-display-strategy#stockdisplaystrategy)
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/catalog/default-stock-location-strategy.ts" sourceLine="105" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
|
-
The DefaultStockLocationStrategy was the default implementation of the
|
|
8
|
-
prior to the introduction of the
|
|
7
|
+
The DefaultStockLocationStrategy was the default implementation of the [StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy)
|
|
8
|
+
prior to the introduction of the [MultiChannelStockLocationStrategy](/reference/typescript-api/products-stock/multi-channel-stock-location-strategy#multichannelstocklocationstrategy).
|
|
9
9
|
It assumes only a single StockLocation and that all stock is allocated from that location. When
|
|
10
10
|
more than one StockLocation or Channel is used, it will not behave as expected.
|
|
11
11
|
|
package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx
CHANGED
|
@@ -4,13 +4,13 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/catalog/multi-channel-stock-location-strategy.ts" sourceLine="32" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
The MultiChannelStockLocationStrategy is an implementation of the
|
|
7
|
+
The MultiChannelStockLocationStrategy is an implementation of the [StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy).
|
|
8
8
|
which is suitable for both single- and multichannel setups. It takes into account the active
|
|
9
9
|
channel when determining stock levels, and also ensures that allocations are made only against
|
|
10
10
|
stock locations which are associated with the active channel.
|
|
11
11
|
|
|
12
12
|
This strategy became the default in Vendure 3.1.0. If you want to use the previous strategy which
|
|
13
|
-
does not take channels into account, update your VendureConfig to use to
|
|
13
|
+
does not take channels into account, update your VendureConfig to use to [DefaultStockLocationStrategy](/reference/typescript-api/products-stock/default-stock-location-strategy#defaultstocklocationstrategy).
|
|
14
14
|
|
|
15
15
|
```ts title="Signature"
|
|
16
16
|
class MultiChannelStockLocationStrategy extends BaseStockLocationStrategy {
|
package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx
CHANGED
|
@@ -18,7 +18,7 @@ interface ProductVariantPriceCalculationStrategy extends InjectableStrategy {
|
|
|
18
18
|
calculate(args: ProductVariantPriceCalculationArgs): Promise<PriceCalculationResult>;
|
|
19
19
|
}
|
|
20
20
|
```
|
|
21
|
-
* Extends:
|
|
21
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
@@ -34,7 +34,7 @@ interface ProductVariantPriceCalculationStrategy extends InjectableStrategy {
|
|
|
34
34
|
</div>
|
|
35
35
|
<GenerationInfo sourceFile="packages/core/src/config/catalog/product-variant-price-calculation-strategy.ts" sourceLine="36" packageName="@vendure/core" />
|
|
36
36
|
|
|
37
|
-
The arguments passed the `calculate` method of the configured
|
|
37
|
+
The arguments passed the `calculate` method of the configured [ProductVariantPriceCalculationStrategy](/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationstrategy).
|
|
38
38
|
|
|
39
39
|
The `productVariant` argument was added in v2.1.0.
|
|
40
40
|
|
|
@@ -25,7 +25,7 @@ interface StockDisplayStrategy extends InjectableStrategy {
|
|
|
25
25
|
): string | Promise<string>;
|
|
26
26
|
}
|
|
27
27
|
```
|
|
28
|
-
* Extends:
|
|
28
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
@@ -4,10 +4,10 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/catalog/stock-location-strategy.ts" sourceLine="55" packageName="@vendure/core" since="2.0.0" />
|
|
6
6
|
|
|
7
|
-
The StockLocationStrategy is responsible for determining which
|
|
8
|
-
should be used to fulfill an
|
|
7
|
+
The StockLocationStrategy is responsible for determining which [StockLocation](/reference/typescript-api/entities/stock-location#stocklocation)s
|
|
8
|
+
should be used to fulfill an [OrderLine](/reference/typescript-api/entities/order-line#orderline) and how much stock should be allocated
|
|
9
9
|
from each location. It is also used to determine the available stock for a given
|
|
10
|
-
|
|
10
|
+
[ProductVariant](/reference/typescript-api/entities/product-variant#productvariant).
|
|
11
11
|
|
|
12
12
|
:::info
|
|
13
13
|
|
|
@@ -49,7 +49,7 @@ interface StockLocationStrategy extends InjectableStrategy {
|
|
|
49
49
|
): LocationWithQuantity[] | Promise<LocationWithQuantity[]>;
|
|
50
50
|
}
|
|
51
51
|
```
|
|
52
|
-
* Extends:
|
|
52
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
|
|
@@ -91,7 +91,7 @@ of an OrderLine which has already been fulfilled.
|
|
|
91
91
|
<GenerationInfo sourceFile="packages/core/src/config/catalog/stock-location-strategy.ts" sourceLine="18" packageName="@vendure/core" since="2.0.0" />
|
|
92
92
|
|
|
93
93
|
The overall available stock for a ProductVariant as determined by the logic of the
|
|
94
|
-
|
|
94
|
+
[StockLocationStrategy](/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy)'s `getAvailableStock` method.
|
|
95
95
|
|
|
96
96
|
```ts title="Signature"
|
|
97
97
|
interface AvailableStock {
|
|
@@ -65,9 +65,9 @@ class FacetValueChecker implements OnModuleInit {
|
|
|
65
65
|
|
|
66
66
|
<MemberInfo kind="method" type={`(orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, facetValueIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<boolean>`} />
|
|
67
67
|
|
|
68
|
-
Checks a given
|
|
69
|
-
`true` if the associated
|
|
70
|
-
have *all* the specified
|
|
68
|
+
Checks a given [OrderLine](/reference/typescript-api/entities/order-line#orderline) against the facetValueIds and returns
|
|
69
|
+
`true` if the associated [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) & [Product](/reference/typescript-api/entities/product#product) together
|
|
70
|
+
have *all* the specified [FacetValue](/reference/typescript-api/entities/facet-value#facetvalue)s.
|
|
71
71
|
|
|
72
72
|
|
|
73
73
|
</div>
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="281" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
An abstract class which is extended by
|
|
8
|
-
and
|
|
7
|
+
An abstract class which is extended by [PromotionItemAction](/reference/typescript-api/promotions/promotion-action#promotionitemaction), [PromotionOrderAction](/reference/typescript-api/promotions/promotion-action#promotionorderaction),
|
|
8
|
+
and [PromotionShippingAction](/reference/typescript-api/promotions/promotion-action#promotionshippingaction).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class PromotionAction<T extends ConfigArgs = ConfigArgs, U extends PromotionCondition[] | undefined = any> extends ConfigurableOperationDef<T> {
|
|
@@ -13,7 +13,7 @@ class PromotionAction<T extends ConfigArgs = ConfigArgs, U extends PromotionCond
|
|
|
13
13
|
constructor(config: PromotionActionConfig<T, U>)
|
|
14
14
|
}
|
|
15
15
|
```
|
|
16
|
-
* Extends:
|
|
16
|
+
* Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
@@ -24,7 +24,7 @@ class PromotionAction<T extends ConfigArgs = ConfigArgs, U extends PromotionCond
|
|
|
24
24
|
<MemberInfo kind="property" type={`number`} default={`0`} />
|
|
25
25
|
|
|
26
26
|
Used to determine the order of application of multiple Promotions
|
|
27
|
-
on the same Order. See the
|
|
27
|
+
on the same Order. See the [Promotion](/reference/typescript-api/entities/promotion#promotion) `priorityScore` field for
|
|
28
28
|
more information.
|
|
29
29
|
### constructor
|
|
30
30
|
|
|
@@ -36,7 +36,7 @@ more information.
|
|
|
36
36
|
</div>
|
|
37
37
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="354" packageName="@vendure/core" />
|
|
38
38
|
|
|
39
|
-
Represents a PromotionAction which applies to individual
|
|
39
|
+
Represents a PromotionAction which applies to individual [OrderLine](/reference/typescript-api/entities/order-line#orderline)s.
|
|
40
40
|
|
|
41
41
|
*Example*
|
|
42
42
|
|
|
@@ -57,7 +57,7 @@ class PromotionItemAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
|
|
|
57
57
|
constructor(config: PromotionItemActionConfig<T, U>)
|
|
58
58
|
}
|
|
59
59
|
```
|
|
60
|
-
* Extends:
|
|
60
|
+
* Extends: [`PromotionAction`](/reference/typescript-api/promotions/promotion-action#promotionaction)`<T, U>`
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
|
|
@@ -73,7 +73,7 @@ class PromotionItemAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
|
|
|
73
73
|
</div>
|
|
74
74
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="464" packageName="@vendure/core" />
|
|
75
75
|
|
|
76
|
-
Represents a PromotionAction which applies to the
|
|
76
|
+
Represents a PromotionAction which applies to the [Order](/reference/typescript-api/entities/order#order) as a whole.
|
|
77
77
|
|
|
78
78
|
*Example*
|
|
79
79
|
|
|
@@ -94,7 +94,7 @@ class PromotionOrderAction<T extends ConfigArgs = ConfigArgs, U extends Promotio
|
|
|
94
94
|
constructor(config: PromotionOrderActionConfig<T, U>)
|
|
95
95
|
}
|
|
96
96
|
```
|
|
97
|
-
* Extends:
|
|
97
|
+
* Extends: [`PromotionAction`](/reference/typescript-api/promotions/promotion-action#promotionaction)`<T, U>`
|
|
98
98
|
|
|
99
99
|
|
|
100
100
|
|
|
@@ -117,7 +117,7 @@ class PromotionShippingAction<T extends ConfigArgs = ConfigArgs, U extends Promo
|
|
|
117
117
|
constructor(config: PromotionShippingActionConfig<T, U>)
|
|
118
118
|
}
|
|
119
119
|
```
|
|
120
|
-
* Extends:
|
|
120
|
+
* Extends: [`PromotionAction`](/reference/typescript-api/promotions/promotion-action#promotionaction)`<T, U>`
|
|
121
121
|
|
|
122
122
|
|
|
123
123
|
|
|
@@ -202,7 +202,7 @@ type PromotionActionSideEffectFn<T extends ConfigArgs> = (
|
|
|
202
202
|
```
|
|
203
203
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="155" packageName="@vendure/core" />
|
|
204
204
|
|
|
205
|
-
Configuration for all types of
|
|
205
|
+
Configuration for all types of [PromotionAction](/reference/typescript-api/promotions/promotion-action#promotionaction).
|
|
206
206
|
|
|
207
207
|
```ts title="Signature"
|
|
208
208
|
interface PromotionActionConfig<T extends ConfigArgs, U extends Array<PromotionCondition<any>> | undefined> extends ConfigurableOperationDefOptions<T> {
|
|
@@ -212,7 +212,7 @@ interface PromotionActionConfig<T extends ConfigArgs, U extends Array<PromotionC
|
|
|
212
212
|
onDeactivate?: PromotionActionSideEffectFn<T>;
|
|
213
213
|
}
|
|
214
214
|
```
|
|
215
|
-
* Extends:
|
|
215
|
+
* Extends: [`ConfigurableOperationDefOptions`](/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions)`<T>`
|
|
216
216
|
|
|
217
217
|
|
|
218
218
|
|
|
@@ -223,7 +223,7 @@ interface PromotionActionConfig<T extends ConfigArgs, U extends Array<PromotionC
|
|
|
223
223
|
<MemberInfo kind="property" type={`number`} default={`0`} />
|
|
224
224
|
|
|
225
225
|
Used to determine the order of application of multiple Promotions
|
|
226
|
-
on the same Order. See the
|
|
226
|
+
on the same Order. See the [Promotion](/reference/typescript-api/entities/promotion#promotion) `priorityScore` field for
|
|
227
227
|
more information.
|
|
228
228
|
### conditions
|
|
229
229
|
|
|
@@ -255,14 +255,14 @@ Used to reverse or clean up any side effects executed as part of the `onActivate
|
|
|
255
255
|
</div>
|
|
256
256
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="209" packageName="@vendure/core" />
|
|
257
257
|
|
|
258
|
-
Configuration for a
|
|
258
|
+
Configuration for a [PromotionItemAction](/reference/typescript-api/promotions/promotion-action#promotionitemaction)
|
|
259
259
|
|
|
260
260
|
```ts title="Signature"
|
|
261
261
|
interface PromotionItemActionConfig<T extends ConfigArgs, U extends PromotionCondition[]> extends PromotionActionConfig<T, U> {
|
|
262
262
|
execute: ExecutePromotionItemActionFn<T, U>;
|
|
263
263
|
}
|
|
264
264
|
```
|
|
265
|
-
* Extends:
|
|
265
|
+
* Extends: [`PromotionActionConfig`](/reference/typescript-api/promotions/promotion-action#promotionactionconfig)`<T, U>`
|
|
266
266
|
|
|
267
267
|
|
|
268
268
|
|
|
@@ -280,14 +280,14 @@ the OrderLine, i.e. the number should be negative.
|
|
|
280
280
|
</div>
|
|
281
281
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="227" packageName="@vendure/core" />
|
|
282
282
|
|
|
283
|
-
Configuration for a
|
|
283
|
+
Configuration for a [PromotionLineAction](/reference/typescript-api/promotions/promotion-action#promotionlineaction)
|
|
284
284
|
|
|
285
285
|
```ts title="Signature"
|
|
286
286
|
interface PromotionLineActionConfig<T extends ConfigArgs, U extends PromotionCondition[]> extends PromotionActionConfig<T, U> {
|
|
287
287
|
execute: ExecutePromotionLineActionFn<T, U>;
|
|
288
288
|
}
|
|
289
289
|
```
|
|
290
|
-
* Extends:
|
|
290
|
+
* Extends: [`PromotionActionConfig`](/reference/typescript-api/promotions/promotion-action#promotionactionconfig)`<T, U>`
|
|
291
291
|
|
|
292
292
|
|
|
293
293
|
|
|
@@ -312,7 +312,7 @@ interface PromotionOrderActionConfig<T extends ConfigArgs, U extends PromotionCo
|
|
|
312
312
|
execute: ExecutePromotionOrderActionFn<T, U>;
|
|
313
313
|
}
|
|
314
314
|
```
|
|
315
|
-
* Extends:
|
|
315
|
+
* Extends: [`PromotionActionConfig`](/reference/typescript-api/promotions/promotion-action#promotionactionconfig)`<T, U>`
|
|
316
316
|
|
|
317
317
|
|
|
318
318
|
|
|
@@ -337,7 +337,7 @@ interface PromotionShippingActionConfig<T extends ConfigArgs, U extends Promotio
|
|
|
337
337
|
execute: ExecutePromotionShippingActionFn<T, U>;
|
|
338
338
|
}
|
|
339
339
|
```
|
|
340
|
-
* Extends:
|
|
340
|
+
* Extends: [`PromotionActionConfig`](/reference/typescript-api/promotions/promotion-action#promotionactionconfig)`<T, U>`
|
|
341
341
|
|
|
342
342
|
|
|
343
343
|
|
|
@@ -355,7 +355,7 @@ the Shipping, i.e. the number should be negative.
|
|
|
355
355
|
</div>
|
|
356
356
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-action.ts" sourceLine="409" packageName="@vendure/core" />
|
|
357
357
|
|
|
358
|
-
Represents a PromotionAction which applies to individual
|
|
358
|
+
Represents a PromotionAction which applies to individual [OrderLine](/reference/typescript-api/entities/order-line#orderline)s.
|
|
359
359
|
The difference from PromotionItemAction is that it applies regardless of the Quantity of the OrderLine.
|
|
360
360
|
|
|
361
361
|
*Example*
|
|
@@ -377,7 +377,7 @@ class PromotionLineAction<T extends ConfigArgs = ConfigArgs, U extends Array<Pro
|
|
|
377
377
|
constructor(config: PromotionLineActionConfig<T, U>)
|
|
378
378
|
}
|
|
379
379
|
```
|
|
380
|
-
* Extends:
|
|
380
|
+
* Extends: [`PromotionAction`](/reference/typescript-api/promotions/promotion-action#promotionaction)`<T, U>`
|
|
381
381
|
|
|
382
382
|
|
|
383
383
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-condition.ts" sourceLine="66" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
PromotionConditions are used to create
|
|
7
|
+
PromotionConditions are used to create [Promotion](/reference/typescript-api/entities/promotion#promotion)s. The purpose of a PromotionCondition
|
|
8
8
|
is to check the order against a particular predicate function (the `check` function) and to return
|
|
9
9
|
`true` if the Order satisfies the condition, or `false` if it does not.
|
|
10
10
|
|
|
@@ -16,7 +16,7 @@ class PromotionCondition<T extends ConfigArgs = ConfigArgs, C extends string = s
|
|
|
16
16
|
check(ctx: RequestContext, order: Order, args: ConfigArg[], promotion: Promotion) => Promise<R>;
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Extends:
|
|
19
|
+
* Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -27,7 +27,7 @@ class PromotionCondition<T extends ConfigArgs = ConfigArgs, C extends string = s
|
|
|
27
27
|
<MemberInfo kind="property" type={`number`} default={`0`} />
|
|
28
28
|
|
|
29
29
|
Used to determine the order of application of multiple Promotions
|
|
30
|
-
on the same Order. See the
|
|
30
|
+
on the same Order. See the [Promotion](/reference/typescript-api/entities/promotion#promotion) `priorityScore` field for
|
|
31
31
|
more information.
|
|
32
32
|
### code
|
|
33
33
|
|
|
@@ -44,7 +44,7 @@ more information.
|
|
|
44
44
|
<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>, args: ConfigArg[], promotion: <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>) => Promise<R>`} />
|
|
45
45
|
|
|
46
46
|
This is the function which contains the conditional logic to decide whether
|
|
47
|
-
a Promotion should apply to an Order. See
|
|
47
|
+
a Promotion should apply to an Order. See [CheckPromotionConditionFn](/reference/typescript-api/promotions/promotion-condition#checkpromotionconditionfn).
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
</div>
|
|
@@ -59,7 +59,7 @@ interface PromotionConditionConfig<T extends ConfigArgs, C extends string, R ext
|
|
|
59
59
|
priorityValue?: number;
|
|
60
60
|
}
|
|
61
61
|
```
|
|
62
|
-
* Extends:
|
|
62
|
+
* Extends: [`ConfigurableOperationDefOptions`](/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions)`<T>`
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
|
|
@@ -85,7 +85,7 @@ interface PromotionConditionConfig<T extends ConfigArgs, C extends string, R ext
|
|
|
85
85
|
</div>
|
|
86
86
|
<GenerationInfo sourceFile="packages/core/src/config/promotion/promotion-condition.ts" sourceLine="31" packageName="@vendure/core" />
|
|
87
87
|
|
|
88
|
-
A function which checks whether or not a given
|
|
88
|
+
A function which checks whether or not a given [Order](/reference/typescript-api/entities/order#order) satisfies the [PromotionCondition](/reference/typescript-api/promotions/promotion-condition#promotioncondition).
|
|
89
89
|
|
|
90
90
|
The function should return either a `boolean` or and plain object type:
|
|
91
91
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/api/decorators/allow.decorator.ts" sourceLine="51" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
Attaches metadata to the resolver defining which permissions are required to execute the
|
|
8
|
-
operation, using one or more
|
|
8
|
+
operation, using one or more [Permission](/reference/typescript-api/common/permission#permission) values.
|
|
9
9
|
|
|
10
10
|
When multiple permissions are specified, the user needs only **one** of them (OR logic).
|
|
11
11
|
This is useful for operations that can be performed by users with different permission sets.
|
|
@@ -8,7 +8,7 @@ Resolver param decorator which returns which Api the request came though.
|
|
|
8
8
|
This is useful because sometimes the same resolver will have different behaviour
|
|
9
9
|
depending whether it is being called from the shop API or the admin API.
|
|
10
10
|
|
|
11
|
-
Returns a string of type
|
|
11
|
+
Returns a string of type [ApiType](/reference/typescript-api/request/api-type#apitype).
|
|
12
12
|
|
|
13
13
|
*Example*
|
|
14
14
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/api/decorators/request-context.decorator.ts" sourceLine="23" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Resolver param decorator which extracts the
|
|
7
|
+
Resolver param decorator which extracts the [RequestContext](/reference/typescript-api/request/request-context#requestcontext) from the incoming
|
|
8
8
|
request object.
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
@@ -57,7 +57,7 @@ then the value of `relations` will be
|
|
|
57
57
|
['customer', 'lines'']
|
|
58
58
|
```
|
|
59
59
|
The `'customer'` comes from the fact that the query is nesting the "customer" object, and the `'lines'` is taken
|
|
60
|
-
from the `Order` entity's `totalQuantity` property, which uses
|
|
60
|
+
from the `Order` entity's `totalQuantity` property, which uses [Calculated](/reference/typescript-api/data-access/calculated#calculated) decorator and defines those relations as dependencies
|
|
61
61
|
for deriving the calculated value.
|
|
62
62
|
|
|
63
63
|
## Depth
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/request-context/request-context.service.ts" sourceLine="25" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Creates new
|
|
7
|
+
Creates new [RequestContext](/reference/typescript-api/request/request-context#requestcontext) instances.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class RequestContextService {
|
|
@@ -7,11 +7,11 @@ generated: true
|
|
|
7
7
|
The RequestContext holds information relevant to the current request, which may be
|
|
8
8
|
required at various points of the stack.
|
|
9
9
|
|
|
10
|
-
It is a good practice to inject the RequestContext (using the
|
|
10
|
+
It is a good practice to inject the RequestContext (using the [Ctx](/reference/typescript-api/request/ctx-decorator#ctx) decorator) into
|
|
11
11
|
_all_ resolvers & REST handler, and then pass it through to the service layer.
|
|
12
12
|
|
|
13
13
|
This allows the service layer to access information about the current user, the active language,
|
|
14
|
-
the active Channel, and so on. In addition, the
|
|
14
|
+
the active Channel, and so on. In addition, the [TransactionalConnection](/reference/typescript-api/data-access/transactional-connection#transactionalconnection) relies on the
|
|
15
15
|
presence of the RequestContext object in order to correctly handle per-request database transactions.
|
|
16
16
|
|
|
17
17
|
The RequestContext also provides mechanisms for managing the database replication mode via the
|
|
@@ -71,7 +71,7 @@ class RequestContext {
|
|
|
71
71
|
Creates an "empty" RequestContext object. This is only intended to be used
|
|
72
72
|
when a service method must be called outside the normal request-response
|
|
73
73
|
cycle, e.g. when programmatically populating data. Usually a better alternative
|
|
74
|
-
is to use the
|
|
74
|
+
is to use the [RequestContextService](/reference/typescript-api/request/request-context-service#requestcontextservice) `create()` method, which allows more control
|
|
75
75
|
over the resulting RequestContext object.
|
|
76
76
|
### deserialize
|
|
77
77
|
|
|
@@ -117,7 +117,7 @@ ctx.userHasAllPermissions([Permission.ReadProduct, Permission.UpdateProduct]);
|
|
|
117
117
|
|
|
118
118
|
Serializes the RequestContext object into a JSON-compatible simple object.
|
|
119
119
|
This is useful when you need to send a RequestContext object to another
|
|
120
|
-
process, e.g. to pass it to the Job Queue via the
|
|
120
|
+
process, e.g. to pass it to the Job Queue via the [JobQueueService](/reference/typescript-api/job-queue/job-queue-service#jobqueueservice).
|
|
121
121
|
### copy
|
|
122
122
|
|
|
123
123
|
<MemberInfo kind="method" type={`() => <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`} />
|
|
@@ -139,7 +139,7 @@ Signals which API this request was received by, e.g. `admin` or `shop`.
|
|
|
139
139
|
|
|
140
140
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`} />
|
|
141
141
|
|
|
142
|
-
The active
|
|
142
|
+
The active [Channel](/reference/typescript-api/entities/channel#channel) of this request.
|
|
143
143
|
### channelId
|
|
144
144
|
|
|
145
145
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
Runs the decorated method in a TypeORM transaction. It works by creating a transactional
|
|
8
8
|
QueryRunner which gets attached to the RequestContext object. When the RequestContext
|
|
9
|
-
is the passed to the
|
|
9
|
+
is the passed to the [TransactionalConnection](/reference/typescript-api/data-access/transactional-connection#transactionalconnection) `getRepository()` method, this
|
|
10
10
|
QueryRunner is used to execute the queries within this transaction.
|
|
11
11
|
|
|
12
12
|
Essentially, the entire resolver function is wrapped in a try-catch block which commits the
|
|
@@ -32,7 +32,7 @@ async myMutation(@Ctx() ctx: RequestContext) {
|
|
|
32
32
|
<GenerationInfo sourceFile="packages/core/src/api/decorators/transaction.decorator.ts" sourceLine="32" packageName="@vendure/core" />
|
|
33
33
|
|
|
34
34
|
The Transaction decorator can handle transactions automatically (which is the default) or be set to
|
|
35
|
-
"manual" mode, where the
|
|
35
|
+
"manual" mode, where the [TransactionalConnection](/reference/typescript-api/data-access/transactional-connection#transactionalconnection) `.startTransaction()` and `.commitOpenTransaction()`
|
|
36
36
|
methods must them be used.
|
|
37
37
|
|
|
38
38
|
*Example*
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/scheduler/tasks/clean-sessions-task.ts" sourceLine="37" packageName="@vendure/core" since="3.3.0" />
|
|
6
6
|
|
|
7
|
-
A
|
|
7
|
+
A [ScheduledTask](/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask) that cleans expired & inactive sessions from the database.
|
|
8
8
|
|
|
9
9
|
*Example*
|
|
10
10
|
|
|
@@ -51,7 +51,7 @@ class DefaultSchedulerPlugin {
|
|
|
51
51
|
</div>
|
|
52
52
|
<GenerationInfo sourceFile="packages/core/src/plugin/default-scheduler-plugin/types.ts" sourceLine="9" packageName="@vendure/core" since="3.3.0" />
|
|
53
53
|
|
|
54
|
-
The options for the
|
|
54
|
+
The options for the [DefaultSchedulerPlugin](/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin).
|
|
55
55
|
|
|
56
56
|
```ts title="Signature"
|
|
57
57
|
interface DefaultSchedulerPluginOptions {
|
|
@@ -4,9 +4,9 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/plugin/default-scheduler-plugin/default-scheduler-strategy.ts" sourceLine="28" packageName="@vendure/core" since="3.3.0" />
|
|
6
6
|
|
|
7
|
-
The default
|
|
7
|
+
The default [SchedulerStrategy](/reference/typescript-api/scheduled-tasks/scheduler-strategy#schedulerstrategy) implementation that uses the database to
|
|
8
8
|
execute scheduled tasks. This strategy is configured when you use the
|
|
9
|
-
|
|
9
|
+
[DefaultSchedulerPlugin](/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin).
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
class DefaultSchedulerStrategy implements SchedulerStrategy {
|
|
@@ -20,7 +20,7 @@ class DefaultSchedulerStrategy implements SchedulerStrategy {
|
|
|
20
20
|
triggerTask(task: ScheduledTask) => Promise<void>;
|
|
21
21
|
}
|
|
22
22
|
```
|
|
23
|
-
* Implements:
|
|
23
|
+
* Implements: [`SchedulerStrategy`](/reference/typescript-api/scheduled-tasks/scheduler-strategy#schedulerstrategy)
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -21,8 +21,8 @@ interface SchedulerOptions {
|
|
|
21
21
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduler-strategy#schedulerstrategy'>SchedulerStrategy</a>`} />
|
|
22
22
|
|
|
23
23
|
The strategy used to execute scheduled tasks. If you are using the
|
|
24
|
-
|
|
25
|
-
|
|
24
|
+
[DefaultSchedulerPlugin](/reference/typescript-api/scheduled-tasks/default-scheduler-plugin#defaultschedulerplugin) (which is recommended) then this will be set to the
|
|
25
|
+
[DefaultSchedulerStrategy](/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy).
|
|
26
26
|
### tasks
|
|
27
27
|
|
|
28
28
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a>[]`} />
|
|
@@ -12,7 +12,7 @@ are multiple instances of the worker running.
|
|
|
12
12
|
To do this, the strategy must use some form of shared storage and a method of
|
|
13
13
|
locking so that only a single worker is allowed to execute the task.
|
|
14
14
|
|
|
15
|
-
By default, the
|
|
15
|
+
By default, the [DefaultSchedulerStrategy](/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy) will use the database to enable
|
|
16
16
|
this functionality.
|
|
17
17
|
|
|
18
18
|
```ts title="Signature"
|
|
@@ -25,7 +25,7 @@ interface SchedulerStrategy extends InjectableStrategy {
|
|
|
25
25
|
updateTask(input: UpdateScheduledTaskInput): Promise<TaskReport>;
|
|
26
26
|
}
|
|
27
27
|
```
|
|
28
|
-
* Extends:
|
|
28
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
@@ -46,7 +46,7 @@ Execute a scheduled task. This method must also take care of
|
|
|
46
46
|
ensuring that the task is executed exactly once at the scheduled time,
|
|
47
47
|
even if there are multiple instances of the worker running.
|
|
48
48
|
|
|
49
|
-
For instance, in the
|
|
49
|
+
For instance, in the [DefaultSchedulerStrategy](/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy) we make use of a
|
|
50
50
|
dedicated database table and a locking mechansim. If you implement a custom
|
|
51
51
|
SchedulerStrategy, you must use some other form of shared locking mechanism
|
|
52
52
|
that could make use of something like Redis etc. to ensure that the task
|
|
@@ -75,7 +75,7 @@ instance which we typically do not want. Instead, it should be used
|
|
|
75
75
|
to signal to the strategy that this specific task needs to be invoked
|
|
76
76
|
at the soonest opportunity.
|
|
77
77
|
|
|
78
|
-
For instance, in the
|
|
78
|
+
For instance, in the [DefaultSchedulerStrategy](/reference/typescript-api/scheduled-tasks/default-scheduler-strategy#defaultschedulerstrategy) this is done by setting
|
|
79
79
|
a flag in the database table which is checked periodically and causes those tasks
|
|
80
80
|
to get immediately invoked.
|
|
81
81
|
### updateTask
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/entity-duplicator/entity-duplicator.service.ts" sourceLine="23" packageName="@vendure/core" since="2.2.0" />
|
|
6
6
|
|
|
7
7
|
This service is used to duplicate entities using one of the configured
|
|
8
|
-
|
|
8
|
+
[EntityDuplicator](/reference/typescript-api/configuration/entity-duplicator#entityduplicator) functions.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class EntityDuplicatorService {
|
|
@@ -26,12 +26,12 @@ class EntityDuplicatorService {
|
|
|
26
26
|
|
|
27
27
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => EntityDuplicatorDefinition[]`} />
|
|
28
28
|
|
|
29
|
-
Returns all configured
|
|
29
|
+
Returns all configured [EntityDuplicator](/reference/typescript-api/configuration/entity-duplicator#entityduplicator) definitions.
|
|
30
30
|
### duplicateEntity
|
|
31
31
|
|
|
32
32
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: DuplicateEntityInput) => Promise<DuplicateEntityResult>`} />
|
|
33
33
|
|
|
34
|
-
Duplicates an entity using the specified
|
|
34
|
+
Duplicates an entity using the specified [EntityDuplicator](/reference/typescript-api/configuration/entity-duplicator#entityduplicator). The duplication is performed
|
|
35
35
|
within a transaction, so if an error occurs, the transaction will be rolled back.
|
|
36
36
|
|
|
37
37
|
|
|
@@ -57,7 +57,7 @@ matches, or `undefined` if no match is found.
|
|
|
57
57
|
|
|
58
58
|
<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>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, customFields?: { [key: string]: any }) => `} />
|
|
59
59
|
|
|
60
|
-
Returns the OrderLine containing the given
|
|
60
|
+
Returns the OrderLine containing the given [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant), taking into account any custom field values. If no existing
|
|
61
61
|
OrderLine is found, a new OrderLine will be created.
|
|
62
62
|
### updateOrderLineQuantity
|
|
63
63
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/product-price-applicator/product-price-applicator.ts" sourceLine="41" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
This helper is used to apply the correct price to a ProductVariant based on the current context
|
|
8
|
-
including active Channel, any current Order, etc. If you use the
|
|
8
|
+
including active Channel, any current Order, etc. If you use the [TransactionalConnection](/reference/typescript-api/data-access/transactional-connection#transactionalconnection) to
|
|
9
9
|
directly query ProductVariants, you will find that the `price` and `priceWithTax` properties will
|
|
10
10
|
always be `0` until you use the `applyChannelPriceAndTax()` method:
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/slug-validator/slug-validator.ts" sourceLine="44" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
Used to validate slugs to ensure they are URL-safe and unique. Designed to be used with translatable
|
|
8
|
-
entities such as
|
|
8
|
+
entities such as [Product](/reference/typescript-api/entities/product#product) and [Collection](/reference/typescript-api/entities/collection#collection).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class SlugValidator {
|