@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
- package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
- package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
- package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
- package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
- package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
- package/docs/reference/dashboard/page-layout/index.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +3 -3
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
- package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/index.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
- package/docs/reference/typescript-api/common/injector.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -1
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +1 -1
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +1 -1
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +1 -1
- package/docs/reference/typescript-api/entities/role.mdx +1 -1
- package/docs/reference/typescript-api/entities/seller.mdx +1 -1
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
- package/docs/reference/typescript-api/entities/user.mdx +1 -1
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
- package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
- package/docs/reference/typescript-api/events/event-types.mdx +30 -30
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
- package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
- package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
- package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
- package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
- package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
- package/docs/reference/typescript-api/services/country-service.mdx +7 -7
- package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
- package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
- package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
- package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +8 -8
- package/docs/reference/typescript-api/services/order-service.mdx +52 -52
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
- package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
- package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-service.mdx +13 -13
- package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
- package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
- package/docs/reference/typescript-api/services/province-service.mdx +5 -5
- package/docs/reference/typescript-api/services/role-service.mdx +11 -11
- package/docs/reference/typescript-api/services/search-service.mdx +2 -2
- package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
- package/docs/reference/typescript-api/services/session-service.mdx +8 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
- package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
- package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
- package/docs/reference/typescript-api/services/user-service.mdx +12 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
- package/package.json +1 -1
- package/docs/reference/admin-ui-api/index.mdx +0 -4
- package/docs/reference/dashboard/index.mdx +0 -4
- package/docs/reference/graphql-api/admin/_index.mdx +0 -4
- package/docs/reference/graphql-api/shop/_index.mdx +0 -4
- package/docs/reference/typescript-api/_index.mdx +0 -4
|
@@ -119,7 +119,7 @@ Parameters
|
|
|
119
119
|
|
|
120
120
|
### props
|
|
121
121
|
|
|
122
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
122
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/paginated-list-data-table#paginatedlistdatatableprops'>PaginatedListDataTableProps</a><T, U, V, AC>>`} />
|
|
123
123
|
|
|
124
124
|
|
|
125
125
|
|
|
@@ -173,22 +173,22 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
173
173
|
|
|
174
174
|
### deleteMutation
|
|
175
175
|
|
|
176
|
-
<MemberInfo kind="property" type={`TypedDocumentNode
|
|
176
|
+
<MemberInfo kind="property" type={`TypedDocumentNode<any, any>`} />
|
|
177
177
|
|
|
178
178
|
|
|
179
179
|
### transformQueryKey
|
|
180
180
|
|
|
181
|
-
<MemberInfo kind="property" type={`(queryKey: any[])
|
|
181
|
+
<MemberInfo kind="property" type={`(queryKey: any[]) => any[]`} />
|
|
182
182
|
|
|
183
183
|
|
|
184
184
|
### transformVariables
|
|
185
185
|
|
|
186
|
-
<MemberInfo kind="property" type={`(variables: V)
|
|
186
|
+
<MemberInfo kind="property" type={`(variables: V) => V`} />
|
|
187
187
|
|
|
188
188
|
|
|
189
189
|
### customizeColumns
|
|
190
190
|
|
|
191
|
-
<MemberInfo kind="property" type={`CustomizeColumnConfig
|
|
191
|
+
<MemberInfo kind="property" type={`CustomizeColumnConfig<T>`} />
|
|
192
192
|
|
|
193
193
|
|
|
194
194
|
### additionalColumns
|
|
@@ -198,17 +198,17 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
198
198
|
|
|
199
199
|
### defaultColumnOrder
|
|
200
200
|
|
|
201
|
-
<MemberInfo kind="property" type={`(keyof ListQueryFields
|
|
201
|
+
<MemberInfo kind="property" type={`(keyof ListQueryFields<T> | keyof AC | CustomFieldKeysOfItem<ListQueryFields<T>>)[]`} />
|
|
202
202
|
|
|
203
203
|
|
|
204
204
|
### defaultVisibility
|
|
205
205
|
|
|
206
|
-
<MemberInfo kind="property" type={`Partial
|
|
206
|
+
<MemberInfo kind="property" type={`Partial<Record<AllItemFieldKeys<T>, boolean>>`} />
|
|
207
207
|
|
|
208
208
|
|
|
209
209
|
### onSearchTermChange
|
|
210
210
|
|
|
211
|
-
<MemberInfo kind="property" type={`(searchTerm: string)
|
|
211
|
+
<MemberInfo kind="property" type={`(searchTerm: string) => NonNullable<V['options']>['filter']`} />
|
|
212
212
|
|
|
213
213
|
|
|
214
214
|
### page
|
|
@@ -233,32 +233,32 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
233
233
|
|
|
234
234
|
### onPageChange
|
|
235
235
|
|
|
236
|
-
<MemberInfo kind="property" type={`(table: Table
|
|
236
|
+
<MemberInfo kind="property" type={`(table: Table<any>, page: number, perPage: number) => void`} />
|
|
237
237
|
|
|
238
238
|
|
|
239
239
|
### onSortChange
|
|
240
240
|
|
|
241
|
-
<MemberInfo kind="property" type={`(table: Table
|
|
241
|
+
<MemberInfo kind="property" type={`(table: Table<any>, sorting: SortingState) => void`} />
|
|
242
242
|
|
|
243
243
|
|
|
244
244
|
### onFilterChange
|
|
245
245
|
|
|
246
|
-
<MemberInfo kind="property" type={`(table: Table
|
|
246
|
+
<MemberInfo kind="property" type={`(table: Table<any>, filters: ColumnFiltersState) => void`} />
|
|
247
247
|
|
|
248
248
|
|
|
249
249
|
### onColumnVisibilityChange
|
|
250
250
|
|
|
251
|
-
<MemberInfo kind="property" type={`(table: Table
|
|
251
|
+
<MemberInfo kind="property" type={`(table: Table<any>, columnVisibility: VisibilityState) => void`} />
|
|
252
252
|
|
|
253
253
|
|
|
254
254
|
### facetedFilters
|
|
255
255
|
|
|
256
|
-
<MemberInfo kind="property" type={`FacetedFilterConfig
|
|
256
|
+
<MemberInfo kind="property" type={`FacetedFilterConfig<T>`} />
|
|
257
257
|
|
|
258
258
|
|
|
259
259
|
### rowActions
|
|
260
260
|
|
|
261
|
-
<MemberInfo kind="property" type={`RowAction
|
|
261
|
+
<MemberInfo kind="property" type={`RowAction<PaginatedListItemFields<T>>[]`} />
|
|
262
262
|
|
|
263
263
|
|
|
264
264
|
### bulkActions
|
|
@@ -273,12 +273,12 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
273
273
|
|
|
274
274
|
### transformData
|
|
275
275
|
|
|
276
|
-
<MemberInfo kind="property" type={`(data: PaginatedListItemFields
|
|
276
|
+
<MemberInfo kind="property" type={`(data: PaginatedListItemFields<T>[]) => PaginatedListItemFields<T>[]`} />
|
|
277
277
|
|
|
278
278
|
|
|
279
279
|
### setTableOptions
|
|
280
280
|
|
|
281
|
-
<MemberInfo kind="property" type={`(table: TableOptions
|
|
281
|
+
<MemberInfo kind="property" type={`(table: TableOptions<any>) => TableOptions<any>`} />
|
|
282
282
|
|
|
283
283
|
|
|
284
284
|
### registerRefresher
|
|
@@ -288,7 +288,7 @@ interface PaginatedListDataTableProps<T extends TypedDocumentNode<U, V>, U exten
|
|
|
288
288
|
|
|
289
289
|
### onReorder
|
|
290
290
|
|
|
291
|
-
<MemberInfo kind="property" type={`( oldIndex: number, newIndex: number, item: PaginatedListItemFields
|
|
291
|
+
<MemberInfo kind="property" type={`( oldIndex: number, newIndex: number, item: PaginatedListItemFields<T>, ) => void | Promise<void>`} />
|
|
292
292
|
|
|
293
293
|
Callback when items are reordered via drag and drop.
|
|
294
294
|
When provided, enables drag-and-drop functionality.
|
|
@@ -19,7 +19,7 @@ Parameters
|
|
|
19
19
|
|
|
20
20
|
### props
|
|
21
21
|
|
|
22
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
22
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/page-layout/#pagelayoutprops'>PageLayoutProps</a>>`} />
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -20,7 +20,7 @@ Parameters
|
|
|
20
20
|
|
|
21
21
|
### props
|
|
22
22
|
|
|
23
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
23
|
+
<MemberInfo kind="parameter" type={`Readonly<{ children: React.ReactNode }>`} />
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
|
|
@@ -37,7 +37,7 @@ Parameters
|
|
|
37
37
|
|
|
38
38
|
### props
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
40
|
+
<MemberInfo kind="parameter" type={`Readonly<{ children: React.ReactNode }>`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
|
|
@@ -57,5 +57,5 @@ Parameters
|
|
|
57
57
|
|
|
58
58
|
### props
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
60
|
+
<MemberInfo kind="parameter" type={`Readonly<{ children: React.ReactNode; dropdownMenuItems?: InlineDropdownItem[]; }>`} />
|
|
61
61
|
|
|
@@ -28,7 +28,7 @@ Parameters
|
|
|
28
28
|
|
|
29
29
|
### props
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
31
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/page-layout/page-block#pageblockprops'>PageBlockProps</a>>`} />
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
@@ -102,7 +102,7 @@ Parameters
|
|
|
102
102
|
|
|
103
103
|
### props
|
|
104
104
|
|
|
105
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
105
|
+
<MemberInfo kind="parameter" type={`Readonly<Pick<<a href='/reference/dashboard/page-layout/page-block#pageblockprops'>PageBlockProps</a>, 'children' | 'className' | 'blockId'>>`} />
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
|
|
@@ -132,5 +132,5 @@ Parameters
|
|
|
132
132
|
|
|
133
133
|
### props
|
|
134
134
|
|
|
135
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
135
|
+
<MemberInfo kind="parameter" type={`Readonly<{ column: 'main' | 'side'; entityType: string; control: Control<any, any>; }>`} />
|
|
136
136
|
|
|
@@ -50,7 +50,7 @@ Parameters
|
|
|
50
50
|
|
|
51
51
|
### props
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="parameter" type={`Readonly
|
|
53
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/page-layout/page#pageprops'>PageProps</a>>`} />
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
|
|
@@ -68,7 +68,7 @@ interface PageProps extends ComponentProps<'div'> {
|
|
|
68
68
|
submitHandler?: any;
|
|
69
69
|
}
|
|
70
70
|
```
|
|
71
|
-
* Extends: <code>ComponentProps
|
|
71
|
+
* Extends: <code>ComponentProps<'div'></code>
|
|
72
72
|
|
|
73
73
|
|
|
74
74
|
|
|
@@ -86,7 +86,7 @@ A string identifier for the page, e.g. "product-list", "review-detail", etc.
|
|
|
86
86
|
|
|
87
87
|
### form
|
|
88
88
|
|
|
89
|
-
<MemberInfo kind="property" type={`UseFormReturn
|
|
89
|
+
<MemberInfo kind="property" type={`UseFormReturn<any>`} />
|
|
90
90
|
|
|
91
91
|
|
|
92
92
|
### submitHandler
|
|
@@ -36,7 +36,7 @@ interface AssetPreviewStrategy extends InjectableStrategy {
|
|
|
36
36
|
|
|
37
37
|
### generatePreviewImage
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise
|
|
39
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
|
|
@@ -37,36 +37,36 @@ interface AssetStorageStrategy extends InjectableStrategy {
|
|
|
37
37
|
|
|
38
38
|
### writeFileFromBuffer
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise
|
|
40
|
+
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`} />
|
|
41
41
|
|
|
42
42
|
Writes a buffer to the store and returns a unique identifier for that
|
|
43
43
|
file such as a file path or a URL.
|
|
44
44
|
### writeFileFromStream
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="method" type={`(fileName: string, data: Stream) => Promise
|
|
46
|
+
<MemberInfo kind="method" type={`(fileName: string, data: Stream) => Promise<string>`} />
|
|
47
47
|
|
|
48
48
|
Writes a readable stream to the store and returns a unique identifier for that
|
|
49
49
|
file such as a file path or a URL.
|
|
50
50
|
### readFileToBuffer
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="method" type={`(identifier: string) => Promise
|
|
52
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`} />
|
|
53
53
|
|
|
54
54
|
Reads a file based on an identifier which was generated by the writeFile
|
|
55
55
|
method, and returns the as a Buffer.
|
|
56
56
|
### readFileToStream
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(identifier: string) => Promise
|
|
58
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`} />
|
|
59
59
|
|
|
60
60
|
Reads a file based on an identifier which was generated by the writeFile
|
|
61
61
|
method, and returns the file as a Stream.
|
|
62
62
|
### deleteFile
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="method" type={`(identifier: string) => Promise
|
|
64
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<void>`} />
|
|
65
65
|
|
|
66
66
|
Deletes a file from the storage.
|
|
67
67
|
### fileExists
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="method" type={`(fileName: string) => Promise
|
|
69
|
+
<MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`} />
|
|
70
70
|
|
|
71
71
|
Check whether a file with the given name already exists. Used to avoid
|
|
72
72
|
naming conflicts before saving the file.
|
|
@@ -42,7 +42,7 @@ NEVER set the to true in production. It exists
|
|
|
42
42
|
only to aid certain development tasks.
|
|
43
43
|
### tokenMethod
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`'cookie' | 'bearer' | ReadonlyArray
|
|
45
|
+
<MemberInfo kind="property" type={`'cookie' | 'bearer' | ReadonlyArray<'cookie' | 'bearer'>`} default={`'cookie'`} />
|
|
46
46
|
|
|
47
47
|
Sets the method by which the session token is delivered and read.
|
|
48
48
|
|
|
@@ -79,7 +79,7 @@ authenticate(input: {
|
|
|
79
79
|
the _first_ input will be assumed to be the top-level input.
|
|
80
80
|
### authenticate
|
|
81
81
|
|
|
82
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: Data) => Promise
|
|
82
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: Data) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | false | string>`} />
|
|
83
83
|
|
|
84
84
|
Used to authenticate a user with the authentication provider. This method
|
|
85
85
|
will implement the provider-specific authentication logic, and should resolve to either a
|
|
@@ -87,7 +87,7 @@ will implement the provider-specific authentication logic, and should resolve to
|
|
|
87
87
|
A `string` return could be used to describe what error happened, otherwise `false` to an unknown error.
|
|
88
88
|
### onLogOut
|
|
89
89
|
|
|
90
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>) => Promise
|
|
90
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>) => Promise<void>`} />
|
|
91
91
|
|
|
92
92
|
Called when a user logs out, and may perform any required tasks
|
|
93
93
|
related to the user logging out with the external provider.
|
|
@@ -24,12 +24,12 @@ class BcryptPasswordHashingStrategy implements PasswordHashingStrategy {
|
|
|
24
24
|
|
|
25
25
|
### hash
|
|
26
26
|
|
|
27
|
-
<MemberInfo kind="method" type={`(plaintext: string) => Promise
|
|
27
|
+
<MemberInfo kind="method" type={`(plaintext: string) => Promise<string>`} />
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
### check
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise
|
|
32
|
+
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise<boolean>`} />
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -49,22 +49,22 @@ class DefaultSessionCacheStrategy implements SessionCacheStrategy {
|
|
|
49
49
|
|
|
50
50
|
### set
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => Promise
|
|
52
|
+
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => Promise<void>`} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
### get
|
|
56
56
|
|
|
57
|
-
<MemberInfo kind="method" type={`(sessionToken: string) => Promise
|
|
57
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined>`} />
|
|
58
58
|
|
|
59
59
|
|
|
60
60
|
### delete
|
|
61
61
|
|
|
62
|
-
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise
|
|
62
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise<void>`} />
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
### clear
|
|
66
66
|
|
|
67
|
-
<MemberInfo kind="method" type={`() => Promise
|
|
67
|
+
<MemberInfo kind="method" type={`() => Promise<void>`} />
|
|
68
68
|
|
|
69
69
|
|
|
70
70
|
|
|
@@ -50,7 +50,7 @@ class ExternalAuthenticationService {
|
|
|
50
50
|
|
|
51
51
|
### findCustomerUser
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string, checkCurrentChannelOnly: = true) => Promise
|
|
53
|
+
<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
54
|
|
|
55
55
|
Looks up a User based on their identifier from an external authentication
|
|
56
56
|
provider, ensuring this User is associated with a Customer account.
|
|
@@ -60,13 +60,13 @@ By passing `false` as the `checkCurrentChannelOnly` argument, _all_ channels
|
|
|
60
60
|
will be checked.
|
|
61
61
|
### findAdministratorUser
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise
|
|
63
|
+
<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
64
|
|
|
65
65
|
Looks up a User based on their identifier from an external authentication
|
|
66
66
|
provider, ensuring this User is associated with an Administrator account.
|
|
67
67
|
### createCustomerAndUser
|
|
68
68
|
|
|
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
|
|
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<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
|
|
70
70
|
|
|
71
71
|
If a customer has been successfully authenticated by an external authentication provider, yet cannot
|
|
72
72
|
be found using `findCustomerUser`, then we need to create a new User and
|
|
@@ -81,12 +81,12 @@ be found using `findAdministratorUser`, then we need to create a new User and
|
|
|
81
81
|
Administrator record in Vendure for that user.
|
|
82
82
|
### findUser
|
|
83
83
|
|
|
84
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise
|
|
84
|
+
<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
85
|
|
|
86
86
|
|
|
87
87
|
### createUser
|
|
88
88
|
|
|
89
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; }) => Promise
|
|
89
|
+
<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
90
|
|
|
91
91
|
Looks up a User based on their identifier from an external authentication
|
|
92
92
|
provider. Creates the user if does not exist. Unlike `findCustomerUser` and `findAdministratorUser`,
|
|
@@ -21,7 +21,7 @@ class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthe
|
|
|
21
21
|
verifyUserPassword(ctx: RequestContext, userId: ID, password: string) => Promise<boolean>;
|
|
22
22
|
}
|
|
23
23
|
```
|
|
24
|
-
* Implements: <code><a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a
|
|
24
|
+
* Implements: <code><a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a><NativeAuthenticationData></code>
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -44,12 +44,12 @@ class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthe
|
|
|
44
44
|
|
|
45
45
|
### authenticate
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: NativeAuthenticationData) => Promise
|
|
47
|
+
<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
48
|
|
|
49
49
|
|
|
50
50
|
### verifyUserPassword
|
|
51
51
|
|
|
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
|
|
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<boolean>`} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
|
|
@@ -31,12 +31,12 @@ interface PasswordHashingStrategy extends InjectableStrategy {
|
|
|
31
31
|
|
|
32
32
|
### hash
|
|
33
33
|
|
|
34
|
-
<MemberInfo kind="method" type={`(plaintext: string) => Promise
|
|
34
|
+
<MemberInfo kind="method" type={`(plaintext: string) => Promise<string>`} />
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
### check
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise
|
|
39
|
+
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise<boolean>`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
|
|
@@ -31,7 +31,7 @@ interface PasswordValidationStrategy extends InjectableStrategy {
|
|
|
31
31
|
|
|
32
32
|
### validate
|
|
33
33
|
|
|
34
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) => Promise
|
|
34
|
+
<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
35
|
|
|
36
36
|
Validates a password submitted during account registration or when a customer updates their password.
|
|
37
37
|
The method should resolve to `true` if the password is acceptable. If not, it should return `false` or
|
|
@@ -117,7 +117,7 @@ class CrudPermissionDefinition extends PermissionDefinition {
|
|
|
117
117
|
|
|
118
118
|
### constructor
|
|
119
119
|
|
|
120
|
-
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete')
|
|
120
|
+
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete') => string) => CrudPermissionDefinition`} />
|
|
121
121
|
|
|
122
122
|
|
|
123
123
|
### Create
|
|
@@ -203,7 +203,7 @@ class RwPermissionDefinition extends PermissionDefinition {
|
|
|
203
203
|
|
|
204
204
|
### constructor
|
|
205
205
|
|
|
206
|
-
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'read' | 'write')
|
|
206
|
+
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'read' | 'write') => string) => RwPermissionDefinition`} />
|
|
207
207
|
|
|
208
208
|
|
|
209
209
|
### Read
|
|
@@ -137,24 +137,24 @@ interface SessionCacheStrategy extends InjectableStrategy {
|
|
|
137
137
|
|
|
138
138
|
### set
|
|
139
139
|
|
|
140
|
-
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => void | Promise
|
|
140
|
+
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => void | Promise<void>`} />
|
|
141
141
|
|
|
142
142
|
Store the session in the cache. When caching a session, the data
|
|
143
143
|
should not be modified apart from performing any transforms needed to
|
|
144
144
|
get it into a state to be stored, e.g. JSON.stringify().
|
|
145
145
|
### get
|
|
146
146
|
|
|
147
|
-
<MemberInfo kind="method" type={`(sessionToken: string) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined | Promise
|
|
147
|
+
<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
148
|
|
|
149
149
|
Retrieve the session from the cache
|
|
150
150
|
### delete
|
|
151
151
|
|
|
152
|
-
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise
|
|
152
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise<void>`} />
|
|
153
153
|
|
|
154
154
|
Delete a session from the cache
|
|
155
155
|
### clear
|
|
156
156
|
|
|
157
|
-
<MemberInfo kind="method" type={`() => void | Promise
|
|
157
|
+
<MemberInfo kind="method" type={`() => void | Promise<void>`} />
|
|
158
158
|
|
|
159
159
|
Clear the entire cache
|
|
160
160
|
|
|
@@ -31,12 +31,12 @@ interface VerificationTokenStrategy extends InjectableStrategy {
|
|
|
31
31
|
|
|
32
32
|
### generateVerificationToken
|
|
33
33
|
|
|
34
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise
|
|
34
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<string> | string`} since="3.2.0" />
|
|
35
35
|
|
|
36
36
|
Generates a verification token.
|
|
37
37
|
### verifyVerificationToken
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise
|
|
39
|
+
<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
40
|
|
|
41
41
|
Checks the validity of a verification token.
|
|
42
42
|
|
|
@@ -21,7 +21,7 @@ interface CacheConfig {
|
|
|
21
21
|
|
|
22
22
|
### getKey
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="property" type={`(id: string | number)
|
|
24
|
+
<MemberInfo kind="property" type={`(id: string | number) => string`} />
|
|
25
25
|
|
|
26
26
|
A function which generates a cache key from the given id.
|
|
27
27
|
This key will be used to store the value in the cache.
|
|
@@ -47,13 +47,13 @@ The `Cache` instance provides a convenience wrapper around the `CacheService`
|
|
|
47
47
|
methods.
|
|
48
48
|
### get
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
50
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`} />
|
|
51
51
|
|
|
52
52
|
Gets an item from the cache, or returns undefined if the key is not found, or the
|
|
53
53
|
item has expired.
|
|
54
54
|
### set
|
|
55
55
|
|
|
56
|
-
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise
|
|
56
|
+
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`} />
|
|
57
57
|
|
|
58
58
|
Sets a key-value pair in the cache. The value must be serializable, so cannot contain
|
|
59
59
|
things like functions, circular data structures, class instances etc.
|
|
@@ -62,12 +62,12 @@ Optionally a "time to live" (ttl) can be specified, which means that the key wil
|
|
|
62
62
|
be considered stale after that many milliseconds.
|
|
63
63
|
### delete
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
65
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<void>`} />
|
|
66
66
|
|
|
67
67
|
Deletes an item from the cache.
|
|
68
68
|
### invalidateTags
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="method" type={`(tags: string[]) => Promise
|
|
70
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
71
71
|
|
|
72
72
|
Deletes all items from the cache which contain at least one matching tag.
|
|
73
73
|
|
|
@@ -40,13 +40,13 @@ interface CacheStrategy extends InjectableStrategy {
|
|
|
40
40
|
|
|
41
41
|
### get
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
43
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`} />
|
|
44
44
|
|
|
45
45
|
Gets an item from the cache, or returns undefined if the key is not found, or the
|
|
46
46
|
item has expired.
|
|
47
47
|
### set
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise
|
|
49
|
+
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`} />
|
|
50
50
|
|
|
51
51
|
Sets a key-value pair in the cache. The value must be serializable, so cannot contain
|
|
52
52
|
things like functions, circular data structures, class instances etc.
|
|
@@ -55,12 +55,12 @@ Optionally a "time to live" (ttl) can be specified, which means that the key wil
|
|
|
55
55
|
be considered stale after that many milliseconds.
|
|
56
56
|
### delete
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(key: string) => Promise
|
|
58
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<void>`} />
|
|
59
59
|
|
|
60
60
|
Deletes an item from the cache.
|
|
61
61
|
### invalidateTags
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="method" type={`(tags: string[]) => Promise
|
|
63
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
64
64
|
|
|
65
65
|
Deletes all items from the cache which contain at least one matching tag.
|
|
66
66
|
|
|
@@ -59,18 +59,18 @@ class Cache {
|
|
|
59
59
|
|
|
60
60
|
### get
|
|
61
61
|
|
|
62
|
-
<MemberInfo kind="method" type={`(id: string | number, getValueFn: ()
|
|
62
|
+
<MemberInfo kind="method" type={`(id: string | number, getValueFn: () => T | Promise<T>) => Promise<T>`} />
|
|
63
63
|
|
|
64
64
|
Retrieves the value from the cache if it exists, otherwise calls the `getValueFn` function
|
|
65
65
|
to get the value, sets it in the cache and returns it.
|
|
66
66
|
### delete
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="method" type={`(id: string | number | Array
|
|
68
|
+
<MemberInfo kind="method" type={`(id: string | number | Array<string | number>) => Promise<void>`} />
|
|
69
69
|
|
|
70
70
|
Deletes one or more items from the cache.
|
|
71
71
|
### invalidateTags
|
|
72
72
|
|
|
73
|
-
<MemberInfo kind="method" type={`(tags: string[]) => Promise
|
|
73
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
74
74
|
|
|
75
75
|
Invalidates one or more tags in the cache.
|
|
76
76
|
|