@vendure/docs 0.0.0-202601211551 → 0.0.0-202601211609

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.
Files changed (358) hide show
  1. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  4. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  5. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +5 -5
  6. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
  7. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  8. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  9. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  10. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  11. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  13. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  15. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  16. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  17. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  18. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  20. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  21. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  22. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  23. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  24. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +1 -1
  26. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  27. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  28. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  29. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  30. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  31. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
  32. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
  33. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  34. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  35. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  36. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  37. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  38. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  39. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  40. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  41. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  47. package/docs/reference/admin-ui-api/services/data-service.mdx +9 -9
  48. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  49. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  50. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  51. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  52. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  53. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  54. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  55. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  56. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  57. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  58. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  59. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  60. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  61. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  62. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  63. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  64. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +6 -6
  65. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  66. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  67. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  68. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  69. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  70. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  71. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  72. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  73. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  74. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  75. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  76. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  77. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  78. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  79. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  80. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  81. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  82. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
  83. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  84. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  85. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  86. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  87. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  88. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  89. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  90. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  91. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  92. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  93. package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
  94. package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
  95. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +10 -10
  96. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +2 -2
  97. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  98. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  99. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  100. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  101. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  102. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  103. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  104. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  105. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  106. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  107. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  108. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  109. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  110. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  114. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  115. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  116. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  117. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  118. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  119. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  120. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  121. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  122. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  123. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  124. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  125. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  126. package/docs/reference/dashboard/page-layout/page.mdx +2 -2
  127. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  128. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  129. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  130. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  131. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  132. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  133. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  134. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +2 -2
  135. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  136. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  137. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  138. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  139. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  140. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  141. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  142. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  143. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  144. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  145. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  146. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +5 -5
  147. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  148. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  149. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  150. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  151. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  152. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  153. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  154. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  155. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  156. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
  157. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  158. package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
  159. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  160. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
  161. package/docs/reference/typescript-api/configuration/entity-options.mdx +1 -1
  162. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  163. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  164. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +14 -14
  165. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  166. package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
  167. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  168. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  169. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  170. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  171. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  172. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  173. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  174. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  175. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  176. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  177. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  178. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  179. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  180. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  181. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  182. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  183. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  184. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  185. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  186. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  188. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  189. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  190. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  191. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  192. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  194. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  196. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  197. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  199. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  200. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  202. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  204. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  205. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  207. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  208. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  209. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  210. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  212. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  213. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  215. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  216. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  217. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  220. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  221. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  225. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  227. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  228. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  229. package/docs/reference/typescript-api/events/event-bus.mdx +3 -3
  230. package/docs/reference/typescript-api/events/event-types.mdx +1 -1
  231. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +1 -1
  232. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  233. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  234. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  235. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  236. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  237. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  238. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  239. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  240. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  241. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  242. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  243. package/docs/reference/typescript-api/job-queue/index.mdx +1 -1
  244. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  245. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  246. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  247. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
  248. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  249. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  250. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  251. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +1 -1
  252. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  253. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  254. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  255. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  256. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  257. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  258. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  259. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  260. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  261. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  262. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  263. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  264. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  266. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  267. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  268. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  270. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  271. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +1 -1
  273. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  274. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  275. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  276. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  277. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  278. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  279. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  280. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  281. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  282. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  283. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  284. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  285. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  286. package/docs/reference/typescript-api/promotions/promotion-action.mdx +1 -1
  287. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +1 -1
  288. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  289. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  290. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  291. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
  292. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  293. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  294. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  295. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  296. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  297. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  298. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  299. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  300. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  301. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  302. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  303. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  304. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  305. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  306. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  307. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  308. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  309. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  310. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  311. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  312. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  313. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  314. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  315. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  316. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  317. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  318. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  319. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  320. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  321. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  322. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  323. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  324. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  325. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  326. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  327. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  328. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  329. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  330. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  331. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  332. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  333. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  334. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  335. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  336. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  337. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  338. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  339. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  340. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  341. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  342. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +2 -2
  343. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  344. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  345. package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
  346. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  347. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  348. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  349. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  350. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  351. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  352. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  353. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  354. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  355. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  356. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  357. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  358. package/package.json +1 -1
