@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

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 (587) hide show
  1. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +3 -7
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +3 -7
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +4 -8
  4. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -5
  5. package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx +0 -4
  6. package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx +0 -4
  7. package/docs/reference/admin-ui-api/action-bar/page-location-id.mdx +0 -4
  8. package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -5
  9. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -9
  10. package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -5
  11. package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -5
  12. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +7 -23
  13. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -5
  14. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -8
  15. package/docs/reference/admin-ui-api/components/chip-component.mdx +0 -4
  16. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -8
  17. package/docs/reference/admin-ui-api/components/data-table-component.mdx +7 -11
  18. package/docs/reference/admin-ui-api/components/data-table2component.mdx +8 -12
  19. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -11
  20. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -5
  21. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -10
  22. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -5
  23. package/docs/reference/admin-ui-api/components/order-state-label-component.mdx +0 -4
  24. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -5
  25. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -6
  26. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -7
  27. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +2 -6
  28. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -5
  29. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -5
  30. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -5
  31. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -5
  32. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +5 -9
  33. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +2 -6
  34. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -5
  35. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -5
  36. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +24 -92
  37. package/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx +0 -4
  38. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +3 -7
  39. package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx +0 -4
  40. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +3 -7
  41. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -5
  42. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -5
  43. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -5
  44. package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx +0 -4
  45. package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx +0 -4
  46. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -6
  47. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -6
  48. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +7 -11
  49. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +2 -6
  50. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +9 -13
  51. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +2 -6
  52. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +4 -8
  53. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +8 -12
  54. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx +0 -4
  55. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx +0 -4
  56. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -7
  57. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +2 -6
  58. package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx +0 -4
  59. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +0 -4
  60. package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +0 -4
  61. package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +0 -4
  62. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +0 -4
  63. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +0 -4
  64. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +0 -4
  65. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +0 -4
  66. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +0 -4
  67. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +0 -4
  68. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +0 -4
  69. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -5
  70. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -5
  71. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -5
  72. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -5
  73. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -5
  74. package/docs/reference/admin-ui-api/react-components/page-block.mdx +0 -4
  75. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -5
  76. package/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx +0 -4
  77. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -5
  78. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +2 -6
  79. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -5
  80. package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx +0 -4
  81. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -5
  82. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx +0 -4
  83. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -5
  84. package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx +0 -4
  85. package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx +0 -4
  86. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -5
  87. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -5
  88. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -5
  89. package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx +0 -4
  90. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -5
  91. package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx +0 -4
  92. package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx +0 -4
  93. package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx +0 -4
  94. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -5
  95. package/docs/reference/admin-ui-api/services/data-service.mdx +11 -19
  96. package/docs/reference/admin-ui-api/services/modal-service.mdx +6 -22
  97. package/docs/reference/admin-ui-api/services/notification-service.mdx +0 -12
  98. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -5
  99. package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx +0 -4
  100. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +3 -39
  101. package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx +0 -4
  102. package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx +0 -4
  103. package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx +0 -20
  104. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +0 -4
  105. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +1 -5
  106. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +0 -4
  107. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +2 -6
  108. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -5
  109. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +7 -11
  110. package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx +0 -4
  111. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -5
  112. package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx +0 -4
  113. package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx +0 -4
  114. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -13
  115. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +4 -8
  116. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -12
  117. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -11
  118. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +6 -18
  119. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -11
  120. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -5
  121. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -5
  122. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +9 -21
  123. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +2 -6
  124. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +3 -7
  125. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +23 -27
  126. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +2 -6
  127. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -10
  128. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +4 -16
  129. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +10 -62
  130. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +0 -4
  131. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +2 -10
  132. package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -8
  133. package/docs/reference/core-plugins/email-plugin/index.mdx +5 -9
  134. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -12
  135. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +3 -31
  136. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -6
  137. package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx +0 -4
  138. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +2 -6
  139. package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -6
  140. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx +0 -4
  141. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +10 -14
  142. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +6 -14
  143. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +4 -8
  144. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -5
  145. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -10
  146. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -9
  147. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +6 -14
  148. package/docs/reference/core-plugins/sentry-plugin/index.mdx +0 -4
  149. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -5
  150. package/docs/reference/core-plugins/sentry-plugin/sentry-service.mdx +0 -4
  151. package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -7
  152. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +7 -15
  153. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -5
  154. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -5
  155. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -9
  156. package/docs/reference/core-plugins/telemetry-plugin/index.mdx +0 -4
  157. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +0 -8
  158. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +3 -7
  159. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +2 -6
  160. package/docs/reference/dashboard/components/asset-gallery.mdx +4 -12
  161. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +3 -11
  162. package/docs/reference/dashboard/components/channel-chip.mdx +1 -5
  163. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -5
  164. package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -4
  165. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -9
  166. package/docs/reference/dashboard/components/permission-guard.mdx +1 -9
  167. package/docs/reference/dashboard/components/vendure-image.mdx +7 -31
  168. package/docs/reference/dashboard/detail-views/detail-page.mdx +5 -13
  169. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -23
  170. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +4 -12
  171. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -5
  172. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -10
  173. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -5
  174. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -8
  175. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -9
  176. package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -21
  177. package/docs/reference/dashboard/extensions-api/history-entries.mdx +5 -21
  178. package/docs/reference/dashboard/extensions-api/login.mdx +0 -16
  179. package/docs/reference/dashboard/extensions-api/navigation.mdx +0 -8
  180. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -14
  181. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -8
  182. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -5
  183. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -5
  184. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -5
  185. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -5
  186. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -5
  187. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +2 -10
  188. package/docs/reference/dashboard/form-components/money-input.mdx +1 -5
  189. package/docs/reference/dashboard/form-components/number-input.mdx +1 -5
  190. package/docs/reference/dashboard/form-components/password-input.mdx +1 -5
  191. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -5
  192. package/docs/reference/dashboard/form-components/slug-input.mdx +0 -4
  193. package/docs/reference/dashboard/form-components/text-input.mdx +0 -4
  194. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -5
  195. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -9
  196. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -9
  197. package/docs/reference/dashboard/hooks/use-auth.mdx +6 -14
  198. package/docs/reference/dashboard/hooks/use-channel.mdx +3 -11
  199. package/docs/reference/dashboard/hooks/use-custom-field-config.mdx +0 -4
  200. package/docs/reference/dashboard/hooks/use-display-locale.mdx +0 -4
  201. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -5
  202. package/docs/reference/dashboard/hooks/use-local-format.mdx +0 -4
  203. package/docs/reference/dashboard/hooks/use-paginated-list.mdx +0 -4
  204. package/docs/reference/dashboard/hooks/use-permissions.mdx +0 -4
  205. package/docs/reference/dashboard/hooks/use-sorted-languages.mdx +0 -4
  206. package/docs/reference/dashboard/hooks/use-ui-language-loader.mdx +0 -4
  207. package/docs/reference/dashboard/hooks/use-widget-filters.mdx +0 -4
  208. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -15
  209. package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -4
  210. package/docs/reference/dashboard/list-views/data-table.mdx +11 -23
  211. package/docs/reference/dashboard/list-views/list-page.mdx +15 -23
  212. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +19 -27
  213. package/docs/reference/dashboard/page-layout/index.mdx +3 -11
  214. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +5 -17
  215. package/docs/reference/dashboard/page-layout/page-block.mdx +7 -23
  216. package/docs/reference/dashboard/page-layout/page-title.mdx +2 -6
  217. package/docs/reference/dashboard/page-layout/page.mdx +7 -15
  218. package/docs/reference/dashboard/page-layout/use-page-block.mdx +0 -4
  219. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -28
  220. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +0 -4
  221. package/docs/reference/typescript-api/assets/asset-options.mdx +0 -4
  222. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -5
  223. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -10
  224. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -4
  225. package/docs/reference/typescript-api/auth/auth-options.mdx +5 -9
  226. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +3 -7
  227. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -6
  228. package/docs/reference/typescript-api/auth/cookie-options.mdx +0 -4
  229. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +0 -4
  230. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +7 -11
  231. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +0 -4
  232. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +6 -10
  233. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +0 -4
  234. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -7
  235. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +0 -4
  236. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +3 -7
  237. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -6
  238. package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -28
  239. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +8 -20
  240. package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -4
  241. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -6
  242. package/docs/reference/typescript-api/cache/cache-config.mdx +2 -6
  243. package/docs/reference/typescript-api/cache/cache-service.mdx +6 -10
  244. package/docs/reference/typescript-api/cache/cache-strategy.mdx +5 -13
  245. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -11
  246. package/docs/reference/typescript-api/cache/index.mdx +5 -9
  247. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -11
  248. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +5 -9
  249. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -6
  250. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +8 -20
  251. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -7
  252. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -5
  253. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -5
  254. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -5
  255. package/docs/reference/typescript-api/common/async-queue.mdx +1 -5
  256. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -10
  257. package/docs/reference/typescript-api/common/currency-code.mdx +0 -4
  258. package/docs/reference/typescript-api/common/entity-relation-paths.mdx +0 -4
  259. package/docs/reference/typescript-api/common/i18n-service.mdx +0 -8
  260. package/docs/reference/typescript-api/common/id.mdx +1 -5
  261. package/docs/reference/typescript-api/common/injectable-strategy.mdx +3 -7
  262. package/docs/reference/typescript-api/common/injector.mdx +2 -6
  263. package/docs/reference/typescript-api/common/job-state.mdx +0 -4
  264. package/docs/reference/typescript-api/common/json-compatible.mdx +0 -4
  265. package/docs/reference/typescript-api/common/language-code.mdx +0 -4
  266. package/docs/reference/typescript-api/common/middleware.mdx +1 -5
  267. package/docs/reference/typescript-api/common/paginated-list.mdx +0 -4
  268. package/docs/reference/typescript-api/common/permission.mdx +1 -5
  269. package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -6
  270. package/docs/reference/typescript-api/common/process-context.mdx +0 -4
  271. package/docs/reference/typescript-api/common/vendure_version.mdx +0 -4
  272. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -5
  273. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +4 -8
  274. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +2 -6
  275. package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx +0 -4
  276. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -15
  277. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +12 -16
  278. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -5
  279. package/docs/reference/typescript-api/configuration/api-options.mdx +3 -7
  280. package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -7
  281. package/docs/reference/typescript-api/configuration/default-config.mdx +0 -4
  282. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +0 -4
  283. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -18
  284. package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -4
  285. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +6 -18
  286. package/docs/reference/typescript-api/configuration/entity-options.mdx +4 -12
  287. package/docs/reference/typescript-api/configuration/merge-config.mdx +0 -4
  288. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -9
  289. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +5 -17
  290. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +16 -20
  291. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -5
  292. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -5
  293. package/docs/reference/typescript-api/configuration/system-options.mdx +3 -7
  294. package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx +0 -4
  295. package/docs/reference/typescript-api/configuration/vendure-config.mdx +4 -8
  296. package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +0 -4
  297. package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx +0 -4
  298. package/docs/reference/typescript-api/custom-fields/index.mdx +1 -5
  299. package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +0 -4
  300. package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +0 -4
  301. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -5
  302. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -5
  303. package/docs/reference/typescript-api/data-access/calculated.mdx +3 -11
  304. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +2 -6
  305. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +3 -7
  306. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +2 -6
  307. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +5 -13
  308. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +16 -20
  309. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -6
  310. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -5
  311. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -8
  312. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -8
  313. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +5 -9
  314. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -8
  315. package/docs/reference/typescript-api/entities/address.mdx +2 -6
  316. package/docs/reference/typescript-api/entities/administrator.mdx +2 -6
  317. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -5
  318. package/docs/reference/typescript-api/entities/asset.mdx +1 -5
  319. package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -7
  320. package/docs/reference/typescript-api/entities/authentication-method.mdx +4 -16
  321. package/docs/reference/typescript-api/entities/channel.mdx +1 -5
  322. package/docs/reference/typescript-api/entities/collection.mdx +3 -7
  323. package/docs/reference/typescript-api/entities/country.mdx +4 -8
  324. package/docs/reference/typescript-api/entities/customer-group.mdx +2 -6
  325. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -6
  326. package/docs/reference/typescript-api/entities/customer.mdx +2 -6
  327. package/docs/reference/typescript-api/entities/facet-value.mdx +3 -7
  328. package/docs/reference/typescript-api/entities/facet.mdx +4 -8
  329. package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -6
  330. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -5
  331. package/docs/reference/typescript-api/entities/history-entry.mdx +2 -6
  332. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -21
  333. package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -6
  334. package/docs/reference/typescript-api/entities/order-line-reference.mdx +7 -23
  335. package/docs/reference/typescript-api/entities/order-line.mdx +8 -12
  336. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -5
  337. package/docs/reference/typescript-api/entities/order.mdx +8 -12
  338. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -5
  339. package/docs/reference/typescript-api/entities/payment-method.mdx +4 -8
  340. package/docs/reference/typescript-api/entities/payment.mdx +2 -6
  341. package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -7
  342. package/docs/reference/typescript-api/entities/product-option.mdx +3 -7
  343. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -5
  344. package/docs/reference/typescript-api/entities/product-variant.mdx +3 -7
  345. package/docs/reference/typescript-api/entities/product.mdx +3 -7
  346. package/docs/reference/typescript-api/entities/promotion.mdx +6 -10
  347. package/docs/reference/typescript-api/entities/province.mdx +2 -6
  348. package/docs/reference/typescript-api/entities/refund.mdx +1 -5
  349. package/docs/reference/typescript-api/entities/region.mdx +3 -7
  350. package/docs/reference/typescript-api/entities/role.mdx +2 -6
  351. package/docs/reference/typescript-api/entities/seller.mdx +2 -6
  352. package/docs/reference/typescript-api/entities/session.mdx +2 -6
  353. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -5
  354. package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -6
  355. package/docs/reference/typescript-api/entities/shipping-method.mdx +6 -10
  356. package/docs/reference/typescript-api/entities/stock-level.mdx +3 -7
  357. package/docs/reference/typescript-api/entities/stock-location.mdx +3 -7
  358. package/docs/reference/typescript-api/entities/stock-movement.mdx +6 -30
  359. package/docs/reference/typescript-api/entities/surcharge.mdx +2 -6
  360. package/docs/reference/typescript-api/entities/tag.mdx +1 -5
  361. package/docs/reference/typescript-api/entities/tax-category.mdx +2 -6
  362. package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -9
  363. package/docs/reference/typescript-api/entities/user.mdx +2 -6
  364. package/docs/reference/typescript-api/entities/vendure-entity.mdx +2 -6
  365. package/docs/reference/typescript-api/entities/zone.mdx +2 -6
  366. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -6
  367. package/docs/reference/typescript-api/errors/error-result-union.mdx +0 -4
  368. package/docs/reference/typescript-api/errors/error-types.mdx +1 -29
  369. package/docs/reference/typescript-api/errors/i18n-error.mdx +0 -4
  370. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -5
  371. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -6
  372. package/docs/reference/typescript-api/events/event-bus.mdx +10 -14
  373. package/docs/reference/typescript-api/events/event-types.mdx +80 -316
  374. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +0 -4
  375. package/docs/reference/typescript-api/events/vendure-event.mdx +0 -4
  376. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +8 -24
  377. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +8 -16
  378. package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -5
  379. package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -5
  380. package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx +0 -4
  381. package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -7
  382. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -5
  383. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -5
  384. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -5
  385. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -7
  386. package/docs/reference/typescript-api/import-export/asset-importer.mdx +3 -7
  387. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +0 -4
  388. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -8
  389. package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -5
  390. package/docs/reference/typescript-api/import-export/import-parser.mdx +13 -41
  391. package/docs/reference/typescript-api/import-export/importer.mdx +5 -9
  392. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -7
  393. package/docs/reference/typescript-api/import-export/populate.mdx +4 -8
  394. package/docs/reference/typescript-api/import-export/populator.mdx +2 -6
  395. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +10 -22
  396. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +6 -10
  397. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +10 -14
  398. package/docs/reference/typescript-api/job-queue/index.mdx +6 -10
  399. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -9
  400. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +4 -8
  401. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +4 -8
  402. package/docs/reference/typescript-api/job-queue/job-queue-options.mdx +0 -4
  403. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +10 -14
  404. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +4 -8
  405. package/docs/reference/typescript-api/job-queue/job.mdx +5 -17
  406. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +11 -15
  407. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +8 -12
  408. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +7 -11
  409. package/docs/reference/typescript-api/job-queue/types.mdx +6 -30
  410. package/docs/reference/typescript-api/logger/default-logger.mdx +0 -4
  411. package/docs/reference/typescript-api/logger/index.mdx +3 -7
  412. package/docs/reference/typescript-api/logger/log-level.mdx +0 -4
  413. package/docs/reference/typescript-api/logger/vendure-logger.mdx +0 -4
  414. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -5
  415. package/docs/reference/typescript-api/migration/migration-options.mdx +1 -5
  416. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -5
  417. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -5
  418. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +2 -6
  419. package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -5
  420. package/docs/reference/typescript-api/money/money-decorator.mdx +1 -5
  421. package/docs/reference/typescript-api/money/money-strategy.mdx +4 -8
  422. package/docs/reference/typescript-api/money/round-money.mdx +1 -5
  423. package/docs/reference/typescript-api/orders/active-order-service.mdx +7 -11
  424. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +4 -8
  425. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -6
  426. package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -5
  427. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -5
  428. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -11
  429. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -6
  430. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -5
  431. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -5
  432. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -5
  433. package/docs/reference/typescript-api/orders/merge-strategies.mdx +0 -16
  434. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -9
  435. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -9
  436. package/docs/reference/typescript-api/orders/order-interceptor.mdx +7 -11
  437. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -7
  438. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -9
  439. package/docs/reference/typescript-api/orders/order-options.mdx +4 -8
  440. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -5
  441. package/docs/reference/typescript-api/orders/order-process.mdx +16 -44
  442. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +6 -18
  443. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -5
  444. package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -5
  445. package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -5
  446. package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx +0 -4
  447. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +9 -13
  448. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +7 -19
  449. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +3 -7
  450. package/docs/reference/typescript-api/payment/payment-method-types.mdx +19 -63
  451. package/docs/reference/typescript-api/payment/payment-options.mdx +10 -14
  452. package/docs/reference/typescript-api/payment/payment-process.mdx +5 -9
  453. package/docs/reference/typescript-api/payment/payment-state.mdx +0 -4
  454. package/docs/reference/typescript-api/payment/payment-states.mdx +1 -5
  455. package/docs/reference/typescript-api/payment/payment-transition-data.mdx +0 -4
  456. package/docs/reference/typescript-api/payment/refund-process.mdx +5 -9
  457. package/docs/reference/typescript-api/payment/refund-state.mdx +0 -4
  458. package/docs/reference/typescript-api/payment/refund-states.mdx +1 -5
  459. package/docs/reference/typescript-api/payment/refund-transition-data.mdx +0 -4
  460. package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -7
  461. package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -9
  462. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +7 -19
  463. package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -4
  464. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +2 -6
  465. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -5
  466. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +0 -4
  467. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +3 -7
  468. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +4 -8
  469. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -10
  470. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -5
  471. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +9 -21
  472. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +4 -8
  473. package/docs/reference/typescript-api/promotions/promotion-action.mdx +32 -92
  474. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +9 -21
  475. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -6
  476. package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -5
  477. package/docs/reference/typescript-api/request/api-decorator.mdx +1 -5
  478. package/docs/reference/typescript-api/request/api-type.mdx +0 -4
  479. package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -5
  480. package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -5
  481. package/docs/reference/typescript-api/request/request-context-service.mdx +3 -7
  482. package/docs/reference/typescript-api/request/request-context.mdx +5 -9
  483. package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -14
  484. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -5
  485. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -9
  486. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +6 -10
  487. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -16
  488. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -6
  489. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -7
  490. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +8 -16
  491. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +4 -8
  492. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -5
  493. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +4 -8
  494. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +2 -6
  495. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +3 -15
  496. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +3 -7
  497. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -5
  498. package/docs/reference/typescript-api/services/administrator-service.mdx +7 -11
  499. package/docs/reference/typescript-api/services/asset-service.mdx +15 -27
  500. package/docs/reference/typescript-api/services/auth-service.mdx +7 -11
  501. package/docs/reference/typescript-api/services/channel-service.mdx +15 -19
  502. package/docs/reference/typescript-api/services/collection-service.mdx +23 -27
  503. package/docs/reference/typescript-api/services/country-service.mdx +8 -12
  504. package/docs/reference/typescript-api/services/customer-group-service.mdx +10 -14
  505. package/docs/reference/typescript-api/services/customer-service.mdx +37 -41
  506. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -5
  507. package/docs/reference/typescript-api/services/facet-service.mdx +12 -16
  508. package/docs/reference/typescript-api/services/facet-value-service.mdx +13 -17
  509. package/docs/reference/typescript-api/services/fulfillment-service.mdx +7 -11
  510. package/docs/reference/typescript-api/services/global-settings-service.mdx +3 -7
  511. package/docs/reference/typescript-api/services/history-service.mdx +9 -13
  512. package/docs/reference/typescript-api/services/initializer-service.mdx +0 -4
  513. package/docs/reference/typescript-api/services/order-service.mdx +76 -80
  514. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -6
  515. package/docs/reference/typescript-api/services/payment-method-service.mdx +11 -15
  516. package/docs/reference/typescript-api/services/payment-service.mdx +13 -17
  517. package/docs/reference/typescript-api/services/product-option-group-service.mdx +6 -10
  518. package/docs/reference/typescript-api/services/product-option-service.mdx +6 -10
  519. package/docs/reference/typescript-api/services/product-service.mdx +15 -19
  520. package/docs/reference/typescript-api/services/product-variant-service.mdx +29 -33
  521. package/docs/reference/typescript-api/services/promotion-service.mdx +10 -14
  522. package/docs/reference/typescript-api/services/province-service.mdx +6 -10
  523. package/docs/reference/typescript-api/services/role-service.mdx +12 -16
  524. package/docs/reference/typescript-api/services/search-service.mdx +2 -6
  525. package/docs/reference/typescript-api/services/seller-service.mdx +4 -8
  526. package/docs/reference/typescript-api/services/session-service.mdx +12 -16
  527. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -19
  528. package/docs/reference/typescript-api/services/shipping-method-service.mdx +9 -13
  529. package/docs/reference/typescript-api/services/slug-service.mdx +1 -5
  530. package/docs/reference/typescript-api/services/stock-level-service.mdx +8 -12
  531. package/docs/reference/typescript-api/services/stock-location-service.mdx +12 -16
  532. package/docs/reference/typescript-api/services/stock-movement-service.mdx +15 -19
  533. package/docs/reference/typescript-api/services/tag-service.mdx +6 -10
  534. package/docs/reference/typescript-api/services/tax-category-service.mdx +6 -10
  535. package/docs/reference/typescript-api/services/tax-rate-service.mdx +7 -11
  536. package/docs/reference/typescript-api/services/user-service.mdx +20 -24
  537. package/docs/reference/typescript-api/services/zone-service.mdx +9 -13
  538. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.mdx +0 -4
  539. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.mdx +0 -4
  540. package/docs/reference/typescript-api/settings-store/index.mdx +1 -5
  541. package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.mdx +0 -4
  542. package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.mdx +0 -4
  543. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -6
  544. package/docs/reference/typescript-api/settings-store/settings-store-registration.mdx +0 -4
  545. package/docs/reference/typescript-api/settings-store/settings-store-scope-function.mdx +0 -4
  546. package/docs/reference/typescript-api/settings-store/settings-store-scopes.mdx +0 -4
  547. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -6
  548. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -6
  549. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +7 -19
  550. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +4 -8
  551. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +3 -7
  552. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -7
  553. package/docs/reference/typescript-api/shipping/shipping-options.mdx +8 -12
  554. package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -4
  555. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -6
  556. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +5 -21
  557. package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -6
  558. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +2 -6
  559. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +2 -6
  560. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -5
  561. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -11
  562. package/docs/reference/typescript-api/tax/tax-options.mdx +0 -4
  563. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -6
  564. package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -5
  565. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -5
  566. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +3 -7
  567. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +2 -6
  568. package/docs/reference/typescript-api/testing/create-test-environment.mdx +3 -7
  569. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -5
  570. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -5
  571. package/docs/reference/typescript-api/testing/register-initializer.mdx +3 -7
  572. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -9
  573. package/docs/reference/typescript-api/testing/test-config.mdx +1 -5
  574. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +4 -8
  575. package/docs/reference/typescript-api/testing/test-environment.mdx +1 -5
  576. package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -5
  577. package/docs/reference/typescript-api/testing/test-server.mdx +2 -6
  578. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -5
  579. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +4 -12
  580. package/docs/reference/typescript-api/worker/vendure-worker.mdx +3 -7
  581. package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -4
  582. package/package.json +2 -2
  583. package/docs/reference/admin-ui-api/index.mdx +0 -4
  584. package/docs/reference/dashboard/index.mdx +0 -4
  585. package/docs/reference/graphql-api/admin/_index.mdx +0 -4
  586. package/docs/reference/graphql-api/shop/_index.mdx +0 -4
  587. package/docs/reference/typescript-api/_index.mdx +0 -4
