@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
|
@@ -37,7 +37,7 @@ class OrderableAsset extends VendureEntity implements Orderable {
|
|
|
37
37
|
|
|
38
38
|
### constructor
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
40
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/orderable-asset#orderableasset'>OrderableAsset</a>>) => OrderableAsset`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### assetId
|
|
@@ -40,7 +40,7 @@ class PaymentMethod extends VendureEntity implements Translatable, ChannelAware,
|
|
|
40
40
|
|
|
41
41
|
### constructor
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
43
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>>) => PaymentMethod`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### name
|
|
@@ -60,7 +60,7 @@ class PaymentMethod extends VendureEntity implements Translatable, ChannelAware,
|
|
|
60
60
|
|
|
61
61
|
### translations
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="property" type={`Array
|
|
63
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>>>`} />
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
### enabled
|
|
@@ -42,7 +42,7 @@ class Payment extends VendureEntity implements HasCustomFields {
|
|
|
42
42
|
|
|
43
43
|
### constructor
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
45
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/payment#payment'>Payment</a>>) => Payment`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### method
|
|
@@ -40,7 +40,7 @@ class ProductOptionGroup extends VendureEntity implements Translatable, HasCusto
|
|
|
40
40
|
|
|
41
41
|
### constructor
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
43
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/product-option-group#productoptiongroup'>ProductOptionGroup</a>>) => ProductOptionGroup`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### deletedAt
|
|
@@ -60,7 +60,7 @@ class ProductOptionGroup extends VendureEntity implements Translatable, HasCusto
|
|
|
60
60
|
|
|
61
61
|
### translations
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="property" type={`Array
|
|
63
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/product-option-group#productoptiongroup'>ProductOptionGroup</a>>>`} />
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
### options
|
|
@@ -41,7 +41,7 @@ class ProductOption extends VendureEntity implements Translatable, HasCustomFiel
|
|
|
41
41
|
|
|
42
42
|
### constructor
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
44
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>>) => ProductOption`} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### deletedAt
|
|
@@ -61,7 +61,7 @@ class ProductOption extends VendureEntity implements Translatable, HasCustomFiel
|
|
|
61
61
|
|
|
62
62
|
### translations
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="property" type={`Array
|
|
64
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>>>`} />
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
### group
|
|
@@ -36,7 +36,7 @@ class ProductVariantPrice extends VendureEntity implements HasCustomFields {
|
|
|
36
36
|
|
|
37
37
|
### constructor
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
39
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>>) => ProductVariantPrice`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
### price
|
|
@@ -90,7 +90,7 @@ class ProductVariant extends VendureEntity implements Translatable, HasCustomFie
|
|
|
90
90
|
|
|
91
91
|
### constructor
|
|
92
92
|
|
|
93
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
93
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>) => ProductVariant`} />
|
|
94
94
|
|
|
95
95
|
|
|
96
96
|
### deletedAt
|
|
@@ -175,7 +175,7 @@ class ProductVariant extends VendureEntity implements Translatable, HasCustomFie
|
|
|
175
175
|
|
|
176
176
|
### translations
|
|
177
177
|
|
|
178
|
-
<MemberInfo kind="property" type={`Array
|
|
178
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>`} />
|
|
179
179
|
|
|
180
180
|
|
|
181
181
|
### product
|
|
@@ -55,7 +55,7 @@ class Product extends VendureEntity implements Translatable, HasCustomFields, Ch
|
|
|
55
55
|
|
|
56
56
|
### constructor
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
58
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/product#product'>Product</a>>) => Product`} />
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
### deletedAt
|
|
@@ -100,7 +100,7 @@ class Product extends VendureEntity implements Translatable, HasCustomFields, Ch
|
|
|
100
100
|
|
|
101
101
|
### translations
|
|
102
102
|
|
|
103
|
-
<MemberInfo kind="property" type={`Array
|
|
103
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/product#product'>Product</a>>>`} />
|
|
104
104
|
|
|
105
105
|
|
|
106
106
|
### variants
|
|
@@ -70,7 +70,7 @@ class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable,
|
|
|
70
70
|
|
|
71
71
|
### constructor
|
|
72
72
|
|
|
73
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
73
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>> & { promotionConditions?: Array<<a href='/reference/typescript-api/promotions/promotion-condition#promotioncondition'>PromotionCondition</a><any>>; promotionActions?: Array<<a href='/reference/typescript-api/promotions/promotion-action#promotionaction'>PromotionAction</a><any>>; }) => Promotion`} />
|
|
74
74
|
|
|
75
75
|
|
|
76
76
|
### deletedAt
|
|
@@ -115,7 +115,7 @@ class Promotion extends AdjustmentSource implements ChannelAware, SoftDeletable,
|
|
|
115
115
|
|
|
116
116
|
### translations
|
|
117
117
|
|
|
118
|
-
<MemberInfo kind="property" type={`Array
|
|
118
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>>>`} />
|
|
119
119
|
|
|
120
120
|
|
|
121
121
|
### enabled
|
|
@@ -166,12 +166,12 @@ If Promotion 2 is evaluated prior to Promotion 1, then it can trigger the 10% di
|
|
|
166
166
|
if the subsequent application of Promotion 1 brings the order total down to way below $50.
|
|
167
167
|
### apply
|
|
168
168
|
|
|
169
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, args: ApplyOrderActionArgs | ApplyOrderItemActionArgs | ApplyShippingActionArgs, state?: PromotionState) => Promise
|
|
169
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, args: ApplyOrderActionArgs | ApplyOrderItemActionArgs | ApplyShippingActionArgs, state?: PromotionState) => Promise<Adjustment | undefined>`} />
|
|
170
170
|
|
|
171
171
|
|
|
172
172
|
### test
|
|
173
173
|
|
|
174
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise
|
|
174
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<PromotionTestResult>`} />
|
|
175
175
|
|
|
176
176
|
|
|
177
177
|
### activate
|
|
@@ -25,7 +25,7 @@ class Province extends Region {
|
|
|
25
25
|
|
|
26
26
|
### constructor
|
|
27
27
|
|
|
28
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
28
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/province#province'>Province</a>>) => Province`} />
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
### type
|
|
@@ -46,7 +46,7 @@ class Refund extends VendureEntity implements HasCustomFields {
|
|
|
46
46
|
|
|
47
47
|
### constructor
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
49
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>>) => Refund`} />
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
### items
|
|
@@ -73,7 +73,7 @@ a format relevant to the type of province, e.g. a US state code like "CA".
|
|
|
73
73
|
|
|
74
74
|
### translations
|
|
75
75
|
|
|
76
|
-
<MemberInfo kind="property" type={`Array
|
|
76
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/region#region'>Region</a>>>`} />
|
|
77
77
|
|
|
78
78
|
|
|
79
79
|
### customFields
|
|
@@ -33,7 +33,7 @@ class Role extends VendureEntity implements ChannelAware {
|
|
|
33
33
|
|
|
34
34
|
### constructor
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
36
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/role#role'>Role</a>>) => Role`} />
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
### code
|
|
@@ -34,7 +34,7 @@ class Seller extends VendureEntity implements SoftDeletable, HasCustomFields {
|
|
|
34
34
|
|
|
35
35
|
### constructor
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
37
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>>) => Seller`} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### deletedAt
|
|
@@ -33,7 +33,7 @@ class SettingsStoreEntry extends VendureEntity {
|
|
|
33
33
|
|
|
34
34
|
### constructor
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(input?: Partial
|
|
36
|
+
<MemberInfo kind="method" type={`(input?: Partial<<a href='/reference/typescript-api/entities/settings-store-entry#settingsstoreentry'>SettingsStoreEntry</a>>) => SettingsStoreEntry`} />
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
### key
|
|
@@ -56,7 +56,7 @@ class ShippingLine extends VendureEntity implements HasCustomFields {
|
|
|
56
56
|
|
|
57
57
|
### constructor
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
59
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>>) => ShippingLine`} />
|
|
60
60
|
|
|
61
61
|
|
|
62
62
|
### shippingMethodId
|
|
@@ -49,7 +49,7 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
|
|
|
49
49
|
|
|
50
50
|
### constructor
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
52
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>) => ShippingMethod`} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
### deletedAt
|
|
@@ -94,7 +94,7 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
|
|
|
94
94
|
|
|
95
95
|
### translations
|
|
96
96
|
|
|
97
|
-
<MemberInfo kind="property" type={`Array
|
|
97
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>>`} />
|
|
98
98
|
|
|
99
99
|
|
|
100
100
|
### customFields
|
|
@@ -104,12 +104,12 @@ class ShippingMethod extends VendureEntity implements ChannelAware, SoftDeletabl
|
|
|
104
104
|
|
|
105
105
|
### apply
|
|
106
106
|
|
|
107
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise
|
|
107
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculationresult'>ShippingCalculationResult</a> | undefined>`} />
|
|
108
108
|
|
|
109
109
|
|
|
110
110
|
### test
|
|
111
111
|
|
|
112
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise
|
|
112
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<boolean>`} />
|
|
113
113
|
|
|
114
114
|
|
|
115
115
|
### toJSON
|
|
@@ -43,7 +43,7 @@ class StockLevel extends VendureEntity implements HasCustomFields {
|
|
|
43
43
|
|
|
44
44
|
### constructor
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
46
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>>) => StockLevel`} />
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
### productVariant
|
|
@@ -42,7 +42,7 @@ class StockLocation extends VendureEntity implements HasCustomFields, ChannelAwa
|
|
|
42
42
|
|
|
43
43
|
### constructor
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
45
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>) => StockLocation`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### name
|
|
@@ -102,7 +102,7 @@ class Allocation extends StockMovement {
|
|
|
102
102
|
|
|
103
103
|
### constructor
|
|
104
104
|
|
|
105
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
105
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>>) => Allocation`} />
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
### orderLine
|
|
@@ -142,7 +142,7 @@ class Cancellation extends StockMovement {
|
|
|
142
142
|
|
|
143
143
|
### constructor
|
|
144
144
|
|
|
145
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
145
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>>) => Cancellation`} />
|
|
146
146
|
|
|
147
147
|
|
|
148
148
|
### orderLine
|
|
@@ -183,7 +183,7 @@ class Release extends StockMovement {
|
|
|
183
183
|
|
|
184
184
|
### constructor
|
|
185
185
|
|
|
186
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
186
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#release'>Release</a>>) => Release`} />
|
|
187
187
|
|
|
188
188
|
|
|
189
189
|
### orderLine
|
|
@@ -223,7 +223,7 @@ class Sale extends StockMovement {
|
|
|
223
223
|
|
|
224
224
|
### constructor
|
|
225
225
|
|
|
226
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
226
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>>) => Sale`} />
|
|
227
227
|
|
|
228
228
|
|
|
229
229
|
### orderLine
|
|
@@ -261,7 +261,7 @@ class StockAdjustment extends StockMovement {
|
|
|
261
261
|
|
|
262
262
|
### constructor
|
|
263
263
|
|
|
264
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
264
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a>>) => StockAdjustment`} />
|
|
265
265
|
|
|
266
266
|
|
|
267
267
|
|
|
@@ -43,7 +43,7 @@ class Surcharge extends VendureEntity {
|
|
|
43
43
|
|
|
44
44
|
### constructor
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
46
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>>) => Surcharge`} />
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
### description
|
|
@@ -26,7 +26,7 @@ class Tag extends VendureEntity {
|
|
|
26
26
|
|
|
27
27
|
### constructor
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
29
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>>) => Tag`} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
### value
|
|
@@ -34,7 +34,7 @@ class TaxCategory extends VendureEntity implements HasCustomFields {
|
|
|
34
34
|
|
|
35
35
|
### constructor
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
37
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>) => TaxCategory`} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### name
|
|
@@ -54,7 +54,7 @@ class TaxRate extends VendureEntity implements HasCustomFields {
|
|
|
54
54
|
|
|
55
55
|
### constructor
|
|
56
56
|
|
|
57
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
57
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>) => TaxRate`} />
|
|
58
58
|
|
|
59
59
|
|
|
60
60
|
### name
|
|
@@ -47,7 +47,7 @@ class User extends VendureEntity implements HasCustomFields, SoftDeletable {
|
|
|
47
47
|
|
|
48
48
|
### constructor
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
50
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/user#user'>User</a>>) => User`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### deletedAt
|
|
@@ -25,7 +25,7 @@ class VendureEntity {
|
|
|
25
25
|
|
|
26
26
|
### constructor
|
|
27
27
|
|
|
28
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
28
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>>) => VendureEntity`} />
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
### id
|
|
@@ -39,7 +39,7 @@ class Zone extends VendureEntity implements HasCustomFields {
|
|
|
39
39
|
|
|
40
40
|
### constructor
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
42
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>) => Zone`} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### name
|
|
@@ -72,13 +72,13 @@ interface ErrorHandlerStrategy extends InjectableStrategy {
|
|
|
72
72
|
|
|
73
73
|
### handleServerError
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="method" type={`(exception: Error, context: { host: ArgumentsHost }) => void | Promise
|
|
75
|
+
<MemberInfo kind="method" type={`(exception: Error, context: { host: ArgumentsHost }) => void | Promise<void>`} />
|
|
76
76
|
|
|
77
77
|
This method will be invoked for any error thrown during the execution of the
|
|
78
78
|
server.
|
|
79
79
|
### handleWorkerError
|
|
80
80
|
|
|
81
|
-
<MemberInfo kind="method" type={`(exception: Error, context: { job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a> }) => void | Promise
|
|
81
|
+
<MemberInfo kind="method" type={`(exception: Error, context: { job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a> }) => void | Promise<void>`} />
|
|
82
82
|
|
|
83
83
|
This method will be invoked for any error thrown during the execution of a
|
|
84
84
|
job on the worker.
|
|
@@ -24,13 +24,13 @@ type BlockingEventHandlerOptions<T extends VendureEvent> = {
|
|
|
24
24
|
|
|
25
25
|
### event
|
|
26
26
|
|
|
27
|
-
<MemberInfo kind="property" type={`Type
|
|
27
|
+
<MemberInfo kind="property" type={`Type<T> | Array<Type<T>>`} />
|
|
28
28
|
|
|
29
29
|
The event type to which the handler should listen.
|
|
30
30
|
Can be a single event type or an array of event types.
|
|
31
31
|
### handler
|
|
32
32
|
|
|
33
|
-
<MemberInfo kind="property" type={`(event: T)
|
|
33
|
+
<MemberInfo kind="property" type={`(event: T) => void | Promise<void>`} />
|
|
34
34
|
|
|
35
35
|
The handler function which will be executed when the event is published.
|
|
36
36
|
If the handler returns a Promise, the event publishing code will wait for the Promise to resolve
|
|
@@ -70,7 +70,7 @@ class EventBus implements OnModuleDestroy {
|
|
|
70
70
|
|
|
71
71
|
### publish
|
|
72
72
|
|
|
73
|
-
<MemberInfo kind="method" type={`(event: T) => Promise
|
|
73
|
+
<MemberInfo kind="method" type={`(event: T) => Promise<void>`} />
|
|
74
74
|
|
|
75
75
|
Publish an event which any subscribers can react to.
|
|
76
76
|
|
|
@@ -81,7 +81,7 @@ await eventBus.publish(new SomeEvent());
|
|
|
81
81
|
```
|
|
82
82
|
### ofType
|
|
83
83
|
|
|
84
|
-
<MemberInfo kind="method" type={`(type: Type
|
|
84
|
+
<MemberInfo kind="method" type={`(type: Type<T>) => Observable<T>`} />
|
|
85
85
|
|
|
86
86
|
Returns an RxJS Observable stream of events of the given type.
|
|
87
87
|
If the event contains a <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> object, the subscriber
|
|
@@ -91,7 +91,7 @@ This means that the subscriber function can safely access all updated
|
|
|
91
91
|
data related to the event.
|
|
92
92
|
### filter
|
|
93
93
|
|
|
94
|
-
<MemberInfo kind="method" type={`(predicate: (event: <a href='/reference/typescript-api/events/vendure-event#vendureevent'>VendureEvent</a>)
|
|
94
|
+
<MemberInfo kind="method" type={`(predicate: (event: <a href='/reference/typescript-api/events/vendure-event#vendureevent'>VendureEvent</a>) => boolean) => Observable<T>`} />
|
|
95
95
|
|
|
96
96
|
Returns an RxJS Observable stream of events filtered by a custom predicate.
|
|
97
97
|
If the event contains a <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> object, the subscriber
|
|
@@ -101,7 +101,7 @@ This means that the subscriber function can safely access all updated
|
|
|
101
101
|
data related to the event.
|
|
102
102
|
### registerBlockingEventHandler
|
|
103
103
|
|
|
104
|
-
<MemberInfo kind="method" type={`(handlerOptions: <a href='/reference/typescript-api/events/blocking-event-handler-options#blockingeventhandleroptions'>BlockingEventHandlerOptions</a
|
|
104
|
+
<MemberInfo kind="method" type={`(handlerOptions: <a href='/reference/typescript-api/events/blocking-event-handler-options#blockingeventhandleroptions'>BlockingEventHandlerOptions</a><T>) => `} since="2.2.0" />
|
|
105
105
|
|
|
106
106
|
Register an event handler function which will be executed when an event of the given type is published,
|
|
107
107
|
and will block execution of the code which published the event until the handler has completed.
|