@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,14 +2,10 @@
|
|
|
2
2
|
title: "ActionBarContext"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ActionBarContext
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="90" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
|
-
Providers & data available to the `onClick` & `buttonState` functions of an <
|
|
12
|
-
<
|
|
7
|
+
Providers & data available to the `onClick` & `buttonState` functions of an <DocsLink href="/reference/admin-ui-api/action-bar/action-bar-item#actionbaritem">ActionBarItem</DocsLink>,
|
|
8
|
+
<DocsLink href="/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item#actionbardropdownmenuitem">ActionBarDropdownMenuItem</DocsLink> or <DocsLink href="/reference/admin-ui-api/nav-menu/nav-menu-item#navmenuitem">NavMenuItem</DocsLink>.
|
|
13
9
|
|
|
14
10
|
```ts title="Signature"
|
|
15
11
|
interface ActionBarContext {
|
|
@@ -50,7 +46,7 @@ The [NotificationService](/reference/admin-ui-api/services/notification-service)
|
|
|
50
46
|
displaying notifications to the user.
|
|
51
47
|
### entity$
|
|
52
48
|
|
|
53
|
-
<MemberInfo kind="property" type={`Observable
|
|
49
|
+
<MemberInfo kind="property" type={`Observable<Record<string, any> | undefined>`} since="2.2.0" />
|
|
54
50
|
|
|
55
51
|
An observable of the current entity in a detail view. In a list view the observable will not emit any values.
|
|
56
52
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "ActionBarDropdownMenuItem"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ActionBarDropdownMenuItem
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="227" packageName="@vendure/admin-ui" since="2.2.0" />
|
|
10
6
|
|
|
11
7
|
A dropdown menu item in the ActionBar area at the top of one of the list or detail views.
|
|
@@ -49,13 +45,13 @@ The location in the UI where this menu item should be displayed.
|
|
|
49
45
|
Whether to render a divider above this item.
|
|
50
46
|
### buttonState
|
|
51
47
|
|
|
52
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>)
|
|
48
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => Observable<ActionBarButtonState | undefined>`} />
|
|
53
49
|
|
|
54
50
|
A function which returns an observable of the button state, allowing you to
|
|
55
51
|
dynamically enable/disable or show/hide the button.
|
|
56
52
|
### onClick
|
|
57
53
|
|
|
58
|
-
<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>)
|
|
54
|
+
<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => void`} />
|
|
59
55
|
|
|
60
56
|
|
|
61
57
|
### routerLink
|
|
@@ -75,7 +71,7 @@ set.
|
|
|
75
71
|
<MemberInfo kind="property" type={`string | string[]`} />
|
|
76
72
|
|
|
77
73
|
Control the display of this item based on the user permissions. Note: if you attempt to pass a
|
|
78
|
-
<
|
|
74
|
+
<DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink> object, you will get a compilation error. Instead, pass the plain
|
|
79
75
|
string version. For example, if the permission is defined as:
|
|
80
76
|
|
|
81
77
|
```ts
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "ActionBarItem"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ActionBarItem
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="158" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
A button in the ActionBar area at the top of one of the list or detail views.
|
|
@@ -46,18 +42,18 @@ e.g. `invoice-plugin.print-invoice`.
|
|
|
46
42
|
The location in the UI where this button should be displayed.
|
|
47
43
|
### disabled
|
|
48
44
|
|
|
49
|
-
<MemberInfo kind="property" type={`Observable
|
|
45
|
+
<MemberInfo kind="property" type={`Observable<boolean>`} />
|
|
50
46
|
|
|
51
47
|
Deprecated since v2.1.0 - use `buttonState` instead.
|
|
52
48
|
### buttonState
|
|
53
49
|
|
|
54
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>)
|
|
50
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => Observable<ActionBarButtonState>`} since="2.1.0" />
|
|
55
51
|
|
|
56
52
|
A function which returns an observable of the button state, allowing you to
|
|
57
53
|
dynamically enable/disable or show/hide the button.
|
|
58
54
|
### onClick
|
|
59
55
|
|
|
60
|
-
<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>)
|
|
56
|
+
<MemberInfo kind="property" type={`(event: MouseEvent, context: <a href='/reference/admin-ui-api/action-bar/action-bar-context#actionbarcontext'>ActionBarContext</a>) => void`} />
|
|
61
57
|
|
|
62
58
|
|
|
63
59
|
### routerLink
|
|
@@ -87,7 +83,7 @@ set.
|
|
|
87
83
|
<MemberInfo kind="property" type={`string | string[]`} />
|
|
88
84
|
|
|
89
85
|
Control the display of this item based on the user permissions. Note: if you attempt to pass a
|
|
90
|
-
<
|
|
86
|
+
<DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink> object, you will get a compilation error. Instead, pass the plain
|
|
91
87
|
string version. For example, if the permission is defined as:
|
|
92
88
|
|
|
93
89
|
```ts
|
|
@@ -2,14 +2,10 @@
|
|
|
2
2
|
title: "ActionBarLocationId"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ActionBarLocationId
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="107" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
The valid locationIds for registering action bar items. For a list of
|
|
12
|
-
values, see <
|
|
8
|
+
values, see <DocsLink href="/reference/admin-ui-api/action-bar/page-location-id#pagelocationid">PageLocationId</DocsLink>.
|
|
13
9
|
|
|
14
10
|
```ts title="Signature"
|
|
15
11
|
type ActionBarLocationId = PageLocationId
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "AddActionBarDropdownMenuItem"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## addActionBarDropdownMenuItem
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-action-bar-dropdown-menu-item.ts" sourceLine="27" packageName="@vendure/admin-ui" since="2.2.0" />
|
|
10
6
|
|
|
11
7
|
Adds a dropdown menu item to the ActionBar at the top right of each list or detail view. The locationId can
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "AddActionBarItem"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## addActionBarItem
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-action-bar-item.ts" sourceLine="23" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
Adds a button to the ActionBar at the top right of each list or detail view. The locationId can
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "PageLocationId"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## PageLocationId
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="52" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
The valid locationIds for registering action bar items or tabs.
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "RouterLinkDefinition"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## RouterLinkDefinition
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="289" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
|
-
A function which returns the router link for an <
|
|
7
|
+
A function which returns the router link for an <DocsLink href="/reference/admin-ui-api/action-bar/action-bar-item#actionbaritem">ActionBarItem</DocsLink> or <DocsLink href="/reference/admin-ui-api/nav-menu/nav-menu-item#navmenuitem">NavMenuItem</DocsLink>.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
type RouterLinkDefinition = ((route: ActivatedRoute, context: ActionBarContext) => any[]) | any[]
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "AlertConfig"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## AlertConfig
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/alerts/alerts.service.ts" sourceLine="63" packageName="@vendure/admin-ui" since="2.2.0" />
|
|
10
6
|
|
|
11
7
|
A configuration object for an Admin UI alert.
|
|
@@ -34,7 +30,7 @@ interface AlertConfig<T = any> {
|
|
|
34
30
|
A unique identifier for the alert.
|
|
35
31
|
### check
|
|
36
32
|
|
|
37
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>)
|
|
33
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => T | Promise<T> | Observable<T>`} />
|
|
38
34
|
|
|
39
35
|
A function which is gets the data used to determine whether the alert should be shown.
|
|
40
36
|
Typically, this function will query the server or some other remote data source.
|
|
@@ -43,7 +39,7 @@ This function will be called once when the Admin UI app bootstraps, and can be a
|
|
|
43
39
|
set to run at regular intervals by setting the `recheckIntervalMs` property.
|
|
44
40
|
### recheck
|
|
45
41
|
|
|
46
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>)
|
|
42
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => Observable<any>`} default={`undefined`} />
|
|
47
43
|
|
|
48
44
|
A function which returns an Observable which is used to determine when to re-run the `check`
|
|
49
45
|
function. Whenever the observable emits, the `check` function will be called again.
|
|
@@ -62,18 +58,18 @@ recheck: () => interval(60_000)
|
|
|
62
58
|
If this is not set, the `check` function will only be called once when the Admin UI app bootstraps.
|
|
63
59
|
### isAlert
|
|
64
60
|
|
|
65
|
-
<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>)
|
|
61
|
+
<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => boolean`} />
|
|
66
62
|
|
|
67
63
|
A function which determines whether the alert should be shown based on the data returned by the `check`
|
|
68
64
|
function.
|
|
69
65
|
### action
|
|
70
66
|
|
|
71
|
-
<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>)
|
|
67
|
+
<MemberInfo kind="property" type={`(data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>) => void`} />
|
|
72
68
|
|
|
73
69
|
A function which is called when the alert is clicked in the Admin UI.
|
|
74
70
|
### label
|
|
75
71
|
|
|
76
|
-
<MemberInfo kind="property" type={`( data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>, )
|
|
72
|
+
<MemberInfo kind="property" type={`( data: T, context: <a href='/reference/admin-ui-api/alerts/alert-context#alertcontext'>AlertContext</a>, ) => { text: string; translationVars?: { [key: string]: string | number } }`} />
|
|
77
73
|
|
|
78
74
|
A function which returns the text used in the UI to describe the alert.
|
|
79
75
|
### requiredPermissions
|
|
@@ -2,14 +2,10 @@
|
|
|
2
2
|
title: "AlertContext"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## AlertContext
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/alerts/alerts.service.ts" sourceLine="29" packageName="@vendure/admin-ui" since="2.2.0" />
|
|
10
6
|
|
|
11
7
|
The context object which is passed to the `check`, `isAlert`, `label` and `action` functions of an
|
|
12
|
-
<
|
|
8
|
+
<DocsLink href="/reference/admin-ui-api/alerts/alert-config#alertconfig">AlertConfig</DocsLink> object.
|
|
13
9
|
|
|
14
10
|
```ts title="Signature"
|
|
15
11
|
interface AlertContext {
|
|
@@ -2,14 +2,10 @@
|
|
|
2
2
|
title: "RegisterAlert"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## registerAlert
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-alert.ts" sourceLine="12" packageName="@vendure/admin-ui" since="2.2.0" />
|
|
10
6
|
|
|
11
7
|
Registers an alert which can be displayed in the Admin UI alert dropdown in the top bar.
|
|
12
|
-
The alert is configured using the <
|
|
8
|
+
The alert is configured using the <DocsLink href="/reference/admin-ui-api/alerts/alert-config#alertconfig">AlertConfig</DocsLink> object.
|
|
13
9
|
|
|
14
10
|
```ts title="Signature"
|
|
15
11
|
function registerAlert(config: AlertConfig): void
|
|
@@ -2,15 +2,11 @@
|
|
|
2
2
|
title: "BulkAction"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## BulkAction
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/bulk-action-registry/bulk-action-types.ts" sourceLine="99" packageName="@vendure/admin-ui" since="1.8.0" />
|
|
10
6
|
|
|
11
7
|
Configures a bulk action which can be performed on all selected items in a list view.
|
|
12
8
|
|
|
13
|
-
For a full example, see the <
|
|
9
|
+
For a full example, see the <DocsLink href="/reference/admin-ui-api/bulk-actions/register-bulk-action#registerbulkaction">registerBulkAction</DocsLink> docs.
|
|
14
10
|
|
|
15
11
|
```ts title="Signature"
|
|
16
12
|
interface BulkAction<ItemType = any, ComponentType = any> {
|
|
@@ -41,7 +37,7 @@ interface BulkAction<ItemType = any, ComponentType = any> {
|
|
|
41
37
|
|
|
42
38
|
### getTranslationVars
|
|
43
39
|
|
|
44
|
-
<MemberInfo kind="property" type={`( context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a
|
|
40
|
+
<MemberInfo kind="property" type={`( context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a><ItemType, ComponentType>, ) => Record<string, string | number> | Promise<Record<string, string | number>>`} />
|
|
45
41
|
|
|
46
42
|
An optional function that should resolve to a map of translation variables which can be
|
|
47
43
|
used when translating the `label` string.
|
|
@@ -64,12 +60,12 @@ A class to be added to the icon element. Examples:
|
|
|
64
60
|
- is-highlight
|
|
65
61
|
### onClick
|
|
66
62
|
|
|
67
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionclickcontext'>BulkActionClickContext</a
|
|
63
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionclickcontext'>BulkActionClickContext</a><ItemType, ComponentType>) => void`} />
|
|
68
64
|
|
|
69
65
|
Defines the logic that executes when the bulk action button is clicked.
|
|
70
66
|
### isVisible
|
|
71
67
|
|
|
72
|
-
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a
|
|
68
|
+
<MemberInfo kind="property" type={`(context: <a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a><ItemType, ComponentType>) => boolean | Promise<boolean>`} />
|
|
73
69
|
|
|
74
70
|
A function that determines whether this bulk action item should be displayed in the menu.
|
|
75
71
|
If not defined, the item will always be displayed.
|
|
@@ -95,7 +91,7 @@ registerBulkAction({
|
|
|
95
91
|
```
|
|
96
92
|
### requiresPermission
|
|
97
93
|
|
|
98
|
-
<MemberInfo kind="property" type={`string | ((userPermissions: string[])
|
|
94
|
+
<MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
|
|
99
95
|
|
|
100
96
|
Control the display of this item based on the user permissions.
|
|
101
97
|
|
|
@@ -116,10 +112,6 @@ registerBulkAction({
|
|
|
116
112
|
|
|
117
113
|
|
|
118
114
|
</div>
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
## BulkActionLocationId
|
|
122
|
-
|
|
123
115
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/bulk-action-registry/bulk-action-types.ts" sourceLine="12" packageName="@vendure/admin-ui" since="1.8.0" />
|
|
124
116
|
|
|
125
117
|
A valid location of a list view that supports the bulk actions API.
|
|
@@ -146,10 +138,6 @@ type BulkActionLocationId = | 'product-list'
|
|
|
146
138
|
| 'zone-members-list'
|
|
147
139
|
| string
|
|
148
140
|
```
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
## BulkActionFunctionContext
|
|
152
|
-
|
|
153
141
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/bulk-action-registry/bulk-action-types.ts" sourceLine="43" packageName="@vendure/admin-ui" since="1.8.0" />
|
|
154
142
|
|
|
155
143
|
This is the argument which gets passed to the `getTranslationVars` and `isVisible` functions
|
|
@@ -193,10 +181,6 @@ to get service instances which might be needed in the click handler.
|
|
|
193
181
|
|
|
194
182
|
|
|
195
183
|
</div>
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
## BulkActionClickContext
|
|
199
|
-
|
|
200
184
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/bulk-action-registry/bulk-action-types.ts" sourceLine="74" packageName="@vendure/admin-ui" since="1.8.0" />
|
|
201
185
|
|
|
202
186
|
This is the argument which gets passed to the `onClick` function of a BulkAction.
|
|
@@ -207,7 +191,7 @@ interface BulkActionClickContext<ItemType, ComponentType> extends BulkActionFunc
|
|
|
207
191
|
event: MouseEvent;
|
|
208
192
|
}
|
|
209
193
|
```
|
|
210
|
-
* Extends: <code><a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a
|
|
194
|
+
* Extends: <code><a href='/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext'>BulkActionFunctionContext</a><ItemType, ComponentType></code>
|
|
211
195
|
|
|
212
196
|
|
|
213
197
|
|
|
@@ -215,7 +199,7 @@ interface BulkActionClickContext<ItemType, ComponentType> extends BulkActionFunc
|
|
|
215
199
|
|
|
216
200
|
### clearSelection
|
|
217
201
|
|
|
218
|
-
<MemberInfo kind="property" type={`()
|
|
202
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
219
203
|
|
|
220
204
|
Clears the selection in the active list view.
|
|
221
205
|
### event
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "RegisterBulkAction"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## registerBulkAction
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-bulk-action.ts" sourceLine="52" packageName="@vendure/admin-ui" since="1.8.0" />
|
|
10
6
|
|
|
11
|
-
Registers a custom <
|
|
7
|
+
Registers a custom <DocsLink href="/reference/admin-ui-api/bulk-actions/bulk-action#bulkaction">BulkAction</DocsLink> which can be invoked from the bulk action menu
|
|
12
8
|
of any supported list view.
|
|
13
9
|
|
|
14
10
|
This allows you to provide custom functionality that can operate on any of the selected
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "AssetPickerDialogComponent"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## AssetPickerDialogComponent
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/asset-picker-dialog/asset-picker-dialog.component.ts" sourceLine="51" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
A dialog which allows the creation and selection of assets.
|
|
@@ -53,7 +49,7 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
|
|
|
53
49
|
createAssets(files: File[]) => ;
|
|
54
50
|
}
|
|
55
51
|
```
|
|
56
|
-
* Implements: <code>OnInit</code>, <code>AfterViewInit</code>, <code>OnDestroy</code>, <code><a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a
|
|
52
|
+
* Implements: <code>OnInit</code>, <code>AfterViewInit</code>, <code>OnDestroy</code>, <code><a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a><<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]></code>
|
|
57
53
|
|
|
58
54
|
|
|
59
55
|
|
|
@@ -61,12 +57,12 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
|
|
|
61
57
|
|
|
62
58
|
### assets$
|
|
63
59
|
|
|
64
|
-
<MemberInfo kind="property" type={`Observable
|
|
60
|
+
<MemberInfo kind="property" type={`Observable<AssetLike[]>`} />
|
|
65
61
|
|
|
66
62
|
|
|
67
63
|
### allTags$
|
|
68
64
|
|
|
69
|
-
<MemberInfo kind="property" type={`Observable
|
|
65
|
+
<MemberInfo kind="property" type={`Observable<TagFragment[]>`} />
|
|
70
66
|
|
|
71
67
|
|
|
72
68
|
### paginationConfig
|
|
@@ -86,7 +82,7 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
|
|
|
86
82
|
|
|
87
83
|
### resolveWith
|
|
88
84
|
|
|
89
|
-
<MemberInfo kind="property" type={`(result?: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[])
|
|
85
|
+
<MemberInfo kind="property" type={`(result?: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`} />
|
|
90
86
|
|
|
91
87
|
|
|
92
88
|
### selection
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "ChipComponent"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ChipComponent
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/chip/chip.component.ts" sourceLine="16" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
A chip component for displaying a label with an optional action icon.
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "CurrencyInputComponent"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## CurrencyInputComponent
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/currency-input/currency-input.component.ts" sourceLine="33" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
A form input control which displays currency in decimal format, whilst working
|
|
@@ -80,12 +76,12 @@ class CurrencyInputComponent implements ControlValueAccessor, OnInit, OnChanges,
|
|
|
80
76
|
|
|
81
77
|
### prefix$
|
|
82
78
|
|
|
83
|
-
<MemberInfo kind="property" type={`Observable
|
|
79
|
+
<MemberInfo kind="property" type={`Observable<string>`} />
|
|
84
80
|
|
|
85
81
|
|
|
86
82
|
### suffix$
|
|
87
83
|
|
|
88
|
-
<MemberInfo kind="property" type={`Observable
|
|
84
|
+
<MemberInfo kind="property" type={`Observable<string>`} />
|
|
89
85
|
|
|
90
86
|
|
|
91
87
|
### hasFractionPart
|
|
@@ -95,12 +91,12 @@ class CurrencyInputComponent implements ControlValueAccessor, OnInit, OnChanges,
|
|
|
95
91
|
|
|
96
92
|
### onChange
|
|
97
93
|
|
|
98
|
-
<MemberInfo kind="property" type={`(val: any)
|
|
94
|
+
<MemberInfo kind="property" type={`(val: any) => void`} />
|
|
99
95
|
|
|
100
96
|
|
|
101
97
|
### onTouch
|
|
102
98
|
|
|
103
|
-
<MemberInfo kind="property" type={`()
|
|
99
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
104
100
|
|
|
105
101
|
|
|
106
102
|
### _inputValue
|
|
@@ -2,16 +2,12 @@
|
|
|
2
2
|
title: "DataTableComponent"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DataTableComponent
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table/data-table.component.ts" sourceLine="86" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
A table for displaying PaginatedList results. It is designed to be used inside components which
|
|
12
|
-
extend the <
|
|
8
|
+
extend the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">BaseListComponent</DocsLink> class.
|
|
13
9
|
|
|
14
|
-
**Deprecated** This component is deprecated. Use the <
|
|
10
|
+
**Deprecated** This component is deprecated. Use the <DocsLink href="/reference/admin-ui-api/components/data-table2component#datatable2component">DataTable2Component</DocsLink> instead.
|
|
15
11
|
|
|
16
12
|
*Example*
|
|
17
13
|
|
|
@@ -129,7 +125,7 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
|
|
|
129
125
|
|
|
130
126
|
### selectionManager
|
|
131
127
|
|
|
132
|
-
<MemberInfo kind="property" type={`SelectionManager
|
|
128
|
+
<MemberInfo kind="property" type={`SelectionManager<T>`} />
|
|
133
129
|
|
|
134
130
|
|
|
135
131
|
### pageChange
|
|
@@ -149,7 +145,7 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
|
|
|
149
145
|
|
|
150
146
|
### isRowSelectedFn
|
|
151
147
|
|
|
152
|
-
<MemberInfo kind="property" type={`((item: T)
|
|
148
|
+
<MemberInfo kind="property" type={`((item: T) => boolean) | undefined`} />
|
|
153
149
|
|
|
154
150
|
|
|
155
151
|
### allSelectChange
|
|
@@ -164,17 +160,17 @@ class DataTableComponent<T> implements AfterContentInit, OnChanges, OnInit, OnDe
|
|
|
164
160
|
|
|
165
161
|
### columns
|
|
166
162
|
|
|
167
|
-
<MemberInfo kind="property" type={`QueryList
|
|
163
|
+
<MemberInfo kind="property" type={`QueryList<DataTableColumnComponent>`} />
|
|
168
164
|
|
|
169
165
|
|
|
170
166
|
### templateRefs
|
|
171
167
|
|
|
172
|
-
<MemberInfo kind="property" type={`QueryList
|
|
168
|
+
<MemberInfo kind="property" type={`QueryList<TemplateRef<any>>`} />
|
|
173
169
|
|
|
174
170
|
|
|
175
171
|
### rowTemplate
|
|
176
172
|
|
|
177
|
-
<MemberInfo kind="property" type={`TemplateRef
|
|
173
|
+
<MemberInfo kind="property" type={`TemplateRef<any>`} />
|
|
178
174
|
|
|
179
175
|
|
|
180
176
|
### currentStart
|
|
@@ -2,14 +2,10 @@
|
|
|
2
2
|
title: "DataTable2Component"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DataTable2Component
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table2.component.ts" sourceLine="101" packageName="@vendure/admin-ui" />
|
|
10
6
|
|
|
11
7
|
A table for displaying PaginatedList results. It is designed to be used inside components which
|
|
12
|
-
extend the <
|
|
8
|
+
extend the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">BaseListComponent</DocsLink> or <DocsLink href="/reference/admin-ui-api/list-detail-views/typed-base-list-component#typedbaselistcomponent">TypedBaseListComponent</DocsLink> class.
|
|
13
9
|
|
|
14
10
|
*Example*
|
|
15
11
|
|
|
@@ -185,12 +181,12 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
185
181
|
|
|
186
182
|
### columns
|
|
187
183
|
|
|
188
|
-
<MemberInfo kind="property" type={`QueryList
|
|
184
|
+
<MemberInfo kind="property" type={`QueryList<DataTable2ColumnComponent<T>>`} />
|
|
189
185
|
|
|
190
186
|
|
|
191
187
|
### customFieldColumns
|
|
192
188
|
|
|
193
|
-
<MemberInfo kind="property" type={`QueryList
|
|
189
|
+
<MemberInfo kind="property" type={`QueryList<DataTableCustomFieldColumnComponent<T>>`} />
|
|
194
190
|
|
|
195
191
|
|
|
196
192
|
### searchComponent
|
|
@@ -205,12 +201,12 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
205
201
|
|
|
206
202
|
### customSearchTemplate
|
|
207
203
|
|
|
208
|
-
<MemberInfo kind="property" type={`TemplateRef
|
|
204
|
+
<MemberInfo kind="property" type={`TemplateRef<any>`} />
|
|
209
205
|
|
|
210
206
|
|
|
211
207
|
### templateRefs
|
|
212
208
|
|
|
213
|
-
<MemberInfo kind="property" type={`QueryList
|
|
209
|
+
<MemberInfo kind="property" type={`QueryList<TemplateRef<any>>`} />
|
|
214
210
|
|
|
215
211
|
|
|
216
212
|
### injector
|
|
@@ -245,7 +241,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
245
241
|
|
|
246
242
|
### rowTemplate
|
|
247
243
|
|
|
248
|
-
<MemberInfo kind="property" type={`TemplateRef
|
|
244
|
+
<MemberInfo kind="property" type={`TemplateRef<any>`} />
|
|
249
245
|
|
|
250
246
|
|
|
251
247
|
### currentStart
|
|
@@ -270,7 +266,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
270
266
|
|
|
271
267
|
### uiLanguage$
|
|
272
268
|
|
|
273
|
-
<MemberInfo kind="property" type={`Observable
|
|
269
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
|
|
274
270
|
|
|
275
271
|
|
|
276
272
|
### destroy$
|
|
@@ -320,7 +316,7 @@ class DataTable2Component<T> implements AfterContentInit, OnChanges, OnDestroy {
|
|
|
320
316
|
|
|
321
317
|
### onColumnReorder
|
|
322
318
|
|
|
323
|
-
<MemberInfo kind="method" type={`(event: { column: DataTable2ColumnComponent
|
|
319
|
+
<MemberInfo kind="method" type={`(event: { column: DataTable2ColumnComponent<any>; newIndex: number }) => `} />
|
|
324
320
|
|
|
325
321
|
|
|
326
322
|
### onColumnsReset
|