@@ -37,7 +37,7 @@ class BooleanFormInputComponent implements FormInputComponent {
37
37
 
38
38
  ### config
39
39
 
40
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'boolean-form-input'>`} />
40
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'boolean-form-input'>``} />
41
41
 
42
42
 
43
43
 
@@ -161,12 +161,12 @@ class CombinationModeFormInputComponent implements FormInputComponent, OnInit {
161
161
 
162
162
  ### config
163
163
 
164
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'combination-mode-form-input'>`} />
164
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'combination-mode-form-input'>``} />
165
165
 
166
166
 
167
167
  ### selectable$
168
168
 
169
- <MemberInfo kind="property" type={`Observable<boolean>`} />
169
+ <MemberInfo kind="property" type={``Observable<boolean>``} />
170
170
 
171
171
 
172
172
  ### constructor
@@ -229,12 +229,12 @@ class CurrencyFormInputComponent implements FormInputComponent {
229
229
 
230
230
  ### currencyCode$
231
231
 
232
- <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>>`} />
232
+ <MemberInfo kind="property" type={``Observable<`<a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>`>``} />
233
233
 
234
234
 
235
235
  ### config
236
236
 
237
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'currency-form-input'>`} />
237
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'currency-form-input'>``} />
238
238
 
239
239
 
240
240
  ### constructor
@@ -281,17 +281,17 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
281
281
 
282
282
  ### formControl
283
283
 
284
- <MemberInfo kind="property" type={`FormControl<string | { id: string }>`} />
284
+ <MemberInfo kind="property" type={``FormControl<string | { id: string }>``} />
285
285
 
286
286
 
287
287
  ### customerGroups$
288
288
 
289
- <MemberInfo kind="property" type={`Observable<GetCustomerGroupsQuery['customerGroups']['items']>`} />
289
+ <MemberInfo kind="property" type={``Observable<GetCustomerGroupsQuery['customerGroups']['items']>``} />
290
290
 
291
291
 
292
292
  ### config
293
293
 
294
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'customer-group-form-input'>`} />
294
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'customer-group-form-input'>``} />
295
295
 
296
296
 
297
297
  ### constructor
@@ -306,7 +306,7 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
306
306
 
307
307
  ### selectGroup
308
308
 
309
- <MemberInfo kind="method" type={`(group: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>) => `} />
309
+ <MemberInfo kind="method" type={`(group: `ItemOf<GetCustomerGroupsQuery, 'customerGroups'>`) => `} />
310
310
 
311
311
 
312
312
  ### compareWith
@@ -355,7 +355,7 @@ class DateFormInputComponent implements FormInputComponent {
355
355
 
356
356
  ### config
357
357
 
358
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'date-form-input'>`} />
358
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'date-form-input'>``} />
359
359
 
360
360
 
361
361
  ### min
@@ -477,7 +477,7 @@ class NumberFormInputComponent implements FormInputComponent {
477
477
 
478
478
  ### config
479
479
 
480
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'number-form-input'>`} />
480
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'number-form-input'>``} />
481
481
 
482
482
 
483
483
  ### prefix
@@ -591,17 +591,17 @@ class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
591
591
 
592
592
  ### formControl
593
593
 
594
- <MemberInfo kind="property" type={`FormControl<Array<string | { id: string }>>`} />
594
+ <MemberInfo kind="property" type={``FormControl<Array<string | { id: string }>>``} />
595
595
 
596
596
 
597
597
  ### config
598
598
 
599
- <MemberInfo kind="property" type={`DefaultFormComponentUiConfig<'product-selector-form-input'>`} />
599
+ <MemberInfo kind="property" type={``DefaultFormComponentUiConfig<'product-selector-form-input'>``} />
600
600
 
601
601
 
602
602
  ### selection$
603
603
 
604
- <MemberInfo kind="property" type={`Observable<Array<GetProductVariantQuery['productVariant']>>`} />
604
+ <MemberInfo kind="property" type={``Observable<Array<GetProductVariantQuery['productVariant']>>``} />
605
605
 
606
606
 
607
607
  ### constructor
@@ -705,7 +705,7 @@ class RichTextFormInputComponent implements FormInputComponent {
705
705
 
706
706
  ### config
707
707
 
708
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'rich-text-form-input'>`} />
708
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'rich-text-form-input'>``} />
709
709
 
710
710
 
711
711
 
