@vendure/docs 0.0.0-202601211609 → 0.0.0-202601221206
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.d.ts +2 -0
- package/dist/dates.generated.d.ts.map +1 -0
- package/dist/dates.generated.js +811 -0
- package/dist/dates.generated.js.map +1 -0
- package/dist/manifest.d.ts.map +1 -1
- package/dist/manifest.js +4 -2
- 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 +5 -5
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
- package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
- package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
- package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
- package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
- package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
- package/docs/reference/dashboard/page-layout/index.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +2 -2
- package/docs/reference/graphql-api/admin/_index.mdx +11 -0
- package/docs/reference/graphql-api/shop/_index.mdx +11 -0
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
- package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/index.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
- package/docs/reference/typescript-api/common/injector.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +14 -14
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -1
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +1 -1
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +1 -1
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +1 -1
- package/docs/reference/typescript-api/entities/role.mdx +1 -1
- package/docs/reference/typescript-api/entities/seller.mdx +1 -1
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
- package/docs/reference/typescript-api/entities/user.mdx +1 -1
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
- package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
- package/docs/reference/typescript-api/events/event-types.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
- package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +12 -12
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +3 -3
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
- package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
- package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
- package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
- package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
- package/docs/reference/typescript-api/services/country-service.mdx +7 -7
- package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
- package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
- package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
- package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +8 -8
- package/docs/reference/typescript-api/services/order-service.mdx +52 -52
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
- package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
- package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-service.mdx +13 -13
- package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
- package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
- package/docs/reference/typescript-api/services/province-service.mdx +5 -5
- package/docs/reference/typescript-api/services/role-service.mdx +11 -11
- package/docs/reference/typescript-api/services/search-service.mdx +2 -2
- package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
- package/docs/reference/typescript-api/services/session-service.mdx +8 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
- package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
- package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
- package/docs/reference/typescript-api/services/user-service.mdx +12 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
- package/package.json +10 -4
- package/src/dates.generated.ts +811 -0
- package/src/index.ts +2 -0
- package/src/manifest.ts +995 -0
|
@@ -37,12 +37,12 @@ interface TemplateLoader {
|
|
|
37
37
|
|
|
38
38
|
### loadTemplate
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) =>
|
|
40
|
+
<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => Promise<string>`} />
|
|
41
41
|
|
|
42
42
|
Load template and return it's content as a string
|
|
43
43
|
### loadPartials
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`() =>
|
|
45
|
+
<MemberInfo kind="method" type={`() => Promise<Partial[]>`} />
|
|
46
46
|
|
|
47
47
|
Load partials and return their contents.
|
|
48
48
|
This method is only called during initialization, i.e. during server startup.
|
|
@@ -74,12 +74,12 @@ class FileBasedTemplateLoader implements TemplateLoader {
|
|
|
74
74
|
|
|
75
75
|
### loadTemplate
|
|
76
76
|
|
|
77
|
-
<MemberInfo kind="method" type={`(_injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, _ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { type, templateName }: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) =>
|
|
77
|
+
<MemberInfo kind="method" type={`(_injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, _ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { type, templateName }: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loadtemplateinput'>LoadTemplateInput</a>) => Promise<string>`} />
|
|
78
78
|
|
|
79
79
|
|
|
80
80
|
### loadPartials
|
|
81
81
|
|
|
82
|
-
<MemberInfo kind="method" type={`() =>
|
|
82
|
+
<MemberInfo kind="method" type={`() => Promise<Partial[]>`} />
|
|
83
83
|
|
|
84
84
|
|
|
85
85
|
|
|
@@ -204,7 +204,7 @@ interface TestingTransportOptions {
|
|
|
204
204
|
|
|
205
205
|
### onSend
|
|
206
206
|
|
|
207
|
-
<MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a
|
|
207
|
+
<MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>) => void`} />
|
|
208
208
|
|
|
209
209
|
Callback to be invoked when an email would be sent.
|
|
210
210
|
|
|
@@ -61,7 +61,7 @@ class GraphiqlPlugin implements NestModule {
|
|
|
61
61
|
|
|
62
62
|
### options
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="property" type={
|
|
64
|
+
<MemberInfo kind="property" type={`Required<GraphiqlPluginOptions>`} />
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
### constructor
|
|
@@ -71,7 +71,7 @@ class GraphiqlPlugin implements NestModule {
|
|
|
71
71
|
|
|
72
72
|
### init
|
|
73
73
|
|
|
74
|
-
<MemberInfo kind="method" type={`(options: GraphiqlPluginOptions = {}) =>
|
|
74
|
+
<MemberInfo kind="method" type={`(options: GraphiqlPluginOptions = {}) => Type<<a href='/reference/core-plugins/graphiql-plugin/#graphiqlplugin'>GraphiqlPlugin</a>>`} />
|
|
75
75
|
|
|
76
76
|
|
|
77
77
|
### configure
|
|
@@ -85,7 +85,7 @@ When set to `'prod'`, the plugin will disable dev-mode features of the GraphQL A
|
|
|
85
85
|
- GraphQL playground
|
|
86
86
|
### skip
|
|
87
87
|
|
|
88
|
-
<MemberInfo kind="property" type={
|
|
88
|
+
<MemberInfo kind="property" type={`(context: GraphQLRequestContext<any>) => Promise<boolean> | boolean`} />
|
|
89
89
|
|
|
90
90
|
Allows you to skip the complexity check for certain requests.
|
|
91
91
|
|
|
@@ -35,7 +35,7 @@ class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
|
|
|
35
35
|
|
|
36
36
|
### init
|
|
37
37
|
|
|
38
|
-
<MemberInfo kind="method" type={`(injector: Injector) =>
|
|
38
|
+
<MemberInfo kind="method" type={`(injector: Injector) => Promise<void>`} />
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
### destroy
|
|
@@ -45,42 +45,42 @@ class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
|
|
|
45
45
|
|
|
46
46
|
### add
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(job:
|
|
48
|
+
<MemberInfo kind="method" type={`(job: Job<Data>) => Promise<Job<Data>>`} />
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
### cancelJob
|
|
52
52
|
|
|
53
|
-
<MemberInfo kind="method" type={`(jobId: string) =>
|
|
53
|
+
<MemberInfo kind="method" type={`(jobId: string) => Promise<Job | undefined>`} />
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
### findMany
|
|
57
57
|
|
|
58
|
-
<MemberInfo kind="method" type={`(options?: JobListOptions) =>
|
|
58
|
+
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<PaginatedList<Job>>`} />
|
|
59
59
|
|
|
60
60
|
|
|
61
61
|
### findManyById
|
|
62
62
|
|
|
63
|
-
<MemberInfo kind="method" type={`(ids: ID[]) =>
|
|
63
|
+
<MemberInfo kind="method" type={`(ids: ID[]) => Promise<Job[]>`} />
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
### findOne
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="method" type={`(id: ID) =>
|
|
68
|
+
<MemberInfo kind="method" type={`(id: ID) => Promise<Job | undefined>`} />
|
|
69
69
|
|
|
70
70
|
|
|
71
71
|
### removeSettledJobs
|
|
72
72
|
|
|
73
|
-
<MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) =>
|
|
73
|
+
<MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise<number>`} />
|
|
74
74
|
|
|
75
75
|
|
|
76
76
|
### start
|
|
77
77
|
|
|
78
|
-
<MemberInfo kind="method" type={`(queueName: string, process:
|
|
78
|
+
<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>`} />
|
|
79
79
|
|
|
80
80
|
|
|
81
81
|
### stop
|
|
82
82
|
|
|
83
|
-
<MemberInfo kind="method" type={`(queueName: string, process:
|
|
83
|
+
<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>`} />
|
|
84
84
|
|
|
85
85
|
|
|
86
86
|
|
|
@@ -29,21 +29,21 @@ creating a new Queue, Worker and Scheduler instance.
|
|
|
29
29
|
If omitted, it will attempt to connect to Redis at `127.0.0.1:6379`.
|
|
30
30
|
### queueOptions
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="property" type={
|
|
32
|
+
<MemberInfo kind="property" type={`Omit<QueueOptions, 'connection'>`} />
|
|
33
33
|
|
|
34
34
|
Additional options used when instantiating the BullMQ
|
|
35
35
|
Queue instance.
|
|
36
36
|
See the [BullMQ QueueOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.queueoptions.md)
|
|
37
37
|
### workerOptions
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="property" type={
|
|
39
|
+
<MemberInfo kind="property" type={`Omit<WorkerOptions, 'connection'>`} />
|
|
40
40
|
|
|
41
41
|
Additional options used when instantiating the BullMQ
|
|
42
42
|
Worker instance.
|
|
43
43
|
See the [BullMQ WorkerOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.workeroptions.md)
|
|
44
44
|
### setRetries
|
|
45
45
|
|
|
46
|
-
<MemberInfo kind="property" type={
|
|
46
|
+
<MemberInfo kind="property" type={`(queueName: string, job: Job) => number`} since="1.3.0" />
|
|
47
47
|
|
|
48
48
|
When a job is added to the JobQueue using `JobQueue.add()`, the calling
|
|
49
49
|
code may specify the number of retries in case of failure. This option allows
|
|
@@ -65,7 +65,7 @@ setRetries: (queueName, job) => {
|
|
|
65
65
|
```
|
|
66
66
|
### setBackoff
|
|
67
67
|
|
|
68
|
-
<MemberInfo kind="property" type={
|
|
68
|
+
<MemberInfo kind="property" type={`(queueName: string, job: Job) => <a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#backoffoptions'>BackoffOptions</a> | undefined`} default={`'exponential', 1000`} since="1.3.0" />
|
|
69
69
|
|
|
70
70
|
This allows you to specify the backoff settings when a failed job gets retried.
|
|
71
71
|
In other words, this determines how much time should pass before attempting to
|
|
@@ -84,7 +84,7 @@ setBackoff: (queueName, job) => {
|
|
|
84
84
|
```
|
|
85
85
|
### setJobOptions
|
|
86
86
|
|
|
87
|
-
<MemberInfo kind="property" type={
|
|
87
|
+
<MemberInfo kind="property" type={`(queueName: string, job: Job) => BullJobsOptions`} since="3.2.0" />
|
|
88
88
|
|
|
89
89
|
This allows you to specify additional options for a job when it is added to the queue.
|
|
90
90
|
The object returned is the BullMQ [JobsOptions](https://api.docs.bullmq.io/types/v5.JobsOptions.html)
|
|
@@ -42,17 +42,17 @@ class PubSubJobQueueStrategy extends InjectableJobQueueStrategy implements JobQu
|
|
|
42
42
|
|
|
43
43
|
### add
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="method" type={`(job:
|
|
45
|
+
<MemberInfo kind="method" type={`(job: Job<Data>) => Promise<Job<Data>>`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### start
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(queueName: string, process:
|
|
50
|
+
<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => `} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### stop
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="method" type={`(queueName: string, process:
|
|
55
|
+
<MemberInfo kind="method" type={`(queueName: string, process: (job: Job<Data>) => Promise<any>) => `} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
|
|
@@ -23,7 +23,7 @@ class PubSubPlugin {
|
|
|
23
23
|
|
|
24
24
|
### init
|
|
25
25
|
|
|
26
|
-
<MemberInfo kind="method" type={`(options: PubSubOptions) =>
|
|
26
|
+
<MemberInfo kind="method" type={`(options: PubSubOptions) => Type<<a href='/reference/core-plugins/job-queue-plugin/pub-sub-plugin#pubsubplugin'>PubSubPlugin</a>>`} />
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
|
|
@@ -247,7 +247,7 @@ class BraintreePlugin {
|
|
|
247
247
|
|
|
248
248
|
### init
|
|
249
249
|
|
|
250
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreepluginoptions'>BraintreePluginOptions</a>) =>
|
|
250
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreepluginoptions'>BraintreePluginOptions</a>) => Type<<a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreeplugin'>BraintreePlugin</a>>`} />
|
|
251
251
|
|
|
252
252
|
|
|
253
253
|
|
|
@@ -285,7 +285,7 @@ Since v1.8, it is possible to override vaulting on a per-payment basis by passin
|
|
|
285
285
|
`generateBraintreeClientToken` mutation.
|
|
286
286
|
### extractMetadata
|
|
287
287
|
|
|
288
|
-
<MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a
|
|
288
|
+
<MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a>) => PaymentMetadata`} since="1.7.0" />
|
|
289
289
|
|
|
290
290
|
Allows you to configure exactly what information from the Braintree
|
|
291
291
|
[Transaction object](https://developer.paypal.com/braintree/docs/reference/response/transaction#result-object) (which is returned by the
|
|
@@ -161,7 +161,7 @@ The host of your Vendure server, e.g. `'https://my-vendure.io'`.
|
|
|
161
161
|
This is used by Mollie to send webhook events to the Vendure server
|
|
162
162
|
### enabledPaymentMethodsParams
|
|
163
163
|
|
|
164
|
-
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a
|
|
164
|
+
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a> | null, ) => AdditionalEnabledPaymentMethodsParams | Promise<AdditionalEnabledPaymentMethodsParams>`} since="2.2.0" />
|
|
165
165
|
|
|
166
166
|
Provide additional parameters to the Mollie enabled payment methods API call. By default,
|
|
167
167
|
the plugin will already pass the `resource` parameter.
|
|
@@ -163,7 +163,7 @@ class StripePlugin {
|
|
|
163
163
|
|
|
164
164
|
### init
|
|
165
165
|
|
|
166
|
-
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a>) =>
|
|
166
|
+
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a>) => Type<<a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripeplugin'>StripePlugin</a>>`} />
|
|
167
167
|
|
|
168
168
|
Initialize the Stripe payment plugin
|
|
169
169
|
|
|
@@ -212,7 +212,7 @@ to be used with the same PaymentIntent. This is done by adding a custom field to
|
|
|
212
212
|
the Stripe customer ID, so switching this on will require a database migration / synchronization.
|
|
213
213
|
### metadata
|
|
214
214
|
|
|
215
|
-
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a
|
|
215
|
+
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, ) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>`} since="1.9.7" />
|
|
216
216
|
|
|
217
217
|
Attach extra metadata to Stripe payment intent creation call.
|
|
218
218
|
|
|
@@ -242,7 +242,7 @@ Note: If the `paymentIntentCreateParams` is also used and returns a `metadata` k
|
|
|
242
242
|
returned by both functions will be merged.
|
|
243
243
|
### paymentIntentCreateParams
|
|
244
244
|
|
|
245
|
-
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a
|
|
245
|
+
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, ) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>`} since="2.1.0" />
|
|
246
246
|
|
|
247
247
|
Provide additional parameters to the Stripe payment intent creation. By default,
|
|
248
248
|
the plugin will already pass the `amount`, `currency`, `customer` and `automatic_payment_methods: { enabled: true }` parameters.
|
|
@@ -270,7 +270,7 @@ export const config: VendureConfig = {
|
|
|
270
270
|
```
|
|
271
271
|
### requestOptions
|
|
272
272
|
|
|
273
|
-
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a
|
|
273
|
+
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, ) => AdditionalRequestOptions | Promise<AdditionalRequestOptions>`} since="3.1.0" />
|
|
274
274
|
|
|
275
275
|
Provide additional options to the Stripe payment intent creation. By default,
|
|
276
276
|
the plugin will already pass the `idempotencyKey` parameter.
|
|
@@ -298,7 +298,7 @@ export const config: VendureConfig = {
|
|
|
298
298
|
```
|
|
299
299
|
### customerCreateParams
|
|
300
300
|
|
|
301
|
-
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a
|
|
301
|
+
<MemberInfo kind="property" type={`( injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, ) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>`} since="2.1.0" />
|
|
302
302
|
|
|
303
303
|
Provide additional parameters to the Stripe customer creation. By default,
|
|
304
304
|
the plugin will already pass the `email` and `name` parameters.
|
|
@@ -21,7 +21,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
|
|
|
21
21
|
|
|
22
22
|
### eventType
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="property" type={
|
|
24
|
+
<MemberInfo kind="property" type={`Type<Event>`} />
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
### bufferTimeMs
|
|
@@ -36,7 +36,7 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
|
|
|
36
36
|
|
|
37
37
|
### constructor
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a
|
|
39
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a><Event>) => PurgeRule`} />
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
|
|
@@ -62,7 +62,7 @@ interface PurgeRuleConfig<Event extends VendureEvent> {
|
|
|
62
62
|
|
|
63
63
|
### eventType
|
|
64
64
|
|
|
65
|
-
<MemberInfo kind="property" type={
|
|
65
|
+
<MemberInfo kind="property" type={`Type<Event>`} />
|
|
66
66
|
|
|
67
67
|
Specifies which VendureEvent will trigger this purge rule.
|
|
68
68
|
### bufferTime
|
|
@@ -73,7 +73,7 @@ How long to buffer events for in milliseconds before executing the handler. This
|
|
|
73
73
|
us to efficiently batch calls to the Stellate Purge API.
|
|
74
74
|
### handler
|
|
75
75
|
|
|
76
|
-
<MemberInfo kind="property" type={`(handlerArgs: { events: Event[]; stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>; injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a
|
|
76
|
+
<MemberInfo kind="property" type={`(handlerArgs: { events: Event[]; stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>; injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>; }) => void | Promise<void>`} />
|
|
77
77
|
|
|
78
78
|
The function to invoke when the specified event is published. This function should use the
|
|
79
79
|
<DocsLink href="/reference/core-plugins/stellate-plugin/stellate-service#stellateservice">StellateService</DocsLink> instance to call the Stellate Purge API.
|
|
@@ -38,7 +38,7 @@ Purges the cache for the given Products.
|
|
|
38
38
|
Purges the cache for the given ProductVariants.
|
|
39
39
|
### purgeSearchResults
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="method" type={`(items:
|
|
41
|
+
<MemberInfo kind="method" type={`(items: Array<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> | <a href='/reference/typescript-api/entities/product#product'>Product</a>>) => `} />
|
|
42
42
|
|
|
43
43
|
Purges the cache for SearchResults which contain the given Products or ProductVariants.
|
|
44
44
|
### purgeAllOfType
|
|
@@ -75,7 +75,7 @@ When set to `true`, the SDK will log spans to the console instead of sending the
|
|
|
75
75
|
exporter. This should just be used for debugging purposes.
|
|
76
76
|
### config
|
|
77
77
|
|
|
78
|
-
<MemberInfo kind="property" type={
|
|
78
|
+
<MemberInfo kind="property" type={`Partial<NodeSDKConfiguration>`} />
|
|
79
79
|
|
|
80
80
|
The configuration object for the OpenTelemetry Node SDK.
|
|
81
81
|
|
|
@@ -33,9 +33,9 @@ Parameters
|
|
|
33
33
|
|
|
34
34
|
### target
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="parameter" type={
|
|
36
|
+
<MemberInfo kind="parameter" type={`Type<T>`} />
|
|
37
37
|
|
|
38
38
|
### hooks
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="parameter" type={
|
|
40
|
+
<MemberInfo kind="parameter" type={`MethodHooksForType<T>`} />
|
|
41
41
|
|
|
@@ -34,7 +34,7 @@ TelemetryPlugin.init({
|
|
|
34
34
|
```
|
|
35
35
|
### methodHooks
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="property" type={
|
|
37
|
+
<MemberInfo kind="property" type={`Array<MethodHookConfig<any>>`} experimental="true" />
|
|
38
38
|
|
|
39
39
|
**Status: Developer Preview**
|
|
40
40
|
|
|
@@ -52,7 +52,7 @@ interface AssetGalleryProps {
|
|
|
52
52
|
|
|
53
53
|
### onSelect
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a
|
|
55
|
+
<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### selectable
|
|
@@ -95,7 +95,7 @@ Whether the gallery should show a header.
|
|
|
95
95
|
The class name to apply to the gallery.
|
|
96
96
|
### onFilesDropped
|
|
97
97
|
|
|
98
|
-
<MemberInfo kind="property" type={
|
|
98
|
+
<MemberInfo kind="property" type={`(files: File[]) => void`} />
|
|
99
99
|
|
|
100
100
|
The function to call when files are dropped.
|
|
101
101
|
### bulkActions
|
|
@@ -110,7 +110,7 @@ The bulk actions to display in the gallery.
|
|
|
110
110
|
Whether the gallery should display bulk actions.
|
|
111
111
|
### onPageSizeChange
|
|
112
112
|
|
|
113
|
-
<MemberInfo kind="property" type={
|
|
113
|
+
<MemberInfo kind="property" type={`(pageSize: number) => void`} />
|
|
114
114
|
|
|
115
115
|
The function to call when the page size changes.
|
|
116
116
|
|
|
@@ -39,12 +39,12 @@ interface AssetPickerDialogProps {
|
|
|
39
39
|
Whether the dialog is open.
|
|
40
40
|
### onClose
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={
|
|
42
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
43
43
|
|
|
44
44
|
The function to call when the dialog is closed.
|
|
45
45
|
### onSelect
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a
|
|
47
|
+
<MemberInfo kind="property" type={`(assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]) => void`} />
|
|
48
48
|
|
|
49
49
|
The function to call when assets are selected.
|
|
50
50
|
### multiSelect
|
|
@@ -40,5 +40,5 @@ Parameters
|
|
|
40
40
|
|
|
41
41
|
### props
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="parameter" type={
|
|
43
|
+
<MemberInfo kind="parameter" type={`Readonly<{ label: string | React.ReactNode; id?: string; href?: string; disabled?: boolean; search?: Record<string, string>; className?: string; }>`} />
|
|
44
44
|
|
|
@@ -38,7 +38,7 @@ interface FacetValueSelectorProps {
|
|
|
38
38
|
|
|
39
39
|
### onValueSelect
|
|
40
40
|
|
|
41
|
-
<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a
|
|
41
|
+
<MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>) => void`} />
|
|
42
42
|
|
|
43
43
|
The function to call when a facet value is selected.
|
|
44
44
|
|
|
@@ -24,7 +24,7 @@ Parameters
|
|
|
24
24
|
|
|
25
25
|
### props
|
|
26
26
|
|
|
27
|
-
<MemberInfo kind="parameter" type={
|
|
27
|
+
<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>>`} />
|
|
28
28
|
|
|
29
29
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/permission-guard.tsx" sourceLine="12" packageName="@vendure/dashboard" since="3.4.0" />
|
|
30
30
|
|
|
@@ -107,7 +107,7 @@ The fallback to show if no asset is provided. If no fallback is provided,
|
|
|
107
107
|
a default placeholder will be shown.
|
|
108
108
|
### ref
|
|
109
109
|
|
|
110
|
-
<MemberInfo kind="property" type={
|
|
110
|
+
<MemberInfo kind="property" type={`React.Ref<HTMLImageElement>`} />
|
|
111
111
|
|
|
112
112
|
The ref to the image element.
|
|
113
113
|
|
|
@@ -15,7 +15,7 @@ Parameters
|
|
|
15
15
|
|
|
16
16
|
### props
|
|
17
17
|
|
|
18
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a
|
|
18
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a><T, C, U>`} />
|
|
19
19
|
|
|
20
20
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="43" packageName="@vendure/dashboard" since="3.3.0" />
|
|
21
21
|
|
|
@@ -54,7 +54,7 @@ A unique identifier for the page.
|
|
|
54
54
|
The Tanstack Router route used to navigate to this page.
|
|
55
55
|
### title
|
|
56
56
|
|
|
57
|
-
<MemberInfo kind="property" type={
|
|
57
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => string`} />
|
|
58
58
|
|
|
59
59
|
The title of the page.
|
|
60
60
|
### queryDocument
|
|
@@ -74,7 +74,7 @@ The mutation document used to create the entity.
|
|
|
74
74
|
The mutation document used to update the entity.
|
|
75
75
|
### setValuesForUpdate
|
|
76
76
|
|
|
77
|
-
<MemberInfo kind="property" type={
|
|
77
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => VariablesOf<U>['input']`} />
|
|
78
78
|
|
|
79
79
|
A function that sets the values for the update input type based on the entity.
|
|
80
80
|
|
|
@@ -74,7 +74,7 @@ Parameters
|
|
|
74
74
|
|
|
75
75
|
### options
|
|
76
76
|
|
|
77
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a
|
|
77
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a><T, C, U, EntityField, VarNameCreate, VarNameUpdate>`} />
|
|
78
78
|
|
|
79
79
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="46" packageName="@vendure/dashboard" since="3.3.0" />
|
|
80
80
|
|
|
@@ -143,27 +143,27 @@ The document to create the entity.
|
|
|
143
143
|
The document to update the entity.
|
|
144
144
|
### setValuesForUpdate
|
|
145
145
|
|
|
146
|
-
<MemberInfo kind="property" type={
|
|
146
|
+
<MemberInfo kind="property" type={`( entity: NonNullable<ResultOf<T>[EntityField]>, ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>`} />
|
|
147
147
|
|
|
148
148
|
The function to set the values for the update document.
|
|
149
149
|
### transformCreateInput
|
|
150
150
|
|
|
151
|
-
<MemberInfo kind="property" type={
|
|
151
|
+
<MemberInfo kind="property" type={`(input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate]`} />
|
|
152
152
|
|
|
153
153
|
|
|
154
154
|
### transformUpdateInput
|
|
155
155
|
|
|
156
|
-
<MemberInfo kind="property" type={
|
|
156
|
+
<MemberInfo kind="property" type={`(input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate]`} />
|
|
157
157
|
|
|
158
158
|
|
|
159
159
|
### onSuccess
|
|
160
160
|
|
|
161
|
-
<MemberInfo kind="property" type={
|
|
161
|
+
<MemberInfo kind="property" type={`(entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void`} />
|
|
162
162
|
|
|
163
163
|
The function to call when the update is successful.
|
|
164
164
|
### onError
|
|
165
165
|
|
|
166
|
-
<MemberInfo kind="property" type={
|
|
166
|
+
<MemberInfo kind="property" type={`(error: unknown) => void`} />
|
|
167
167
|
|
|
168
168
|
The function to call when the update is successful.
|
|
169
169
|
|
|
@@ -188,17 +188,17 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
|
|
|
188
188
|
|
|
189
189
|
### form
|
|
190
190
|
|
|
191
|
-
<MemberInfo kind="property" type={
|
|
191
|
+
<MemberInfo kind="property" type={`UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>`} />
|
|
192
192
|
|
|
193
193
|
|
|
194
194
|
### submitHandler
|
|
195
195
|
|
|
196
|
-
<MemberInfo kind="property" type={
|
|
196
|
+
<MemberInfo kind="property" type={`(event: FormEvent<HTMLFormElement>) => void`} />
|
|
197
197
|
|
|
198
198
|
|
|
199
199
|
### entity
|
|
200
200
|
|
|
201
|
-
<MemberInfo kind="property" type={
|
|
201
|
+
<MemberInfo kind="property" type={`DetailPageEntity<T, EntityField>`} />
|
|
202
202
|
|
|
203
203
|
|
|
204
204
|
### isPending
|
|
@@ -208,12 +208,12 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
|
|
|
208
208
|
|
|
209
209
|
### refreshEntity
|
|
210
210
|
|
|
211
|
-
<MemberInfo kind="property" type={
|
|
211
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
212
212
|
|
|
213
213
|
|
|
214
214
|
### resetForm
|
|
215
215
|
|
|
216
|
-
<MemberInfo kind="property" type={
|
|
216
|
+
<MemberInfo kind="property" type={`() => void`} />
|
|
217
217
|
|
|
218
218
|
|
|
219
219
|
|
|
@@ -36,7 +36,7 @@ Parameters
|
|
|
36
36
|
|
|
37
37
|
### options
|
|
38
38
|
|
|
39
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a
|
|
39
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a><T, VarName, E>`} />
|
|
40
40
|
|
|
41
41
|
<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="24" packageName="@vendure/dashboard" since="3.3.0" />
|
|
42
42
|
|
|
@@ -83,12 +83,12 @@ The entity to use to generate the form.
|
|
|
83
83
|
|
|
84
84
|
### setValues
|
|
85
85
|
|
|
86
|
-
<MemberInfo kind="property" type={
|
|
86
|
+
<MemberInfo kind="property" type={`( entity: NonNullable<E>, ) => WithLooseCustomFields< VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T> >`} />
|
|
87
87
|
|
|
88
88
|
|
|
89
89
|
### onSubmit
|
|
90
90
|
|
|
91
|
-
<MemberInfo kind="property" type={
|
|
91
|
+
<MemberInfo kind="property" type={`( values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>, ) => void`} />
|
|
92
92
|
|
|
93
93
|
|
|
94
94
|
|
|
@@ -28,7 +28,7 @@ interface DashboardActionBarItem {
|
|
|
28
28
|
The ID of the page where the action bar item should be displayed.
|
|
29
29
|
### component
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="property" type={
|
|
31
|
+
<MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`} />
|
|
32
32
|
|
|
33
33
|
A React component that will be rendered in the action bar. Typically, you would use
|
|
34
34
|
the default Shadcn `<Button>` component.
|