@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211038

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 (585) hide show
  1. package/dist/manifest.d.ts.map +1 -1
  2. package/dist/manifest.js +2 -0
  3. package/dist/manifest.js.map +1 -1
  4. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -6
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -5
  6. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -5
  7. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -5
  8. package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx +0 -4
  9. package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx +0 -4
  10. package/docs/reference/admin-ui-api/action-bar/page-location-id.mdx +0 -4
  11. package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -5
  12. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +0 -4
  13. package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -5
  14. package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -5
  15. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +1 -17
  16. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -5
  17. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +0 -4
  18. package/docs/reference/admin-ui-api/components/chip-component.mdx +0 -4
  19. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +0 -4
  20. package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -6
  21. package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -5
  22. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +0 -4
  23. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +0 -4
  24. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +0 -4
  25. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +0 -4
  26. package/docs/reference/admin-ui-api/components/order-state-label-component.mdx +0 -4
  27. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +0 -4
  28. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +0 -4
  29. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +0 -4
  30. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -5
  31. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -5
  32. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +0 -4
  33. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -5
  34. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -5
  35. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -5
  36. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -5
  37. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -5
  38. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -5
  39. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +2 -70
  40. package/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx +0 -4
  41. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -6
  42. package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx +0 -4
  43. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -6
  44. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -5
  45. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +0 -4
  46. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -5
  47. package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx +0 -4
  48. package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx +0 -4
  49. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +0 -4
  50. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +0 -4
  51. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -5
  52. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -5
  53. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -5
  54. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -5
  55. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -5
  56. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +1 -5
  57. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx +0 -4
  58. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx +0 -4
  59. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +0 -4
  60. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -5
  61. package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx +0 -4
  62. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +0 -4
  63. package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +0 -4
  64. package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +0 -4
  65. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +0 -4
  66. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +0 -4
  67. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +0 -4
  68. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +0 -4
  69. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +0 -4
  70. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +0 -4
  71. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +0 -4
  72. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +0 -4
  73. package/docs/reference/admin-ui-api/react-components/card.mdx +0 -4
  74. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +0 -4
  75. package/docs/reference/admin-ui-api/react-components/form-field.mdx +0 -4
  76. package/docs/reference/admin-ui-api/react-components/link.mdx +0 -4
  77. package/docs/reference/admin-ui-api/react-components/page-block.mdx +0 -4
  78. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +0 -4
  79. package/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx +0 -4
  80. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +0 -4
  81. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -5
  82. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -5
  83. package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx +0 -4
  84. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -5
  85. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx +0 -4
  86. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +0 -4
  87. package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx +0 -4
  88. package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx +0 -4
  89. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +0 -4
  90. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +0 -4
  91. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +0 -4
  92. package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx +0 -4
  93. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +0 -4
  94. package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx +0 -4
  95. package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx +0 -4
  96. package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx +0 -4
  97. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +0 -4
  98. package/docs/reference/admin-ui-api/services/data-service.mdx +1 -9
  99. package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -17
  100. package/docs/reference/admin-ui-api/services/notification-service.mdx +0 -12
  101. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +0 -4
  102. package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx +0 -4
  103. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -37
  104. package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx +0 -4
  105. package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx +0 -4
  106. package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx +0 -20
  107. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +0 -4
  108. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +1 -5
  109. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +0 -4
  110. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -5
  111. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +0 -4
  112. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -9
  113. package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx +0 -4
  114. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -5
  115. package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx +0 -4
  116. package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx +0 -4
  117. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +0 -12
  118. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -7
  119. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +0 -4
  120. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +2 -10
  121. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +4 -16
  122. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +2 -10
  123. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -5
  124. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +0 -4
  125. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -13
  126. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -5
  127. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -5
  128. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -14
  129. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -5
  130. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +0 -8
  131. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +1 -13
  132. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -61
  133. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +0 -4
  134. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -9
  135. package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -8
  136. package/docs/reference/core-plugins/email-plugin/index.mdx +4 -8
  137. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +0 -8
  138. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -30
  139. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +0 -4
  140. package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx +0 -4
  141. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -5
  142. package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -6
  143. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx +0 -4
  144. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -5
  145. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -9
  146. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -5
  147. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +0 -4
  148. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +0 -8
  149. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +0 -8
  150. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -9
  151. package/docs/reference/core-plugins/sentry-plugin/index.mdx +0 -4
  152. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -5
  153. package/docs/reference/core-plugins/sentry-plugin/sentry-service.mdx +0 -4
  154. package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -7
  155. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -11
  156. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -5
  157. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +0 -4
  158. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +0 -8
  159. package/docs/reference/core-plugins/telemetry-plugin/index.mdx +0 -4
  160. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +0 -8
  161. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -5
  162. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -5
  163. package/docs/reference/dashboard/components/asset-gallery.mdx +1 -9
  164. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -9
  165. package/docs/reference/dashboard/components/channel-chip.mdx +0 -4
  166. package/docs/reference/dashboard/components/detail-page-button.mdx +0 -4
  167. package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -4
  168. package/docs/reference/dashboard/components/facet-value-selector.mdx +0 -8
  169. package/docs/reference/dashboard/components/permission-guard.mdx +0 -8
  170. package/docs/reference/dashboard/components/vendure-image.mdx +5 -29
  171. package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -10
  172. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +0 -12
  173. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -9
  174. package/docs/reference/dashboard/extensions-api/action-bar.mdx +0 -4
  175. package/docs/reference/dashboard/extensions-api/alerts.mdx +0 -4
  176. package/docs/reference/dashboard/extensions-api/data-tables.mdx +0 -4
  177. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -8
  178. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +0 -8
  179. package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -21
  180. package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -19
  181. package/docs/reference/dashboard/extensions-api/login.mdx +0 -16
  182. package/docs/reference/dashboard/extensions-api/navigation.mdx +0 -8
  183. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +0 -12
  184. package/docs/reference/dashboard/extensions-api/routes.mdx +0 -4
  185. package/docs/reference/dashboard/extensions-api/widgets.mdx +0 -4
  186. package/docs/reference/dashboard/form-components/affixed-input.mdx +0 -4
  187. package/docs/reference/dashboard/form-components/boolean-input.mdx +0 -4
  188. package/docs/reference/dashboard/form-components/checkbox-input.mdx +0 -4
  189. package/docs/reference/dashboard/form-components/date-time-input.mdx +0 -4
  190. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -9
  191. package/docs/reference/dashboard/form-components/money-input.mdx +0 -4
  192. package/docs/reference/dashboard/form-components/number-input.mdx +0 -4
  193. package/docs/reference/dashboard/form-components/password-input.mdx +0 -4
  194. package/docs/reference/dashboard/form-components/rich-text-input.mdx +0 -4
  195. package/docs/reference/dashboard/form-components/slug-input.mdx +0 -4
  196. package/docs/reference/dashboard/form-components/text-input.mdx +0 -4
  197. package/docs/reference/dashboard/form-components/textarea-input.mdx +0 -4
  198. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -9
  199. package/docs/reference/dashboard/hooks/use-alerts.mdx +0 -8
  200. package/docs/reference/dashboard/hooks/use-auth.mdx +1 -9
  201. package/docs/reference/dashboard/hooks/use-channel.mdx +1 -9
  202. package/docs/reference/dashboard/hooks/use-custom-field-config.mdx +0 -4
  203. package/docs/reference/dashboard/hooks/use-display-locale.mdx +0 -4
  204. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +0 -4
  205. package/docs/reference/dashboard/hooks/use-local-format.mdx +0 -4
  206. package/docs/reference/dashboard/hooks/use-paginated-list.mdx +0 -4
  207. package/docs/reference/dashboard/hooks/use-permissions.mdx +0 -4
  208. package/docs/reference/dashboard/hooks/use-sorted-languages.mdx +0 -4
  209. package/docs/reference/dashboard/hooks/use-ui-language-loader.mdx +0 -4
  210. package/docs/reference/dashboard/hooks/use-widget-filters.mdx +0 -4
  211. package/docs/reference/dashboard/list-views/bulk-actions.mdx +0 -12
  212. package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -4
  213. package/docs/reference/dashboard/list-views/data-table.mdx +1 -13
  214. package/docs/reference/dashboard/list-views/list-page.mdx +2 -10
  215. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -10
  216. package/docs/reference/dashboard/page-layout/index.mdx +2 -10
  217. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -14
  218. package/docs/reference/dashboard/page-layout/page-block.mdx +4 -20
  219. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -5
  220. package/docs/reference/dashboard/page-layout/page.mdx +4 -12
  221. package/docs/reference/dashboard/page-layout/use-page-block.mdx +0 -4
  222. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -28
  223. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +0 -4
  224. package/docs/reference/typescript-api/assets/asset-options.mdx +0 -4
  225. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +0 -4
  226. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +0 -4
  227. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -4
  228. package/docs/reference/typescript-api/auth/auth-options.mdx +4 -8
  229. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -5
  230. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +0 -4
  231. package/docs/reference/typescript-api/auth/cookie-options.mdx +0 -4
  232. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +0 -4
  233. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +3 -7
  234. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +0 -4
  235. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -5
  236. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +0 -4
  237. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +0 -4
  238. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +0 -4
  239. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +1 -5
  240. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -5
  241. package/docs/reference/typescript-api/auth/permission-definition.mdx +10 -26
  242. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -16
  243. package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -4
  244. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +0 -4
  245. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -5
  246. package/docs/reference/typescript-api/cache/cache-service.mdx +2 -6
  247. package/docs/reference/typescript-api/cache/cache-strategy.mdx +1 -9
  248. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -11
  249. package/docs/reference/typescript-api/cache/index.mdx +2 -6
  250. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -11
  251. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -5
  252. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +0 -4
  253. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -14
  254. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +2 -6
  255. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +0 -4
  256. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +0 -4
  257. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -5
  258. package/docs/reference/typescript-api/common/async-queue.mdx +0 -4
  259. package/docs/reference/typescript-api/common/bootstrap.mdx +0 -8
  260. package/docs/reference/typescript-api/common/currency-code.mdx +0 -4
  261. package/docs/reference/typescript-api/common/entity-relation-paths.mdx +0 -4
  262. package/docs/reference/typescript-api/common/i18n-service.mdx +0 -8
  263. package/docs/reference/typescript-api/common/id.mdx +1 -5
  264. package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -5
  265. package/docs/reference/typescript-api/common/injector.mdx +0 -4
  266. package/docs/reference/typescript-api/common/job-state.mdx +0 -4
  267. package/docs/reference/typescript-api/common/json-compatible.mdx +0 -4
  268. package/docs/reference/typescript-api/common/language-code.mdx +0 -4
  269. package/docs/reference/typescript-api/common/middleware.mdx +1 -5
  270. package/docs/reference/typescript-api/common/paginated-list.mdx +0 -4
  271. package/docs/reference/typescript-api/common/permission.mdx +1 -5
  272. package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -6
  273. package/docs/reference/typescript-api/common/process-context.mdx +0 -4
  274. package/docs/reference/typescript-api/common/vendure_version.mdx +0 -4
  275. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -5
  276. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -7
  277. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +2 -6
  278. package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx +0 -4
  279. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +0 -4
  280. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -14
  281. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -5
  282. package/docs/reference/typescript-api/configuration/api-options.mdx +1 -5
  283. package/docs/reference/typescript-api/configuration/collection-filter.mdx +0 -4
  284. package/docs/reference/typescript-api/configuration/default-config.mdx +0 -4
  285. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +0 -4
  286. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +0 -12
  287. package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -4
  288. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -14
  289. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -10
  290. package/docs/reference/typescript-api/configuration/merge-config.mdx +0 -4
  291. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +0 -8
  292. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +2 -14
  293. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -5
  294. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -5
  295. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +0 -4
  296. package/docs/reference/typescript-api/configuration/system-options.mdx +3 -7
  297. package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx +0 -4
  298. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -6
  299. package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +0 -4
  300. package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx +0 -4
  301. package/docs/reference/typescript-api/custom-fields/index.mdx +1 -5
  302. package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +0 -4
  303. package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +0 -4
  304. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -5
  305. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +0 -4
  306. package/docs/reference/typescript-api/data-access/calculated.mdx +2 -10
  307. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -5
  308. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -6
  309. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -5
  310. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -9
  311. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -11
  312. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -6
  313. package/docs/reference/typescript-api/default-search-plugin/index.mdx +0 -4
  314. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +0 -4
  315. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +0 -4
  316. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +1 -5
  317. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +0 -4
  318. package/docs/reference/typescript-api/entities/address.mdx +1 -5
  319. package/docs/reference/typescript-api/entities/administrator.mdx +1 -5
  320. package/docs/reference/typescript-api/entities/anonymous-session.mdx +0 -4
  321. package/docs/reference/typescript-api/entities/asset.mdx +0 -4
  322. package/docs/reference/typescript-api/entities/authenticated-session.mdx +2 -6
  323. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -14
  324. package/docs/reference/typescript-api/entities/channel.mdx +0 -4
  325. package/docs/reference/typescript-api/entities/collection.mdx +1 -5
  326. package/docs/reference/typescript-api/entities/country.mdx +3 -7
  327. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -5
  328. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -5
  329. package/docs/reference/typescript-api/entities/customer.mdx +1 -5
  330. package/docs/reference/typescript-api/entities/facet-value.mdx +1 -5
  331. package/docs/reference/typescript-api/entities/facet.mdx +2 -6
  332. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -5
  333. package/docs/reference/typescript-api/entities/global-settings.mdx +0 -4
  334. package/docs/reference/typescript-api/entities/history-entry.mdx +2 -6
  335. package/docs/reference/typescript-api/entities/interfaces.mdx +0 -20
  336. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -5
  337. package/docs/reference/typescript-api/entities/order-line-reference.mdx +4 -20
  338. package/docs/reference/typescript-api/entities/order-line.mdx +7 -11
  339. package/docs/reference/typescript-api/entities/order-modification.mdx +0 -4
  340. package/docs/reference/typescript-api/entities/order.mdx +7 -11
  341. package/docs/reference/typescript-api/entities/orderable-asset.mdx +0 -4
  342. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -6
  343. package/docs/reference/typescript-api/entities/payment.mdx +1 -5
  344. package/docs/reference/typescript-api/entities/product-option-group.mdx +1 -5
  345. package/docs/reference/typescript-api/entities/product-option.mdx +1 -5
  346. package/docs/reference/typescript-api/entities/product-variant-price.mdx +0 -4
  347. package/docs/reference/typescript-api/entities/product-variant.mdx +1 -5
  348. package/docs/reference/typescript-api/entities/product.mdx +1 -5
  349. package/docs/reference/typescript-api/entities/promotion.mdx +2 -6
  350. package/docs/reference/typescript-api/entities/province.mdx +1 -5
  351. package/docs/reference/typescript-api/entities/refund.mdx +0 -4
  352. package/docs/reference/typescript-api/entities/region.mdx +2 -6
  353. package/docs/reference/typescript-api/entities/role.mdx +1 -5
  354. package/docs/reference/typescript-api/entities/seller.mdx +1 -5
  355. package/docs/reference/typescript-api/entities/session.mdx +2 -6
  356. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +0 -4
  357. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -5
  358. package/docs/reference/typescript-api/entities/shipping-method.mdx +2 -6
  359. package/docs/reference/typescript-api/entities/stock-level.mdx +2 -6
  360. package/docs/reference/typescript-api/entities/stock-location.mdx +2 -6
  361. package/docs/reference/typescript-api/entities/stock-movement.mdx +1 -25
  362. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -5
  363. package/docs/reference/typescript-api/entities/tag.mdx +0 -4
  364. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -5
  365. package/docs/reference/typescript-api/entities/tax-rate.mdx +4 -8
  366. package/docs/reference/typescript-api/entities/user.mdx +1 -5
  367. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -5
  368. package/docs/reference/typescript-api/entities/zone.mdx +1 -5
  369. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +0 -4
  370. package/docs/reference/typescript-api/errors/error-result-union.mdx +0 -4
  371. package/docs/reference/typescript-api/errors/error-types.mdx +1 -29
  372. package/docs/reference/typescript-api/errors/i18n-error.mdx +0 -4
  373. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -5
  374. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +0 -4
  375. package/docs/reference/typescript-api/events/event-bus.mdx +6 -10
  376. package/docs/reference/typescript-api/events/event-types.mdx +50 -286
  377. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +0 -4
  378. package/docs/reference/typescript-api/events/vendure-event.mdx +0 -4
  379. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -19
  380. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -12
  381. package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -5
  382. package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -5
  383. package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx +0 -4
  384. package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -7
  385. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -5
  386. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -5
  387. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -5
  388. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +2 -6
  389. package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -6
  390. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +0 -4
  391. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +0 -4
  392. package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -5
  393. package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -36
  394. package/docs/reference/typescript-api/import-export/importer.mdx +2 -6
  395. package/docs/reference/typescript-api/import-export/initial-data.mdx +0 -4
  396. package/docs/reference/typescript-api/import-export/populate.mdx +3 -7
  397. package/docs/reference/typescript-api/import-export/populator.mdx +2 -6
  398. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -17
  399. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -7
  400. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -6
  401. package/docs/reference/typescript-api/job-queue/index.mdx +4 -8
  402. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +0 -4
  403. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +1 -5
  404. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -6
  405. package/docs/reference/typescript-api/job-queue/job-queue-options.mdx +0 -4
  406. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -8
  407. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +1 -5
  408. package/docs/reference/typescript-api/job-queue/job.mdx +2 -14
  409. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -7
  410. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +2 -6
  411. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +4 -8
  412. package/docs/reference/typescript-api/job-queue/types.mdx +5 -29
  413. package/docs/reference/typescript-api/logger/default-logger.mdx +0 -4
  414. package/docs/reference/typescript-api/logger/index.mdx +3 -7
  415. package/docs/reference/typescript-api/logger/log-level.mdx +0 -4
  416. package/docs/reference/typescript-api/logger/vendure-logger.mdx +0 -4
  417. package/docs/reference/typescript-api/migration/generate-migration.mdx +0 -4
  418. package/docs/reference/typescript-api/migration/migration-options.mdx +1 -5
  419. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +0 -4
  420. package/docs/reference/typescript-api/migration/run-migrations.mdx +0 -4
  421. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +2 -6
  422. package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -5
  423. package/docs/reference/typescript-api/money/money-decorator.mdx +1 -5
  424. package/docs/reference/typescript-api/money/money-strategy.mdx +4 -8
  425. package/docs/reference/typescript-api/money/round-money.mdx +1 -5
  426. package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -5
  427. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +1 -5
  428. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -5
  429. package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -5
  430. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -5
  431. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +2 -10
  432. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -5
  433. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -5
  434. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +0 -4
  435. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +0 -4
  436. package/docs/reference/typescript-api/orders/merge-strategies.mdx +0 -16
  437. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +0 -8
  438. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +0 -8
  439. package/docs/reference/typescript-api/orders/order-interceptor.mdx +4 -8
  440. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +2 -6
  441. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -9
  442. package/docs/reference/typescript-api/orders/order-options.mdx +2 -6
  443. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +0 -4
  444. package/docs/reference/typescript-api/orders/order-process.mdx +12 -40
  445. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -15
  446. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +0 -4
  447. package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -5
  448. package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -5
  449. package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx +0 -4
  450. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +3 -7
  451. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +3 -15
  452. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -5
  453. package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -60
  454. package/docs/reference/typescript-api/payment/payment-options.mdx +7 -11
  455. package/docs/reference/typescript-api/payment/payment-process.mdx +1 -5
  456. package/docs/reference/typescript-api/payment/payment-state.mdx +0 -4
  457. package/docs/reference/typescript-api/payment/payment-states.mdx +1 -5
  458. package/docs/reference/typescript-api/payment/payment-transition-data.mdx +0 -4
  459. package/docs/reference/typescript-api/payment/refund-process.mdx +1 -5
  460. package/docs/reference/typescript-api/payment/refund-state.mdx +0 -4
  461. package/docs/reference/typescript-api/payment/refund-states.mdx +1 -5
  462. package/docs/reference/typescript-api/payment/refund-transition-data.mdx +0 -4
  463. package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -7
  464. package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -9
  465. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -15
  466. package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -4
  467. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -5
  468. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +0 -4
  469. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +0 -4
  470. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -6
  471. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -6
  472. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -9
  473. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +0 -4
  474. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +4 -16
  475. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -7
  476. package/docs/reference/typescript-api/promotions/promotion-action.mdx +10 -70
  477. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +4 -16
  478. package/docs/reference/typescript-api/promotions/promotion-options.mdx +0 -4
  479. package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -5
  480. package/docs/reference/typescript-api/request/api-decorator.mdx +1 -5
  481. package/docs/reference/typescript-api/request/api-type.mdx +0 -4
  482. package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -5
  483. package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -5
  484. package/docs/reference/typescript-api/request/request-context-service.mdx +1 -5
  485. package/docs/reference/typescript-api/request/request-context.mdx +5 -9
  486. package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -14
  487. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -5
  488. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -9
  489. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +2 -6
  490. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +0 -12
  491. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -6
  492. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +0 -4
  493. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +3 -11
  494. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -7
  495. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +0 -4
  496. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -5
  497. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -5
  498. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -13
  499. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -5
  500. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +0 -4
  501. package/docs/reference/typescript-api/services/administrator-service.mdx +1 -5
  502. package/docs/reference/typescript-api/services/asset-service.mdx +2 -14
  503. package/docs/reference/typescript-api/services/auth-service.mdx +3 -7
  504. package/docs/reference/typescript-api/services/channel-service.mdx +3 -7
  505. package/docs/reference/typescript-api/services/collection-service.mdx +3 -7
  506. package/docs/reference/typescript-api/services/country-service.mdx +1 -5
  507. package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -6
  508. package/docs/reference/typescript-api/services/customer-service.mdx +13 -17
  509. package/docs/reference/typescript-api/services/entity-slug-service.mdx +0 -4
  510. package/docs/reference/typescript-api/services/facet-service.mdx +1 -5
  511. package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -5
  512. package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -7
  513. package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -5
  514. package/docs/reference/typescript-api/services/history-service.mdx +1 -5
  515. package/docs/reference/typescript-api/services/initializer-service.mdx +0 -4
  516. package/docs/reference/typescript-api/services/order-service.mdx +24 -28
  517. package/docs/reference/typescript-api/services/order-testing-service.mdx +0 -4
  518. package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -5
  519. package/docs/reference/typescript-api/services/payment-service.mdx +6 -10
  520. package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -5
  521. package/docs/reference/typescript-api/services/product-option-service.mdx +1 -5
  522. package/docs/reference/typescript-api/services/product-service.mdx +2 -6
  523. package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -11
  524. package/docs/reference/typescript-api/services/promotion-service.mdx +1 -5
  525. package/docs/reference/typescript-api/services/province-service.mdx +1 -5
  526. package/docs/reference/typescript-api/services/role-service.mdx +1 -5
  527. package/docs/reference/typescript-api/services/search-service.mdx +0 -4
  528. package/docs/reference/typescript-api/services/seller-service.mdx +1 -5
  529. package/docs/reference/typescript-api/services/session-service.mdx +4 -8
  530. package/docs/reference/typescript-api/services/settings-store-service.mdx +0 -4
  531. package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -5
  532. package/docs/reference/typescript-api/services/slug-service.mdx +0 -4
  533. package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -9
  534. package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -9
  535. package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -12
  536. package/docs/reference/typescript-api/services/tag-service.mdx +1 -5
  537. package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -5
  538. package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -5
  539. package/docs/reference/typescript-api/services/user-service.mdx +8 -12
  540. package/docs/reference/typescript-api/services/zone-service.mdx +1 -5
  541. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.mdx +0 -4
  542. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.mdx +0 -4
  543. package/docs/reference/typescript-api/settings-store/index.mdx +1 -5
  544. package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.mdx +0 -4
  545. package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.mdx +0 -4
  546. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +0 -4
  547. package/docs/reference/typescript-api/settings-store/settings-store-registration.mdx +0 -4
  548. package/docs/reference/typescript-api/settings-store/settings-store-scope-function.mdx +0 -4
  549. package/docs/reference/typescript-api/settings-store/settings-store-scopes.mdx +0 -4
  550. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -6
  551. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -5
  552. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +4 -16
  553. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +1 -5
  554. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -5
  555. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +2 -6
  556. package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -7
  557. package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -4
  558. package/docs/reference/typescript-api/state-machine/fsm.mdx +0 -4
  559. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -17
  560. package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -6
  561. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +2 -6
  562. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +2 -6
  563. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -5
  564. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +2 -10
  565. package/docs/reference/typescript-api/tax/tax-options.mdx +0 -4
  566. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -5
  567. package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -5
  568. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -5
  569. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -5
  570. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -5
  571. package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -6
  572. package/docs/reference/typescript-api/testing/error-result-guard.mdx +0 -4
  573. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -5
  574. package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -6
  575. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +0 -4
  576. package/docs/reference/typescript-api/testing/test-config.mdx +1 -5
  577. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -5
  578. package/docs/reference/typescript-api/testing/test-environment.mdx +1 -5
  579. package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -5
  580. package/docs/reference/typescript-api/testing/test-server.mdx +0 -4
  581. package/docs/reference/typescript-api/testing/testing-logger.mdx +0 -4
  582. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -10
  583. package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -5
  584. package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -4
  585. package/package.json +2 -2
