@vendure/docs 0.0.0-202601201656 → 0.0.0-202601210957

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (378) hide show
  1. package/dist/manifest.d.ts +1 -2
  2. package/dist/manifest.d.ts.map +1 -1
  3. package/dist/manifest.js +55 -1
  4. package/dist/manifest.js.map +1 -1
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  6. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  7. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  8. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  9. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
  10. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
  11. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  12. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  13. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  14. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  15. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  16. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  17. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  18. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  20. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  21. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  22. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  23. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  24. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  26. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  27. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  28. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  29. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
  30. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
  31. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  32. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  33. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  34. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  35. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
  36. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
  37. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  38. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  39. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  40. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  41. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  47. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  48. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  49. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  50. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  51. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  52. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  53. package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
  54. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  55. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  56. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
  57. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  58. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  59. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  60. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  61. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  62. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  63. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  64. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  65. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  66. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  67. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  68. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  69. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
  70. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  71. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  72. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  73. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
  74. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  75. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  76. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  77. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  78. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  79. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  80. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  81. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  82. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  83. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  84. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  85. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  86. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  87. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  88. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
  89. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  90. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  91. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  92. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  93. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  94. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  95. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  96. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  97. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  98. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  99. package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
  100. package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
  101. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
  102. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
  103. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  104. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  105. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  106. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  107. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  108. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  109. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  110. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  114. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  115. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  116. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  117. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  118. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  119. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  120. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  121. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  122. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  123. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  124. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  125. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  126. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  127. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  128. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  129. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  130. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  131. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  132. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  133. package/docs/reference/dashboard/page-layout/page.mdx +3 -3
  134. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  135. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  136. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  137. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  138. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  139. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  140. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  141. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
  142. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  143. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  144. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  145. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  146. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  147. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  148. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  149. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  150. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  151. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  152. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  153. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
  154. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  155. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  156. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  157. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  158. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  159. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  160. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  161. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  162. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  163. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
  164. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  165. package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
  166. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
  167. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
  168. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  169. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  170. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  171. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
  172. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  173. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  174. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  175. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  176. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  177. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
  178. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  179. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  180. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  181. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  182. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  183. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  184. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  185. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  186. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  188. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  189. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  190. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  191. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  192. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  194. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  196. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  197. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  199. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  200. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  202. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  204. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  205. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  207. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  208. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  209. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  210. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  212. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  213. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  215. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  216. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  217. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  220. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  221. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  225. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  227. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  228. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  229. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  230. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  231. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  232. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  233. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  234. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  235. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  236. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  237. package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
  238. package/docs/reference/typescript-api/events/event-types.mdx +30 -30
  239. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
  240. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  241. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  242. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  243. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  244. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  245. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  246. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  247. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  248. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  249. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  250. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  251. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  252. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  253. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  254. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  255. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
  256. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  257. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  258. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  259. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  260. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
  261. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  262. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  263. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  264. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  266. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  267. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  268. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  270. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  271. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  273. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  274. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  275. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  276. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  277. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  278. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  279. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  280. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  281. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
  282. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
  283. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
  284. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  285. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  286. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  287. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  288. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  289. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  290. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  291. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  292. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  293. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  294. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  295. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  296. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  297. package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
  298. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
  299. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  300. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  301. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  302. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
  303. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  304. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  305. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  306. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  307. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  308. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  309. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  310. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  311. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  312. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  313. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  314. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  315. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  316. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  317. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  318. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  319. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  320. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  321. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  322. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  323. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  324. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  325. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  326. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  327. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  328. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  329. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  330. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  331. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  332. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  333. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  334. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  335. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  336. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  337. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  338. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  339. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  340. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  341. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  342. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  343. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  344. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  345. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  346. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  347. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  348. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  349. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  350. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  351. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  352. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  353. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
  354. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
  355. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
  356. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  357. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  358. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
  359. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  360. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  361. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  362. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  363. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  364. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  365. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  366. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  367. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  368. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  369. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  370. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  371. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  372. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  373. package/package.json +2 -2
  374. package/docs/reference/admin-ui-api/index.mdx +0 -4
  375. package/docs/reference/dashboard/index.mdx +0 -4
  376. package/docs/reference/graphql-api/admin/_index.mdx +0 -4
  377. package/docs/reference/graphql-api/shop/_index.mdx +0 -4
  378. package/docs/reference/typescript-api/_index.mdx +0 -4
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### props
19
19
 
