@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dates.generated.js +385 -385
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
- package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
- package/docs/reference/dashboard/page-layout/index.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +4 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/index.mdx +2 -2
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
- package/docs/reference/typescript-api/common/id.mdx +1 -1
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/middleware.mdx +1 -1
- package/docs/reference/typescript-api/common/permission.mdx +1 -1
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/entities/address.mdx +2 -2
- package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
- package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +3 -3
- package/docs/reference/typescript-api/entities/country.mdx +4 -4
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet.mdx +4 -4
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +9 -9
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/payment.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
- package/docs/reference/typescript-api/entities/product.mdx +3 -3
- package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
- package/docs/reference/typescript-api/entities/province.mdx +2 -2
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +4 -4
- package/docs/reference/typescript-api/entities/role.mdx +3 -3
- package/docs/reference/typescript-api/entities/seller.mdx +3 -3
- package/docs/reference/typescript-api/entities/session.mdx +3 -3
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
- package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
- package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
- package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
- package/docs/reference/typescript-api/entities/user.mdx +3 -3
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +2 -2
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
- package/docs/reference/typescript-api/events/event-types.mdx +109 -109
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
- package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
- package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
- package/docs/reference/typescript-api/logger/index.mdx +3 -3
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
- package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
- package/docs/reference/typescript-api/money/round-money.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
- package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
- package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
- package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context.mdx +5 -5
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
- package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
- package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
- package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
- package/docs/reference/typescript-api/services/history-service.mdx +1 -1
- package/docs/reference/typescript-api/services/order-service.mdx +24 -24
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
- package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/session-service.mdx +4 -4
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +8 -8
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
- package/package.json +1 -1
- package/src/dates.generated.ts +385 -385
|
@@ -60,7 +60,7 @@ item to an Order.
|
|
|
60
60
|
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a><any>>`} default={`[]`} />
|
|
61
61
|
|
|
62
62
|
Allows the definition of custom states and transition logic for the order process state machine.
|
|
63
|
-
Takes an array of objects implementing the
|
|
63
|
+
Takes an array of objects implementing the [OrderProcess](/reference/typescript-api/orders/order-process#orderprocess) interface.
|
|
64
64
|
### stockAllocationStrategy
|
|
65
65
|
|
|
66
66
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/stock-allocation-strategy#stockallocationstrategy'>StockAllocationStrategy</a>`} default={`<a href='/reference/typescript-api/orders/default-stock-allocation-strategy#defaultstockallocationstrategy'>DefaultStockAllocationStrategy</a>`} />
|
|
@@ -134,7 +134,7 @@ Defines how we deal with guest checkouts.
|
|
|
134
134
|
|
|
135
135
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-interceptor#orderinterceptor'>OrderInterceptor</a>[]`} default={`[]`} since="3.1.0" />
|
|
136
136
|
|
|
137
|
-
An array of
|
|
137
|
+
An array of [OrderInterceptor](/reference/typescript-api/orders/order-interceptor#orderinterceptor)s which can be used to modify the behavior of the Order process.
|
|
138
138
|
|
|
139
139
|
|
|
140
140
|
</div>
|
|
@@ -28,7 +28,7 @@ interface OrderPlacedStrategy extends InjectableStrategy {
|
|
|
28
28
|
): boolean | Promise<boolean>;
|
|
29
29
|
}
|
|
30
30
|
```
|
|
31
|
-
* Extends:
|
|
31
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -9,7 +9,7 @@ in, and how it may transition from one state to another. Using the `onTransition
|
|
|
9
9
|
OrderProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
|
|
10
10
|
hook allows logic to be executed after a state change.
|
|
11
11
|
|
|
12
|
-
For detailed description of the interface members, see the
|
|
12
|
+
For detailed description of the interface members, see the [StateMachineConfig](/reference/typescript-api/state-machine/state-machine-config#statemachineconfig) docs.
|
|
13
13
|
|
|
14
14
|
:::info
|
|
15
15
|
|
|
@@ -26,7 +26,7 @@ interface OrderProcess<State extends keyof CustomOrderStates | string> extends I
|
|
|
26
26
|
onTransitionError?: OnTransitionErrorFn<State | OrderState>;
|
|
27
27
|
}
|
|
28
28
|
```
|
|
29
|
-
* Extends:
|
|
29
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
|
|
@@ -57,8 +57,8 @@ interface OrderProcess<State extends keyof CustomOrderStates | string> extends I
|
|
|
57
57
|
</div>
|
|
58
58
|
<GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="50" packageName="@vendure/core" since="2.0.0" />
|
|
59
59
|
|
|
60
|
-
Options which can be passed to the
|
|
61
|
-
to configure an instance of the default
|
|
60
|
+
Options which can be passed to the [configureDefaultOrderProcess](/reference/typescript-api/orders/order-process#configuredefaultorderprocess) function
|
|
61
|
+
to configure an instance of the default [OrderProcess](/reference/typescript-api/orders/order-process#orderprocess). By default, all
|
|
62
62
|
options are set to `true`.
|
|
63
63
|
|
|
64
64
|
```ts title="Signature"
|
|
@@ -144,7 +144,7 @@ the Order are part of a Fulfillment which itself is in the `Shipped` state.
|
|
|
144
144
|
</div>
|
|
145
145
|
<GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="163" packageName="@vendure/core" since="2.0.0" />
|
|
146
146
|
|
|
147
|
-
Used to configure a customized instance of the default
|
|
147
|
+
Used to configure a customized instance of the default [OrderProcess](/reference/typescript-api/orders/order-process#orderprocess) that ships with Vendure.
|
|
148
148
|
Using this function allows you to turn off certain checks and constraints that are enabled by default.
|
|
149
149
|
|
|
150
150
|
```ts
|
|
@@ -163,8 +163,8 @@ export const config: VendureConfig = {
|
|
|
163
163
|
},
|
|
164
164
|
};
|
|
165
165
|
```
|
|
166
|
-
The
|
|
167
|
-
more customization, you can create your own implementation of the
|
|
166
|
+
The [DefaultOrderProcessOptions](/reference/typescript-api/orders/order-process#defaultorderprocessoptions) type defines all available options. If you require even
|
|
167
|
+
more customization, you can create your own implementation of the [OrderProcess](/reference/typescript-api/orders/order-process#orderprocess) interface.
|
|
168
168
|
|
|
169
169
|
```ts title="Signature"
|
|
170
170
|
function configureDefaultOrderProcess(options: DefaultOrderProcessOptions): void
|
|
@@ -177,13 +177,13 @@ Parameters
|
|
|
177
177
|
|
|
178
178
|
<GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="475" packageName="@vendure/core" since="2.0.0" />
|
|
179
179
|
|
|
180
|
-
This is the built-in
|
|
181
|
-
can be created using the
|
|
180
|
+
This is the built-in [OrderProcess](/reference/typescript-api/orders/order-process#orderprocess) that ships with Vendure. A customized version of this process
|
|
181
|
+
can be created using the [configureDefaultOrderProcess](/reference/typescript-api/orders/order-process#configuredefaultorderprocess) function, which allows you to pass in an object
|
|
182
182
|
to enable/disable certain checks.
|
|
183
183
|
|
|
184
184
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="21" packageName="@vendure/core" since="2.0.0" />
|
|
185
185
|
|
|
186
|
-
An interface to extend the
|
|
186
|
+
An interface to extend the [OrderState](/reference/typescript-api/orders/order-process#orderstate) type.
|
|
187
187
|
|
|
188
188
|
```ts title="Signature"
|
|
189
189
|
interface OrderStates {
|
|
@@ -193,8 +193,8 @@ interface OrderStates {
|
|
|
193
193
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="42" packageName="@vendure/core" />
|
|
194
194
|
|
|
195
195
|
These are the default states of the Order process. They can be augmented and
|
|
196
|
-
modified by using the
|
|
197
|
-
the
|
|
196
|
+
modified by using the [OrderOptions](/reference/typescript-api/orders/order-options#orderoptions) `process` property, and by default
|
|
197
|
+
the [defaultOrderProcess](/reference/typescript-api/orders/order-process#defaultorderprocess) will add the states
|
|
198
198
|
|
|
199
199
|
- `ArrangingPayment`
|
|
200
200
|
- `PaymentAuthorized`
|
|
@@ -216,7 +216,7 @@ type OrderState = | 'Created'
|
|
|
216
216
|
```
|
|
217
217
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="57" packageName="@vendure/core" />
|
|
218
218
|
|
|
219
|
-
This is the object passed to the
|
|
219
|
+
This is the object passed to the [OrderProcess](/reference/typescript-api/orders/order-process#orderprocess) state transition hooks.
|
|
220
220
|
|
|
221
221
|
```ts title="Signature"
|
|
222
222
|
interface OrderTransitionData {
|
|
@@ -28,7 +28,7 @@ interface OrderSellerStrategy extends InjectableStrategy {
|
|
|
28
28
|
): void | Promise<void>;
|
|
29
29
|
}
|
|
30
30
|
```
|
|
31
|
-
* Extends:
|
|
31
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -39,15 +39,15 @@ interface OrderSellerStrategy extends InjectableStrategy {
|
|
|
39
39
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | undefined | Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | undefined>`} />
|
|
40
40
|
|
|
41
41
|
This method is called whenever a new OrderLine is added to the Order via the `addItemToOrder` mutation or the
|
|
42
|
-
underlying `addItemToOrder()` method of the
|
|
42
|
+
underlying `addItemToOrder()` method of the [OrderService](/reference/typescript-api/services/order-service#orderservice).
|
|
43
43
|
|
|
44
44
|
It should return the Channel to which this OrderLine will be assigned, which will be used to set the
|
|
45
|
-
|
|
45
|
+
[OrderLine](/reference/typescript-api/entities/order-line#orderline) `sellerChannel` property.
|
|
46
46
|
### splitOrder
|
|
47
47
|
|
|
48
48
|
<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>) => <a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>[] | Promise<<a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>[]>`} />
|
|
49
49
|
|
|
50
|
-
Upon checkout (by default, when the Order moves from "active" to "inactive" according to the
|
|
50
|
+
Upon checkout (by default, when the Order moves from "active" to "inactive" according to the [OrderPlacedStrategy](/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy)),
|
|
51
51
|
this method will be called in order to split the Order into multiple Orders, one for each Seller.
|
|
52
52
|
### afterSellerOrdersCreated
|
|
53
53
|
|
|
@@ -68,7 +68,7 @@ class DefaultOrderSellerStrategy implements OrderSellerStrategy {
|
|
|
68
68
|
|
|
69
69
|
}
|
|
70
70
|
```
|
|
71
|
-
* Implements:
|
|
71
|
+
* Implements: [`OrderSellerStrategy`](/reference/typescript-api/orders/order-seller-strategy#ordersellerstrategy)
|
|
72
72
|
|
|
73
73
|
|
|
74
74
|
<GenerationInfo sourceFile="packages/core/src/config/order/order-seller-strategy.ts" sourceLine="19" packageName="@vendure/core" since="2.0.0" />
|
|
@@ -24,7 +24,7 @@ interface StockAllocationStrategy extends InjectableStrategy {
|
|
|
24
24
|
): boolean | Promise<boolean>;
|
|
25
25
|
}
|
|
26
26
|
```
|
|
27
|
-
* Extends:
|
|
27
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
|
|
@@ -4,5 +4,5 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/payment/default-payment-process.ts" sourceLine="26" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
The default
|
|
7
|
+
The default [PaymentProcess](/reference/typescript-api/payment/payment-process#paymentprocess)
|
|
8
8
|
|
|
@@ -4,5 +4,5 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/refund/default-refund-process.ts" sourceLine="16" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
The default
|
|
7
|
+
The default [RefundProcess](/reference/typescript-api/payment/refund-process#refundprocess).
|
|
8
8
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="255" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Defines the object which is used to construct the
|
|
7
|
+
Defines the object which is used to construct the [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface PaymentMethodConfigOptions<T extends ConfigArgs> extends ConfigurableOperationDefOptions<T> {
|
|
@@ -15,7 +15,7 @@ interface PaymentMethodConfigOptions<T extends ConfigArgs> extends ConfigurableO
|
|
|
15
15
|
onStateTransitionStart?: OnTransitionStartFn<PaymentState, PaymentTransitionData>;
|
|
16
16
|
}
|
|
17
17
|
```
|
|
18
|
-
* Extends:
|
|
18
|
+
* Extends: [`ConfigurableOperationDefOptions`](/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions)`<T>`
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|
|
@@ -27,7 +27,7 @@ interface PaymentMethodConfigOptions<T extends ConfigArgs> extends ConfigurableO
|
|
|
27
27
|
|
|
28
28
|
This function provides the logic for creating a payment. For example,
|
|
29
29
|
it may call out to a third-party service with the data and should return a
|
|
30
|
-
|
|
30
|
+
[CreatePaymentResult](/reference/typescript-api/payment/payment-method-types#createpaymentresult) object contains the details of the payment.
|
|
31
31
|
### settlePayment
|
|
32
32
|
|
|
33
33
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a><T>`} />
|
|
@@ -57,7 +57,7 @@ omitted and any Refunds will have to be settled manually by an administrator.
|
|
|
57
57
|
|
|
58
58
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
|
|
59
59
|
|
|
60
|
-
This function, when specified, will be invoked before any transition from one
|
|
60
|
+
This function, when specified, will be invoked before any transition from one [PaymentState](/reference/typescript-api/payment/payment-state#paymentstate) to another.
|
|
61
61
|
The return value (a sync / async `boolean`) is used to determine whether the transition is permitted.
|
|
62
62
|
|
|
63
63
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-eligibility-checker.ts" sourceLine="47" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
The PaymentMethodEligibilityChecker class is used to check whether an order qualifies for a
|
|
8
|
-
given
|
|
8
|
+
given [PaymentMethod](/reference/typescript-api/entities/payment-method#paymentmethod).
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
11
11
|
|
|
@@ -27,7 +27,7 @@ class PaymentMethodEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends
|
|
|
27
27
|
constructor(config: PaymentMethodEligibilityCheckerConfig<T>)
|
|
28
28
|
}
|
|
29
29
|
```
|
|
30
|
-
* Extends:
|
|
30
|
+
* Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
|
|
@@ -43,7 +43,7 @@ class PaymentMethodEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends
|
|
|
43
43
|
</div>
|
|
44
44
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-eligibility-checker.ts" sourceLine="20" packageName="@vendure/core" />
|
|
45
45
|
|
|
46
|
-
Configuration passed into the constructor of a
|
|
46
|
+
Configuration passed into the constructor of a [PaymentMethodEligibilityChecker](/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker) to
|
|
47
47
|
configure its behavior.
|
|
48
48
|
|
|
49
49
|
```ts title="Signature"
|
|
@@ -51,7 +51,7 @@ interface PaymentMethodEligibilityCheckerConfig<T extends ConfigArgs> extends Co
|
|
|
51
51
|
check: CheckPaymentMethodEligibilityCheckerFn<T>;
|
|
52
52
|
}
|
|
53
53
|
```
|
|
54
|
-
* Extends:
|
|
54
|
+
* Extends: [`ConfigurableOperationDefOptions`](/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions)`<T>`
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
|
|
@@ -67,7 +67,7 @@ interface PaymentMethodEligibilityCheckerConfig<T extends ConfigArgs> extends Co
|
|
|
67
67
|
</div>
|
|
68
68
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-eligibility-checker.ts" sourceLine="83" packageName="@vendure/core" />
|
|
69
69
|
|
|
70
|
-
A function which implements logic to determine whether a given
|
|
70
|
+
A function which implements logic to determine whether a given [Order](/reference/typescript-api/entities/order#order) is eligible for
|
|
71
71
|
a particular payment method. If the function resolves to `false` or a string, the check is
|
|
72
72
|
considered to have failed. A string result can be used to provide information about the
|
|
73
73
|
reason for ineligibility, if desired.
|
|
@@ -9,7 +9,7 @@ A PaymentMethodHandler contains the code which is used to generate a Payment whe
|
|
|
9
9
|
third-party payment gateway before the Payment is created and can also define actions to fire
|
|
10
10
|
when the state of the payment is changed.
|
|
11
11
|
|
|
12
|
-
PaymentMethodHandlers are instantiated using a
|
|
12
|
+
PaymentMethodHandlers are instantiated using a [PaymentMethodConfigOptions](/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions) object, which
|
|
13
13
|
configures the business logic used to create, settle and refund payments.
|
|
14
14
|
|
|
15
15
|
*Example*
|
|
@@ -62,7 +62,7 @@ class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> extends Configurab
|
|
|
62
62
|
constructor(config: PaymentMethodConfigOptions<T>)
|
|
63
63
|
}
|
|
64
64
|
```
|
|
65
|
-
* Extends:
|
|
65
|
+
* Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="30" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
This object is the return value of the
|
|
7
|
+
This object is the return value of the [CreatePaymentFn](/reference/typescript-api/payment/payment-method-types#createpaymentfn).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface CreatePaymentResult {
|
|
@@ -29,12 +29,12 @@ are being used for the order.
|
|
|
29
29
|
|
|
30
30
|
<MemberInfo kind="property" type={`Exclude<<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, 'Error'>`} />
|
|
31
31
|
|
|
32
|
-
The
|
|
32
|
+
The [PaymentState](/reference/typescript-api/payment/payment-state#paymentstate) of the resulting Payment.
|
|
33
33
|
|
|
34
34
|
In a single-step payment flow, this should be set to `'Settled'`.
|
|
35
35
|
In a two-step flow, this should be set to `'Authorized'`.
|
|
36
36
|
|
|
37
|
-
If using a
|
|
37
|
+
If using a [PaymentProcess](/reference/typescript-api/payment/payment-process#paymentprocess), may be something else
|
|
38
38
|
entirely according to your business logic.
|
|
39
39
|
### transactionId
|
|
40
40
|
|
|
@@ -66,7 +66,7 @@ url which must then be passed to the storefront app.
|
|
|
66
66
|
</div>
|
|
67
67
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="83" packageName="@vendure/core" />
|
|
68
68
|
|
|
69
|
-
This object is the return value of the
|
|
69
|
+
This object is the return value of the [CreatePaymentFn](/reference/typescript-api/payment/payment-method-types#createpaymentfn) when there has been an error.
|
|
70
70
|
|
|
71
71
|
```ts title="Signature"
|
|
72
72
|
interface CreatePaymentErrorResult {
|
|
@@ -110,7 +110,7 @@ interface CreatePaymentErrorResult {
|
|
|
110
110
|
</div>
|
|
111
111
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="98" packageName="@vendure/core" />
|
|
112
112
|
|
|
113
|
-
This object is the return value of the
|
|
113
|
+
This object is the return value of the [CreateRefundFn](/reference/typescript-api/payment/payment-method-types#createrefundfn).
|
|
114
114
|
|
|
115
115
|
```ts title="Signature"
|
|
116
116
|
interface CreateRefundResult {
|
|
@@ -142,7 +142,7 @@ interface CreateRefundResult {
|
|
|
142
142
|
</div>
|
|
143
143
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="112" packageName="@vendure/core" />
|
|
144
144
|
|
|
145
|
-
This object is the return value of the
|
|
145
|
+
This object is the return value of the [SettlePaymentFn](/reference/typescript-api/payment/payment-method-types#settlepaymentfn) when the Payment
|
|
146
146
|
has been successfully settled.
|
|
147
147
|
|
|
148
148
|
```ts title="Signature"
|
|
@@ -169,7 +169,7 @@ interface SettlePaymentResult {
|
|
|
169
169
|
</div>
|
|
170
170
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="125" packageName="@vendure/core" />
|
|
171
171
|
|
|
172
|
-
This object is the return value of the
|
|
172
|
+
This object is the return value of the [SettlePaymentFn](/reference/typescript-api/payment/payment-method-types#settlepaymentfn) when the Payment
|
|
173
173
|
could not be settled.
|
|
174
174
|
|
|
175
175
|
```ts title="Signature"
|
|
@@ -196,7 +196,7 @@ The state to transition this Payment to upon unsuccessful settlement.
|
|
|
196
196
|
Defaults to `Error`. Note that if using a different state, it must be
|
|
197
197
|
legal to transition to that state from the `Authorized` state according
|
|
198
198
|
to the PaymentState config (which can be customized using the
|
|
199
|
-
|
|
199
|
+
[PaymentProcess](/reference/typescript-api/payment/payment-process#paymentprocess)).
|
|
200
200
|
### errorMessage
|
|
201
201
|
|
|
202
202
|
<MemberInfo kind="property" type={`string`} />
|
|
@@ -213,7 +213,7 @@ also be persisted as `Payment.errorMessage`.
|
|
|
213
213
|
</div>
|
|
214
214
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="153" packageName="@vendure/core" />
|
|
215
215
|
|
|
216
|
-
This object is the return value of the
|
|
216
|
+
This object is the return value of the [CancelPaymentFn](/reference/typescript-api/payment/payment-method-types#cancelpaymentfn) when the Payment
|
|
217
217
|
has been successfully cancelled.
|
|
218
218
|
|
|
219
219
|
```ts title="Signature"
|
|
@@ -240,7 +240,7 @@ interface CancelPaymentResult {
|
|
|
240
240
|
</div>
|
|
241
241
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="165" packageName="@vendure/core" />
|
|
242
242
|
|
|
243
|
-
This object is the return value of the
|
|
243
|
+
This object is the return value of the [CancelPaymentFn](/reference/typescript-api/payment/payment-method-types#cancelpaymentfn) when the Payment
|
|
244
244
|
could not be cancelled.
|
|
245
245
|
|
|
246
246
|
```ts title="Signature"
|
|
@@ -267,7 +267,7 @@ The state to transition this Payment to upon unsuccessful cancellation.
|
|
|
267
267
|
Defaults to `Error`. Note that if using a different state, it must be
|
|
268
268
|
legal to transition to that state from the `Authorized` state according
|
|
269
269
|
to the PaymentState config (which can be customized using the
|
|
270
|
-
|
|
270
|
+
[PaymentProcess](/reference/typescript-api/payment/payment-process#paymentprocess)).
|
|
271
271
|
### errorMessage
|
|
272
272
|
|
|
273
273
|
<MemberInfo kind="property" type={`string`} />
|
|
@@ -284,9 +284,9 @@ also be persisted as `Payment.errorMessage`.
|
|
|
284
284
|
</div>
|
|
285
285
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="193" packageName="@vendure/core" />
|
|
286
286
|
|
|
287
|
-
This function contains the logic for creating a payment. See
|
|
287
|
+
This function contains the logic for creating a payment. See [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler) for an example.
|
|
288
288
|
|
|
289
|
-
Returns a
|
|
289
|
+
Returns a [CreatePaymentResult](/reference/typescript-api/payment/payment-method-types#createpaymentresult).
|
|
290
290
|
|
|
291
291
|
```ts title="Signature"
|
|
292
292
|
type CreatePaymentFn<T extends ConfigArgs> = (
|
|
@@ -300,7 +300,7 @@ type CreatePaymentFn<T extends ConfigArgs> = (
|
|
|
300
300
|
```
|
|
301
301
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="209" packageName="@vendure/core" />
|
|
302
302
|
|
|
303
|
-
This function contains the logic for settling a payment. See
|
|
303
|
+
This function contains the logic for settling a payment. See [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler) for an example.
|
|
304
304
|
|
|
305
305
|
```ts title="Signature"
|
|
306
306
|
type SettlePaymentFn<T extends ConfigArgs> = (
|
|
@@ -313,7 +313,7 @@ type SettlePaymentFn<T extends ConfigArgs> = (
|
|
|
313
313
|
```
|
|
314
314
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="224" packageName="@vendure/core" />
|
|
315
315
|
|
|
316
|
-
This function contains the logic for cancelling a payment. See
|
|
316
|
+
This function contains the logic for cancelling a payment. See [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler) for an example.
|
|
317
317
|
|
|
318
318
|
```ts title="Signature"
|
|
319
319
|
type CancelPaymentFn<T extends ConfigArgs> = (
|
|
@@ -326,7 +326,7 @@ type CancelPaymentFn<T extends ConfigArgs> = (
|
|
|
326
326
|
```
|
|
327
327
|
<GenerationInfo sourceFile="packages/core/src/config/payment/payment-method-handler.ts" sourceLine="239" packageName="@vendure/core" />
|
|
328
328
|
|
|
329
|
-
This function contains the logic for creating a refund. See
|
|
329
|
+
This function contains the logic for creating a refund. See [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler) for an example.
|
|
330
330
|
|
|
331
331
|
```ts title="Signature"
|
|
332
332
|
type CreateRefundFn<T extends ConfigArgs> = (
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="873" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Defines payment-related options in the
|
|
7
|
+
Defines payment-related options in the [VendureConfig](/reference/typescript-api/configuration/vendure-config#vendureconfig).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface PaymentOptions {
|
|
@@ -22,14 +22,14 @@ interface PaymentOptions {
|
|
|
22
22
|
|
|
23
23
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>[]`} />
|
|
24
24
|
|
|
25
|
-
Defines which
|
|
26
|
-
|
|
25
|
+
Defines which [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler)s are available when configuring
|
|
26
|
+
[PaymentMethod](/reference/typescript-api/entities/payment-method#paymentmethod)s
|
|
27
27
|
### paymentMethodEligibilityCheckers
|
|
28
28
|
|
|
29
29
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker'>PaymentMethodEligibilityChecker</a>[]`} />
|
|
30
30
|
|
|
31
|
-
Defines which
|
|
32
|
-
|
|
31
|
+
Defines which [PaymentMethodEligibilityChecker](/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker)s are available when configuring
|
|
32
|
+
[PaymentMethod](/reference/typescript-api/entities/payment-method#paymentmethod)s
|
|
33
33
|
### customPaymentProcess
|
|
34
34
|
|
|
35
35
|
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} />
|
|
@@ -40,13 +40,13 @@ Defines which <DocsLink href="/reference/typescript-api/payment/payment-method-e
|
|
|
40
40
|
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>`} since="2.0.0" />
|
|
41
41
|
|
|
42
42
|
Allows the definition of custom states and transition logic for the payment process state machine.
|
|
43
|
-
Takes an array of objects implementing the
|
|
43
|
+
Takes an array of objects implementing the [PaymentProcess](/reference/typescript-api/payment/payment-process#paymentprocess) interface.
|
|
44
44
|
### refundProcess
|
|
45
45
|
|
|
46
46
|
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-refund-process#defaultrefundprocess'>defaultRefundProcess</a>`} />
|
|
47
47
|
|
|
48
48
|
Allows the definition of custom states and transition logic for the refund process state machine.
|
|
49
|
-
Takes an array of objects implementing the
|
|
49
|
+
Takes an array of objects implementing the [RefundProcess](/reference/typescript-api/payment/refund-process#refundprocess) interface.
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
</div>
|
|
@@ -9,7 +9,7 @@ in, and how it may transition from one state to another. Using the `onTransition
|
|
|
9
9
|
PaymentProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
|
|
10
10
|
hook allows logic to be executed after a state change.
|
|
11
11
|
|
|
12
|
-
For detailed description of the interface members, see the
|
|
12
|
+
For detailed description of the interface members, see the [StateMachineConfig](/reference/typescript-api/state-machine/state-machine-config#statemachineconfig) docs.
|
|
13
13
|
|
|
14
14
|
:::info
|
|
15
15
|
|
|
@@ -26,7 +26,7 @@ interface PaymentProcess<State extends keyof CustomPaymentStates | string> exten
|
|
|
26
26
|
onTransitionError?: OnTransitionErrorFn<State | PaymentState>;
|
|
27
27
|
}
|
|
28
28
|
```
|
|
29
|
-
* Extends:
|
|
29
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/payment-state-machine/payment-state.ts" sourceLine="19" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
An interface to extend standard
|
|
7
|
+
An interface to extend standard [PaymentState](/reference/typescript-api/payment/payment-state#paymentstate).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface PaymentStates {
|
|
@@ -9,7 +9,7 @@ in, and how it may transition from one state to another. Using the `onTransition
|
|
|
9
9
|
RefundProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
|
|
10
10
|
hook allows logic to be executed after a state change.
|
|
11
11
|
|
|
12
|
-
For detailed description of the interface members, see the
|
|
12
|
+
For detailed description of the interface members, see the [StateMachineConfig](/reference/typescript-api/state-machine/state-machine-config#statemachineconfig) docs.
|
|
13
13
|
|
|
14
14
|
```ts title="Signature"
|
|
15
15
|
interface RefundProcess<State extends keyof CustomRefundStates | string> extends InjectableStrategy {
|
|
@@ -19,7 +19,7 @@ interface RefundProcess<State extends keyof CustomRefundStates | string> extends
|
|
|
19
19
|
onTransitionError?: OnTransitionErrorFn<State | RefundState>;
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
|
-
* Extends:
|
|
22
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/refund-state-machine/refund-state.ts" sourceLine="19" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
An interface to extend standard
|
|
7
|
+
An interface to extend standard [RefundState](/reference/typescript-api/payment/refund-state#refundstate).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface RefundStates {
|
|
@@ -10,11 +10,11 @@ repeat the same boilerplate for each individual plugin.
|
|
|
10
10
|
|
|
11
11
|
The PluginCommonModule exports:
|
|
12
12
|
|
|
13
|
-
* `EventBusModule`, allowing the injection of the
|
|
13
|
+
* `EventBusModule`, allowing the injection of the [EventBus](/reference/typescript-api/events/event-bus#eventbus) service.
|
|
14
14
|
* `ServiceModule` allowing the injection of any of the various entity services such as ProductService, OrderService etc.
|
|
15
15
|
* `ConfigModule`, allowing the injection of the ConfigService.
|
|
16
|
-
* `JobQueueModule`, allowing the injection of the
|
|
17
|
-
* `HealthCheckModule`, allowing the injection of the
|
|
16
|
+
* `JobQueueModule`, allowing the injection of the [JobQueueService](/reference/typescript-api/job-queue/job-queue-service#jobqueueservice).
|
|
17
|
+
* `HealthCheckModule`, allowing the injection of the [HealthCheckRegistryService](/reference/typescript-api/health-check/health-check-registry-service#healthcheckregistryservice).
|
|
18
18
|
|
|
19
19
|
```ts title="Signature"
|
|
20
20
|
class PluginCommonModule {
|
|
@@ -42,7 +42,7 @@ Parameters
|
|
|
42
42
|
|
|
43
43
|
<GenerationInfo sourceFile="packages/core/src/plugin/plugin-utils.ts" sourceLine="74" packageName="@vendure/core" />
|
|
44
44
|
|
|
45
|
-
Options to configure proxy middleware via
|
|
45
|
+
Options to configure proxy middleware via [createProxyHandler](/reference/typescript-api/plugin/plugin-utilities#createproxyhandler).
|
|
46
46
|
|
|
47
47
|
```ts title="Signature"
|
|
48
48
|
interface ProxyOptions {
|
|
@@ -29,7 +29,7 @@ interface VendurePluginMetadata extends ModuleMetadata {
|
|
|
29
29
|
|
|
30
30
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/plugin/vendure-plugin-metadata#pluginconfigurationfn'>PluginConfigurationFn</a>`} />
|
|
31
31
|
|
|
32
|
-
A function which can modify the
|
|
32
|
+
A function which can modify the [VendureConfig](/reference/typescript-api/configuration/vendure-config#vendureconfig) object before the server bootstraps.
|
|
33
33
|
### shopApiExtensions
|
|
34
34
|
|
|
35
35
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/plugin/vendure-plugin-metadata#apiextensiondefinition'>APIExtensionDefinition</a>`} />
|
|
@@ -67,7 +67,7 @@ To effectively disable this check for a plugin, you can use an overly-permissive
|
|
|
67
67
|
|
|
68
68
|
:::note
|
|
69
69
|
Since Vendure v3.1.0, it is possible to ignore compatibility errors for specific plugins by
|
|
70
|
-
passing the `ignoreCompatibilityErrorsForPlugins` option to the
|
|
70
|
+
passing the `ignoreCompatibilityErrorsForPlugins` option to the [bootstrap](/reference/typescript-api/common/bootstrap#bootstrap) function.
|
|
71
71
|
:::
|
|
72
72
|
|
|
73
73
|
*Example*
|
|
@@ -125,7 +125,7 @@ Read more about defining custom scalars in the
|
|
|
125
125
|
</div>
|
|
126
126
|
<GenerationInfo sourceFile="packages/core/src/plugin/vendure-plugin.ts" sourceLine="119" packageName="@vendure/core" />
|
|
127
127
|
|
|
128
|
-
This method is called before the app bootstraps and should be used to perform any needed modifications to the
|
|
128
|
+
This method is called before the app bootstraps and should be used to perform any needed modifications to the [VendureConfig](/reference/typescript-api/configuration/vendure-config#vendureconfig).
|
|
129
129
|
|
|
130
130
|
```ts title="Signature"
|
|
131
131
|
type PluginConfigurationFn = (
|
|
@@ -23,7 +23,7 @@ interface CatalogOptions {
|
|
|
23
23
|
|
|
24
24
|
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a><any>>`} default={`defaultCollectionFilters`} />
|
|
25
25
|
|
|
26
|
-
Allows custom
|
|
26
|
+
Allows custom [CollectionFilter](/reference/typescript-api/configuration/collection-filter#collectionfilter)s to be defined.
|
|
27
27
|
### productVariantPriceSelectionStrategy
|
|
28
28
|
|
|
29
29
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/product-variant-price-selection-strategy#productvariantpriceselectionstrategy'>ProductVariantPriceSelectionStrategy</a>`} default={`<a href='/reference/typescript-api/configuration/product-variant-price-selection-strategy#defaultproductvariantpriceselectionstrategy'>DefaultProductVariantPriceSelectionStrategy</a>`} since="2.0.0" />
|
|
@@ -12,7 +12,7 @@ class DefaultProductVariantPriceCalculationStrategy implements ProductVariantPri
|
|
|
12
12
|
calculate(args: ProductVariantPriceCalculationArgs) => Promise<PriceCalculationResult>;
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Implements:
|
|
15
|
+
* Implements: [`ProductVariantPriceCalculationStrategy`](/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationstrategy)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|