@@ -752,12 +752,12 @@ class SelectFormInputComponent implements FormInputComponent, OnInit {
752
752
 
753
753
  ### config
754
754
 
755
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'select-form-input'> &#38; CustomFieldConfigFragment`} />
755
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'select-form-input'> &#38; CustomFieldConfigFragment``} />
756
756
 
757
757
 
758
758
  ### uiLanguage$
759
759
 
760
- <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
760
+ <MemberInfo kind="property" type={``Observable<`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`>``} />
761
761
 
762
762
 
763
763
  ### options
@@ -827,12 +827,12 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
827
827
 
828
828
  ### config
829
829
 
830
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'struct-form-input'>`} />
830
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'struct-form-input'>``} />
831
831
 
832
832
 
833
833
  ### uiLanguage$
834
834
 
835
- <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
835
+ <MemberInfo kind="property" type={``Observable<`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`>``} />
836
836
 
837
837
 
838
838
  ### structFormGroup
@@ -842,7 +842,7 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
842
842
 
843
843
  ### fields
844
844
 
845
- <MemberInfo kind="property" type={`Array<{ def: StructCustomFieldFragment['fields'][number]; formControl: FormControl; }>`} />
845
+ <MemberInfo kind="property" type={``Array<{ def: StructCustomFieldFragment['fields'][number]; formControl: FormControl; }>``} />
846
846
 
847
847
 
848
848
  ### constructor
@@ -900,7 +900,7 @@ class TextFormInputComponent implements FormInputComponent {
900
900
 
901
901
  ### config
902
902
 
903
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'text-form-input'>`} />
903
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'text-form-input'>``} />
904
904
 
905
905
 
906
906
  ### prefix
@@ -952,7 +952,7 @@ class TextareaFormInputComponent implements FormInputComponent {
952
952
 
953
953
  ### config
954
954
 
955
- <MemberInfo kind="property" type={`DefaultFormComponentConfig<'textarea-form-input'>`} />
955
+ <MemberInfo kind="property" type={``DefaultFormComponentConfig<'textarea-form-input'>``} />
956
956
 
957
957
 
958
958
  ### spellcheck
@@ -62,5 +62,5 @@ Parameters
62
62
 
63
63
  ### component
64
64
 
65
- <MemberInfo kind="parameter" type={`Type<<a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>>`} />
65
+ <MemberInfo kind="parameter" type={``Type<`<a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>`>``} />
66
66
 
@@ -29,7 +29,7 @@ The location in the UI where the custom component should be placed.
29
29
  The column in the table where the custom component should be placed.
30
30
  ### component
31
31
 
32
- <MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a>>`} />
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
  <DocsLink href="/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent">CustomColumnComponent</DocsLink> interface.
@@ -19,7 +19,7 @@ interface DashboardWidgetConfig {
19
19
 
20
20
  ### loadComponent
21
21
 
22
- <MemberInfo kind="property" type={`() => Promise<Type<any>> | Type<any>`} />
22
+ <MemberInfo kind="property" type={``() => Promise<Type<any>> | Type<any>``} />
23
23
 
24
24
  Used to specify the widget component. Supports both eager- and lazy-loading.
25
25
 
@@ -28,7 +28,7 @@ class IfMultichannelDirective extends IfDirectiveBase<[]> {
28
28
 
29
29
  ### constructor
30
30
 
31
- <MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, dataService: <a href='/reference/admin-ui-api/services/data-service#dataservice'>DataService</a>) => IfMultichannelDirective`} />
31
+ <MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: `TemplateRef<any>`, dataService: <a href='/reference/admin-ui-api/services/data-service#dataservice'>DataService</a>) => IfMultichannelDirective`} />
32
32
 
33
33
 
34
34
 
@@ -30,7 +30,7 @@ class IfPermissionsDirective extends IfDirectiveBase<Array<Permission[] | null>>
30
30
 
31
31
  ### constructor
32
32
 
33
- <MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService) => IfPermissionsDirective`} />
33
+ <MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: `TemplateRef<any>`, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService) => IfPermissionsDirective`} />
34
34
 
35
35
 
36
36
 
@@ -70,17 +70,17 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
70
70
 
71
71
  ### entity$
72
72
 
73
- <MemberInfo kind="property" type={`Observable<Entity>`} />
73
+ <MemberInfo kind="property" type={``Observable<Entity>``} />
74
74
 
75
75
 
76
76
  ### availableLanguages$
77
77
 
78
- <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]>`} />
78
+ <MemberInfo kind="property" type={``Observable<`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`[]>``} />
79
79
 