@@ -2,15 +2,11 @@
2
2
  title: "BaseEntityResolver"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## BaseEntityResolver
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-entity-resolver.ts" sourceLine="55" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A base resolver for an entity detail route. Resolves to an observable of the given entity, or a "blank"
12
8
  version if the route id equals "create". Should be used together with details views which extend the
13
- <a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a>.
9
+ <DocsLink href="/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent">BaseDetailComponent</DocsLink>.
14
10
 
15
11
  *Example*
16
12
 
@@ -45,7 +41,7 @@ class BaseEntityResolver<T> {
45
41
 
46
42
  ### constructor
47
43
 
48
- <MemberInfo kind="method" type={`(router: Router, emptyEntity: T, entityStream: (id: string) =&#62; Observable&#60;T | null | undefined&#62;) => BaseEntityResolver`} />
44
+ <MemberInfo kind="method" type={`(router: Router, emptyEntity: T, entityStream: (id: string) => Observable<T | null | undefined>) => BaseEntityResolver`} />
49
45
 
50
46
 
51
47
 
@@ -2,16 +2,12 @@
2
2
  title: "BaseListComponent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## BaseListComponent
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-list.component.ts" sourceLine="43" packageName="@vendure/admin-ui" />
10
6
 
11
7
  This is a base class which implements the logic required to fetch and manipulate
12
8
  a list of data from a query which returns a PaginatedList type.
13
9
 
14
- It is normally used in combination with the <a href='/reference/admin-ui-api/components/data-table2component#datatable2component'>DataTable2Component</a>.
10
+ It is normally used in combination with the <DocsLink href="/reference/admin-ui-api/components/data-table2component#datatable2component">DataTable2Component</DocsLink>.
15
11
 
16
12
  ```ts title="Signature"
17
13
  class BaseListComponent<ResultType, ItemType, VariableType extends Record<string, any> = any> implements OnInit, OnDestroy {
@@ -61,27 +57,27 @@ class BaseListComponent<ResultType, ItemType, VariableType extends Record<string
61
57
 
62
58
  ### result$
63
59
 
64
- <MemberInfo kind="property" type={`Observable&#60;ResultType&#62;`} />
60
+ <MemberInfo kind="property" type={`Observable<ResultType>`} />
65
61
 
66
62
 
67
63
  ### items$
68
64
 
69
- <MemberInfo kind="property" type={`Observable&#60;ItemType[]&#62;`} />
65
+ <MemberInfo kind="property" type={`Observable<ItemType[]>`} />
70
66
 
71
67
 
72
68
  ### totalItems$
73
69
 
74
- <MemberInfo kind="property" type={`Observable&#60;number&#62;`} />
70
+ <MemberInfo kind="property" type={`Observable<number>`} />
75
71
 
76
72
 
77
73
  ### itemsPerPage$
78
74
 
79
- <MemberInfo kind="property" type={`Observable&#60;number&#62;`} />
75
+ <MemberInfo kind="property" type={`Observable<number>`} />
80
76
 
81
77
 
82
78
  ### currentPage$
83
79
 
84
- <MemberInfo kind="property" type={`Observable&#60;number&#62;`} />
80
+ <MemberInfo kind="property" type={`Observable<number>`} />
85
81
 
86
82
 
87
83
  ### destroy$
@@ -106,12 +102,12 @@ class BaseListComponent<ResultType, ItemType, VariableType extends Record<string
106
102
 
107
103
  ### setQueryFn
108
104
 
109
- <MemberInfo kind="method" type={`(listQueryFn: ListQueryFn&#60;ResultType&#62;, mappingFn: MappingFn&#60;ItemType, ResultType&#62;, onPageChangeFn?: OnPageChangeFn&#60;VariableType&#62;, 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 }) => `} />
110
106
 
111
107
  Sets the fetch function for the list being implemented.
112
108
  ### refreshListOnChanges
113
109
 
114
- <MemberInfo kind="method" type={`(streams: Array&#60;Observable&#60;any&#62;&#62;) => `} />
110
+ <MemberInfo kind="method" type={`(streams: Array<Observable<any>>) => `} />
115
111
 
116
112
  Accepts a list of Observables which will trigger a refresh of the list when any of them emit.
117
113
  ### setPageNumber
@@ -126,7 +122,7 @@ Sets the current page number in the url.
126
122
  Sets the number of items per page in the url.
127
123
  ### setVisibleColumns
128
124
 
129
- <MemberInfo kind="method" type={`(columns: Array&#60;DataTable2ColumnComponent&#60;any&#62;&#62;) => `} />
125
+ <MemberInfo kind="method" type={`(columns: Array<DataTable2ColumnComponent<any>>) => `} />
130
126
 
131
127
 
132
128
  ### refresh
@@ -2,13 +2,9 @@
2
2
  title: "DetailComponentWithResolver"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## detailComponentWithResolver
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="256" packageName="@vendure/admin-ui" />
10
6
 
11
- A helper function for creating tabs that point to a <a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a>. This takes
7
+ A helper function for creating tabs that point to a <DocsLink href="/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent">TypedBaseDetailComponent</DocsLink>. This takes
12
8
  care of the route resolver parts so that the detail component automatically has access to the
13
9
  correct resolved detail data.
14
10
 
@@ -47,5 +43,5 @@ Parameters
47
43
 
48
44
  ### config
49
45
 
50
- <MemberInfo kind="parameter" type={`{ component: Type&#60;<a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a>&#60;T, Field&#62;&#62;; query: T; entityKey: R; getBreadcrumbs?: (entity: ResultOf&#60;T&#62;[R]) =&#62; BreadcrumbValue; variables?: T extends TypedDocumentNode&#60;any, infer V&#62; ? Omit&#60;V, 'id'&#62; : 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; }`} />
51
47
 
@@ -2,13 +2,9 @@
2
2
  title: "TypedBaseDetailComponent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TypedBaseDetailComponent
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-detail.component.ts" sourceLine="186" packageName="@vendure/admin-ui" />
10
6
 
11
- A version of the <a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a> which is designed to be used with a
7
+ A version of the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent">BaseDetailComponent</DocsLink> which is designed to be used with a
12
8
  [TypedDocumentNode](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node).
13
9
 
14
10
  ```ts title="Signature"
@@ -19,7 +15,7 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
19
15
  init() => ;
20
16
  }
21
17
  ```
22
- * Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a>&#60;NonNullable&#60;ResultOf&#60;T&#62;[Field]&#62;&#62;</code>
18
+ * Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a><NonNullable<ResultOf<T>[Field]>></code>
23
19
 
24
20
 
25
21
 
@@ -27,12 +23,12 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
27
23
 
28
24
  ### result$
29
25
 
30
- <MemberInfo kind="property" type={`Observable&#60;ResultOf&#60;T&#62;&#62;`} />
26
+ <MemberInfo kind="property" type={`Observable<ResultOf<T>>`} />
31
27
 
32
28
 
33
29
  ### entity
34
30
 
35
- <MemberInfo kind="property" type={`ResultOf&#60;T&#62;[Field]`} />
31
+ <MemberInfo kind="property" type={`ResultOf<T>[Field]`} />
36
32
 
37
33
 
38
34
  ### constructor
@@ -2,13 +2,9 @@
2
2
  title: "TypedBaseListComponent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TypedBaseListComponent
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/common/base-list.component.ts" sourceLine="217" packageName="@vendure/admin-ui" />
10
6
 
11
- A version of the <a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a> which is designed to be used with a
7
+ A version of the <DocsLink href="/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent">BaseListComponent</DocsLink> which is designed to be used with a
12
8
  [TypedDocumentNode](https://the-guild.dev/graphql/codegen/plugins/typescript/typed-document-node).
13
9
 
14
10
  ```ts title="Signature"
@@ -35,7 +31,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
35
31
  getCustomFieldConfig(key: Exclude<keyof CustomFields, '__typename'> | string) => CustomFieldConfig[];
36
32
  }
37
33
  ```
38
- * Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a>&#60;ResultOf&#60;T&#62;, ItemOf&#60;ResultOf&#60;T&#62;, Field&#62;, VariablesOf&#60;T&#62;&#62;</code>
34
+ * Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a><ResultOf<T>, ItemOf<ResultOf<T>, Field>, VariablesOf<T>></code>
39
35
 
40
36
 
41
37
  * Implements: <code>OnInit</code>
@@ -46,12 +42,12 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
46
42
 
47
43
  ### availableLanguages$
48
44
 
49
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]&#62;`} />
45
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]>`} />
50
46
 
51
47
 
52
48
  ### contentLanguage$
53
49
 
54
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>&#62;`} />
50
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
55
51
 
