@vendure/docs 0.0.0-202601201656 → 0.0.0-202601210957
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/manifest.d.ts +1 -2
- package/dist/manifest.d.ts.map +1 -1
- package/dist/manifest.js +55 -1
- package/dist/manifest.js.map +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
- package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
- package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
- package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
- package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
- package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
- package/docs/reference/dashboard/page-layout/index.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +3 -3
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
- package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/index.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
- package/docs/reference/typescript-api/common/injector.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -1
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +1 -1
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +1 -1
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +1 -1
- package/docs/reference/typescript-api/entities/role.mdx +1 -1
- package/docs/reference/typescript-api/entities/seller.mdx +1 -1
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
- package/docs/reference/typescript-api/entities/user.mdx +1 -1
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
- package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
- package/docs/reference/typescript-api/events/event-types.mdx +30 -30
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
- package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
- package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
- package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
- package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
- package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
- package/docs/reference/typescript-api/services/country-service.mdx +7 -7
- package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
- package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
- package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
- package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +8 -8
- package/docs/reference/typescript-api/services/order-service.mdx +52 -52
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
- package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
- package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-service.mdx +13 -13
- package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
- package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
- package/docs/reference/typescript-api/services/province-service.mdx +5 -5
- package/docs/reference/typescript-api/services/role-service.mdx +11 -11
- package/docs/reference/typescript-api/services/search-service.mdx +2 -2
- package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
- package/docs/reference/typescript-api/services/session-service.mdx +8 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
- package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
- package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
- package/docs/reference/typescript-api/services/user-service.mdx +12 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
- package/package.json +2 -2
- package/docs/reference/admin-ui-api/index.mdx +0 -4
- package/docs/reference/dashboard/index.mdx +0 -4
- package/docs/reference/graphql-api/admin/_index.mdx +0 -4
- package/docs/reference/graphql-api/shop/_index.mdx +0 -4
- package/docs/reference/typescript-api/_index.mdx +0 -4
|
@@ -29,7 +29,7 @@ interface RuntimeVendureConfig extends Required<VendureConfig> {
|
|
|
29
29
|
systemOptions: Required<SystemOptions>;
|
|
30
30
|
}
|
|
31
31
|
```
|
|
32
|
-
* Extends: <code>Required
|
|
32
|
+
* Extends: <code>Required<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>></code>
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -37,72 +37,72 @@ interface RuntimeVendureConfig extends Required<VendureConfig> {
|
|
|
37
37
|
|
|
38
38
|
### apiOptions
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="property" type={`Required
|
|
40
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/configuration/api-options#apioptions'>ApiOptions</a>>`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### assetOptions
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`Required
|
|
45
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/assets/asset-options#assetoptions'>AssetOptions</a>>`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### authOptions
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="property" type={`Required
|
|
50
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/auth/auth-options#authoptions'>AuthOptions</a>>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### catalogOptions
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={`Required
|
|
55
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/products-stock/catalog-options#catalogoptions'>CatalogOptions</a>>`} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### customFields
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={`Required
|
|
60
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>>`} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
### entityOptions
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="property" type={`Required
|
|
65
|
+
<MemberInfo kind="property" type={`Required<Omit<<a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>, 'entityIdStrategy'>> & <a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>`} />
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
### importExportOptions
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="property" type={`Required
|
|
70
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/import-export/import-export-options#importexportoptions'>ImportExportOptions</a>>`} />
|
|
71
71
|
|
|
72
72
|
|
|
73
73
|
### jobQueueOptions
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="property" type={`Required
|
|
75
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/job-queue/job-queue-options#jobqueueoptions'>JobQueueOptions</a>>`} />
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
### schedulerOptions
|
|
79
79
|
|
|
80
|
-
<MemberInfo kind="property" type={`Required
|
|
80
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/scheduled-tasks/scheduler-options#scheduleroptions'>SchedulerOptions</a>>`} />
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
### orderOptions
|
|
84
84
|
|
|
85
|
-
<MemberInfo kind="property" type={`Required
|
|
85
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a>>`} />
|
|
86
86
|
|
|
87
87
|
|
|
88
88
|
### promotionOptions
|
|
89
89
|
|
|
90
|
-
<MemberInfo kind="property" type={`Required
|
|
90
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/promotions/promotion-options#promotionoptions'>PromotionOptions</a>>`} />
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
### shippingOptions
|
|
94
94
|
|
|
95
|
-
<MemberInfo kind="property" type={`Required
|
|
95
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/shipping/shipping-options#shippingoptions'>ShippingOptions</a>>`} />
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
### taxOptions
|
|
99
99
|
|
|
100
|
-
<MemberInfo kind="property" type={`Required
|
|
100
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/tax/tax-options#taxoptions'>TaxOptions</a>>`} />
|
|
101
101
|
|
|
102
102
|
|
|
103
103
|
### systemOptions
|
|
104
104
|
|
|
105
|
-
<MemberInfo kind="property" type={`Required
|
|
105
|
+
<MemberInfo kind="property" type={`Required<<a href='/reference/typescript-api/configuration/system-options#systemoptions'>SystemOptions</a>>`} />
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
|
|
@@ -38,7 +38,7 @@ interface SlugStrategy extends InjectableStrategy {
|
|
|
38
38
|
|
|
39
39
|
### generate
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => string | Promise
|
|
41
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, params: SlugGenerateParams) => string | Promise<string>`} />
|
|
42
42
|
|
|
43
43
|
Generates a slug from the input string.
|
|
44
44
|
|
|
@@ -94,7 +94,7 @@ will be randomly generated.
|
|
|
94
94
|
The default languageCode of the app.
|
|
95
95
|
### entityIdStrategy
|
|
96
96
|
|
|
97
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a
|
|
97
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a><any>`} default={`<a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>`} />
|
|
98
98
|
|
|
99
99
|
Defines the strategy used for both storing the primary keys of entities
|
|
100
100
|
in the database, and the encoding & decoding of those ids when exposing
|
|
@@ -122,7 +122,7 @@ Configuration settings governing how orders are handled.
|
|
|
122
122
|
Configures available payment processing methods.
|
|
123
123
|
### plugins
|
|
124
124
|
|
|
125
|
-
<MemberInfo kind="property" type={`Array
|
|
125
|
+
<MemberInfo kind="property" type={`Array<DynamicModule | Type<any>>`} default={`[]`} />
|
|
126
126
|
|
|
127
127
|
An array of plugins.
|
|
128
128
|
### promotionOptions
|
|
@@ -29,7 +29,7 @@ class CalculatedPropertySubscriber implements EntitySubscriberInterface {
|
|
|
29
29
|
|
|
30
30
|
### afterInsert
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="method" type={`(event: InsertEvent
|
|
32
|
+
<MemberInfo kind="method" type={`(event: InsertEvent<any>) => Promise<any> | void`} />
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
|
|
@@ -48,7 +48,7 @@ on the entity (e.g. an `Order` entity calculating the `totalQuantity` by adding
|
|
|
48
48
|
up the quantities of each `OrderLine`), then those relations should be defined here.
|
|
49
49
|
### query
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="property" type={`(qb: SelectQueryBuilder
|
|
51
|
+
<MemberInfo kind="property" type={`(qb: SelectQueryBuilder<any>) => void`} />
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
### expression
|
|
@@ -80,7 +80,7 @@ class EntityHydrator {
|
|
|
80
80
|
|
|
81
81
|
### hydrate
|
|
82
82
|
|
|
83
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, target: Entity, options: <a href='/reference/typescript-api/data-access/hydrate-options#hydrateoptions'>HydrateOptions</a
|
|
83
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, target: Entity, options: <a href='/reference/typescript-api/data-access/hydrate-options#hydrateoptions'>HydrateOptions</a><Entity>) => Promise<Entity>`} since="1.3.0" />
|
|
84
84
|
|
|
85
85
|
Hydrates (joins) the specified relations to the target entity instance. This method
|
|
86
86
|
mutates the `target` entity.
|
|
@@ -22,7 +22,7 @@ interface HydrateOptions<Entity extends VendureEntity> {
|
|
|
22
22
|
|
|
23
23
|
### relations
|
|
24
24
|
|
|
25
|
-
<MemberInfo kind="property" type={`Array
|
|
25
|
+
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><Entity>>`} />
|
|
26
26
|
|
|
27
27
|
Defines the relations to hydrate, using strings with dot notation to indicate
|
|
28
28
|
nested joins. If the entity already has a particular relation available, that relation
|
|
@@ -94,7 +94,7 @@ class ListQueryBuilder implements OnApplicationBootstrap {
|
|
|
94
94
|
|
|
95
95
|
### filterObjectHasProperty
|
|
96
96
|
|
|
97
|
-
<MemberInfo kind="method" type={`(filterObject: FP | NullOptionals
|
|
97
|
+
<MemberInfo kind="method" type={`(filterObject: FP | NullOptionals<FP> | null | undefined, property: keyof FP) => boolean`} />
|
|
98
98
|
|
|
99
99
|
Used to determine whether a list query `filter` object contains the
|
|
100
100
|
given property, either at the top level or nested inside a boolean
|
|
@@ -106,7 +106,7 @@ filter object contains that property, which then means we would need
|
|
|
106
106
|
to join that relation.
|
|
107
107
|
### build
|
|
108
108
|
|
|
109
|
-
<MemberInfo kind="method" type={`(entity: Type
|
|
109
|
+
<MemberInfo kind="method" type={`(entity: Type<T>, options: ListQueryOptions<T> = {}, extendedOptions: <a href='/reference/typescript-api/data-access/list-query-builder#extendedlistqueryoptions'>ExtendedListQueryOptions</a><T> = {}) => SelectQueryBuilder<T>`} />
|
|
110
110
|
|
|
111
111
|
|
|
112
112
|
|
|
@@ -147,12 +147,12 @@ type ExtendedListQueryOptions<T extends VendureEntity> = {
|
|
|
147
147
|
|
|
148
148
|
### where
|
|
149
149
|
|
|
150
|
-
<MemberInfo kind="property" type={`FindOptionsWhere
|
|
150
|
+
<MemberInfo kind="property" type={`FindOptionsWhere<T>`} />
|
|
151
151
|
|
|
152
152
|
|
|
153
153
|
### orderBy
|
|
154
154
|
|
|
155
|
-
<MemberInfo kind="property" type={`FindOneOptions
|
|
155
|
+
<MemberInfo kind="property" type={`FindOneOptions<T>['order']`} />
|
|
156
156
|
|
|
157
157
|
|
|
158
158
|
### entityAlias
|
|
@@ -55,14 +55,14 @@ performed with this connection will not be performed within any outer
|
|
|
55
55
|
transactions.
|
|
56
56
|
### getRepository
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(target: ObjectType
|
|
58
|
+
<MemberInfo kind="method" type={`(target: ObjectType<Entity> | EntitySchema<Entity> | string) => Repository<Entity>`} />
|
|
59
59
|
|
|
60
60
|
Returns a TypeORM repository. Note that when no RequestContext is supplied, the repository will not
|
|
61
61
|
be aware of any existing transaction. Therefore, calling this method without supplying a RequestContext
|
|
62
62
|
is discouraged without a deliberate reason.
|
|
63
63
|
### getRepository
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | undefined, target: ObjectType
|
|
65
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | undefined, target: ObjectType<Entity> | EntitySchema<Entity> | string, options?: { replicationMode?: ReplicationMode; }) => Repository<Entity>`} />
|
|
66
66
|
|
|
67
67
|
Returns a TypeORM repository which is bound to any existing transactions. It is recommended to _always_ pass
|
|
68
68
|
the RequestContext argument when possible, otherwise the queries will be executed outside of any
|
|
@@ -72,14 +72,14 @@ The `options` parameter allows specifying additional configurations, such as the
|
|
|
72
72
|
which determines whether the repository should interact with the master or replica database.
|
|
73
73
|
### getRepository
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="method" type={`(ctxOrTarget: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ObjectType
|
|
75
|
+
<MemberInfo kind="method" type={`(ctxOrTarget: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ObjectType<Entity> | EntitySchema<Entity> | string | undefined, maybeTarget?: ObjectType<Entity> | EntitySchema<Entity> | string, options?: { replicationMode?: ReplicationMode; }) => Repository<Entity>`} />
|
|
76
76
|
|
|
77
77
|
Returns a TypeORM repository. Depending on the parameters passed, it will either be transaction-aware
|
|
78
78
|
or not. If `RequestContext` is provided, the repository is bound to any ongoing transactions. The
|
|
79
79
|
`options` parameter allows further customization, such as selecting the replication mode (e.g., 'master').
|
|
80
80
|
### withTransaction
|
|
81
81
|
|
|
82
|
-
<MemberInfo kind="method" type={`(work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>)
|
|
82
|
+
<MemberInfo kind="method" type={`(work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`} since="1.3.0" />
|
|
83
83
|
|
|
84
84
|
Allows database operations to be wrapped in a transaction, ensuring that in the event of an error being
|
|
85
85
|
thrown at any point, the entire transaction will be rolled back and no changes will be saved.
|
|
@@ -120,12 +120,12 @@ private async transferCredit(outerCtx: RequestContext, fromId: ID, toId: ID, amo
|
|
|
120
120
|
```
|
|
121
121
|
### withTransaction
|
|
122
122
|
|
|
123
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>)
|
|
123
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, work: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`} />
|
|
124
124
|
|
|
125
125
|
|
|
126
126
|
### withTransaction
|
|
127
127
|
|
|
128
|
-
<MemberInfo kind="method" type={`(ctxOrWork: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>)
|
|
128
|
+
<MemberInfo kind="method" type={`(ctxOrWork: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>), maybeWork?: (ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<T>) => Promise<T>`} />
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
### startTransaction
|
|
@@ -151,19 +151,19 @@ and the internal TransactionInterceptor take care of this automatically. Use-cas
|
|
|
151
151
|
Transaction decorator in manual mode.
|
|
152
152
|
### getEntityOrThrow
|
|
153
153
|
|
|
154
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: Type
|
|
154
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entityType: Type<T>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: <a href='/reference/typescript-api/data-access/get-entity-or-throw-options#getentityorthrowoptions'>GetEntityOrThrowOptions</a><T> = {}) => Promise<T>`} />
|
|
155
155
|
|
|
156
156
|
Finds an entity of the given type by ID, or throws an `EntityNotFoundError` if none
|
|
157
157
|
is found.
|
|
158
158
|
### findOneInChannel
|
|
159
159
|
|
|
160
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type
|
|
160
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type<T>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: FindOneOptions<T> = {}) => `} />
|
|
161
161
|
|
|
162
162
|
Like the TypeOrm `Repository.findOne()` method, but limits the results to
|
|
163
163
|
the given Channel.
|
|
164
164
|
### findByIdsInChannel
|
|
165
165
|
|
|
166
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type
|
|
166
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, entity: Type<T>, ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[], channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: FindManyOptions<T>) => `} />
|
|
167
167
|
|
|
168
168
|
Like the TypeOrm `Repository.findByIds()` method, but limits the results to
|
|
169
169
|
the given Channel.
|
|
@@ -55,7 +55,7 @@ class DefaultSearchPlugin implements OnApplicationBootstrap, OnApplicationShutdo
|
|
|
55
55
|
|
|
56
56
|
### init
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions'>DefaultSearchPluginInitOptions</a>) => Type
|
|
58
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/default-search-plugin/default-search-plugin-init-options#defaultsearchplugininitoptions'>DefaultSearchPluginInitOptions</a>) => Type<<a href='/reference/typescript-api/default-search-plugin/#defaultsearchplugin'>DefaultSearchPlugin</a>>`} />
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
|
|
@@ -32,22 +32,22 @@ class MysqlSearchStrategy implements SearchStrategy {
|
|
|
32
32
|
|
|
33
33
|
### getFacetValueIds
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### getCollectionIds
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
40
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### getSearchResults
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
45
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### getTotalCount
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
50
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<number>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
|
|
@@ -32,22 +32,22 @@ class PostgresSearchStrategy implements SearchStrategy {
|
|
|
32
32
|
|
|
33
33
|
### getFacetValueIds
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### getCollectionIds
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
40
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### getSearchResults
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
45
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### getTotalCount
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
50
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<number>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
|
|
@@ -34,22 +34,22 @@ interface SearchStrategy extends InjectableStrategy {
|
|
|
34
34
|
|
|
35
35
|
### getSearchResults
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
37
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>`} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### getTotalCount
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
42
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<number>`} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### getFacetValueIds
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
47
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### getCollectionIds
|
|
51
51
|
|
|
52
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
52
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`} />
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
|
|
@@ -33,22 +33,22 @@ class SqliteSearchStrategy implements SearchStrategy {
|
|
|
33
33
|
|
|
34
34
|
### getFacetValueIds
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
36
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`} />
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
### getCollectionIds
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
41
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<Map<<a href='/reference/typescript-api/common/id#id'>ID</a>, number>>`} />
|
|
42
42
|
|
|
43
43
|
|
|
44
44
|
### getSearchResults
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
46
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<SearchResult[]>`} />
|
|
47
47
|
|
|
48
48
|
|
|
49
49
|
### getTotalCount
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise
|
|
51
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SearchInput, enabledOnly: boolean) => Promise<number>`} />
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
|
|
@@ -50,7 +50,7 @@ class Address extends VendureEntity implements HasCustomFields {
|
|
|
50
50
|
|
|
51
51
|
### constructor
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
53
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/address#address'>Address</a>>) => Address`} />
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
### customer
|
|
@@ -39,7 +39,7 @@ class Administrator extends VendureEntity implements SoftDeletable, HasCustomFie
|
|
|
39
39
|
|
|
40
40
|
### constructor
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
42
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/administrator#administrator'>Administrator</a>>) => Administrator`} />
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### deletedAt
|
|
@@ -25,7 +25,7 @@ class AnonymousSession extends Session {
|
|
|
25
25
|
|
|
26
26
|
### constructor
|
|
27
27
|
|
|
28
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
28
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a>>) => AnonymousSession`} />
|
|
29
29
|
|
|
30
30
|
|
|
31
31
|
|
|
@@ -51,7 +51,7 @@ class Asset extends VendureEntity implements Taggable, ChannelAware, HasCustomFi
|
|
|
51
51
|
|
|
52
52
|
### constructor
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
54
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/asset#asset'>Asset</a>>) => Asset`} />
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
### name
|
|
@@ -28,7 +28,7 @@ class AuthenticatedSession extends Session {
|
|
|
28
28
|
|
|
29
29
|
### constructor
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
31
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>>) => AuthenticatedSession`} />
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
### user
|
|
@@ -60,7 +60,7 @@ class ExternalAuthenticationMethod extends AuthenticationMethod {
|
|
|
60
60
|
|
|
61
61
|
### constructor
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
63
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/authentication-method#externalauthenticationmethod'>ExternalAuthenticationMethod</a>>) => ExternalAuthenticationMethod`} />
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
### strategy
|
|
@@ -114,7 +114,7 @@ class NativeAuthenticationMethod extends AuthenticationMethod {
|
|
|
114
114
|
|
|
115
115
|
### constructor
|
|
116
116
|
|
|
117
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
117
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a>>) => NativeAuthenticationMethod`} />
|
|
118
118
|
|
|
119
119
|
|
|
120
120
|
### identifier
|
|
@@ -90,7 +90,7 @@ class Channel extends VendureEntity {
|
|
|
90
90
|
|
|
91
91
|
### constructor
|
|
92
92
|
|
|
93
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
93
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>>) => Channel`} />
|
|
94
94
|
|
|
95
95
|
|
|
96
96
|
### code
|
|
@@ -58,7 +58,7 @@ class Collection extends VendureEntity implements Translatable, HasCustomFields,
|
|
|
58
58
|
|
|
59
59
|
### constructor
|
|
60
60
|
|
|
61
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
61
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>>) => Collection`} />
|
|
62
62
|
|
|
63
63
|
|
|
64
64
|
### isRoot
|
|
@@ -93,7 +93,7 @@ class Collection extends VendureEntity implements Translatable, HasCustomFields,
|
|
|
93
93
|
|
|
94
94
|
### translations
|
|
95
95
|
|
|
96
|
-
<MemberInfo kind="property" type={`Array
|
|
96
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>>>`} />
|
|
97
97
|
|
|
98
98
|
|
|
99
99
|
### featuredAsset
|
|
@@ -26,7 +26,7 @@ class Country extends Region {
|
|
|
26
26
|
|
|
27
27
|
### constructor
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
29
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/country#country'>Country</a>>) => Country`} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
### type
|
|
@@ -34,7 +34,7 @@ class CustomerGroup extends VendureEntity implements HasCustomFields {
|
|
|
34
34
|
|
|
35
35
|
### constructor
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
37
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>>) => CustomerGroup`} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### name
|
|
@@ -26,7 +26,7 @@ class CustomerHistoryEntry extends HistoryEntry {
|
|
|
26
26
|
|
|
27
27
|
### constructor
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="method" type={`(input: DeepPartial
|
|
29
|
+
<MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/customer-history-entry#customerhistoryentry'>CustomerHistoryEntry</a>>) => CustomerHistoryEntry`} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
### customer
|
|
@@ -53,7 +53,7 @@ class Customer extends VendureEntity implements ChannelAware, HasCustomFields, S
|
|
|
53
53
|
|
|
54
54
|
### constructor
|
|
55
55
|
|
|
56
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
56
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>) => Customer`} />
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
### deletedAt
|
|
@@ -44,7 +44,7 @@ class FacetValue extends VendureEntity implements Translatable, HasCustomFields,
|
|
|
44
44
|
|
|
45
45
|
### constructor
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="method" type={`(input?: DeepPartial
|
|
47
|
+
<MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>) => FacetValue`} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### name
|
|
@@ -59,7 +59,7 @@ class FacetValue extends VendureEntity implements Translatable, HasCustomFields,
|
|
|
59
59
|
|
|
60
60
|
### translations
|
|
61
61
|
|
|
62
|
-
<MemberInfo kind="property" type={`Array
|
|
62
|
+
<MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>>`} />
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
### facet
|