@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: "ExternalAuthenticationService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ExternalAuthenticationService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/external-authentication/external-authentication.service.ts" sourceLine="24" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
This is a helper service which exposes methods related to looking up and creating Users based on an
|
|
12
|
-
external <
|
|
8
|
+
external <DocsLink href="/reference/typescript-api/auth/authentication-strategy#authenticationstrategy">AuthenticationStrategy</DocsLink>.
|
|
13
9
|
|
|
14
10
|
```ts title="Signature"
|
|
15
11
|
class ExternalAuthenticationService {
|
|
@@ -50,7 +46,7 @@ class ExternalAuthenticationService {
|
|
|
50
46
|
|
|
51
47
|
### findCustomerUser
|
|
52
48
|
|
|
53
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string, checkCurrentChannelOnly: = true) => Promise
|
|
49
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string, checkCurrentChannelOnly: = true) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
|
|
54
50
|
|
|
55
51
|
Looks up a User based on their identifier from an external authentication
|
|
56
52
|
provider, ensuring this User is associated with a Customer account.
|
|
@@ -60,13 +56,13 @@ By passing `false` as the `checkCurrentChannelOnly` argument, _all_ channels
|
|
|
60
56
|
will be checked.
|
|
61
57
|
### findAdministratorUser
|
|
62
58
|
|
|
63
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise
|
|
59
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
|
|
64
60
|
|
|
65
61
|
Looks up a User based on their identifier from an external authentication
|
|
66
62
|
provider, ensuring this User is associated with an Administrator account.
|
|
67
63
|
### createCustomerAndUser
|
|
68
64
|
|
|
69
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; emailAddress: string; firstName: string; lastName: string; verified?: boolean; }) => Promise
|
|
65
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; emailAddress: string; firstName: string; lastName: string; verified?: boolean; }) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
|
|
70
66
|
|
|
71
67
|
If a customer has been successfully authenticated by an external authentication provider, yet cannot
|
|
72
68
|
be found using `findCustomerUser`, then we need to create a new User and
|
|
@@ -81,12 +77,12 @@ be found using `findAdministratorUser`, then we need to create a new User and
|
|
|
81
77
|
Administrator record in Vendure for that user.
|
|
82
78
|
### findUser
|
|
83
79
|
|
|
84
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise
|
|
80
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
|
|
85
81
|
|
|
86
82
|
|
|
87
83
|
### createUser
|
|
88
84
|
|
|
89
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; }) => Promise
|
|
85
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; }) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
|
|
90
86
|
|
|
91
87
|
Looks up a User based on their identifier from an external authentication
|
|
92
88
|
provider. Creates the user if does not exist. Unlike `findCustomerUser` and `findAdministratorUser`,
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "InMemorySessionCacheStrategy"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## InMemorySessionCacheStrategy
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/session-cache/in-memory-session-cache-strategy.ts" sourceLine="16" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
Caches session in memory, using a LRU cache implementation. Not suitable for
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "NativeAuthenticationStrategy"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## NativeAuthenticationStrategy
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/auth/native-authentication-strategy.ts" sourceLine="28" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
This strategy implements a username/password credential-based authentication, with the credentials
|
|
@@ -21,7 +17,7 @@ class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthe
|
|
|
21
17
|
verifyUserPassword(ctx: RequestContext, userId: ID, password: string) => Promise<boolean>;
|
|
22
18
|
}
|
|
23
19
|
```
|
|
24
|
-
* Implements: <code><a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a
|
|
20
|
+
* Implements: <code><a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a><NativeAuthenticationData></code>
|
|
25
21
|
|
|
26
22
|
|
|
27
23
|
|
|
@@ -44,12 +40,12 @@ class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthe
|
|
|
44
40
|
|
|
45
41
|
### authenticate
|
|
46
42
|
|
|
47
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: NativeAuthenticationData) => Promise
|
|
43
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: NativeAuthenticationData) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | false>`} />
|
|
48
44
|
|
|
49
45
|
|
|
50
46
|
### verifyUserPassword
|
|
51
47
|
|
|
52
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, password: string) => Promise
|
|
48
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, password: string) => Promise<boolean>`} />
|
|
53
49
|
|
|
54
50
|
|
|
55
51
|
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "NoopSessionCacheStrategy"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## NoopSessionCacheStrategy
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/session-cache/noop-session-cache-strategy.ts" sourceLine="10" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
A cache that doesn't cache. The cache lookup will miss every time
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "PasswordHashingStrategy"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## PasswordHashingStrategy
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/auth/password-hashing-strategy.ts" sourceLine="17" packageName="@vendure/core" since="1.3.0" />
|
|
10
6
|
|
|
11
|
-
Defines how user passwords get hashed when using the <
|
|
7
|
+
Defines how user passwords get hashed when using the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink>.
|
|
12
8
|
|
|
13
9
|
:::info
|
|
14
10
|
|
|
@@ -31,12 +27,12 @@ interface PasswordHashingStrategy extends InjectableStrategy {
|
|
|
31
27
|
|
|
32
28
|
### hash
|
|
33
29
|
|
|
34
|
-
<MemberInfo kind="method" type={`(plaintext: string) => Promise
|
|
30
|
+
<MemberInfo kind="method" type={`(plaintext: string) => Promise<string>`} />
|
|
35
31
|
|
|
36
32
|
|
|
37
33
|
### check
|
|
38
34
|
|
|
39
|
-
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise
|
|
35
|
+
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise<boolean>`} />
|
|
40
36
|
|
|
41
37
|
|
|
42
38
|
|
|
@@ -2,14 +2,10 @@
|
|
|
2
2
|
title: "PasswordValidationStrategy"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## PasswordValidationStrategy
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/auth/password-validation-strategy.ts" sourceLine="19" packageName="@vendure/core" since="1.5.0" />
|
|
10
6
|
|
|
11
7
|
Defines validation to apply to new password (when creating an account or updating an existing account's
|
|
12
|
-
password when using the <
|
|
8
|
+
password when using the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink>.
|
|
13
9
|
|
|
14
10
|
:::info
|
|
15
11
|
|
|
@@ -31,7 +27,7 @@ interface PasswordValidationStrategy extends InjectableStrategy {
|
|
|
31
27
|
|
|
32
28
|
### validate
|
|
33
29
|
|
|
34
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) => Promise
|
|
30
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) => Promise<boolean | string> | boolean | string`} since="1.5.0" />
|
|
35
31
|
|
|
36
32
|
Validates a password submitted during account registration or when a customer updates their password.
|
|
37
33
|
The method should resolve to `true` if the password is acceptable. If not, it should return `false` or
|
|
@@ -2,16 +2,12 @@
|
|
|
2
2
|
title: "PermissionDefinition"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## PermissionDefinition
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="86" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
Defines a new Permission with which to control access to GraphQL resolvers & REST controllers.
|
|
12
|
-
Used in conjunction with the <
|
|
8
|
+
Used in conjunction with the <DocsLink href="/reference/typescript-api/request/allow-decorator#allow">Allow</DocsLink> decorator (see example below).
|
|
13
9
|
|
|
14
|
-
**Note:** To define CRUD permissions, use the <
|
|
10
|
+
**Note:** To define CRUD permissions, use the <DocsLink href="/reference/typescript-api/auth/permission-definition#crudpermissiondefinition">CrudPermissionDefinition</DocsLink>.
|
|
15
11
|
|
|
16
12
|
*Example*
|
|
17
13
|
|
|
@@ -61,14 +57,10 @@ class PermissionDefinition {
|
|
|
61
57
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
62
58
|
|
|
63
59
|
Returns the permission defined by this definition, for use in the
|
|
64
|
-
<
|
|
60
|
+
<DocsLink href="/reference/typescript-api/request/allow-decorator#allow">Allow</DocsLink> decorator.
|
|
65
61
|
|
|
66
62
|
|
|
67
63
|
</div>
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
## CrudPermissionDefinition
|
|
71
|
-
|
|
72
64
|
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="146" packageName="@vendure/core" />
|
|
73
65
|
|
|
74
66
|
Defines a set of CRUD Permissions for the given name, i.e. a `name` of 'Wishlist' will create
|
|
@@ -117,7 +109,7 @@ class CrudPermissionDefinition extends PermissionDefinition {
|
|
|
117
109
|
|
|
118
110
|
### constructor
|
|
119
111
|
|
|
120
|
-
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete')
|
|
112
|
+
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete') => string) => CrudPermissionDefinition`} />
|
|
121
113
|
|
|
122
114
|
|
|
123
115
|
### Create
|
|
@@ -125,32 +117,28 @@ class CrudPermissionDefinition extends PermissionDefinition {
|
|
|
125
117
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
126
118
|
|
|
127
119
|
Returns the 'Create' CRUD permission defined by this definition, for use in the
|
|
128
|
-
<
|
|
120
|
+
<DocsLink href="/reference/typescript-api/request/allow-decorator#allow">Allow</DocsLink> decorator.
|
|
129
121
|
### Read
|
|
130
122
|
|
|
131
123
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
132
124
|
|
|
133
125
|
Returns the 'Read' CRUD permission defined by this definition, for use in the
|
|
134
|
-
<
|
|
126
|
+
<DocsLink href="/reference/typescript-api/request/allow-decorator#allow">Allow</DocsLink> decorator.
|
|
135
127
|
### Update
|
|
136
128
|
|
|
137
129
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
138
130
|
|
|
139
131
|
Returns the 'Update' CRUD permission defined by this definition, for use in the
|
|
140
|
-
<
|
|
132
|
+
<DocsLink href="/reference/typescript-api/request/allow-decorator#allow">Allow</DocsLink> decorator.
|
|
141
133
|
### Delete
|
|
142
134
|
|
|
143
135
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
144
136
|
|
|
145
137
|
Returns the 'Delete' CRUD permission defined by this definition, for use in the
|
|
146
|
-
<
|
|
138
|
+
<DocsLink href="/reference/typescript-api/request/allow-decorator#allow">Allow</DocsLink> decorator.
|
|
147
139
|
|
|
148
140
|
|
|
149
141
|
</div>
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
## RwPermissionDefinition
|
|
153
|
-
|
|
154
142
|
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="245" packageName="@vendure/core" since="3.5.0" />
|
|
155
143
|
|
|
156
144
|
Defines a set of Read-Write Permissions for the given name, i.e. a `name` of 'DashboardSavedViews' will create
|
|
@@ -203,7 +191,7 @@ class RwPermissionDefinition extends PermissionDefinition {
|
|
|
203
191
|
|
|
204
192
|
### constructor
|
|
205
193
|
|
|
206
|
-
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'read' | 'write')
|
|
194
|
+
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'read' | 'write') => string) => RwPermissionDefinition`} />
|
|
207
195
|
|
|
208
196
|
|
|
209
197
|
### Read
|
|
@@ -211,23 +199,19 @@ class RwPermissionDefinition extends PermissionDefinition {
|
|
|
211
199
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
212
200
|
|
|
213
201
|
Returns the 'Read' permission defined by this definition, for use in the
|
|
214
|
-
<
|
|
202
|
+
<DocsLink href="/reference/typescript-api/request/allow-decorator#allow">Allow</DocsLink> decorator.
|
|
215
203
|
### Write
|
|
216
204
|
|
|
217
205
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
218
206
|
|
|
219
207
|
Returns the 'Write' permission defined by this definition, for use in the
|
|
220
|
-
<
|
|
208
|
+
<DocsLink href="/reference/typescript-api/request/allow-decorator#allow">Allow</DocsLink> decorator.
|
|
221
209
|
|
|
222
210
|
|
|
223
211
|
</div>
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
## PermissionDefinitionConfig
|
|
227
|
-
|
|
228
212
|
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="10" packageName="@vendure/core" />
|
|
229
213
|
|
|
230
|
-
Configures a <
|
|
214
|
+
Configures a <DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink>
|
|
231
215
|
|
|
232
216
|
```ts title="Signature"
|
|
233
217
|
interface PermissionDefinitionConfig {
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "SessionCacheStrategy"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## SessionCacheStrategy
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/session-cache/session-cache-strategy.ts" sourceLine="164" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
This strategy defines how sessions get cached. Since most requests will need the Session
|
|
@@ -13,18 +9,18 @@ object for permissions data, it can become a bottleneck to go to the database an
|
|
|
13
9
|
SQL query each time. Therefore, we cache the session data only perform the SQL query once and upon
|
|
14
10
|
invalidation of the cache.
|
|
15
11
|
|
|
16
|
-
The Vendure default from v3.1+ is to use a the <
|
|
17
|
-
to the configured <
|
|
12
|
+
The Vendure default from v3.1+ is to use a the <DocsLink href="/reference/typescript-api/auth/default-session-cache-strategy#defaultsessioncachestrategy">DefaultSessionCacheStrategy</DocsLink>, which delegates
|
|
13
|
+
to the configured <DocsLink href="/reference/typescript-api/cache/cache-strategy#cachestrategy">CacheStrategy</DocsLink> to store the session data. This should be suitable
|
|
18
14
|
for most use-cases.
|
|
19
15
|
|
|
20
16
|
:::note
|
|
21
17
|
|
|
22
18
|
If you are using v3.1 or later, you should not normally need to implement a custom `SessionCacheStrategy`,
|
|
23
|
-
since this is now handled by the <
|
|
19
|
+
since this is now handled by the <DocsLink href="/reference/typescript-api/auth/default-session-cache-strategy#defaultsessioncachestrategy">DefaultSessionCacheStrategy</DocsLink>.
|
|
24
20
|
|
|
25
21
|
:::
|
|
26
22
|
|
|
27
|
-
Prior to v3.1, the default was to use the <
|
|
23
|
+
Prior to v3.1, the default was to use the <DocsLink href="/reference/typescript-api/auth/in-memory-session-cache-strategy#inmemorysessioncachestrategy">InMemorySessionCacheStrategy</DocsLink>, which is fast but suitable for
|
|
28
24
|
single-instance deployments.
|
|
29
25
|
|
|
30
26
|
:::info
|
|
@@ -137,33 +133,29 @@ interface SessionCacheStrategy extends InjectableStrategy {
|
|
|
137
133
|
|
|
138
134
|
### set
|
|
139
135
|
|
|
140
|
-
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => void | Promise
|
|
136
|
+
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => void | Promise<void>`} />
|
|
141
137
|
|
|
142
138
|
Store the session in the cache. When caching a session, the data
|
|
143
139
|
should not be modified apart from performing any transforms needed to
|
|
144
140
|
get it into a state to be stored, e.g. JSON.stringify().
|
|
145
141
|
### get
|
|
146
142
|
|
|
147
|
-
<MemberInfo kind="method" type={`(sessionToken: string) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined | Promise
|
|
143
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined | Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined>`} />
|
|
148
144
|
|
|
149
145
|
Retrieve the session from the cache
|
|
150
146
|
### delete
|
|
151
147
|
|
|
152
|
-
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise
|
|
148
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise<void>`} />
|
|
153
149
|
|
|
154
150
|
Delete a session from the cache
|
|
155
151
|
### clear
|
|
156
152
|
|
|
157
|
-
<MemberInfo kind="method" type={`() => void | Promise
|
|
153
|
+
<MemberInfo kind="method" type={`() => void | Promise<void>`} />
|
|
158
154
|
|
|
159
155
|
Clear the entire cache
|
|
160
156
|
|
|
161
157
|
|
|
162
158
|
</div>
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
## CachedSessionUser
|
|
166
|
-
|
|
167
159
|
<GenerationInfo sourceFile="packages/core/src/config/session-cache/session-cache-strategy.ts" sourceLine="14" packageName="@vendure/core" />
|
|
168
160
|
|
|
169
161
|
A simplified representation of the User associated with the
|
|
@@ -203,10 +195,6 @@ type CachedSessionUser = {
|
|
|
203
195
|
|
|
204
196
|
|
|
205
197
|
</div>
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
## CachedSession
|
|
209
|
-
|
|
210
198
|
<GenerationInfo sourceFile="packages/core/src/config/session-cache/session-cache-strategy.ts" sourceLine="29" packageName="@vendure/core" />
|
|
211
199
|
|
|
212
200
|
A simplified representation of a Session which is easy to
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "SuperadminCredentials"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## SuperadminCredentials
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="851" packageName="@vendure/core" />
|
|
10
6
|
|
|
11
7
|
These credentials will be used to create the Superadmin user & administrator
|
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
title: "VerificationTokenStrategy"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## VerificationTokenStrategy
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/auth/verification-token-strategy.ts" sourceLine="18" packageName="@vendure/core" since="3.2.0" />
|
|
10
6
|
|
|
11
7
|
Defines a custom strategy for creating and validating verification tokens.
|
|
@@ -31,12 +27,12 @@ interface VerificationTokenStrategy extends InjectableStrategy {
|
|
|
31
27
|
|
|
32
28
|
### generateVerificationToken
|
|
33
29
|
|
|
34
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise
|
|
30
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<string> | string`} since="3.2.0" />
|
|
35
31
|
|
|
36
32
|
Generates a verification token.
|
|
37
33
|
### verifyVerificationToken
|
|
38
34
|
|
|
39
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<boolean> | boolean`} since="3.2.0" />
|
|
40
36
|
|
|
41
37
|
Checks the validity of a verification token.
|
|
42
38
|
|
|
@@ -2,13 +2,9 @@
|
|
|
2
2
|
title: "CacheConfig"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## CacheConfig
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/cache/cache.ts" sourceLine="14" packageName="@vendure/core" since="3.1.0" />
|
|
10
6
|
|
|
11
|
-
Configuration for a new <
|
|
7
|
+
Configuration for a new <DocsLink href="/reference/typescript-api/cache/#cache">Cache</DocsLink> instance.
|
|
12
8
|
|
|
13
9
|
```ts title="Signature"
|
|
14
10
|
interface CacheConfig {
|
|
@@ -21,7 +17,7 @@ interface CacheConfig {
|
|
|
21
17
|
|
|
22
18
|
### getKey
|
|
23
19
|
|
|
24
|
-
<MemberInfo kind="property" type={`(id: string | number)
|
|
20
|
+
<MemberInfo kind="property" type={`(id: string | number) => string`} />
|
|
25
21
|
|
|
26
22
|
A function which generates a cache key from the given id.
|
|
27
23
|
This key will be used to store the value in the cache.
|
|
@@ -2,15 +2,11 @@
|
|
|
2
2
|
title: "CacheService"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## CacheService
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/cache/cache.service.ts" sourceLine="21" packageName="@vendure/core" since="3.1.0" />
|
|
10
6
|
|
|
11
7
|
The CacheService is used to cache data in order to optimize performance.
|
|
12
8
|
|
|
13
|
-
Internally it makes use of the configured <
|
|
9
|
+
Internally it makes use of the configured <DocsLink href="/reference/typescript-api/cache/cache-strategy#cachestrategy">CacheStrategy</DocsLink> to persist
|
|
14
10
|
the cache into a key-value store.
|
|
15
11
|
|
|
16
12
|
```ts title="Signature"
|
|
@@ -41,19 +37,19 @@ class CacheService {
|
|
|
41
37
|
|
|
42
38
|
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/cache/cache-config#cacheconfig'>CacheConfig</a>) => <a href='/reference/typescript-api/cache/#cache'>Cache</a>`} />
|
|
43
39
|
|
|
44
|
-
Creates a new <
|
|
40
|
+
Creates a new <DocsLink href="/reference/typescript-api/cache/#cache">Cache</DocsLink> instance with the given configuration.
|
|
45
41
|
|
|
46
42
|
The `Cache` instance provides a convenience wrapper around the `CacheService`
|
|
47
43
|
methods.
|
|
48
44
|
### get
|
|
49
45
|
|
|
50
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
46
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`} />
|
|
51
47
|
|
|
52
48
|
Gets an item from the cache, or returns undefined if the key is not found, or the
|
|
53
49
|
item has expired.
|
|
54
50
|
### set
|
|
55
51
|
|
|
56
|
-
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise
|
|
52
|
+
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`} />
|
|
57
53
|
|
|
58
54
|
Sets a key-value pair in the cache. The value must be serializable, so cannot contain
|
|
59
55
|
things like functions, circular data structures, class instances etc.
|
|
@@ -62,12 +58,12 @@ Optionally a "time to live" (ttl) can be specified, which means that the key wil
|
|
|
62
58
|
be considered stale after that many milliseconds.
|
|
63
59
|
### delete
|
|
64
60
|
|
|
65
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
61
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<void>`} />
|
|
66
62
|
|
|
67
63
|
Deletes an item from the cache.
|
|
68
64
|
### invalidateTags
|
|
69
65
|
|
|
70
|
-
<MemberInfo kind="method" type={`(tags: string[]) => Promise
|
|
66
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
71
67
|
|
|
72
68
|
Deletes all items from the cache which contain at least one matching tag.
|
|
73
69
|
|
|
@@ -2,15 +2,11 @@
|
|
|
2
2
|
title: "CacheStrategy"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## CacheStrategy
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/config/system/cache-strategy.ts" sourceLine="53" packageName="@vendure/core" since="3.1.0" />
|
|
10
6
|
|
|
11
7
|
The CacheStrategy defines how the underlying shared cache mechanism is implemented.
|
|
12
8
|
|
|
13
|
-
It is used by the <
|
|
9
|
+
It is used by the <DocsLink href="/reference/typescript-api/cache/cache-service#cacheservice">CacheService</DocsLink> to take care of storage and retrieval of items
|
|
14
10
|
from the cache.
|
|
15
11
|
|
|
16
12
|
If you are using the `DefaultCachePlugin` or the `RedisCachePlugin`, you will not need to
|
|
@@ -40,13 +36,13 @@ interface CacheStrategy extends InjectableStrategy {
|
|
|
40
36
|
|
|
41
37
|
### get
|
|
42
38
|
|
|
43
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
39
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`} />
|
|
44
40
|
|
|
45
41
|
Gets an item from the cache, or returns undefined if the key is not found, or the
|
|
46
42
|
item has expired.
|
|
47
43
|
### set
|
|
48
44
|
|
|
49
|
-
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise
|
|
45
|
+
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`} />
|
|
50
46
|
|
|
51
47
|
Sets a key-value pair in the cache. The value must be serializable, so cannot contain
|
|
52
48
|
things like functions, circular data structures, class instances etc.
|
|
@@ -55,21 +51,17 @@ Optionally a "time to live" (ttl) can be specified, which means that the key wil
|
|
|
55
51
|
be considered stale after that many milliseconds.
|
|
56
52
|
### delete
|
|
57
53
|
|
|
58
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
54
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<void>`} />
|
|
59
55
|
|
|
60
56
|
Deletes an item from the cache.
|
|
61
57
|
### invalidateTags
|
|
62
58
|
|
|
63
|
-
<MemberInfo kind="method" type={`(tags: string[]) => Promise
|
|
59
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
64
60
|
|
|
65
61
|
Deletes all items from the cache which contain at least one matching tag.
|
|
66
62
|
|
|
67
63
|
|
|
68
64
|
</div>
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
## SetCacheKeyOptions
|
|
72
|
-
|
|
73
65
|
<GenerationInfo sourceFile="packages/core/src/config/system/cache-strategy.ts" sourceLine="13" packageName="@vendure/core" since="3.1.0" />
|
|
74
66
|
|
|
75
67
|
Options available when setting the value in the cache.
|
|
@@ -2,17 +2,13 @@
|
|
|
2
2
|
title: "DefaultCachePlugin"
|
|
3
3
|
generated: true
|
|
4
4
|
---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## DefaultCachePlugin
|
|
8
|
-
|
|
9
5
|
<GenerationInfo sourceFile="packages/core/src/plugin/default-cache-plugin/default-cache-plugin.ts" sourceLine="48" packageName="@vendure/core" since="3.1.0" />
|
|
10
6
|
|
|
11
|
-
This plugin provides a simple SQL-based cache strategy <
|
|
7
|
+
This plugin provides a simple SQL-based cache strategy <DocsLink href="/reference/typescript-api/cache/sql-cache-strategy#sqlcachestrategy">SqlCacheStrategy</DocsLink> which stores cached
|
|
12
8
|
items in the database.
|
|
13
9
|
|
|
14
10
|
It is suitable for production use (including multi-instance setups). For increased performance
|
|
15
|
-
you can also consider using the <
|
|
11
|
+
you can also consider using the <DocsLink href="/reference/typescript-api/cache/redis-cache-plugin#rediscacheplugin">RedisCachePlugin</DocsLink>.
|
|
16
12
|
|
|
17
13
|
```ts title="Signature"
|
|
18
14
|
class DefaultCachePlugin {
|
|
@@ -38,13 +34,9 @@ class DefaultCachePlugin {
|
|
|
38
34
|
|
|
39
35
|
|
|
40
36
|
</div>
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
## DefaultCachePluginInitOptions
|
|
44
|
-
|
|
45
37
|
<GenerationInfo sourceFile="packages/core/src/plugin/default-cache-plugin/default-cache-plugin.ts" sourceLine="18" packageName="@vendure/core" since="3.1.0" />
|
|
46
38
|
|
|
47
|
-
Configuration options for the <
|
|
39
|
+
Configuration options for the <DocsLink href="/reference/typescript-api/cache/default-cache-plugin#defaultcacheplugin">DefaultCachePlugin</DocsLink>.
|
|
48
40
|
|
|
49
41
|
```ts title="Signature"
|
|
50
42
|
interface DefaultCachePluginInitOptions {
|