@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114
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/dist/dates.generated.js +385 -385
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
- package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
- package/docs/reference/dashboard/page-layout/index.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +4 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/index.mdx +2 -2
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
- package/docs/reference/typescript-api/common/id.mdx +1 -1
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/middleware.mdx +1 -1
- package/docs/reference/typescript-api/common/permission.mdx +1 -1
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/entities/address.mdx +2 -2
- package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
- package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +3 -3
- package/docs/reference/typescript-api/entities/country.mdx +4 -4
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet.mdx +4 -4
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +9 -9
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/payment.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
- package/docs/reference/typescript-api/entities/product.mdx +3 -3
- package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
- package/docs/reference/typescript-api/entities/province.mdx +2 -2
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +4 -4
- package/docs/reference/typescript-api/entities/role.mdx +3 -3
- package/docs/reference/typescript-api/entities/seller.mdx +3 -3
- package/docs/reference/typescript-api/entities/session.mdx +3 -3
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
- package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
- package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
- package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
- package/docs/reference/typescript-api/entities/user.mdx +3 -3
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +2 -2
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
- package/docs/reference/typescript-api/events/event-types.mdx +109 -109
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
- package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
- package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
- package/docs/reference/typescript-api/logger/index.mdx +3 -3
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
- package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
- package/docs/reference/typescript-api/money/round-money.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
- package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
- package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
- package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context.mdx +5 -5
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
- package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
- package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
- package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
- package/docs/reference/typescript-api/services/history-service.mdx +1 -1
- package/docs/reference/typescript-api/services/order-service.mdx +24 -24
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
- package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/session-service.mdx +4 -4
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +8 -8
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
- package/package.json +1 -1
- package/src/dates.generated.ts +385 -385
|
@@ -21,7 +21,7 @@ Parameters
|
|
|
21
21
|
|
|
22
22
|
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-vendure-dashboard.ts" sourceLine="32" packageName="@vendure/dashboard" since="3.4.0" />
|
|
23
23
|
|
|
24
|
-
Options for the
|
|
24
|
+
Options for the [vendureDashboardPlugin](/reference/dashboard/vite-plugin/vendure-dashboard-plugin#venduredashboardplugin) Vite plugin.
|
|
25
25
|
|
|
26
26
|
```ts title="Signature"
|
|
27
27
|
type VitePluginVendureDashboardOptions = {
|
|
@@ -201,7 +201,7 @@ A function to determine the path to the compiled Vendure config file.
|
|
|
201
201
|
</div>
|
|
202
202
|
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-ui-config.ts" sourceLine="19" packageName="@vendure/dashboard" since="3.4.0" />
|
|
203
203
|
|
|
204
|
-
Options used by the
|
|
204
|
+
Options used by the [vendureDashboardPlugin](/reference/dashboard/vite-plugin/vendure-dashboard-plugin#venduredashboardplugin) to configure how the Dashboard
|
|
205
205
|
connects to the Vendure Admin API
|
|
206
206
|
|
|
207
207
|
```ts title="Signature"
|
|
@@ -260,7 +260,7 @@ setting of the server's `apiOptions.channelTokenKey` config option.
|
|
|
260
260
|
</div>
|
|
261
261
|
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-ui-config.ts" sourceLine="81" packageName="@vendure/dashboard" since="3.4.0" />
|
|
262
262
|
|
|
263
|
-
Options used by the
|
|
263
|
+
Options used by the [vendureDashboardPlugin](/reference/dashboard/vite-plugin/vendure-dashboard-plugin#venduredashboardplugin) to configure aspects of the
|
|
264
264
|
Dashboard UI behaviour.
|
|
265
265
|
|
|
266
266
|
```ts title="Signature"
|
|
@@ -304,7 +304,7 @@ An array of locales to be used on Admin UI.
|
|
|
304
304
|
</div>
|
|
305
305
|
<GenerationInfo sourceFile="packages/dashboard/vite/vite-plugin-ui-config.ts" sourceLine="124" packageName="@vendure/dashboard" since="3.4.0" />
|
|
306
306
|
|
|
307
|
-
Options used by the
|
|
307
|
+
Options used by the [vendureDashboardPlugin](/reference/dashboard/vite-plugin/vendure-dashboard-plugin#venduredashboardplugin) to configure aspects of the
|
|
308
308
|
Dashboard UI behaviour.
|
|
309
309
|
|
|
310
310
|
```ts title="Signature"
|
|
@@ -20,7 +20,7 @@ interface AssetNamingStrategy extends InjectableStrategy {
|
|
|
20
20
|
generatePreviewFileName(ctx: RequestContext, sourceFileName: string, conflictFileName?: string): string;
|
|
21
21
|
}
|
|
22
22
|
```
|
|
23
|
-
* Extends:
|
|
23
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -24,7 +24,7 @@ interface AssetPreviewStrategy extends InjectableStrategy {
|
|
|
24
24
|
generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer): Promise<Buffer>;
|
|
25
25
|
}
|
|
26
26
|
```
|
|
27
|
-
* Extends:
|
|
27
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
|
|
@@ -25,7 +25,7 @@ interface AssetStorageStrategy extends InjectableStrategy {
|
|
|
25
25
|
toAbsoluteUrl?(request: Request, identifier: string): string;
|
|
26
26
|
}
|
|
27
27
|
```
|
|
28
|
-
* Extends:
|
|
28
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
@@ -13,7 +13,7 @@ class DefaultAssetNamingStrategy implements AssetNamingStrategy {
|
|
|
13
13
|
generatePreviewFileName(ctx: RequestContext, sourceFileName: string, conflictFileName?: string) => string;
|
|
14
14
|
}
|
|
15
15
|
```
|
|
16
|
-
* Implements:
|
|
16
|
+
* Implements: [`AssetNamingStrategy`](/reference/typescript-api/assets/asset-naming-strategy#assetnamingstrategy)
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
@@ -77,7 +77,7 @@ If passed as a number should represent milliseconds and if passed as a string de
|
|
|
77
77
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy'>SessionCacheStrategy</a>`} default={`<a href='/reference/typescript-api/auth/default-session-cache-strategy#defaultsessioncachestrategy'>DefaultSessionCacheStrategy</a>`} />
|
|
78
78
|
|
|
79
79
|
This strategy defines how sessions will be cached. By default, since v3.1.0, sessions are cached using
|
|
80
|
-
the underlying cache strategy defined in the
|
|
80
|
+
the underlying cache strategy defined in the [SystemOptions](/reference/typescript-api/configuration/system-options#systemoptions)`.cacheStrategy`.
|
|
81
81
|
### sessionCacheTTL
|
|
82
82
|
|
|
83
83
|
<MemberInfo kind="property" type={`string | number`} default={`300`} />
|
|
@@ -130,13 +130,13 @@ GraphQL resolvers defined in plugins.
|
|
|
130
130
|
|
|
131
131
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/password-hashing-strategy#passwordhashingstrategy'>PasswordHashingStrategy</a>`} default={`<a href='/reference/typescript-api/auth/bcrypt-password-hashing-strategy#bcryptpasswordhashingstrategy'>BcryptPasswordHashingStrategy</a>`} since="1.3.0" />
|
|
132
132
|
|
|
133
|
-
Allows you to customize the way passwords are hashed when using the
|
|
133
|
+
Allows you to customize the way passwords are hashed when using the [NativeAuthenticationStrategy](/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy).
|
|
134
134
|
### passwordValidationStrategy
|
|
135
135
|
|
|
136
136
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/password-validation-strategy#passwordvalidationstrategy'>PasswordValidationStrategy</a>`} default={`<a href='/reference/typescript-api/auth/default-password-validation-strategy#defaultpasswordvalidationstrategy'>DefaultPasswordValidationStrategy</a>`} since="1.5.0" />
|
|
137
137
|
|
|
138
|
-
Allows you to set a custom policy for passwords when using the
|
|
139
|
-
By default, it uses the
|
|
138
|
+
Allows you to set a custom policy for passwords when using the [NativeAuthenticationStrategy](/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy).
|
|
139
|
+
By default, it uses the [DefaultPasswordValidationStrategy](/reference/typescript-api/auth/default-password-validation-strategy#defaultpasswordvalidationstrategy), which will impose a minimum length
|
|
140
140
|
of four characters. To improve security for production, you are encouraged to specify a more strict
|
|
141
141
|
policy, which you can do like this:
|
|
142
142
|
|
|
@@ -24,7 +24,7 @@ interface AuthenticationStrategy<Data = unknown> extends InjectableStrategy {
|
|
|
24
24
|
onLogOut?(ctx: RequestContext, user: User): Promise<void>;
|
|
25
25
|
}
|
|
26
26
|
```
|
|
27
|
-
* Extends:
|
|
27
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
|
|
@@ -79,7 +79,7 @@ the _first_ input will be assumed to be the top-level input.
|
|
|
79
79
|
|
|
80
80
|
Used to authenticate a user with the authentication provider. This method
|
|
81
81
|
will implement the provider-specific authentication logic, and should resolve to either a
|
|
82
|
-
|
|
82
|
+
[User](/reference/typescript-api/entities/user#user) object on success, or `false | string` on failure.
|
|
83
83
|
A `string` return could be used to describe what error happened, otherwise `false` to an unknown error.
|
|
84
84
|
### onLogOut
|
|
85
85
|
|
|
@@ -12,7 +12,7 @@ class BcryptPasswordHashingStrategy implements PasswordHashingStrategy {
|
|
|
12
12
|
check(plaintext: string, hash: string) => Promise<boolean>;
|
|
13
13
|
}
|
|
14
14
|
```
|
|
15
|
-
* Implements:
|
|
15
|
+
* Implements: [`PasswordHashingStrategy`](/reference/typescript-api/auth/password-hashing-strategy#passwordhashingstrategy)
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
|
|
@@ -18,7 +18,7 @@ class DefaultPasswordValidationStrategy implements PasswordValidationStrategy {
|
|
|
18
18
|
validate(ctx: RequestContext, password: string) => boolean | string;
|
|
19
19
|
}
|
|
20
20
|
```
|
|
21
|
-
* Implements:
|
|
21
|
+
* Implements: [`PasswordValidationStrategy`](/reference/typescript-api/auth/password-validation-strategy#passwordvalidationstrategy)
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
@@ -4,9 +4,9 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/session-cache/default-session-cache-strategy.ts" sourceLine="17" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
The default
|
|
8
|
-
|
|
9
|
-
for most use-cases, assuming you select a suitable
|
|
7
|
+
The default [SessionCacheStrategy](/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy) delegates to the configured
|
|
8
|
+
[CacheStrategy](/reference/typescript-api/cache/cache-strategy#cachestrategy) to store the session data. This should be suitable
|
|
9
|
+
for most use-cases, assuming you select a suitable [CacheStrategy](/reference/typescript-api/cache/cache-strategy#cachestrategy)
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
class DefaultSessionCacheStrategy implements SessionCacheStrategy {
|
|
@@ -22,7 +22,7 @@ class DefaultSessionCacheStrategy implements SessionCacheStrategy {
|
|
|
22
22
|
clear() => Promise<void>;
|
|
23
23
|
}
|
|
24
24
|
```
|
|
25
|
-
* Implements:
|
|
25
|
+
* Implements: [`SessionCacheStrategy`](/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy)
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
@@ -16,7 +16,7 @@ class DefaultVerificationTokenStrategy implements VerificationTokenStrategy {
|
|
|
16
16
|
verifyVerificationToken(_ctx: RequestContext, token: string) => boolean;
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Implements:
|
|
19
|
+
* Implements: [`VerificationTokenStrategy`](/reference/typescript-api/auth/verification-token-strategy#verificationtokenstrategy)
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/external-authentication/external-authentication.service.ts" sourceLine="24" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
This is a helper service which exposes methods related to looking up and creating Users based on an
|
|
8
|
-
external
|
|
8
|
+
external [AuthenticationStrategy](/reference/typescript-api/auth/authentication-strategy#authenticationstrategy).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class ExternalAuthenticationService {
|
|
@@ -22,7 +22,7 @@ class InMemorySessionCacheStrategy implements SessionCacheStrategy {
|
|
|
22
22
|
clear() => ;
|
|
23
23
|
}
|
|
24
24
|
```
|
|
25
|
-
* Implements:
|
|
25
|
+
* Implements: [`SessionCacheStrategy`](/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy)
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
@@ -17,7 +17,7 @@ class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthe
|
|
|
17
17
|
verifyUserPassword(ctx: RequestContext, userId: ID, password: string) => Promise<boolean>;
|
|
18
18
|
}
|
|
19
19
|
```
|
|
20
|
-
* Implements:
|
|
20
|
+
* Implements: [`AuthenticationStrategy`](/reference/typescript-api/auth/authentication-strategy#authenticationstrategy)`<NativeAuthenticationData>`
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
|
|
@@ -15,7 +15,7 @@ class NoopSessionCacheStrategy implements SessionCacheStrategy {
|
|
|
15
15
|
set(session: CachedSession) => ;
|
|
16
16
|
}
|
|
17
17
|
```
|
|
18
|
-
* Implements:
|
|
18
|
+
* Implements: [`SessionCacheStrategy`](/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy)
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/auth/password-hashing-strategy.ts" sourceLine="17" packageName="@vendure/core" since="1.3.0" />
|
|
6
6
|
|
|
7
|
-
Defines how user passwords get hashed when using the
|
|
7
|
+
Defines how user passwords get hashed when using the [NativeAuthenticationStrategy](/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy).
|
|
8
8
|
|
|
9
9
|
:::info
|
|
10
10
|
|
|
@@ -19,7 +19,7 @@ interface PasswordHashingStrategy extends InjectableStrategy {
|
|
|
19
19
|
check(plaintext: string, hash: string): Promise<boolean>;
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
|
-
* Extends:
|
|
22
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/auth/password-validation-strategy.ts" sourceLine="19" packageName="@vendure/core" since="1.5.0" />
|
|
6
6
|
|
|
7
7
|
Defines validation to apply to new password (when creating an account or updating an existing account's
|
|
8
|
-
password when using the
|
|
8
|
+
password when using the [NativeAuthenticationStrategy](/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy).
|
|
9
9
|
|
|
10
10
|
:::info
|
|
11
11
|
|
|
@@ -19,7 +19,7 @@ interface PasswordValidationStrategy extends InjectableStrategy {
|
|
|
19
19
|
validate(ctx: RequestContext, password: string): Promise<boolean | string> | boolean | string;
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
|
-
* Extends:
|
|
22
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -5,9 +5,9 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="86" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
Defines a new Permission with which to control access to GraphQL resolvers & REST controllers.
|
|
8
|
-
Used in conjunction with the
|
|
8
|
+
Used in conjunction with the [Allow](/reference/typescript-api/request/allow-decorator#allow) decorator (see example below).
|
|
9
9
|
|
|
10
|
-
**Note:** To define CRUD permissions, use the
|
|
10
|
+
**Note:** To define CRUD permissions, use the [CrudPermissionDefinition](/reference/typescript-api/auth/permission-definition#crudpermissiondefinition).
|
|
11
11
|
|
|
12
12
|
*Example*
|
|
13
13
|
|
|
@@ -57,7 +57,7 @@ class PermissionDefinition {
|
|
|
57
57
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
58
58
|
|
|
59
59
|
Returns the permission defined by this definition, for use in the
|
|
60
|
-
|
|
60
|
+
[Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
</div>
|
|
@@ -101,7 +101,7 @@ class CrudPermissionDefinition extends PermissionDefinition {
|
|
|
101
101
|
Delete: Permission
|
|
102
102
|
}
|
|
103
103
|
```
|
|
104
|
-
* Extends:
|
|
104
|
+
* Extends: [`PermissionDefinition`](/reference/typescript-api/auth/permission-definition#permissiondefinition)
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
|
|
@@ -117,25 +117,25 @@ class CrudPermissionDefinition extends PermissionDefinition {
|
|
|
117
117
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
118
118
|
|
|
119
119
|
Returns the 'Create' CRUD permission defined by this definition, for use in the
|
|
120
|
-
|
|
120
|
+
[Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.
|
|
121
121
|
### Read
|
|
122
122
|
|
|
123
123
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
124
124
|
|
|
125
125
|
Returns the 'Read' CRUD permission defined by this definition, for use in the
|
|
126
|
-
|
|
126
|
+
[Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.
|
|
127
127
|
### Update
|
|
128
128
|
|
|
129
129
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
130
130
|
|
|
131
131
|
Returns the 'Update' CRUD permission defined by this definition, for use in the
|
|
132
|
-
|
|
132
|
+
[Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.
|
|
133
133
|
### Delete
|
|
134
134
|
|
|
135
135
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
136
136
|
|
|
137
137
|
Returns the 'Delete' CRUD permission defined by this definition, for use in the
|
|
138
|
-
|
|
138
|
+
[Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.
|
|
139
139
|
|
|
140
140
|
|
|
141
141
|
</div>
|
|
@@ -183,7 +183,7 @@ class RwPermissionDefinition extends PermissionDefinition {
|
|
|
183
183
|
Write: Permission
|
|
184
184
|
}
|
|
185
185
|
```
|
|
186
|
-
* Extends:
|
|
186
|
+
* Extends: [`PermissionDefinition`](/reference/typescript-api/auth/permission-definition#permissiondefinition)
|
|
187
187
|
|
|
188
188
|
|
|
189
189
|
|
|
@@ -199,19 +199,19 @@ class RwPermissionDefinition extends PermissionDefinition {
|
|
|
199
199
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
200
200
|
|
|
201
201
|
Returns the 'Read' permission defined by this definition, for use in the
|
|
202
|
-
|
|
202
|
+
[Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.
|
|
203
203
|
### Write
|
|
204
204
|
|
|
205
205
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
|
|
206
206
|
|
|
207
207
|
Returns the 'Write' permission defined by this definition, for use in the
|
|
208
|
-
|
|
208
|
+
[Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.
|
|
209
209
|
|
|
210
210
|
|
|
211
211
|
</div>
|
|
212
212
|
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="10" packageName="@vendure/core" />
|
|
213
213
|
|
|
214
|
-
Configures a
|
|
214
|
+
Configures a [PermissionDefinition](/reference/typescript-api/auth/permission-definition#permissiondefinition)
|
|
215
215
|
|
|
216
216
|
```ts title="Signature"
|
|
217
217
|
interface PermissionDefinitionConfig {
|
|
@@ -9,18 +9,18 @@ object for permissions data, it can become a bottleneck to go to the database an
|
|
|
9
9
|
SQL query each time. Therefore, we cache the session data only perform the SQL query once and upon
|
|
10
10
|
invalidation of the cache.
|
|
11
11
|
|
|
12
|
-
The Vendure default from v3.1+ is to use a the
|
|
13
|
-
to the configured
|
|
12
|
+
The Vendure default from v3.1+ is to use a the [DefaultSessionCacheStrategy](/reference/typescript-api/auth/default-session-cache-strategy#defaultsessioncachestrategy), which delegates
|
|
13
|
+
to the configured [CacheStrategy](/reference/typescript-api/cache/cache-strategy#cachestrategy) to store the session data. This should be suitable
|
|
14
14
|
for most use-cases.
|
|
15
15
|
|
|
16
16
|
:::note
|
|
17
17
|
|
|
18
18
|
If you are using v3.1 or later, you should not normally need to implement a custom `SessionCacheStrategy`,
|
|
19
|
-
since this is now handled by the
|
|
19
|
+
since this is now handled by the [DefaultSessionCacheStrategy](/reference/typescript-api/auth/default-session-cache-strategy#defaultsessioncachestrategy).
|
|
20
20
|
|
|
21
21
|
:::
|
|
22
22
|
|
|
23
|
-
Prior to v3.1, the default was to use the
|
|
23
|
+
Prior to v3.1, the default was to use the [InMemorySessionCacheStrategy](/reference/typescript-api/auth/in-memory-session-cache-strategy#inmemorysessioncachestrategy), which is fast but suitable for
|
|
24
24
|
single-instance deployments.
|
|
25
25
|
|
|
26
26
|
:::info
|
|
@@ -125,7 +125,7 @@ interface SessionCacheStrategy extends InjectableStrategy {
|
|
|
125
125
|
clear(): void | Promise<void>;
|
|
126
126
|
}
|
|
127
127
|
```
|
|
128
|
-
* Extends:
|
|
128
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
|
|
@@ -19,7 +19,7 @@ interface VerificationTokenStrategy extends InjectableStrategy {
|
|
|
19
19
|
verifyVerificationToken(ctx: RequestContext, token: string): Promise<boolean> | boolean;
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
|
-
* Extends:
|
|
22
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/cache/cache.ts" sourceLine="14" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
Configuration for a new
|
|
7
|
+
Configuration for a new [Cache](/reference/typescript-api/cache/#cache) instance.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface CacheConfig {
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
The CacheService is used to cache data in order to optimize performance.
|
|
8
8
|
|
|
9
|
-
Internally it makes use of the configured
|
|
9
|
+
Internally it makes use of the configured [CacheStrategy](/reference/typescript-api/cache/cache-strategy#cachestrategy) to persist
|
|
10
10
|
the cache into a key-value store.
|
|
11
11
|
|
|
12
12
|
```ts title="Signature"
|
|
@@ -37,7 +37,7 @@ class CacheService {
|
|
|
37
37
|
|
|
38
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>`} />
|
|
39
39
|
|
|
40
|
-
Creates a new
|
|
40
|
+
Creates a new [Cache](/reference/typescript-api/cache/#cache) instance with the given configuration.
|
|
41
41
|
|
|
42
42
|
The `Cache` instance provides a convenience wrapper around the `CacheService`
|
|
43
43
|
methods.
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
The CacheStrategy defines how the underlying shared cache mechanism is implemented.
|
|
8
8
|
|
|
9
|
-
It is used by the
|
|
9
|
+
It is used by the [CacheService](/reference/typescript-api/cache/cache-service#cacheservice) to take care of storage and retrieval of items
|
|
10
10
|
from the cache.
|
|
11
11
|
|
|
12
12
|
If you are using the `DefaultCachePlugin` or the `RedisCachePlugin`, you will not need to
|
|
@@ -28,7 +28,7 @@ interface CacheStrategy extends InjectableStrategy {
|
|
|
28
28
|
invalidateTags(tags: string[]): Promise<void>;
|
|
29
29
|
}
|
|
30
30
|
```
|
|
31
|
-
* Extends:
|
|
31
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -4,11 +4,11 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/plugin/default-cache-plugin/default-cache-plugin.ts" sourceLine="48" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
This plugin provides a simple SQL-based cache strategy
|
|
7
|
+
This plugin provides a simple SQL-based cache strategy [SqlCacheStrategy](/reference/typescript-api/cache/sql-cache-strategy#sqlcachestrategy) which stores cached
|
|
8
8
|
items in the database.
|
|
9
9
|
|
|
10
10
|
It is suitable for production use (including multi-instance setups). For increased performance
|
|
11
|
-
you can also consider using the
|
|
11
|
+
you can also consider using the [RedisCachePlugin](/reference/typescript-api/cache/redis-cache-plugin#rediscacheplugin).
|
|
12
12
|
|
|
13
13
|
```ts title="Signature"
|
|
14
14
|
class DefaultCachePlugin {
|
|
@@ -36,7 +36,7 @@ class DefaultCachePlugin {
|
|
|
36
36
|
</div>
|
|
37
37
|
<GenerationInfo sourceFile="packages/core/src/plugin/default-cache-plugin/default-cache-plugin.ts" sourceLine="18" packageName="@vendure/core" since="3.1.0" />
|
|
38
38
|
|
|
39
|
-
Configuration options for the
|
|
39
|
+
Configuration options for the [DefaultCachePlugin](/reference/typescript-api/cache/default-cache-plugin#defaultcacheplugin).
|
|
40
40
|
|
|
41
41
|
```ts title="Signature"
|
|
42
42
|
interface DefaultCachePluginInitOptions {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/cache/cache.ts" sourceLine="72" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
A convenience wrapper around the
|
|
7
|
+
A convenience wrapper around the [CacheService](/reference/typescript-api/cache/cache-service#cacheservice) methods which provides a simple
|
|
8
8
|
API for caching and retrieving data.
|
|
9
9
|
|
|
10
10
|
The advantage of using the `Cache` class rather than directly calling the `CacheService`
|
|
@@ -14,7 +14,7 @@ already exist.
|
|
|
14
14
|
|
|
15
15
|
In most cases, using the `Cache` class will result in simpler and more readable code.
|
|
16
16
|
|
|
17
|
-
This class is normally created via the
|
|
17
|
+
This class is normally created via the [CacheService](/reference/typescript-api/cache/cache-service#cacheservice).`createCache()` method.
|
|
18
18
|
|
|
19
19
|
*Example*
|
|
20
20
|
|
|
@@ -4,9 +4,9 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/plugin/redis-cache-plugin/redis-cache-plugin.ts" sourceLine="25" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
This plugin provides a Redis-based
|
|
7
|
+
This plugin provides a Redis-based [RedisCacheStrategy](/reference/typescript-api/cache/redis-cache-strategy#rediscachestrategy) which stores cached items in a Redis instance.
|
|
8
8
|
This is a high-performance cache strategy which is suitable for production use, and is a drop-in
|
|
9
|
-
replacement for the
|
|
9
|
+
replacement for the [DefaultCachePlugin](/reference/typescript-api/cache/default-cache-plugin#defaultcacheplugin).
|
|
10
10
|
|
|
11
11
|
Note: To use this plugin, you need to manually install the `ioredis` package:
|
|
12
12
|
|
|
@@ -42,7 +42,7 @@ class RedisCachePlugin {
|
|
|
42
42
|
</div>
|
|
43
43
|
<GenerationInfo sourceFile="packages/core/src/plugin/redis-cache-plugin/types.ts" sourceLine="9" packageName="@vendure/core" since="3.1.0" />
|
|
44
44
|
|
|
45
|
-
Configuration options for the
|
|
45
|
+
Configuration options for the [RedisCachePlugin](/reference/typescript-api/cache/redis-cache-plugin#rediscacheplugin).
|
|
46
46
|
|
|
47
47
|
```ts title="Signature"
|
|
48
48
|
interface RedisCachePluginInitOptions {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/plugin/redis-cache-plugin/redis-cache-strategy.ts" sourceLine="23" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
A
|
|
7
|
+
A [CacheStrategy](/reference/typescript-api/cache/cache-strategy#cachestrategy) which stores cached items in a Redis instance.
|
|
8
8
|
This is a high-performance cache strategy which is suitable for production use.
|
|
9
9
|
|
|
10
10
|
Note: To use this strategy, you need to manually install the `ioredis` package:
|
|
@@ -24,7 +24,7 @@ class RedisCacheStrategy implements CacheStrategy {
|
|
|
24
24
|
invalidateTags(tags: string[]) => Promise<void>;
|
|
25
25
|
}
|
|
26
26
|
```
|
|
27
|
-
* Implements:
|
|
27
|
+
* Implements: [`CacheStrategy`](/reference/typescript-api/cache/cache-strategy#cachestrategy)
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
|
|
@@ -45,7 +45,7 @@ an update operation to the source data in the database.
|
|
|
45
45
|
</div>
|
|
46
46
|
<GenerationInfo sourceFile="packages/core/src/common/self-refreshing-cache.ts" sourceLine="46" packageName="@vendure/core" />
|
|
47
47
|
|
|
48
|
-
Configuration options for creating a
|
|
48
|
+
Configuration options for creating a [SelfRefreshingCache](/reference/typescript-api/cache/self-refreshing-cache#selfrefreshingcache).
|
|
49
49
|
|
|
50
50
|
```ts title="Signature"
|
|
51
51
|
interface SelfRefreshingCacheConfig<V, RefreshArgs extends any[]> {
|
|
@@ -93,7 +93,7 @@ By default uses `() => new Date().getTime()`
|
|
|
93
93
|
</div>
|
|
94
94
|
<GenerationInfo sourceFile="packages/core/src/common/self-refreshing-cache.ts" sourceLine="114" packageName="@vendure/core" />
|
|
95
95
|
|
|
96
|
-
Creates a
|
|
96
|
+
Creates a [SelfRefreshingCache](/reference/typescript-api/cache/self-refreshing-cache#selfrefreshingcache) object, which is used to cache a single frequently-accessed value. In this type
|
|
97
97
|
of cache, the function used to populate the value (`refreshFn`) is defined during the creation of the cache, and
|
|
98
98
|
it is immediately used to populate the initial value.
|
|
99
99
|
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/plugin/default-cache-plugin/sql-cache-strategy.ts" sourceLine="21" packageName="@vendure/core" since="3.1.0" />
|
|
6
6
|
|
|
7
|
-
A
|
|
8
|
-
is the strategy used by the
|
|
7
|
+
A [CacheStrategy](/reference/typescript-api/cache/cache-strategy#cachestrategy) that stores cached items in the database. This
|
|
8
|
+
is the strategy used by the [DefaultCachePlugin](/reference/typescript-api/cache/default-cache-plugin#defaultcacheplugin).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class SqlCacheStrategy implements CacheStrategy {
|
|
@@ -21,7 +21,7 @@ class SqlCacheStrategy implements CacheStrategy {
|
|
|
21
21
|
invalidateTags(tags: string[]) => ;
|
|
22
22
|
}
|
|
23
23
|
```
|
|
24
|
-
* Implements:
|
|
24
|
+
* Implements: [`CacheStrategy`](/reference/typescript-api/cache/cache-strategy#cachestrategy)
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -98,7 +98,7 @@ An array of locales to be used on Admin UI.
|
|
|
98
98
|
|
|
99
99
|
<MemberInfo kind="property" type={`string`} />
|
|
100
100
|
|
|
101
|
-
If you are using an external
|
|
101
|
+
If you are using an external [AuthenticationStrategy](/reference/typescript-api/auth/authentication-strategy#authenticationstrategy) for the Admin API, you can configure
|
|
102
102
|
a custom URL for the login page with this option. On logging out or redirecting an unauthenticated
|
|
103
103
|
user, the Admin UI app will redirect the user to this URL rather than the default username/password
|
|
104
104
|
screen.
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/common/src/shared-types.ts" sourceLine="79" packageName="@vendure/common" />
|
|
6
6
|
|
|
7
|
-
An entity ID. Depending on the configured
|
|
7
|
+
An entity ID. Depending on the configured [EntityIdStrategy](/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy), it will be either
|
|
8
8
|
a `string` or a `number`;
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -21,7 +21,7 @@ interface InjectableStrategy {
|
|
|
21
21
|
<MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => void | Promise<void>`} />
|
|
22
22
|
|
|
23
23
|
Defines setup logic to be run during application bootstrap. Receives
|
|
24
|
-
the
|
|
24
|
+
the [Injector](/reference/typescript-api/common/injector#injector) as an argument, which allows application providers
|
|
25
25
|
to be used as part of the setup. This hook will be called on both the
|
|
26
26
|
main server and the worker processes.
|
|
27
27
|
|