@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957
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/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
- 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.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
- 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 +8 -8
- 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 +3 -3
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.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-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
- package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +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 +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
- 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 +13 -13
- 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 +3 -3
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
- package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
- package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
- package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
- package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
- package/docs/reference/dashboard/page-layout/index.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +3 -3
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
- package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/index.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
- package/docs/reference/typescript-api/common/injector.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
- 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 +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -1
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +1 -1
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +1 -1
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +1 -1
- package/docs/reference/typescript-api/entities/role.mdx +1 -1
- package/docs/reference/typescript-api/entities/seller.mdx +1 -1
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
- package/docs/reference/typescript-api/entities/user.mdx +1 -1
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
- package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
- package/docs/reference/typescript-api/events/event-types.mdx +30 -30
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
- package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
- 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 +3 -3
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- 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/order-by-code-access-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- 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 +4 -4
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
- 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-location-strategy.mdx +1 -1
- 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 +1 -1
- 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 +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
- package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
- package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
- package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
- package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
- package/docs/reference/typescript-api/services/country-service.mdx +7 -7
- package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
- package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
- package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
- package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +8 -8
- package/docs/reference/typescript-api/services/order-service.mdx +52 -52
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
- package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
- package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-service.mdx +13 -13
- package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
- package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
- package/docs/reference/typescript-api/services/province-service.mdx +5 -5
- package/docs/reference/typescript-api/services/role-service.mdx +11 -11
- package/docs/reference/typescript-api/services/search-service.mdx +2 -2
- package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
- package/docs/reference/typescript-api/services/session-service.mdx +8 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
- package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
- package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
- package/docs/reference/typescript-api/services/user-service.mdx +12 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
- 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 +2 -2
- package/package.json +1 -1
- package/docs/reference/admin-ui-api/index.mdx +0 -4
- package/docs/reference/dashboard/index.mdx +0 -4
- package/docs/reference/graphql-api/admin/_index.mdx +0 -4
- package/docs/reference/graphql-api/shop/_index.mdx +0 -4
- package/docs/reference/typescript-api/_index.mdx +0 -4
|
@@ -24,7 +24,7 @@ class DataService {
|
|
|
24
24
|
|
|
25
25
|
### query
|
|
26
26
|
|
|
27
|
-
<MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode
|
|
27
|
+
<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>`} />
|
|
28
28
|
|
|
29
29
|
Perform a GraphQL query. Returns a <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a> which allows further control over
|
|
30
30
|
they type of result returned, e.g. stream of values, single value etc.
|
|
@@ -45,7 +45,7 @@ const result$ = this.dataService.query(gql`
|
|
|
45
45
|
```
|
|
46
46
|
### mutate
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(mutation: DocumentNode | TypedDocumentNode
|
|
48
|
+
<MemberInfo kind="method" type={`(mutation: DocumentNode | TypedDocumentNode<T, V>, variables?: V, update?: MutationUpdaterFunction<T, V, any, any>, options: ExtendedQueryOptions = {}) => Observable<T>`} />
|
|
49
49
|
|
|
50
50
|
Perform a GraphQL mutation.
|
|
51
51
|
|
|
@@ -92,43 +92,43 @@ class QueryResult<T, V extends Record<string, any> = Record<string, any>> {
|
|
|
92
92
|
|
|
93
93
|
### constructor
|
|
94
94
|
|
|
95
|
-
<MemberInfo kind="method" type={`(queryRef: QueryRef
|
|
95
|
+
<MemberInfo kind="method" type={`(queryRef: QueryRef<T, V>, apollo: Apollo, customFieldMap: Map<string, <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]>) => QueryResult`} />
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
### refetchOnChannelChange
|
|
99
99
|
|
|
100
|
-
<MemberInfo kind="method" type={`() => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a
|
|
100
|
+
<MemberInfo kind="method" type={`() => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} />
|
|
101
101
|
|
|
102
102
|
Re-fetch this query whenever the active Channel changes.
|
|
103
103
|
### refetchOnCustomFieldsChange
|
|
104
104
|
|
|
105
|
-
<MemberInfo kind="method" type={`(customFieldsToInclude$: Observable
|
|
105
|
+
<MemberInfo kind="method" type={`(customFieldsToInclude$: Observable<string[]>) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} since="3.0.4" />
|
|
106
106
|
|
|
107
107
|
Re-fetch this query whenever the custom fields change, updating the query to include the
|
|
108
108
|
specified custom fields.
|
|
109
109
|
### single$
|
|
110
110
|
|
|
111
|
-
<MemberInfo kind="property" type={`Observable
|
|
111
|
+
<MemberInfo kind="property" type={`Observable<T>`} />
|
|
112
112
|
|
|
113
113
|
Returns an Observable which emits a single result and then completes.
|
|
114
114
|
### stream$
|
|
115
115
|
|
|
116
|
-
<MemberInfo kind="property" type={`Observable
|
|
116
|
+
<MemberInfo kind="property" type={`Observable<T>`} />
|
|
117
117
|
|
|
118
118
|
Returns an Observable which emits until unsubscribed.
|
|
119
119
|
### ref
|
|
120
120
|
|
|
121
|
-
<MemberInfo kind="property" type={`QueryRef
|
|
121
|
+
<MemberInfo kind="property" type={`QueryRef<T, V>`} />
|
|
122
122
|
|
|
123
123
|
|
|
124
124
|
### mapSingle
|
|
125
125
|
|
|
126
|
-
<MemberInfo kind="method" type={`(mapFn: (item: T)
|
|
126
|
+
<MemberInfo kind="method" type={`(mapFn: (item: T) => R) => Observable<R>`} />
|
|
127
127
|
|
|
128
128
|
Returns a single-result Observable after applying the map function.
|
|
129
129
|
### mapStream
|
|
130
130
|
|
|
131
|
-
<MemberInfo kind="method" type={`(mapFn: (item: T)
|
|
131
|
+
<MemberInfo kind="method" type={`(mapFn: (item: T) => R) => Observable<R>`} />
|
|
132
132
|
|
|
133
133
|
Returns a multiple-result Observable after applying the map function.
|
|
134
134
|
### destroy
|
|
@@ -28,7 +28,7 @@ class ModalService {
|
|
|
28
28
|
|
|
29
29
|
### fromComponent
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(component: Type
|
|
31
|
+
<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>`} />
|
|
32
32
|
|
|
33
33
|
Create a modal from a component. The component must implement the <a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a> interface.
|
|
34
34
|
Additionally, the component should include templates for the title and the buttons to be
|
|
@@ -72,7 +72,7 @@ class MyDialog implements Dialog {
|
|
|
72
72
|
```
|
|
73
73
|
### dialog
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/admin-ui-api/services/modal-service#dialogconfig'>DialogConfig</a
|
|
75
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/admin-ui-api/services/modal-service#dialogconfig'>DialogConfig</a><T>) => Observable<T | undefined>`} />
|
|
76
76
|
|
|
77
77
|
Displays a modal dialog with the provided title, body and buttons.
|
|
78
78
|
|
|
@@ -97,7 +97,7 @@ interface Dialog<R = any> {
|
|
|
97
97
|
|
|
98
98
|
### resolveWith
|
|
99
99
|
|
|
100
|
-
<MemberInfo kind="property" type={`(result?: R)
|
|
100
|
+
<MemberInfo kind="property" type={`(result?: R) => void`} />
|
|
101
101
|
|
|
102
102
|
Function to be invoked in order to close the dialog when the action is complete.
|
|
103
103
|
The Observable returned from the .fromComponent() method will emit the value passed
|
|
@@ -142,7 +142,7 @@ interface DialogConfig<T> {
|
|
|
142
142
|
|
|
143
143
|
### buttons
|
|
144
144
|
|
|
145
|
-
<MemberInfo kind="property" type={`Array
|
|
145
|
+
<MemberInfo kind="property" type={`Array<DialogButtonConfig<T>>`} />
|
|
146
146
|
|
|
147
147
|
|
|
148
148
|
### size
|
|
@@ -190,7 +190,7 @@ When true, the "x" icon is shown
|
|
|
190
190
|
and clicking it or the mask will close the dialog
|
|
191
191
|
### locals
|
|
192
192
|
|
|
193
|
-
<MemberInfo kind="property" type={`Partial
|
|
193
|
+
<MemberInfo kind="property" type={`Partial<T>`} />
|
|
194
194
|
|
|
195
195
|
Values to be passed directly to the component being instantiated inside the dialog.
|
|
196
196
|
|
|
@@ -54,7 +54,7 @@ The name of the tab to display in the UI.
|
|
|
54
54
|
The priority of the tab. Tabs with a lower priority will be displayed first.
|
|
55
55
|
### component
|
|
56
56
|
|
|
57
|
-
<MemberInfo kind="property" type={`Type
|
|
57
|
+
<MemberInfo kind="property" type={`Type<any> | ReturnType<typeof <a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>>`} />
|
|
58
58
|
|
|
59
59
|
The component to render at the route of the tab.
|
|
60
60
|
### routeConfig
|
|
@@ -28,7 +28,7 @@ interface AdminUiExtension extends Partial<TranslationExtension>,
|
|
|
28
28
|
exclude?: string[];
|
|
29
29
|
}
|
|
30
30
|
```
|
|
31
|
-
* Extends: <code>Partial
|
|
31
|
+
* Extends: <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#translationextension'>TranslationExtension</a>></code>, <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#staticassetextension'>StaticAssetExtension</a>></code>, <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#globalstylesextension'>GlobalStylesExtension</a>></code>
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -49,7 +49,7 @@ will be copied into the Admin UI app, including all TypeScript source files, htm
|
|
|
49
49
|
scss style sheets etc.
|
|
50
50
|
### ngModules
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="property" type={`Array
|
|
52
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionsharedmodule'>AdminUiExtensionSharedModule</a> | <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionlazymodule'>AdminUiExtensionLazyModule</a>>`} />
|
|
53
53
|
|
|
54
54
|
One or more Angular modules which extend the default Admin UI.
|
|
55
55
|
### providers
|
|
@@ -52,7 +52,7 @@ Admin UI. This option can be used to override this default build with a differen
|
|
|
52
52
|
version, e.g. one pre-compiled with one or more ui extensions.
|
|
53
53
|
### adminUiConfig
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={`Partial
|
|
55
|
+
<MemberInfo kind="property" type={`Partial<<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>>`} />
|
|
56
56
|
|
|
57
57
|
Allows the contents of the `vendure-ui-config.json` file to be set, e.g.
|
|
58
58
|
for specifying the Vendure GraphQL API host, available UI languages, etc.
|
|
@@ -80,7 +80,7 @@ class AdminUiPlugin implements NestModule {
|
|
|
80
80
|
|
|
81
81
|
### init
|
|
82
82
|
|
|
83
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type
|
|
83
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type<<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>>`} />
|
|
84
84
|
|
|
85
85
|
Set the plugin options
|
|
86
86
|
### configure
|
|
@@ -42,7 +42,7 @@ The route to the asset server.
|
|
|
42
42
|
The local directory to which assets will be uploaded when using the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>.
|
|
43
43
|
### assetUrlPrefix
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string)
|
|
45
|
+
<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) => string)`} />
|
|
46
46
|
|
|
47
47
|
The complete URL prefix of the asset files. For example, "https://demo.vendure.io/assets/". A
|
|
48
48
|
function can also be provided to handle more complex cases, such as serving multiple domains
|
|
@@ -90,7 +90,7 @@ Defines how previews are generated for a given Asset binary. By default, this us
|
|
|
90
90
|
the <a href='/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy'>SharpAssetPreviewStrategy</a>
|
|
91
91
|
### storageStrategyFactory
|
|
92
92
|
|
|
93
|
-
<MemberInfo kind="property" type={`( options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>, )
|
|
93
|
+
<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>`} />
|
|
94
94
|
|
|
95
95
|
A function which can be used to configure an <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>. This is useful e.g. if you wish to store your assets
|
|
96
96
|
using a cloud storage provider. By default, the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a> is used.
|
|
@@ -33,7 +33,7 @@ interface ImageTransformStrategy extends InjectableStrategy {
|
|
|
33
33
|
|
|
34
34
|
### getImageTransformParameters
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise
|
|
36
|
+
<MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
|
|
37
37
|
|
|
38
38
|
Given the input parameters, return the parameters which should be used to transform the image.
|
|
39
39
|
|
|
@@ -170,7 +170,7 @@ class AssetServerPlugin implements NestModule, OnApplicationBootstrap, OnApplica
|
|
|
170
170
|
|
|
171
171
|
### init
|
|
172
172
|
|
|
173
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type
|
|
173
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type<<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>>`} />
|
|
174
174
|
|
|
175
175
|
Set the plugin options.
|
|
176
176
|
### constructor
|
|
@@ -30,42 +30,42 @@ class LocalAssetStorageStrategy implements AssetStorageStrategy {
|
|
|
30
30
|
|
|
31
31
|
### toAbsoluteUrl
|
|
32
32
|
|
|
33
|
-
<MemberInfo kind="property" type={`((reqest: Request, identifier: string)
|
|
33
|
+
<MemberInfo kind="property" type={`((reqest: Request, identifier: string) => string) | undefined`} />
|
|
34
34
|
|
|
35
35
|
|
|
36
36
|
### constructor
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string)
|
|
38
|
+
<MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) => string) => LocalAssetStorageStrategy`} />
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
### writeFileFromStream
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise
|
|
43
|
+
<MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise<string>`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### writeFileFromBuffer
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise
|
|
48
|
+
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`} />
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
### fileExists
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="method" type={`(fileName: string) => Promise
|
|
53
|
+
<MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`} />
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
### readFileToBuffer
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(identifier: string) => Promise
|
|
58
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`} />
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
### readFileToStream
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="method" type={`(identifier: string) => Promise
|
|
63
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`} />
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
### deleteFile
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="method" type={`(identifier: string) => Promise
|
|
68
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<void>`} />
|
|
69
69
|
|
|
70
70
|
|
|
71
71
|
|
|
@@ -65,7 +65,7 @@ class PresetOnlyStrategy implements ImageTransformStrategy {
|
|
|
65
65
|
<MemberInfo kind="method" type={`({
|
|
66
66
|
input,
|
|
67
67
|
availablePresets,
|
|
68
|
-
}: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise
|
|
68
|
+
}: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
|
|
69
69
|
|
|
70
70
|
|
|
71
71
|
|
|
@@ -45,7 +45,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
|
|
|
45
45
|
|
|
46
46
|
### constructor
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string)
|
|
48
|
+
<MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string) => string) => S3AssetStorageStrategy`} />
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
### init
|
|
@@ -55,7 +55,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
|
|
|
55
55
|
|
|
56
56
|
### destroy
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="property" type={`(()
|
|
58
|
+
<MemberInfo kind="property" type={`(() => void | Promise<void>) | undefined`} />
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
### writeFileFromBuffer
|
|
@@ -47,7 +47,7 @@ class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
|
|
|
47
47
|
|
|
48
48
|
### generatePreviewImage
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise
|
|
50
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
|
|
@@ -92,7 +92,7 @@ class DashboardPlugin implements NestModule {
|
|
|
92
92
|
|
|
93
93
|
### init
|
|
94
94
|
|
|
95
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => Type
|
|
95
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => Type<<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>>`} />
|
|
96
96
|
|
|
97
97
|
Set the plugin options
|
|
98
98
|
### configure
|
|
@@ -174,7 +174,7 @@ bulk operation is executed.
|
|
|
174
174
|
Configuration of the internal Elasticsearch query.
|
|
175
175
|
### customProductMappings
|
|
176
176
|
|
|
177
|
-
<MemberInfo kind="property" type={`{ [fieldName: string]: CustomMapping
|
|
177
|
+
<MemberInfo kind="property" type={`{ [fieldName: string]: CustomMapping< [<a href='/reference/typescript-api/entities/product#product'>Product</a>, <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>] >; }`} />
|
|
178
178
|
|
|
179
179
|
Custom mappings may be defined which will add the defined data to the
|
|
180
180
|
Elasticsearch index and expose that data via the SearchResult GraphQL type,
|
|
@@ -237,7 +237,7 @@ query SearchProducts($input: SearchInput!) {
|
|
|
237
237
|
```
|
|
238
238
|
### customProductVariantMappings
|
|
239
239
|
|
|
240
|
-
<MemberInfo kind="property" type={`{ [fieldName: string]: CustomMapping
|
|
240
|
+
<MemberInfo kind="property" type={`{ [fieldName: string]: CustomMapping<[<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]>; }`} />
|
|
241
241
|
|
|
242
242
|
This config option defines custom mappings which are accessible when the "groupByProduct" and "groupBySKU"
|
|
243
243
|
input options are both set to `false`. In addition, custom product mappings can be accessed by using
|
|
@@ -278,7 +278,7 @@ and also performs optimizations to minimize the amount of work that needs to be
|
|
|
278
278
|
the worker.
|
|
279
279
|
### hydrateProductRelations
|
|
280
280
|
|
|
281
|
-
<MemberInfo kind="property" type={`Array
|
|
281
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><<a href='/reference/typescript-api/entities/product#product'>Product</a>>>`} default={`[]`} since="1.3.0" />
|
|
282
282
|
|
|
283
283
|
Additional product relations that will be fetched from DB while reindexing. This can be used
|
|
284
284
|
in combination with `customProductMappings` to ensure that the required relations are joined
|
|
@@ -301,13 +301,13 @@ before the `product` object is passed to the `valueFn`.
|
|
|
301
301
|
```
|
|
302
302
|
### hydrateProductVariantRelations
|
|
303
303
|
|
|
304
|
-
<MemberInfo kind="property" type={`Array
|
|
304
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>`} default={`[]`} since="1.3.0" />
|
|
305
305
|
|
|
306
306
|
Additional variant relations that will be fetched from DB while reindexing. See
|
|
307
307
|
`hydrateProductRelations` for more explanation and a usage example.
|
|
308
308
|
### extendSearchInputType
|
|
309
309
|
|
|
310
|
-
<MemberInfo kind="property" type={`{ [name: string]: PrimitiveTypeVariations
|
|
310
|
+
<MemberInfo kind="property" type={`{ [name: string]: PrimitiveTypeVariations<GraphQlPrimitive>; }`} default={`{}`} since="1.3.0" />
|
|
311
311
|
|
|
312
312
|
Allows the `SearchInput` type to be extended with new input fields. This allows arbitrary
|
|
313
313
|
data to be passed in, which can then be used e.g. in the `mapQuery()` function or
|
|
@@ -467,7 +467,7 @@ The interval used to group search results into buckets according to price range.
|
|
|
467
467
|
```
|
|
468
468
|
### mapQuery
|
|
469
469
|
|
|
470
|
-
<MemberInfo kind="property" type={`( query: any, input: ElasticSearchInput, searchConfig: DeepRequired
|
|
470
|
+
<MemberInfo kind="property" type={`( query: any, input: ElasticSearchInput, searchConfig: DeepRequired<<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, enabledOnly: boolean, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ) => any`} />
|
|
471
471
|
|
|
472
472
|
This config option allows the the modification of the whole (already built) search query. This allows
|
|
473
473
|
for e.g. wildcard / fuzzy searches on the index.
|
|
@@ -506,7 +506,7 @@ mapQuery: (query, input, searchConfig, channelId, enabledOnly, ctx) => {
|
|
|
506
506
|
```
|
|
507
507
|
### scriptFields
|
|
508
508
|
|
|
509
|
-
<MemberInfo kind="property" type={`{ [fieldName: string]: CustomScriptMapping
|
|
509
|
+
<MemberInfo kind="property" type={`{ [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> }`} since="1.3.0" />
|
|
510
510
|
|
|
511
511
|
Sets `script_fields` inside the elasticsearch body which allows returning a script evaluation for each hit.
|
|
512
512
|
|
|
@@ -567,7 +567,7 @@ searchConfig: {
|
|
|
567
567
|
```
|
|
568
568
|
### mapSort
|
|
569
569
|
|
|
570
|
-
<MemberInfo kind="property" type={`(sort: ElasticSearchSortInput, input: ElasticSearchInput)
|
|
570
|
+
<MemberInfo kind="property" type={`(sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput`} default={`{}`} since="1.4.0" />
|
|
571
571
|
|
|
572
572
|
Allows extending the `sort` input of the elasticsearch body as covered in
|
|
573
573
|
[Elasticsearch sort docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html)
|
|
@@ -184,7 +184,7 @@ class ElasticsearchPlugin implements OnApplicationBootstrap {
|
|
|
184
184
|
|
|
185
185
|
### init
|
|
186
186
|
|
|
187
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => Type
|
|
187
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => Type<<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>>`} />
|
|
188
188
|
|
|
189
189
|
|
|
190
190
|
|
|
@@ -16,7 +16,7 @@ class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent
|
|
|
16
16
|
constructor(_loadDataFn: LoadDataFn<InputEvent, Data>, listener: EmailEventListener<T>, event: Type<InputEvent>)
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Extends: <code><a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a
|
|
19
|
+
* Extends: <code><a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event></code>
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -24,7 +24,7 @@ class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent
|
|
|
24
24
|
|
|
25
25
|
### constructor
|
|
26
26
|
|
|
27
|
-
<MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a
|
|
27
|
+
<MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a><InputEvent, Data>, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a><T>, event: Type<InputEvent>) => EmailEventHandlerWithAsyncData`} />
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
|
|
@@ -156,18 +156,18 @@ class EmailEventHandler<T extends string = string, Event extends EventWithContex
|
|
|
156
156
|
|
|
157
157
|
### constructor
|
|
158
158
|
|
|
159
|
-
<MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a
|
|
159
|
+
<MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a><T>, event: Type<Event>) => EmailEventHandler`} />
|
|
160
160
|
|
|
161
161
|
|
|
162
162
|
### filter
|
|
163
163
|
|
|
164
|
-
<MemberInfo kind="method" type={`(filterFn: (event: Event)
|
|
164
|
+
<MemberInfo kind="method" type={`(filterFn: (event: Event) => boolean) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
|
|
165
165
|
|
|
166
166
|
Defines a predicate function which is used to determine whether the event will trigger an email.
|
|
167
167
|
Multiple filter functions may be defined.
|
|
168
168
|
### setRecipient
|
|
169
169
|
|
|
170
|
-
<MemberInfo kind="method" type={`(setRecipientFn: (event: Event)
|
|
170
|
+
<MemberInfo kind="method" type={`(setRecipientFn: (event: Event) => string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
|
|
171
171
|
|
|
172
172
|
A function which defines how the recipient email address should be extracted from the incoming event.
|
|
173
173
|
|
|
@@ -176,35 +176,35 @@ Or with a formatted name (includes unicode support): `'Ноде Майлер <fo
|
|
|
176
176
|
Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
|
|
177
177
|
### setLanguageCode
|
|
178
178
|
|
|
179
|
-
<MemberInfo kind="method" type={`(setLanguageCodeFn: (event: Event)
|
|
179
|
+
<MemberInfo kind="method" type={`(setLanguageCodeFn: (event: Event) => <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} since="1.8.0" />
|
|
180
180
|
|
|
181
181
|
A function which allows to override the language of the email. If not defined, the language from the context will be used.
|
|
182
182
|
### setTemplateVars
|
|
183
183
|
|
|
184
|
-
<MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a
|
|
184
|
+
<MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
|
|
185
185
|
|
|
186
186
|
A function which returns an object hash of variables which will be made available to the Handlebars template
|
|
187
187
|
and subject line for interpolation.
|
|
188
188
|
### setSubject
|
|
189
189
|
|
|
190
|
-
<MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a
|
|
190
|
+
<MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
|
|
191
191
|
|
|
192
192
|
Sets the default subject of the email. The subject string may use Handlebars variables defined by the
|
|
193
193
|
setTemplateVars() method.
|
|
194
194
|
### setFrom
|
|
195
195
|
|
|
196
|
-
<MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a
|
|
196
|
+
<MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
|
|
197
197
|
|
|
198
198
|
Sets the default from field of the email. The from string may use Handlebars variables defined by the
|
|
199
199
|
setTemplateVars() method.
|
|
200
200
|
### setOptionalAddressFields
|
|
201
201
|
|
|
202
|
-
<MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a
|
|
202
|
+
<MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a><Event>) => `} since="1.1.0" />
|
|
203
203
|
|
|
204
204
|
A function which allows <a href='/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields'>OptionalAddressFields</a> to be specified such as "cc" and "bcc".
|
|
205
205
|
### setMetadata
|
|
206
206
|
|
|
207
|
-
<MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a
|
|
207
|
+
<MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a><Event>) => `} since="3.1.0" />
|
|
208
208
|
|
|
209
209
|
A function which allows <a href='/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata'>EmailMetadata</a> to be specified for the email. This can be used
|
|
210
210
|
to store arbitrary data about the email which can be used for tracking or other purposes.
|
|
@@ -229,7 +229,7 @@ It will be exposed in the <a href='/reference/core-plugins/email-plugin/email-se
|
|
|
229
229
|
the order in another available way.
|
|
230
230
|
### setAttachments
|
|
231
231
|
|
|
232
|
-
<MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a
|
|
232
|
+
<MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a><Event>) => `} />
|
|
233
233
|
|
|
234
234
|
Defines one or more files to be attached to the email. An attachment can be specified
|
|
235
235
|
as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
|
|
@@ -257,13 +257,13 @@ const testAttachmentHandler = new EmailEventListener('activate-voucher')
|
|
|
257
257
|
```
|
|
258
258
|
### addTemplate
|
|
259
259
|
|
|
260
|
-
<MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a
|
|
260
|
+
<MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
|
|
261
261
|
|
|
262
262
|
Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
|
|
263
263
|
templates for channels or languageCodes other than the default.
|
|
264
264
|
### loadData
|
|
265
265
|
|
|
266
|
-
<MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a
|
|
266
|
+
<MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a><Event, R>) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a><R, T, Event, <a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>EventWithAsyncData</a><Event, R>>`} />
|
|
267
267
|
|
|
268
268
|
Allows data to be loaded asynchronously which can then be used as template variables.
|
|
269
269
|
The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
|
|
@@ -289,7 +289,7 @@ new EmailEventListener('order-confirmation')
|
|
|
289
289
|
```
|
|
290
290
|
### setMockEvent
|
|
291
291
|
|
|
292
|
-
<MemberInfo kind="method" type={`(event: Omit
|
|
292
|
+
<MemberInfo kind="method" type={`(event: Omit<Event, 'ctx' | 'data'>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
|
|
293
293
|
|
|
294
294
|
Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
|
|
295
295
|
from this handler, which is useful when developing the email templates.
|
|
@@ -33,7 +33,7 @@ class EmailEventListener<T extends string> {
|
|
|
33
33
|
|
|
34
34
|
### on
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(event: Type
|
|
36
|
+
<MemberInfo kind="method" type={`(event: Type<Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
|
|
37
37
|
|
|
38
38
|
Defines the event to listen for.
|
|
39
39
|
|
|
@@ -29,12 +29,12 @@ interface EmailGenerator<T extends string = any, E extends VendureEvent = any> e
|
|
|
29
29
|
|
|
30
30
|
### onInit
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => void | Promise
|
|
32
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => void | Promise<void>`} />
|
|
33
33
|
|
|
34
34
|
Any necessary setup can be performed here.
|
|
35
35
|
### generate
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => Pick
|
|
37
|
+
<MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => Pick<<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, 'from' | 'subject' | 'body'>`} />
|
|
38
38
|
|
|
39
39
|
Given a subject and body from an email template, this method generates the final
|
|
40
40
|
interpolated email text.
|
|
@@ -43,12 +43,12 @@ An optional TemplateLoader which can be used to load templates from a custom loc
|
|
|
43
43
|
The default uses the FileBasedTemplateLoader which loads templates from `<project root>/vendure/email/templates`
|
|
44
44
|
### transport
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | (( injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, )
|
|
46
|
+
<MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | (( injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ) => <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | Promise<<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>>)`} />
|
|
47
47
|
|
|
48
48
|
Configures how the emails are sent.
|
|
49
49
|
### handlers
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="property" type={`Array
|
|
51
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><string, any>>`} />
|
|
52
52
|
|
|
53
53
|
An array of <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>s which define which Vendure events will trigger
|
|
54
54
|
emails, and how those emails are generated.
|
|
@@ -127,7 +127,7 @@ interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'
|
|
|
127
127
|
route: string;
|
|
128
128
|
}
|
|
129
129
|
```
|
|
130
|
-
* Extends: <code>Omit
|
|
130
|
+
* Extends: <code>Omit<<a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>, 'transport'></code>
|
|
131
131
|
|
|
132
132
|
|
|
133
133
|
|
|
@@ -72,7 +72,7 @@ interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialize
|
|
|
72
72
|
|
|
73
73
|
### attachments
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="property" type={`Array
|
|
75
|
+
<MemberInfo kind="property" type={`Array<Type extends 'serialized' ? SerializedAttachment : Attachment>`} />
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
### cc
|