56
52
 
57
53
  ### dataService
@@ -91,7 +87,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
91
87
 
92
88
  ### configure
93
89
 
94
- <MemberInfo kind="method" type={`(config: { document: T; getItems: (data: ResultOf&#60;T&#62;) =&#62; { items: Array&#60;ItemOf&#60;ResultOf&#60;T&#62;, Field&#62;&#62;; totalItems: number }; setVariables?: (skip: number, take: number) =&#62; VariablesOf&#60;T&#62;; refreshListOnChanges?: Array&#60;Observable&#60;any&#62;&#62;; }) => `} />
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>>; }) => `} />
95
91
 
96
92
 
97
93
  ### ngOnInit
@@ -101,12 +97,12 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
101
97
 
102
98
  ### createFilterCollection
103
99
 
104
- <MemberInfo kind="method" type={`() => DataTableFilterCollection&#60;NonNullable&#60;NonNullable&#60;Vars['options']&#62;['filter']&#62;&#62;`} />
100
+ <MemberInfo kind="method" type={`() => DataTableFilterCollection<NonNullable<NonNullable<Vars['options']>['filter']>>`} />
105
101
 
106
102
 
107
103
  ### createSortCollection
108
104
 
109
- <MemberInfo kind="method" type={`() => DataTableSortCollection&#60;NonNullable&#60;NonNullable&#60;Vars['options']&#62;['sort']&#62;&#62;`} />
105
+ <MemberInfo kind="method" type={`() => DataTableSortCollection<NonNullable<NonNullable<Vars['options']>['sort']>>`} />
110
106
 
