@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
|
@@ -22,7 +22,7 @@ class DataService {
|
|
|
22
22
|
|
|
23
23
|
<MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} />
|
|
24
24
|
|
|
25
|
-
Perform a GraphQL query. Returns a
|
|
25
|
+
Perform a GraphQL query. Returns a [QueryResult](/reference/admin-ui-api/services/data-service#queryresult) which allows further control over
|
|
26
26
|
they type of result returned, e.g. stream of values, single value etc.
|
|
27
27
|
|
|
28
28
|
*Example*
|
|
@@ -26,7 +26,7 @@ class ModalService {
|
|
|
26
26
|
|
|
27
27
|
<MemberInfo kind="method" type={`(component: Type<T> & Type<<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a><R>>, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a><T>) => Observable<R | undefined>`} />
|
|
28
28
|
|
|
29
|
-
Create a modal from a component. The component must implement the
|
|
29
|
+
Create a modal from a component. The component must implement the [Dialog](/reference/admin-ui-api/services/modal-service#dialog) interface.
|
|
30
30
|
Additionally, the component should include templates for the title and the buttons to be
|
|
31
31
|
displayed in the modal dialog. See example:
|
|
32
32
|
|
|
@@ -12,9 +12,7 @@ See [Extending the Admin UI](/extending-the-admin-ui/getting-started/) for
|
|
|
12
12
|
detailed instructions.
|
|
13
13
|
|
|
14
14
|
```ts title="Signature"
|
|
15
|
-
interface AdminUiExtension extends Partial<TranslationExtension>,
|
|
16
|
-
Partial<StaticAssetExtension>,
|
|
17
|
-
Partial<GlobalStylesExtension> {
|
|
15
|
+
interface AdminUiExtension extends Partial<TranslationExtension>, Partial<StaticAssetExtension>, Partial<GlobalStylesExtension> {
|
|
18
16
|
id?: string;
|
|
19
17
|
extensionPath: string;
|
|
20
18
|
ngModules?: Array<AdminUiExtensionSharedModule | AdminUiExtensionLazyModule>;
|
|
@@ -24,7 +22,7 @@ interface AdminUiExtension extends Partial<TranslationExtension>,
|
|
|
24
22
|
exclude?: string[];
|
|
25
23
|
}
|
|
26
24
|
```
|
|
27
|
-
* Extends: `Partial
|
|
25
|
+
* Extends: `Partial<`[`TranslationExtension`](/reference/admin-ui-api/ui-devkit/admin-ui-extension#translationextension)`>`, `Partial<`[`StaticAssetExtension`](/reference/admin-ui-api/ui-devkit/admin-ui-extension#staticassetextension)`>`, `Partial<`[`GlobalStylesExtension`](/reference/admin-ui-api/ui-devkit/admin-ui-extension#globalstylesextension)`>`
|
|
28
26
|
|
|
29
27
|
|
|
30
28
|
|
|
@@ -165,7 +163,7 @@ exclude: ['**/*.spec.ts']
|
|
|
165
163
|
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="18" packageName="@vendure/ui-devkit" />
|
|
166
164
|
|
|
167
165
|
Defines extensions to the Admin UI translations. Can be used as a stand-alone extension definition which only adds translations
|
|
168
|
-
without adding new UI functionality, or as part of a full
|
|
166
|
+
without adding new UI functionality, or as part of a full [AdminUiExtension](/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextension).
|
|
169
167
|
|
|
170
168
|
```ts title="Signature"
|
|
171
169
|
interface TranslationExtension {
|
|
@@ -295,7 +293,7 @@ This is useful when the extension is intended to replace the default Admin UI, r
|
|
|
295
293
|
|
|
296
294
|
|
|
297
295
|
</div>
|
|
298
|
-
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="
|
|
296
|
+
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="278" packageName="@vendure/ui-devkit" />
|
|
299
297
|
|
|
300
298
|
A static asset can be provided as a path to the asset, or as an object containing a path and a new
|
|
301
299
|
name, which will cause the compiler to copy and then rename the asset.
|
|
@@ -303,7 +301,7 @@ name, which will cause the compiler to copy and then rename the asset.
|
|
|
303
301
|
```ts title="Signature"
|
|
304
302
|
type StaticAssetDefinition = string | { path: string; rename: string }
|
|
305
303
|
```
|
|
306
|
-
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="
|
|
304
|
+
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="287" packageName="@vendure/ui-devkit" />
|
|
307
305
|
|
|
308
306
|
Configuration defining a single NgModule with which to extend the Admin UI.
|
|
309
307
|
|
|
@@ -337,7 +335,7 @@ The name of the extension module class.
|
|
|
337
335
|
|
|
338
336
|
|
|
339
337
|
</div>
|
|
340
|
-
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="
|
|
338
|
+
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="314" packageName="@vendure/ui-devkit" />
|
|
341
339
|
|
|
342
340
|
Configuration defining a single NgModule with which to extend the Admin UI.
|
|
343
341
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: "UiExtensionBuildCommand"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="
|
|
5
|
+
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="354" packageName="@vendure/ui-devkit" />
|
|
6
6
|
|
|
7
7
|
The package manager to use when invoking the Angular CLI to build UI extensions.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: "UiExtensionCompilerOptions"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="
|
|
5
|
+
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="362" packageName="@vendure/ui-devkit" />
|
|
6
6
|
|
|
7
7
|
Options to configure how the Admin UI should be compiled.
|
|
8
8
|
|
|
@@ -68,7 +68,7 @@ Allows the baseHref of the compiled Admin UI app to be set. This determines the
|
|
|
68
68
|
of the app, for example with the default value of `'/admin/'`, the Admin UI app
|
|
69
69
|
will be configured to be served from `http://<host>/admin/`.
|
|
70
70
|
|
|
71
|
-
Note: if you are using this in conjunction with the
|
|
71
|
+
Note: if you are using this in conjunction with the [AdminUiPlugin](/reference/core-plugins/admin-ui-plugin/#adminuiplugin) then you should
|
|
72
72
|
also set the `route` option to match this value.
|
|
73
73
|
|
|
74
74
|
*Example*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: "UiExtensionCompilerProcessArgument"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="
|
|
5
|
+
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="346" packageName="@vendure/ui-devkit" />
|
|
6
6
|
|
|
7
7
|
Argument to configure process (watch or compile)
|
|
8
8
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="44" packageName="@vendure/admin-ui-plugin" />
|
|
6
6
|
|
|
7
|
-
Configuration options for the
|
|
7
|
+
Configuration options for the [AdminUiPlugin](/reference/core-plugins/admin-ui-plugin/#adminuiplugin).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface AdminUiPluginOptions {
|
|
@@ -35,7 +35,7 @@ The route to the asset server.
|
|
|
35
35
|
|
|
36
36
|
<MemberInfo kind="property" type={`string`} />
|
|
37
37
|
|
|
38
|
-
The local directory to which assets will be uploaded when using the
|
|
38
|
+
The local directory to which assets will be uploaded when using the [LocalAssetStorageStrategy](/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy).
|
|
39
39
|
### assetUrlPrefix
|
|
40
40
|
|
|
41
41
|
<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) => string)`} />
|
|
@@ -61,7 +61,7 @@ The max height in pixels of a generated preview image.
|
|
|
61
61
|
|
|
62
62
|
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset'>ImageTransformPreset</a>[]`} />
|
|
63
63
|
|
|
64
|
-
An array of additional
|
|
64
|
+
An array of additional [ImageTransformPreset](/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset) objects.
|
|
65
65
|
### imageTransformStrategy
|
|
66
66
|
|
|
67
67
|
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy'>ImageTransformStrategy</a> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy'>ImageTransformStrategy</a>[]`} default={`[]`} since="3.1.0" />
|
|
@@ -83,13 +83,13 @@ Defines how asset files and preview images are named before being saved.
|
|
|
83
83
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a>`} since="1.7.0" />
|
|
84
84
|
|
|
85
85
|
Defines how previews are generated for a given Asset binary. By default, this uses
|
|
86
|
-
the
|
|
86
|
+
the [SharpAssetPreviewStrategy](/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy)
|
|
87
87
|
### storageStrategyFactory
|
|
88
88
|
|
|
89
89
|
<MemberInfo kind="property" type={`( options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>, ) => <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise<<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>>`} default={`() => <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`} />
|
|
90
90
|
|
|
91
|
-
A function which can be used to configure an
|
|
92
|
-
using a cloud storage provider. By default, the
|
|
91
|
+
A function which can be used to configure an [AssetStorageStrategy](/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy). This is useful e.g. if you wish to store your assets
|
|
92
|
+
using a cloud storage provider. By default, the [LocalAssetStorageStrategy](/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy) is used.
|
|
93
93
|
### cacheHeader
|
|
94
94
|
|
|
95
95
|
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/cache-config#cacheconfig'>CacheConfig</a> | string`} default={`'public, max-age=15552000'`} since="1.9.3" />
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/asset-server-plugin/src/config/hashed-asset-naming-strategy.ts" sourceLine="20" packageName="@vendure/asset-server-plugin" />
|
|
6
6
|
|
|
7
|
-
An extension of the
|
|
7
|
+
An extension of the [DefaultAssetNamingStrategy](/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy) which prefixes file names with
|
|
8
8
|
the type (`'source'` or `'preview'`) as well as a 2-character sub-directory based on
|
|
9
9
|
the md5 hash of the original file name.
|
|
10
10
|
|
|
@@ -21,7 +21,7 @@ class HashedAssetNamingStrategy extends DefaultAssetNamingStrategy {
|
|
|
21
21
|
generatePreviewFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string) => string;
|
|
22
22
|
}
|
|
23
23
|
```
|
|
24
|
-
* Extends:
|
|
24
|
+
* Extends: [`DefaultAssetNamingStrategy`](/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy)
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -21,7 +21,7 @@ interface ImageTransformStrategy extends InjectableStrategy {
|
|
|
21
21
|
): Promise<ImageTransformParameters> | ImageTransformParameters;
|
|
22
22
|
}
|
|
23
23
|
```
|
|
24
|
-
* Extends:
|
|
24
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/asset-server-plugin/src/plugin.ts" sourceLine="176" packageName="@vendure/asset-server-plugin" />
|
|
6
6
|
|
|
7
7
|
The `AssetServerPlugin` serves assets (images and other files) from the local file system, and can also be configured to use
|
|
8
|
-
other storage strategies (e.g.
|
|
8
|
+
other storage strategies (e.g. [S3AssetStorageStrategy](/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3assetstoragestrategy). It can also perform on-the-fly image transformations
|
|
9
9
|
and caches the results for subsequent calls.
|
|
10
10
|
|
|
11
11
|
## Installation
|
|
@@ -127,11 +127,11 @@ a given configuration. Caching can be disabled per-request by setting the `?cach
|
|
|
127
127
|
### Limiting transformations
|
|
128
128
|
|
|
129
129
|
By default, the AssetServerPlugin will allow any transformation to be performed on an image. However, it is possible to restrict the transformations
|
|
130
|
-
which can be performed by using an
|
|
130
|
+
which can be performed by using an [ImageTransformStrategy](/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy). This can be used to limit the transformations to a known set of presets, for example.
|
|
131
131
|
|
|
132
132
|
This is advisable in order to prevent abuse of the image transformation feature, as it can be computationally expensive.
|
|
133
133
|
|
|
134
|
-
Since v3.1.0 we ship with a
|
|
134
|
+
Since v3.1.0 we ship with a [PresetOnlyStrategy](/reference/core-plugins/asset-server-plugin/preset-only-strategy#presetonlystrategy) which allows only transformations using a known set of presets.
|
|
135
135
|
|
|
136
136
|
*Example*
|
|
137
137
|
|
|
@@ -18,7 +18,7 @@ class LocalAssetStorageStrategy implements AssetStorageStrategy {
|
|
|
18
18
|
deleteFile(identifier: string) => Promise<void>;
|
|
19
19
|
}
|
|
20
20
|
```
|
|
21
|
-
* Implements:
|
|
21
|
+
* Implements: [`AssetStorageStrategy`](/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy)
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/asset-server-plugin/src/config/preset-only-strategy.ts" sourceLine="85" packageName="@vendure/asset-server-plugin" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
An
|
|
7
|
+
An [ImageTransformStrategy](/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy) which only allows transformations to be made using
|
|
8
8
|
presets which are defined in the available presets.
|
|
9
9
|
|
|
10
10
|
With this strategy enabled, requests to the asset server must include a `preset` parameter (or use the default preset)
|
|
@@ -45,7 +45,7 @@ class PresetOnlyStrategy implements ImageTransformStrategy {
|
|
|
45
45
|
}: GetImageTransformParametersArgs) => Promise<ImageTransformParameters> | ImageTransformParameters;
|
|
46
46
|
}
|
|
47
47
|
```
|
|
48
|
-
* Implements:
|
|
48
|
+
* Implements: [`ImageTransformStrategy`](/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformstrategy)
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
|
|
@@ -69,7 +69,7 @@ class PresetOnlyStrategy implements ImageTransformStrategy {
|
|
|
69
69
|
</div>
|
|
70
70
|
<GenerationInfo sourceFile="packages/asset-server-plugin/src/config/preset-only-strategy.ts" sourceLine="16" packageName="@vendure/asset-server-plugin" />
|
|
71
71
|
|
|
72
|
-
Configuration options for the
|
|
72
|
+
Configuration options for the [PresetOnlyStrategy](/reference/core-plugins/asset-server-plugin/preset-only-strategy#presetonlystrategy).
|
|
73
73
|
|
|
74
74
|
```ts title="Signature"
|
|
75
75
|
interface PresetOnlyStrategyOptions {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/asset-server-plugin/src/config/s3-asset-storage-strategy.ts" sourceLine="155" packageName="@vendure/asset-server-plugin" />
|
|
6
6
|
|
|
7
|
-
An
|
|
7
|
+
An [AssetStorageStrategy](/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy) which uses [Amazon S3](https://aws.amazon.com/s3/) object storage service.
|
|
8
8
|
To us this strategy you must first have access to an AWS account.
|
|
9
9
|
See their [getting started guide](https://aws.amazon.com/s3/getting-started/) for how to get set up.
|
|
10
10
|
|
|
@@ -14,11 +14,11 @@ Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aw
|
|
|
14
14
|
npm install @aws-sdk/client-s3 @aws-sdk/lib-storage
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
**Note:** Rather than instantiating this manually, use the
|
|
17
|
+
**Note:** Rather than instantiating this manually, use the [configureS3AssetStorage](/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#configures3assetstorage) function.
|
|
18
18
|
|
|
19
19
|
## Use with S3-compatible services (MinIO)
|
|
20
20
|
This strategy will also work with any S3-compatible object storage solutions, such as [MinIO](https://min.io/).
|
|
21
|
-
See the
|
|
21
|
+
See the [configureS3AssetStorage](/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#configures3assetstorage) for an example with MinIO.
|
|
22
22
|
|
|
23
23
|
```ts title="Signature"
|
|
24
24
|
class S3AssetStorageStrategy implements AssetStorageStrategy {
|
|
@@ -33,7 +33,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
|
|
|
33
33
|
fileExists(fileName: string) => ;
|
|
34
34
|
}
|
|
35
35
|
```
|
|
36
|
-
* Implements:
|
|
36
|
+
* Implements: [`AssetStorageStrategy`](/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy)
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
|
|
@@ -134,7 +134,7 @@ Using type `any` in order to avoid the need to include `aws-sdk` dependency in g
|
|
|
134
134
|
</div>
|
|
135
135
|
<GenerationInfo sourceFile="packages/asset-server-plugin/src/config/s3-asset-storage-strategy.ts" sourceLine="119" packageName="@vendure/asset-server-plugin" />
|
|
136
136
|
|
|
137
|
-
Returns a configured instance of the
|
|
137
|
+
Returns a configured instance of the [S3AssetStorageStrategy](/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3assetstoragestrategy) which can then be passed to the [AssetServerOptions](/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions)`storageStrategyFactory` property.
|
|
138
138
|
|
|
139
139
|
Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aws-sdk/lib-storage` package installed:
|
|
140
140
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/asset-server-plugin/src/config/sharp-asset-preview-strategy.ts" sourceLine="95" packageName="@vendure/asset-server-plugin" />
|
|
6
6
|
|
|
7
|
-
This
|
|
7
|
+
This [AssetPreviewStrategy](/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy) uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
|
|
8
8
|
preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
|
|
9
9
|
overlay will be generated.
|
|
10
10
|
|
|
@@ -30,7 +30,7 @@ class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
|
|
|
30
30
|
generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer) => Promise<Buffer>;
|
|
31
31
|
}
|
|
32
32
|
```
|
|
33
|
-
* Implements:
|
|
33
|
+
* Implements: [`AssetPreviewStrategy`](/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy)
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
|
|
@@ -51,7 +51,7 @@ class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
|
|
|
51
51
|
</div>
|
|
52
52
|
<GenerationInfo sourceFile="packages/asset-server-plugin/src/config/sharp-asset-preview-strategy.ts" sourceLine="17" packageName="@vendure/asset-server-plugin" />
|
|
53
53
|
|
|
54
|
-
This
|
|
54
|
+
This [AssetPreviewStrategy](/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy) uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
|
|
55
55
|
preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
|
|
56
56
|
overlay will be generated.
|
|
57
57
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/dashboard/plugin/dashboard.plugin.ts" sourceLine="29" packageName="@vendure/dashboard" />
|
|
6
6
|
|
|
7
|
-
Configuration options for the
|
|
7
|
+
Configuration options for the [DashboardPlugin](/reference/core-plugins/dashboard-plugin/#dashboardplugin).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface DashboardPluginOptions {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="30" packageName="@vendure/elasticsearch-plugin" />
|
|
6
6
|
|
|
7
|
-
Configuration options for the
|
|
7
|
+
Configuration options for the [ElasticsearchPlugin](/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface ElasticsearchOptions {
|
|
@@ -23,7 +23,7 @@ or
|
|
|
23
23
|
|
|
24
24
|
Make sure to remove the `DefaultSearchPlugin` if it is still in the VendureConfig plugins array.
|
|
25
25
|
|
|
26
|
-
Then add the `ElasticsearchPlugin`, calling the `.init()` method with
|
|
26
|
+
Then add the `ElasticsearchPlugin`, calling the `.init()` method with [ElasticsearchOptions](/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions):
|
|
27
27
|
|
|
28
28
|
*Example*
|
|
29
29
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/email-plugin/src/handler/event-handler.ts" sourceLine="506" packageName="@vendure/email-plugin" />
|
|
6
6
|
|
|
7
|
-
Identical to the
|
|
7
|
+
Identical to the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler) but with a `data` property added to the `event` based on the result
|
|
8
8
|
of the `.loadData()` function.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -12,7 +12,7 @@ class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent
|
|
|
12
12
|
constructor(_loadDataFn: LoadDataFn<InputEvent, Data>, listener: EmailEventListener<T>, event: Type<InputEvent>)
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Extends:
|
|
15
|
+
* Extends: [`EmailEventHandler`](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)`<T, Event>`
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
The EmailEventHandler defines how the EmailPlugin will respond to a given event.
|
|
8
8
|
|
|
9
|
-
A handler is created by creating a new
|
|
9
|
+
A handler is created by creating a new [EmailEventListener](/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener) and calling the `.on()` method
|
|
10
10
|
to specify which event to respond to.
|
|
11
11
|
|
|
12
12
|
*Example*
|
|
@@ -34,9 +34,9 @@ By default, the handler will respond to all events on all channels and use the s
|
|
|
34
34
|
and body template.
|
|
35
35
|
|
|
36
36
|
Since v2.0 the `.addTemplate()` method has been **deprecated**. To serve different templates — for example, based on the current
|
|
37
|
-
`languageCode` — implement a custom
|
|
37
|
+
`languageCode` — implement a custom [TemplateLoader](/reference/core-plugins/email-plugin/template-loader#templateloader) and pass it to `EmailPlugin.init({ templateLoader: new MyTemplateLoader() })`.
|
|
38
38
|
|
|
39
|
-
The language is typically determined by the `languageCode` property of the event's `ctx` (
|
|
39
|
+
The language is typically determined by the `languageCode` property of the event's `ctx` ([RequestContext](/reference/typescript-api/request/request-context#requestcontext)) object, so the
|
|
40
40
|
`loadTemplate()` method can use that to locate the correct template file.
|
|
41
41
|
|
|
42
42
|
*Example*
|
|
@@ -65,7 +65,7 @@ EmailPlugin.init({
|
|
|
65
65
|
## Defining a custom handler
|
|
66
66
|
|
|
67
67
|
Let's say you have a plugin which defines a new event type, `QuoteRequestedEvent`. In your plugin you have defined a mutation
|
|
68
|
-
which is executed when the customer requests a quote in your storefront, and in your resolver, you use the
|
|
68
|
+
which is executed when the customer requests a quote in your storefront, and in your resolver, you use the [EventBus](/reference/typescript-api/events/event-bus#eventbus) to publish a
|
|
69
69
|
new `QuoteRequestedEvent`.
|
|
70
70
|
|
|
71
71
|
You now want to email the customer with their quote. Here are the steps you would take to set this up:
|
|
@@ -197,17 +197,17 @@ setTemplateVars() method.
|
|
|
197
197
|
|
|
198
198
|
<MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a><Event>) => `} since="1.1.0" />
|
|
199
199
|
|
|
200
|
-
A function which allows
|
|
200
|
+
A function which allows [OptionalAddressFields](/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields) to be specified such as "cc" and "bcc".
|
|
201
201
|
### setMetadata
|
|
202
202
|
|
|
203
203
|
<MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a><Event>) => `} since="3.1.0" />
|
|
204
204
|
|
|
205
|
-
A function which allows
|
|
205
|
+
A function which allows [EmailMetadata](/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata) to be specified for the email. This can be used
|
|
206
206
|
to store arbitrary data about the email which can be used for tracking or other purposes.
|
|
207
207
|
|
|
208
|
-
It will be exposed in the
|
|
208
|
+
It will be exposed in the [EmailSendEvent](/reference/core-plugins/email-plugin/email-send-event#emailsendevent) as `event.metadata`. Here's an example of usage:
|
|
209
209
|
|
|
210
|
-
- An
|
|
210
|
+
- An [OrderStateTransitionEvent](/reference/typescript-api/events/event-types#orderstatetransitionevent) occurs, and the EmailEventListener starts processing it.
|
|
211
211
|
- The EmailEventHandler attaches metadata to the email:
|
|
212
212
|
```ts
|
|
213
213
|
new EmailEventListener(EventType.ORDER_CONFIRMATION)
|
|
@@ -217,7 +217,7 @@ It will be exposed in the <DocsLink href="/reference/core-plugins/email-plugin/e
|
|
|
217
217
|
orderId: event.order.id,
|
|
218
218
|
}));
|
|
219
219
|
```
|
|
220
|
-
- Then, the EmailPlugin tries to send the email and publishes
|
|
220
|
+
- Then, the EmailPlugin tries to send the email and publishes [EmailSendEvent](/reference/core-plugins/email-plugin/email-send-event#emailsendevent),
|
|
221
221
|
passing ctx, emailDetails, error or success, and this metadata.
|
|
222
222
|
- In another part of the server, we have an eventBus that subscribes to EmailSendEvent. We can use
|
|
223
223
|
`metadata.type` and `metadata.orderId` to identify the related order. For example, we can indicate on the
|
|
@@ -264,7 +264,7 @@ templates for channels or languageCodes other than the default.
|
|
|
264
264
|
Allows data to be loaded asynchronously which can then be used as template variables.
|
|
265
265
|
The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
|
|
266
266
|
`inject()` function which can be used to inject any of the providers exported
|
|
267
|
-
by the
|
|
267
|
+
by the [PluginCommonModule](/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule). The return value of the `loadDataFn` will be
|
|
268
268
|
added to the `event` as the `data` property.
|
|
269
269
|
|
|
270
270
|
*Example*
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/email-plugin/src/event-listener.ts" sourceLine="13" packageName="@vendure/email-plugin" />
|
|
6
6
|
|
|
7
|
-
An EmailEventListener is used to listen for events and set up a
|
|
7
|
+
An EmailEventListener is used to listen for events and set up a [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler) which
|
|
8
8
|
defines how an email will be generated from this event.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -17,7 +17,7 @@ interface EmailGenerator<T extends string = any, E extends VendureEvent = any> e
|
|
|
17
17
|
): Pick<EmailDetails, 'from' | 'subject' | 'body'>;
|
|
18
18
|
}
|
|
19
19
|
```
|
|
20
|
-
* Extends:
|
|
20
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
|
|
@@ -48,7 +48,7 @@ class HandlebarsMjmlGenerator implements EmailGenerator {
|
|
|
48
48
|
generate(from: string, subject: string, template: string, templateVars: any) => ;
|
|
49
49
|
}
|
|
50
50
|
```
|
|
51
|
-
* Implements:
|
|
51
|
+
* Implements: [`EmailGenerator`](/reference/core-plugins/email-plugin/email-generator#emailgenerator)
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
|
|
@@ -46,7 +46,7 @@ Configures how the emails are sent.
|
|
|
46
46
|
|
|
47
47
|
<MemberInfo kind="property" type={`Array<<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><string, any>>`} />
|
|
48
48
|
|
|
49
|
-
An array of
|
|
49
|
+
An array of [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)s which define which Vendure events will trigger
|
|
50
50
|
emails, and how those emails are generated.
|
|
51
51
|
### globalTemplateVars
|
|
52
52
|
|
|
@@ -115,7 +115,7 @@ interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'
|
|
|
115
115
|
route: string;
|
|
116
116
|
}
|
|
117
117
|
```
|
|
118
|
-
* Extends: `Omit
|
|
118
|
+
* Extends: `Omit<`[`EmailPluginOptions`](/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions)`, 'transport'>`
|
|
119
119
|
|
|
120
120
|
|
|
121
121
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="22" packageName="@vendure/email-plugin" />
|
|
6
6
|
|
|
7
7
|
A VendureEvent which also includes a `ctx` property containing the current
|
|
8
|
-
|
|
8
|
+
[RequestContext](/reference/typescript-api/request/request-context#requestcontext), which is used to determine the channel and language
|
|
9
9
|
to use when generating the email.
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
@@ -13,8 +13,8 @@ type EventWithContext = VendureEvent & { ctx: RequestContext }
|
|
|
13
13
|
```
|
|
14
14
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="32" packageName="@vendure/email-plugin" />
|
|
15
15
|
|
|
16
|
-
A VendureEvent with a
|
|
17
|
-
value resolved from the
|
|
16
|
+
A VendureEvent with a [RequestContext](/reference/typescript-api/request/request-context#requestcontext) and a `data` property which contains the
|
|
17
|
+
value resolved from the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)`.loadData()` callback.
|
|
18
18
|
|
|
19
19
|
```ts title="Signature"
|
|
20
20
|
type EventWithAsyncData<Event extends EventWithContext, R> = Event & { data: R }
|
|
@@ -83,7 +83,7 @@ interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialize
|
|
|
83
83
|
</div>
|
|
84
84
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="322" packageName="@vendure/email-plugin" />
|
|
85
85
|
|
|
86
|
-
A function used to load async data for use by an
|
|
86
|
+
A function used to load async data for use by an [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler).
|
|
87
87
|
|
|
88
88
|
```ts title="Signature"
|
|
89
89
|
type LoadDataFn<Event extends EventWithContext, R> = (context: {
|
|
@@ -103,7 +103,7 @@ type EmailAttachment = Omit<Attachment, 'raw'> & { path?: string }
|
|
|
103
103
|
```
|
|
104
104
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="402" packageName="@vendure/email-plugin" />
|
|
105
105
|
|
|
106
|
-
The object passed to the
|
|
106
|
+
The object passed to the [TemplateLoader](/reference/core-plugins/email-plugin/template-loader#templateloader) `loadTemplate()` method.
|
|
107
107
|
|
|
108
108
|
```ts title="Signature"
|
|
109
109
|
interface LoadTemplateInput {
|
|
@@ -138,7 +138,7 @@ EmailEventHandler's `setTemplateVars()` method.
|
|
|
138
138
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="435" packageName="@vendure/email-plugin" />
|
|
139
139
|
|
|
140
140
|
A function used to define template variables available to email templates.
|
|
141
|
-
See
|
|
141
|
+
See [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler).setTemplateVars().
|
|
142
142
|
|
|
143
143
|
```ts title="Signature"
|
|
144
144
|
type SetTemplateVarsFn<Event> = (
|
|
@@ -200,7 +200,7 @@ An email address that will appear on the _Reply-To:_ field
|
|
|
200
200
|
</div>
|
|
201
201
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="497" packageName="@vendure/email-plugin" since="1.1.0" />
|
|
202
202
|
|
|
203
|
-
A function used to set the
|
|
203
|
+
A function used to set the [OptionalAddressFields](/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields).
|
|
204
204
|
|
|
205
205
|
```ts title="Signature"
|
|
206
206
|
type SetOptionalAddressFieldsFn<Event> = (
|
|
@@ -209,14 +209,14 @@ type SetOptionalAddressFieldsFn<Event> = (
|
|
|
209
209
|
```
|
|
210
210
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="509" packageName="@vendure/email-plugin" since="3.1.0" />
|
|
211
211
|
|
|
212
|
-
A function used to set the
|
|
212
|
+
A function used to set the [EmailMetadata](/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata).
|
|
213
213
|
|
|
214
214
|
```ts title="Signature"
|
|
215
215
|
type SetMetadataFn<Event> = (event: Event) => EmailMetadata | Promise<EmailMetadata>
|
|
216
216
|
```
|
|
217
217
|
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="519" packageName="@vendure/email-plugin" since="3.1.0" />
|
|
218
218
|
|
|
219
|
-
Metadata that can be attached to an email via the
|
|
219
|
+
Metadata that can be attached to an email via the [EmailEventHandler](/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler)`.setMetadata()` method.
|
|
220
220
|
|
|
221
221
|
```ts title="Signature"
|
|
222
222
|
type EmailMetadata = Record<string, any>
|
|
@@ -13,7 +13,7 @@ class EmailSendEvent extends VendureEvent {
|
|
|
13
13
|
constructor(ctx: RequestContext, details: EmailDetails, success: boolean, error?: Error, metadata?: EmailMetadata)
|
|
14
14
|
}
|
|
15
15
|
```
|
|
16
|
-
* Extends:
|
|
16
|
+
* Extends: [`VendureEvent`](/reference/typescript-api/events/vendure-event#vendureevent)
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|