@vendure/docs 0.0.0-202601271334 → 0.0.0-202601281114
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dates.generated.js +393 -393
- package/docs/guides/extending-the-admin-ui/getting-started/index.mdx +1 -1
- package/docs/guides/extending-the-dashboard/custom-form-components/index.mdx +2 -2
- package/docs/guides/extending-the-dashboard/customizing-pages/page-blocks.mdx +1 -1
- package/docs/guides/extending-the-dashboard/deployment/index.mdx +2 -2
- package/docs/guides/extending-the-dashboard/getting-started/index.mdx +1 -1
- package/docs/guides/extending-the-dashboard/navigation/index.mdx +2 -2
- package/docs/guides/how-to/cms-integration-plugin/index.mdx +7 -7
- package/docs/guides/how-to/codegen/index.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
- package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
- package/docs/reference/dashboard/page-layout/index.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +4 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/index.mdx +2 -2
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
- package/docs/reference/typescript-api/common/id.mdx +1 -1
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/middleware.mdx +1 -1
- package/docs/reference/typescript-api/common/permission.mdx +1 -1
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/entities/address.mdx +2 -2
- package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
- package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +3 -3
- package/docs/reference/typescript-api/entities/country.mdx +4 -4
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet.mdx +4 -4
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +9 -9
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/payment.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
- package/docs/reference/typescript-api/entities/product.mdx +3 -3
- package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
- package/docs/reference/typescript-api/entities/province.mdx +2 -2
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +4 -4
- package/docs/reference/typescript-api/entities/role.mdx +3 -3
- package/docs/reference/typescript-api/entities/seller.mdx +3 -3
- package/docs/reference/typescript-api/entities/session.mdx +3 -3
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
- package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
- package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
- package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
- package/docs/reference/typescript-api/entities/user.mdx +3 -3
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +2 -2
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
- package/docs/reference/typescript-api/events/event-types.mdx +109 -109
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
- package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
- package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
- package/docs/reference/typescript-api/logger/index.mdx +3 -3
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
- package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
- package/docs/reference/typescript-api/money/round-money.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
- package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
- package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
- package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context.mdx +5 -5
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
- package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
- package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
- package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
- package/docs/reference/typescript-api/services/history-service.mdx +1 -1
- package/docs/reference/typescript-api/services/order-service.mdx +24 -24
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
- package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/session-service.mdx +4 -4
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +8 -8
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
- package/package.json +2 -2
- package/src/dates.generated.ts +393 -393
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/fulfillment-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
This entity represents a line from an
|
|
7
|
+
This entity represents a line from an [Order](/reference/typescript-api/entities/order#order) which has been fulfilled by a [Fulfillment](/reference/typescript-api/entities/fulfillment#fulfillment).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class FulfillmentLine extends OrderLineReference {
|
|
@@ -16,7 +16,7 @@ class FulfillmentLine extends OrderLineReference {
|
|
|
16
16
|
fulfillmentId: ID;
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Extends:
|
|
19
|
+
* Extends: [`OrderLineReference`](/reference/typescript-api/entities/order-line-reference#orderlinereference)
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -42,7 +42,7 @@ class FulfillmentLine extends OrderLineReference {
|
|
|
42
42
|
</div>
|
|
43
43
|
<GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/order-line-reference.entity.ts" sourceLine="15" packageName="@vendure/core" />
|
|
44
44
|
|
|
45
|
-
This is an abstract base class for entities which reference an
|
|
45
|
+
This is an abstract base class for entities which reference an [OrderLine](/reference/typescript-api/entities/order-line#orderline).
|
|
46
46
|
|
|
47
47
|
```ts title="Signature"
|
|
48
48
|
class OrderLineReference extends VendureEntity {
|
|
@@ -55,7 +55,7 @@ class OrderLineReference extends VendureEntity {
|
|
|
55
55
|
orderLineId: ID;
|
|
56
56
|
}
|
|
57
57
|
```
|
|
58
|
-
* Extends:
|
|
58
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
|
|
@@ -81,7 +81,7 @@ class OrderLineReference extends VendureEntity {
|
|
|
81
81
|
</div>
|
|
82
82
|
<GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/order-modification-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
|
|
83
83
|
|
|
84
|
-
This entity represents a line from an
|
|
84
|
+
This entity represents a line from an [Order](/reference/typescript-api/entities/order#order) which has been modified by an [OrderModification](/reference/typescript-api/entities/order-modification#ordermodification).
|
|
85
85
|
|
|
86
86
|
```ts title="Signature"
|
|
87
87
|
class OrderModificationLine extends OrderLineReference {
|
|
@@ -93,7 +93,7 @@ class OrderModificationLine extends OrderLineReference {
|
|
|
93
93
|
modificationId: ID;
|
|
94
94
|
}
|
|
95
95
|
```
|
|
96
|
-
* Extends:
|
|
96
|
+
* Extends: [`OrderLineReference`](/reference/typescript-api/entities/order-line-reference#orderlinereference)
|
|
97
97
|
|
|
98
98
|
|
|
99
99
|
|
|
@@ -119,7 +119,7 @@ class OrderModificationLine extends OrderLineReference {
|
|
|
119
119
|
</div>
|
|
120
120
|
<GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/refund-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
|
|
121
121
|
|
|
122
|
-
This entity represents a line from an
|
|
122
|
+
This entity represents a line from an [Order](/reference/typescript-api/entities/order#order) which has been refunded by a [Refund](/reference/typescript-api/entities/refund#refund).
|
|
123
123
|
|
|
124
124
|
```ts title="Signature"
|
|
125
125
|
class RefundLine extends OrderLineReference {
|
|
@@ -131,7 +131,7 @@ class RefundLine extends OrderLineReference {
|
|
|
131
131
|
refundId: ID;
|
|
132
132
|
}
|
|
133
133
|
```
|
|
134
|
-
* Extends:
|
|
134
|
+
* Extends: [`OrderLineReference`](/reference/typescript-api/entities/order-line-reference#orderlinereference)
|
|
135
135
|
|
|
136
136
|
|
|
137
137
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/order-line/order-line.entity.ts" sourceLine="32" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A single line on an
|
|
7
|
+
A single line on an [Order](/reference/typescript-api/entities/order#order) which contains information about the [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) and
|
|
8
8
|
quantity ordered, as well as the price and tax information.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -87,7 +87,7 @@ class OrderLine extends VendureEntity implements HasCustomFields {
|
|
|
87
87
|
clearAdjustments(type?: AdjustmentType) => ;
|
|
88
88
|
}
|
|
89
89
|
```
|
|
90
|
-
* Extends:
|
|
90
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
* Implements: HasCustomFields
|
|
@@ -105,7 +105,7 @@ class OrderLine extends VendureEntity implements HasCustomFields {
|
|
|
105
105
|
|
|
106
106
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`} />
|
|
107
107
|
|
|
108
|
-
The
|
|
108
|
+
The [Channel](/reference/typescript-api/entities/channel#channel) of the [Seller](/reference/typescript-api/entities/seller#seller) for a multivendor setup.
|
|
109
109
|
### sellerChannelId
|
|
110
110
|
|
|
111
111
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
|
|
@@ -115,8 +115,8 @@ The <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel<
|
|
|
115
115
|
|
|
116
116
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>`} />
|
|
117
117
|
|
|
118
|
-
The
|
|
119
|
-
This is determined by the configured
|
|
118
|
+
The [ShippingLine](/reference/typescript-api/entities/shipping-line#shippingline) to which this line has been assigned.
|
|
119
|
+
This is determined by the configured [ShippingLineAssignmentStrategy](/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy).
|
|
120
120
|
### shippingLineId
|
|
121
121
|
|
|
122
122
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
|
|
@@ -126,7 +126,7 @@ This is determined by the configured <DocsLink href="/reference/typescript-api/s
|
|
|
126
126
|
|
|
127
127
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`} />
|
|
128
128
|
|
|
129
|
-
The
|
|
129
|
+
The [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) which is being ordered.
|
|
130
130
|
### productVariantId
|
|
131
131
|
|
|
132
132
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
|
|
@@ -171,7 +171,7 @@ The <DocsLink href="/reference/typescript-api/entities/product-variant#productva
|
|
|
171
171
|
|
|
172
172
|
<MemberInfo kind="property" type={`number`} />
|
|
173
173
|
|
|
174
|
-
The quantity of this OrderLine at the time the order was placed (as per the
|
|
174
|
+
The quantity of this OrderLine at the time the order was placed (as per the [OrderPlacedStrategy](/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy)).
|
|
175
175
|
### initialListPrice
|
|
176
176
|
|
|
177
177
|
<MemberInfo kind="property" type={`number`} />
|
|
@@ -183,7 +183,7 @@ the Order has been performed.
|
|
|
183
183
|
|
|
184
184
|
<MemberInfo kind="property" type={`number`} />
|
|
185
185
|
|
|
186
|
-
This is the price as listed by the ProductVariant (and possibly modified by the
|
|
186
|
+
This is the price as listed by the ProductVariant (and possibly modified by the [OrderItemPriceCalculationStrategy](/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy)),
|
|
187
187
|
which, depending on the current Channel, may or may not include tax.
|
|
188
188
|
### listPriceIncludesTax
|
|
189
189
|
|
|
@@ -32,7 +32,7 @@ class OrderModification extends VendureEntity {
|
|
|
32
32
|
isSettled: boolean
|
|
33
33
|
}
|
|
34
34
|
```
|
|
35
|
-
* Extends:
|
|
35
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -4,11 +4,11 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/order/order.entity.ts" sourceLine="43" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
An Order is created whenever a
|
|
8
|
-
information required to fulfill an order: which
|
|
7
|
+
An Order is created whenever a [Customer](/reference/typescript-api/entities/customer#customer) adds an item to the cart. It contains all the
|
|
8
|
+
information required to fulfill an order: which [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant)s in what quantities;
|
|
9
9
|
the shipping address and price; any applicable promotions; payments etc.
|
|
10
10
|
|
|
11
|
-
An Order exists in a well-defined state according to the
|
|
11
|
+
An Order exists in a well-defined state according to the [OrderState](/reference/typescript-api/orders/order-process#orderstate) type. A state machine
|
|
12
12
|
is used to govern the transition from one state to another.
|
|
13
13
|
|
|
14
14
|
```ts title="Signature"
|
|
@@ -81,10 +81,10 @@ class Order extends VendureEntity implements ChannelAware, HasCustomFields {
|
|
|
81
81
|
taxSummary: OrderTaxSummary[]
|
|
82
82
|
}
|
|
83
83
|
```
|
|
84
|
-
* Extends:
|
|
84
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
85
85
|
|
|
86
86
|
|
|
87
|
-
* Implements:
|
|
87
|
+
* Implements: [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware), HasCustomFields
|
|
88
88
|
|
|
89
89
|
|
|
90
90
|
|
|
@@ -120,7 +120,7 @@ class Order extends VendureEntity implements ChannelAware, HasCustomFields {
|
|
|
120
120
|
<MemberInfo kind="property" type={`string`} />
|
|
121
121
|
|
|
122
122
|
A unique code for the Order, generated according to the
|
|
123
|
-
|
|
123
|
+
[OrderCodeStrategy](/reference/typescript-api/orders/order-code-strategy#ordercodestrategy). This should be used as an order reference
|
|
124
124
|
for Customers, rather than the Order's id.
|
|
125
125
|
### state
|
|
126
126
|
|
|
@@ -134,14 +134,14 @@ for Customers, rather than the Order's id.
|
|
|
134
134
|
Whether the Order is considered "active", meaning that the
|
|
135
135
|
Customer can still make changes to it and has not yet completed
|
|
136
136
|
the checkout process.
|
|
137
|
-
This is governed by the
|
|
137
|
+
This is governed by the [OrderPlacedStrategy](/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy).
|
|
138
138
|
### orderPlacedAt
|
|
139
139
|
|
|
140
140
|
<MemberInfo kind="property" type={`Date`} />
|
|
141
141
|
|
|
142
142
|
The date & time that the Order was placed, i.e. the Customer
|
|
143
143
|
completed the checkout and the Order is no longer "active".
|
|
144
|
-
This is governed by the
|
|
144
|
+
This is governed by the [OrderPlacedStrategy](/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy).
|
|
145
145
|
### customer
|
|
146
146
|
|
|
147
147
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`} />
|
|
@@ -228,7 +228,7 @@ i.e. the Order is no longer active.
|
|
|
228
228
|
The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
|
|
229
229
|
discounts which have been prorated (proportionally distributed) amongst the OrderItems.
|
|
230
230
|
To get a total of all OrderLines which does not account for prorated discounts, use the
|
|
231
|
-
sum of
|
|
231
|
+
sum of [OrderLine](/reference/typescript-api/entities/order-line#orderline)'s `discountedLinePrice` values.
|
|
232
232
|
### subTotalWithTax
|
|
233
233
|
|
|
234
234
|
<MemberInfo kind="property" type={`number`} />
|
|
@@ -22,10 +22,10 @@ class OrderableAsset extends VendureEntity implements Orderable {
|
|
|
22
22
|
position: number;
|
|
23
23
|
}
|
|
24
24
|
```
|
|
25
|
-
* Extends:
|
|
25
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
26
26
|
|
|
27
27
|
|
|
28
|
-
* Implements:
|
|
28
|
+
* Implements: [`Orderable`](/reference/typescript-api/entities/interfaces#orderable)
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/payment-method/payment-method.entity.ts" sourceLine="21" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A PaymentMethod is created automatically according to the configured
|
|
8
|
-
in the
|
|
7
|
+
A PaymentMethod is created automatically according to the configured [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler)s defined
|
|
8
|
+
in the [PaymentOptions](/reference/typescript-api/payment/payment-options#paymentoptions) config.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class PaymentMethod extends VendureEntity implements Translatable, ChannelAware, HasCustomFields {
|
|
@@ -25,10 +25,10 @@ class PaymentMethod extends VendureEntity implements Translatable, ChannelAware,
|
|
|
25
25
|
customFields: CustomPaymentMethodFields;
|
|
26
26
|
}
|
|
27
27
|
```
|
|
28
|
-
* Extends:
|
|
28
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
29
29
|
|
|
30
30
|
|
|
31
|
-
* Implements:
|
|
31
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware), HasCustomFields
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/payment/payment.entity.ts" sourceLine="20" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
A Payment represents a single payment transaction and exists in a well-defined state
|
|
8
|
-
defined by the
|
|
8
|
+
defined by the [PaymentState](/reference/typescript-api/payment/payment-state#paymentstate) type.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class Payment extends VendureEntity implements HasCustomFields {
|
|
@@ -27,7 +27,7 @@ class Payment extends VendureEntity implements HasCustomFields {
|
|
|
27
27
|
customFields: CustomPaymentFields;
|
|
28
28
|
}
|
|
29
29
|
```
|
|
30
|
-
* Extends:
|
|
30
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
* Implements: HasCustomFields
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/product-option-group/product-option-group.entity.ts" sourceLine="20" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A grouping of one or more
|
|
7
|
+
A grouping of one or more [ProductOption](/reference/typescript-api/entities/product-option#productoption)s.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ProductOptionGroup extends VendureEntity implements Translatable, HasCustomFields, SoftDeletable {
|
|
@@ -25,10 +25,10 @@ class ProductOptionGroup extends VendureEntity implements Translatable, HasCusto
|
|
|
25
25
|
customFields: CustomProductOptionGroupFields;
|
|
26
26
|
}
|
|
27
27
|
```
|
|
28
|
-
* Extends:
|
|
28
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
29
29
|
|
|
30
30
|
|
|
31
|
-
* Implements:
|
|
31
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), HasCustomFields, [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable)
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/product-option/product-option.entity.ts" sourceLine="21" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A ProductOption is used to differentiate
|
|
7
|
+
A ProductOption is used to differentiate [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant)s from one another.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class ProductOption extends VendureEntity implements Translatable, HasCustomFields, SoftDeletable {
|
|
@@ -26,10 +26,10 @@ class ProductOption extends VendureEntity implements Translatable, HasCustomFiel
|
|
|
26
26
|
customFields: CustomProductOptionFields;
|
|
27
27
|
}
|
|
28
28
|
```
|
|
29
|
-
* Extends:
|
|
29
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
* Implements:
|
|
32
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), HasCustomFields, [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable)
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -21,7 +21,7 @@ class ProductVariantPrice extends VendureEntity implements HasCustomFields {
|
|
|
21
21
|
customFields: CustomProductVariantPriceFields;
|
|
22
22
|
}
|
|
23
23
|
```
|
|
24
|
-
* Extends:
|
|
24
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
* Implements: HasCustomFields
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/product-variant/product-variant.entity.ts" sourceLine="38" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
A ProductVariant represents a single stock keeping unit (SKU) in the store's inventory.
|
|
8
|
-
Whereas a
|
|
8
|
+
Whereas a [Product](/reference/typescript-api/entities/product#product) is a "container" of variants, the variant itself holds the
|
|
9
9
|
data on price, tax category etc. When one adds items to their cart, they are adding
|
|
10
10
|
ProductVariants, not Products.
|
|
11
11
|
|
|
@@ -75,10 +75,10 @@ class ProductVariant extends VendureEntity implements Translatable, HasCustomFie
|
|
|
75
75
|
lines: OrderLine[];
|
|
76
76
|
}
|
|
77
77
|
```
|
|
78
|
-
* Extends:
|
|
78
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
79
79
|
|
|
80
80
|
|
|
81
|
-
* Implements:
|
|
81
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), HasCustomFields, [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable), [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware)
|
|
82
82
|
|
|
83
83
|
|
|
84
84
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/product/product.entity.ts" sourceLine="26" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A Product contains one or more
|
|
7
|
+
A Product contains one or more [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant)s and serves as a container for those variants,
|
|
8
8
|
providing an overall name, description etc.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -40,10 +40,10 @@ class Product extends VendureEntity implements Translatable, HasCustomFields, Ch
|
|
|
40
40
|
customFields: CustomProductFields;
|
|
41
41
|
}
|
|
42
42
|
```
|
|
43
|
-
* Extends:
|
|
43
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
44
44
|
|
|
45
45
|
|
|
46
|
-
* Implements:
|
|
46
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), HasCustomFields, [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware), [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable)
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
|
|
@@ -7,8 +7,8 @@ generated: true
|
|
|
7
7
|
A Promotion is used to define a set of conditions under which promotions actions (typically discounts)
|
|
8
8
|
will be applied to an Order.
|
|
9
9
|
|
|
10
|
-
Each assigned
|
|
11
|
-
then each assign
|
|
10
|
+
Each assigned [PromotionCondition](/reference/typescript-api/promotions/promotion-condition#promotioncondition) is checked against the Order, and if they all return `true`,
|
|
11
|
+
then each assign [PromotionItemAction](/reference/typescript-api/promotions/promotion-action#promotionitemaction) / [PromotionLineAction](/reference/typescript-api/promotions/promotion-action#promotionlineaction) / [PromotionOrderAction](/reference/typescript-api/promotions/promotion-action#promotionorderaction) / [PromotionShippingAction](/reference/typescript-api/promotions/promotion-action#promotionshippingaction) is applied to the Order.
|
|
12
12
|
|
|
13
13
|
```ts title="Signature"
|
|
14
14
|
class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable, HasCustomFields, Translatable {
|
|
@@ -53,7 +53,7 @@ class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable,
|
|
|
53
53
|
* Extends: AdjustmentSource
|
|
54
54
|
|
|
55
55
|
|
|
56
|
-
* Implements:
|
|
56
|
+
* Implements: [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware), [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable), HasCustomFields, [`Translatable`](/reference/typescript-api/entities/interfaces#translatable)
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/region/province.entity.ts" sourceLine="13" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A Province represents an administrative subdivision of a
|
|
7
|
+
A Province represents an administrative subdivision of a [Country](/reference/typescript-api/entities/country#country). For example, in the
|
|
8
8
|
United States, the country would be "United States" and the province would be "California".
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -13,7 +13,7 @@ class Province extends Region {
|
|
|
13
13
|
readonly type: RegionType = 'province';
|
|
14
14
|
}
|
|
15
15
|
```
|
|
16
|
-
* Extends:
|
|
16
|
+
* Extends: [`Region`](/reference/typescript-api/entities/region#region)
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
@@ -31,7 +31,7 @@ class Refund extends VendureEntity implements HasCustomFields {
|
|
|
31
31
|
customFields: CustomRefundFields;
|
|
32
32
|
}
|
|
33
33
|
```
|
|
34
|
-
* Extends:
|
|
34
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
* Implements: HasCustomFields
|
|
@@ -5,8 +5,8 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/region/region.entity.ts" sourceLine="22" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
A Region represents a geographical administrative unit, such as a Country, Province, State, Prefecture etc.
|
|
8
|
-
This is an abstract class which is extended by the
|
|
9
|
-
Regions can be grouped into
|
|
8
|
+
This is an abstract class which is extended by the [Country](/reference/typescript-api/entities/country#country) and [Province](/reference/typescript-api/entities/province#province) entities.
|
|
9
|
+
Regions can be grouped into [Zone](/reference/typescript-api/entities/zone#zone)s which are in turn used to determine applicable shipping and taxes for an [Order](/reference/typescript-api/entities/order#order).
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
class Region extends VendureEntity implements Translatable, HasCustomFields {
|
|
@@ -26,10 +26,10 @@ class Region extends VendureEntity implements Translatable, HasCustomFields {
|
|
|
26
26
|
customFields: CustomRegionFields;
|
|
27
27
|
}
|
|
28
28
|
```
|
|
29
|
-
* Extends:
|
|
29
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
* Implements:
|
|
32
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), HasCustomFields
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/role/role.entity.ts" sourceLine="16" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
A Role represents a collection of permissions which determine the authorization
|
|
8
|
-
level of a
|
|
8
|
+
level of a [User](/reference/typescript-api/entities/user#user) on a given set of [Channel](/reference/typescript-api/entities/channel#channel)s.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class Role extends VendureEntity implements ChannelAware {
|
|
@@ -18,10 +18,10 @@ class Role extends VendureEntity implements ChannelAware {
|
|
|
18
18
|
channels: Channel[];
|
|
19
19
|
}
|
|
20
20
|
```
|
|
21
|
-
* Extends:
|
|
21
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
22
22
|
|
|
23
23
|
|
|
24
|
-
* Implements:
|
|
24
|
+
* Implements: [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware)
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/seller/seller.entity.ts" sourceLine="17" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A Seller represents the person or organization who is selling the goods on a given
|
|
7
|
+
A Seller represents the person or organization who is selling the goods on a given [Channel](/reference/typescript-api/entities/channel#channel).
|
|
8
8
|
By default, a single-channel Vendure installation will have a single default Seller.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -19,10 +19,10 @@ class Seller extends VendureEntity implements SoftDeletable, HasCustomFields {
|
|
|
19
19
|
channels: Channel[];
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
|
-
* Extends:
|
|
22
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
23
23
|
|
|
24
24
|
|
|
25
|
-
* Implements:
|
|
25
|
+
* Implements: [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable), HasCustomFields
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/session/session.entity.ts" sourceLine="18" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A Session is created when a user makes a request to restricted API operations. A Session can be an
|
|
8
|
-
in the case of un-authenticated users, otherwise it is an
|
|
7
|
+
A Session is created when a user makes a request to restricted API operations. A Session can be an [AnonymousSession](/reference/typescript-api/entities/anonymous-session#anonymoussession)
|
|
8
|
+
in the case of un-authenticated users, otherwise it is an [AuthenticatedSession](/reference/typescript-api/entities/authenticated-session#authenticatedsession).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class Session extends VendureEntity implements HasCustomFields {
|
|
@@ -28,7 +28,7 @@ class Session extends VendureEntity implements HasCustomFields {
|
|
|
28
28
|
customFields: CustomSessionFields;
|
|
29
29
|
}
|
|
30
30
|
```
|
|
31
|
-
* Extends:
|
|
31
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
* Implements: HasCustomFields
|
|
@@ -21,7 +21,7 @@ class SettingsStoreEntry extends VendureEntity {
|
|
|
21
21
|
scope: string | null;
|
|
22
22
|
}
|
|
23
23
|
```
|
|
24
|
-
* Extends:
|
|
24
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/shipping-line/shipping-line.entity.ts" sourceLine="26" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A ShippingLine is created when a
|
|
7
|
+
A ShippingLine is created when a [ShippingMethod](/reference/typescript-api/entities/shipping-method#shippingmethod) is applied to an [Order](/reference/typescript-api/entities/order#order).
|
|
8
8
|
It contains information about the price of the shipping method, any discounts that were
|
|
9
9
|
applied, and the resulting tax on the shipping method.
|
|
10
10
|
|
|
@@ -41,7 +41,7 @@ class ShippingLine extends VendureEntity implements HasCustomFields {
|
|
|
41
41
|
clearAdjustments() => ;
|
|
42
42
|
}
|
|
43
43
|
```
|
|
44
|
-
* Extends:
|
|
44
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
* Implements: HasCustomFields
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/shipping-method/shipping-method.entity.ts" sourceLine="34" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A ShippingMethod is used to apply a shipping price to an
|
|
8
|
-
|
|
7
|
+
A ShippingMethod is used to apply a shipping price to an [Order](/reference/typescript-api/entities/order#order). It is composed of a
|
|
8
|
+
[ShippingEligibilityChecker](/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker) and a [ShippingCalculator](/reference/typescript-api/shipping/shipping-calculator#shippingcalculator). For a given Order,
|
|
9
9
|
the `checker` is used to determine whether this ShippingMethod can be used. If yes, then
|
|
10
10
|
the ShippingMethod can be applied and the `calculator` is used to determine the price of
|
|
11
11
|
shipping.
|
|
@@ -34,10 +34,10 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
|
|
|
34
34
|
toJSON() => any;
|
|
35
35
|
}
|
|
36
36
|
```
|
|
37
|
-
* Extends:
|
|
37
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
38
38
|
|
|
39
39
|
|
|
40
|
-
* Implements:
|
|
40
|
+
* Implements: [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware), [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable), HasCustomFields, [`Translatable`](/reference/typescript-api/entities/interfaces#translatable)
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/stock-level/stock-level.entity.ts" sourceLine="18" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A StockLevel represents the number of a particular
|
|
8
|
-
at a particular
|
|
7
|
+
A StockLevel represents the number of a particular [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant) which are available
|
|
8
|
+
at a particular [StockLocation](/reference/typescript-api/entities/stock-location#stocklocation).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class StockLevel extends VendureEntity implements HasCustomFields {
|
|
@@ -28,7 +28,7 @@ class StockLevel extends VendureEntity implements HasCustomFields {
|
|
|
28
28
|
customFields: CustomStockLevelFields;
|
|
29
29
|
}
|
|
30
30
|
```
|
|
31
|
-
* Extends:
|
|
31
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
* Implements: HasCustomFields
|