20
- <MemberInfo kind="parameter" type={`Readonly&#60;ChannelChipProps&#62;`} />
20
+ <MemberInfo kind="parameter" type={`Readonly<ChannelChipProps>`} />
21
21
 
@@ -44,5 +44,5 @@ Parameters
44
44
 
45
45
  ### props
46
46
 
47
- <MemberInfo kind="parameter" type={`Readonly&#60;{ label: string | React.ReactNode; id?: string; href?: string; disabled?: boolean; search?: Record&#60;string, string&#62;; className?: string; }&#62;`} />
47
+ <MemberInfo kind="parameter" type={`Readonly<{ label: string | React.ReactNode; id?: string; href?: string; disabled?: boolean; search?: Record<string, string>; className?: string; }>`} />
48
48
 
@@ -46,7 +46,7 @@ interface FacetValueSelectorProps {
46
46
 
47
47
  ### onValueSelect
48
48
 
49
- <MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>) =&#62; void`} />
49
+ <MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>) => void`} />
50
50
 
51
51
  The function to call when a facet value is selected.
52
52
 
@@ -28,7 +28,7 @@ Parameters
28
28
 
29
29
  ### props
30
30
 
31
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>&#62;`} />
31
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>>`} />
32
32
 
33
33
 
34
34
 
@@ -61,7 +61,7 @@ interface VendureImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
61
61
  ref?: React.Ref<HTMLImageElement>;
62
62
  }
63
63
  ```
64
- * Extends: <code>React.ImgHTMLAttributes&#60;HTMLImageElement&#62;</code>
64
+ * Extends: <code>React.ImgHTMLAttributes<HTMLImageElement></code>
65
65
 
66
66
 
67
67
 
@@ -115,7 +115,7 @@ The fallback to show if no asset is provided. If no fallback is provided,
115
115
  a default placeholder will be shown.
116
116
  ### ref
117
117
 
118
- <MemberInfo kind="property" type={`React.Ref&#60;HTMLImageElement&#62;`} />
118
+ <MemberInfo kind="property" type={`React.Ref<HTMLImageElement>`} />
119
119
 
120
120
  The ref to the image element.
121
121
 
@@ -19,7 +19,7 @@ Parameters
19
19
 
20
20
  ### props
21
21
 