80
80
 
81
81
  ### languageCode$
82
82
 
83
- <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
83
+ <MemberInfo kind="property" type={``Observable<`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`>``} />
84
84
 
85
85
 
86
86
  ### languageCode
@@ -90,7 +90,7 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
90
90
 
91
91
  ### isNew$
92
92
 
93
- <MemberInfo kind="property" type={`Observable<boolean>`} />
93
+ <MemberInfo kind="property" type={``Observable<boolean>``} />
94
94
 
95
95
 
96
96
  ### id
@@ -145,12 +145,12 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
145
145
 
146
146
  ### setCustomFieldFormValues
147
147
 
148
- <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>) => `} />
148
+ <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>`) => `} />
149
149
 
150
150
 
151
151
  ### getCustomFieldConfig
152
152
 
153
- <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>[]`} />
153
+ <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>[]`} />
154
154
 
155
155
 
156
156
  ### setQueryParam
@@ -41,7 +41,7 @@ class BaseEntityResolver<T> {
41
41
 
42
42
  ### constructor
43
43
 
44
- <MemberInfo kind="method" type={`(router: Router, emptyEntity: T, entityStream: (id: string) => Observable<T | null | undefined>) => BaseEntityResolver`} />
44
+ <MemberInfo kind="method" type={`(router: Router, emptyEntity: T, entityStream: `(id: string) => Observable<T | null | undefined>`) => BaseEntityResolver`} />
45
45
 
46
46
 
47
47
 
@@ -57,27 +57,27 @@ class BaseListComponent<ResultType, ItemType, VariableType extends Record<string
57
57
 
58
58
  ### result$
59
59
 
60
- <MemberInfo kind="property" type={`Observable<ResultType>`} />
60
+ <MemberInfo kind="property" type={``Observable<ResultType>``} />
61
61
 
62
62
 
63
63
  ### items$
64
64
 
65
- <MemberInfo kind="property" type={`Observable<ItemType[]>`} />
65
+ <MemberInfo kind="property" type={``Observable<ItemType[]>``} />
66
66
 
67
67
 
68
68
  ### totalItems$
69
69
 
70
- <MemberInfo kind="property" type={`Observable<number>`} />
70
+ <MemberInfo kind="property" type={``Observable<number>``} />
71
71
 
72
72
 
73
73
  ### itemsPerPage$
74
74
 
75
- <MemberInfo kind="property" type={`Observable<number>`} />
75
+ <MemberInfo kind="property" type={``Observable<number>``} />
76
76
 
77
77
 
78
78
  ### currentPage$
79
79
 
80
- <MemberInfo kind="property" type={`Observable<number>`} />
80
+ <MemberInfo kind="property" type={``Observable<number>``} />
81
81
 
82
82
 
83
83
  ### destroy$
@@ -102,12 +102,12 @@ class BaseListComponent<ResultType, ItemType, VariableType extends Record<string
102
102
 
103
103
  ### setQueryFn
104
104
 
105
- <MemberInfo kind="method" type={`(listQueryFn: ListQueryFn<ResultType>, mappingFn: MappingFn<ItemType, ResultType>, onPageChangeFn?: OnPageChangeFn<VariableType>, defaults?: { take: number; skip: number }) => `} />
105
+ <MemberInfo kind="method" type={`(listQueryFn: `ListQueryFn<ResultType>`, mappingFn: `MappingFn<ItemType, ResultType>`, onPageChangeFn?: `OnPageChangeFn<VariableType>`, defaults?: { take: number; skip: number }) => `} />
106
106
 
107
107
  Sets the fetch function for the list being implemented.
108
108
  ### refreshListOnChanges
109
109
 
110
- <MemberInfo kind="method" type={`(streams: Array<Observable<any>>) => `} />
110
+ <MemberInfo kind="method" type={`(streams: `Array<Observable<any>>`) => `} />
111
111
 
112
112
  Accepts a list of Observables which will trigger a refresh of the list when any of them emit.
113
113
  ### setPageNumber
@@ -122,7 +122,7 @@ Sets the current page number in the url.
122
122
  Sets the number of items per page in the url.
123
123
  ### setVisibleColumns
124
124
 
125
- <MemberInfo kind="method" type={`(columns: Array<DataTable2ColumnComponent<any>>) => `} />
125
+ <MemberInfo kind="method" type={`(columns: `Array<DataTable2ColumnComponent<any>>`) => `} />
126
126
 
127
127
 
128
128
  ### refresh
@@ -43,5 +43,5 @@ Parameters
43
43
 
44
44
  ### config
45
45
 
46
- <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; }`} />
46
+ <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; }``} />
47
47
 