@@ -2,10 +2,6 @@
2
2
  title: "StripePlugin"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## StripePlugin
8
-
9
5
  <GenerationInfo sourceFile="packages/payments-plugin/src/stripe/stripe.plugin.ts" sourceLine="160" packageName="@vendure/payments-plugin" />
10
6
 
11
7
  Plugin to enable payments through [Stripe](https://stripe.com/docs) via the Payment Intents API.
@@ -41,7 +37,7 @@ the Stripe CLI to test your webhook locally. See the _local development_ section
41
37
  }),
42
38
  ]
43
39
  ````
44
- For all the plugin options, see the <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a> type.
40
+ For all the plugin options, see the <DocsLink href="/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions">StripePluginOptions</DocsLink> type.
45
41
  2. Create a new PaymentMethod in the Admin UI, and select "Stripe payments" as the handler.
46
42
  3. Set the webhook secret and API key in the PaymentMethod form.
47
43
 
@@ -173,10 +169,6 @@ Initialize the Stripe payment plugin
173
169
 
174
170
 
175
171
  </div>
176
-
177
-
178
- ## StripePluginOptions
179
-
180
172
  <GenerationInfo sourceFile="packages/payments-plugin/src/stripe/types.ts" sourceLine="29" packageName="@vendure/payments-plugin" />
