@vendure/docs 0.0.0-202601211609 → 0.0.0-202601220950
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 +5 -5
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
- 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 +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 +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 +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
- 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 +1 -1
- 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 +1 -1
- 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 +2 -2
- 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 +1 -1
- 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 +2 -2
- package/docs/reference/graphql-api/admin/_index.mdx +11 -0
- package/docs/reference/graphql-api/shop/_index.mdx +11 -0
- 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 +2 -2
- 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 +2 -2
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
- 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 +14 -14
- 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/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 +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
- 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 +2 -2
- 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 +5 -5
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
- 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 +12 -12
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +3 -3
- 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/request/request-context.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 +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
- 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 +6 -3
|
@@ -15,7 +15,7 @@ Parameters
|
|
|
15
15
|
|
|
16
16
|
### props
|
|
17
17
|
|
|
18
|
-
<MemberInfo kind="parameter" type={
|
|
18
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/page-layout/#pagelayoutprops'>PageLayoutProps</a>>`} />
|
|
19
19
|
|
|
20
20
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="183" packageName="@vendure/dashboard" since="3.3.0" />
|
|
21
21
|
|
|
@@ -16,7 +16,7 @@ Parameters
|
|
|
16
16
|
|
|
17
17
|
### props
|
|
18
18
|
|
|
19
|
-
<MemberInfo kind="parameter" type={
|
|
19
|
+
<MemberInfo kind="parameter" type={`Readonly<{ children: React.ReactNode }>`} />
|
|
20
20
|
|
|
21
21
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="373" packageName="@vendure/dashboard" since="3.3.0" />
|
|
22
22
|
|
|
@@ -29,7 +29,7 @@ Parameters
|
|
|
29
29
|
|
|
30
30
|
### props
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="parameter" type={
|
|
32
|
+
<MemberInfo kind="parameter" type={`Readonly<{ children: React.ReactNode }>`} />
|
|
33
33
|
|
|
34
34
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="466" packageName="@vendure/dashboard" since="3.3.0" />
|
|
35
35
|
|
|
@@ -45,5 +45,5 @@ Parameters
|
|
|
45
45
|
|
|
46
46
|
### props
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="parameter" type={
|
|
48
|
+
<MemberInfo kind="parameter" type={`Readonly<{ children: React.ReactNode; dropdownMenuItems?: InlineDropdownItem[]; }>`} />
|
|
49
49
|
|
|
@@ -24,7 +24,7 @@ Parameters
|
|
|
24
24
|
|
|
25
25
|
### props
|
|
26
26
|
|
|
27
|
-
<MemberInfo kind="parameter" type={
|
|
27
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/page-layout/page-block#pageblockprops'>PageBlockProps</a>>`} />
|
|
28
28
|
|
|
29
29
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="540" packageName="@vendure/dashboard" since="3.3.0" />
|
|
30
30
|
|
|
@@ -90,7 +90,7 @@ Parameters
|
|
|
90
90
|
|
|
91
91
|
### props
|
|
92
92
|
|
|
93
|
-
<MemberInfo kind="parameter" type={
|
|
93
|
+
<MemberInfo kind="parameter" type={`Readonly<Pick<<a href='/reference/dashboard/page-layout/page-block#pageblockprops'>PageBlockProps</a>, 'children' | 'className' | 'blockId'>>`} />
|
|
94
94
|
|
|
95
95
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="668" packageName="@vendure/dashboard" since="3.3.0" />
|
|
96
96
|
|
|
@@ -116,5 +116,5 @@ Parameters
|
|
|
116
116
|
|
|
117
117
|
### props
|
|
118
118
|
|
|
119
|
-
<MemberInfo kind="parameter" type={
|
|
119
|
+
<MemberInfo kind="parameter" type={`Readonly<{ column: 'main' | 'side'; entityType: string; control: Control<any, any>; }>`} />
|
|
120
120
|
|
|
@@ -46,7 +46,7 @@ Parameters
|
|
|
46
46
|
|
|
47
47
|
### props
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="parameter" type={
|
|
49
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/page-layout/page#pageprops'>PageProps</a>>`} />
|
|
50
50
|
|
|
51
51
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/layout-engine/page-layout.tsx" sourceLine="38" packageName="@vendure/dashboard" since="3.3.0" />
|
|
52
52
|
|
|
@@ -78,7 +78,7 @@ A string identifier for the page, e.g. "product-list", "review-detail", etc.
|
|
|
78
78
|
|
|
79
79
|
### form
|
|
80
80
|
|
|
81
|
-
<MemberInfo kind="property" type={
|
|
81
|
+
<MemberInfo kind="property" type={`UseFormReturn<any>`} />
|
|
82
82
|
|
|
83
83
|
|
|
84
84
|
### submitHandler
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Admin API"
|
|
3
|
+
generated: true
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
<LinkCard href="/reference/graphql-api/admin/queries" title="Queries" />
|
|
8
|
+
<LinkCard href="/reference/graphql-api/admin/mutations" title="Mutations" />
|
|
9
|
+
<LinkCard href="/reference/graphql-api/admin/object-types" title="Types" />
|
|
10
|
+
<LinkCard href="/reference/graphql-api/admin/input-types" title="Input Objects" />
|
|
11
|
+
<LinkCard href="/reference/graphql-api/admin/enums" title="Enums" />
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Shop API"
|
|
3
|
+
generated: true
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
<LinkCard href="/reference/graphql-api/shop/queries" title="Queries" />
|
|
8
|
+
<LinkCard href="/reference/graphql-api/shop/mutations" title="Mutations" />
|
|
9
|
+
<LinkCard href="/reference/graphql-api/shop/object-types" title="Types" />
|
|
10
|
+
<LinkCard href="/reference/graphql-api/shop/input-types" title="Input Objects" />
|
|
11
|
+
<LinkCard href="/reference/graphql-api/shop/enums" title="Enums" />
|
|
@@ -32,7 +32,7 @@ interface AssetPreviewStrategy extends InjectableStrategy {
|
|
|
32
32
|
|
|
33
33
|
### generatePreviewImage
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) =>
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -33,36 +33,36 @@ interface AssetStorageStrategy extends InjectableStrategy {
|
|
|
33
33
|
|
|
34
34
|
### writeFileFromBuffer
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) =>
|
|
36
|
+
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`} />
|
|
37
37
|
|
|
38
38
|
Writes a buffer to the store and returns a unique identifier for that
|
|
39
39
|
file such as a file path or a URL.
|
|
40
40
|
### writeFileFromStream
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="method" type={`(fileName: string, data: Stream) =>
|
|
42
|
+
<MemberInfo kind="method" type={`(fileName: string, data: Stream) => Promise<string>`} />
|
|
43
43
|
|
|
44
44
|
Writes a readable stream to the store and returns a unique identifier for that
|
|
45
45
|
file such as a file path or a URL.
|
|
46
46
|
### readFileToBuffer
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(identifier: string) =>
|
|
48
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`} />
|
|
49
49
|
|
|
50
50
|
Reads a file based on an identifier which was generated by the writeFile
|
|
51
51
|
method, and returns the as a Buffer.
|
|
52
52
|
### readFileToStream
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(identifier: string) =>
|
|
54
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`} />
|
|
55
55
|
|
|
56
56
|
Reads a file based on an identifier which was generated by the writeFile
|
|
57
57
|
method, and returns the file as a Stream.
|
|
58
58
|
### deleteFile
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="method" type={`(identifier: string) =>
|
|
60
|
+
<MemberInfo kind="method" type={`(identifier: string) => Promise<void>`} />
|
|
61
61
|
|
|
62
62
|
Deletes a file from the storage.
|
|
63
63
|
### fileExists
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="method" type={`(fileName: string) =>
|
|
65
|
+
<MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`} />
|
|
66
66
|
|
|
67
67
|
Check whether a file with the given name already exists. Used to avoid
|
|
68
68
|
naming conflicts before saving the file.
|
|
@@ -38,7 +38,7 @@ NEVER set the to true in production. It exists
|
|
|
38
38
|
only to aid certain development tasks.
|
|
39
39
|
### tokenMethod
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="property" type={
|
|
41
|
+
<MemberInfo kind="property" type={`'cookie' | 'bearer' | ReadonlyArray<'cookie' | 'bearer'>`} default={`'cookie'`} />
|
|
42
42
|
|
|
43
43
|
Sets the method by which the session token is delivered and read.
|
|
44
44
|
|
|
@@ -75,7 +75,7 @@ authenticate(input: {
|
|
|
75
75
|
the _first_ input will be assumed to be the top-level input.
|
|
76
76
|
### authenticate
|
|
77
77
|
|
|
78
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: Data) =>
|
|
78
|
+
<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>`} />
|
|
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
|
|
@@ -83,7 +83,7 @@ will implement the provider-specific authentication logic, and should resolve to
|
|
|
83
83
|
A `string` return could be used to describe what error happened, otherwise `false` to an unknown error.
|
|
84
84
|
### onLogOut
|
|
85
85
|
|
|
86
|
-
<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>) =>
|
|
86
|
+
<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>`} />
|
|
87
87
|
|
|
88
88
|
Called when a user logs out, and may perform any required tasks
|
|
89
89
|
related to the user logging out with the external provider.
|
|
@@ -20,12 +20,12 @@ class BcryptPasswordHashingStrategy implements PasswordHashingStrategy {
|
|
|
20
20
|
|
|
21
21
|
### hash
|
|
22
22
|
|
|
23
|
-
<MemberInfo kind="method" type={`(plaintext: string) =>
|
|
23
|
+
<MemberInfo kind="method" type={`(plaintext: string) => Promise<string>`} />
|
|
24
24
|
|
|
25
25
|
|
|
26
26
|
### check
|
|
27
27
|
|
|
28
|
-
<MemberInfo kind="method" type={`(plaintext: string, hash: string) =>
|
|
28
|
+
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise<boolean>`} />
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
@@ -45,22 +45,22 @@ class DefaultSessionCacheStrategy implements SessionCacheStrategy {
|
|
|
45
45
|
|
|
46
46
|
### set
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) =>
|
|
48
|
+
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => Promise<void>`} />
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
### get
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="method" type={`(sessionToken: string) =>
|
|
53
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined>`} />
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
### delete
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(sessionToken: string) =>
|
|
58
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise<void>`} />
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
### clear
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="method" type={`() =>
|
|
63
|
+
<MemberInfo kind="method" type={`() => Promise<void>`} />
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
|
|
@@ -46,7 +46,7 @@ class ExternalAuthenticationService {
|
|
|
46
46
|
|
|
47
47
|
### findCustomerUser
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string, checkCurrentChannelOnly: = true) =>
|
|
49
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string, checkCurrentChannelOnly: = true) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
|
|
50
50
|
|
|
51
51
|
Looks up a User based on their identifier from an external authentication
|
|
52
52
|
provider, ensuring this User is associated with a Customer account.
|
|
@@ -56,13 +56,13 @@ By passing `false` as the `checkCurrentChannelOnly` argument, _all_ channels
|
|
|
56
56
|
will be checked.
|
|
57
57
|
### findAdministratorUser
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) =>
|
|
59
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
|
|
60
60
|
|
|
61
61
|
Looks up a User based on their identifier from an external authentication
|
|
62
62
|
provider, ensuring this User is associated with an Administrator account.
|
|
63
63
|
### createCustomerAndUser
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; emailAddress: string; firstName: string; lastName: string; verified?: boolean; }) =>
|
|
65
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; emailAddress: string; firstName: string; lastName: string; verified?: boolean; }) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
|
|
66
66
|
|
|
67
67
|
If a customer has been successfully authenticated by an external authentication provider, yet cannot
|
|
68
68
|
be found using `findCustomerUser`, then we need to create a new User and
|
|
@@ -77,12 +77,12 @@ be found using `findAdministratorUser`, then we need to create a new User and
|
|
|
77
77
|
Administrator record in Vendure for that user.
|
|
78
78
|
### findUser
|
|
79
79
|
|
|
80
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) =>
|
|
80
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
### createUser
|
|
84
84
|
|
|
85
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; }) =>
|
|
85
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: { strategy: string; externalIdentifier: string; }) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
|
|
86
86
|
|
|
87
87
|
Looks up a User based on their identifier from an external authentication
|
|
88
88
|
provider. Creates the user if does not exist. Unlike `findCustomerUser` and `findAdministratorUser`,
|
|
@@ -40,12 +40,12 @@ class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthe
|
|
|
40
40
|
|
|
41
41
|
### authenticate
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: NativeAuthenticationData) =>
|
|
43
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: NativeAuthenticationData) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | false>`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### verifyUserPassword
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, password: string) =>
|
|
48
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, password: string) => Promise<boolean>`} />
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
|
|
@@ -27,12 +27,12 @@ interface PasswordHashingStrategy extends InjectableStrategy {
|
|
|
27
27
|
|
|
28
28
|
### hash
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="method" type={`(plaintext: string) =>
|
|
30
|
+
<MemberInfo kind="method" type={`(plaintext: string) => Promise<string>`} />
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
### check
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(plaintext: string, hash: string) =>
|
|
35
|
+
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise<boolean>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -27,7 +27,7 @@ interface PasswordValidationStrategy extends InjectableStrategy {
|
|
|
27
27
|
|
|
28
28
|
### validate
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) =>
|
|
30
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) => Promise<boolean | string> | boolean | string`} since="1.5.0" />
|
|
31
31
|
|
|
32
32
|
Validates a password submitted during account registration or when a customer updates their password.
|
|
33
33
|
The method should resolve to `true` if the password is acceptable. If not, it should return `false` or
|
|
@@ -109,7 +109,7 @@ class CrudPermissionDefinition extends PermissionDefinition {
|
|
|
109
109
|
|
|
110
110
|
### constructor
|
|
111
111
|
|
|
112
|
-
<MemberInfo kind="method" type={`(name: string, descriptionFn?:
|
|
112
|
+
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete') => string) => CrudPermissionDefinition`} />
|
|
113
113
|
|
|
114
114
|
|
|
115
115
|
### Create
|
|
@@ -191,7 +191,7 @@ class RwPermissionDefinition extends PermissionDefinition {
|
|
|
191
191
|
|
|
192
192
|
### constructor
|
|
193
193
|
|
|
194
|
-
<MemberInfo kind="method" type={`(name: string, descriptionFn?:
|
|
194
|
+
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'read' | 'write') => string) => RwPermissionDefinition`} />
|
|
195
195
|
|
|
196
196
|
|
|
197
197
|
### Read
|
|
@@ -133,24 +133,24 @@ interface SessionCacheStrategy extends InjectableStrategy {
|
|
|
133
133
|
|
|
134
134
|
### set
|
|
135
135
|
|
|
136
|
-
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) =>
|
|
136
|
+
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => void | Promise<void>`} />
|
|
137
137
|
|
|
138
138
|
Store the session in the cache. When caching a session, the data
|
|
139
139
|
should not be modified apart from performing any transforms needed to
|
|
140
140
|
get it into a state to be stored, e.g. JSON.stringify().
|
|
141
141
|
### get
|
|
142
142
|
|
|
143
|
-
<MemberInfo kind="method" type={`(sessionToken: string) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a
|
|
143
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined | Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined>`} />
|
|
144
144
|
|
|
145
145
|
Retrieve the session from the cache
|
|
146
146
|
### delete
|
|
147
147
|
|
|
148
|
-
<MemberInfo kind="method" type={`(sessionToken: string) =>
|
|
148
|
+
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise<void>`} />
|
|
149
149
|
|
|
150
150
|
Delete a session from the cache
|
|
151
151
|
### clear
|
|
152
152
|
|
|
153
|
-
<MemberInfo kind="method" type={`() =>
|
|
153
|
+
<MemberInfo kind="method" type={`() => void | Promise<void>`} />
|
|
154
154
|
|
|
155
155
|
Clear the entire cache
|
|
156
156
|
|
|
@@ -27,12 +27,12 @@ interface VerificationTokenStrategy extends InjectableStrategy {
|
|
|
27
27
|
|
|
28
28
|
### generateVerificationToken
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) =>
|
|
30
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<string> | string`} since="3.2.0" />
|
|
31
31
|
|
|
32
32
|
Generates a verification token.
|
|
33
33
|
### verifyVerificationToken
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) =>
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, token: string) => Promise<boolean> | boolean`} since="3.2.0" />
|
|
36
36
|
|
|
37
37
|
Checks the validity of a verification token.
|
|
38
38
|
|
|
@@ -17,7 +17,7 @@ interface CacheConfig {
|
|
|
17
17
|
|
|
18
18
|
### getKey
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="property" type={
|
|
20
|
+
<MemberInfo kind="property" type={`(id: string | number) => string`} />
|
|
21
21
|
|
|
22
22
|
A function which generates a cache key from the given id.
|
|
23
23
|
This key will be used to store the value in the cache.
|
|
@@ -43,13 +43,13 @@ The `Cache` instance provides a convenience wrapper around the `CacheService`
|
|
|
43
43
|
methods.
|
|
44
44
|
### get
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="method" type={`(key: string) =>
|
|
46
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`} />
|
|
47
47
|
|
|
48
48
|
Gets an item from the cache, or returns undefined if the key is not found, or the
|
|
49
49
|
item has expired.
|
|
50
50
|
### set
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) =>
|
|
52
|
+
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`} />
|
|
53
53
|
|
|
54
54
|
Sets a key-value pair in the cache. The value must be serializable, so cannot contain
|
|
55
55
|
things like functions, circular data structures, class instances etc.
|
|
@@ -58,12 +58,12 @@ Optionally a "time to live" (ttl) can be specified, which means that the key wil
|
|
|
58
58
|
be considered stale after that many milliseconds.
|
|
59
59
|
### delete
|
|
60
60
|
|
|
61
|
-
<MemberInfo kind="method" type={`(key: string) =>
|
|
61
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<void>`} />
|
|
62
62
|
|
|
63
63
|
Deletes an item from the cache.
|
|
64
64
|
### invalidateTags
|
|
65
65
|
|
|
66
|
-
<MemberInfo kind="method" type={`(tags: string[]) =>
|
|
66
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
67
67
|
|
|
68
68
|
Deletes all items from the cache which contain at least one matching tag.
|
|
69
69
|
|
|
@@ -36,13 +36,13 @@ interface CacheStrategy extends InjectableStrategy {
|
|
|
36
36
|
|
|
37
37
|
### get
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(key: string) =>
|
|
39
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`} />
|
|
40
40
|
|
|
41
41
|
Gets an item from the cache, or returns undefined if the key is not found, or the
|
|
42
42
|
item has expired.
|
|
43
43
|
### set
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) =>
|
|
45
|
+
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`} />
|
|
46
46
|
|
|
47
47
|
Sets a key-value pair in the cache. The value must be serializable, so cannot contain
|
|
48
48
|
things like functions, circular data structures, class instances etc.
|
|
@@ -51,12 +51,12 @@ Optionally a "time to live" (ttl) can be specified, which means that the key wil
|
|
|
51
51
|
be considered stale after that many milliseconds.
|
|
52
52
|
### delete
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(key: string) =>
|
|
54
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<void>`} />
|
|
55
55
|
|
|
56
56
|
Deletes an item from the cache.
|
|
57
57
|
### invalidateTags
|
|
58
58
|
|
|
59
|
-
<MemberInfo kind="method" type={`(tags: string[]) =>
|
|
59
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
60
60
|
|
|
61
61
|
Deletes all items from the cache which contain at least one matching tag.
|
|
62
62
|
|
|
@@ -55,18 +55,18 @@ class Cache {
|
|
|
55
55
|
|
|
56
56
|
### get
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(id: string | number, getValueFn:
|
|
58
|
+
<MemberInfo kind="method" type={`(id: string | number, getValueFn: () => T | Promise<T>) => Promise<T>`} />
|
|
59
59
|
|
|
60
60
|
Retrieves the value from the cache if it exists, otherwise calls the `getValueFn` function
|
|
61
61
|
to get the value, sets it in the cache and returns it.
|
|
62
62
|
### delete
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="method" type={`(id:
|
|
64
|
+
<MemberInfo kind="method" type={`(id: string | number | Array<string | number>) => Promise<void>`} />
|
|
65
65
|
|
|
66
66
|
Deletes one or more items from the cache.
|
|
67
67
|
### invalidateTags
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="method" type={`(tags: string[]) =>
|
|
69
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
70
70
|
|
|
71
71
|
Invalidates one or more tags in the cache.
|
|
72
72
|
|
|
@@ -47,22 +47,22 @@ class RedisCacheStrategy implements CacheStrategy {
|
|
|
47
47
|
|
|
48
48
|
### get
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(key: string) =>
|
|
50
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<T | undefined>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### set
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) =>
|
|
55
|
+
<MemberInfo kind="method" type={`(key: string, value: T, options?: <a href='/reference/typescript-api/cache/cache-strategy#setcachekeyoptions'>SetCacheKeyOptions</a>) => Promise<void>`} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### delete
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="method" type={`(key: string) =>
|
|
60
|
+
<MemberInfo kind="method" type={`(key: string) => Promise<void>`} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### invalidateTags
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="method" type={`(tags: string[]) =>
|
|
65
|
+
<MemberInfo kind="method" type={`(tags: string[]) => Promise<void>`} />
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
|
|
@@ -36,12 +36,12 @@ Get a value from the RequestContext cache. If the value is not found, the `getDe
|
|
|
36
36
|
function will be called to get the value, which will then be cached and returned.
|
|
37
37
|
### get
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?:
|
|
39
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: () => T) => T`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
### get
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?:
|
|
44
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, key: any, getDefault?: () => T) => T | Promise<T> | undefined`} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
|
|
@@ -22,13 +22,13 @@ interface SelfRefreshingCache<V, RefreshArgs extends any[] = []> {
|
|
|
22
22
|
|
|
23
23
|
### value
|
|
24
24
|
|
|
25
|
-
<MemberInfo kind="method" type={`(refreshArgs: RefreshArgs | [undefined] | []) =>
|
|
25
|
+
<MemberInfo kind="method" type={`(refreshArgs: RefreshArgs | [undefined] | []) => Promise<V>`} />
|
|
26
26
|
|
|
27
27
|
The current value of the cache. If the value is stale, the data will be refreshed and then
|
|
28
28
|
the fresh value will be returned.
|
|
29
29
|
### memoize
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(args: Args, refreshArgs: RefreshArgs, fn:
|
|
31
|
+
<MemberInfo kind="method" type={`(args: Args, refreshArgs: RefreshArgs, fn: (value: V, ...args: Args) => R) => Promise<R>`} />
|
|
32
32
|
|
|
33
33
|
Allows a memoized function to be defined. For the given arguments, the `fn` function will
|
|
34
34
|
be invoked only once and its output cached and returned.
|
|
@@ -36,7 +36,7 @@ The results cache is cleared along with the rest of the cache according to the c
|
|
|
36
36
|
`ttl` value.
|
|
37
37
|
### refresh
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(args: RefreshArgs) =>
|
|
39
|
+
<MemberInfo kind="method" type={`(args: RefreshArgs) => Promise<V>`} />
|
|
40
40
|
|
|
41
41
|
Force a refresh of the value, e.g. when it is known that the value has changed such as after
|
|
42
42
|
an update operation to the source data in the database.
|
|
@@ -78,13 +78,13 @@ The time-to-live (ttl) in milliseconds for the cache. After this time, the value
|
|
|
78
78
|
and will be refreshed the next time it is accessed.
|
|
79
79
|
### refresh
|
|
80
80
|
|
|
81
|
-
<MemberInfo kind="property" type={
|
|
81
|
+
<MemberInfo kind="property" type={`{ fn: (...args: RefreshArgs) => Promise<V>; /** * Default arguments, passed to refresh function */ defaultArgs: RefreshArgs; }`} />
|
|
82
82
|
|
|
83
83
|
The function which is used to refresh the value of the cache.
|
|
84
84
|
This function should return a Promise which resolves to the new value.
|
|
85
85
|
### getTimeFn
|
|
86
86
|
|
|
87
|
-
<MemberInfo kind="property" type={
|
|
87
|
+
<MemberInfo kind="property" type={`() => number`} />
|
|
88
88
|
|
|
89
89
|
Intended for unit testing the SelfRefreshingCache only.
|
|
90
90
|
By default uses `() => new Date().getTime()`
|
|
@@ -131,7 +131,7 @@ Parameters
|
|
|
131
131
|
|
|
132
132
|
### config
|
|
133
133
|
|
|
134
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/cache/self-refreshing-cache#selfrefreshingcacheconfig'>SelfRefreshingCacheConfig</a
|
|
134
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/cache/self-refreshing-cache#selfrefreshingcacheconfig'>SelfRefreshingCacheConfig</a><V, RefreshArgs>`} />
|
|
135
135
|
|
|
136
136
|
### refreshArgs
|
|
137
137
|
|
|
@@ -30,7 +30,7 @@ index.html, the compiled js bundles etc.
|
|
|
30
30
|
Specifies the url route to the Admin UI app.
|
|
31
31
|
### compile
|
|
32
32
|
|
|
33
|
-
<MemberInfo kind="property" type={
|
|
33
|
+
<MemberInfo kind="property" type={`() => Promise<void>`} />
|
|
34
34
|
|
|
35
35
|
The function which will be invoked to start the app compilation process.
|
|
36
36
|
|