@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028
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 +3 -7
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +3 -7
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +4 -8
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -5
- package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx +0 -4
- package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx +0 -4
- package/docs/reference/admin-ui-api/action-bar/page-location-id.mdx +0 -4
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -5
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -9
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -5
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +7 -23
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -5
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -8
- package/docs/reference/admin-ui-api/components/chip-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -8
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +7 -11
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +8 -12
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -11
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -5
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -10
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -5
- package/docs/reference/admin-ui-api/components/order-state-label-component.mdx +0 -4
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -5
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -6
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -7
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +2 -6
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +5 -9
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +2 -6
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -5
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +24 -92
- package/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx +0 -4
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +3 -7
- package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx +0 -4
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +3 -7
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -5
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -5
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -5
- package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx +0 -4
- package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx +0 -4
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -6
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -6
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +7 -11
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +2 -6
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +9 -13
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +2 -6
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +4 -8
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +8 -12
- package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx +0 -4
- package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx +0 -4
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -7
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +2 -6
- package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -5
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -5
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -5
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -5
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -5
- package/docs/reference/admin-ui-api/react-components/page-block.mdx +0 -4
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -5
- package/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx +0 -4
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -5
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +2 -6
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -5
- package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx +0 -4
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -5
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx +0 -4
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -5
- package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -5
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -5
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -5
- package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -5
- package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx +0 -4
- package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx +0 -4
- package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx +0 -4
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -5
- package/docs/reference/admin-ui-api/services/data-service.mdx +11 -19
- package/docs/reference/admin-ui-api/services/modal-service.mdx +6 -22
- package/docs/reference/admin-ui-api/services/notification-service.mdx +0 -12
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -5
- package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx +0 -4
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +3 -39
- package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx +0 -4
- package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx +0 -4
- package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx +0 -20
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +0 -4
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +1 -5
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +0 -4
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +2 -6
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -5
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +7 -11
- package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx +0 -4
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -5
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx +0 -4
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx +0 -4
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -13
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +4 -8
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -12
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -11
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +6 -18
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -11
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -5
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -5
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +9 -21
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +2 -6
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +3 -7
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +23 -27
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +2 -6
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -10
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +4 -16
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +10 -62
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +0 -4
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +2 -10
- package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -8
- package/docs/reference/core-plugins/email-plugin/index.mdx +5 -9
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -12
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +3 -31
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -6
- package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx +0 -4
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +2 -6
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -6
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx +0 -4
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +10 -14
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +6 -14
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +4 -8
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -5
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -10
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -9
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +6 -14
- package/docs/reference/core-plugins/sentry-plugin/index.mdx +0 -4
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -5
- package/docs/reference/core-plugins/sentry-plugin/sentry-service.mdx +0 -4
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -7
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +7 -15
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -5
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -5
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -9
- package/docs/reference/core-plugins/telemetry-plugin/index.mdx +0 -4
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +0 -8
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +3 -7
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +2 -6
- package/docs/reference/dashboard/components/asset-gallery.mdx +4 -12
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +3 -11
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -5
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -5
- package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -4
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -9
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -9
- package/docs/reference/dashboard/components/vendure-image.mdx +7 -31
- package/docs/reference/dashboard/detail-views/detail-page.mdx +5 -13
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -23
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +4 -12
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -5
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -10
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -5
- package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -8
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -9
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -21
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +5 -21
- package/docs/reference/dashboard/extensions-api/login.mdx +0 -16
- package/docs/reference/dashboard/extensions-api/navigation.mdx +0 -8
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -14
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -8
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -5
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +2 -10
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/slug-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/text-input.mdx +0 -4
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -5
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -9
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -9
- package/docs/reference/dashboard/hooks/use-auth.mdx +6 -14
- package/docs/reference/dashboard/hooks/use-channel.mdx +3 -11
- package/docs/reference/dashboard/hooks/use-custom-field-config.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-display-locale.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -5
- package/docs/reference/dashboard/hooks/use-local-format.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-paginated-list.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-permissions.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-sorted-languages.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-ui-language-loader.mdx +0 -4
- package/docs/reference/dashboard/hooks/use-widget-filters.mdx +0 -4
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -15
- package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -4
- package/docs/reference/dashboard/list-views/data-table.mdx +11 -23
- package/docs/reference/dashboard/list-views/list-page.mdx +15 -23
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +19 -27
- package/docs/reference/dashboard/page-layout/index.mdx +3 -11
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +5 -17
- package/docs/reference/dashboard/page-layout/page-block.mdx +7 -23
- package/docs/reference/dashboard/page-layout/page-title.mdx +2 -6
- package/docs/reference/dashboard/page-layout/page.mdx +7 -15
- package/docs/reference/dashboard/page-layout/use-page-block.mdx +0 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -28
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +0 -4
- package/docs/reference/typescript-api/assets/asset-options.mdx +0 -4
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -5
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -10
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/auth-options.mdx +5 -9
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +3 -7
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -6
- package/docs/reference/typescript-api/auth/cookie-options.mdx +0 -4
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +7 -11
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +6 -10
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -7
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +0 -4
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +3 -7
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -6
- package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -28
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +8 -20
- package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -6
- package/docs/reference/typescript-api/cache/cache-config.mdx +2 -6
- package/docs/reference/typescript-api/cache/cache-service.mdx +6 -10
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +5 -13
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -11
- package/docs/reference/typescript-api/cache/index.mdx +5 -9
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -11
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +5 -9
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -6
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +8 -20
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -7
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -5
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -5
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -5
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -5
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -10
- package/docs/reference/typescript-api/common/currency-code.mdx +0 -4
- package/docs/reference/typescript-api/common/entity-relation-paths.mdx +0 -4
- package/docs/reference/typescript-api/common/i18n-service.mdx +0 -8
- package/docs/reference/typescript-api/common/id.mdx +1 -5
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +3 -7
- package/docs/reference/typescript-api/common/injector.mdx +2 -6
- package/docs/reference/typescript-api/common/job-state.mdx +0 -4
- package/docs/reference/typescript-api/common/json-compatible.mdx +0 -4
- package/docs/reference/typescript-api/common/language-code.mdx +0 -4
- package/docs/reference/typescript-api/common/middleware.mdx +1 -5
- package/docs/reference/typescript-api/common/paginated-list.mdx +0 -4
- package/docs/reference/typescript-api/common/permission.mdx +1 -5
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -6
- package/docs/reference/typescript-api/common/process-context.mdx +0 -4
- package/docs/reference/typescript-api/common/vendure_version.mdx +0 -4
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -5
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +4 -8
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +2 -6
- package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx +0 -4
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -15
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +12 -16
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -5
- package/docs/reference/typescript-api/configuration/api-options.mdx +3 -7
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -7
- package/docs/reference/typescript-api/configuration/default-config.mdx +0 -4
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +0 -4
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -18
- package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -4
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +6 -18
- package/docs/reference/typescript-api/configuration/entity-options.mdx +4 -12
- package/docs/reference/typescript-api/configuration/merge-config.mdx +0 -4
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -9
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +5 -17
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +16 -20
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -5
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -5
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -7
- package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx +0 -4
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +4 -8
- package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +0 -4
- package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx +0 -4
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -5
- package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +0 -4
- package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +0 -4
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -5
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -5
- package/docs/reference/typescript-api/data-access/calculated.mdx +3 -11
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +2 -6
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +3 -7
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +2 -6
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +5 -13
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +16 -20
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -6
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -5
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -8
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -8
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +5 -9
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -8
- package/docs/reference/typescript-api/entities/address.mdx +2 -6
- package/docs/reference/typescript-api/entities/administrator.mdx +2 -6
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -5
- package/docs/reference/typescript-api/entities/asset.mdx +1 -5
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -7
- package/docs/reference/typescript-api/entities/authentication-method.mdx +4 -16
- package/docs/reference/typescript-api/entities/channel.mdx +1 -5
- package/docs/reference/typescript-api/entities/collection.mdx +3 -7
- package/docs/reference/typescript-api/entities/country.mdx +4 -8
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -6
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -6
- package/docs/reference/typescript-api/entities/customer.mdx +2 -6
- package/docs/reference/typescript-api/entities/facet-value.mdx +3 -7
- package/docs/reference/typescript-api/entities/facet.mdx +4 -8
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -6
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -5
- package/docs/reference/typescript-api/entities/history-entry.mdx +2 -6
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -21
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -6
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +7 -23
- package/docs/reference/typescript-api/entities/order-line.mdx +8 -12
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -5
- package/docs/reference/typescript-api/entities/order.mdx +8 -12
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -5
- package/docs/reference/typescript-api/entities/payment-method.mdx +4 -8
- package/docs/reference/typescript-api/entities/payment.mdx +2 -6
- package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -7
- package/docs/reference/typescript-api/entities/product-option.mdx +3 -7
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -5
- package/docs/reference/typescript-api/entities/product-variant.mdx +3 -7
- package/docs/reference/typescript-api/entities/product.mdx +3 -7
- package/docs/reference/typescript-api/entities/promotion.mdx +6 -10
- package/docs/reference/typescript-api/entities/province.mdx +2 -6
- package/docs/reference/typescript-api/entities/refund.mdx +1 -5
- package/docs/reference/typescript-api/entities/region.mdx +3 -7
- package/docs/reference/typescript-api/entities/role.mdx +2 -6
- package/docs/reference/typescript-api/entities/seller.mdx +2 -6
- package/docs/reference/typescript-api/entities/session.mdx +2 -6
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -5
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -6
- package/docs/reference/typescript-api/entities/shipping-method.mdx +6 -10
- package/docs/reference/typescript-api/entities/stock-level.mdx +3 -7
- package/docs/reference/typescript-api/entities/stock-location.mdx +3 -7
- package/docs/reference/typescript-api/entities/stock-movement.mdx +6 -30
- package/docs/reference/typescript-api/entities/surcharge.mdx +2 -6
- package/docs/reference/typescript-api/entities/tag.mdx +1 -5
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -6
- package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -9
- package/docs/reference/typescript-api/entities/user.mdx +2 -6
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +2 -6
- package/docs/reference/typescript-api/entities/zone.mdx +2 -6
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -6
- package/docs/reference/typescript-api/errors/error-result-union.mdx +0 -4
- package/docs/reference/typescript-api/errors/error-types.mdx +1 -29
- package/docs/reference/typescript-api/errors/i18n-error.mdx +0 -4
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -5
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -6
- package/docs/reference/typescript-api/events/event-bus.mdx +10 -14
- package/docs/reference/typescript-api/events/event-types.mdx +80 -316
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +0 -4
- package/docs/reference/typescript-api/events/vendure-event.mdx +0 -4
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +8 -24
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +8 -16
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx +0 -4
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -7
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -5
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -5
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -5
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -7
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +3 -7
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +0 -4
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -8
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -5
- package/docs/reference/typescript-api/import-export/import-parser.mdx +13 -41
- package/docs/reference/typescript-api/import-export/importer.mdx +5 -9
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -7
- package/docs/reference/typescript-api/import-export/populate.mdx +4 -8
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -6
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +10 -22
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +6 -10
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +10 -14
- package/docs/reference/typescript-api/job-queue/index.mdx +6 -10
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -9
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +4 -8
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +4 -8
- package/docs/reference/typescript-api/job-queue/job-queue-options.mdx +0 -4
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +10 -14
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +4 -8
- package/docs/reference/typescript-api/job-queue/job.mdx +5 -17
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +11 -15
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +8 -12
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +7 -11
- package/docs/reference/typescript-api/job-queue/types.mdx +6 -30
- package/docs/reference/typescript-api/logger/default-logger.mdx +0 -4
- package/docs/reference/typescript-api/logger/index.mdx +3 -7
- package/docs/reference/typescript-api/logger/log-level.mdx +0 -4
- package/docs/reference/typescript-api/logger/vendure-logger.mdx +0 -4
- package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -5
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -5
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -5
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -5
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +2 -6
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -5
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -5
- package/docs/reference/typescript-api/money/money-strategy.mdx +4 -8
- package/docs/reference/typescript-api/money/round-money.mdx +1 -5
- package/docs/reference/typescript-api/orders/active-order-service.mdx +7 -11
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +4 -8
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -6
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -5
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -11
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -6
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +0 -16
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -9
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -9
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +7 -11
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -7
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -9
- package/docs/reference/typescript-api/orders/order-options.mdx +4 -8
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -5
- package/docs/reference/typescript-api/orders/order-process.mdx +16 -44
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +6 -18
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -5
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -5
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -5
- package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx +0 -4
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +9 -13
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +7 -19
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +3 -7
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +19 -63
- package/docs/reference/typescript-api/payment/payment-options.mdx +10 -14
- package/docs/reference/typescript-api/payment/payment-process.mdx +5 -9
- package/docs/reference/typescript-api/payment/payment-state.mdx +0 -4
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -5
- package/docs/reference/typescript-api/payment/payment-transition-data.mdx +0 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +5 -9
- package/docs/reference/typescript-api/payment/refund-state.mdx +0 -4
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -5
- package/docs/reference/typescript-api/payment/refund-transition-data.mdx +0 -4
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -7
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -9
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +7 -19
- package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +2 -6
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -5
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +0 -4
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +3 -7
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +4 -8
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -10
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -5
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +9 -21
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +4 -8
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +32 -92
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +9 -21
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -6
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -5
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -5
- package/docs/reference/typescript-api/request/api-type.mdx +0 -4
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -5
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -5
- package/docs/reference/typescript-api/request/request-context-service.mdx +3 -7
- package/docs/reference/typescript-api/request/request-context.mdx +5 -9
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -14
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -5
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -9
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +6 -10
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -16
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -6
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -7
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +8 -16
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +4 -8
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -5
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +4 -8
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +2 -6
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +3 -15
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +3 -7
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -5
- package/docs/reference/typescript-api/services/administrator-service.mdx +7 -11
- package/docs/reference/typescript-api/services/asset-service.mdx +15 -27
- package/docs/reference/typescript-api/services/auth-service.mdx +7 -11
- package/docs/reference/typescript-api/services/channel-service.mdx +15 -19
- package/docs/reference/typescript-api/services/collection-service.mdx +23 -27
- package/docs/reference/typescript-api/services/country-service.mdx +8 -12
- package/docs/reference/typescript-api/services/customer-group-service.mdx +10 -14
- package/docs/reference/typescript-api/services/customer-service.mdx +37 -41
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -5
- package/docs/reference/typescript-api/services/facet-service.mdx +12 -16
- package/docs/reference/typescript-api/services/facet-value-service.mdx +13 -17
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +7 -11
- package/docs/reference/typescript-api/services/global-settings-service.mdx +3 -7
- package/docs/reference/typescript-api/services/history-service.mdx +9 -13
- package/docs/reference/typescript-api/services/initializer-service.mdx +0 -4
- package/docs/reference/typescript-api/services/order-service.mdx +76 -80
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -6
- package/docs/reference/typescript-api/services/payment-method-service.mdx +11 -15
- package/docs/reference/typescript-api/services/payment-service.mdx +13 -17
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +6 -10
- package/docs/reference/typescript-api/services/product-option-service.mdx +6 -10
- package/docs/reference/typescript-api/services/product-service.mdx +15 -19
- package/docs/reference/typescript-api/services/product-variant-service.mdx +29 -33
- package/docs/reference/typescript-api/services/promotion-service.mdx +10 -14
- package/docs/reference/typescript-api/services/province-service.mdx +6 -10
- package/docs/reference/typescript-api/services/role-service.mdx +12 -16
- package/docs/reference/typescript-api/services/search-service.mdx +2 -6
- package/docs/reference/typescript-api/services/seller-service.mdx +4 -8
- package/docs/reference/typescript-api/services/session-service.mdx +12 -16
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -19
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +9 -13
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -5
- package/docs/reference/typescript-api/services/stock-level-service.mdx +8 -12
- package/docs/reference/typescript-api/services/stock-location-service.mdx +12 -16
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +15 -19
- package/docs/reference/typescript-api/services/tag-service.mdx +6 -10
- package/docs/reference/typescript-api/services/tax-category-service.mdx +6 -10
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +7 -11
- package/docs/reference/typescript-api/services/user-service.mdx +20 -24
- package/docs/reference/typescript-api/services/zone-service.mdx +9 -13
- package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -5
- package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -6
- package/docs/reference/typescript-api/settings-store/settings-store-registration.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/settings-store-scope-function.mdx +0 -4
- package/docs/reference/typescript-api/settings-store/settings-store-scopes.mdx +0 -4
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -6
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -6
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +7 -19
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +4 -8
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +3 -7
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -7
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +8 -12
- package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -4
- package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -6
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +5 -21
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -6
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +2 -6
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +2 -6
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -5
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -11
- package/docs/reference/typescript-api/tax/tax-options.mdx +0 -4
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -6
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -5
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -5
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +3 -7
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +2 -6
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +3 -7
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -5
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -5
- package/docs/reference/typescript-api/testing/register-initializer.mdx +3 -7
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -9
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +4 -8
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -5
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -5
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -6
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -5
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +4 -12
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +3 -7
- package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -4
- package/package.json +2 -2
- 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
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "AssetGallery"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## AssetGallery
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-gallery.tsx" sourceLine="160" packageName="@vendure/dashboard" />
|
|
10
6
|
|
|
11
7
|
A component for displaying a gallery of assets.
|
|
@@ -31,13 +27,9 @@ Parameters
|
|
|
31
27
|
|
|
32
28
|
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/components/asset-gallery#assetgalleryprops'>AssetGalleryProps</a>`} />
|
|
33
29
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
## AssetGalleryProps
|
|
37
|
-
|
|
38
30
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-gallery.tsx" sourceLine="83" packageName="@vendure/dashboard" />
|
|
39
31
|
|
|
40
|
-
Props for the <
|
|
32
|
+
Props for the <DocsLink href="/reference/dashboard/components/asset-gallery#assetgallery">AssetGallery</DocsLink> component.
|
|
41
33
|
|
|
42
34
|
```ts title="Signature"
|
|
43
35
|
interface AssetGalleryProps {
|
|
@@ -60,7 +52,7 @@ interface AssetGalleryProps {
|
|
|
60
52
|
|
|
61
53
|
### onSelect
|
|
62
54
|
|
|
63
|
-
<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[])
|
|
55
|
+
<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`} />
|
|
64
56
|
|
|
65
57
|
|
|
66
58
|
### selectable
|
|
@@ -103,7 +95,7 @@ Whether the gallery should show a header.
|
|
|
103
95
|
The class name to apply to the gallery.
|
|
104
96
|
### onFilesDropped
|
|
105
97
|
|
|
106
|
-
<MemberInfo kind="property" type={`(files: File[])
|
|
98
|
+
<MemberInfo kind="property" type={`(files: File[]) => void`} />
|
|
107
99
|
|
|
108
100
|
The function to call when files are dropped.
|
|
109
101
|
### bulkActions
|
|
@@ -118,7 +110,7 @@ The bulk actions to display in the gallery.
|
|
|
118
110
|
Whether the gallery should display bulk actions.
|
|
119
111
|
### onPageSizeChange
|
|
120
112
|
|
|
121
|
-
<MemberInfo kind="property" type={`(pageSize: number)
|
|
113
|
+
<MemberInfo kind="property" type={`(pageSize: number) => void`} />
|
|
122
114
|
|
|
123
115
|
The function to call when the page size changes.
|
|
124
116
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "AssetPickerDialog"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## AssetPickerDialog
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-picker-dialog.tsx" sourceLine="60" packageName="@vendure/dashboard" />
|
|
10
6
|
|
|
11
7
|
A dialog which allows the creation and selection of assets.
|
|
@@ -19,13 +15,9 @@ Parameters
|
|
|
19
15
|
|
|
20
16
|
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/components/asset-picker-dialog#assetpickerdialogprops'>AssetPickerDialogProps</a>`} />
|
|
21
17
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
## AssetPickerDialogProps
|
|
25
|
-
|
|
26
18
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-picker-dialog.tsx" sourceLine="19" packageName="@vendure/dashboard" />
|
|
27
19
|
|
|
28
|
-
Props for the <
|
|
20
|
+
Props for the <DocsLink href="/reference/dashboard/components/asset-picker-dialog#assetpickerdialog">AssetPickerDialog</DocsLink> component.
|
|
29
21
|
|
|
30
22
|
```ts title="Signature"
|
|
31
23
|
interface AssetPickerDialogProps {
|
|
@@ -47,12 +39,12 @@ interface AssetPickerDialogProps {
|
|
|
47
39
|
Whether the dialog is open.
|
|
48
40
|
### onClose
|
|
49
41
|
|
|
50
|
-
<MemberInfo kind="property" type={`()
|
|
42
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
51
43
|
|
|
52
44
|
The function to call when the dialog is closed.
|
|
53
45
|
### onSelect
|
|
54
46
|
|
|
55
|
-
<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[])
|
|
47
|
+
<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`} />
|
|
56
48
|
|
|
57
49
|
The function to call when assets are selected.
|
|
58
50
|
### multiSelect
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "ChannelChip"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ChannelChip
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/channel-chip.tsx" sourceLine="18" packageName="@vendure/dashboard" since="3.5.2" />
|
|
10
6
|
|
|
11
7
|
A component for displaying a channel as a chip.
|
|
@@ -17,5 +13,5 @@ Parameters
|
|
|
17
13
|
|
|
18
14
|
### props
|
|
19
15
|
|
|
20
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
16
|
+
<MemberInfo kind="parameter" type={`Readonly<ChannelChipProps>`} />
|
|
21
17
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "DetailPageButton"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DetailPageButton
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/detail-page-button.tsx" sourceLine="33" packageName="@vendure/dashboard" since="3.4.0" />
|
|
10
6
|
|
|
11
7
|
DetailPageButton is a reusable navigation component designed to provide consistent UX
|
|
@@ -44,5 +40,5 @@ Parameters
|
|
|
44
40
|
|
|
45
41
|
### props
|
|
46
42
|
|
|
47
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
43
|
+
<MemberInfo kind="parameter" type={`Readonly<{ label: string | React.ReactNode; id?: string; href?: string; disabled?: boolean; search?: Record<string, string>; className?: string; }>`} />
|
|
48
44
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "FacetValueChip"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## FacetValueChip
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/facet-value-chip.tsx" sourceLine="30" packageName="@vendure/dashboard" since="3.4.0" />
|
|
10
6
|
|
|
11
7
|
A component for displaying a facet value as a chip.
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "FacetValueSelector"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## FacetValueSelector
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/facet-value-selector.tsx" sourceLine="143" packageName="@vendure/dashboard" since="3.4.0" />
|
|
10
6
|
|
|
11
7
|
A component for selecting facet values.
|
|
@@ -25,10 +21,6 @@ Parameters
|
|
|
25
21
|
|
|
26
22
|
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/components/facet-value-selector#facetvalueselectorprops'>FacetValueSelectorProps</a>`} />
|
|
27
23
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
## FacetValueSelectorProps
|
|
31
|
-
|
|
32
24
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/facet-value-selector.tsx" sourceLine="40" packageName="@vendure/dashboard" since="3.4.0" />
|
|
33
25
|
|
|
34
26
|
A component for selecting facet values.
|
|
@@ -46,7 +38,7 @@ interface FacetValueSelectorProps {
|
|
|
46
38
|
|
|
47
39
|
### onValueSelect
|
|
48
40
|
|
|
49
|
-
<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>)
|
|
41
|
+
<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>) => void`} />
|
|
50
42
|
|
|
51
43
|
The function to call when a facet value is selected.
|
|
52
44
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "PermissionGuard"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## PermissionGuard
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/permission-guard.tsx" sourceLine="44" packageName="@vendure/dashboard" since="3.4.0" />
|
|
10
6
|
|
|
11
7
|
This component is used to protect a route from unauthorized access.
|
|
@@ -28,11 +24,7 @@ Parameters
|
|
|
28
24
|
|
|
29
25
|
### props
|
|
30
26
|
|
|
31
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
## PermissionGuardProps
|
|
27
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>>`} />
|
|
36
28
|
|
|
37
29
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/permission-guard.tsx" sourceLine="12" packageName="@vendure/dashboard" since="3.4.0" />
|
|
38
30
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "VendureImage"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## VendureImage
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="141" packageName="@vendure/dashboard" since="3.4.0" />
|
|
10
6
|
|
|
11
7
|
A component for displaying an image from a Vendure asset.
|
|
@@ -39,13 +35,9 @@ Parameters
|
|
|
39
35
|
|
|
40
36
|
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/components/vendure-image#vendureimageprops'>VendureImageProps</a>`} />
|
|
41
37
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
## VendureImageProps
|
|
45
|
-
|
|
46
38
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="59" packageName="@vendure/dashboard" since="3.4.0" />
|
|
47
39
|
|
|
48
|
-
The props for the <
|
|
40
|
+
The props for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
|
|
49
41
|
|
|
50
42
|
```ts title="Signature"
|
|
51
43
|
interface VendureImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
|
|
@@ -61,7 +53,7 @@ interface VendureImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
|
|
|
61
53
|
ref?: React.Ref<HTMLImageElement>;
|
|
62
54
|
}
|
|
63
55
|
```
|
|
64
|
-
* Extends: <code>React.ImgHTMLAttributes
|
|
56
|
+
* Extends: <code>React.ImgHTMLAttributes<HTMLImageElement></code>
|
|
65
57
|
|
|
66
58
|
|
|
67
59
|
|
|
@@ -115,19 +107,15 @@ The fallback to show if no asset is provided. If no fallback is provided,
|
|
|
115
107
|
a default placeholder will be shown.
|
|
116
108
|
### ref
|
|
117
109
|
|
|
118
|
-
<MemberInfo kind="property" type={`React.Ref
|
|
110
|
+
<MemberInfo kind="property" type={`React.Ref<HTMLImageElement>`} />
|
|
119
111
|
|
|
120
112
|
The ref to the image element.
|
|
121
113
|
|
|
122
114
|
|
|
123
115
|
</div>
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
## AssetLike
|
|
127
|
-
|
|
128
116
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="13" packageName="@vendure/dashboard" since="3.4.0" />
|
|
129
117
|
|
|
130
|
-
The type of object that can be used as an asset in the <
|
|
118
|
+
The type of object that can be used as an asset in the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
|
|
131
119
|
|
|
132
120
|
```ts title="Signature"
|
|
133
121
|
interface AssetLike {
|
|
@@ -163,35 +151,23 @@ interface AssetLike {
|
|
|
163
151
|
|
|
164
152
|
|
|
165
153
|
</div>
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
## ImagePreset
|
|
169
|
-
|
|
170
154
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="28" packageName="@vendure/dashboard" since="3.4.0" />
|
|
171
155
|
|
|
172
|
-
The presets that can be used for the <
|
|
156
|
+
The presets that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
|
|
173
157
|
|
|
174
158
|
```ts title="Signature"
|
|
175
159
|
type ImagePreset = 'tiny' | 'thumb' | 'small' | 'medium' | 'large' | 'full' | null
|
|
176
160
|
```
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
## ImageFormat
|
|
180
|
-
|
|
181
161
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="38" packageName="@vendure/dashboard" since="3.4.0" />
|
|
182
162
|
|
|
183
|
-
The formats that can be used for the <
|
|
163
|
+
The formats that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
|
|
184
164
|
|
|
185
165
|
```ts title="Signature"
|
|
186
166
|
type ImageFormat = 'jpg' | 'jpeg' | 'png' | 'webp' | 'avif' | null
|
|
187
167
|
```
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
## ImageMode
|
|
191
|
-
|
|
192
168
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="48" packageName="@vendure/dashboard" since="3.4.0" />
|
|
193
169
|
|
|
194
|
-
The modes that can be used for the <
|
|
170
|
+
The modes that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
|
|
195
171
|
|
|
196
172
|
```ts title="Signature"
|
|
197
173
|
type ImageMode = 'crop' | 'resize' | null
|
|
@@ -2,15 +2,11 @@
|
|
|
2
2
|
title: "DetailPage"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DetailPage
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="147" packageName="@vendure/dashboard" since="3.3.0" />
|
|
10
6
|
|
|
11
7
|
Auto-generates a detail page with a form based on the provided query and mutation documents.
|
|
12
8
|
|
|
13
|
-
For more control over the layout, you would use the more low-level <
|
|
9
|
+
For more control over the layout, you would use the more low-level <DocsLink href="/reference/dashboard/page-layout/page#page">Page</DocsLink> component.
|
|
14
10
|
|
|
15
11
|
```ts title="Signature"
|
|
16
12
|
function DetailPage<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>>(props: DetailPageProps<T, C, U>): void
|
|
@@ -19,15 +15,11 @@ Parameters
|
|
|
19
15
|
|
|
20
16
|
### props
|
|
21
17
|
|
|
22
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
## DetailPageProps
|
|
18
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a><T, C, U>`} />
|
|
27
19
|
|
|
28
20
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="43" packageName="@vendure/dashboard" since="3.3.0" />
|
|
29
21
|
|
|
30
|
-
Props to configure the <
|
|
22
|
+
Props to configure the <DocsLink href="/reference/dashboard/detail-views/detail-page#detailpage">DetailPage</DocsLink> component.
|
|
31
23
|
|
|
32
24
|
```ts title="Signature"
|
|
33
25
|
interface DetailPageProps<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>, EntityField extends keyof ResultOf<T> = DetailEntityPath<T>> {
|
|
@@ -62,7 +54,7 @@ A unique identifier for the page.
|
|
|
62
54
|
The Tanstack Router route used to navigate to this page.
|
|
63
55
|
### title
|
|
64
56
|
|
|
65
|
-
<MemberInfo kind="property" type={`(entity: ResultOf
|
|
57
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => string`} />
|
|
66
58
|
|
|
67
59
|
The title of the page.
|
|
68
60
|
### queryDocument
|
|
@@ -82,7 +74,7 @@ The mutation document used to create the entity.
|
|
|
82
74
|
The mutation document used to update the entity.
|
|
83
75
|
### setValuesForUpdate
|
|
84
76
|
|
|
85
|
-
<MemberInfo kind="property" type={`(entity: ResultOf
|
|
77
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => VariablesOf<U>['input']`} />
|
|
86
78
|
|
|
87
79
|
A function that sets the values for the update input type based on the entity.
|
|
88
80
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "UseDetailPage"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## useDetailPage
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="240" packageName="@vendure/dashboard" since="3.3.0" />
|
|
10
6
|
|
|
11
7
|
**Status: Developer Preview**
|
|
@@ -78,11 +74,7 @@ Parameters
|
|
|
78
74
|
|
|
79
75
|
### options
|
|
80
76
|
|
|
81
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
## DetailPageOptions
|
|
77
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a><T, C, U, EntityField, VarNameCreate, VarNameUpdate>`} />
|
|
86
78
|
|
|
87
79
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="46" packageName="@vendure/dashboard" since="3.3.0" />
|
|
88
80
|
|
|
@@ -151,36 +143,32 @@ The document to create the entity.
|
|
|
151
143
|
The document to update the entity.
|
|
152
144
|
### setValuesForUpdate
|
|
153
145
|
|
|
154
|
-
<MemberInfo kind="property" type={`( entity: NonNullable
|
|
146
|
+
<MemberInfo kind="property" type={`( entity: NonNullable<ResultOf<T>[EntityField]>, ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>`} />
|
|
155
147
|
|
|
156
148
|
The function to set the values for the update document.
|
|
157
149
|
### transformCreateInput
|
|
158
150
|
|
|
159
|
-
<MemberInfo kind="property" type={`(input: VariablesOf
|
|
151
|
+
<MemberInfo kind="property" type={`(input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate]`} />
|
|
160
152
|
|
|
161
153
|
|
|
162
154
|
### transformUpdateInput
|
|
163
155
|
|
|
164
|
-
<MemberInfo kind="property" type={`(input: VariablesOf
|
|
156
|
+
<MemberInfo kind="property" type={`(input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate]`} />
|
|
165
157
|
|
|
166
158
|
|
|
167
159
|
### onSuccess
|
|
168
160
|
|
|
169
|
-
<MemberInfo kind="property" type={`(entity: ResultOf
|
|
161
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void`} />
|
|
170
162
|
|
|
171
163
|
The function to call when the update is successful.
|
|
172
164
|
### onError
|
|
173
165
|
|
|
174
|
-
<MemberInfo kind="property" type={`(error: unknown)
|
|
166
|
+
<MemberInfo kind="property" type={`(error: unknown) => void`} />
|
|
175
167
|
|
|
176
168
|
The function to call when the update is successful.
|
|
177
169
|
|
|
178
170
|
|
|
179
171
|
</div>
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
## UseDetailPageResult
|
|
183
|
-
|
|
184
172
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="158" packageName="@vendure/dashboard" since="3.3.0" />
|
|
185
173
|
|
|
186
174
|
|
|
@@ -200,17 +188,17 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
|
|
|
200
188
|
|
|
201
189
|
### form
|
|
202
190
|
|
|
203
|
-
<MemberInfo kind="property" type={`UseFormReturn
|
|
191
|
+
<MemberInfo kind="property" type={`UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>`} />
|
|
204
192
|
|
|
205
193
|
|
|
206
194
|
### submitHandler
|
|
207
195
|
|
|
208
|
-
<MemberInfo kind="property" type={`(event: FormEvent
|
|
196
|
+
<MemberInfo kind="property" type={`(event: FormEvent<HTMLFormElement>) => void`} />
|
|
209
197
|
|
|
210
198
|
|
|
211
199
|
### entity
|
|
212
200
|
|
|
213
|
-
<MemberInfo kind="property" type={`DetailPageEntity
|
|
201
|
+
<MemberInfo kind="property" type={`DetailPageEntity<T, EntityField>`} />
|
|
214
202
|
|
|
215
203
|
|
|
216
204
|
### isPending
|
|
@@ -220,12 +208,12 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
|
|
|
220
208
|
|
|
221
209
|
### refreshEntity
|
|
222
210
|
|
|
223
|
-
<MemberInfo kind="property" type={`()
|
|
211
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
224
212
|
|
|
225
213
|
|
|
226
214
|
### resetForm
|
|
227
215
|
|
|
228
|
-
<MemberInfo kind="property" type={`()
|
|
216
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
229
217
|
|
|
230
218
|
|
|
231
219
|
|
|
@@ -2,17 +2,13 @@
|
|
|
2
2
|
title: "UseGeneratedForm"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## useGeneratedForm
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="86" packageName="@vendure/dashboard" since="3.3.0" />
|
|
10
6
|
|
|
11
7
|
This hook is used to create a form from a document and an entity.
|
|
12
8
|
It will create a form with the fields defined in the document's input type.
|
|
13
9
|
It will also create a submit handler that will submit the form to the server.
|
|
14
10
|
|
|
15
|
-
This hook is mostly used internally by the higher-level <
|
|
11
|
+
This hook is mostly used internally by the higher-level <DocsLink href="/reference/dashboard/detail-views/use-detail-page#usedetailpage">useDetailPage</DocsLink> hook,
|
|
16
12
|
but can in some cases be useful to use directly.
|
|
17
13
|
|
|
18
14
|
*Example*
|
|
@@ -40,11 +36,7 @@ Parameters
|
|
|
40
36
|
|
|
41
37
|
### options
|
|
42
38
|
|
|
43
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
## GeneratedFormOptions
|
|
39
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a><T, VarName, E>`} />
|
|
48
40
|
|
|
49
41
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="24" packageName="@vendure/dashboard" since="3.3.0" />
|
|
50
42
|
|
|
@@ -91,12 +83,12 @@ The entity to use to generate the form.
|
|
|
91
83
|
|
|
92
84
|
### setValues
|
|
93
85
|
|
|
94
|
-
<MemberInfo kind="property" type={`( entity: NonNullable
|
|
86
|
+
<MemberInfo kind="property" type={`( entity: NonNullable<E>, ) => WithLooseCustomFields< VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T> >`} />
|
|
95
87
|
|
|
96
88
|
|
|
97
89
|
### onSubmit
|
|
98
90
|
|
|
99
|
-
<MemberInfo kind="property" type={`( values: VarName extends keyof VariablesOf
|
|
91
|
+
<MemberInfo kind="property" type={`( values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>, ) => void`} />
|
|
100
92
|
|
|
101
93
|
|
|
102
94
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "ActionBar"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DashboardActionBarItem
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/layout.ts" sourceLine="17" packageName="@vendure/dashboard" since="3.3.0" />
|
|
10
6
|
|
|
11
7
|
Allows you to define custom action bar items for any page in the dashboard, which is the
|
|
@@ -32,7 +28,7 @@ interface DashboardActionBarItem {
|
|
|
32
28
|
The ID of the page where the action bar item should be displayed.
|
|
33
29
|
### component
|
|
34
30
|
|
|
35
|
-
<MemberInfo kind="property" type={`React.FunctionComponent
|
|
31
|
+
<MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`} />
|
|
36
32
|
|
|
37
33
|
A React component that will be rendered in the action bar. Typically, you would use
|
|
38
34
|
the default Shadcn `<Button>` component.
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "Alerts"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DashboardAlertDefinition
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/alerts.ts" sourceLine="11" packageName="@vendure/dashboard" since="3.3.0" />
|
|
10
6
|
|
|
11
7
|
Allows you to define custom alerts that can be displayed in the dashboard.
|
|
@@ -35,27 +31,27 @@ interface DashboardAlertDefinition<TResponse = any> {
|
|
|
35
31
|
A unique identifier for the alert.
|
|
36
32
|
### title
|
|
37
33
|
|
|
38
|
-
<MemberInfo kind="property" type={`string | ((data: TResponse)
|
|
34
|
+
<MemberInfo kind="property" type={`string | ((data: TResponse) => string)`} />
|
|
39
35
|
|
|
40
36
|
The title of the alert. Can be a string or a function that returns a string based on the response data.
|
|
41
37
|
### description
|
|
42
38
|
|
|
43
|
-
<MemberInfo kind="property" type={`string | ((data: TResponse)
|
|
39
|
+
<MemberInfo kind="property" type={`string | ((data: TResponse) => string)`} />
|
|
44
40
|
|
|
45
41
|
The description of the alert. Can be a string or a function that returns a string based on the response data.
|
|
46
42
|
### severity
|
|
47
43
|
|
|
48
|
-
<MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse)
|
|
44
|
+
<MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse) => AlertSeverity)`} />
|
|
49
45
|
|
|
50
46
|
The severity level of the alert.
|
|
51
47
|
### check
|
|
52
48
|
|
|
53
|
-
<MemberInfo kind="property" type={`()
|
|
49
|
+
<MemberInfo kind="property" type={`() => Promise<TResponse> | TResponse`} />
|
|
54
50
|
|
|
55
51
|
A function that checks the condition and returns the response data.
|
|
56
52
|
### shouldShow
|
|
57
53
|
|
|
58
|
-
<MemberInfo kind="property" type={`(data: TResponse)
|
|
54
|
+
<MemberInfo kind="property" type={`(data: TResponse) => boolean`} />
|
|
59
55
|
|
|
60
56
|
A function that determines whether the alert should be rendered based on the response data.
|
|
61
57
|
### recheckInterval
|
|
@@ -65,7 +61,7 @@ A function that determines whether the alert should be rendered based on the res
|
|
|
65
61
|
The interval in milliseconds to recheck the condition.
|
|
66
62
|
### actions
|
|
67
63
|
|
|
68
|
-
<MemberInfo kind="property" type={`Array
|
|
64
|
+
<MemberInfo kind="property" type={`Array<{ label: string; onClick: (args: { data: TResponse; dismiss: () => void }) => void | Promise<any>; }>`} />
|
|
69
65
|
|
|
70
66
|
Optional actions that can be performed when the alert is shown.
|
|
71
67
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "DataTables"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DashboardDataTableExtensionDefinition
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/data-table.ts" sourceLine="131" packageName="@vendure/dashboard" since="3.4.0" />
|
|
10
6
|
|
|
11
7
|
This allows you to customize aspects of existing data tables in the dashboard.
|
|
@@ -41,7 +37,7 @@ such as `'product-variants-table'` on the `'product-detail'` page.
|
|
|
41
37
|
An array of additional bulk actions that will be available on the data table.
|
|
42
38
|
### extendListDocument
|
|
43
39
|
|
|
44
|
-
<MemberInfo kind="property" type={`string | DocumentNode | (()
|
|
40
|
+
<MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`} />
|
|
45
41
|
|
|
46
42
|
Allows you to extend the list document for the data table.
|
|
47
43
|
### displayComponents
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "DefineDashboardExtension"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## defineDashboardExtension
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/define-dashboard-extension.ts" sourceLine="62" packageName="@vendure/dashboard" since="3.3.0" />
|
|
10
6
|
|
|
11
7
|
The main entry point for extensions to the React-based dashboard. Every dashboard extension
|
|
@@ -43,10 +39,6 @@ Parameters
|
|
|
43
39
|
|
|
44
40
|
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/extensions-api/define-dashboard-extension#dashboardextension'>DashboardExtension</a>`} />
|
|
45
41
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
## DashboardExtension
|
|
49
|
-
|
|
50
42
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/extension-api-types.ts" sourceLine="34" packageName="@vendure/dashboard" since="3.3.0" />
|
|
51
43
|
|
|
52
44
|
This is the main interface for defining _all_ extensions to the dashboard.
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "DetailForms"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DashboardDetailFormInputComponent
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/detail-forms.ts" sourceLine="13" packageName="@vendure/dashboard" since="3.4.0" />
|
|
10
6
|
|
|
11
7
|
Allows you to define custom input components for specific fields in detail forms.
|
|
@@ -40,10 +36,6 @@ It should accept `value`, `onChange`, and other standard input props.
|
|
|
40
36
|
|
|
41
37
|
|
|
42
38
|
</div>
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
## DashboardDetailFormExtensionDefinition
|
|
46
|
-
|
|
47
39
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/detail-forms.ts" sourceLine="41" packageName="@vendure/dashboard" since="3.4.0" />
|
|
48
40
|
|
|
49
41
|
Allows you to extend existing detail forms (e.g. on the product detail or customer detail pages)
|
|
@@ -66,7 +58,7 @@ interface DashboardDetailFormExtensionDefinition {
|
|
|
66
58
|
The ID of the page where the detail form is located, e.g. `'product-detail'`, `'order-detail'`.
|
|
67
59
|
### extendDetailDocument
|
|
68
60
|
|
|
69
|
-
<MemberInfo kind="property" type={`string | DocumentNode | (()
|
|
61
|
+
<MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`} />
|
|
70
62
|
|
|
71
63
|
Extends the GraphQL query used to fetch data for the detail page, allowing you to add additional
|
|
72
64
|
fields that can be used by custom input or display components.
|