111
107
 
112
108
  ### setLanguage
@@ -116,7 +112,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
116
112
 
117
113
  ### getCustomFieldConfig
118
114
 
119
- <MemberInfo kind="method" type={`(key: Exclude&#60;keyof <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>, '__typename'&#62; | 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>[]`} />
120
116
 
121
117
 
122
118
 
@@ -2,10 +2,6 @@
2
2
  title: "AddNavMenuItem"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## addNavMenuItem
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-nav-menu-item.ts" sourceLine="66" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Add a menu item to an existing section specified by `sectionId`. The id of the section
@@ -2,10 +2,6 @@
2
2
  title: "AddNavMenuSection"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## addNavMenuSection
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/add-nav-menu-item.ts" sourceLine="30" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Add a section to the main nav menu. Providing the `before` argument will
@@ -2,10 +2,6 @@
2
2
  title: "NavMenuItem"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## NavMenuItem
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="37" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A NavMenuItem is a menu item in the main (left-hand side) nav
@@ -42,7 +38,7 @@ interface NavMenuItem {
42
38
 
43
39
  ### onClick
44
40
 
45
- <MemberInfo kind="property" type={`(event: MouseEvent) =&#62; void`} />
41
+ <MemberInfo kind="property" type={`(event: MouseEvent) => void`} />
46
42
 
47
43
 
48
44
  ### icon
@@ -52,12 +48,12 @@ interface NavMenuItem {
52
48
 
53
49
  ### requiresPermission
54
50
 
55
- <MemberInfo kind="property" type={`string | ((userPermissions: string[]) =&#62; boolean)`} />
51
+ <MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
56
52
 
57
53
 
58
54
  ### statusBadge
59
55
 
60
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/admin-ui-api/nav-menu/navigation-types#navmenubadge'>NavMenuBadge</a>&#62;`} />
56
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/admin-ui-api/nav-menu/navigation-types#navmenubadge'>NavMenuBadge</a>>`} />
61
57
 
62
58
 
63
59
 
@@ -2,10 +2,6 @@
2
2
  title: "NavMenuSection"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## NavMenuSection
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="57" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A NavMenuSection is a grouping of links in the main
@@ -53,10 +49,10 @@ interface NavMenuSection {
53
49
 
54
50
  ### requiresPermission
55
51
 
56
- <MemberInfo kind="property" type={`string | ((userPermissions: string[]) =&#62; boolean)`} />
52
+ <MemberInfo kind="property" type={`string | ((userPermissions: string[]) => boolean)`} />
57
53
 
58
54
  Control the display of this item based on the user permissions. Note: if you attempt to pass a
59
- <a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a> object, you will get a compilation error. Instead, pass the plain
55
+ <DocsLink href="/reference/typescript-api/auth/permission-definition#permissiondefinition">PermissionDefinition</DocsLink> object, you will get a compilation error. Instead, pass the plain
60
56
  string version. For example, if the permission is defined as:
61
57
  ```ts
62
58
  export const MyPermission = new PermissionDefinition('ProductReview');
@@ -2,10 +2,6 @@
2
2
  title: "Navigation Types"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## NavMenuBadge
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/nav-builder/nav-builder-types.ts" sourceLine="19" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A color-coded notification badge which will be displayed by the
@@ -2,10 +2,6 @@
2
2
  title: "AssetPreviewPipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## AssetPreviewPipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/asset-preview.pipe.ts" sourceLine="19" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Given an Asset object (an object with `preview` and optionally `focalPoint` properties), this pipe
@@ -2,10 +2,6 @@
2
2
  title: "DurationPipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DurationPipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/duration.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Displays a number of milliseconds in a more human-readable format,
@@ -2,10 +2,6 @@
2
2
  title: "FileSizePipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FileSizePipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/file-size.pipe.ts" sourceLine="14" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Formats a number into a human-readable file size string.
@@ -2,10 +2,6 @@
2
2
  title: "HasPermissionPipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## HasPermissionPipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/has-permission.pipe.ts" sourceLine="16" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A pipe which checks the provided permission against all the permissions of the current user.
@@ -2,10 +2,6 @@
2
2
  title: "LocaleCurrencyNamePipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleCurrencyNamePipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-currency-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Displays a human-readable name for a given ISO 4217 currency code.
@@ -2,10 +2,6 @@
2
2
  title: "LocaleCurrencyPipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleCurrencyPipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-currency.pipe.ts" sourceLine="20" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Formats a Vendure monetary value (in cents) into the correct format for the configured currency and display
@@ -2,10 +2,6 @@
2
2
  title: "LocaleDatePipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleDatePipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-date.pipe.ts" sourceLine="19" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A replacement of the Angular DatePipe which makes use of the Intl API
@@ -2,10 +2,6 @@
2
2
  title: "LocaleLanguageNamePipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleLanguageNamePipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-language-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Displays a human-readable name for a given ISO 639-1 language code.
@@ -2,10 +2,6 @@
2
2
  title: "LocaleRegionNamePipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleRegionNamePipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-region-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Displays a human-readable name for a given region.
@@ -2,10 +2,6 @@
2
2
  title: "TimeAgoPipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TimeAgoPipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/time-ago.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Converts a date into the format "3 minutes ago", "5 hours ago" etc.
@@ -2,10 +2,6 @@
2
2
  title: "ActionBar"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ActionBar
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/ActionBar.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A container for the primary actions on a list or detail page
@@ -31,5 +27,5 @@ Parameters
31
27
 
32
28
  ### props
33
29
 
34
- <MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ leftContent?: ReactNode }&#62;`} />
30
+ <MemberInfo kind="parameter" type={`PropsWithChildren<{ leftContent?: ReactNode }>`} />
35
31
 
@@ -2,10 +2,6 @@
2
2
  title: "Card"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Card
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/Card.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A card component which can be used to group related content.
@@ -31,5 +27,5 @@ Parameters
31
27
 
32
28
  ### props
33
29
 
34
- <MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ title?: string; paddingX?: boolean }&#62;`} />
30
+ <MemberInfo kind="parameter" type={`PropsWithChildren<{ title?: string; paddingX?: boolean }>`} />
35
31
 
@@ -2,10 +2,6 @@
2
2
  title: "CdsIcon"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## CdsIcon
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/CdsIcon.tsx" sourceLine="47" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A React wrapper for the Clarity UI icon component.
@@ -29,5 +25,5 @@ Parameters
29
25
 
30
26
  ### props
31
27
 
32
- <MemberInfo kind="parameter" type={`{ icon: IconShapeTuple; className?: string } &#38; Partial&#60;CdsIconProps&#62;`} />
28
+ <MemberInfo kind="parameter" type={`{ icon: IconShapeTuple; className?: string } &#38; Partial<CdsIconProps>`} />
33
29
 
@@ -2,10 +2,6 @@
2
2
  title: "FormField"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FormField
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/FormField.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A wrapper around form fields which provides a label, tooltip and error message.
@@ -37,5 +33,5 @@ Parameters
37
33
 
38
34
  ### props
39
35
 
40
- <MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ for?: string; label?: string; tooltip?: string; invalid?: boolean; errorMessage?: string; }&#62;`} />
36
+ <MemberInfo kind="parameter" type={`PropsWithChildren<{ for?: string; label?: string; tooltip?: string; invalid?: boolean; errorMessage?: string; }>`} />
41
37
 
