@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
- package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
- package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
- package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
- package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
- package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
- package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
- package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
- package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
- package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
- package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
- package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
- package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
- package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
- package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
- package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
- package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
- package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
- package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
- package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
- package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
- package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
- package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
- package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
- package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
- package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
- package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
- package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
- package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
- package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
- package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
- package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
- package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
- package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
- package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
- package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
- package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
- package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
- package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
- package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
- package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
- package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
- package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
- package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
- package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
- package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
- package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
- package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
- package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
- package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
- package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
- package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
- package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
- package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
- package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
- package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
- package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
- package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
- package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
- package/docs/reference/dashboard/page-layout/index.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
- package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
- package/docs/reference/dashboard/page-layout/page.mdx +3 -3
- package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
- package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
- package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
- package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
- package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
- package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
- package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
- package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
- package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
- package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
- package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/index.mdx +3 -3
- package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
- package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
- package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
- package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
- package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
- package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
- package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
- package/docs/reference/typescript-api/common/injector.mdx +2 -2
- package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
- package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
- package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
- package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
- package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
- package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
- package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
- package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
- package/docs/reference/typescript-api/entities/address.mdx +1 -1
- package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
- package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
- package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/channel.mdx +1 -1
- package/docs/reference/typescript-api/entities/collection.mdx +2 -2
- package/docs/reference/typescript-api/entities/country.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/customer.mdx +1 -1
- package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
- package/docs/reference/typescript-api/entities/facet.mdx +2 -2
- package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
- package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
- package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
- package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
- package/docs/reference/typescript-api/entities/order.mdx +1 -1
- package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
- package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
- package/docs/reference/typescript-api/entities/payment.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
- package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
- package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
- package/docs/reference/typescript-api/entities/product.mdx +2 -2
- package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
- package/docs/reference/typescript-api/entities/province.mdx +1 -1
- package/docs/reference/typescript-api/entities/refund.mdx +1 -1
- package/docs/reference/typescript-api/entities/region.mdx +1 -1
- package/docs/reference/typescript-api/entities/role.mdx +1 -1
- package/docs/reference/typescript-api/entities/seller.mdx +1 -1
- package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
- package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
- package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
- package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
- package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
- package/docs/reference/typescript-api/entities/tag.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
- package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
- package/docs/reference/typescript-api/entities/user.mdx +1 -1
- package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
- package/docs/reference/typescript-api/entities/zone.mdx +1 -1
- package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
- package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
- package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
- package/docs/reference/typescript-api/events/event-types.mdx +30 -30
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
- package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
- package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
- package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
- package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
- package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
- package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
- package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
- package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
- package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
- package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
- package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
- package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
- package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
- package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
- package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
- package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
- package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
- package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
- package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
- package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
- package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
- package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
- package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
- package/docs/reference/typescript-api/services/country-service.mdx +7 -7
- package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
- package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
- package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
- package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
- package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
- package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +8 -8
- package/docs/reference/typescript-api/services/order-service.mdx +52 -52
- package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
- package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
- package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
- package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
- package/docs/reference/typescript-api/services/product-service.mdx +13 -13
- package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
- package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
- package/docs/reference/typescript-api/services/province-service.mdx +5 -5
- package/docs/reference/typescript-api/services/role-service.mdx +11 -11
- package/docs/reference/typescript-api/services/search-service.mdx +2 -2
- package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
- package/docs/reference/typescript-api/services/session-service.mdx +8 -8
- package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
- package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
- package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
- package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
- package/docs/reference/typescript-api/services/user-service.mdx +12 -12
- package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
- package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
- package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
- package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
- package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
- package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
- package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
- package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
- package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
- package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
- package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
- package/package.json +1 -1
- package/docs/reference/admin-ui-api/index.mdx +0 -4
- package/docs/reference/dashboard/index.mdx +0 -4
- package/docs/reference/graphql-api/admin/_index.mdx +0 -4
- package/docs/reference/graphql-api/shop/_index.mdx +0 -4
- package/docs/reference/typescript-api/_index.mdx +0 -4
|
@@ -41,7 +41,7 @@ class BooleanFormInputComponent implements FormInputComponent {
|
|
|
41
41
|
|
|
42
42
|
### config
|
|
43
43
|
|
|
44
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
44
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'boolean-form-input'>`} />
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
|
|
@@ -177,12 +177,12 @@ class CombinationModeFormInputComponent implements FormInputComponent, OnInit {
|
|
|
177
177
|
|
|
178
178
|
### config
|
|
179
179
|
|
|
180
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
180
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'combination-mode-form-input'>`} />
|
|
181
181
|
|
|
182
182
|
|
|
183
183
|
### selectable$
|
|
184
184
|
|
|
185
|
-
<MemberInfo kind="property" type={`Observable
|
|
185
|
+
<MemberInfo kind="property" type={`Observable<boolean>`} />
|
|
186
186
|
|
|
187
187
|
|
|
188
188
|
### constructor
|
|
@@ -249,12 +249,12 @@ class CurrencyFormInputComponent implements FormInputComponent {
|
|
|
249
249
|
|
|
250
250
|
### currencyCode$
|
|
251
251
|
|
|
252
|
-
<MemberInfo kind="property" type={`Observable
|
|
252
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>>`} />
|
|
253
253
|
|
|
254
254
|
|
|
255
255
|
### config
|
|
256
256
|
|
|
257
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
257
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'currency-form-input'>`} />
|
|
258
258
|
|
|
259
259
|
|
|
260
260
|
### constructor
|
|
@@ -305,17 +305,17 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
|
|
|
305
305
|
|
|
306
306
|
### formControl
|
|
307
307
|
|
|
308
|
-
<MemberInfo kind="property" type={`FormControl
|
|
308
|
+
<MemberInfo kind="property" type={`FormControl<string | { id: string }>`} />
|
|
309
309
|
|
|
310
310
|
|
|
311
311
|
### customerGroups$
|
|
312
312
|
|
|
313
|
-
<MemberInfo kind="property" type={`Observable
|
|
313
|
+
<MemberInfo kind="property" type={`Observable<GetCustomerGroupsQuery['customerGroups']['items']>`} />
|
|
314
314
|
|
|
315
315
|
|
|
316
316
|
### config
|
|
317
317
|
|
|
318
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
318
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'customer-group-form-input'>`} />
|
|
319
319
|
|
|
320
320
|
|
|
321
321
|
### constructor
|
|
@@ -330,7 +330,7 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
|
|
|
330
330
|
|
|
331
331
|
### selectGroup
|
|
332
332
|
|
|
333
|
-
<MemberInfo kind="method" type={`(group: ItemOf
|
|
333
|
+
<MemberInfo kind="method" type={`(group: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>) => `} />
|
|
334
334
|
|
|
335
335
|
|
|
336
336
|
### compareWith
|
|
@@ -383,7 +383,7 @@ class DateFormInputComponent implements FormInputComponent {
|
|
|
383
383
|
|
|
384
384
|
### config
|
|
385
385
|
|
|
386
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
386
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'date-form-input'>`} />
|
|
387
387
|
|
|
388
388
|
|
|
389
389
|
### min
|
|
@@ -513,7 +513,7 @@ class NumberFormInputComponent implements FormInputComponent {
|
|
|
513
513
|
|
|
514
514
|
### config
|
|
515
515
|
|
|
516
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
516
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'number-form-input'>`} />
|
|
517
517
|
|
|
518
518
|
|
|
519
519
|
### prefix
|
|
@@ -635,17 +635,17 @@ class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
|
|
|
635
635
|
|
|
636
636
|
### formControl
|
|
637
637
|
|
|
638
|
-
<MemberInfo kind="property" type={`FormControl
|
|
638
|
+
<MemberInfo kind="property" type={`FormControl<Array<string | { id: string }>>`} />
|
|
639
639
|
|
|
640
640
|
|
|
641
641
|
### config
|
|
642
642
|
|
|
643
|
-
<MemberInfo kind="property" type={`DefaultFormComponentUiConfig
|
|
643
|
+
<MemberInfo kind="property" type={`DefaultFormComponentUiConfig<'product-selector-form-input'>`} />
|
|
644
644
|
|
|
645
645
|
|
|
646
646
|
### selection$
|
|
647
647
|
|
|
648
|
-
<MemberInfo kind="property" type={`Observable
|
|
648
|
+
<MemberInfo kind="property" type={`Observable<Array<GetProductVariantQuery['productVariant']>>`} />
|
|
649
649
|
|
|
650
650
|
|
|
651
651
|
### constructor
|
|
@@ -757,7 +757,7 @@ class RichTextFormInputComponent implements FormInputComponent {
|
|
|
757
757
|
|
|
758
758
|
### config
|
|
759
759
|
|
|
760
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
760
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'rich-text-form-input'>`} />
|
|
761
761
|
|
|
762
762
|
|
|
763
763
|
|
|
@@ -808,12 +808,12 @@ class SelectFormInputComponent implements FormInputComponent, OnInit {
|
|
|
808
808
|
|
|
809
809
|
### config
|
|
810
810
|
|
|
811
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
811
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'select-form-input'> & CustomFieldConfigFragment`} />
|
|
812
812
|
|
|
813
813
|
|
|
814
814
|
### uiLanguage$
|
|
815
815
|
|
|
816
|
-
<MemberInfo kind="property" type={`Observable
|
|
816
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
|
|
817
817
|
|
|
818
818
|
|
|
819
819
|
### options
|
|
@@ -887,12 +887,12 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
|
|
|
887
887
|
|
|
888
888
|
### config
|
|
889
889
|
|
|
890
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
890
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'struct-form-input'>`} />
|
|
891
891
|
|
|
892
892
|
|
|
893
893
|
### uiLanguage$
|
|
894
894
|
|
|
895
|
-
<MemberInfo kind="property" type={`Observable
|
|
895
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
|
|
896
896
|
|
|
897
897
|
|
|
898
898
|
### structFormGroup
|
|
@@ -902,7 +902,7 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
|
|
|
902
902
|
|
|
903
903
|
### fields
|
|
904
904
|
|
|
905
|
-
<MemberInfo kind="property" type={`Array
|
|
905
|
+
<MemberInfo kind="property" type={`Array<{ def: StructCustomFieldFragment['fields'][number]; formControl: FormControl; }>`} />
|
|
906
906
|
|
|
907
907
|
|
|
908
908
|
### constructor
|
|
@@ -964,7 +964,7 @@ class TextFormInputComponent implements FormInputComponent {
|
|
|
964
964
|
|
|
965
965
|
### config
|
|
966
966
|
|
|
967
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
967
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'text-form-input'>`} />
|
|
968
968
|
|
|
969
969
|
|
|
970
970
|
### prefix
|
|
@@ -1020,7 +1020,7 @@ class TextareaFormInputComponent implements FormInputComponent {
|
|
|
1020
1020
|
|
|
1021
1021
|
### config
|
|
1022
1022
|
|
|
1023
|
-
<MemberInfo kind="property" type={`DefaultFormComponentConfig
|
|
1023
|
+
<MemberInfo kind="property" type={`DefaultFormComponentConfig<'textarea-form-input'>`} />
|
|
1024
1024
|
|
|
1025
1025
|
|
|
1026
1026
|
### spellcheck
|
package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx
CHANGED
|
@@ -66,5 +66,5 @@ Parameters
|
|
|
66
66
|
|
|
67
67
|
### component
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="parameter" type={`Type
|
|
69
|
+
<MemberInfo kind="parameter" type={`Type<<a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>>`} />
|
|
70
70
|
|
|
@@ -33,7 +33,7 @@ The location in the UI where the custom component should be placed.
|
|
|
33
33
|
The column in the table where the custom component should be placed.
|
|
34
34
|
### component
|
|
35
35
|
|
|
36
|
-
<MemberInfo kind="property" type={`Type
|
|
36
|
+
<MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a>>`} />
|
|
37
37
|
|
|
38
38
|
The component to render in the table cell. This component should implement the
|
|
39
39
|
<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a> interface.
|
|
@@ -23,7 +23,7 @@ interface DashboardWidgetConfig {
|
|
|
23
23
|
|
|
24
24
|
### loadComponent
|
|
25
25
|
|
|
26
|
-
<MemberInfo kind="property" type={`()
|
|
26
|
+
<MemberInfo kind="property" type={`() => Promise<Type<any>> | Type<any>`} />
|
|
27
27
|
|
|
28
28
|
Used to specify the widget component. Supports both eager- and lazy-loading.
|
|
29
29
|
|
|
@@ -24,7 +24,7 @@ class IfMultichannelDirective extends IfDirectiveBase<[]> {
|
|
|
24
24
|
constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, dataService: DataService)
|
|
25
25
|
}
|
|
26
26
|
```
|
|
27
|
-
* Extends: <code>IfDirectiveBase
|
|
27
|
+
* Extends: <code>IfDirectiveBase<[]></code>
|
|
28
28
|
|
|
29
29
|
|
|
30
30
|
|
|
@@ -32,7 +32,7 @@ class IfMultichannelDirective extends IfDirectiveBase<[]> {
|
|
|
32
32
|
|
|
33
33
|
### constructor
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef
|
|
35
|
+
<MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, dataService: <a href='/reference/admin-ui-api/services/data-service#dataservice'>DataService</a>) => IfMultichannelDirective`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
|
|
@@ -26,7 +26,7 @@ class IfPermissionsDirective extends IfDirectiveBase<Array<Permission[] | null>>
|
|
|
26
26
|
constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService)
|
|
27
27
|
}
|
|
28
28
|
```
|
|
29
|
-
* Extends: <code>IfDirectiveBase
|
|
29
|
+
* Extends: <code>IfDirectiveBase<Array<<a href='/reference/typescript-api/common/permission#permission'>Permission</a>[] | null>></code>
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ class IfPermissionsDirective extends IfDirectiveBase<Array<Permission[] | null>>
|
|
|
34
34
|
|
|
35
35
|
### constructor
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef
|
|
37
|
+
<MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService) => IfPermissionsDirective`} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
|
|
@@ -74,17 +74,17 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
|
|
|
74
74
|
|
|
75
75
|
### entity$
|
|
76
76
|
|
|
77
|
-
<MemberInfo kind="property" type={`Observable
|
|
77
|
+
<MemberInfo kind="property" type={`Observable<Entity>`} />
|
|
78
78
|
|
|
79
79
|
|
|
80
80
|
### availableLanguages$
|
|
81
81
|
|
|
82
|
-
<MemberInfo kind="property" type={`Observable
|
|
82
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]>`} />
|
|
83
83
|
|
|
84
84
|
|
|
85
85
|
### languageCode$
|
|
86
86
|
|
|
87
|
-
<MemberInfo kind="property" type={`Observable
|
|
87
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
|
|
88
88
|
|
|
89
89
|
|
|
90
90
|
### languageCode
|
|
@@ -94,7 +94,7 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
|
|
|
94
94
|
|
|
95
95
|
### isNew$
|
|
96
96
|
|
|
97
|
-
<MemberInfo kind="property" type={`Observable
|
|
97
|
+
<MemberInfo kind="property" type={`Observable<boolean>`} />
|
|
98
98
|
|
|
99
99
|
|
|
100
100
|
### id
|
|
@@ -149,12 +149,12 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
|
|
|
149
149
|
|
|
150
150
|
### setCustomFieldFormValues
|
|
151
151
|
|
|
152
|
-
<MemberInfo kind="method" type={`(customFields: <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[], formGroup: AbstractControl | null, entity: T, currentTranslation?: TranslationOf
|
|
152
|
+
<MemberInfo kind="method" type={`(customFields: <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[], formGroup: AbstractControl | null, entity: T, currentTranslation?: TranslationOf<T>) => `} />
|
|
153
153
|
|
|
154
154
|
|
|
155
155
|
### getCustomFieldConfig
|
|
156
156
|
|
|
157
|
-
<MemberInfo kind="method" type={`(key: Exclude
|
|
157
|
+
<MemberInfo kind="method" type={`(key: Exclude<keyof <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>, '__typename'>) => <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]`} />
|
|
158
158
|
|
|
159
159
|
|
|
160
160
|
### setQueryParam
|
|
@@ -45,7 +45,7 @@ class BaseEntityResolver<T> {
|
|
|
45
45
|
|
|
46
46
|
### constructor
|
|
47
47
|
|
|
48
|
-
<MemberInfo kind="method" type={`(router: Router, emptyEntity: T, entityStream: (id: string)
|
|
48
|
+
<MemberInfo kind="method" type={`(router: Router, emptyEntity: T, entityStream: (id: string) => Observable<T | null | undefined>) => BaseEntityResolver`} />
|
|
49
49
|
|
|
50
50
|
|
|
51
51
|
|
|
@@ -61,27 +61,27 @@ class BaseListComponent<ResultType, ItemType, VariableType extends Record<string
|
|
|
61
61
|
|
|
62
62
|
### result$
|
|
63
63
|
|
|
64
|
-
<MemberInfo kind="property" type={`Observable
|
|
64
|
+
<MemberInfo kind="property" type={`Observable<ResultType>`} />
|
|
65
65
|
|
|
66
66
|
|
|
67
67
|
### items$
|
|
68
68
|
|
|
69
|
-
<MemberInfo kind="property" type={`Observable
|
|
69
|
+
<MemberInfo kind="property" type={`Observable<ItemType[]>`} />
|
|
70
70
|
|
|
71
71
|
|
|
72
72
|
### totalItems$
|
|
73
73
|
|
|
74
|
-
<MemberInfo kind="property" type={`Observable
|
|
74
|
+
<MemberInfo kind="property" type={`Observable<number>`} />
|
|
75
75
|
|
|
76
76
|
|
|
77
77
|
### itemsPerPage$
|
|
78
78
|
|
|
79
|
-
<MemberInfo kind="property" type={`Observable
|
|
79
|
+
<MemberInfo kind="property" type={`Observable<number>`} />
|
|
80
80
|
|
|
81
81
|
|
|
82
82
|
### currentPage$
|
|
83
83
|
|
|
84
|
-
<MemberInfo kind="property" type={`Observable
|
|
84
|
+
<MemberInfo kind="property" type={`Observable<number>`} />
|
|
85
85
|
|
|
86
86
|
|
|
87
87
|
### destroy$
|
|
@@ -106,12 +106,12 @@ class BaseListComponent<ResultType, ItemType, VariableType extends Record<string
|
|
|
106
106
|
|
|
107
107
|
### setQueryFn
|
|
108
108
|
|
|
109
|
-
<MemberInfo kind="method" type={`(listQueryFn: ListQueryFn
|
|
109
|
+
<MemberInfo kind="method" type={`(listQueryFn: ListQueryFn<ResultType>, mappingFn: MappingFn<ItemType, ResultType>, onPageChangeFn?: OnPageChangeFn<VariableType>, defaults?: { take: number; skip: number }) => `} />
|
|
110
110
|
|
|
111
111
|
Sets the fetch function for the list being implemented.
|
|
112
112
|
### refreshListOnChanges
|
|
113
113
|
|
|
114
|
-
<MemberInfo kind="method" type={`(streams: Array
|
|
114
|
+
<MemberInfo kind="method" type={`(streams: Array<Observable<any>>) => `} />
|
|
115
115
|
|
|
116
116
|
Accepts a list of Observables which will trigger a refresh of the list when any of them emit.
|
|
117
117
|
### setPageNumber
|
|
@@ -126,7 +126,7 @@ Sets the current page number in the url.
|
|
|
126
126
|
Sets the number of items per page in the url.
|
|
127
127
|
### setVisibleColumns
|
|
128
128
|
|
|
129
|
-
<MemberInfo kind="method" type={`(columns: Array
|
|
129
|
+
<MemberInfo kind="method" type={`(columns: Array<DataTable2ColumnComponent<any>>) => `} />
|
|
130
130
|
|
|
131
131
|
|
|
132
132
|
### refresh
|
|
@@ -47,5 +47,5 @@ Parameters
|
|
|
47
47
|
|
|
48
48
|
### config
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="parameter" type={`{ component: Type
|
|
50
|
+
<MemberInfo kind="parameter" type={`{ component: Type<<a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a><T, Field>>; query: T; entityKey: R; getBreadcrumbs?: (entity: ResultOf<T>[R]) => BreadcrumbValue; variables?: T extends TypedDocumentNode<any, infer V> ? Omit<V, 'id'> : never; }`} />
|
|
51
51
|
|
|
@@ -19,7 +19,7 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
|
|
|
19
19
|
init() => ;
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
|
-
* Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a
|
|
22
|
+
* Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a><NonNullable<ResultOf<T>[Field]>></code>
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -27,12 +27,12 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
|
|
|
27
27
|
|
|
28
28
|
### result$
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="property" type={`Observable
|
|
30
|
+
<MemberInfo kind="property" type={`Observable<ResultOf<T>>`} />
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
### entity
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="property" type={`ResultOf
|
|
35
|
+
<MemberInfo kind="property" type={`ResultOf<T>[Field]`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### constructor
|
|
@@ -35,7 +35,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
|
|
|
35
35
|
getCustomFieldConfig(key: Exclude<keyof CustomFields, '__typename'> | string) => CustomFieldConfig[];
|
|
36
36
|
}
|
|
37
37
|
```
|
|
38
|
-
* Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a
|
|
38
|
+
* Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a><ResultOf<T>, ItemOf<ResultOf<T>, Field>, VariablesOf<T>></code>
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
* Implements: <code>OnInit</code>
|
|
@@ -46,12 +46,12 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
|
|
|
46
46
|
|
|
47
47
|
### availableLanguages$
|
|
48
48
|
|
|
49
|
-
<MemberInfo kind="property" type={`Observable
|
|
49
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]>`} />
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
### contentLanguage$
|
|
53
53
|
|
|
54
|
-
<MemberInfo kind="property" type={`Observable
|
|
54
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
|
|
55
55
|
|
|
56
56
|
|
|
57
57
|
### dataService
|
|
@@ -91,7 +91,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
|
|
|
91
91
|
|
|
92
92
|
### configure
|
|
93
93
|
|
|
94
|
-
<MemberInfo kind="method" type={`(config: { document: T; getItems: (data: ResultOf
|
|
94
|
+
<MemberInfo kind="method" type={`(config: { document: T; getItems: (data: ResultOf<T>) => { items: Array<ItemOf<ResultOf<T>, Field>>; totalItems: number }; setVariables?: (skip: number, take: number) => VariablesOf<T>; refreshListOnChanges?: Array<Observable<any>>; }) => `} />
|
|
95
95
|
|
|
96
96
|
|
|
97
97
|
### ngOnInit
|
|
@@ -101,12 +101,12 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
|
|
|
101
101
|
|
|
102
102
|
### createFilterCollection
|
|
103
103
|
|
|
104
|
-
<MemberInfo kind="method" type={`() => DataTableFilterCollection
|
|
104
|
+
<MemberInfo kind="method" type={`() => DataTableFilterCollection<NonNullable<NonNullable<Vars['options']>['filter']>>`} />
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
### createSortCollection
|
|
108
108
|
|
|
109
|
-
<MemberInfo kind="method" type={`() => DataTableSortCollection
|
|
109
|
+
<MemberInfo kind="method" type={`() => DataTableSortCollection<NonNullable<NonNullable<Vars['options']>['sort']>>`} />
|
|
110
110
|
|
|
111
111
|
|
|
112
112
|
### setLanguage
|
|
@@ -116,7 +116,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
|
|
|
116
116
|
|
|
117
117
|
### getCustomFieldConfig
|
|
118
118
|
|
|
119
|
-
<MemberInfo kind="method" type={`(key: Exclude
|
|
119
|
+
<MemberInfo kind="method" type={`(key: Exclude<keyof <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>, '__typename'> | string) => <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]`} />
|
|
120
120
|
|
|
121
121
|
|
|
122
122
|
|
|
@@ -42,7 +42,7 @@ interface NavMenuItem {
|
|
|
42
42
|
|
|
43
43
|
### onClick
|
|
44
44
|
|
|
45
|
-
<MemberInfo kind="property" type={`(event: MouseEvent)
|
|
45
|
+
<MemberInfo kind="property" type={`(event: MouseEvent) => void`} />
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
### icon
|
|
@@ -52,12 +52,12 @@ interface NavMenuItem {
|
|
|
52
52
|
|
|
53
53
|
### requiresPermission
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="property" type={`string | ((userPermissions: string[])
|
|
55
|
+
<MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
### statusBadge
|
|
59
59
|
|
|
60
|
-
<MemberInfo kind="property" type={`Observable
|
|
60
|
+
<MemberInfo kind="property" type={`Observable<<a href='/reference/admin-ui-api/nav-menu/navigation-types#navmenubadge'>NavMenuBadge</a>>`} />
|
|
61
61
|
|
|
62
62
|
|
|
63
63
|
|
|
@@ -53,7 +53,7 @@ interface NavMenuSection {
|
|
|
53
53
|
|
|
54
54
|
### requiresPermission
|
|
55
55
|
|
|
56
|
-
<MemberInfo kind="property" type={`string | ((userPermissions: string[])
|
|
56
|
+
<MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
|
|
57
57
|
|
|
58
58
|
Control the display of this item based on the user permissions. Note: if you attempt to pass a
|
|
59
59
|
<a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a> object, you will get a compilation error. Instead, pass the plain
|
|
@@ -29,5 +29,5 @@ Parameters
|
|
|
29
29
|
|
|
30
30
|
### props
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="parameter" type={`{ icon: IconShapeTuple; className?: string } & Partial
|
|
32
|
+
<MemberInfo kind="parameter" type={`{ icon: IconShapeTuple; className?: string } & Partial<CdsIconProps>`} />
|
|
33
33
|
|
|
@@ -37,5 +37,5 @@ Parameters
|
|
|
37
37
|
|
|
38
38
|
### props
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="parameter" type={`PropsWithChildren
|
|
40
|
+
<MemberInfo kind="parameter" type={`PropsWithChildren<{ for?: string; label?: string; tooltip?: string; invalid?: boolean; errorMessage?: string; }>`} />
|
|
41
41
|
|
package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx
CHANGED
|
@@ -32,7 +32,7 @@ The id of the detail page location in which to place the component.
|
|
|
32
32
|
The React component to render.
|
|
33
33
|
### props
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="property" type={`Record
|
|
35
|
+
<MemberInfo kind="property" type={`Record<string, any>`} />
|
|
36
36
|
|
|
37
37
|
Optional props to pass to the React component.
|
|
38
38
|
|
|
@@ -39,7 +39,7 @@ The component to render in the table cell. This component will receive the `rowI
|
|
|
39
39
|
which is the data object for the row, e.g. the `Product` object if used in the `product-list` table.
|
|
40
40
|
### props
|
|
41
41
|
|
|
42
|
-
<MemberInfo kind="property" type={`Record
|
|
42
|
+
<MemberInfo kind="property" type={`Record<string, any>`} />
|
|
43
43
|
|
|
44
44
|
Optional props to pass to the React component.
|
|
45
45
|
|
|
@@ -17,5 +17,5 @@ Parameters
|
|
|
17
17
|
|
|
18
18
|
### options
|
|
19
19
|
|
|
20
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/react-extensions/register-react-route-component-options#registerreactroutecomponentoptions'>RegisterReactRouteComponentOptions</a
|
|
20
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/react-extensions/register-react-route-component-options#registerreactroutecomponentoptions'>RegisterReactRouteComponentOptions</a><Entity, T, Field, R>`} />
|
|
21
21
|
|
|
@@ -52,5 +52,5 @@ Parameters
|
|
|
52
52
|
|
|
53
53
|
### options
|
|
54
54
|
|
|
55
|
-
<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/routes/register-route-component-options#registerroutecomponentoptions'>RegisterRouteComponentOptions</a
|
|
55
|
+
<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/routes/register-route-component-options#registerroutecomponentoptions'>RegisterRouteComponentOptions</a><Component, Entity, T, Field, R>`} />
|
|
56
56
|
|