@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dates.generated.js +385 -385
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
- package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
- package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
- package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
- package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
- package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
- package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
- package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
- package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
- package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
- package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
- package/docs/reference/dashboard/page-layout/index.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
- package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +4 -4
- package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
- package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
- package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/index.mdx +2 -2
- package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
- package/docs/reference/typescript-api/common/id.mdx +1 -1
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/middleware.mdx +1 -1
- package/docs/reference/typescript-api/common/permission.mdx +1 -1
- package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
- package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
- package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
- package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
- package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
- package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
- package/docs/reference/typescript-api/entities/address.mdx +2 -2
- package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
- package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +3 -3
- package/docs/reference/typescript-api/entities/country.mdx +4 -4
- package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/customer.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
- package/docs/reference/typescript-api/entities/facet.mdx +4 -4
- package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +9 -9
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/payment.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
- package/docs/reference/typescript-api/entities/product.mdx +3 -3
- package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
- package/docs/reference/typescript-api/entities/province.mdx +2 -2
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +4 -4
- package/docs/reference/typescript-api/entities/role.mdx +3 -3
- package/docs/reference/typescript-api/entities/seller.mdx +3 -3
- package/docs/reference/typescript-api/entities/session.mdx +3 -3
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
- package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
- package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
- package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
- package/docs/reference/typescript-api/entities/user.mdx +3 -3
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +2 -2
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
- package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
- package/docs/reference/typescript-api/events/event-types.mdx +109 -109
- package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
- package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
- package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
- package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
- package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
- package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
- package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
- package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
- package/docs/reference/typescript-api/logger/index.mdx +3 -3
- package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
- package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
- package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
- package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
- package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
- package/docs/reference/typescript-api/money/round-money.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
- package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
- package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
- package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
- package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
- package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
- package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
- package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
- package/docs/reference/typescript-api/request/request-context.mdx +5 -5
- package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
- package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
- package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
- package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
- package/docs/reference/typescript-api/services/history-service.mdx +1 -1
- package/docs/reference/typescript-api/services/order-service.mdx +24 -24
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
- package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/session-service.mdx +4 -4
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +8 -8
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
- package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
- package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
- package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
- package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
- package/package.json +1 -1
- package/src/dates.generated.ts +385 -385
|
@@ -4,8 +4,8 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="90" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
Providers & data available to the `onClick` & `buttonState` functions of an
|
|
8
|
-
|
|
7
|
+
Providers & data available to the `onClick` & `buttonState` functions of an [ActionBarItem](/reference/admin-ui-api/action-bar/action-bar-item#actionbaritem),
|
|
8
|
+
[ActionBarDropdownMenuItem](/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item#actionbardropdownmenuitem) or [NavMenuItem](/reference/admin-ui-api/nav-menu/nav-menu-item#navmenuitem).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
interface ActionBarContext {
|
|
@@ -71,7 +71,7 @@ set.
|
|
|
71
71
|
<MemberInfo kind="property" type={`string | string[]`} />
|
|
72
72
|
|
|
73
73
|
Control the display of this item based on the user permissions. Note: if you attempt to pass a
|
|
74
|
-
|
|
74
|
+
[PermissionDefinition](/reference/typescript-api/auth/permission-definition#permissiondefinition) object, you will get a compilation error. Instead, pass the plain
|
|
75
75
|
string version. For example, if the permission is defined as:
|
|
76
76
|
|
|
77
77
|
```ts
|
|
@@ -83,7 +83,7 @@ set.
|
|
|
83
83
|
<MemberInfo kind="property" type={`string | string[]`} />
|
|
84
84
|
|
|
85
85
|
Control the display of this item based on the user permissions. Note: if you attempt to pass a
|
|
86
|
-
|
|
86
|
+
[PermissionDefinition](/reference/typescript-api/auth/permission-definition#permissiondefinition) object, you will get a compilation error. Instead, pass the plain
|
|
87
87
|
string version. For example, if the permission is defined as:
|
|
88
88
|
|
|
89
89
|
```ts
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="107" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
7
|
The valid locationIds for registering action bar items. For a list of
|
|
8
|
-
values, see
|
|
8
|
+
values, see [PageLocationId](/reference/admin-ui-api/action-bar/page-location-id#pagelocationid).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
type ActionBarLocationId = PageLocationId
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="289" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
A function which returns the router link for an
|
|
7
|
+
A function which returns the router link for an [ActionBarItem](/reference/admin-ui-api/action-bar/action-bar-item#actionbaritem) or [NavMenuItem](/reference/admin-ui-api/nav-menu/nav-menu-item#navmenuitem).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
type RouterLinkDefinition = ((route: ActivatedRoute, context: ActionBarContext) => any[]) | any[]
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/alerts/alerts.service.ts" sourceLine="29" packageName="@vendure/admin-ui" since="2.2.0" />
|
|
6
6
|
|
|
7
7
|
The context object which is passed to the `check`, `isAlert`, `label` and `action` functions of an
|
|
8
|
-
|
|
8
|
+
[AlertConfig](/reference/admin-ui-api/alerts/alert-config#alertconfig) object.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
interface AlertContext {
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-alert.ts" sourceLine="12" packageName="@vendure/admin-ui" since="2.2.0" />
|
|
6
6
|
|
|
7
7
|
Registers an alert which can be displayed in the Admin UI alert dropdown in the top bar.
|
|
8
|
-
The alert is configured using the
|
|
8
|
+
The alert is configured using the [AlertConfig](/reference/admin-ui-api/alerts/alert-config#alertconfig) object.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
function registerAlert(config: AlertConfig): void
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
Configures a bulk action which can be performed on all selected items in a list view.
|
|
8
8
|
|
|
9
|
-
For a full example, see the
|
|
9
|
+
For a full example, see the [registerBulkAction](/reference/admin-ui-api/bulk-actions/register-bulk-action#registerbulkaction) docs.
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
interface BulkAction<ItemType = any, ComponentType = any> {
|
|
@@ -191,7 +191,7 @@ interface BulkActionClickContext<ItemType, ComponentType> extends BulkActionFunc
|
|
|
191
191
|
event: MouseEvent;
|
|
192
192
|
}
|
|
193
193
|
```
|
|
194
|
-
* Extends:
|
|
194
|
+
* Extends: [`BulkActionFunctionContext`](/reference/admin-ui-api/bulk-actions/bulk-action#bulkactionfunctioncontext)`<ItemType, ComponentType>`
|
|
195
195
|
|
|
196
196
|
|
|
197
197
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-bulk-action.ts" sourceLine="52" packageName="@vendure/admin-ui" since="1.8.0" />
|
|
6
6
|
|
|
7
|
-
Registers a custom
|
|
7
|
+
Registers a custom [BulkAction](/reference/admin-ui-api/bulk-actions/bulk-action#bulkaction) which can be invoked from the bulk action menu
|
|
8
8
|
of any supported list view.
|
|
9
9
|
|
|
10
10
|
This allows you to provide custom functionality that can operate on any of the selected
|
|
@@ -49,7 +49,7 @@ class AssetPickerDialogComponent implements OnInit, AfterViewInit, OnDestroy, Di
|
|
|
49
49
|
createAssets(files: File[]) => ;
|
|
50
50
|
}
|
|
51
51
|
```
|
|
52
|
-
* Implements: OnInit, AfterViewInit, OnDestroy,
|
|
52
|
+
* Implements: OnInit, AfterViewInit, OnDestroy, [`Dialog`](/reference/admin-ui-api/services/modal-service#dialog)`<`[`Asset`](/reference/typescript-api/entities/asset#asset)`[]>`
|
|
53
53
|
|
|
54
54
|
|
|
55
55
|
|
|
@@ -5,9 +5,9 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table/data-table.component.ts" sourceLine="86" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
7
|
A table for displaying PaginatedList results. It is designed to be used inside components which
|
|
8
|
-
extend the
|
|
8
|
+
extend the [BaseListComponent](/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent) class.
|
|
9
9
|
|
|
10
|
-
**Deprecated** This component is deprecated. Use the
|
|
10
|
+
**Deprecated** This component is deprecated. Use the [DataTable2Component](/reference/admin-ui-api/components/data-table2component#datatable2component) instead.
|
|
11
11
|
|
|
12
12
|
*Example*
|
|
13
13
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table2.component.ts" sourceLine="101" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
7
|
A table for displaying PaginatedList results. It is designed to be used inside components which
|
|
8
|
-
extend the
|
|
8
|
+
extend the [BaseListComponent](/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent) or [TypedBaseListComponent](/reference/admin-ui-api/list-detail-views/typed-base-list-component#typedbaselistcomponent) class.
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
11
11
|
|
package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx
CHANGED
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-detail-component/custom-detail-component-types.ts" sourceLine="25" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
Configures a
|
|
7
|
+
Configures a [CustomDetailComponent](/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent) to be placed in the given location.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface CustomDetailComponentConfig {
|
package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx
CHANGED
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/component-registry-types.ts" sourceLine="115" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
The valid locations for embedding a
|
|
7
|
+
The valid locations for embedding a [CustomDetailComponent](/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
type CustomDetailComponentLocationId = | 'administrator-profile'
|
package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx
CHANGED
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-custom-detail-component.ts" sourceLine="57" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
Registers a
|
|
7
|
+
Registers a [CustomDetailComponent](/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent) to be placed in a given location. This allows you
|
|
8
8
|
to embed any type of custom Angular component in the entity detail pages of the Admin UI.
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
@@ -4,14 +4,14 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="64" packageName="@vendure/admin-ui" since="1.9.0" />
|
|
6
6
|
|
|
7
|
-
Used to implement a
|
|
7
|
+
Used to implement a [HistoryEntryComponent](/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent) which requires access to the Customer object.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface CustomerHistoryEntryComponent extends HistoryEntryComponent {
|
|
11
11
|
customer: CustomerFragment;
|
|
12
12
|
}
|
|
13
13
|
```
|
|
14
|
-
* Extends:
|
|
14
|
+
* Extends: [`HistoryEntryComponent`](/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent)
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
|
package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx
CHANGED
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
This interface should be implemented by components intended to display a history entry in the
|
|
8
8
|
Order or Customer history timeline. If the component needs access to the Order or Customer object itself,
|
|
9
|
-
you should implement
|
|
9
|
+
you should implement [OrderHistoryEntryComponent](/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component#orderhistoryentrycomponent) or [CustomerHistoryEntryComponent](/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component#customerhistoryentrycomponent) respectively.
|
|
10
10
|
|
|
11
11
|
```ts title="Signature"
|
|
12
12
|
interface HistoryEntryComponent {
|
package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx
CHANGED
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="75" packageName="@vendure/admin-ui" since="1.9.0" />
|
|
6
6
|
|
|
7
|
-
Configuration for registering a custom
|
|
7
|
+
Configuration for registering a custom [HistoryEntryComponent](/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface HistoryEntryConfig {
|
|
@@ -4,14 +4,14 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/custom-history-entry-component/history-entry-component-types.ts" sourceLine="53" packageName="@vendure/admin-ui" since="1.9.0" />
|
|
6
6
|
|
|
7
|
-
Used to implement a
|
|
7
|
+
Used to implement a [HistoryEntryComponent](/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent) which requires access to the Order object.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface OrderHistoryEntryComponent extends HistoryEntryComponent {
|
|
11
11
|
order: OrderDetailFragment;
|
|
12
12
|
}
|
|
13
13
|
```
|
|
14
|
-
* Extends:
|
|
14
|
+
* Extends: [`HistoryEntryComponent`](/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent)
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-history-entry-component.ts" sourceLine="68" packageName="@vendure/admin-ui" since="1.9.0" />
|
|
6
6
|
|
|
7
|
-
Registers a
|
|
7
|
+
Registers a [HistoryEntryComponent](/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent) for displaying history entries in the Order/Customer
|
|
8
8
|
history timeline.
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
@@ -14,7 +14,7 @@ class BooleanFormInputComponent implements FormInputComponent {
|
|
|
14
14
|
config: DefaultFormComponentConfig<'boolean-form-input'>;
|
|
15
15
|
}
|
|
16
16
|
```
|
|
17
|
-
* Implements:
|
|
17
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
|
|
@@ -58,7 +58,7 @@ class HtmlEditorFormInputComponent extends BaseCodeEditorFormInputComponent impl
|
|
|
58
58
|
* Extends: BaseCodeEditorFormInputComponent
|
|
59
59
|
|
|
60
60
|
|
|
61
|
-
* Implements:
|
|
61
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent), AfterViewInit, OnInit
|
|
62
62
|
|
|
63
63
|
|
|
64
64
|
|
|
@@ -97,7 +97,7 @@ class JsonEditorFormInputComponent extends BaseCodeEditorFormInputComponent impl
|
|
|
97
97
|
* Extends: BaseCodeEditorFormInputComponent
|
|
98
98
|
|
|
99
99
|
|
|
100
|
-
* Implements:
|
|
100
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent), AfterViewInit, OnInit
|
|
101
101
|
|
|
102
102
|
|
|
103
103
|
|
|
@@ -138,7 +138,7 @@ class CombinationModeFormInputComponent implements FormInputComponent, OnInit {
|
|
|
138
138
|
setCombinationModeOr() => ;
|
|
139
139
|
}
|
|
140
140
|
```
|
|
141
|
-
* Implements:
|
|
141
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent), OnInit
|
|
142
142
|
|
|
143
143
|
|
|
144
144
|
|
|
@@ -206,7 +206,7 @@ class CurrencyFormInputComponent implements FormInputComponent {
|
|
|
206
206
|
constructor(dataService: DataService)
|
|
207
207
|
}
|
|
208
208
|
```
|
|
209
|
-
* Implements:
|
|
209
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
210
210
|
|
|
211
211
|
|
|
212
212
|
|
|
@@ -263,7 +263,7 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
|
|
|
263
263
|
compareWith(o1: T, o2: T) => ;
|
|
264
264
|
}
|
|
265
265
|
```
|
|
266
|
-
* Implements:
|
|
266
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent), OnInit
|
|
267
267
|
|
|
268
268
|
|
|
269
269
|
|
|
@@ -332,7 +332,7 @@ class DateFormInputComponent implements FormInputComponent {
|
|
|
332
332
|
yearRange: void
|
|
333
333
|
}
|
|
334
334
|
```
|
|
335
|
-
* Implements:
|
|
335
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
336
336
|
|
|
337
337
|
|
|
338
338
|
|
|
@@ -398,7 +398,7 @@ class FacetValueFormInputComponent implements FormInputComponent {
|
|
|
398
398
|
};
|
|
399
399
|
}
|
|
400
400
|
```
|
|
401
|
-
* Implements:
|
|
401
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
402
402
|
|
|
403
403
|
|
|
404
404
|
|
|
@@ -454,7 +454,7 @@ class NumberFormInputComponent implements FormInputComponent {
|
|
|
454
454
|
step: void
|
|
455
455
|
}
|
|
456
456
|
```
|
|
457
|
-
* Implements:
|
|
457
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
458
458
|
|
|
459
459
|
|
|
460
460
|
|
|
@@ -520,7 +520,7 @@ class PasswordFormInputComponent implements FormInputComponent {
|
|
|
520
520
|
config: InputComponentConfig;
|
|
521
521
|
}
|
|
522
522
|
```
|
|
523
|
-
* Implements:
|
|
523
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
524
524
|
|
|
525
525
|
|
|
526
526
|
|
|
@@ -568,7 +568,7 @@ class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
|
|
|
568
568
|
removeProductVariant(id: string) => ;
|
|
569
569
|
}
|
|
570
570
|
```
|
|
571
|
-
* Implements:
|
|
571
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent), OnInit
|
|
572
572
|
|
|
573
573
|
|
|
574
574
|
|
|
@@ -631,7 +631,7 @@ class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
|
|
|
631
631
|
|
|
632
632
|
The default input component for `relation` type custom fields. Allows the selection
|
|
633
633
|
of a ProductVariant, Product, Customer or Asset. For other entity types, a custom
|
|
634
|
-
implementation will need to be defined. See
|
|
634
|
+
implementation will need to be defined. See [registerFormInputComponent](/reference/admin-ui-api/custom-input-components/register-form-input-component#registerforminputcomponent).
|
|
635
635
|
|
|
636
636
|
```ts title="Signature"
|
|
637
637
|
class RelationFormInputComponent implements FormInputComponent {
|
|
@@ -641,7 +641,7 @@ class RelationFormInputComponent implements FormInputComponent {
|
|
|
641
641
|
config: RelationCustomFieldConfig;
|
|
642
642
|
}
|
|
643
643
|
```
|
|
644
|
-
* Implements:
|
|
644
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
645
645
|
|
|
646
646
|
|
|
647
647
|
|
|
@@ -672,7 +672,7 @@ class RelationFormInputComponent implements FormInputComponent {
|
|
|
672
672
|
</div>
|
|
673
673
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/dynamic-form-inputs/rich-text-form-input/rich-text-form-input.component.ts" sourceLine="14" packageName="@vendure/admin-ui" />
|
|
674
674
|
|
|
675
|
-
Uses the
|
|
675
|
+
Uses the [RichTextEditorComponent](/reference/admin-ui-api/components/rich-text-editor-component#richtexteditorcomponent) as in input for `text` type fields.
|
|
676
676
|
|
|
677
677
|
```ts title="Signature"
|
|
678
678
|
class RichTextFormInputComponent implements FormInputComponent {
|
|
@@ -682,7 +682,7 @@ class RichTextFormInputComponent implements FormInputComponent {
|
|
|
682
682
|
config: DefaultFormComponentConfig<'rich-text-form-input'>;
|
|
683
683
|
}
|
|
684
684
|
```
|
|
685
|
-
* Implements:
|
|
685
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
686
686
|
|
|
687
687
|
|
|
688
688
|
|
|
@@ -729,7 +729,7 @@ class SelectFormInputComponent implements FormInputComponent, OnInit {
|
|
|
729
729
|
trackByFn(index: number, item: any) => ;
|
|
730
730
|
}
|
|
731
731
|
```
|
|
732
|
-
* Implements:
|
|
732
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent), OnInit
|
|
733
733
|
|
|
734
734
|
|
|
735
735
|
|
|
@@ -804,7 +804,7 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
|
|
|
804
804
|
ngOnDestroy() => ;
|
|
805
805
|
}
|
|
806
806
|
```
|
|
807
|
-
* Implements:
|
|
807
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent), OnInit, OnDestroy
|
|
808
808
|
|
|
809
809
|
|
|
810
810
|
|
|
@@ -877,7 +877,7 @@ class TextFormInputComponent implements FormInputComponent {
|
|
|
877
877
|
suffix: void
|
|
878
878
|
}
|
|
879
879
|
```
|
|
880
|
-
* Implements:
|
|
880
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
881
881
|
|
|
882
882
|
|
|
883
883
|
|
|
@@ -929,7 +929,7 @@ class TextareaFormInputComponent implements FormInputComponent {
|
|
|
929
929
|
spellcheck: boolean
|
|
930
930
|
}
|
|
931
931
|
```
|
|
932
|
-
* Implements:
|
|
932
|
+
* Implements: [`FormInputComponent`](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent)
|
|
933
933
|
|
|
934
934
|
|
|
935
935
|
|
package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx
CHANGED
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-form-input-component.ts" sourceLine="53" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
7
|
Registers a custom FormInputComponent which can be used to control the argument inputs
|
|
8
|
-
of a
|
|
8
|
+
of a [ConfigurableOperationDef](/reference/typescript-api/configurable-operation-def/#configurableoperationdef) (e.g. CollectionFilter, ShippingMethod etc.) or for
|
|
9
9
|
a custom field.
|
|
10
10
|
|
|
11
11
|
*Example*
|
|
@@ -41,7 +41,7 @@ const config: VendureConfig = {
|
|
|
41
41
|
}
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
or with an argument of a
|
|
44
|
+
or with an argument of a [ConfigurableOperationDef](/reference/typescript-api/configurable-operation-def/#configurableoperationdef):
|
|
45
45
|
|
|
46
46
|
*Example*
|
|
47
47
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/components/data-table-2/data-table-custom-component.service.ts" sourceLine="54" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
Configures a
|
|
7
|
+
Configures a [CustomDetailComponent](/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent) to be placed in the given location.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface DataTableComponentConfig {
|
|
@@ -32,7 +32,7 @@ The column in the table where the custom component should be placed.
|
|
|
32
32
|
<MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a>>`} />
|
|
33
33
|
|
|
34
34
|
The component to render in the table cell. This component should implement the
|
|
35
|
-
|
|
35
|
+
[CustomColumnComponent](/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent) interface.
|
|
36
36
|
### providers
|
|
37
37
|
|
|
38
38
|
<MemberInfo kind="property" type={`Provider[]`} />
|
package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx
CHANGED
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-data-table-component.ts" sourceLine="45" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
7
|
Allows you to override the default component used to render the data of a particular column in a DataTable.
|
|
8
|
-
The component should implement the
|
|
8
|
+
The component should implement the [CustomColumnComponent](/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent) interface. The tableId and columnId can
|
|
9
9
|
be determined by pressing `ctrl + u` when running the Admin UI in dev mode.
|
|
10
10
|
|
|
11
11
|
*Example*
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-dashboard-widget.ts" sourceLine="16" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
7
|
Registers a dashboard widget. Once registered, the widget can be set as part of the default
|
|
8
|
-
(using
|
|
8
|
+
(using [setDashboardWidgetLayout](/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout#setdashboardwidgetlayout)).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
function registerDashboardWidget(id: string, config: DashboardWidgetConfig): void
|
|
@@ -22,7 +22,7 @@ class IfPermissionsDirective extends IfDirectiveBase<Array<Permission[] | null>>
|
|
|
22
22
|
constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService)
|
|
23
23
|
}
|
|
24
24
|
```
|
|
25
|
-
* Extends: `IfDirectiveBase<Array
|
|
25
|
+
* Extends: `IfDirectiveBase<Array<`[`Permission`](/reference/typescript-api/common/permission#permission)`[] | null>>`
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="57" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
7
|
A base class for entity detail views. It should be used in conjunction with the
|
|
8
|
-
|
|
8
|
+
[BaseEntityResolver](/reference/admin-ui-api/list-detail-views/base-entity-resolver#baseentityresolver).
|
|
9
9
|
|
|
10
10
|
*Example*
|
|
11
11
|
|
|
@@ -6,7 +6,7 @@ generated: true
|
|
|
6
6
|
|
|
7
7
|
A base resolver for an entity detail route. Resolves to an observable of the given entity, or a "blank"
|
|
8
8
|
version if the route id equals "create". Should be used together with details views which extend the
|
|
9
|
-
|
|
9
|
+
[BaseDetailComponent](/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent).
|
|
10
10
|
|
|
11
11
|
*Example*
|
|
12
12
|
|
|
@@ -7,7 +7,7 @@ generated: true
|
|
|
7
7
|
This is a base class which implements the logic required to fetch and manipulate
|
|
8
8
|
a list of data from a query which returns a PaginatedList type.
|
|
9
9
|
|
|
10
|
-
It is normally used in combination with the
|
|
10
|
+
It is normally used in combination with the [DataTable2Component](/reference/admin-ui-api/components/data-table2component#datatable2component).
|
|
11
11
|
|
|
12
12
|
```ts title="Signature"
|
|
13
13
|
class BaseListComponent<ResultType, ItemType, VariableType extends Record<string, any> = any> implements OnInit, OnDestroy {
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="256" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
A helper function for creating tabs that point to a
|
|
7
|
+
A helper function for creating tabs that point to a [TypedBaseDetailComponent](/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent). This takes
|
|
8
8
|
care of the route resolver parts so that the detail component automatically has access to the
|
|
9
9
|
correct resolved detail data.
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="186" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
A version of the
|
|
7
|
+
A version of the [BaseDetailComponent](/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent) which is designed to be used with a
|
|
8
8
|
[TypedDocumentNode](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -15,7 +15,7 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
|
|
|
15
15
|
init() => ;
|
|
16
16
|
}
|
|
17
17
|
```
|
|
18
|
-
* Extends:
|
|
18
|
+
* Extends: [`BaseDetailComponent`](/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent)`<NonNullable<ResultOf<T>[Field]>>`
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-list.component.ts" sourceLine="217" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
A version of the
|
|
7
|
+
A version of the [BaseListComponent](/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent) which is designed to be used with a
|
|
8
8
|
[TypedDocumentNode](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node).
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
@@ -31,7 +31,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
|
|
|
31
31
|
getCustomFieldConfig(key: Exclude<keyof CustomFields, '__typename'> | string) => CustomFieldConfig[];
|
|
32
32
|
}
|
|
33
33
|
```
|
|
34
|
-
* Extends:
|
|
34
|
+
* Extends: [`BaseListComponent`](/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent)`<ResultOf<T>, ItemOf<ResultOf<T>, Field>, VariablesOf<T>>`
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
* Implements: OnInit
|
|
@@ -52,7 +52,7 @@ interface NavMenuSection {
|
|
|
52
52
|
<MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
|
|
53
53
|
|
|
54
54
|
Control the display of this item based on the user permissions. Note: if you attempt to pass a
|
|
55
|
-
|
|
55
|
+
[PermissionDefinition](/reference/typescript-api/auth/permission-definition#permissiondefinition) object, you will get a compilation error. Instead, pass the plain
|
|
56
56
|
string version. For example, if the permission is defined as:
|
|
57
57
|
```ts
|
|
58
58
|
export const MyPermission = new PermissionDefinition('ProductReview');
|
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts" sourceLine="19" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
Configures a
|
|
7
|
+
Configures a [CustomDetailComponent](/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent) to be placed in the given location.
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
interface ReactDataTableComponentConfig {
|
package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx
CHANGED
|
@@ -5,7 +5,7 @@ generated: true
|
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="40" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
7
|
Registers a React component to be rendered in a detail page in the given location.
|
|
8
|
-
Components used as custom detail components can make use of the
|
|
8
|
+
Components used as custom detail components can make use of the [useDetailComponentData](/reference/admin-ui-api/react-hooks/use-detail-component-data#usedetailcomponentdata) hook.
|
|
9
9
|
|
|
10
10
|
```ts title="Signature"
|
|
11
11
|
function registerReactCustomDetailComponent(config: ReactCustomDetailComponentConfig): void
|
package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx
CHANGED
|
@@ -4,7 +4,7 @@ generated: true
|
|
|
4
4
|
---
|
|
5
5
|
<GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-form-input-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
|
|
6
6
|
|
|
7
|
-
Registers a React component to be used as a
|
|
7
|
+
Registers a React component to be used as a [FormInputComponent](/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent).
|
|
8
8
|
|
|
9
9
|
```ts title="Signature"
|
|
10
10
|
function registerReactFormInputComponent(id: string, component: ElementType): void
|