@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dates.generated.js +385 -385
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
- package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
- package/docs/reference/dashboard/page-layout/index.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +4 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/index.mdx +2 -2
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
- package/docs/reference/typescript-api/common/id.mdx +1 -1
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/middleware.mdx +1 -1
- package/docs/reference/typescript-api/common/permission.mdx +1 -1
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/entities/address.mdx +2 -2
- package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
- package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +3 -3
- package/docs/reference/typescript-api/entities/country.mdx +4 -4
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet.mdx +4 -4
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +9 -9
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/payment.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
- package/docs/reference/typescript-api/entities/product.mdx +3 -3
- package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
- package/docs/reference/typescript-api/entities/province.mdx +2 -2
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +4 -4
- package/docs/reference/typescript-api/entities/role.mdx +3 -3
- package/docs/reference/typescript-api/entities/seller.mdx +3 -3
- package/docs/reference/typescript-api/entities/session.mdx +3 -3
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
- package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
- package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
- package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
- package/docs/reference/typescript-api/entities/user.mdx +3 -3
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +2 -2
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
- package/docs/reference/typescript-api/events/event-types.mdx +109 -109
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
- package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
- package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
- package/docs/reference/typescript-api/logger/index.mdx +3 -3
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
- package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
- package/docs/reference/typescript-api/money/round-money.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
- package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
- package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
- package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context.mdx +5 -5
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
- package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
- package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
- package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
- package/docs/reference/typescript-api/services/history-service.mdx +1 -1
- package/docs/reference/typescript-api/services/order-service.mdx +24 -24
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
- package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/session-service.mdx +4 -4
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +8 -8
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
- package/package.json +1 -1
- package/src/dates.generated.ts +385 -385
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="212" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Defines API middleware, set in the
|
|
7
|
+
Defines API middleware, set in the [ApiOptions](/reference/typescript-api/configuration/api-options#apioptions). Middleware can be either
|
|
8
8
|
[Express middleware](https://expressjs.com/en/guide/using-middleware.html) or [NestJS middleware](https://docs.nestjs.com/middleware).
|
|
9
9
|
|
|
10
10
|
## Increasing the maximum request body size limit
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="4491" packageName="@vendure/common" />
|
|
6
6
|
|
|
7
7
|
Permissions for administrators and customers. Used to control access to
|
|
8
|
-
GraphQL resolvers via the
|
|
8
|
+
GraphQL resolvers via the [Allow](/reference/typescript-api/request/allow-decorator#allow) decorator.
|
|
9
9
|
|
|
10
10
|
## Understanding Permission.Owner
|
|
11
11
|
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="174" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
The result of the price calculation from the
|
|
8
|
-
|
|
7
|
+
The result of the price calculation from the [ProductVariantPriceCalculationStrategy](/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationstrategy) or the
|
|
8
|
+
[OrderItemPriceCalculationStrategy](/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
type PriceCalculationResult = {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/common/src/shared-types.ts" sourceLine="130" packageName="@vendure/common" />
|
|
6
6
|
|
|
7
|
-
Certain entities (those which implement
|
|
7
|
+
Certain entities (those which implement [ConfigurableOperationDef](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)) allow arbitrary
|
|
8
8
|
configuration arguments to be specified which can then be set in the admin-ui and used in
|
|
9
9
|
the business logic of the app. These are the valid data types of such arguments.
|
|
10
10
|
The data type influences:
|
|
@@ -5,10 +5,10 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/common/configurable-operation.ts" sourceLine="140" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
A object which defines the configurable arguments which may be passed to
|
|
8
|
-
functions in those classes which implement the
|
|
8
|
+
functions in those classes which implement the [ConfigurableOperationDef](/reference/typescript-api/configurable-operation-def/#configurableoperationdef) interface.
|
|
9
9
|
|
|
10
10
|
## Data types
|
|
11
|
-
Each argument has a data type, which must be one of
|
|
11
|
+
Each argument has a data type, which must be one of [ConfigArgType](/reference/typescript-api/configurable-operation-def/config-arg-type#configargtype).
|
|
12
12
|
|
|
13
13
|
*Example*
|
|
14
14
|
|
|
@@ -62,7 +62,7 @@ When not set, a default input component is used appropriate to the data type.
|
|
|
62
62
|
},
|
|
63
63
|
}
|
|
64
64
|
```
|
|
65
|
-
The available components as well as their configuration options can be found in the
|
|
65
|
+
The available components as well as their configuration options can be found in the [DefaultFormConfigHash](/reference/typescript-api/configurable-operation-def/default-form-config-hash#defaultformconfighash) docs.
|
|
66
66
|
Custom UI components may also be defined via an Admin UI extension using the `registerFormInputComponent()` function
|
|
67
67
|
which is exported from `@vendure/admin-ui/core`.
|
|
68
68
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/common/configurable-operation.ts" sourceLine="230" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
Common configuration options used when creating a new instance of a
|
|
8
|
-
|
|
8
|
+
[ConfigurableOperationDef](/reference/typescript-api/configurable-operation-def/#configurableoperationdef) (
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
interface ConfigurableOperationDefOptions<T extends ConfigArgs> extends InjectableStrategy {
|
|
@@ -14,7 +14,7 @@ interface ConfigurableOperationDefOptions<T extends ConfigArgs> extends Injectab
|
|
|
14
14
|
description: LocalizedStringArray;
|
|
15
15
|
}
|
|
16
16
|
```
|
|
17
|
-
* Extends:
|
|
17
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
@@ -41,7 +41,7 @@ args: {
|
|
|
41
41
|
}
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
See
|
|
44
|
+
See [ConfigArgs](/reference/typescript-api/configurable-operation-def/config-args#configargs) for available configuration options.
|
|
45
45
|
### description
|
|
46
46
|
|
|
47
47
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configurable-operation-def/localized-string-array#localizedstringarray'>LocalizedStringArray</a>`} />
|
|
@@ -9,15 +9,15 @@ code blocks which have arguments which are configurable at run-time by the admin
|
|
|
9
9
|
|
|
10
10
|
This is the mechanism used by:
|
|
11
11
|
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
12
|
+
* [CollectionFilter](/reference/typescript-api/configuration/collection-filter#collectionfilter)
|
|
13
|
+
* [PaymentMethodHandler](/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler)
|
|
14
|
+
* [PromotionAction](/reference/typescript-api/promotions/promotion-action#promotionaction)
|
|
15
|
+
* [PromotionCondition](/reference/typescript-api/promotions/promotion-condition#promotioncondition)
|
|
16
|
+
* [ShippingCalculator](/reference/typescript-api/shipping/shipping-calculator#shippingcalculator)
|
|
17
|
+
* [ShippingEligibilityChecker](/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker)
|
|
18
18
|
|
|
19
19
|
Any class which extends ConfigurableOperationDef works in the same way: it takes a
|
|
20
|
-
config object as the constructor argument. That config object extends the
|
|
20
|
+
config object as the constructor argument. That config object extends the [ConfigurableOperationDefOptions](/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions)
|
|
21
21
|
interface and typically adds some kind of business logic function to it.
|
|
22
22
|
|
|
23
23
|
For example, in the case of `ShippingEligibilityChecker`,
|
|
@@ -31,13 +31,13 @@ arguments that are exposed via the Admin UI as data input components. This allow
|
|
|
31
31
|
be set at run-time by the Administrator. Those values can then be accessed in the business logic
|
|
32
32
|
of the operation.
|
|
33
33
|
|
|
34
|
-
The data type of the args can be one of
|
|
35
|
-
the docs of
|
|
34
|
+
The data type of the args can be one of [ConfigArgType](/reference/typescript-api/configurable-operation-def/config-arg-type#configargtype), and the configuration is further explained in
|
|
35
|
+
the docs of [ConfigArgs](/reference/typescript-api/configurable-operation-def/config-args#configargs).
|
|
36
36
|
|
|
37
37
|
## Dependency Injection
|
|
38
38
|
If your business logic relies on injectable providers, such as the `TransactionalConnection` object, or any of the
|
|
39
39
|
internal Vendure services or those defined in a plugin, you can inject them by using the config object's
|
|
40
|
-
`init()` method, which exposes the
|
|
40
|
+
`init()` method, which exposes the [Injector](/reference/typescript-api/common/injector#injector).
|
|
41
41
|
|
|
42
42
|
Here's an example of a ShippingCalculator that injects a service which has been defined in a plugin:
|
|
43
43
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/common/configurable-operation.ts" sourceLine="43" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
An array of string values in a given
|
|
7
|
+
An array of string values in a given [LanguageCode](/reference/typescript-api/common/language-code#languagecode), used to define human-readable string values.
|
|
8
8
|
The `ui` property can be used in conjunction with the Vendure Admin UI to specify a custom form input
|
|
9
9
|
component.
|
|
10
10
|
|
|
@@ -116,7 +116,7 @@ Set the CORS handling for the server. See the [express CORS docs](https://github
|
|
|
116
116
|
|
|
117
117
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/middleware#middleware'>Middleware</a>[]`} default={`[]`} />
|
|
118
118
|
|
|
119
|
-
Custom Express or NestJS middleware for the server. More information can be found in the
|
|
119
|
+
Custom Express or NestJS middleware for the server. More information can be found in the [Middleware](/reference/typescript-api/common/middleware#middleware) docs.
|
|
120
120
|
### trustProxy
|
|
121
121
|
|
|
122
122
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/trust-proxy-options#trustproxyoptions'>TrustProxyOptions</a>`} default={`false`} since="3.4.0" />
|
|
@@ -50,7 +50,7 @@ class CollectionFilter<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
|
|
|
50
50
|
apply(qb: SelectQueryBuilder<ProductVariant>, args: ConfigArg[]) => SelectQueryBuilder<ProductVariant>;
|
|
51
51
|
}
|
|
52
52
|
```
|
|
53
|
-
* Extends:
|
|
53
|
+
* Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
|
|
@@ -25,7 +25,7 @@ class DefaultSlugStrategy implements SlugStrategy {
|
|
|
25
25
|
generate(ctx: RequestContext, params: SlugGenerateParams) => string;
|
|
26
26
|
}
|
|
27
27
|
```
|
|
28
|
-
* Implements:
|
|
28
|
+
* Implements: [`SlugStrategy`](/reference/typescript-api/configuration/slug-strategy#slugstrategy)
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
@@ -101,7 +101,7 @@ class EntityDuplicator<T extends ConfigArgs = ConfigArgs> extends ConfigurableOp
|
|
|
101
101
|
}) => Promise<VendureEntity>;
|
|
102
102
|
}
|
|
103
103
|
```
|
|
104
|
-
* Extends:
|
|
104
|
+
* Extends: [`ConfigurableOperationDef`](/reference/typescript-api/configurable-operation-def/#configurableoperationdef)`<T>`
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
|
|
@@ -143,7 +143,7 @@ interface EntityDuplicatorConfig<T extends ConfigArgs> extends ConfigurableOpera
|
|
|
143
143
|
duplicate: DuplicateEntityFn<T>;
|
|
144
144
|
}
|
|
145
145
|
```
|
|
146
|
-
* Extends:
|
|
146
|
+
* Extends: [`ConfigurableOperationDefOptions`](/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions)`<T>`
|
|
147
147
|
|
|
148
148
|
|
|
149
149
|
|
|
@@ -14,7 +14,7 @@ class AutoIncrementIdStrategy implements EntityIdStrategy<'increment'> {
|
|
|
14
14
|
encodeId(primaryKey: number) => string;
|
|
15
15
|
}
|
|
16
16
|
```
|
|
17
|
-
* Implements:
|
|
17
|
+
* Implements: [`EntityIdStrategy`](/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy)`<'increment'>`
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
@@ -44,7 +44,7 @@ The EntityIdStrategy determines how entity IDs are generated and stored in the
|
|
|
44
44
|
database, as well as how they are transformed when being passed from the API to the
|
|
45
45
|
service layer and vice versa.
|
|
46
46
|
|
|
47
|
-
Vendure ships with two strategies:
|
|
47
|
+
Vendure ships with two strategies: [AutoIncrementIdStrategy](/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy) and [UuidIdStrategy](/reference/typescript-api/configuration/entity-id-strategy#uuididstrategy),
|
|
48
48
|
but custom strategies can be used, e.g. to apply some custom encoding to the ID before exposing
|
|
49
49
|
it in the GraphQL API.
|
|
50
50
|
|
|
@@ -69,7 +69,7 @@ interface EntityIdStrategy<T extends 'increment' | 'uuid'> extends InjectableStr
|
|
|
69
69
|
decodeId: (id: string) => PrimaryKeyType<T>;
|
|
70
70
|
}
|
|
71
71
|
```
|
|
72
|
-
* Extends:
|
|
72
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
73
73
|
|
|
74
74
|
|
|
75
75
|
|
|
@@ -107,7 +107,7 @@ back to the raw ID value.
|
|
|
107
107
|
An id strategy which uses string uuids as primary keys
|
|
108
108
|
for all entities. This strategy can be configured with the
|
|
109
109
|
`entityIdStrategy` property of the `entityOptions` property
|
|
110
|
-
of
|
|
110
|
+
of [VendureConfig](/reference/typescript-api/configuration/vendure-config#vendureconfig).
|
|
111
111
|
|
|
112
112
|
*Example*
|
|
113
113
|
|
|
@@ -129,7 +129,7 @@ class UuidIdStrategy implements EntityIdStrategy<'uuid'> {
|
|
|
129
129
|
encodeId(primaryKey: string) => string;
|
|
130
130
|
}
|
|
131
131
|
```
|
|
132
|
-
* Implements:
|
|
132
|
+
* Implements: [`EntityIdStrategy`](/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy)`<'uuid'>`
|
|
133
133
|
|
|
134
134
|
|
|
135
135
|
|
|
@@ -40,7 +40,7 @@ a fresh database.
|
|
|
40
40
|
|
|
41
41
|
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/entity-duplicator#entityduplicator'>EntityDuplicator</a><any>>`} default={`defaultEntityDuplicators`} since="2.2.0" />
|
|
42
42
|
|
|
43
|
-
An array of
|
|
43
|
+
An array of [EntityDuplicator](/reference/typescript-api/configuration/entity-duplicator#entityduplicator) instances which are used to duplicate entities
|
|
44
44
|
when using the `duplicateEntity` mutation.
|
|
45
45
|
### moneyStrategy
|
|
46
46
|
|
|
@@ -78,7 +78,7 @@ smaller value here will prevent data inconsistencies between instances.
|
|
|
78
78
|
Allows the metadata of the built-in TypeORM entities to be manipulated. This allows you
|
|
79
79
|
to do things like altering data types, adding indices etc. This is an advanced feature
|
|
80
80
|
which should be used with some caution as it will result in DB schema changes. For examples
|
|
81
|
-
see
|
|
81
|
+
see [EntityMetadataModifier](/reference/typescript-api/configuration/entity-options#entitymetadatamodifier).
|
|
82
82
|
### slugStrategy
|
|
83
83
|
|
|
84
84
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/slug-strategy#slugstrategy'>SlugStrategy</a>`} default={`<a href='/reference/typescript-api/configuration/default-slug-strategy#defaultslugstrategy'>DefaultSlugStrategy</a>`} since="3.5.0" />
|
package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx
CHANGED
|
@@ -21,7 +21,7 @@ interface ProductVariantPriceSelectionStrategy extends InjectableStrategy {
|
|
|
21
21
|
): ProductVariantPrice | undefined | Promise<ProductVariantPrice | undefined>;
|
|
22
22
|
}
|
|
23
23
|
```
|
|
24
|
-
* Extends:
|
|
24
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
@@ -46,7 +46,7 @@ class DefaultProductVariantPriceSelectionStrategy implements ProductVariantPrice
|
|
|
46
46
|
selectPrice(ctx: RequestContext, prices: ProductVariantPrice[]) => ;
|
|
47
47
|
}
|
|
48
48
|
```
|
|
49
|
-
* Implements:
|
|
49
|
+
* Implements: [`ProductVariantPriceSelectionStrategy`](/reference/typescript-api/configuration/product-variant-price-selection-strategy#productvariantpriceselectionstrategy)
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
|
package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx
CHANGED
|
@@ -46,7 +46,7 @@ interface ProductVariantPriceUpdateStrategy extends InjectableStrategy {
|
|
|
46
46
|
): UpdatedProductVariantPrice[] | Promise<UpdatedProductVariantPrice[]>;
|
|
47
47
|
}
|
|
48
48
|
```
|
|
49
|
-
* Extends:
|
|
49
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
|
|
@@ -84,7 +84,7 @@ the prices of the specific ProductVariantPrices.
|
|
|
84
84
|
</div>
|
|
85
85
|
<GenerationInfo sourceFile="packages/core/src/config/catalog/default-product-variant-price-update-strategy.ts" sourceLine="14" packageName="@vendure/core" since="2.2.0" />
|
|
86
86
|
|
|
87
|
-
The options available to the
|
|
87
|
+
The options available to the [DefaultProductVariantPriceUpdateStrategy](/reference/typescript-api/configuration/product-variant-price-update-strategy#defaultproductvariantpriceupdatestrategy).
|
|
88
88
|
|
|
89
89
|
```ts title="Signature"
|
|
90
90
|
interface DefaultProductVariantPriceUpdateStrategyOptions {
|
|
@@ -107,7 +107,7 @@ case, a custom strategy should be implemented.
|
|
|
107
107
|
</div>
|
|
108
108
|
<GenerationInfo sourceFile="packages/core/src/config/catalog/default-product-variant-price-update-strategy.ts" sourceLine="56" packageName="@vendure/core" since="2.2.0" />
|
|
109
109
|
|
|
110
|
-
The default
|
|
110
|
+
The default [ProductVariantPriceUpdateStrategy](/reference/typescript-api/configuration/product-variant-price-update-strategy#productvariantpriceupdatestrategy) which by default will not update any other
|
|
111
111
|
prices when a price is created, updated or deleted.
|
|
112
112
|
|
|
113
113
|
If the `syncPricesAcrossChannels` option is set to `true`, then when a price is updated in one Channel,
|
|
@@ -141,7 +141,7 @@ class DefaultProductVariantPriceUpdateStrategy implements ProductVariantPriceUpd
|
|
|
141
141
|
onPriceDeleted(ctx: RequestContext, deletedPrice: ProductVariantPrice, prices: ProductVariantPrice[]) => ;
|
|
142
142
|
}
|
|
143
143
|
```
|
|
144
|
-
* Implements:
|
|
144
|
+
* Implements: [`ProductVariantPriceUpdateStrategy`](/reference/typescript-api/configuration/product-variant-price-update-strategy#productvariantpriceupdatestrategy)
|
|
145
145
|
|
|
146
146
|
|
|
147
147
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="1319" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
This interface represents the VendureConfig object available at run-time, i.e. the user-supplied
|
|
8
|
-
config values have been merged with the
|
|
8
|
+
config values have been merged with the [defaultConfig](/reference/typescript-api/configuration/default-config#defaultconfig) values.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
interface RuntimeVendureConfig extends Required<VendureConfig> {
|
|
@@ -25,7 +25,7 @@ interface RuntimeVendureConfig extends Required<VendureConfig> {
|
|
|
25
25
|
systemOptions: Required<SystemOptions>;
|
|
26
26
|
}
|
|
27
27
|
```
|
|
28
|
-
* Extends: `Required
|
|
28
|
+
* Extends: `Required<`[`VendureConfig`](/reference/typescript-api/configuration/vendure-config#vendureconfig)`>`
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/settings-store/settings-store-types.ts" sourceLine="141" packageName="@vendure/core" since="3.4.0" />
|
|
6
6
|
|
|
7
|
-
This is how SettingsStoreFields are defined in the
|
|
7
|
+
This is how SettingsStoreFields are defined in the [VendureConfig](/reference/typescript-api/configuration/vendure-config#vendureconfig) object.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
type SettingsStoreFields = {
|
|
@@ -26,7 +26,7 @@ interface SlugStrategy extends InjectableStrategy {
|
|
|
26
26
|
generate(ctx: RequestContext, params: SlugGenerateParams): string | Promise<string>;
|
|
27
27
|
}
|
|
28
28
|
```
|
|
29
|
-
* Extends:
|
|
29
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
|
|
@@ -21,20 +21,20 @@ interface SystemOptions {
|
|
|
21
21
|
|
|
22
22
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a>[]`} default={`[<a href='/reference/typescript-api/health-check/type-ormhealth-check-strategy#typeormhealthcheckstrategy'>TypeORMHealthCheckStrategy</a>]`} since="1.6.0" />
|
|
23
23
|
|
|
24
|
-
Defines an array of
|
|
24
|
+
Defines an array of [HealthCheckStrategy](/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy) instances which are used by the `/health` endpoint to verify
|
|
25
25
|
that any critical systems which the Vendure server depends on are also healthy.
|
|
26
26
|
### errorHandlers
|
|
27
27
|
|
|
28
28
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/errors/error-handler-strategy#errorhandlerstrategy'>ErrorHandlerStrategy</a>[]`} default={`[]`} since="2.2.0" />
|
|
29
29
|
|
|
30
|
-
Defines an array of
|
|
30
|
+
Defines an array of [ErrorHandlerStrategy](/reference/typescript-api/errors/error-handler-strategy#errorhandlerstrategy) instances which are used to define logic to be executed
|
|
31
31
|
when an error occurs, either on the server or the worker.
|
|
32
32
|
### cacheStrategy
|
|
33
33
|
|
|
34
34
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/cache/cache-strategy#cachestrategy'>CacheStrategy</a>`} default={`InMemoryCacheStrategy`} since="3.1.0" />
|
|
35
35
|
|
|
36
36
|
Defines the underlying method used to store cache key-value pairs which powers the
|
|
37
|
-
|
|
37
|
+
[CacheService](/reference/typescript-api/cache/cache-service#cacheservice).
|
|
38
38
|
### instrumentationStrategy
|
|
39
39
|
|
|
40
40
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/telemetry/instrumentation-strategy#instrumentationstrategy'>InstrumentationStrategy</a>`} />
|
|
@@ -67,7 +67,7 @@ Defines custom fields which can be used to extend the built-in entities.
|
|
|
67
67
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/settings-store-fields#settingsstorefields'>SettingsStoreFields</a>`} since="3.4.0" />
|
|
68
68
|
|
|
69
69
|
Defines key-value fields that can be set and read via the `getKeyValue`/`setKeyValue` GraphQL APIs
|
|
70
|
-
and via the
|
|
70
|
+
and via the [SettingsStoreService](/reference/typescript-api/services/settings-store-service#settingsstoreservice). These differ from custom fields in that they are not associated
|
|
71
71
|
with a specific entity, but can be scoped globally or to a specific user etc, and defining them does not
|
|
72
72
|
require any changes to the database schema.
|
|
73
73
|
### dbConnectionOptions
|
|
@@ -135,7 +135,7 @@ Configures the available checkers and calculators for ShippingMethods.
|
|
|
135
135
|
|
|
136
136
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a>`} default={`<a href='/reference/typescript-api/logger/default-logger#defaultlogger'>DefaultLogger</a>`} />
|
|
137
137
|
|
|
138
|
-
Provide a logging service which implements the
|
|
138
|
+
Provide a logging service which implements the [VendureLogger](/reference/typescript-api/logger/vendure-logger#vendurelogger) interface.
|
|
139
139
|
Note that the logging of SQL queries is controlled separately by the
|
|
140
140
|
`dbConnectionOptions.logging` property.
|
|
141
141
|
### taxOptions
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="273" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Most entities can have additional fields added to them by defining an array of
|
|
7
|
+
Most entities can have additional fields added to them by defining an array of [CustomFieldConfig](/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig)objects on against the corresponding key.
|
|
8
8
|
|
|
9
9
|
*Example*
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/config/custom-field/custom-field-types.ts" sourceLine="84" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Configures a custom field on an entity in the
|
|
7
|
+
Configures a custom field on an entity in the [CustomFields](/reference/typescript-api/custom-fields/#customfields) config object.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
type TypedCustomSingleFieldConfig<T extends CustomFieldType, C extends CustomField> = BaseTypedCustomFieldConfig<T, C> & {
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/common/calculated-decorator.ts" sourceLine="43" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
Used to define calculated entity getters. The decorator simply attaches an array of "calculated"
|
|
8
|
-
property names to the entity's prototype. This array is then used by the
|
|
8
|
+
property names to the entity's prototype. This array is then used by the [CalculatedPropertySubscriber](/reference/typescript-api/data-access/calculated-property-subscriber#calculatedpropertysubscriber)to transfer the getter function from the prototype to the entity instance.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
function Calculated(queryInstruction?: CalculatedColumnQueryInstruction): MethodDecorator
|
|
@@ -18,7 +18,7 @@ Parameters
|
|
|
18
18
|
|
|
19
19
|
<GenerationInfo sourceFile="packages/core/src/common/calculated-decorator.ts" sourceLine="17" packageName="@vendure/core" />
|
|
20
20
|
|
|
21
|
-
Optional metadata used to tell the
|
|
21
|
+
Optional metadata used to tell the [ListQueryBuilder](/reference/typescript-api/data-access/list-query-builder#listquerybuilder) & [Relations](/reference/typescript-api/request/relations-decorator#relations) decorator how to deal with
|
|
22
22
|
calculated columns when sorting, filtering and deriving required relations from GraphQL operations.
|
|
23
23
|
|
|
24
24
|
```ts title="Signature"
|
|
@@ -45,7 +45,7 @@ available, and those FacetValues will have their `facet` relations joined too.
|
|
|
45
45
|
|
|
46
46
|
This `hydrate` method will _also_ automatically take care or translating any
|
|
47
47
|
translatable entities (e.g. Product, Collection, Facet), and if the `applyProductVariantPrices`
|
|
48
|
-
options is used (see
|
|
48
|
+
options is used (see [HydrateOptions](/reference/typescript-api/data-access/hydrate-options#hydrateoptions)), any related ProductVariant will have the correct
|
|
49
49
|
Channel-specific prices applied to them.
|
|
50
50
|
|
|
51
51
|
Custom field relations may also be hydrated:
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/connection/types.ts" sourceLine="10" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Options used by the
|
|
7
|
+
Options used by the [TransactionalConnection](/reference/typescript-api/data-access/transactional-connection#transactionalconnection) `getEntityOrThrow` method.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
|
|
@@ -25,7 +25,7 @@ interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {
|
|
|
25
25
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
|
|
26
26
|
|
|
27
27
|
An optional channelId to limit results to entities assigned to the given Channel. Should
|
|
28
|
-
only be used when getting entities that implement the
|
|
28
|
+
only be used when getting entities that implement the [ChannelAware](/reference/typescript-api/entities/interfaces#channelaware) interface.
|
|
29
29
|
### retries
|
|
30
30
|
|
|
31
31
|
<MemberInfo kind="property" type={`number`} default={`0`} since="1.1.0" />
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/entity-hydrator/entity-hydrator-types.ts" sourceLine="12" packageName="@vendure/core" since="1.3.0" />
|
|
6
6
|
|
|
7
7
|
Options used to control which relations of the entity get hydrated
|
|
8
|
-
when using the
|
|
8
|
+
when using the [EntityHydrator](/reference/typescript-api/data-access/entity-hydrator#entityhydrator) helper.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
interface HydrateOptions<Entity extends VendureEntity> {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/service/helpers/list-query-builder/list-query-builder.ts" sourceLine="207" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
This helper class is used when fetching entities the database from queries which return a
|
|
7
|
+
This helper class is used when fetching entities the database from queries which return a [PaginatedList](/reference/typescript-api/common/paginated-list#paginatedlist) type.
|
|
8
8
|
These queries all follow the same format:
|
|
9
9
|
|
|
10
10
|
In the GraphQL definition, they return a type which implements the `Node` interface, and the query returns a
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/connection/transactional-connection.ts" sourceLine="41" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
The TransactionalConnection is a wrapper around the TypeORM `Connection` object which works in conjunction
|
|
8
|
-
with the
|
|
8
|
+
with the [Transaction](/reference/typescript-api/request/transaction-decorator#transaction) decorator to implement per-request transactions. All services which access the
|
|
9
9
|
database should use this class rather than the raw TypeORM connection, to ensure that db changes can be
|
|
10
10
|
easily wrapped in transactions when required.
|
|
11
11
|
|
|
@@ -62,7 +62,7 @@ is discouraged without a deliberate reason.
|
|
|
62
62
|
|
|
63
63
|
Returns a TypeORM repository which is bound to any existing transactions. It is recommended to _always_ pass
|
|
64
64
|
the RequestContext argument when possible, otherwise the queries will be executed outside of any
|
|
65
|
-
ongoing transactions which have been started by the
|
|
65
|
+
ongoing transactions which have been started by the [Transaction](/reference/typescript-api/request/transaction-decorator#transaction) decorator.
|
|
66
66
|
|
|
67
67
|
The `options` parameter allows specifying additional configurations, such as the `replicationMode`,
|
|
68
68
|
which determines whether the repository should interact with the master or replica database.
|
|
@@ -80,7 +80,7 @@ or not. If `RequestContext` is provided, the repository is bound to any ongoing
|
|
|
80
80
|
Allows database operations to be wrapped in a transaction, ensuring that in the event of an error being
|
|
81
81
|
thrown at any point, the entire transaction will be rolled back and no changes will be saved.
|
|
82
82
|
|
|
83
|
-
In the context of API requests, you should instead use the
|
|
83
|
+
In the context of API requests, you should instead use the [Transaction](/reference/typescript-api/request/transaction-decorator#transaction) decorator on your resolver or
|
|
84
84
|
controller method.
|
|
85
85
|
|
|
86
86
|
On the other hand, for code that does not run in the context of a GraphQL/REST request, this method
|
|
@@ -90,7 +90,7 @@ inconsistent state.
|
|
|
90
90
|
Such situations include function processed by the JobQueue or stand-alone scripts which make use
|
|
91
91
|
of Vendure internal services.
|
|
92
92
|
|
|
93
|
-
If there is already a
|
|
93
|
+
If there is already a [RequestContext](/reference/typescript-api/request/request-context#requestcontext) object available, you should pass it in as the first
|
|
94
94
|
argument in order to create transactional context as the copy. If not, omit the first argument and an empty
|
|
95
95
|
RequestContext object will be created, which is then used to propagate the transaction to
|
|
96
96
|
all inner method calls.
|
|
@@ -129,12 +129,12 @@ private async transferCredit(outerCtx: RequestContext, fromId: ID, toId: ID, amo
|
|
|
129
129
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, isolationLevel?: <a href='/reference/typescript-api/request/transaction-decorator#transactionisolationlevel'>TransactionIsolationLevel</a>) => `} />
|
|
130
130
|
|
|
131
131
|
Manually start a transaction if one is not already in progress. This method should be used in
|
|
132
|
-
conjunction with the `'manual'` mode of the
|
|
132
|
+
conjunction with the `'manual'` mode of the [Transaction](/reference/typescript-api/request/transaction-decorator#transaction) decorator.
|
|
133
133
|
### commitOpenTransaction
|
|
134
134
|
|
|
135
135
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `} />
|
|
136
136
|
|
|
137
|
-
Manually commits any open transaction. Should be very rarely needed, since the
|
|
137
|
+
Manually commits any open transaction. Should be very rarely needed, since the [Transaction](/reference/typescript-api/request/transaction-decorator#transaction) decorator
|
|
138
138
|
and the internal TransactionInterceptor take care of this automatically. Use-cases include situations
|
|
139
139
|
in which the worker thread needs to access changes made in the current transaction, or when using the
|
|
140
140
|
Transaction decorator in manual mode.
|
|
@@ -142,7 +142,7 @@ Transaction decorator in manual mode.
|
|
|
142
142
|
|
|
143
143
|
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `} />
|
|
144
144
|
|
|
145
|
-
Manually rolls back any open transaction. Should be very rarely needed, since the
|
|
145
|
+
Manually rolls back any open transaction. Should be very rarely needed, since the [Transaction](/reference/typescript-api/request/transaction-decorator#transaction) decorator
|
|
146
146
|
and the internal TransactionInterceptor take care of this automatically. Use-cases include when using the
|
|
147
147
|
Transaction decorator in manual mode.
|
|
148
148
|
### getEntityOrThrow
|
package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx
CHANGED
|
@@ -39,8 +39,8 @@ the worker.
|
|
|
39
39
|
|
|
40
40
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy'>SearchStrategy</a>`} default={`undefined`} since="1.6.0" />
|
|
41
41
|
|
|
42
|
-
Set a custom search strategy that implements
|
|
43
|
-
such as
|
|
42
|
+
Set a custom search strategy that implements [SearchStrategy](/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy) or extends an existing search strategy
|
|
43
|
+
such as [MysqlSearchStrategy](/reference/typescript-api/default-search-plugin/mysql-search-strategy#mysqlsearchstrategy), [PostgresSearchStrategy](/reference/typescript-api/default-search-plugin/postgres-search-strategy#postgressearchstrategy) or [SqliteSearchStrategy](/reference/typescript-api/default-search-plugin/sqlite-search-strategy#sqlitesearchstrategy).
|
|
44
44
|
|
|
45
45
|
*Example*
|
|
46
46
|
|
|
@@ -15,7 +15,7 @@ class MysqlSearchStrategy implements SearchStrategy {
|
|
|
15
15
|
getTotalCount(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<number>;
|
|
16
16
|
}
|
|
17
17
|
```
|
|
18
|
-
* Implements:
|
|
18
|
+
* Implements: [`SearchStrategy`](/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy)
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|
|
@@ -15,7 +15,7 @@ class PostgresSearchStrategy implements SearchStrategy {
|
|
|
15
15
|
getTotalCount(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<number>;
|
|
16
16
|
}
|
|
17
17
|
```
|
|
18
|
-
* Implements:
|
|
18
|
+
* Implements: [`SearchStrategy`](/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy)
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|