@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
|
@@ -51,22 +51,22 @@ class RedisCacheStrategy implements CacheStrategy {
|
|
|
51
51
|
|
|
52
52
|
### get
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
54
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`} />
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
### set
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise
|
|
59
|
+
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`} />
|
|
60
60
|
|
|
61
61
|
|
|
62
62
|
### delete
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
64
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<void>`} />
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
### invalidateTags
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="method" type={`(tags: string[]) => Promise
|
|
69
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
70
70
|
|
|
71
71
|
|
|
72
72
|
|
|
@@ -40,12 +40,12 @@ Get a value from the RequestContext cache. If the value is not found, the `getDe
|
|
|
40
40
|
function will be called to get the value, which will then be cached and returned.
|
|
41
41
|
### get
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: ()
|
|
43
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: () => T) => T`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### get
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: ()
|
|
48
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: () => T) => T | Promise<T> | undefined`} />
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
|
|
@@ -26,13 +26,13 @@ interface SelfRefreshingCache<V, RefreshArgs extends any[] = []> {
|
|
|
26
26
|
|
|
27
27
|
### value
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="method" type={`(refreshArgs: RefreshArgs | [undefined] | []) => Promise
|
|
29
|
+
<MemberInfo kind="method" type={`(refreshArgs: RefreshArgs | [undefined] | []) => Promise<V>`} />
|
|
30
30
|
|
|
31
31
|
The current value of the cache. If the value is stale, the data will be refreshed and then
|
|
32
32
|
the fresh value will be returned.
|
|
33
33
|
### memoize
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(args: Args, refreshArgs: RefreshArgs, fn: (value: V, ...args: Args)
|
|
35
|
+
<MemberInfo kind="method" type={`(args: Args, refreshArgs: RefreshArgs, fn: (value: V, ...args: Args) => R) => Promise<R>`} />
|
|
36
36
|
|
|
37
37
|
Allows a memoized function to be defined. For the given arguments, the `fn` function will
|
|
38
38
|
be invoked only once and its output cached and returned.
|
|
@@ -40,7 +40,7 @@ The results cache is cleared along with the rest of the cache according to the c
|
|
|
40
40
|
`ttl` value.
|
|
41
41
|
### refresh
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(args: RefreshArgs) => Promise
|
|
43
|
+
<MemberInfo kind="method" type={`(args: RefreshArgs) => Promise<V>`} />
|
|
44
44
|
|
|
45
45
|
Force a refresh of the value, e.g. when it is known that the value has changed such as after
|
|
46
46
|
an update operation to the source data in the database.
|
|
@@ -86,13 +86,13 @@ The time-to-live (ttl) in milliseconds for the cache. After this time, the value
|
|
|
86
86
|
and will be refreshed the next time it is accessed.
|
|
87
87
|
### refresh
|
|
88
88
|
|
|
89
|
-
<MemberInfo kind="property" type={`{ fn: (...args: RefreshArgs)
|
|
89
|
+
<MemberInfo kind="property" type={`{ fn: (...args: RefreshArgs) => Promise<V>; /** * Default arguments, passed to refresh function */ defaultArgs: RefreshArgs; }`} />
|
|
90
90
|
|
|
91
91
|
The function which is used to refresh the value of the cache.
|
|
92
92
|
This function should return a Promise which resolves to the new value.
|
|
93
93
|
### getTimeFn
|
|
94
94
|
|
|
95
|
-
<MemberInfo kind="property" type={`()
|
|
95
|
+
<MemberInfo kind="property" type={`() => number`} />
|
|
96
96
|
|
|
97
97
|
Intended for unit testing the SelfRefreshingCache only.
|
|
98
98
|
By default uses `() => new Date().getTime()`
|
|
@@ -143,7 +143,7 @@ Parameters
|
|
|
143
143
|
|
|
144
144
|
### config
|
|
145
145
|
|
|
146
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/cache/self-refreshing-cache#selfrefreshingcacheconfig'>SelfRefreshingCacheConfig</a
|
|
146
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/cache/self-refreshing-cache#selfrefreshingcacheconfig'>SelfRefreshingCacheConfig</a><V, RefreshArgs>`} />
|
|
147
147
|
|
|
148
148
|
### refreshArgs
|
|
149
149
|
|
|
@@ -34,7 +34,7 @@ index.html, the compiled js bundles etc.
|
|
|
34
34
|
Specifies the url route to the Admin UI app.
|
|
35
35
|
### compile
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="property" type={`()
|
|
37
|
+
<MemberInfo kind="property" type={`() => Promise<void>`} />
|
|
38
38
|
|
|
39
39
|
The function which will be invoked to start the app compilation process.
|
|
40
40
|
|
|
@@ -38,7 +38,7 @@ The port on which the dev server is listening. Overrides the value set by `Admin
|
|
|
38
38
|
Specifies the url route to the Admin UI app.
|
|
39
39
|
### compile
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="property" type={`()
|
|
41
|
+
<MemberInfo kind="property" type={`() => Promise<void>`} />
|
|
42
42
|
|
|
43
43
|
The function which will be invoked to start the app compilation process.
|
|
44
44
|
|
|
@@ -27,7 +27,7 @@ class AsyncQueue {
|
|
|
27
27
|
|
|
28
28
|
### push
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="method" type={`(task: Task
|
|
30
|
+
<MemberInfo kind="method" type={`(task: Task<T>) => Promise<T>`} />
|
|
31
31
|
|
|
32
32
|
Pushes a new task onto the queue, upon which the task will either execute immediately or
|
|
33
33
|
(if the number of running tasks is equal to the concurrency limit) enqueue the task to
|
|
@@ -72,7 +72,7 @@ Parameters
|
|
|
72
72
|
|
|
73
73
|
### userConfig
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="parameter" type={`Partial
|
|
75
|
+
<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
|
|
76
76
|
|
|
77
77
|
### options
|
|
78
78
|
|
|
@@ -103,7 +103,7 @@ interface BootstrapOptions {
|
|
|
103
103
|
These options get passed directly to the `NestFactory.create()` method.
|
|
104
104
|
### ignoreCompatibilityErrorsForPlugins
|
|
105
105
|
|
|
106
|
-
<MemberInfo kind="property" type={`Array
|
|
106
|
+
<MemberInfo kind="property" type={`Array<DynamicModule | Type<any>>`} default={`[]`} since="3.1.0" />
|
|
107
107
|
|
|
108
108
|
By default, if a plugin specifies a compatibility range which does not include the current
|
|
109
109
|
Vendure version, the bootstrap process will fail. This option allows you to ignore compatibility
|
|
@@ -22,7 +22,7 @@ interface InjectableStrategy {
|
|
|
22
22
|
|
|
23
23
|
### init
|
|
24
24
|
|
|
25
|
-
<MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>)
|
|
25
|
+
<MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => void | Promise<void>`} />
|
|
26
26
|
|
|
27
27
|
Defines setup logic to be run during application bootstrap. Receives
|
|
28
28
|
the <a href='/reference/typescript-api/common/injector#injector'>Injector</a> as an argument, which allows application providers
|
|
@@ -39,7 +39,7 @@ async init(injector: Injector) {
|
|
|
39
39
|
```
|
|
40
40
|
### destroy
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={`()
|
|
42
|
+
<MemberInfo kind="property" type={`() => void | Promise<void>`} />
|
|
43
43
|
|
|
44
44
|
Defines teardown logic to be run before application shutdown.
|
|
45
45
|
|
|
@@ -30,13 +30,13 @@ class Injector {
|
|
|
30
30
|
|
|
31
31
|
### get
|
|
32
32
|
|
|
33
|
-
<MemberInfo kind="method" type={`(typeOrToken: Type
|
|
33
|
+
<MemberInfo kind="method" type={`(typeOrToken: Type<T> | string | symbol) => R`} />
|
|
34
34
|
|
|
35
35
|
Retrieve an instance of the given type from the app's dependency injection container.
|
|
36
36
|
Wraps the Nestjs `ModuleRef.get()` method.
|
|
37
37
|
### resolve
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(typeOrToken: Type
|
|
39
|
+
<MemberInfo kind="method" type={`(typeOrToken: Type<T> | string | symbol, contextId?: ContextId) => Promise<R>`} />
|
|
40
40
|
|
|
41
41
|
Retrieve an instance of the given scoped provider (transient or request-scoped) from the
|
|
42
42
|
app's dependency injection container.
|
|
@@ -80,7 +80,7 @@ type ConfigArgs = {
|
|
|
80
80
|
|
|
81
81
|
### [index]
|
|
82
82
|
|
|
83
|
-
<MemberInfo kind="property" type={`ConfigArgDef
|
|
83
|
+
<MemberInfo kind="property" type={`ConfigArgDef<<a href='/reference/typescript-api/configurable-operation-def/config-arg-type#configargtype'>ConfigArgType</a>>`} />
|
|
84
84
|
|
|
85
85
|
|
|
86
86
|
|
package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx
CHANGED
|
@@ -43,17 +43,17 @@ type DefaultFormConfigHash = {
|
|
|
43
43
|
|
|
44
44
|
### 'boolean-form-input'
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="property" type={`Record
|
|
46
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
### 'currency-form-input'
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="property" type={`Record
|
|
51
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
### 'customer-group-form-input'
|
|
55
55
|
|
|
56
|
-
<MemberInfo kind="property" type={`Record
|
|
56
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
### 'date-form-input'
|
|
@@ -63,7 +63,7 @@ type DefaultFormConfigHash = {
|
|
|
63
63
|
|
|
64
64
|
### 'facet-value-form-input'
|
|
65
65
|
|
|
66
|
-
<MemberInfo kind="property" type={`Record
|
|
66
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
67
67
|
|
|
68
68
|
|
|
69
69
|
### 'json-editor-form-input'
|
|
@@ -83,27 +83,27 @@ type DefaultFormConfigHash = {
|
|
|
83
83
|
|
|
84
84
|
### 'password-form-input'
|
|
85
85
|
|
|
86
|
-
<MemberInfo kind="property" type={`Record
|
|
86
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
87
87
|
|
|
88
88
|
|
|
89
89
|
### 'product-selector-form-input'
|
|
90
90
|
|
|
91
|
-
<MemberInfo kind="property" type={`Record
|
|
91
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
92
92
|
|
|
93
93
|
|
|
94
94
|
### 'relation-form-input'
|
|
95
95
|
|
|
96
|
-
<MemberInfo kind="property" type={`Record
|
|
96
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
97
97
|
|
|
98
98
|
|
|
99
99
|
### 'rich-text-form-input'
|
|
100
100
|
|
|
101
|
-
<MemberInfo kind="property" type={`Record
|
|
101
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
102
102
|
|
|
103
103
|
|
|
104
104
|
### 'select-form-input'
|
|
105
105
|
|
|
106
|
-
<MemberInfo kind="property" type={`{ options?: Array
|
|
106
|
+
<MemberInfo kind="property" type={`{ options?: Array<{ value: string; label?: Array<Omit<LocalizedString, '__typename'>> }>; }`} />
|
|
107
107
|
|
|
108
108
|
|
|
109
109
|
### 'text-form-input'
|
|
@@ -123,12 +123,12 @@ type DefaultFormConfigHash = {
|
|
|
123
123
|
|
|
124
124
|
### 'combination-mode-form-input'
|
|
125
125
|
|
|
126
|
-
<MemberInfo kind="property" type={`Record
|
|
126
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
127
127
|
|
|
128
128
|
|
|
129
129
|
### 'struct-form-input'
|
|
130
130
|
|
|
131
|
-
<MemberInfo kind="property" type={`Record
|
|
131
|
+
<MemberInfo kind="property" type={`Record<string, never>`} />
|
|
132
132
|
|
|
133
133
|
|
|
134
134
|
|
|
@@ -113,7 +113,7 @@ class ConfigurableOperationDef<T extends ConfigArgs = ConfigArgs> {
|
|
|
113
113
|
|
|
114
114
|
### constructor
|
|
115
115
|
|
|
116
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a
|
|
116
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a><T>) => ConfigurableOperationDef`} />
|
|
117
117
|
|
|
118
118
|
|
|
119
119
|
### init
|
|
@@ -134,7 +134,7 @@ Convert a ConfigurableOperationDef into a ConfigurableOperationDefinition object
|
|
|
134
134
|
so that it can be sent via the API.
|
|
135
135
|
### argsArrayToHash
|
|
136
136
|
|
|
137
|
-
<MemberInfo kind="method" type={`(args: ConfigArg[]) => ConfigArgValues
|
|
137
|
+
<MemberInfo kind="method" type={`(args: ConfigArg[]) => ConfigArgValues<T>`} />
|
|
138
138
|
|
|
139
139
|
Coverts an array of ConfigArgs into a hash object:
|
|
140
140
|
|
|
@@ -94,13 +94,13 @@ The maximum number of items that may be returned by a query which returns a `Pag
|
|
|
94
94
|
this is the upper limit of the `take` input option.
|
|
95
95
|
### adminApiValidationRules
|
|
96
96
|
|
|
97
|
-
<MemberInfo kind="property" type={`Array
|
|
97
|
+
<MemberInfo kind="property" type={`Array<(context: ValidationContext) => any>`} default={`[]`} />
|
|
98
98
|
|
|
99
99
|
Custom functions to use as additional validation rules when validating the schema for the admin GraphQL API
|
|
100
100
|
[ApolloServer validation rules](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#validationrules).
|
|
101
101
|
### shopApiValidationRules
|
|
102
102
|
|
|
103
|
-
<MemberInfo kind="property" type={`Array
|
|
103
|
+
<MemberInfo kind="property" type={`Array<(context: ValidationContext) => any>`} default={`[]`} />
|
|
104
104
|
|
|
105
105
|
Custom functions to use as additional validation rules when validating the schema for the shop GraphQL API
|
|
106
106
|
[ApolloServer validation rules](https://www.apollographql.com/docs/apollo-server/api/apollo-server/#validationrules).
|
|
@@ -54,7 +54,7 @@ class CollectionFilter<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
|
|
|
54
54
|
apply(qb: SelectQueryBuilder<ProductVariant>, args: ConfigArg[]) => SelectQueryBuilder<ProductVariant>;
|
|
55
55
|
}
|
|
56
56
|
```
|
|
57
|
-
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a
|
|
57
|
+
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a><T></code>
|
|
58
58
|
|
|
59
59
|
|
|
60
60
|
|
|
@@ -62,12 +62,12 @@ class CollectionFilter<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
|
|
|
62
62
|
|
|
63
63
|
### constructor
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="method" type={`(config: CollectionFilterConfig
|
|
65
|
+
<MemberInfo kind="method" type={`(config: CollectionFilterConfig<T>) => CollectionFilter`} />
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
### apply
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="method" type={`(qb: SelectQueryBuilder
|
|
70
|
+
<MemberInfo kind="method" type={`(qb: SelectQueryBuilder<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>, args: ConfigArg[]) => SelectQueryBuilder<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>`} />
|
|
71
71
|
|
|
72
72
|
|
|
73
73
|
|
|
@@ -105,7 +105,7 @@ class EntityDuplicator<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
|
|
|
105
105
|
}) => Promise<VendureEntity>;
|
|
106
106
|
}
|
|
107
107
|
```
|
|
108
|
-
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a
|
|
108
|
+
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a><T></code>
|
|
109
109
|
|
|
110
110
|
|
|
111
111
|
|
|
@@ -113,12 +113,12 @@ class EntityDuplicator<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
|
|
|
113
113
|
|
|
114
114
|
### constructor
|
|
115
115
|
|
|
116
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicatorconfig'>EntityDuplicatorConfig</a
|
|
116
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicatorconfig'>EntityDuplicatorConfig</a><T>) => EntityDuplicator`} />
|
|
117
117
|
|
|
118
118
|
|
|
119
119
|
### duplicate
|
|
120
120
|
|
|
121
|
-
<MemberInfo kind="method" type={`(input: { ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>; entityName: string; id: <a href='/reference/typescript-api/common/id#id'>ID</a>; args: ConfigArg[]; }) => Promise
|
|
121
|
+
<MemberInfo kind="method" type={`(input: { ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>; entityName: string; id: <a href='/reference/typescript-api/common/id#id'>ID</a>; args: ConfigArg[]; }) => Promise<<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>>`} />
|
|
122
122
|
|
|
123
123
|
|
|
124
124
|
|
|
@@ -155,7 +155,7 @@ interface EntityDuplicatorConfig<T extends ConfigArgs> extends ConfigurableOpera
|
|
|
155
155
|
duplicate: DuplicateEntityFn<T>;
|
|
156
156
|
}
|
|
157
157
|
```
|
|
158
|
-
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a
|
|
158
|
+
* Extends: <code><a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a><T></code>
|
|
159
159
|
|
|
160
160
|
|
|
161
161
|
|
|
@@ -163,7 +163,7 @@ interface EntityDuplicatorConfig<T extends ConfigArgs> extends ConfigurableOpera
|
|
|
163
163
|
|
|
164
164
|
### requiresPermission
|
|
165
165
|
|
|
166
|
-
<MemberInfo kind="property" type={`Array
|
|
166
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string> | <a href='/reference/typescript-api/common/permission#permission'>Permission</a> | string`} />
|
|
167
167
|
|
|
168
168
|
The permissions required in order to execute this duplicator. If an array is passed,
|
|
169
169
|
then the administrator must have at least one of the permissions in the array.
|
|
@@ -174,7 +174,7 @@ then the administrator must have at least one of the permissions in the array.
|
|
|
174
174
|
The entities for which this duplicator is able to duplicate.
|
|
175
175
|
### duplicate
|
|
176
176
|
|
|
177
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-duplicator#duplicateentityfn'>DuplicateEntityFn</a
|
|
177
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-duplicator#duplicateentityfn'>DuplicateEntityFn</a><T>`} />
|
|
178
178
|
|
|
179
179
|
The function which performs the duplication.
|
|
180
180
|
|
|
@@ -18,7 +18,7 @@ class AutoIncrementIdStrategy implements EntityIdStrategy<'increment'> {
|
|
|
18
18
|
encodeId(primaryKey: number) => string;
|
|
19
19
|
}
|
|
20
20
|
```
|
|
21
|
-
* Implements: <code><a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a
|
|
21
|
+
* Implements: <code><a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a><'increment'></code>
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
@@ -92,7 +92,7 @@ Defines how the primary key will be stored in the database - either
|
|
|
92
92
|
string ID.
|
|
93
93
|
### encodeId
|
|
94
94
|
|
|
95
|
-
<MemberInfo kind="property" type={`(primaryKey: PrimaryKeyType
|
|
95
|
+
<MemberInfo kind="property" type={`(primaryKey: PrimaryKeyType<T>) => string`} />
|
|
96
96
|
|
|
97
97
|
Allows the raw ID from the database to be transformed in some way before exposing
|
|
98
98
|
it in the GraphQL API.
|
|
@@ -103,7 +103,7 @@ case, you can use the encode/decode methods to obfuscate the ID with some kind o
|
|
|
103
103
|
encoding scheme, such as base64 (or something more sophisticated).
|
|
104
104
|
### decodeId
|
|
105
105
|
|
|
106
|
-
<MemberInfo kind="property" type={`(id: string)
|
|
106
|
+
<MemberInfo kind="property" type={`(id: string) => PrimaryKeyType<T>`} />
|
|
107
107
|
|
|
108
108
|
Reverses the transformation performed by the `encodeId` method in order to get
|
|
109
109
|
back to the raw ID value.
|
|
@@ -141,7 +141,7 @@ class UuidIdStrategy implements EntityIdStrategy<'uuid'> {
|
|
|
141
141
|
encodeId(primaryKey: string) => string;
|
|
142
142
|
}
|
|
143
143
|
```
|
|
144
|
-
* Implements: <code><a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a
|
|
144
|
+
* Implements: <code><a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a><'uuid'></code>
|
|
145
145
|
|
|
146
146
|
|
|
147
147
|
|
|
@@ -27,7 +27,7 @@ interface EntityOptions {
|
|
|
27
27
|
|
|
28
28
|
### entityIdStrategy
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a
|
|
30
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a><any>`} default={`<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>`} since="1.3.0" />
|
|
31
31
|
|
|
32
32
|
Defines the strategy used for both storing the primary keys of entities
|
|
33
33
|
in the database, and the encoding & decoding of those ids when exposing
|
|
@@ -42,7 +42,7 @@ a fresh database.
|
|
|
42
42
|
:::
|
|
43
43
|
### entityDuplicators
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`Array
|
|
45
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicator'>EntityDuplicator</a><any>>`} default={`defaultEntityDuplicators`} since="2.2.0" />
|
|
46
46
|
|
|
47
47
|
An array of <a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicator'>EntityDuplicator</a> instances which are used to duplicate entities
|
|
48
48
|
when using the `duplicateEntity` mutation.
|
package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx
CHANGED
|
@@ -33,7 +33,7 @@ interface ProductVariantPriceSelectionStrategy extends InjectableStrategy {
|
|
|
33
33
|
|
|
34
34
|
### selectPrice
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined | Promise
|
|
36
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined | Promise<<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> | undefined>`} />
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
|
package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx
CHANGED
|
@@ -58,7 +58,7 @@ interface ProductVariantPriceUpdateStrategy extends InjectableStrategy {
|
|
|
58
58
|
|
|
59
59
|
### onPriceCreated
|
|
60
60
|
|
|
61
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createdPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise
|
|
61
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, createdPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`} />
|
|
62
62
|
|
|
63
63
|
This method is called when a ProductVariantPrice is created. It receives the created
|
|
64
64
|
ProductVariantPrice and the array of all prices associated with the ProductVariant.
|
|
@@ -67,7 +67,7 @@ It should return an array of UpdatedProductVariantPrice objects which will be us
|
|
|
67
67
|
the prices of the specific ProductVariantPrices.
|
|
68
68
|
### onPriceUpdated
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, updatedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise
|
|
70
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, updatedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`} />
|
|
71
71
|
|
|
72
72
|
This method is called when a ProductVariantPrice is updated. It receives the updated
|
|
73
73
|
ProductVariantPrice and the array of all prices associated with the ProductVariant.
|
|
@@ -76,7 +76,7 @@ It should return an array of UpdatedProductVariantPrice objects which will be us
|
|
|
76
76
|
the prices of the specific ProductVariantPrices.
|
|
77
77
|
### onPriceDeleted
|
|
78
78
|
|
|
79
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, deletedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise
|
|
79
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, deletedPrice: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>, prices: <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>[]) => UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>`} />
|
|
80
80
|
|
|
81
81
|
This method is called when a ProductVariantPrice is deleted. It receives the deleted
|
|
82
82
|
ProductVariantPrice and the array of all prices associated with the ProductVariant.
|
|
@@ -29,7 +29,7 @@ interface RuntimeVendureConfig extends Required<VendureConfig> {
|
|
|
29
29
|
systemOptions: Required<SystemOptions>;
|
|
30
30
|
}
|
|
31
31
|
```
|
|
32
|
-
* Extends: <code>Required
|
|
32
|
+
* Extends: <code>Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>></code>
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -37,72 +37,72 @@ interface RuntimeVendureConfig extends Required<VendureConfig> {
|
|
|
37
37
|
|
|
38
38
|
### apiOptions
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={`Required
|
|
40
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/configuration/api-options#apioptions'>ApiOptions</a>>`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### assetOptions
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`Required
|
|
45
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/assets/asset-options#assetoptions'>AssetOptions</a>>`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### authOptions
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="property" type={`Required
|
|
50
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/auth/auth-options#authoptions'>AuthOptions</a>>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### catalogOptions
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={`Required
|
|
55
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/products-stock/catalog-options#catalogoptions'>CatalogOptions</a>>`} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### customFields
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={`Required
|
|
60
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>>`} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### entityOptions
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="property" type={`Required
|
|
65
|
+
<MemberInfo kind="property" type={`Required<Omit<<a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>, 'entityIdStrategy'>> & <a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>`} />
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
### importExportOptions
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="property" type={`Required
|
|
70
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/import-export/import-export-options#importexportoptions'>ImportExportOptions</a>>`} />
|
|
71
71
|
|
|
72
72
|
|
|
73
73
|
### jobQueueOptions
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="property" type={`Required
|
|
75
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/job-queue/job-queue-options#jobqueueoptions'>JobQueueOptions</a>>`} />
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
### schedulerOptions
|
|
79
79
|
|
|
80
|
-
<MemberInfo kind="property" type={`Required
|
|
80
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/scheduled-tasks/scheduler-options#scheduleroptions'>SchedulerOptions</a>>`} />
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
### orderOptions
|
|
84
84
|
|
|
85
|
-
<MemberInfo kind="property" type={`Required
|
|
85
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a>>`} />
|
|
86
86
|
|
|
87
87
|
|
|
88
88
|
### promotionOptions
|
|
89
89
|
|
|
90
|
-
<MemberInfo kind="property" type={`Required
|
|
90
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/promotions/promotion-options#promotionoptions'>PromotionOptions</a>>`} />
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
### shippingOptions
|
|
94
94
|
|
|
95
|
-
<MemberInfo kind="property" type={`Required
|
|
95
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/shipping/shipping-options#shippingoptions'>ShippingOptions</a>>`} />
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
### taxOptions
|
|
99
99
|
|
|
100
|
-
<MemberInfo kind="property" type={`Required
|
|
100
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/tax/tax-options#taxoptions'>TaxOptions</a>>`} />
|
|
101
101
|
|
|
102
102
|
|
|
103
103
|
### systemOptions
|
|
104
104
|
|
|
105
|
-
<MemberInfo kind="property" type={`Required
|
|
105
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/configuration/system-options#systemoptions'>SystemOptions</a>>`} />
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
|
|
@@ -38,7 +38,7 @@ interface SlugStrategy extends InjectableStrategy {
|
|
|
38
38
|
|
|
39
39
|
### generate
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => string | Promise
|
|
41
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => string | Promise<string>`} />
|
|
42
42
|
|
|
43
43
|
Generates a slug from the input string.
|
|
44
44
|
|