@@ -2,10 +2,6 @@
2
2
  title: "Link"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Link
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/Link.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A React component which renders an anchor tag and navigates to the specified route when clicked.
@@ -29,5 +25,5 @@ Parameters
29
25
 
30
26
  ### props
31
27
 
32
- <MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ href: string; [props: string]: any }&#62;`} />
28
+ <MemberInfo kind="parameter" type={`PropsWithChildren<{ href: string; [props: string]: any }>`} />
33
29
 
@@ -2,10 +2,6 @@
2
2
  title: "PageBlock"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PageBlock
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/PageBlock.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A container for page content which provides a consistent width and spacing.
@@ -2,10 +2,6 @@
2
2
  title: "PageDetailLayout"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PageDetailLayout
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/PageDetailLayout.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A responsive container for detail views with a main content area and an optional sidebar.
@@ -31,5 +27,5 @@ Parameters
31
27
 
32
28
  ### props
33
29
 
34
- <MemberInfo kind="parameter" type={`PropsWithChildren&#60;{ sidebar?: ReactNode }&#62;`} />
30
+ <MemberInfo kind="parameter" type={`PropsWithChildren<{ sidebar?: ReactNode }>`} />
35
31
 
@@ -2,10 +2,6 @@
2
2
  title: "RichTextEditor"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## RichTextEditor
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/RichTextEditor.tsx" sourceLine="60" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A rich text editor component which uses ProseMirror (rich text editor) under the hood.
@@ -2,10 +2,6 @@
2
2
  title: "ReactCustomDetailComponentConfig"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ReactCustomDetailComponentConfig
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Configures a React-based component to be placed in a detail page in the given location.
@@ -32,7 +28,7 @@ The id of the detail page location in which to place the component.
32
28
  The React component to render.
33
29
  ### props
34
30
 
35
- <MemberInfo kind="property" type={`Record&#60;string, any&#62;`} />
31
+ <MemberInfo kind="property" type={`Record<string, any>`} />
36
32
 
37
33
  Optional props to pass to the React component.
38
34
 
@@ -2,13 +2,9 @@
2
2
  title: "ReactDataTableComponentConfig"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ReactDataTableComponentConfig
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts" sourceLine="19" packageName="@vendure/admin-ui" />
10
6
 
11
- Configures a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a> to be placed in the given location.
7
+ Configures a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink> to be placed in the given location.
12
8
 
13
9
  ```ts title="Signature"
14
10
  interface ReactDataTableComponentConfig {
@@ -39,7 +35,7 @@ The component to render in the table cell. This component will receive the `rowI
39
35
  which is the data object for the row, e.g. the `Product` object if used in the `product-list` table.
40
36
  ### props
41
37
 
42
- <MemberInfo kind="property" type={`Record&#60;string, any&#62;`} />
38
+ <MemberInfo kind="property" type={`Record<string, any>`} />
43
39
 
44
40
  Optional props to pass to the React component.
45
41