22
- <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a>&#60;T, C, U&#62;`} />
22
+ <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a><T, C, U>`} />
23
23
 
24
24
 
25
25
 
@@ -62,7 +62,7 @@ A unique identifier for the page.
62
62
  The Tanstack Router route used to navigate to this page.
63
63
  ### title
64
64
 
65
- <MemberInfo kind="property" type={`(entity: ResultOf&#60;T&#62;[EntityField]) =&#62; string`} />
65
+ <MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => string`} />
66
66
 
67
67
  The title of the page.
68
68
  ### queryDocument
@@ -82,7 +82,7 @@ The mutation document used to create the entity.
82
82
  The mutation document used to update the entity.
83
83
  ### setValuesForUpdate
84
84
 
85
- <MemberInfo kind="property" type={`(entity: ResultOf&#60;T&#62;[EntityField]) =&#62; VariablesOf&#60;U&#62;['input']`} />
85
+ <MemberInfo kind="property" type={`(entity: ResultOf<T>[EntityField]) => VariablesOf<U>['input']`} />
86
86
 
87
87
  A function that sets the values for the update input type based on the entity.
88
88
 
@@ -78,7 +78,7 @@ Parameters
78
78
 
79
79
  ### options
80
80
 
81
- <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a>&#60;T, C, U, EntityField, VarNameCreate, VarNameUpdate&#62;`} />
81
+ <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a><T, C, U, EntityField, VarNameCreate, VarNameUpdate>`} />
82
82
 
83
83
 
84
84
 
@@ -151,27 +151,27 @@ The document to create the entity.
151
151
  The document to update the entity.
152
152
  ### setValuesForUpdate
153
153
 
154
- <MemberInfo kind="property" type={`( entity: NonNullable&#60;ResultOf&#60;T&#62;[EntityField]&#62;, ) =&#62; WithLooseCustomFields&#60;VariablesOf&#60;U&#62;[VarNameUpdate]&#62;`} />
154
+ <MemberInfo kind="property" type={`( entity: NonNullable<ResultOf<T>[EntityField]>, ) => WithLooseCustomFields<VariablesOf<U>[VarNameUpdate]>`} />
155
155
 
156
156
  The function to set the values for the update document.
157
157
  ### transformCreateInput
158
158
 
159
- <MemberInfo kind="property" type={`(input: VariablesOf&#60;C&#62;[VarNameCreate]) =&#62; VariablesOf&#60;C&#62;[VarNameCreate]`} />
159
+ <MemberInfo kind="property" type={`(input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate]`} />
160
160
 
161
161
 
162
162
  ### transformUpdateInput
163
163
 
164
- <MemberInfo kind="property" type={`(input: VariablesOf&#60;U&#62;[VarNameUpdate]) =&#62; VariablesOf&#60;U&#62;[VarNameUpdate]`} />
164
+ <MemberInfo kind="property" type={`(input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate]`} />
165
165
 
166
166
 
167
167
  ### onSuccess
168
168
 
169
- <MemberInfo kind="property" type={`(entity: ResultOf&#60;C&#62;[keyof ResultOf&#60;C&#62;] | ResultOf&#60;U&#62;[keyof ResultOf&#60;U&#62;]) =&#62; void`} />
169
+ <MemberInfo kind="property" type={`(entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void`} />
170
170
 
171
171
  The function to call when the update is successful.
172
172
  ### onError
173
173
 
174
- <MemberInfo kind="property" type={`(error: unknown) =&#62; void`} />
174
+ <MemberInfo kind="property" type={`(error: unknown) => void`} />
175
175
 
176
176
  The function to call when the update is successful.
177
177
 
@@ -200,17 +200,17 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
200
200
 
201
201
  ### form
202
202
 
203
- <MemberInfo kind="property" type={`UseFormReturn&#60;RemoveNullFields&#60;VariablesOf&#60;U&#62;['input']&#62;&#62;`} />
203
+ <MemberInfo kind="property" type={`UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>`} />
204
204
 
205
205
 
206
206
  ### submitHandler
207
207
 
208
- <MemberInfo kind="property" type={`(event: FormEvent&#60;HTMLFormElement&#62;) =&#62; void`} />
208
+ <MemberInfo kind="property" type={`(event: FormEvent<HTMLFormElement>) => void`} />
209
209
 
210
210
 
211
211
  ### entity
212
212
 
213
- <MemberInfo kind="property" type={`DetailPageEntity&#60;T, EntityField&#62;`} />
213
+ <MemberInfo kind="property" type={`DetailPageEntity<T, EntityField>`} />
214
214
 
215
215
 
216
216
  ### isPending
@@ -220,12 +220,12 @@ interface UseDetailPageResult<T extends TypedDocumentNode<any, any>, U extends T
220
220
 
221
221
  ### refreshEntity
222
222
 
223
- <MemberInfo kind="property" type={`() =&#62; void`} />
223
+ <MemberInfo kind="property" type={`() => void`} />
224
224
 
225
225
 
226
226
  ### resetForm
227
227
 
228
- <MemberInfo kind="property" type={`() =&#62; void`} />
228
+ <MemberInfo kind="property" type={`() => void`} />
229
229
 
230
230
 
231
231
 
@@ -40,7 +40,7 @@ Parameters
40
40
 
41
41
  ### options
42
42
 
43
- <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a>&#60;T, VarName, E&#62;`} />
43
+ <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a><T, VarName, E>`} />
44
44
 
45
45
 
46
46
 
@@ -91,12 +91,12 @@ The entity to use to generate the form.
91
91
 
92
92
  ### setValues
93
93
 
94
- <MemberInfo kind="property" type={`( entity: NonNullable&#60;E&#62;, ) =&#62; WithLooseCustomFields&#60; VarName extends keyof VariablesOf&#60;T&#62; ? VariablesOf&#60;T&#62;[VarName] : VariablesOf&#60;T&#62; &#62;`} />
94
+ <MemberInfo kind="property" type={`( entity: NonNullable<E>, ) => WithLooseCustomFields< VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T> >`} />
95
95
 
96
96
 
97
97
  ### onSubmit
98
98
 
99
- <MemberInfo kind="property" type={`( values: VarName extends keyof VariablesOf&#60;T&#62; ? VariablesOf&#60;T&#62;[VarName] : VariablesOf&#60;T&#62;, ) =&#62; void`} />
99
+ <MemberInfo kind="property" type={`( values: VarName extends keyof VariablesOf<T> ? VariablesOf<T>[VarName] : VariablesOf<T>, ) => void`} />
100
100
 
101
101
 
102
102
 
@@ -32,7 +32,7 @@ interface DashboardActionBarItem {
32
32
  The ID of the page where the action bar item should be displayed.
33
33
  ### component
34
34
 
35
- <MemberInfo kind="property" type={`React.FunctionComponent&#60;{ context: PageContextValue }&#62;`} />
35
+ <MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`} />
36
36
 
37
37
  A React component that will be rendered in the action bar. Typically, you would use
38
38
  the default Shadcn `<Button>` component.
@@ -35,27 +35,27 @@ interface DashboardAlertDefinition<TResponse = any> {
35
35
  A unique identifier for the alert.
36
36
  ### title
37
37
 
38
- <MemberInfo kind="property" type={`string | ((data: TResponse) =&#62; string)`} />
38
+ <MemberInfo kind="property" type={`string | ((data: TResponse) => string)`} />
39
39
 
40
40
  The title of the alert. Can be a string or a function that returns a string based on the response data.
41
41
  ### description
42
42
 
43
- <MemberInfo kind="property" type={`string | ((data: TResponse) =&#62; string)`} />
43
+ <MemberInfo kind="property" type={`string | ((data: TResponse) => string)`} />
44
44
 
45
45
  The description of the alert. Can be a string or a function that returns a string based on the response data.
46
46
  ### severity
47
47
 
48
- <MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse) =&#62; AlertSeverity)`} />
48
+ <MemberInfo kind="property" type={`AlertSeverity | ((data: TResponse) => AlertSeverity)`} />
49
49
 
50
50
  The severity level of the alert.
51
51
  ### check
52
52
 
53
- <MemberInfo kind="property" type={`() =&#62; Promise&#60;TResponse&#62; | TResponse`} />
53
+ <MemberInfo kind="property" type={`() => Promise<TResponse> | TResponse`} />
54
54
 
55
55
  A function that checks the condition and returns the response data.
56
56
  ### shouldShow
57
57
 
58
- <MemberInfo kind="property" type={`(data: TResponse) =&#62; boolean`} />
58
+ <MemberInfo kind="property" type={`(data: TResponse) => boolean`} />
59
59
 
60
60
  A function that determines whether the alert should be rendered based on the response data.
61
61
  ### recheckInterval
@@ -65,7 +65,7 @@ A function that determines whether the alert should be rendered based on the res
65
65
  The interval in milliseconds to recheck the condition.
66
66
  ### actions
67
67
 
68
- <MemberInfo kind="property" type={`Array&#60;{ label: string; onClick: (args: { data: TResponse; dismiss: () =&#62; void }) =&#62; void | Promise&#60;any&#62;; }&#62;`} />
68
+ <MemberInfo kind="property" type={`Array<{ label: string; onClick: (args: { data: TResponse; dismiss: () => void }) => void | Promise<any>; }>`} />
69
69
 
70
70
  Optional actions that can be performed when the alert is shown.
71
71
 
@@ -41,7 +41,7 @@ such as `'product-variants-table'` on the `'product-detail'` page.
41
41
  An array of additional bulk actions that will be available on the data table.
42
42
  ### extendListDocument
43
43
 
44
- <MemberInfo kind="property" type={`string | DocumentNode | (() =&#62; DocumentNode | string)`} />
44
+ <MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`} />
45
45
 
46
46
  Allows you to extend the list document for the data table.
47
47
  ### displayComponents
@@ -66,7 +66,7 @@ interface DashboardDetailFormExtensionDefinition {
66
66
  The ID of the page where the detail form is located, e.g. `'product-detail'`, `'order-detail'`.
67
67
  ### extendDetailDocument
68
68
 
69
- <MemberInfo kind="property" type={`string | DocumentNode | (() =&#62; DocumentNode | string)`} />
69
+ <MemberInfo kind="property" type={`string | DocumentNode | (() => DocumentNode | string)`} />
70
70
 
71
71
  Extends the GraphQL query used to fetch data for the detail page, allowing you to add additional
72
72
  fields that can be used by custom input or display components.
@@ -62,7 +62,7 @@ The `type` should correspond to a valid `HistoryEntryType`, such as
62
62
  how to define custom history entry types.
63
63
  ### component
64
64
 
65
- <MemberInfo kind="property" type={`React.ComponentType&#60;{ entry: <a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>; entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail; }&#62;`} />
65
+ <MemberInfo kind="property" type={`React.ComponentType<{ entry: <a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>; entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail; }>`} />
66
66
 
67
67
  The component which is used to render the timeline entry. It should use the
68
68
  <a href='/reference/dashboard/extensions-api/history-entries#historyentry'>HistoryEntry</a> component and pass the appropriate props to configure
@@ -241,5 +241,5 @@ Parameters
241
241
 
242
242
  ### props
243
243
 
244
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/history-entries#historyentryprops'>HistoryEntryProps</a>&#62;`} />
244
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/history-entries#historyentryprops'>HistoryEntryProps</a>>`} />
245
245
 
@@ -43,12 +43,12 @@ The location of the page block. It specifies the pageId, and then the
43
43
  relative location compared to another existing block.
44
44
  ### component
45
45
 
46
- <MemberInfo kind="property" type={`React.FunctionComponent&#60;{ context: PageContextValue }&#62;`} />
46
+ <MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`} />
47
47
 
48
48
  The component to be rendered inside the page block.
49
49
  ### shouldRender
50
50
 
51
- <MemberInfo kind="property" type={`(context: PageContextValue) =&#62; boolean`} since="3.5.0" />
51
+ <MemberInfo kind="property" type={`(context: PageContextValue) => boolean`} since="3.5.0" />
52
52
 
53
53
  Control whether to render the page block depending on your custom
54
54
  logic.
@@ -25,7 +25,7 @@ interface DashboardRouteDefinition {
25
25
 
26
26
  ### component
27
27
 
28
- <MemberInfo kind="property" type={`(route: AnyRoute) =&#62; React.ReactNode`} />
28
+ <MemberInfo kind="property" type={`(route: AnyRoute) => React.ReactNode`} />
29
29
 
30
30
  The React component that will be rendered for this route.
31
31
  ### path
@@ -35,7 +35,7 @@ The React component that will be rendered for this route.
35
35
  The URL path for this route, e.g. '/my-custom-page'.
36
36
  ### navMenuItem
37
37
 
38
- <MemberInfo kind="property" type={`Partial&#60;<a href='/reference/dashboard/extensions-api/navigation#navmenuitem'>NavMenuItem</a>&#62; &#38; { sectionId: string }`} />
38
+ <MemberInfo kind="property" type={`Partial<<a href='/reference/dashboard/extensions-api/navigation#navmenuitem'>NavMenuItem</a>> &#38; { sectionId: string }`} />
39
39
 
40
40
  Optional navigation menu item configuration to add this route to the nav menu
41
41
  on the left side of the dashboard.
@@ -45,14 +45,14 @@ this item should appear in. It can also point to custom nav menu sections that
45
45
  have been defined using the `navSections` extension property.
46
46
  ### loader
47
47
 
48
- <MemberInfo kind="property" type={`RouteOptions&#60;any&#62;['loader']`} />
48
+ <MemberInfo kind="property" type={`RouteOptions<any>['loader']`} />
49
49
 
50
50
  Optional loader function to fetch data before the route renders.
51
51
  The value is a Tanstack Router
52
52
  [loader function](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#route-loaders)
53
53
  ### validateSearch
54
54
 
55
- <MemberInfo kind="property" type={`RouteOptions&#60;any&#62;['validateSearch']`} />
55
+ <MemberInfo kind="property" type={`RouteOptions<any>['validateSearch']`} />
56
56
 
57
57
  Optional search parameter validation function.
58
58
  The value is a Tanstack Router
@@ -37,7 +37,7 @@ A unique identifier for the widget.
37
37
  The display name of the widget.
38
38
  ### component
39
39
 
40
- <MemberInfo kind="property" type={`React.ComponentType&#60;<a href='/reference/dashboard/extensions-api/widgets#dashboardbasewidgetprops'>DashboardBaseWidgetProps</a>&#62;`} />
40
+ <MemberInfo kind="property" type={`React.ComponentType<<a href='/reference/dashboard/extensions-api/widgets#dashboardbasewidgetprops'>DashboardBaseWidgetProps</a>>`} />
41
41
 
42
42
  The React component that renders the widget.
43
43
  ### defaultSize
@@ -29,5 +29,5 @@ Parameters
29
29
 
30
30
  ### props
31
31
 
32
- <MemberInfo kind="parameter" type={`Readonly&#60;AffixedInputProps&#62;`} />
32
+ <MemberInfo kind="parameter" type={`Readonly<AffixedInputProps>`} />
33
33
 
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### props
19
19
 
20
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
20
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
21
21
 
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### props
19
19
 
20
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
20
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
21
21
 
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### props
19
19
 
20
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
20
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
21
21
 
@@ -43,7 +43,7 @@ Parameters
43
43
 
44
44
  ### props
45
45
 
46
- <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a>&#60;TFieldValues, TName&#62;`} />
46
+ <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a><TFieldValues, TName>`} />
47
47
 
48
48
 
49
49
 
@@ -18,5 +18,5 @@ Parameters
18
18
 
19
19
  ### props
20
20
 
21
- <MemberInfo kind="parameter" type={`Readonly&#60;MoneyInputProps&#62;`} />
21
+ <MemberInfo kind="parameter" type={`Readonly<MoneyInputProps>`} />
22
22
 
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### props
19
19
 
20
- <MemberInfo kind="parameter" type={`Readonly&#60;NumberInputProps&#62;`} />
20
+ <MemberInfo kind="parameter" type={`Readonly<NumberInputProps>`} />
21
21
 
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### props
19
19
 
20
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
20
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
21
21
 
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### props
19
19
 
20
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
20
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
21
21
 
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### props
19
19
 
20
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
20
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
21
21
 
@@ -56,7 +56,7 @@ interface AlertEntry {
56
56
 
57
57
  ### dismiss
58
58
 
59
- <MemberInfo kind="property" type={`() =&#62; void`} />
59
+ <MemberInfo kind="property" type={`() => void`} />
60
60
 
61
61
 
62
62
 
@@ -55,27 +55,27 @@ The error message if the authentication fails.
55
55
  Whether the user is authenticated.
56
56
  ### login
57
57
 
58
- <MemberInfo kind="property" type={`(username: string, password: string, onSuccess?: () =&#62; void) =&#62; void`} />
58
+ <MemberInfo kind="property" type={`(username: string, password: string, onSuccess?: () => void) => void`} />
59
59
 
60
60
  The function to login the user.
61
61
  ### logout
62
62
 
63
- <MemberInfo kind="property" type={`(onSuccess?: () =&#62; void) =&#62; Promise&#60;void&#62;`} />
63
+ <MemberInfo kind="property" type={`(onSuccess?: () => void) => Promise<void>`} />
64
64
 
65
65
  The function to logout the user.
66
66
  ### user
67
67
 
68
- <MemberInfo kind="property" type={`ResultOf&#60;typeof CurrentUserQuery&#62;['activeAdministrator'] | undefined`} />
68
+ <MemberInfo kind="property" type={`ResultOf<typeof CurrentUserQuery>['activeAdministrator'] | undefined`} />
69
69
 
70
70
  The user object.
71
71
  ### channels
72
72
 
73
- <MemberInfo kind="property" type={`NonNullable&#60;ResultOf&#60;typeof CurrentUserQuery&#62;['me']&#62;['channels'] | undefined`} />
73
+ <MemberInfo kind="property" type={`NonNullable<ResultOf<typeof CurrentUserQuery>['me']>['channels'] | undefined`} />
74
74
 
75
75
  The channels object.
76
76
  ### refreshCurrentUser
77
77
 
78
- <MemberInfo kind="property" type={`() =&#62; void`} />
78
+ <MemberInfo kind="property" type={`() => void`} />
79
79
 
80
80
  The function to refresh the current user.
81
81
 
@@ -58,12 +58,12 @@ An array of all available channels.
58
58
  The active channel.
59
59
  ### setActiveChannel
60
60
 
61
- <MemberInfo kind="property" type={`(channelId: string) =&#62; void`} />
61
+ <MemberInfo kind="property" type={`(channelId: string) => void`} />
62
62
 
63
63
  The function to set the active channel.
64
64
  ### refreshChannels
65
65
 
66
- <MemberInfo kind="property" type={`() =&#62; void`} />
66
+ <MemberInfo kind="property" type={`() => void`} />
67
67
 
68
68
  The function to refresh the channels.
69
69
 
@@ -17,5 +17,5 @@ Parameters
17
17
 
18
18
  ### options
19
19
 
20
- <MemberInfo kind="parameter" type={`UseDragAndDropOptions&#60;TData&#62;`} />
20
+ <MemberInfo kind="parameter" type={`UseDragAndDropOptions<TData>`} />
21
21
 
@@ -41,7 +41,7 @@ interface DataTableBulkActionItemProps {
41
41
 
42
42
  ### onClick
43
43
 
44
- <MemberInfo kind="property" type={`() =&#62; void`} />
44
+ <MemberInfo kind="property" type={`() => void`} />
45
45
 
46
46
 
47
47
  ### className
@@ -101,7 +101,7 @@ Parameters
101
101
 
102
102
  ### props
103
103
 
104
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/list-views/bulk-actions#datatablebulkactionitemprops'>DataTableBulkActionItemProps</a>&#62;`} />
104
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/bulk-actions#datatablebulkactionitemprops'>DataTableBulkActionItemProps</a>>`} />
105
105
 
106
106
 
107
107
 
@@ -190,7 +190,7 @@ Optional order number to control the position of this bulk action in the dropdow
190
190
  A larger number will appear lower in the list.
191
191
  ### component
192
192
 
193
- <MemberInfo kind="property" type={`BulkActionComponent&#60;any&#62;`} />
193
+ <MemberInfo kind="property" type={`BulkActionComponent<any>`} />
194
194
 
195
195
  The React component that will be rendered as the bulk action item.
196
196
 
@@ -19,7 +19,7 @@ Parameters
19
19
 
20
20
  ### props
21
21
 
22
- <MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/list-views/data-table#datatableprops'>DataTableProps</a>&#60;TData&#62;&#62;`} />
22
+ <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/list-views/data-table#datatableprops'>DataTableProps</a><TData>>`} />
23
23
 
24
24
 
25
25
 
@@ -65,7 +65,7 @@ interface DataTableProps<TData> {
65
65
 
66
66
  ### columns
67
67
 
68
- <MemberInfo kind="property" type={`ColumnDef&#60;TData, any&#62;[]`} />
68
+ <MemberInfo kind="property" type={`ColumnDef<TData, any>[]`} />
69
69
 
70
70
 
71
71
  ### data
@@ -105,27 +105,27 @@ interface DataTableProps<TData> {
105
105
 
106
106
  ### onPageChange
107
107
 
108
- <MemberInfo kind="property" type={`(table: TableType&#60;TData&#62;, page: number, itemsPerPage: number) =&#62; void`} />
108
+ <MemberInfo kind="property" type={`(table: TableType<TData>, page: number, itemsPerPage: number) => void`} />
109
109
 
110
110
 
111
111
  ### onSortChange
112
112
 
113
- <MemberInfo kind="property" type={`(table: TableType&#60;TData&#62;, sorting: SortingState) =&#62; void`} />
113
+ <MemberInfo kind="property" type={`(table: TableType<TData>, sorting: SortingState) => void`} />
114
114
 
115
115
 
116
116
  ### onFilterChange
117
117
 
118
- <MemberInfo kind="property" type={`(table: TableType&#60;TData&#62;, columnFilters: ColumnFilter[]) =&#62; void`} />
118
+ <MemberInfo kind="property" type={`(table: TableType<TData>, columnFilters: ColumnFilter[]) => void`} />
119
119
 
120
120
 
121
121
  ### onColumnVisibilityChange
122
122
 
123
- <MemberInfo kind="property" type={`(table: TableType&#60;TData&#62;, columnVisibility: VisibilityState) =&#62; void`} />
123
+ <MemberInfo kind="property" type={`(table: TableType<TData>, columnVisibility: VisibilityState) => void`} />
124
124
 
125
125
 
126
126
  ### onSearchTermChange
127
127
 
128
- <MemberInfo kind="property" type={`(searchTerm: string) =&#62; void`} />
128
+ <MemberInfo kind="property" type={`(searchTerm: string) => void`} />
129
129
 
130
130
 
131
131
  ### defaultColumnVisibility
@@ -150,18 +150,18 @@ interface DataTableProps<TData> {
150
150
 
151
151
  ### setTableOptions
152
152
 
153
- <MemberInfo kind="property" type={`(table: TableOptions&#60;TData&#62;) =&#62; TableOptions&#60;TData&#62;`} />
153
+ <MemberInfo kind="property" type={`(table: TableOptions<TData>) => TableOptions<TData>`} />
154
154
 
155
155
  This property allows full control over _all_ features of TanStack Table
156
156
  when needed.
157
157
  ### onRefresh
158
158
 
159
- <MemberInfo kind="property" type={`() =&#62; void`} />
159
+ <MemberInfo kind="property" type={`() => void`} />
160
160
 
161
161
 
162
162
  ### onReorder
163
163
 
164
- <MemberInfo kind="property" type={`(oldIndex: number, newIndex: number, item: TData, allItems?: TData[]) =&#62; void | Promise&#60;void&#62;`} />
164
+ <MemberInfo kind="property" type={`(oldIndex: number, newIndex: number, item: TData, allItems?: TData[]) => void | Promise<void>`} />
165
165
 
166
166
  Callback when items are reordered via drag and drop.
167
167
  When provided, enables drag-and-drop functionality.