@@ -23,12 +23,12 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
23
23
 
24
24
  ### result$
25
25
 
26
- <MemberInfo kind="property" type={`Observable<ResultOf<T>>`} />
26
+ <MemberInfo kind="property" type={``Observable<ResultOf<T>>``} />
27
27
 
28
28
 
29
29
  ### entity
30
30
 
31
- <MemberInfo kind="property" type={`ResultOf<T>[Field]`} />
31
+ <MemberInfo kind="property" type={``ResultOf<T>[Field]``} />
32
32
 
33
33
 
34
34
  ### constructor
@@ -42,12 +42,12 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
42
42
 
43
43
  ### availableLanguages$
44
44
 
45
- <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]>`} />
45
+ <MemberInfo kind="property" type={``Observable<`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`[]>``} />
46
46
 
47
47
 
48
48
  ### contentLanguage$
49
49
 
50
- <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
50
+ <MemberInfo kind="property" type={``Observable<`<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>`>``} />
51
51
 
52
52
 
53
53
  ### dataService
@@ -87,7 +87,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
87
87
 
88
88
  ### configure
89
89
 
90
- <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>>; }) => `} />
90
+ <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>>; }`) => `} />
91
91
 
92
92
 
93
93
  ### ngOnInit
@@ -97,12 +97,12 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
97
97
 
98
98
  ### createFilterCollection
99
99
 
100
- <MemberInfo kind="method" type={`() => DataTableFilterCollection<NonNullable<NonNullable<Vars['options']>['filter']>>`} />
100
+ <MemberInfo kind="method" type={`() => `DataTableFilterCollection<NonNullable<NonNullable<Vars['options']>['filter']>>``} />
101
101
 
102
102
 
103
103
  ### createSortCollection
104
104
 
105
- <MemberInfo kind="method" type={`() => DataTableSortCollection<NonNullable<NonNullable<Vars['options']>['sort']>>`} />
105
+ <MemberInfo kind="method" type={`() => `DataTableSortCollection<NonNullable<NonNullable<Vars['options']>['sort']>>``} />
106
106
 
107
107
 
108
108
  ### setLanguage
@@ -112,7 +112,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
112
112
 
113
113
  ### getCustomFieldConfig
114
114
 
115
- <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>[]`} />
115
+ <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>[]`} />
116
116
 
117
117
 
118
118
 