181
173
 
182
174
  Configuration options for the Stripe payments plugin.
@@ -2,10 +2,6 @@
2
2
  title: "SentryPlugin"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SentryPlugin
8
-
9
5
  <GenerationInfo sourceFile="packages/sentry-plugin/src/sentry-plugin.ts" sourceLine="146" packageName="@vendure/sentry-plugin" />
10
6
 
11
7
  This plugin integrates the [Sentry](https://sentry.io) error tracking & performance monitoring
@@ -2,13 +2,9 @@
2
2
  title: "SentryPluginOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SentryPluginOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/sentry-plugin/src/types.ts" sourceLine="7" packageName="@vendure/sentry-plugin" />
10
6
 
11
- Configuration options for the <a href='/reference/core-plugins/sentry-plugin/#sentryplugin'>SentryPlugin</a>.
7
+ Configuration options for the <DocsLink href="/reference/core-plugins/sentry-plugin/#sentryplugin">SentryPlugin</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  interface SentryPluginOptions {
@@ -2,10 +2,6 @@
2
2
  title: "SentryService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SentryService
8
-
9
5
  <GenerationInfo sourceFile="packages/sentry-plugin/src/sentry.service.ts" sourceLine="13" packageName="@vendure/sentry-plugin" />
10
6
 
11
7
  Service for capturing errors and messages to Sentry.
@@ -2,10 +2,6 @@
2
2
  title: "StellatePlugin"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## StellatePlugin
8
-
9
5
  <GenerationInfo sourceFile="packages/stellate-plugin/src/stellate-plugin.ts" sourceLine="246" packageName="@vendure/stellate-plugin" since="2.1.5" />
10
6
 
11
7
  A plugin to integrate the [Stellate](https://stellate.co/) GraphQL caching service with your Vendure server.
@@ -29,7 +25,7 @@ npm install @vendure/stellate-plugin
29
25
  ## Configuration
30
26
 
31
27
  The plugin is configured via the `StellatePlugin.init()` method. This method accepts an options object
32
- which defines the Stellate service name and API token, as well as an array of <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a>s which
28
+ which defines the Stellate service name and API token, as well as an array of <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink>s which
33
29
  define how the plugin will respond to Vendure events in order to trigger calls to the
34
30
  Stellate [Purging API](https://stellate.co/docs/graphql-edge-cache/purging-api).
35
31
 
@@ -152,7 +148,7 @@ export const searchProductsDocument = graphql(`
152
148
 
153
149
  The configuration above only accounts for caching of some of the built-in Vendure entity types. If you have
154
150
  custom entity types, you may well want to add them to the Stellate cache. In this case, you'll also need a way to
155
- purge those entities from the cache when they are updated. This is where the <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a> comes in.
151
+ purge those entities from the cache when they are updated. This is where the <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink> comes in.
156
152
 
157
153
  Let's imagine that you have built a simple CMS plugin for Vendure which exposes an `Article` entity in your Shop API, and
158
154
  you have added this to your Stellate configuration:
@@ -180,7 +176,7 @@ const config: Config = {
180
176
  export default config;
181
177
  ```
182
178
 
183
- You can then add a custom <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a> to the StellatePlugin configuration:
179
+ You can then add a custom <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink> to the StellatePlugin configuration:
184
180
 
185
181
  *Example*
186
182
 
@@ -2,15 +2,11 @@
2
2
  title: "PurgeRule"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PurgeRule
8
-
9
5
  <GenerationInfo sourceFile="packages/stellate-plugin/src/purge-rule.ts" sourceLine="49" packageName="@vendure/stellate-plugin" />
10
6
 
11
7
  Defines a rule that listens for a particular VendureEvent and uses that to
12
8
  make calls to the [Stellate Purging API](https://docs.stellate.co/docs/purging-api) via
13
- the provided <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a> instance.
9
+ the provided <DocsLink href="/reference/core-plugins/stellate-plugin/stellate-service#stellateservice">StellateService</DocsLink> instance.
14
10
 
15
11
  ```ts title="Signature"
16
12
  class PurgeRule<Event extends VendureEvent = VendureEvent> {
@@ -46,13 +42,9 @@ class PurgeRule<Event extends VendureEvent = VendureEvent> {
46
42
 
47
43
 
48
44
  </div>
49
-
50
-
51
- ## PurgeRuleConfig
52
-
53
45
  <GenerationInfo sourceFile="packages/stellate-plugin/src/purge-rule.ts" sourceLine="13" packageName="@vendure/stellate-plugin" />
54
46
 
55
- Configures a <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a>.
47
+ Configures a <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink>.
56
48
 
57
49
  ```ts title="Signature"
58
50
  interface PurgeRuleConfig<Event extends VendureEvent> {
@@ -84,7 +76,7 @@ us to efficiently batch calls to the Stellate Purge API.
84
76
  <MemberInfo kind="property" type={`(handlerArgs: { events: Event[]; stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>; injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>; }) => void | Promise<void>`} />
85
77
 
86
78
  The function to invoke when the specified event is published. This function should use the
87
- <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a> instance to call the Stellate Purge API.
79
+ <DocsLink href="/reference/core-plugins/stellate-plugin/stellate-service#stellateservice">StellateService</DocsLink> instance to call the Stellate Purge API.
88
80
 
89
81
 
90
82
  </div>
@@ -2,10 +2,6 @@
2
2
  title: "StellatePluginOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## StellatePluginOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/stellate-plugin/src/types.ts" sourceLine="9" packageName="@vendure/stellate-plugin" />
10
6
 
11
7
  Configuration options for the StellatePlugin.
@@ -38,7 +34,7 @@ see the [Stellate docs](https://docs.stellate.co/docs/purging-api#authentication
38
34
 
39
35
  <MemberInfo kind="property" type={`<a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a>[]`} />
40
36
 
41
- An array of <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a> instances which are used to define how the plugin will
37
+ An array of <DocsLink href="/reference/core-plugins/stellate-plugin/purge-rule#purgerule">PurgeRule</DocsLink> instances which are used to define how the plugin will
42
38
  respond to Vendure events in order to trigger calls to the Stellate Purging API.
43
39
  ### defaultBufferTimeMs
44
40
 
@@ -2,10 +2,6 @@
2
2
  title: "StellateService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## StellateService
8
-
9
5
  <GenerationInfo sourceFile="packages/stellate-plugin/src/service/stellate.service.ts" sourceLine="23" packageName="@vendure/stellate-plugin" />
10
6
 
11
7
  The StellateService is used to purge the Stellate cache when certain events occur.
@@ -2,10 +2,6 @@
2
2
  title: "GetSdkConfiguration"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## getSdkConfiguration
8
-
9
5
  <GenerationInfo sourceFile="packages/telemetry-plugin/src/instrumentation.ts" sourceLine="89" packageName="@vendure/telemetry-plugin" />
10
6
 
11
7
  Creates a configuration object for the OpenTelemetry Node SDK. This is used to set up a custom
@@ -58,10 +54,6 @@ Parameters
58
54
 
59
55
  <MemberInfo kind="parameter" type={`<a href='/reference/core-plugins/telemetry-plugin/get-sdk-configuration#sdkconfigurationoptions'>SdkConfigurationOptions</a>`} />
60
56
 
61
-
62
-
63
- ## SdkConfigurationOptions
64
-
65
57
  <GenerationInfo sourceFile="packages/telemetry-plugin/src/instrumentation.ts" sourceLine="27" packageName="@vendure/telemetry-plugin" />
66
58
 
67
59
  Options for configuring the OpenTelemetry Node SDK.
@@ -2,10 +2,6 @@
2
2
  title: "TelemetryPlugin"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TelemetryPlugin
8
-
9
5
  <GenerationInfo sourceFile="packages/telemetry-plugin/src/telemetry.plugin.ts" sourceLine="107" packageName="@vendure/telemetry-plugin" since="3.3.0" />
10
6
 
11
7
  The TelemetryPlugin is used to instrument the Vendure application and collect telemetry data using
@@ -2,10 +2,6 @@
2
2
  title: "OtelLogger"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OtelLogger
8
-
9
5
  <GenerationInfo sourceFile="packages/telemetry-plugin/src/config/otel-logger.ts" sourceLine="46" packageName="@vendure/telemetry-plugin" since="3.3.0" />
10
6
 
11
7
  A logger that emits logs to OpenTelemetry and optionally to the console.
@@ -59,10 +55,6 @@ class OtelLogger implements VendureLogger {
59
55
 
60
56
 
61
57
  </div>
62
-
63
-
64
- ## OtelLoggerOptions
65
-
66
58
  <GenerationInfo sourceFile="packages/telemetry-plugin/src/config/otel-logger.ts" sourceLine="14" packageName="@vendure/telemetry-plugin" since="3.3.0" />
67
59
 
68
60
  Options for the OtelLogger.
@@ -2,16 +2,12 @@
2
2
  title: "RegisterMethodHooks"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## registerMethodHooks
8
-
9
5
  <GenerationInfo sourceFile="packages/telemetry-plugin/src/service/method-hooks.service.ts" sourceLine="60" packageName="@vendure/telemetry-plugin" since="3.3.0" />
10
6
 
11
7
  Allows you to register hooks for a specific method of an instrumented class.
12
8
  These hooks allow extra telemetry actions to be performed on the method.
13
9
 
14
- They can then be passed to the <a href='/reference/core-plugins/telemetry-plugin/#telemetryplugin'>TelemetryPlugin</a> via the <a href='/reference/core-plugins/telemetry-plugin/telemetry-plugin-options#telemetrypluginoptions'>TelemetryPluginOptions</a>.
10
+ They can then be passed to the <DocsLink href="/reference/core-plugins/telemetry-plugin/#telemetryplugin">TelemetryPlugin</DocsLink> via the <DocsLink href="/reference/core-plugins/telemetry-plugin/telemetry-plugin-options#telemetrypluginoptions">TelemetryPluginOptions</DocsLink>.
15
11
 
16
12
  *Example*
17
13
 
@@ -2,10 +2,6 @@
2
2
  title: "TelemetryPluginOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TelemetryPluginOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/telemetry-plugin/src/types.ts" sourceLine="18" packageName="@vendure/telemetry-plugin" since="3.3.0" />
10
6
 
11
7
  Configuration options for the TelemetryPlugin.
@@ -45,7 +41,7 @@ TelemetryPlugin.init({
45
41
  This API may change in a future release.
46
42
 
47
43
  Method hooks allow you to add extra telemetry actions to specific methods.
48
- To define hooks on a method, use the <a href='/reference/core-plugins/telemetry-plugin/register-method-hooks#registermethodhooks'>registerMethodHooks</a> function.
44
+ To define hooks on a method, use the <DocsLink href="/reference/core-plugins/telemetry-plugin/register-method-hooks#registermethodhooks">registerMethodHooks</DocsLink> function.
49
45
 
50
46
  *Example*
51
47
 
@@ -2,10 +2,6 @@
2
2
  title: "AssetGallery"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## AssetGallery
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-gallery.tsx" sourceLine="160" packageName="@vendure/dashboard" />
10
6
 
11
7
  A component for displaying a gallery of assets.
@@ -31,13 +27,9 @@ Parameters
31
27
 
32
28
  <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/components/asset-gallery#assetgalleryprops'>AssetGalleryProps</a>`} />
33
29
 
34
-
35
-
36
- ## AssetGalleryProps
37
-
38
30
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-gallery.tsx" sourceLine="83" packageName="@vendure/dashboard" />
39
31
 
40
- Props for the <a href='/reference/dashboard/components/asset-gallery#assetgallery'>AssetGallery</a> component.
32
+ Props for the <DocsLink href="/reference/dashboard/components/asset-gallery#assetgallery">AssetGallery</DocsLink> component.
41
33
 
42
34
  ```ts title="Signature"
43
35
  interface AssetGalleryProps {
@@ -2,10 +2,6 @@
2
2
  title: "AssetPickerDialog"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## AssetPickerDialog
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-picker-dialog.tsx" sourceLine="60" packageName="@vendure/dashboard" />
10
6
 
11
7
  A dialog which allows the creation and selection of assets.
@@ -19,13 +15,9 @@ Parameters
19
15
 
20
16
  <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/components/asset-picker-dialog#assetpickerdialogprops'>AssetPickerDialogProps</a>`} />
21
17
 
22
-
23
-
24
- ## AssetPickerDialogProps
25
-
26
18
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/asset/asset-picker-dialog.tsx" sourceLine="19" packageName="@vendure/dashboard" />
27
19
 
28
- Props for the <a href='/reference/dashboard/components/asset-picker-dialog#assetpickerdialog'>AssetPickerDialog</a> component.
20
+ Props for the <DocsLink href="/reference/dashboard/components/asset-picker-dialog#assetpickerdialog">AssetPickerDialog</DocsLink> component.
29
21
 
30
22
  ```ts title="Signature"
31
23
  interface AssetPickerDialogProps {
@@ -2,10 +2,6 @@
2
2
  title: "ChannelChip"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ChannelChip
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/channel-chip.tsx" sourceLine="18" packageName="@vendure/dashboard" since="3.5.2" />
10
6
 
11
7
  A component for displaying a channel as a chip.
@@ -2,10 +2,6 @@
2
2
  title: "DetailPageButton"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DetailPageButton
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/detail-page-button.tsx" sourceLine="33" packageName="@vendure/dashboard" since="3.4.0" />
10
6
 
11
7
  DetailPageButton is a reusable navigation component designed to provide consistent UX
@@ -2,10 +2,6 @@
2
2
  title: "FacetValueChip"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FacetValueChip
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/facet-value-chip.tsx" sourceLine="30" packageName="@vendure/dashboard" since="3.4.0" />
10
6
 
11
7
  A component for displaying a facet value as a chip.
@@ -2,10 +2,6 @@
2
2
  title: "FacetValueSelector"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FacetValueSelector
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/facet-value-selector.tsx" sourceLine="143" packageName="@vendure/dashboard" since="3.4.0" />
10
6
 
11
7
  A component for selecting facet values.
@@ -25,10 +21,6 @@ Parameters
25
21
 
26
22
  <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/components/facet-value-selector#facetvalueselectorprops'>FacetValueSelectorProps</a>`} />
27
23
 
28
-
29
-
30
- ## FacetValueSelectorProps
31
-
32
24
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/facet-value-selector.tsx" sourceLine="40" packageName="@vendure/dashboard" since="3.4.0" />
33
25
 
34
26
  A component for selecting facet values.
@@ -2,10 +2,6 @@
2
2
  title: "PermissionGuard"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PermissionGuard
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/permission-guard.tsx" sourceLine="44" packageName="@vendure/dashboard" since="3.4.0" />
10
6
 
11
7
  This component is used to protect a route from unauthorized access.
@@ -30,10 +26,6 @@ Parameters
30
26
 
31
27
  <MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/components/permission-guard#permissionguardprops'>PermissionGuardProps</a>>`} />
32
28
 
33
-
34
-
35
- ## PermissionGuardProps
36
-
37
29
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/permission-guard.tsx" sourceLine="12" packageName="@vendure/dashboard" since="3.4.0" />
38
30
 
39
31
  The props for the PermissionGuard component.
@@ -2,10 +2,6 @@
2
2
  title: "VendureImage"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## VendureImage
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="141" packageName="@vendure/dashboard" since="3.4.0" />
10
6
 
11
7
  A component for displaying an image from a Vendure asset.
@@ -39,13 +35,9 @@ Parameters
39
35
 
40
36
  <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/components/vendure-image#vendureimageprops'>VendureImageProps</a>`} />
41
37
 
42
-
43
-
44
- ## VendureImageProps
45
-
46
38
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="59" packageName="@vendure/dashboard" since="3.4.0" />
47
39
 
48
- The props for the <a href='/reference/dashboard/components/vendure-image#vendureimage'>VendureImage</a> component.
40
+ The props for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
49
41
 
50
42
  ```ts title="Signature"
51
43
  interface VendureImageProps extends React.ImgHTMLAttributes<HTMLImageElement> {
@@ -121,13 +113,9 @@ The ref to the image element.
121
113
 
122
114
 
123
115
  </div>
124
-
125
-
126
- ## AssetLike
127
-
128
116
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="13" packageName="@vendure/dashboard" since="3.4.0" />
129
117
 
130
- The type of object that can be used as an asset in the <a href='/reference/dashboard/components/vendure-image#vendureimage'>VendureImage</a> component.
118
+ The type of object that can be used as an asset in the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
131
119
 
132
120
  ```ts title="Signature"
133
121
  interface AssetLike {
@@ -163,35 +151,23 @@ interface AssetLike {
163
151
 
164
152
 
165
153
  </div>
166
-
167
-
168
- ## ImagePreset
169
-
170
154
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="28" packageName="@vendure/dashboard" since="3.4.0" />
171
155
 
172
- The presets that can be used for the <a href='/reference/dashboard/components/vendure-image#vendureimage'>VendureImage</a> component.
156
+ The presets that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
173
157
 
174
158
  ```ts title="Signature"
175
159
  type ImagePreset = 'tiny' | 'thumb' | 'small' | 'medium' | 'large' | 'full' | null
176
160
  ```
177
-
178
-
179
- ## ImageFormat
180
-
181
161
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="38" packageName="@vendure/dashboard" since="3.4.0" />
182
162
 
183
- The formats that can be used for the <a href='/reference/dashboard/components/vendure-image#vendureimage'>VendureImage</a> component.
163
+ The formats that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
184
164
 
185
165
  ```ts title="Signature"
186
166
  type ImageFormat = 'jpg' | 'jpeg' | 'png' | 'webp' | 'avif' | null
187
167
  ```
188
-
189
-
190
- ## ImageMode
191
-
192
168
  <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/vendure-image.tsx" sourceLine="48" packageName="@vendure/dashboard" since="3.4.0" />
193
169
 
194
- The modes that can be used for the <a href='/reference/dashboard/components/vendure-image#vendureimage'>VendureImage</a> component.
170
+ The modes that can be used for the <DocsLink href="/reference/dashboard/components/vendure-image#vendureimage">VendureImage</DocsLink> component.
195
171
 
196
172
  ```ts title="Signature"
197
173
  type ImageMode = 'crop' | 'resize' | null
@@ -2,15 +2,11 @@
2
2
  title: "DetailPage"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DetailPage
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="147" packageName="@vendure/dashboard" since="3.3.0" />
10
6
 
11
7
  Auto-generates a detail page with a form based on the provided query and mutation documents.
12
8
 
13
- For more control over the layout, you would use the more low-level <a href='/reference/dashboard/page-layout/page#page'>Page</a> component.
9
+ For more control over the layout, you would use the more low-level <DocsLink href="/reference/dashboard/page-layout/page#page">Page</DocsLink> component.
14
10
 
15
11
  ```ts title="Signature"
16
12
  function DetailPage<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>>(props: DetailPageProps<T, C, U>): void
@@ -21,13 +17,9 @@ Parameters
21
17
 
22
18
  <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/detail-page#detailpageprops'>DetailPageProps</a><T, C, U>`} />
23
19
 
24
-
25
-
26
- ## DetailPageProps
27
-
28
20
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/detail-page.tsx" sourceLine="43" packageName="@vendure/dashboard" since="3.3.0" />
29
21
 
30
- Props to configure the <a href='/reference/dashboard/detail-views/detail-page#detailpage'>DetailPage</a> component.
22
+ Props to configure the <DocsLink href="/reference/dashboard/detail-views/detail-page#detailpage">DetailPage</DocsLink> component.
31
23
 
32
24
  ```ts title="Signature"
33
25
  interface DetailPageProps<T extends TypedDocumentNode<any, any>, C extends TypedDocumentNode<any, any>, U extends TypedDocumentNode<any, any>, EntityField extends keyof ResultOf<T> = DetailEntityPath<T>> {
@@ -2,10 +2,6 @@
2
2
  title: "UseDetailPage"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useDetailPage
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="240" packageName="@vendure/dashboard" since="3.3.0" />
10
6
 
11
7
  **Status: Developer Preview**
@@ -80,10 +76,6 @@ Parameters
80
76
 
81
77
  <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-detail-page#detailpageoptions'>DetailPageOptions</a><T, C, U, EntityField, VarNameCreate, VarNameUpdate>`} />
82
78
 
83
-
84
-
85
- ## DetailPageOptions
86
-
87
79
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="46" packageName="@vendure/dashboard" since="3.3.0" />
88
80
 
89
81
  Options used to configure the result of the `useDetailPage` hook.
@@ -177,10 +169,6 @@ The function to call when the update is successful.
177
169
 
178
170
 
179
171
  </div>
180
-
181
-
182
- ## UseDetailPageResult
183
-
184
172
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/page/use-detail-page.ts" sourceLine="158" packageName="@vendure/dashboard" since="3.3.0" />
185
173
 
186
174
 
@@ -2,17 +2,13 @@
2
2
  title: "UseGeneratedForm"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useGeneratedForm
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="86" packageName="@vendure/dashboard" since="3.3.0" />
10
6
 
11
7
  This hook is used to create a form from a document and an entity.
12
8
  It will create a form with the fields defined in the document's input type.
13
9
  It will also create a submit handler that will submit the form to the server.
14
10
 
15
- This hook is mostly used internally by the higher-level <a href='/reference/dashboard/detail-views/use-detail-page#usedetailpage'>useDetailPage</a> hook,
11
+ This hook is mostly used internally by the higher-level <DocsLink href="/reference/dashboard/detail-views/use-detail-page#usedetailpage">useDetailPage</DocsLink> hook,
16
12
  but can in some cases be useful to use directly.
17
13
 
18
14
  *Example*
@@ -42,10 +38,6 @@ Parameters
42
38
 
43
39
  <MemberInfo kind="parameter" type={`<a href='/reference/dashboard/detail-views/use-generated-form#generatedformoptions'>GeneratedFormOptions</a><T, VarName, E>`} />
44
40
 
45
-
46
-
47
- ## GeneratedFormOptions
48
-
49
41
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/use-generated-form.tsx" sourceLine="24" packageName="@vendure/dashboard" since="3.3.0" />
50
42
 
51
43
  Options for the useGeneratedForm hook.
@@ -2,10 +2,6 @@
2
2
  title: "ActionBar"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DashboardActionBarItem
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/layout.ts" sourceLine="17" packageName="@vendure/dashboard" since="3.3.0" />
10
6
 
11
7
  Allows you to define custom action bar items for any page in the dashboard, which is the
@@ -2,10 +2,6 @@
2
2
  title: "Alerts"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DashboardAlertDefinition
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/alerts.ts" sourceLine="11" packageName="@vendure/dashboard" since="3.3.0" />
10
6
 
11
7
  Allows you to define custom alerts that can be displayed in the dashboard.
@@ -2,10 +2,6 @@
2
2
  title: "DataTables"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DashboardDataTableExtensionDefinition
8
-
9
5
  <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/data-table.ts" sourceLine="131" packageName="@vendure/dashboard" since="3.4.0" />
10
6
 
11
7
  This allows you to customize aspects of existing data tables in the dashboard.