@vendure/docs 0.0.0-202601271334 → 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 +393 -393
- package/docs/guides/extending-the-admin-ui/getting-started/index.mdx +1 -1
- package/docs/guides/extending-the-dashboard/custom-form-components/index.mdx +2 -2
- package/docs/guides/extending-the-dashboard/customizing-pages/page-blocks.mdx +1 -1
- package/docs/guides/extending-the-dashboard/deployment/index.mdx +2 -2
- package/docs/guides/extending-the-dashboard/getting-started/index.mdx +1 -1
- package/docs/guides/extending-the-dashboard/navigation/index.mdx +2 -2
- package/docs/guides/how-to/cms-integration-plugin/index.mdx +7 -7
- package/docs/guides/how-to/codegen/index.mdx +1 -1
- 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/admin-ui-plugin/index.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 +2 -2
- package/src/dates.generated.ts +393 -393
|
@@ -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
|
|
|
@@ -10,7 +10,7 @@ should follow.
|
|
|
10
10
|
:::info
|
|
11
11
|
|
|
12
12
|
This is configured via the `searchStrategy` property of
|
|
13
|
-
the
|
|
13
|
+
the [DefaultSearchPluginInitOptions](/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions).
|
|
14
14
|
|
|
15
15
|
:::
|
|
16
16
|
|
|
@@ -22,7 +22,7 @@ interface SearchStrategy extends InjectableStrategy {
|
|
|
22
22
|
getCollectionIds(ctx: RequestContext, input: SearchInput, enabledOnly: boolean): Promise<Map<ID, number>>;
|
|
23
23
|
}
|
|
24
24
|
```
|
|
25
|
-
* Extends:
|
|
25
|
+
* Extends: [`InjectableStrategy`](/reference/typescript-api/common/injectable-strategy#injectablestrategy)
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
@@ -16,7 +16,7 @@ class SqliteSearchStrategy implements SearchStrategy {
|
|
|
16
16
|
getTotalCount(ctx: RequestContext, input: SearchInput, enabledOnly: boolean) => Promise<number>;
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Implements:
|
|
19
|
+
* Implements: [`SearchStrategy`](/reference/typescript-api/default-search-plugin/search-strategy#searchstrategy)
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/address/address.entity.ts" sourceLine="16" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Represents a
|
|
7
|
+
Represents a [Customer](/reference/typescript-api/entities/customer#customer)'s address.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class Address extends VendureEntity implements HasCustomFields {
|
|
@@ -35,7 +35,7 @@ class Address extends VendureEntity implements HasCustomFields {
|
|
|
35
35
|
customFields: CustomAddressFields;
|
|
36
36
|
}
|
|
37
37
|
```
|
|
38
|
-
* Extends:
|
|
38
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
* Implements: HasCustomFields
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
An administrative user who has access to the Admin UI and Admin API. The
|
|
8
8
|
specific permissions of the Administrator are determined by the assigned
|
|
9
|
-
|
|
9
|
+
[Role](/reference/typescript-api/entities/role#role)s.
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
class Administrator extends VendureEntity implements SoftDeletable, HasCustomFields {
|
|
@@ -24,10 +24,10 @@ class Administrator extends VendureEntity implements SoftDeletable, HasCustomFie
|
|
|
24
24
|
customFields: CustomAdministratorFields;
|
|
25
25
|
}
|
|
26
26
|
```
|
|
27
|
-
* Extends:
|
|
27
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
28
28
|
|
|
29
29
|
|
|
30
|
-
* Implements:
|
|
30
|
+
* Implements: [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable), HasCustomFields
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
|
|
@@ -13,7 +13,7 @@ class AnonymousSession extends Session {
|
|
|
13
13
|
constructor(input: DeepPartial<AnonymousSession>)
|
|
14
14
|
}
|
|
15
15
|
```
|
|
16
|
-
* Extends:
|
|
16
|
+
* Extends: [`Session`](/reference/typescript-api/entities/session#session)
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
@@ -36,10 +36,10 @@ class Asset extends VendureEntity implements Taggable, ChannelAware, HasCustomFi
|
|
|
36
36
|
customFields: CustomAssetFields;
|
|
37
37
|
}
|
|
38
38
|
```
|
|
39
|
-
* Extends:
|
|
39
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
40
40
|
|
|
41
41
|
|
|
42
|
-
* Implements:
|
|
42
|
+
* Implements: [`Taggable`](/reference/typescript-api/entities/interfaces#taggable), [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware), HasCustomFields
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
|
|
@@ -16,7 +16,7 @@ class AuthenticatedSession extends Session {
|
|
|
16
16
|
authenticationStrategy: string;
|
|
17
17
|
}
|
|
18
18
|
```
|
|
19
|
-
* Extends:
|
|
19
|
+
* Extends: [`Session`](/reference/typescript-api/entities/session#session)
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
|
|
@@ -31,12 +31,12 @@ class AuthenticatedSession extends Session {
|
|
|
31
31
|
|
|
32
32
|
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/user#user'>User</a>`} />
|
|
33
33
|
|
|
34
|
-
The
|
|
34
|
+
The [User](/reference/typescript-api/entities/user#user) who has authenticated to create this session.
|
|
35
35
|
### authenticationStrategy
|
|
36
36
|
|
|
37
37
|
<MemberInfo kind="property" type={`string`} />
|
|
38
38
|
|
|
39
|
-
The name of the
|
|
39
|
+
The name of the [AuthenticationStrategy](/reference/typescript-api/auth/authentication-strategy#authenticationstrategy) used when authenticating
|
|
40
40
|
to create this session.
|
|
41
41
|
|
|
42
42
|
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/authentication-method/authentication-method.entity.ts" sourceLine="14" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
An AuthenticationMethod represents the means by which a
|
|
8
|
-
|
|
7
|
+
An AuthenticationMethod represents the means by which a [User](/reference/typescript-api/entities/user#user) is authenticated. There are two kinds:
|
|
8
|
+
[NativeAuthenticationMethod](/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod) and [ExternalAuthenticationMethod](/reference/typescript-api/entities/authentication-method#externalauthenticationmethod).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class AuthenticationMethod extends VendureEntity {
|
|
@@ -14,7 +14,7 @@ class AuthenticationMethod extends VendureEntity {
|
|
|
14
14
|
user: User;
|
|
15
15
|
}
|
|
16
16
|
```
|
|
17
|
-
* Extends:
|
|
17
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
@@ -44,7 +44,7 @@ class ExternalAuthenticationMethod extends AuthenticationMethod {
|
|
|
44
44
|
metadata: any;
|
|
45
45
|
}
|
|
46
46
|
```
|
|
47
|
-
* Extends:
|
|
47
|
+
* Extends: [`AuthenticationMethod`](/reference/typescript-api/entities/authentication-method#authenticationmethod)
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
|
|
@@ -94,7 +94,7 @@ class NativeAuthenticationMethod extends AuthenticationMethod {
|
|
|
94
94
|
pendingIdentifier: string | null;
|
|
95
95
|
}
|
|
96
96
|
```
|
|
97
|
-
* Extends:
|
|
97
|
+
* Extends: [`AuthenticationMethod`](/reference/typescript-api/entities/authentication-method#authenticationmethod)
|
|
98
98
|
|
|
99
99
|
|
|
100
100
|
|
|
@@ -78,7 +78,7 @@ class Channel extends VendureEntity {
|
|
|
78
78
|
stockLocations: StockLocation[];
|
|
79
79
|
}
|
|
80
80
|
```
|
|
81
|
-
* Extends:
|
|
81
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
82
82
|
|
|
83
83
|
|
|
84
84
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/collection/collection.entity.ts" sourceLine="35" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A Collection is a grouping of
|
|
7
|
+
A Collection is a grouping of [Product](/reference/typescript-api/entities/product#product)s based on various configurable criteria.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class Collection extends VendureEntity implements Translatable, HasCustomFields, ChannelAware, Orderable {
|
|
@@ -43,10 +43,10 @@ class Collection extends VendureEntity implements Translatable, HasCustomFields,
|
|
|
43
43
|
channels: Channel[];
|
|
44
44
|
}
|
|
45
45
|
```
|
|
46
|
-
* Extends:
|
|
46
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
47
47
|
|
|
48
48
|
|
|
49
|
-
* Implements:
|
|
49
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), HasCustomFields, [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware), [`Orderable`](/reference/typescript-api/entities/interfaces#orderable)
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
|
|
@@ -4,9 +4,9 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/region/country.entity.ts" sourceLine="14" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A country to which is available when creating / updating an
|
|
8
|
-
grouped together into
|
|
9
|
-
and taxes for an
|
|
7
|
+
A country to which is available when creating / updating an [Address](/reference/typescript-api/entities/address#address). Countries are
|
|
8
|
+
grouped together into [Zone](/reference/typescript-api/entities/zone#zone)s which are in turn used to determine applicable shipping
|
|
9
|
+
and taxes for an [Order](/reference/typescript-api/entities/order#order).
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
class Country extends Region {
|
|
@@ -14,7 +14,7 @@ class Country extends Region {
|
|
|
14
14
|
readonly type: RegionType = 'country';
|
|
15
15
|
}
|
|
16
16
|
```
|
|
17
|
-
* Extends:
|
|
17
|
+
* Extends: [`Region`](/reference/typescript-api/entities/region#region)
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/customer-group/customer-group.entity.ts" sourceLine="17" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A grouping of
|
|
7
|
+
A grouping of [Customer](/reference/typescript-api/entities/customer#customer)s which enables features such as group-based promotions
|
|
8
8
|
or tax rules.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -19,7 +19,7 @@ class CustomerGroup extends VendureEntity implements HasCustomFields {
|
|
|
19
19
|
taxRates: TaxRate[];
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
|
-
* Extends:
|
|
22
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
* Implements: HasCustomFields
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/history-entry/customer-history-entry.entity.ts" sourceLine="14" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Represents an event in the history of a particular
|
|
7
|
+
Represents an event in the history of a particular [Customer](/reference/typescript-api/entities/customer#customer).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class CustomerHistoryEntry extends HistoryEntry {
|
|
@@ -14,7 +14,7 @@ class CustomerHistoryEntry extends HistoryEntry {
|
|
|
14
14
|
customer: Customer;
|
|
15
15
|
}
|
|
16
16
|
```
|
|
17
|
-
* Extends:
|
|
17
|
+
* Extends: [`HistoryEntry`](/reference/typescript-api/entities/history-entry#historyentry)
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/customer/customer.entity.ts" sourceLine="22" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
7
|
This entity represents a customer of the store, typically an individual person. A Customer can be
|
|
8
|
-
a guest, in which case it has no associated
|
|
8
|
+
a guest, in which case it has no associated [User](/reference/typescript-api/entities/user#user). Customers with registered account will
|
|
9
9
|
have an associated User entity.
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
@@ -38,10 +38,10 @@ class Customer extends VendureEntity implements ChannelAware, HasCustomFields, S
|
|
|
38
38
|
channels: Channel[];
|
|
39
39
|
}
|
|
40
40
|
```
|
|
41
|
-
* Extends:
|
|
41
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
42
42
|
|
|
43
43
|
|
|
44
|
-
* Implements:
|
|
44
|
+
* Implements: [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware), HasCustomFields, [`SoftDeletable`](/reference/typescript-api/entities/interfaces#softdeletable)
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/facet-value/facet-value.entity.ts" sourceLine="23" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A particular value of a
|
|
7
|
+
A particular value of a [Facet](/reference/typescript-api/entities/facet#facet).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class FacetValue extends VendureEntity implements Translatable, HasCustomFields, ChannelAware {
|
|
@@ -29,10 +29,10 @@ class FacetValue extends VendureEntity implements Translatable, HasCustomFields,
|
|
|
29
29
|
productVariants: ProductVariant[];
|
|
30
30
|
}
|
|
31
31
|
```
|
|
32
|
-
* Extends:
|
|
32
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
* Implements:
|
|
35
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), HasCustomFields, [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware)
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -4,11 +4,11 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/facet/facet.entity.ts" sourceLine="25" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
A Facet is a class of properties which can be applied to a
|
|
7
|
+
A Facet is a class of properties which can be applied to a [Product](/reference/typescript-api/entities/product#product) or [ProductVariant](/reference/typescript-api/entities/product-variant#productvariant).
|
|
8
8
|
They are used to enable [faceted search](https://en.wikipedia.org/wiki/Faceted_search) whereby products
|
|
9
9
|
can be filtered along a number of dimensions (facets).
|
|
10
10
|
|
|
11
|
-
For example, there could be a Facet named "Brand" which has a number of
|
|
11
|
+
For example, there could be a Facet named "Brand" which has a number of [FacetValue](/reference/typescript-api/entities/facet-value#facetvalue)s representing
|
|
12
12
|
the various brands of product, e.g. "Apple", "Samsung", "Dell", "HP" etc.
|
|
13
13
|
|
|
14
14
|
```ts title="Signature"
|
|
@@ -30,10 +30,10 @@ class Facet extends VendureEntity implements Translatable, HasCustomFields, Chan
|
|
|
30
30
|
channels: Channel[];
|
|
31
31
|
}
|
|
32
32
|
```
|
|
33
|
-
* Extends:
|
|
33
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
34
34
|
|
|
35
35
|
|
|
36
|
-
* Implements:
|
|
36
|
+
* Implements: [`Translatable`](/reference/typescript-api/entities/interfaces#translatable), HasCustomFields, [`ChannelAware`](/reference/typescript-api/entities/interfaces#channelaware)
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/fulfillment/fulfillment.entity.ts" sourceLine="18" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
This entity represents a fulfillment of an Order or part of it, i.e. which
|
|
7
|
+
This entity represents a fulfillment of an Order or part of it, i.e. which [OrderLine](/reference/typescript-api/entities/order-line#orderline)s have been
|
|
8
8
|
delivered to the Customer after successful payment.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -25,7 +25,7 @@ class Fulfillment extends VendureEntity implements HasCustomFields {
|
|
|
25
25
|
customFields: CustomFulfillmentFields;
|
|
26
26
|
}
|
|
27
27
|
```
|
|
28
|
-
* Extends:
|
|
28
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
* Implements: HasCustomFields
|
|
@@ -19,7 +19,7 @@ class GlobalSettings extends VendureEntity implements HasCustomFields {
|
|
|
19
19
|
customFields: CustomGlobalSettingsFields;
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
|
-
* Extends:
|
|
22
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
* Implements: HasCustomFields
|
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/history-entry/history-entry.entity.ts" sourceLine="16" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
An abstract entity representing an entry in the history of an Order (
|
|
8
|
-
or a Customer (
|
|
7
|
+
An abstract entity representing an entry in the history of an Order ([OrderHistoryEntry](/reference/typescript-api/entities/order-history-entry#orderhistoryentry))
|
|
8
|
+
or a Customer ([CustomerHistoryEntry](/reference/typescript-api/entities/customer-history-entry#customerhistoryentry)).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
class HistoryEntry extends VendureEntity implements HasCustomFields {
|
|
@@ -22,7 +22,7 @@ class HistoryEntry extends VendureEntity implements HasCustomFields {
|
|
|
22
22
|
customFields: CustomHistoryEntryFields;
|
|
23
23
|
}
|
|
24
24
|
```
|
|
25
|
-
* Extends:
|
|
25
|
+
* Extends: [`VendureEntity`](/reference/typescript-api/entities/vendure-entity#vendureentity)
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
* Implements: HasCustomFields
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/core/src/entity/history-entry/order-history-entry.entity.ts" sourceLine="14" packageName="@vendure/core" />
|
|
6
6
|
|
|
7
|
-
Represents an event in the history of a particular
|
|
7
|
+
Represents an event in the history of a particular [Order](/reference/typescript-api/entities/order#order).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
class OrderHistoryEntry extends HistoryEntry {
|
|
@@ -14,7 +14,7 @@ class OrderHistoryEntry extends HistoryEntry {
|
|
|
14
14
|
order: Order;
|
|
15
15
|
}
|
|
16
16
|
```
|
|
17
|
-
* Extends:
|
|
17
|
+
* Extends: [`HistoryEntry`](/reference/typescript-api/entities/history-entry#historyentry)
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|