@@ -38,7 +38,7 @@ interface NavMenuItem {
38
38
 
39
39
  ### onClick
40
40
 
41
- <MemberInfo kind="property" type={`(event: MouseEvent) => void`} />
41
+ <MemberInfo kind="property" type={``(event: MouseEvent) => void``} />
42
42
 
43
43
 
44
44
  ### icon
@@ -48,12 +48,12 @@ interface NavMenuItem {
48
48
 
49
49
  ### requiresPermission
50
50
 
51
- <MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
51
+ <MemberInfo kind="property" type={``string | ((userPermissions: string[]) => boolean)``} />
52
52
 
53
53
 
54
54
  ### statusBadge
55
55
 
56
- <MemberInfo kind="property" type={`Observable<<a href='/reference/admin-ui-api/nav-menu/navigation-types#navmenubadge'>NavMenuBadge</a>>`} />
56
+ <MemberInfo kind="property" type={``Observable<`<a href='/reference/admin-ui-api/nav-menu/navigation-types#navmenubadge'>NavMenuBadge</a>`>``} />
57
57
 
58
58
 
59
59
 
@@ -49,7 +49,7 @@ interface NavMenuSection {
49
49
 
50
50
  ### requiresPermission
51
51
 
52
- <MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
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
  <DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink> object, you will get a compilation error. Instead, pass the plain
@@ -27,5 +27,5 @@ Parameters
27
27
 
28
28
  ### props
29
29
 
30
- <MemberInfo kind="parameter" type={`PropsWithChildren<{ leftContent?: ReactNode }>`} />
30
+ <MemberInfo kind="parameter" type={``PropsWithChildren<{ leftContent?: ReactNode }>``} />
31
31
 
@@ -27,5 +27,5 @@ Parameters
27
27
 
28
28
  ### props
29
29
 
30
- <MemberInfo kind="parameter" type={`PropsWithChildren<{ title?: string; paddingX?: boolean }>`} />
30
+ <MemberInfo kind="parameter" type={``PropsWithChildren<{ title?: string; paddingX?: boolean }>``} />
31
31
 
@@ -25,5 +25,5 @@ Parameters
25
25
 
26
26
  ### props
27
27
 
28
- <MemberInfo kind="parameter" type={`{ icon: IconShapeTuple; className?: string } &#38; Partial<CdsIconProps>`} />
28
+ <MemberInfo kind="parameter" type={``{ icon: IconShapeTuple; className?: string } &#38; Partial<CdsIconProps>``} />
29
29
 
@@ -33,5 +33,5 @@ Parameters
33
33
 
34
34
  ### props
35
35
 
36
- <MemberInfo kind="parameter" type={`PropsWithChildren<{ for?: string; label?: string; tooltip?: string; invalid?: boolean; errorMessage?: string; }>`} />
36
+ <MemberInfo kind="parameter" type={``PropsWithChildren<{ for?: string; label?: string; tooltip?: string; invalid?: boolean; errorMessage?: string; }>``} />
37
37
 
@@ -25,5 +25,5 @@ Parameters
25
25
 
26
26
  ### props
27
27
 
28
- <MemberInfo kind="parameter" type={`PropsWithChildren<{ href: string; [props: string]: any }>`} />
28
+ <MemberInfo kind="parameter" type={``PropsWithChildren<{ href: string; [props: string]: any }>``} />
29
29
 
@@ -27,5 +27,5 @@ Parameters
27
27
 
28
28
  ### props
29
29
 
30
- <MemberInfo kind="parameter" type={`PropsWithChildren<{ sidebar?: ReactNode }>`} />
30
+ <MemberInfo kind="parameter" type={``PropsWithChildren<{ sidebar?: ReactNode }>``} />
31
31
 
@@ -28,7 +28,7 @@ The id of the detail page location in which to place the component.
28
28
  The React component to render.
29
29
  ### props
30
30
 
31
- <MemberInfo kind="property" type={`Record<string, any>`} />
31
+ <MemberInfo kind="property" type={``Record<string, any>``} />
32
32
 
33
33
  Optional props to pass to the React component.
34
34
 
@@ -35,7 +35,7 @@ The component to render in the table cell. This component will receive the `rowI
35
35
  which is the data object for the row, e.g. the `Product` object if used in the `product-list` table.
36
36
  ### props
37
37
 
38
- <MemberInfo kind="property" type={`Record<string, any>`} />
38
+ <MemberInfo kind="property" type={``Record<string, any>``} />
39
39
 
40
40
  Optional props to pass to the React component.
41
41
 
@@ -30,5 +30,5 @@ Parameters
30
30
 
31
31
  ### token
32
32
 
33
- <MemberInfo kind="parameter" type={`ProviderToken<T>`} />
33
+ <MemberInfo kind="parameter" type={``ProviderToken<T>``} />
34
34
 
@@ -61,7 +61,7 @@ Parameters
61
61
 
62
62
  ### query
63
63
 
64
- <MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode<T, V>`} />
64
+ <MemberInfo kind="parameter" type={``DocumentNode | TypedDocumentNode<T, V>``} />
65
65
 
66
66
  ### options
67
67
 
@@ -53,5 +53,5 @@ Parameters
53
53
 
54
54
  ### mutation
55
55
 
56
- <MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode<T, V>`} />
56
+ <MemberInfo kind="parameter" type={``DocumentNode | TypedDocumentNode<T, V>``} />
57
57
 
@@ -42,7 +42,7 @@ Parameters
42
42
 
43
43
  ### query
44
44
 
45
- <MemberInfo kind="parameter" type={`DocumentNode | TypedDocumentNode<T, V>`} />
45
+ <MemberInfo kind="parameter" type={``DocumentNode | TypedDocumentNode<T, V>``} />
46
46
 
47
47
  ### variables
48
48
 
@@ -20,7 +20,7 @@ class DataService {
20
20
 
21
21
  ### query
22
22
 
23
- <MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} />
23
+ <MemberInfo kind="method" type={`(query: `DocumentNode | TypedDocumentNode<T, V>`, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} />
24
24
 
25
25
  Perform a GraphQL query. Returns a <DocsLink href="/reference/admin-ui-api/services/data-service#queryresult">QueryResult</DocsLink> which allows further control over
26
26
  they type of result returned, e.g. stream of values, single value etc.
@@ -41,7 +41,7 @@ const result$ = this.dataService.query(gql`
41
41
  ```
42
42
  ### mutate
43
43
 
44
- <MemberInfo kind="method" type={`(mutation: DocumentNode | TypedDocumentNode<T, V>, variables?: V, update?: MutationUpdaterFunction<T, V, any, any>, options: ExtendedQueryOptions = {}) => Observable<T>`} />
44
+ <MemberInfo kind="method" type={`(mutation: `DocumentNode | TypedDocumentNode<T, V>`, variables?: V, update?: `MutationUpdaterFunction<T, V, any, any>`, options: ExtendedQueryOptions = {}) => `Observable<T>``} />
45
45
 
46
46
  Perform a GraphQL mutation.
47
47
 
@@ -84,7 +84,7 @@ class QueryResult<T, V extends Record<string, any> = Record<string, any>> {
84
84
 
85
85
  ### constructor
86
86
 
87
- <MemberInfo kind="method" type={`(queryRef: QueryRef<T, V>, apollo: Apollo, customFieldMap: Map<string, <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]>) => QueryResult`} />
87
+ <MemberInfo kind="method" type={`(queryRef: `QueryRef<T, V>`, apollo: Apollo, customFieldMap: `Map<string, `<a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>`[]>`) => QueryResult`} />
88
88
 
89
89
 
90
90
  ### refetchOnChannelChange
@@ -94,33 +94,33 @@ class QueryResult<T, V extends Record<string, any> = Record<string, any>> {
94
94
  Re-fetch this query whenever the active Channel changes.
95
95
  ### refetchOnCustomFieldsChange
96
96
 
97
- <MemberInfo kind="method" type={`(customFieldsToInclude$: Observable<string[]>) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} since="3.0.4" />
97
+ <MemberInfo kind="method" type={`(customFieldsToInclude$: `Observable<string[]>`) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} since="3.0.4" />
98
98
 
99
99
  Re-fetch this query whenever the custom fields change, updating the query to include the
100
100
  specified custom fields.
101
101
  ### single$
102
102
 
103
- <MemberInfo kind="property" type={`Observable<T>`} />
103
+ <MemberInfo kind="property" type={``Observable<T>``} />
104
104
 
105
105
  Returns an Observable which emits a single result and then completes.
106
106
  ### stream$
107
107
 
108
- <MemberInfo kind="property" type={`Observable<T>`} />
108
+ <MemberInfo kind="property" type={``Observable<T>``} />
109
109
 
110
110
  Returns an Observable which emits until unsubscribed.
111
111
  ### ref
112
112
 
113
- <MemberInfo kind="property" type={`QueryRef<T, V>`} />
113
+ <MemberInfo kind="property" type={``QueryRef<T, V>``} />
114
114
 
115
115
 
116
116
  ### mapSingle
117
117
 
118
- <MemberInfo kind="method" type={`(mapFn: (item: T) => R) => Observable<R>`} />
118
+ <MemberInfo kind="method" type={`(mapFn: `(item: T) => R`) => `Observable<R>``} />
119
119
 
120
120
  Returns a single-result Observable after applying the map function.
121
121
  ### mapStream
122
122
 
123
- <MemberInfo kind="method" type={`(mapFn: (item: T) => R) => Observable<R>`} />
123
+ <MemberInfo kind="method" type={`(mapFn: `(item: T) => R`) => `Observable<R>``} />
124
124
 
125
125
  Returns a multiple-result Observable after applying the map function.
126
126
  ### destroy