@vendure/docs 0.0.0-202601211551 → 0.0.0-202601211609
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 +5 -5
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
- 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 +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +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 +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
- 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-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/services/data-service.mdx +9 -9
- 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 +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +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 +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +6 -6
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +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 +3 -3
- 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 +1 -1
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +10 -10
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +2 -2
- 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/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 +2 -2
- 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 +2 -2
- 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 +5 -5
- 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 +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-options.mdx +1 -1
- 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 +14 -14
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
- 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/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 +3 -3
- package/docs/reference/typescript-api/events/event-types.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +1 -1
- 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 +1 -1
- 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 +4 -4
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.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 +1 -1
- 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 +1 -1
- 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 +1 -1
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +1 -1
- 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 +3 -3
- 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 +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 +1 -1
- 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/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
|
@@ -41,32 +41,32 @@ class SqlJobQueueStrategy extends PollingJobQueueStrategy implements Inspectable
|
|
|
41
41
|
|
|
42
42
|
### add
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<Data>`, jobOptions?: JobQueueStrategyJobOptions<Data
|
|
44
|
+
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<Data>`, jobOptions?: `JobQueueStrategyJobOptions<Data>`) => `Promise<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<Data>>``} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### next
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="method" type={`(queueName: string) => Promise
|
|
49
|
+
<MemberInfo kind="method" type={`(queueName: string) => `Promise<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``} />
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
### update
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<any>`) => Promise<void
|
|
54
|
+
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<any>`) => `Promise<void>``} />
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
### findMany
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise
|
|
59
|
+
<MemberInfo kind="method" type={`(options?: JobListOptions) => `Promise<`<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`>>``} />
|
|
60
60
|
|
|
61
61
|
|
|
62
62
|
### findOne
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="method" type={`(id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise
|
|
64
|
+
<MemberInfo kind="method" type={`(id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => `Promise<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>` | undefined>``} />
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
### findManyById
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="method" type={`(ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise
|
|
69
|
+
<MemberInfo kind="method" type={`(ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => `Promise<`<a href='/reference/typescript-api/job-queue/job#job'>Job</a>`[]>``} />
|
|
70
70
|
|
|
71
71
|
|
|
72
72
|
### removeSettledJobs
|
|
@@ -28,7 +28,7 @@ class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
|
|
|
28
28
|
|
|
29
29
|
### updates
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(options?: <a href='/reference/typescript-api/job-queue/types#jobupdateoptions'>JobUpdateOptions</a>) => Observable
|
|
31
|
+
<MemberInfo kind="method" type={`(options?: <a href='/reference/typescript-api/job-queue/types#jobupdateoptions'>JobUpdateOptions</a>) => `Observable<`<a href='/reference/typescript-api/job-queue/types#jobupdate'>JobUpdate</a>`<T>>``} />
|
|
32
32
|
|
|
33
33
|
Returns an Observable stream of updates to the Job. Works by polling the current JobQueueStrategy's `findOne()` method
|
|
34
34
|
to obtain updates. If the updates are not subscribed to, then no polling occurs.
|
|
@@ -72,7 +72,7 @@ interface CreateQueueOptions<T extends JobData<T>> {
|
|
|
72
72
|
The name of the queue, e.g. "image processing", "re-indexing" etc.
|
|
73
73
|
### process
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="property" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<T
|
|
75
|
+
<MemberInfo kind="property" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>`<T>) => Promise<any>``} />
|
|
76
76
|
|
|
77
77
|
Defines the work to be done for each job in the queue. The returned promise
|
|
78
78
|
should resolve when the job is complete, or be rejected in case of an error.
|
|
@@ -15,7 +15,7 @@ Parameters
|
|
|
15
15
|
|
|
16
16
|
### userConfig
|
|
17
17
|
|
|
18
|
-
<MemberInfo kind="parameter" type={
|
|
18
|
+
<MemberInfo kind="parameter" type={``Partial<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
|
|
19
19
|
|
|
20
20
|
### options
|
|
21
21
|
|
|
@@ -14,5 +14,5 @@ Parameters
|
|
|
14
14
|
|
|
15
15
|
### userConfig
|
|
16
16
|
|
|
17
|
-
<MemberInfo kind="parameter" type={
|
|
17
|
+
<MemberInfo kind="parameter" type={``Partial<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
|
|
18
18
|
|
|
@@ -14,5 +14,5 @@ Parameters
|
|
|
14
14
|
|
|
15
15
|
### userConfig
|
|
16
16
|
|
|
17
|
-
<MemberInfo kind="parameter" type={
|
|
17
|
+
<MemberInfo kind="parameter" type={``Partial<`<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>`>``} />
|
|
18
18
|
|
|
@@ -27,7 +27,7 @@ class ActiveOrderService {
|
|
|
27
27
|
|
|
28
28
|
### getOrderFromContext
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise
|
|
30
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``} />
|
|
31
31
|
|
|
32
32
|
Gets the active Order object from the current Session. Optionally can create a new Order if
|
|
33
33
|
no active Order exists.
|
|
@@ -36,27 +36,27 @@ Intended to be used at the Resolver layer for those resolvers that depend upon a
|
|
|
36
36
|
being present.
|
|
37
37
|
### getOrderFromContext
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createIfNotExists: true) => Promise
|
|
39
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createIfNotExists: true) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>``} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
### getOrderFromContext
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createIfNotExists: = false) => Promise
|
|
44
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createIfNotExists: = false) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### getActiveOrder
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined) => Promise
|
|
49
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``} since="1.9.0" />
|
|
50
50
|
|
|
51
51
|
Retrieves the active Order based on the configured <DocsLink href="/reference/typescript-api/orders/active-order-strategy#activeorderstrategy">ActiveOrderStrategy</DocsLink>.
|
|
52
52
|
### getActiveOrder
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined, createIfNotExists: true) => Promise
|
|
54
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined, createIfNotExists: true) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>``} />
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
### getActiveOrder
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: Record<string, any> | undefined } | undefined
|
|
59
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: `{ [strategyName: string]: Record<string, any> | undefined } | undefined`, createIfNotExists: = false) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``} />
|
|
60
60
|
|
|
61
61
|
|
|
62
62
|
|
|
@@ -141,7 +141,7 @@ The name of the strategy, e.g. "orderByToken", which will also be used as the
|
|
|
141
141
|
field name in the ActiveOrderInput type.
|
|
142
142
|
### defineInputType
|
|
143
143
|
|
|
144
|
-
<MemberInfo kind="property" type={
|
|
144
|
+
<MemberInfo kind="property" type={``() => DocumentNode``} />
|
|
145
145
|
|
|
146
146
|
Defines the type of the GraphQL Input object expected by the `activeOrderInput`
|
|
147
147
|
input argument.
|
|
@@ -177,7 +177,7 @@ activeOrder(activeOrderInput: {
|
|
|
177
177
|
the _first_ input will be assumed to be the top-level input.
|
|
178
178
|
### createActiveOrder
|
|
179
179
|
|
|
180
|
-
<MemberInfo kind="property" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a
|
|
180
|
+
<MemberInfo kind="property" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`, input: InputType) => Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>`>``} />
|
|
181
181
|
|
|
182
182
|
Certain mutations such as `addItemToOrder` can automatically create a new Order if one does not exist.
|
|
183
183
|
In these cases, this method will be called to create the new Order.
|
|
@@ -186,7 +186,7 @@ If automatic creation of an Order does not make sense in your strategy, then lea
|
|
|
186
186
|
undefined. You'll then need to take care of creating an order manually by defining a custom mutation.
|
|
187
187
|
### determineActiveOrder
|
|
188
188
|
|
|
189
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: InputType) => Promise
|
|
189
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: InputType) => `Promise<`<a href='/reference/typescript-api/entities/order#order'>Order</a>` | undefined>``} />
|
|
190
190
|
|
|
191
191
|
This method is used to determine the active Order based on the current RequestContext in addition to any
|
|
192
192
|
input values provided, as defined by the `defineInputType` method of this strategy.
|
|
@@ -35,7 +35,7 @@ interface ChangedPriceHandlingStrategy extends InjectableStrategy {
|
|
|
35
35
|
|
|
36
36
|
### handlePriceChange
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, current: <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a
|
|
38
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, current: <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>` | Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``} />
|
|
39
39
|
|
|
40
40
|
This method is called when adding to or adjusting OrderLines, if the latest price
|
|
41
41
|
(as determined by the ProductVariant price, potentially modified by the configured
|
|
@@ -48,7 +48,7 @@ class DefaultGuestCheckoutStrategy implements GuestCheckoutStrategy {
|
|
|
48
48
|
|
|
49
49
|
### setCustomerForOrder
|
|
50
50
|
|
|
51
|
-
<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>, input: CreateCustomerInput) => Promise
|
|
51
|
+
<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>, input: CreateCustomerInput) => `Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<SetCustomerForOrderResult, `<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>>``} />
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
|
package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx
CHANGED
|
@@ -20,7 +20,7 @@ class DefaultOrderItemPriceCalculationStrategy implements OrderItemPriceCalculat
|
|
|
20
20
|
|
|
21
21
|
### calculateUnitPrice
|
|
22
22
|
|
|
23
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a
|
|
23
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>` | Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``} />
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -20,7 +20,7 @@ class DefaultStockAllocationStrategy implements StockAllocationStrategy {
|
|
|
20
20
|
|
|
21
21
|
### shouldAllocateStock
|
|
22
22
|
|
|
23
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => boolean | Promise<boolean
|
|
23
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `boolean | Promise<boolean>``} />
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -42,7 +42,7 @@ interface GuestCheckoutStrategy extends InjectableStrategy {
|
|
|
42
42
|
|
|
43
43
|
### setCustomerForOrder
|
|
44
44
|
|
|
45
|
-
<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>, input: CreateCustomerInput) => | <a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<SetCustomerForOrderResult,
|
|
45
|
+
<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>, input: CreateCustomerInput) => | <a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<SetCustomerForOrderResult, `<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`> | Promise<`<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<SetCustomerForOrderResult, `<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`>>``} />
|
|
46
46
|
|
|
47
47
|
This method is called when the `setCustomerForOrder` mutation is executed.
|
|
48
48
|
It should return either a Customer object or an ErrorResult.
|
|
@@ -43,7 +43,7 @@ interface OrderByCodeAccessStrategy extends InjectableStrategy {
|
|
|
43
43
|
|
|
44
44
|
### canAccessOrder
|
|
45
45
|
|
|
46
|
-
<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>) => boolean | Promise<boolean
|
|
46
|
+
<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>) => `boolean | Promise<boolean>``} />
|
|
47
47
|
|
|
48
48
|
Gives or denies permission to access the requested Order
|
|
49
49
|
|
|
@@ -47,7 +47,7 @@ interface OrderCodeStrategy extends InjectableStrategy {
|
|
|
47
47
|
|
|
48
48
|
### generate
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => string | Promise<string
|
|
50
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `string | Promise<string>``} />
|
|
51
51
|
|
|
52
52
|
Generates the order code.
|
|
53
53
|
|
|
@@ -221,21 +221,21 @@ interface OrderInterceptor extends InjectableStrategy {
|
|
|
221
221
|
|
|
222
222
|
### willAddItemToOrder
|
|
223
223
|
|
|
224
|
-
<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>, input: WillAddItemToOrderInput) => Promise<void | string> | void | string
|
|
224
|
+
<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>, input: WillAddItemToOrderInput) => `Promise<void | string> | void | string``} />
|
|
225
225
|
|
|
226
226
|
Called when a new item is about to be added to the order,
|
|
227
227
|
as in the `addItemToOrder` mutation or the `addItemToOrder()` / `addItemsToOrder()` method
|
|
228
228
|
of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
|
|
229
229
|
### willAdjustOrderLine
|
|
230
230
|
|
|
231
|
-
<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>, input: WillAdjustOrderLineInput) => Promise<void | string> | void | string
|
|
231
|
+
<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>, input: WillAdjustOrderLineInput) => `Promise<void | string> | void | string``} />
|
|
232
232
|
|
|
233
233
|
Called when an existing order line is about to be adjusted,
|
|
234
234
|
as in the `adjustOrderLine` mutation or the `adjustOrderLine()` / `adjustOrderLines()` method
|
|
235
235
|
of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
|
|
236
236
|
### willRemoveItemFromOrder
|
|
237
237
|
|
|
238
|
-
<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>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => Promise<void | string> | void | string
|
|
238
|
+
<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>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => `Promise<void | string> | void | string``} />
|
|
239
239
|
|
|
240
240
|
Called when an item is about to be removed from the order,
|
|
241
241
|
as in the `removeItemFromOrder` mutation or the `removeItemFromOrder()` / `removeItemsFromOrder()` method
|
|
@@ -72,7 +72,7 @@ interface OrderItemPriceCalculationStrategy extends InjectableStrategy {
|
|
|
72
72
|
|
|
73
73
|
### calculateUnitPrice
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, orderLineCustomFields: { [key: string]: any }, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, quantity: number) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a
|
|
75
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, orderLineCustomFields: { [key: string]: any }, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, quantity: number) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>` | Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``} />
|
|
76
76
|
|
|
77
77
|
Receives the ProductVariant to be added to the Order as well as any OrderLine custom fields and returns
|
|
78
78
|
the price for a single unit.
|
|
@@ -57,7 +57,7 @@ Defines the logic used to calculate the unit price of an OrderLine when adding a
|
|
|
57
57
|
item to an Order.
|
|
58
58
|
### process
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={
|
|
60
|
+
<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a>`<any>>``} default={`[]`} />
|
|
61
61
|
|
|
62
62
|
Allows the definition of custom states and transition logic for the order process state machine.
|
|
63
63
|
Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> interface.
|
|
@@ -113,7 +113,7 @@ will be reflected in the GraphQL `OrderLine.unitPrice[WithTax]ChangeSinceAdded`
|
|
|
113
113
|
Defines the point of the order process at which the Order is set as "placed".
|
|
114
114
|
### activeOrderStrategy
|
|
115
115
|
|
|
116
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>`<any
|
|
116
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>`<any> | Array<`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>`<any>>``} default={`<a href='/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy'>DefaultActiveOrderStrategy</a>`} since="1.9.0" />
|
|
117
117
|
|
|
118
118
|
Defines the strategy used to determine the active Order when interacting with Shop API operations
|
|
119
119
|
such as `activeOrder` and `addItemToOrder`. By default, the strategy uses the active Session.
|
|
@@ -36,7 +36,7 @@ interface OrderPlacedStrategy extends InjectableStrategy {
|
|
|
36
36
|
|
|
37
37
|
### shouldSetAsPlaced
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => boolean | Promise<boolean
|
|
39
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `boolean | Promise<boolean>``} />
|
|
40
40
|
|
|
41
41
|
This method is called whenever an _active_ Order transitions from one state to another.
|
|
42
42
|
If it resolves to `true`, then the Order will be set as "placed", which means:
|
|
@@ -34,22 +34,22 @@ interface OrderProcess<State extends keyof CustomOrderStates | string> extends I
|
|
|
34
34
|
|
|
35
35
|
### transitions
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State |
|
|
37
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | `<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>`> & Partial<`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<`<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>` | State>>``} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### onTransitionStart
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State |
|
|
42
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | `<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>`>``} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### onTransitionEnd
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State |
|
|
47
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | `<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>`>``} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### onTransitionError
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State |
|
|
52
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | `<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>`>``} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
|
|
@@ -36,7 +36,7 @@ interface OrderSellerStrategy extends InjectableStrategy {
|
|
|
36
36
|
|
|
37
37
|
### setOrderLineSellerChannel
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => <a href='/reference/typescript-api/entities/channel#channel'>Channel</a
|
|
39
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>` | undefined | Promise<`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>` | undefined>``} />
|
|
40
40
|
|
|
41
41
|
This method is called whenever a new OrderLine is added to the Order via the `addItemToOrder` mutation or the
|
|
42
42
|
underlying `addItemToOrder()` method of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
|
|
@@ -45,13 +45,13 @@ It should return the Channel to which this OrderLine will be assigned, which wil
|
|
|
45
45
|
<DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink> `sellerChannel` property.
|
|
46
46
|
### splitOrder
|
|
47
47
|
|
|
48
|
-
<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>) => <a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a
|
|
48
|
+
<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>) => <a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>`[] | Promise<`<a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>`[]>``} />
|
|
49
49
|
|
|
50
50
|
Upon checkout (by default, when the Order moves from "active" to "inactive" according to the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>),
|
|
51
51
|
this method will be called in order to split the Order into multiple Orders, one for each Seller.
|
|
52
52
|
### afterSellerOrdersCreated
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, aggregateOrder: <a href='/reference/typescript-api/entities/order#order'>Order</a>, sellerOrders: <a href='/reference/typescript-api/entities/order#order'>Order</a>[]) => void | Promise<void
|
|
54
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, aggregateOrder: <a href='/reference/typescript-api/entities/order#order'>Order</a>, sellerOrders: <a href='/reference/typescript-api/entities/order#order'>Order</a>[]) => `void | Promise<void>``} />
|
|
55
55
|
|
|
56
56
|
This method is called after splitting the orders, including calculating the totals for each of the seller Orders.
|
|
57
57
|
This method can be used to set platform fee surcharges on the seller Orders as well as perform any payment processing
|
|
@@ -32,7 +32,7 @@ interface StockAllocationStrategy extends InjectableStrategy {
|
|
|
32
32
|
|
|
33
33
|
### shouldAllocateStock
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => boolean | Promise<boolean
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `boolean | Promise<boolean>``} />
|
|
36
36
|
|
|
37
37
|
This method is called whenever an Order transitions from one state to another.
|
|
38
38
|
If it resolves to `true`, then stock will be allocated for this order.
|
|
@@ -55,7 +55,7 @@ programmatically create a refund. In such a case, this method should be
|
|
|
55
55
|
omitted and any Refunds will have to be settled manually by an administrator.
|
|
56
56
|
### onStateTransitionStart
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a
|
|
58
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>`>``} />
|
|
59
59
|
|
|
60
60
|
This function, when specified, will be invoked before any transition from one <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> to another.
|
|
61
61
|
The return value (a sync / async `boolean`) is used to determine whether the transition is permitted.
|
|
@@ -27,7 +27,7 @@ Typically this should equal the Order total, unless multiple payment methods
|
|
|
27
27
|
are being used for the order.
|
|
28
28
|
### state
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="property" type={
|
|
30
|
+
<MemberInfo kind="property" type={``Exclude<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`, 'Error'>``} />
|
|
31
31
|
|
|
32
32
|
The <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> of the resulting Payment.
|
|
33
33
|
|
|
@@ -190,7 +190,7 @@ interface SettlePaymentErrorResult {
|
|
|
190
190
|
|
|
191
191
|
### state
|
|
192
192
|
|
|
193
|
-
<MemberInfo kind="property" type={
|
|
193
|
+
<MemberInfo kind="property" type={``Exclude<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`, 'Settled'>``} />
|
|
194
194
|
|
|
195
195
|
The state to transition this Payment to upon unsuccessful settlement.
|
|
196
196
|
Defaults to `Error`. Note that if using a different state, it must be
|
|
@@ -261,7 +261,7 @@ interface CancelPaymentErrorResult {
|
|
|
261
261
|
|
|
262
262
|
### state
|
|
263
263
|
|
|
264
|
-
<MemberInfo kind="property" type={
|
|
264
|
+
<MemberInfo kind="property" type={``Exclude<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`, 'Cancelled'>``} />
|
|
265
265
|
|
|
266
266
|
The state to transition this Payment to upon unsuccessful cancellation.
|
|
267
267
|
Defaults to `Error`. Note that if using a different state, it must be
|
|
@@ -32,18 +32,18 @@ Defines which <DocsLink href="/reference/typescript-api/payment/payment-method-e
|
|
|
32
32
|
<DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>s
|
|
33
33
|
### customPaymentProcess
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="property" type={
|
|
35
|
+
<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>`<any>>``} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### process
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={
|
|
40
|
+
<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>`<any>>``} default={`<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>`} since="2.0.0" />
|
|
41
41
|
|
|
42
42
|
Allows the definition of custom states and transition logic for the payment process state machine.
|
|
43
43
|
Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink> interface.
|
|
44
44
|
### refundProcess
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="property" type={
|
|
46
|
+
<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a>`<any>>``} default={`<a href='/reference/typescript-api/payment/default-refund-process#defaultrefundprocess'>defaultRefundProcess</a>`} />
|
|
47
47
|
|
|
48
48
|
Allows the definition of custom states and transition logic for the refund process state machine.
|
|
49
49
|
Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/refund-process#refundprocess">RefundProcess</DocsLink> interface.
|
|
@@ -34,22 +34,22 @@ interface PaymentProcess<State extends keyof CustomPaymentStates | string> exten
|
|
|
34
34
|
|
|
35
35
|
### transitions
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State |
|
|
37
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | `<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`> & Partial<`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>` | State>>``} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### onTransitionStart
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State |
|
|
42
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | `<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>`>``} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### onTransitionEnd
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State |
|
|
47
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | `<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>`>``} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### onTransitionError
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State |
|
|
52
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | `<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`>``} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
|
|
@@ -27,22 +27,22 @@ interface RefundProcess<State extends keyof CustomRefundStates | string> extends
|
|
|
27
27
|
|
|
28
28
|
### transitions
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State |
|
|
30
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | `<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>`> & Partial<`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<`<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>` | State>>``} />
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
### onTransitionStart
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State |
|
|
35
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | `<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>`>``} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### onTransitionEnd
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State |
|
|
40
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | `<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>`>``} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### onTransitionError
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State |
|
|
45
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | `<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>`>``} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
|
|
@@ -44,7 +44,7 @@ The plugin may extend the default Vendure GraphQL admin api by providing extende
|
|
|
44
44
|
schema definitions and any required resolvers.
|
|
45
45
|
### entities
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={
|
|
47
|
+
<MemberInfo kind="property" type={``Array<Type<any>> | (() => Array<Type<any>>)``} />
|
|
48
48
|
|
|
49
49
|
The plugin may define custom [TypeORM database entities](https://typeorm.io/#/entities).
|
|
50
50
|
### dashboard
|
|
@@ -94,7 +94,7 @@ interface APIExtensionDefinition {
|
|
|
94
94
|
|
|
95
95
|
### schema
|
|
96
96
|
|
|
97
|
-
<MemberInfo kind="property" type={
|
|
97
|
+
<MemberInfo kind="property" type={``DocumentNode | ((schema?: GraphQLSchema) => DocumentNode | undefined)``} />
|
|
98
98
|
|
|
99
99
|
Extensions to the schema.
|
|
100
100
|
Passes the current schema as an optional argument, allowing the extension to be based on the existing schema.
|
|
@@ -109,13 +109,13 @@ const schema = gql`extend type SearchReindexResponse {
|
|
|
109
109
|
```
|
|
110
110
|
### resolvers
|
|
111
111
|
|
|
112
|
-
<MemberInfo kind="property" type={
|
|
112
|
+
<MemberInfo kind="property" type={``Array<Type<any>> | (() => Array<Type<any>>)``} />
|
|
113
113
|
|
|
114
114
|
An array of resolvers for the schema extensions. Should be defined as [Nestjs GraphQL resolver](https://docs.nestjs.com/graphql/resolvers-map)
|
|
115
115
|
classes, i.e. using the Nest `@Resolver()` decorator etc.
|
|
116
116
|
### scalars
|
|
117
117
|
|
|
118
|
-
<MemberInfo kind="property" type={
|
|
118
|
+
<MemberInfo kind="property" type={``Record<string, GraphQLScalarType> | (() => Record<string, GraphQLScalarType>)``} since="1.7.0" />
|
|
119
119
|
|
|
120
120
|
A map of GraphQL scalar types which should correspond to any custom scalars defined in your schema.
|
|
121
121
|
Read more about defining custom scalars in the
|
|
@@ -21,7 +21,7 @@ interface CatalogOptions {
|
|
|
21
21
|
|
|
22
22
|
### collectionFilters
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="property" type={
|
|
24
|
+
<MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a>`<any>>``} default={`defaultCollectionFilters`} />
|
|
25
25
|
|
|
26
26
|
Allows custom <DocsLink href="/reference/typescript-api/configuration/collection-filter#collectionfilter">CollectionFilter</DocsLink>s to be defined.
|
|
27
27
|
### productVariantPriceSelectionStrategy
|