@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
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
An EmailSender is responsible for sending the email, e.g. via an SMTP connection
|
|
8
8
|
or using some other mail-sending API. By default, the EmailPlugin uses the
|
|
9
|
-
|
|
9
|
+
[NodemailerEmailSender](/reference/core-plugins/email-plugin/email-sender#nodemaileremailsender), but it is also possible to supply a custom implementation:
|
|
10
10
|
|
|
11
11
|
*Example*
|
|
12
12
|
|
|
@@ -44,7 +44,7 @@ interface EmailSender extends InjectableStrategy {
|
|
|
44
44
|
send: (email: EmailDetails, options: EmailTransportOptions) => void | Promise<void>;
|
|
45
45
|
}
|
|
46
46
|
```
|
|
47
|
-
* Extends:
|
|
47
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
|
|
@@ -67,7 +67,7 @@ class NodemailerEmailSender implements EmailSender {
|
|
|
67
67
|
send(email: EmailDetails, options: EmailTransportOptions) => ;
|
|
68
68
|
}
|
|
69
69
|
```
|
|
70
|
-
* Implements:
|
|
70
|
+
* Implements: [`EmailSender`](/reference/core-plugins/email-plugin/email-sender#emailsender)
|
|
71
71
|
|
|
72
72
|
|
|
73
73
|
|
|
@@ -8,7 +8,7 @@ The EmailPlugin creates and sends transactional emails based on Vendure events.
|
|
|
8
8
|
email generator to generate the email body and [Nodemailer](https://nodemailer.com/about/) to send the emails.
|
|
9
9
|
|
|
10
10
|
## High-level description
|
|
11
|
-
Vendure has an internal events system (see
|
|
11
|
+
Vendure has an internal events system (see [EventBus](/reference/typescript-api/events/event-bus#eventbus)) that allows plugins to subscribe to events. The EmailPlugin is configured with [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)s
|
|
12
12
|
that listen for a specific event and when it is published, the handler defines which template to use to generate the resulting email.
|
|
13
13
|
|
|
14
14
|
The plugin comes with a set of default handler for the following events:
|
|
@@ -17,7 +17,7 @@ The plugin comes with a set of default handler for the following events:
|
|
|
17
17
|
- Password reset request
|
|
18
18
|
- Email address change request
|
|
19
19
|
|
|
20
|
-
You can also create your own handler and register them with the plugin - see the
|
|
20
|
+
You can also create your own handler and register them with the plugin - see the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler) docs for more details.
|
|
21
21
|
|
|
22
22
|
## Installation
|
|
23
23
|
|
|
@@ -188,7 +188,7 @@ EmailPlugin.init({
|
|
|
188
188
|
}),
|
|
189
189
|
```
|
|
190
190
|
|
|
191
|
-
For all available methods of extending a handler, see the
|
|
191
|
+
For all available methods of extending a handler, see the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler) documentation.
|
|
192
192
|
|
|
193
193
|
## Dynamic SMTP settings
|
|
194
194
|
|
|
@@ -224,7 +224,7 @@ const config: VendureConfig = {
|
|
|
224
224
|
## Dev mode
|
|
225
225
|
|
|
226
226
|
For development, the `transport` option can be replaced by `devMode: true`. Doing so configures Vendure to use the
|
|
227
|
-
file transport (See
|
|
227
|
+
file transport (See [FileTransportOptions](/reference/core-plugins/email-plugin/transport-options#filetransportoptions)) and outputs emails as rendered HTML files in the directory specified by the
|
|
228
228
|
`outputPath` property.
|
|
229
229
|
|
|
230
230
|
```ts
|
|
@@ -61,7 +61,7 @@ class FileBasedTemplateLoader implements TemplateLoader {
|
|
|
61
61
|
loadPartials() => Promise<Partial[]>;
|
|
62
62
|
}
|
|
63
63
|
```
|
|
64
|
-
* Implements:
|
|
64
|
+
* Implements: [`TemplateLoader`](/reference/core-plugins/email-plugin/template-loader#templateloader)
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
|
|
@@ -39,7 +39,7 @@ interface SMTPTransportOptions extends SMTPTransport.Options {
|
|
|
39
39
|
|
|
40
40
|
<MemberInfo kind="property" type={`boolean`} default={`false`} />
|
|
41
41
|
|
|
42
|
-
If true, uses the configured
|
|
42
|
+
If true, uses the configured [VendureLogger](/reference/typescript-api/logger/vendure-logger#vendurelogger) to log messages from Nodemailer as it interacts with
|
|
43
43
|
the SMTP server.
|
|
44
44
|
|
|
45
45
|
|
|
@@ -166,7 +166,7 @@ interface FileTransportOptions {
|
|
|
166
166
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="277" packageName="@vendure/email-plugin" />
|
|
167
167
|
|
|
168
168
|
Does nothing with the generated email. Intended for use in testing where we don't care about the email transport,
|
|
169
|
-
or when using a custom
|
|
169
|
+
or when using a custom [EmailSender](/reference/core-plugins/email-plugin/email-sender#emailsender) which does not require transport options.
|
|
170
170
|
|
|
171
171
|
```ts title="Signature"
|
|
172
172
|
interface NoopTransportOptions {
|
|
@@ -36,7 +36,7 @@ A query which exceeds the maximum score will result in an error.
|
|
|
36
36
|
<MemberInfo kind="property" type={`ComplexityEstimator[]`} />
|
|
37
37
|
|
|
38
38
|
An array of custom estimator functions for calculating the complexity of a query. By default,
|
|
39
|
-
the plugin will use the
|
|
39
|
+
the plugin will use the [defaultVendureComplexityEstimator](/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator#defaultvendurecomplexityestimator) which is specifically
|
|
40
40
|
tuned to accurately estimate Vendure queries.
|
|
41
41
|
### logComplexityScore
|
|
42
42
|
|
|
@@ -21,7 +21,7 @@ or
|
|
|
21
21
|
|
|
22
22
|
`npm install @vendure/harden-plugin`
|
|
23
23
|
|
|
24
|
-
Then add the `HardenPlugin`, calling the `.init()` method with
|
|
24
|
+
Then add the `HardenPlugin`, calling the `.init()` method with [HardenPluginOptions](/reference/core-plugins/harden-plugin/harden-plugin-options#hardenpluginoptions):
|
|
25
25
|
|
|
26
26
|
*Example*
|
|
27
27
|
|
|
@@ -79,7 +79,7 @@ query EvilQuery {
|
|
|
79
79
|
This evil query has a complexity score of 2,443,203 - much greater than the default of 1,000!
|
|
80
80
|
|
|
81
81
|
The complexity score is calculated by the [graphql-query-complexity library](https://www.npmjs.com/package/graphql-query-complexity),
|
|
82
|
-
and by default uses the
|
|
82
|
+
and by default uses the [defaultVendureComplexityEstimator](/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator#defaultvendurecomplexityestimator), which is tuned specifically to the Vendure Shop API.
|
|
83
83
|
|
|
84
84
|
:::caution
|
|
85
85
|
Note: By default, if the "take" argument is omitted from a list query (e.g. the `products` or `collections` query), a default factor of 1000 is applied.
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/job-queue-plugin/src/bullmq/bullmq-job-queue-strategy.ts" sourceLine="53" packageName="@vendure/job-queue-plugin" />
|
|
6
6
|
|
|
7
7
|
This JobQueueStrategy uses [BullMQ](https://docs.bullmq.io/) to implement a push-based job queue
|
|
8
|
-
on top of Redis. It should not be used alone, but as part of the
|
|
8
|
+
on top of Redis. It should not be used alone, but as part of the [BullMQJobQueuePlugin](/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin).
|
|
9
9
|
|
|
10
10
|
Note: To use this strategy, you need to manually install the `bullmq` package:
|
|
11
11
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/job-queue-plugin/src/bullmq/types.ts" sourceLine="21" packageName="@vendure/job-queue-plugin" since="1.2.0" />
|
|
6
6
|
|
|
7
|
-
Configuration options for the
|
|
7
|
+
Configuration options for the [BullMQJobQueuePlugin](/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface BullMQPluginOptions {
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/job-queue-plugin/src/pub-sub/pub-sub-job-queue-strategy.ts" sourceLine="29" packageName="@vendure/job-queue-plugin" />
|
|
6
6
|
|
|
7
7
|
This JobQueueStrategy uses Google Cloud Pub/Sub to implement a job queue for Vendure.
|
|
8
|
-
It should not be used alone, but as part of the
|
|
8
|
+
It should not be used alone, but as part of the [PubSubPlugin](/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin).
|
|
9
9
|
|
|
10
10
|
Note: To use this strategy, you need to manually install the `@google-cloud/pubsub` package:
|
|
11
11
|
|
|
@@ -37,7 +37,7 @@ the Stripe CLI to test your webhook locally. See the _local development_ section
|
|
|
37
37
|
}),
|
|
38
38
|
]
|
|
39
39
|
````
|
|
40
|
-
For all the plugin options, see the
|
|
40
|
+
For all the plugin options, see the [StripePluginOptions](/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions) type.
|
|
41
41
|
2. Create a new PaymentMethod in the Admin UI, and select "Stripe payments" as the handler.
|
|
42
42
|
3. Set the webhook secret and API key in the PaymentMethod form.
|
|
43
43
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/sentry-plugin/src/types.ts" sourceLine="7" packageName="@vendure/sentry-plugin" />
|
|
6
6
|
|
|
7
|
-
Configuration options for the
|
|
7
|
+
Configuration options for the [SentryPlugin](/reference/core-plugins/sentry-plugin/#sentryplugin).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface SentryPluginOptions {
|
|
@@ -25,7 +25,7 @@ npm install @vendure/stellate-plugin
|
|
|
25
25
|
## Configuration
|
|
26
26
|
|
|
27
27
|
The plugin is configured via the `StellatePlugin.init()` method. This method accepts an options object
|
|
28
|
-
which defines the Stellate service name and API token, as well as an array of
|
|
28
|
+
which defines the Stellate service name and API token, as well as an array of [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule)s which
|
|
29
29
|
define how the plugin will respond to Vendure events in order to trigger calls to the
|
|
30
30
|
Stellate [Purging API](https://stellate.co/docs/graphql-edge-cache/purging-api).
|
|
31
31
|
|
|
@@ -148,7 +148,7 @@ export const searchProductsDocument = graphql(`
|
|
|
148
148
|
|
|
149
149
|
The configuration above only accounts for caching of some of the built-in Vendure entity types. If you have
|
|
150
150
|
custom entity types, you may well want to add them to the Stellate cache. In this case, you'll also need a way to
|
|
151
|
-
purge those entities from the cache when they are updated. This is where the
|
|
151
|
+
purge those entities from the cache when they are updated. This is where the [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule) comes in.
|
|
152
152
|
|
|
153
153
|
Let's imagine that you have built a simple CMS plugin for Vendure which exposes an `Article` entity in your Shop API, and
|
|
154
154
|
you have added this to your Stellate configuration:
|
|
@@ -176,7 +176,7 @@ const config: Config = {
|
|
|
176
176
|
export default config;
|
|
177
177
|
```
|
|
178
178
|
|
|
179
|
-
You can then add a custom
|
|
179
|
+
You can then add a custom [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule) to the StellatePlugin configuration:
|
|
180
180
|
|
|
181
181
|
*Example*
|
|
182
182
|
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
Defines a rule that listens for a particular VendureEvent and uses that to
|
|
8
8
|
make calls to the [Stellate Purging API](https://docs.stellate.co/docs/purging-api) via
|
|
9
|
-
the provided
|
|
9
|
+
the provided [StellateService](/reference/core-plugins/stellate-plugin/stellate-service#stellateservice) instance.
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
class PurgeRule<Event extends VendureEvent = VendureEvent> {
|
|
@@ -44,7 +44,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
|
|
|
44
44
|
</div>
|
|
45
45
|
<GenerationInfo sourceFile="packages/stellate-plugin/src/purge-rule.ts" sourceLine="13" packageName="@vendure/stellate-plugin" />
|
|
46
46
|
|
|
47
|
-
Configures a
|
|
47
|
+
Configures a [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule).
|
|
48
48
|
|
|
49
49
|
```ts title="Signature"
|
|
50
50
|
interface PurgeRuleConfig<Event extends VendureEvent> {
|
|
@@ -76,7 +76,7 @@ us to efficiently batch calls to the Stellate Purge API.
|
|
|
76
76
|
<MemberInfo kind="property" type={`(handlerArgs: { events: Event[]; stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>; injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>; }) => void | Promise<void>`} />
|
|
77
77
|
|
|
78
78
|
The function to invoke when the specified event is published. This function should use the
|
|
79
|
-
|
|
79
|
+
[StellateService](/reference/core-plugins/stellate-plugin/stellate-service#stellateservice) instance to call the Stellate Purge API.
|
|
80
80
|
|
|
81
81
|
|
|
82
82
|
</div>
|
|
@@ -34,7 +34,7 @@ see the [Stellate docs](https://docs.stellate.co/docs/purging-api#authentication
|
|
|
34
34
|
|
|
35
35
|
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a>[]`} />
|
|
36
36
|
|
|
37
|
-
An array of
|
|
37
|
+
An array of [PurgeRule](/reference/core-plugins/stellate-plugin/purge-rule#purgerule) instances which are used to define how the plugin will
|
|
38
38
|
respond to Vendure events in order to trigger calls to the Stellate Purging API.
|
|
39
39
|
### defaultBufferTimeMs
|
|
40
40
|
|
|
@@ -16,7 +16,7 @@ class OtelLogger implements VendureLogger {
|
|
|
16
16
|
verbose(message: string, context?: string) => void;
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Implements:
|
|
19
|
+
* Implements: [`VendureLogger`](/reference/typescript-api/logger/vendure-logger#vendurelogger)
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -7,7 +7,7 @@ generated: true
|
|
|
7
7
|
Allows you to register hooks for a specific method of an instrumented class.
|
|
8
8
|
These hooks allow extra telemetry actions to be performed on the method.
|
|
9
9
|
|
|
10
|
-
They can then be passed to the
|
|
10
|
+
They can then be passed to the [TelemetryPlugin](/reference/core-plugins/telemetry-plugin/#telemetryplugin) via the [TelemetryPluginOptions](/reference/core-plugins/telemetry-plugin/telemetry-plugin-options#telemetrypluginoptions).
|
|
11
11
|
|
|
12
12
|
*Example*
|
|
13
13
|
|
|
@@ -41,7 +41,7 @@ TelemetryPlugin.init({
|
|
|
41
41
|
This API may change in a future release.
|
|
42
42
|
|
|
43
43
|
Method hooks allow you to add extra telemetry actions to specific methods.
|
|
44
|
-
To define hooks on a method, use the
|
|
44
|
+
To define hooks on a method, use the [registerMethodHooks](/reference/core-plugins/telemetry-plugin/register-method-hooks#registermethodhooks) function.
|
|
45
45
|
|
|
46
46
|
*Example*
|
|
47
47
|
|
|
@@ -29,7 +29,7 @@ Parameters
|
|
|
29
29
|
|
|
30
30
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-gallery.tsx" sourceLine="83" packageName="@vendure/dashboard" />
|
|
31
31
|
|
|
32
|
-
Props for the
|
|
32
|
+
Props for the [AssetGallery](/reference/dashboard/components/asset-gallery#assetgallery) component.
|
|
33
33
|
|
|
34
34
|
```ts title="Signature"
|
|
35
35
|
interface AssetGalleryProps {
|
|
@@ -17,7 +17,7 @@ Parameters
|
|
|
17
17
|
|
|
18
18
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-picker-dialog.tsx" sourceLine="19" packageName="@vendure/dashboard" />
|
|
19
19
|
|
|
20
|
-
Props for the
|
|
20
|
+
Props for the [AssetPickerDialog](/reference/dashboard/components/asset-picker-dialog#assetpickerdialog) component.
|
|
21
21
|
|
|
22
22
|
```ts title="Signature"
|
|
23
23
|
interface AssetPickerDialogProps {
|
|
@@ -37,7 +37,7 @@ Parameters
|
|
|
37
37
|
|
|
38
38
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="59" packageName="@vendure/dashboard" since="3.4.0" />
|
|
39
39
|
|
|
40
|
-
The props for the
|
|
40
|
+
The props for the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
|
|
41
41
|
|
|
42
42
|
```ts title="Signature"
|
|
43
43
|
interface VendureImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
|
|
@@ -115,7 +115,7 @@ The ref to the image element.
|
|
|
115
115
|
</div>
|
|
116
116
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="13" packageName="@vendure/dashboard" since="3.4.0" />
|
|
117
117
|
|
|
118
|
-
The type of object that can be used as an asset in the
|
|
118
|
+
The type of object that can be used as an asset in the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
|
|
119
119
|
|
|
120
120
|
```ts title="Signature"
|
|
121
121
|
interface AssetLike {
|
|
@@ -153,21 +153,21 @@ interface AssetLike {
|
|
|
153
153
|
</div>
|
|
154
154
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="28" packageName="@vendure/dashboard" since="3.4.0" />
|
|
155
155
|
|
|
156
|
-
The presets that can be used for the
|
|
156
|
+
The presets that can be used for the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
|
|
157
157
|
|
|
158
158
|
```ts title="Signature"
|
|
159
159
|
type ImagePreset = 'tiny' | 'thumb' | 'small' | 'medium' | 'large' | 'full' | null
|
|
160
160
|
```
|
|
161
161
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="38" packageName="@vendure/dashboard" since="3.4.0" />
|
|
162
162
|
|
|
163
|
-
The formats that can be used for the
|
|
163
|
+
The formats that can be used for the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
|
|
164
164
|
|
|
165
165
|
```ts title="Signature"
|
|
166
166
|
type ImageFormat = 'jpg' | 'jpeg' | 'png' | 'webp' | 'avif' | null
|
|
167
167
|
```
|
|
168
168
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="48" packageName="@vendure/dashboard" since="3.4.0" />
|
|
169
169
|
|
|
170
|
-
The modes that can be used for the
|
|
170
|
+
The modes that can be used for the [VendureImage](/reference/dashboard/components/vendure-image#vendureimage) component.
|
|
171
171
|
|
|
172
172
|
```ts title="Signature"
|
|
173
173
|
type ImageMode = 'crop' | 'resize' | null
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
Auto-generates a detail page with a form based on the provided query and mutation documents.
|
|
8
8
|
|
|
9
|
-
For more control over the layout, you would use the more low-level
|
|
9
|
+
For more control over the layout, you would use the more low-level [Page](/reference/dashboard/page-layout/page#page) component.
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
function DetailPage<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>>(props: DetailPageProps<T, C, U>): void
|
|
@@ -19,7 +19,7 @@ Parameters
|
|
|
19
19
|
|
|
20
20
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="43" packageName="@vendure/dashboard" since="3.3.0" />
|
|
21
21
|
|
|
22
|
-
Props to configure the
|
|
22
|
+
Props to configure the [DetailPage](/reference/dashboard/detail-views/detail-page#detailpage) component.
|
|
23
23
|
|
|
24
24
|
```ts title="Signature"
|
|
25
25
|
interface DetailPageProps<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>, EntityField extends keyof ResultOf<T> = DetailEntityPath<T>> {
|
|
@@ -8,7 +8,7 @@ This hook is used to create a form from a document and an entity.
|
|
|
8
8
|
It will create a form with the fields defined in the document's input type.
|
|
9
9
|
It will also create a submit handler that will submit the form to the server.
|
|
10
10
|
|
|
11
|
-
This hook is mostly used internally by the higher-level
|
|
11
|
+
This hook is mostly used internally by the higher-level [useDetailPage](/reference/dashboard/detail-views/use-detail-page#usedetailpage) hook,
|
|
12
12
|
but can in some cases be useful to use directly.
|
|
13
13
|
|
|
14
14
|
*Example*
|
|
@@ -92,7 +92,7 @@ type DashboardFormComponentProps<TFieldValues extends FieldValues = FieldValues,
|
|
|
92
92
|
```
|
|
93
93
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/form-engine-types.ts" sourceLine="124" packageName="@vendure/dashboard" since="3.4.0" />
|
|
94
94
|
|
|
95
|
-
Metadata which can be defined on a
|
|
95
|
+
Metadata which can be defined on a [DashboardFormComponent](/reference/dashboard/extensions-api/form-components#dashboardformcomponent) which
|
|
96
96
|
provides additional information about how the dashboard should render the
|
|
97
97
|
component.
|
|
98
98
|
|
|
@@ -54,14 +54,14 @@ The `type` should correspond to a valid `HistoryEntryType`, such as
|
|
|
54
54
|
|
|
55
55
|
- `CUSTOMER_REGISTERED`
|
|
56
56
|
- `ORDER_STATE_TRANSITION`
|
|
57
|
-
- some custom type - see the
|
|
57
|
+
- some custom type - see the [HistoryService](/reference/typescript-api/services/history-service#historyservice) docs for a guide on
|
|
58
58
|
how to define custom history entry types.
|
|
59
59
|
### component
|
|
60
60
|
|
|
61
61
|
<MemberInfo kind="property" type={`React.ComponentType<{ entry: <a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>; entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail; }>`} />
|
|
62
62
|
|
|
63
63
|
The component which is used to render the timeline entry. It should use the
|
|
64
|
-
|
|
64
|
+
[HistoryEntry](/reference/dashboard/extensions-api/history-entries#historyentry) component and pass the appropriate props to configure
|
|
65
65
|
how it will be displayed.
|
|
66
66
|
|
|
67
67
|
The `entity` prop will be a subset of the Order object for Order history entries,
|
|
@@ -142,7 +142,7 @@ and the `ORDER_STATE_TRANSITION` data looks like this:
|
|
|
142
142
|
</div>
|
|
143
143
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/history-entry/history-entry.tsx" sourceLine="14" packageName="@vendure/dashboard" since="3.4.3" />
|
|
144
144
|
|
|
145
|
-
The props for the
|
|
145
|
+
The props for the [HistoryEntry](/reference/dashboard/extensions-api/history-entries#historyentry) component.
|
|
146
146
|
|
|
147
147
|
```ts title="Signature"
|
|
148
148
|
interface HistoryEntryProps {
|
|
@@ -30,7 +30,7 @@ overridden form components.
|
|
|
30
30
|
</PageBlock>
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
If you are dealing with translatable fields, use the
|
|
33
|
+
If you are dealing with translatable fields, use the [TranslatableFormFieldWrapper](/reference/dashboard/form-components/translatable-form-field-wrapper#translatableformfieldwrapper) component instead.
|
|
34
34
|
|
|
35
35
|
```ts title="Signature"
|
|
36
36
|
function FormFieldWrapper<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: FormFieldWrapperProps<TFieldValues, TName>): void
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/translatable-form-field.tsx" sourceLine="112" packageName="@vendure/dashboard" since="3.4.0" />
|
|
6
6
|
|
|
7
|
-
This is the equivalent of the
|
|
7
|
+
This is the equivalent of the [FormFieldWrapper](/reference/dashboard/form-components/form-field-wrapper#formfieldwrapper) component, but for translatable fields.
|
|
8
8
|
|
|
9
9
|
*Example*
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/hooks/use-auth.tsx" sourceLine="15" packageName="@vendure/dashboard" since="3.3.0" />
|
|
6
6
|
|
|
7
|
-
Provides access to the
|
|
7
|
+
Provides access to the [AuthContext](/reference/dashboard/hooks/use-auth#authcontext) which contains information
|
|
8
8
|
about the active channel.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/hooks/use-channel.ts" sourceLine="21" packageName="@vendure/dashboard" since="3.3.0" />
|
|
6
6
|
|
|
7
|
-
Provides access to the
|
|
7
|
+
Provides access to the [ChannelContext](/reference/dashboard/hooks/use-channel#channelcontext) which contains information
|
|
8
8
|
about the active channel.
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
@@ -19,7 +19,7 @@ Parameters
|
|
|
19
19
|
|
|
20
20
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-table/data-table.tsx" sourceLine="113" packageName="@vendure/dashboard" since="3.4.0" />
|
|
21
21
|
|
|
22
|
-
Props for configuring the
|
|
22
|
+
Props for configuring the [DataTable](/reference/dashboard/list-views/data-table#datatable).
|
|
23
23
|
|
|
24
24
|
```ts title="Signature"
|
|
25
25
|
interface DataTableProps<TData> {
|
|
@@ -103,7 +103,7 @@ Parameters
|
|
|
103
103
|
|
|
104
104
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/list-page.tsx" sourceLine="36" packageName="@vendure/dashboard" since="3.3.0" />
|
|
105
105
|
|
|
106
|
-
Props to configure the
|
|
106
|
+
Props to configure the [ListPage](/reference/dashboard/list-views/list-page#listpage) component.
|
|
107
107
|
|
|
108
108
|
```ts title="Signature"
|
|
109
109
|
interface ListPageProps<T extends TypedDocumentNode<U, V>, U extends ListQueryShape, V extends ListQueryOptionsShape, AC extends AdditionalColumns<T>> {
|
|
@@ -435,7 +435,7 @@ Bulk actions are actions that can be applied to one or more table rows, and incl
|
|
|
435
435
|
- Assigning the rows to another channel
|
|
436
436
|
- Bulk editing some aspect of the rows
|
|
437
437
|
|
|
438
|
-
See the
|
|
438
|
+
See the [BulkAction](/reference/dashboard/list-views/bulk-actions#bulkaction) docs for an example of how to build the component.
|
|
439
439
|
|
|
440
440
|
*Example*
|
|
441
441
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="366" packageName="@vendure/dashboard" since="3.4.0" />
|
|
6
6
|
|
|
7
|
-
A wrapper around the
|
|
7
|
+
A wrapper around the [DataTable](/reference/dashboard/list-views/data-table#datatable) component, which automatically configures functionality common to
|
|
8
8
|
list queries that implement the `PaginatedList` interface, which is the common way of representing lists
|
|
9
9
|
of data in Vendure.
|
|
10
10
|
|
|
@@ -119,7 +119,7 @@ Parameters
|
|
|
119
119
|
|
|
120
120
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/paginated-list-data-table.tsx" sourceLine="202" packageName="@vendure/dashboard" since="3.4.0" />
|
|
121
121
|
|
|
122
|
-
Props to configure the
|
|
122
|
+
Props to configure the [PaginatedListDataTable](/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatable) component.
|
|
123
123
|
|
|
124
124
|
```ts title="Signature"
|
|
125
125
|
interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U extends ListQueryShape, V extends ListQueryOptionsShape, AC extends AdditionalColumns<T>> {
|
|
@@ -5,8 +5,8 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="211" packageName="@vendure/dashboard" since="3.3.0" />
|
|
6
6
|
|
|
7
7
|
*
|
|
8
|
-
This component governs the layout of the contents of a
|
|
9
|
-
It should contain all the
|
|
8
|
+
This component governs the layout of the contents of a [Page](/reference/dashboard/page-layout/page#page) component.
|
|
9
|
+
It should contain all the [PageBlock](/reference/dashboard/page-layout/page-block#pageblock) components that are to be displayed on the page.
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
function PageLayout(props: Readonly<PageLayoutProps>): void
|
|
@@ -5,8 +5,8 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="351" packageName="@vendure/dashboard" since="3.3.0" />
|
|
6
6
|
|
|
7
7
|
*
|
|
8
|
-
A component for displaying the main actions for a page. This should be used inside the
|
|
9
|
-
It should be used in conjunction with the
|
|
8
|
+
A component for displaying the main actions for a page. This should be used inside the [Page](/reference/dashboard/page-layout/page#page) component.
|
|
9
|
+
It should be used in conjunction with the [PageActionBarLeft](/reference/dashboard/page-layout/page-action-bar#pageactionbarleft) and [PageActionBarRight](/reference/dashboard/page-layout/page-action-bar#pageactionbarright) components
|
|
10
10
|
as direct children.
|
|
11
11
|
|
|
12
12
|
```ts title="Signature"
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="591" packageName="@vendure/dashboard" since="3.3.0" />
|
|
6
6
|
|
|
7
7
|
*
|
|
8
|
-
A component for displaying a block of content on a page. This should be used inside the
|
|
8
|
+
A component for displaying a block of content on a page. This should be used inside the [PageLayout](/reference/dashboard/page-layout/#pagelayout) component.
|
|
9
9
|
It should be provided with a `column` prop to determine which column it should appear in, and a `blockId` prop
|
|
10
10
|
to identify the block.
|
|
11
11
|
|
|
@@ -28,7 +28,7 @@ Parameters
|
|
|
28
28
|
|
|
29
29
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="540" packageName="@vendure/dashboard" since="3.3.0" />
|
|
30
30
|
|
|
31
|
-
Props used to configure the
|
|
31
|
+
Props used to configure the [PageBlock](/reference/dashboard/page-layout/page-block#pageblock) component.
|
|
32
32
|
|
|
33
33
|
```ts title="Signature"
|
|
34
34
|
type PageBlockProps = {
|
|
@@ -81,7 +81,7 @@ An optional set of CSS classes to apply to the block.
|
|
|
81
81
|
**Status: Developer Preview**
|
|
82
82
|
|
|
83
83
|
A component for displaying a block of content on a page that takes up the full width of the page.
|
|
84
|
-
This should be used inside the
|
|
84
|
+
This should be used inside the [PageLayout](/reference/dashboard/page-layout/#pagelayout) component.
|
|
85
85
|
|
|
86
86
|
```ts title="Signature"
|
|
87
87
|
function FullWidthPageBlock(props: Readonly<Pick<PageBlockProps, 'children' | 'className' | 'blockId'>>): void
|
|
@@ -96,7 +96,7 @@ Parameters
|
|
|
96
96
|
|
|
97
97
|
*
|
|
98
98
|
A component for displaying an auto-generated form for custom fields on a page.
|
|
99
|
-
This is a special form of
|
|
99
|
+
This is a special form of [PageBlock](/reference/dashboard/page-layout/page-block#pageblock) that automatically generates
|
|
100
100
|
a form corresponding to the custom fields for the given entity type.
|
|
101
101
|
|
|
102
102
|
*Example*
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="336" packageName="@vendure/dashboard" since="3.3.0" />
|
|
6
6
|
|
|
7
|
-
A component for displaying the title of a page. This should be used inside the
|
|
7
|
+
A component for displaying the title of a page. This should be used inside the [Page](/reference/dashboard/page-layout/page#page) component.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
function PageTitle(props: Readonly<{ children: React.ReactNode }>): void
|
|
@@ -9,9 +9,9 @@ a consistent layout as well as a context for the slot-based PageBlock system.
|
|
|
9
9
|
|
|
10
10
|
The typical hierarchy of a page is as follows:
|
|
11
11
|
- `Page`
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
12
|
+
- [PageTitle](/reference/dashboard/page-layout/page-title#pagetitle)
|
|
13
|
+
- [PageActionBar](/reference/dashboard/page-layout/page-action-bar#pageactionbar)
|
|
14
|
+
- [PageLayout](/reference/dashboard/page-layout/#pagelayout)
|
|
15
15
|
|
|
16
16
|
*Example*
|
|
17
17
|
|
|
@@ -50,7 +50,7 @@ Parameters
|
|
|
50
50
|
|
|
51
51
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="38" packageName="@vendure/dashboard" since="3.3.0" />
|
|
52
52
|
|
|
53
|
-
The props used to configure the
|
|
53
|
+
The props used to configure the [Page](/reference/dashboard/page-layout/page#page) component.
|
|
54
54
|
|
|
55
55
|
```ts title="Signature"
|
|
56
56
|
interface PageProps extends ComponentProps<'div'> {
|