@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,13 +2,9 @@
2
2
  title: "Collection"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Collection
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/collection/collection.entity.ts" sourceLine="35" packageName="@vendure/core" />
10
6
 
11
- A Collection is a grouping of <a href='/reference/typescript-api/entities/product#product'>Product</a>s based on various configurable criteria.
7
+ A Collection is a grouping of <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink>s based on various configurable criteria.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class Collection extends VendureEntity implements Translatable, HasCustomFields, ChannelAware, Orderable {
@@ -58,7 +54,7 @@ class Collection extends VendureEntity implements Translatable, HasCustomFields,
58
54
 
59
55
  ### constructor
60
56
 
61
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>&#62;) => Collection`} />
57
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>>) => Collection`} />
62
58
 
63
59
 
64
60
  ### isRoot
@@ -93,7 +89,7 @@ class Collection extends VendureEntity implements Translatable, HasCustomFields,
93
89
 
94
90
  ### translations
95
91
 
96
- <MemberInfo kind="property" type={`Array&#60;Translation&#60;<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>&#62;&#62;`} />
92
+ <MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/collection#collection'>Collection</a>>>`} />
97
93
 
98
94
 
99
95
  ### featuredAsset
@@ -2,15 +2,11 @@
2
2
  title: "Country"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Country
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/region/country.entity.ts" sourceLine="14" packageName="@vendure/core" />
10
6
 
11
- A country to which is available when creating / updating an <a href='/reference/typescript-api/entities/address#address'>Address</a>. Countries are
12
- grouped together into <a href='/reference/typescript-api/entities/zone#zone'>Zone</a>s which are in turn used to determine applicable shipping
13
- and taxes for an <a href='/reference/typescript-api/entities/order#order'>Order</a>.
7
+ A country to which is available when creating / updating an <DocsLink href="/reference/typescript-api/entities/address#address">Address</DocsLink>. Countries are
8
+ grouped together into <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink>s which are in turn used to determine applicable shipping
9
+ and taxes for an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>.
14
10
 
15
11
  ```ts title="Signature"
16
12
  class Country extends Region {
@@ -26,7 +22,7 @@ class Country extends Region {
26
22
 
27
23
  ### constructor
28
24
 
29
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/country#country'>Country</a>&#62;) => Country`} />
25
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/country#country'>Country</a>>) => Country`} />
30
26
 
31
27
 
32
28
  ### type
@@ -2,13 +2,9 @@
2
2
  title: "CustomerGroup"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## CustomerGroup
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/customer-group/customer-group.entity.ts" sourceLine="17" packageName="@vendure/core" />
10
6
 
11
- A grouping of <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>s which enables features such as group-based promotions
7
+ A grouping of <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink>s which enables features such as group-based promotions
12
8
  or tax rules.
13
9
 
14
10
  ```ts title="Signature"
@@ -34,7 +30,7 @@ class CustomerGroup extends VendureEntity implements HasCustomFields {
34
30
 
35
31
  ### constructor
36
32
 
37
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>&#62;) => CustomerGroup`} />
33
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/customer-group#customergroup'>CustomerGroup</a>>) => CustomerGroup`} />
38
34
 
39
35
 
40
36
  ### name
@@ -2,13 +2,9 @@
2
2
  title: "CustomerHistoryEntry"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## CustomerHistoryEntry
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/history-entry/customer-history-entry.entity.ts" sourceLine="14" packageName="@vendure/core" />
10
6
 
11
- Represents an event in the history of a particular <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>.
7
+ Represents an event in the history of a particular <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class CustomerHistoryEntry extends HistoryEntry {
@@ -26,7 +22,7 @@ class CustomerHistoryEntry extends HistoryEntry {
26
22
 
27
23
  ### constructor
28
24
 
29
- <MemberInfo kind="method" type={`(input: DeepPartial&#60;<a href='/reference/typescript-api/entities/customer-history-entry#customerhistoryentry'>CustomerHistoryEntry</a>&#62;) => CustomerHistoryEntry`} />
25
+ <MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/customer-history-entry#customerhistoryentry'>CustomerHistoryEntry</a>>) => CustomerHistoryEntry`} />
30
26
 
31
27
 
32
28
  ### customer
@@ -2,14 +2,10 @@
2
2
  title: "Customer"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Customer
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/customer/customer.entity.ts" sourceLine="22" packageName="@vendure/core" />
10
6
 
11
7
  This entity represents a customer of the store, typically an individual person. A Customer can be
12
- a guest, in which case it has no associated <a href='/reference/typescript-api/entities/user#user'>User</a>. Customers with registered account will
8
+ a guest, in which case it has no associated <DocsLink href="/reference/typescript-api/entities/user#user">User</DocsLink>. Customers with registered account will
13
9
  have an associated User entity.
14
10
 
15
11
  ```ts title="Signature"
@@ -53,7 +49,7 @@ class Customer extends VendureEntity implements ChannelAware, HasCustomFields, S
53
49
 
54
50
  ### constructor
55
51
 
56
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>&#62;) => Customer`} />
52
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>>) => Customer`} />
57
53
 
58
54
 
59
55
  ### deletedAt
@@ -2,13 +2,9 @@
2
2
  title: "FacetValue"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FacetValue
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/facet-value/facet-value.entity.ts" sourceLine="23" packageName="@vendure/core" />
10
6
 
11
- A particular value of a <a href='/reference/typescript-api/entities/facet#facet'>Facet</a>.
7
+ A particular value of a <DocsLink href="/reference/typescript-api/entities/facet#facet">Facet</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class FacetValue extends VendureEntity implements Translatable, HasCustomFields, ChannelAware {
@@ -44,7 +40,7 @@ class FacetValue extends VendureEntity implements Translatable, HasCustomFields,
44
40
 
45
41
  ### constructor
46
42
 
47
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>&#62;) => FacetValue`} />
43
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>) => FacetValue`} />
48
44
 
49
45
 
50
46
  ### name
@@ -59,7 +55,7 @@ class FacetValue extends VendureEntity implements Translatable, HasCustomFields,
59
55
 
60
56
  ### translations
61
57
 
62
- <MemberInfo kind="property" type={`Array&#60;Translation&#60;<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>&#62;&#62;`} />
58
+ <MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>>`} />
63
59
 
64
60
 
65
61
  ### facet
@@ -2,17 +2,13 @@
2
2
  title: "Facet"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Facet
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/facet/facet.entity.ts" sourceLine="25" packageName="@vendure/core" />
10
6
 
11
- A Facet is a class of properties which can be applied to a <a href='/reference/typescript-api/entities/product#product'>Product</a> or <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>.
7
+ A Facet is a class of properties which can be applied to a <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> or <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>.
12
8
  They are used to enable [faceted search](https://en.wikipedia.org/wiki/Faceted_search) whereby products
13
9
  can be filtered along a number of dimensions (facets).
14
10
 
15
- For example, there could be a Facet named "Brand" which has a number of <a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>s representing
11
+ For example, there could be a Facet named "Brand" which has a number of <DocsLink href="/reference/typescript-api/entities/facet-value#facetvalue">FacetValue</DocsLink>s representing
16
12
  the various brands of product, e.g. "Apple", "Samsung", "Dell", "HP" etc.
17
13
 
18
14
  ```ts title="Signature"
@@ -45,7 +41,7 @@ class Facet extends VendureEntity implements Translatable, HasCustomFields, Chan
45
41
 
46
42
  ### constructor
47
43
 
48
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>&#62;) => Facet`} />
44
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>>) => Facet`} />
49
45
 
50
46
 
51
47
  ### name
@@ -65,7 +61,7 @@ class Facet extends VendureEntity implements Translatable, HasCustomFields, Chan
65
61
 
66
62
  ### translations
67
63
 
68
- <MemberInfo kind="property" type={`Array&#60;Translation&#60;<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>&#62;&#62;`} />
64
+ <MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/facet#facet'>Facet</a>>>`} />
69
65
 
70
66
 
71
67
  ### values
@@ -2,13 +2,9 @@
2
2
  title: "Fulfillment"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Fulfillment
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/fulfillment/fulfillment.entity.ts" sourceLine="18" packageName="@vendure/core" />
10
6
 
11
- This entity represents a fulfillment of an Order or part of it, i.e. which <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>s have been
7
+ This entity represents a fulfillment of an Order or part of it, i.e. which <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>s have been
12
8
  delivered to the Customer after successful payment.
13
9
 
14
10
  ```ts title="Signature"
@@ -40,7 +36,7 @@ class Fulfillment extends VendureEntity implements HasCustomFields {
40
36
 
41
37
  ### constructor
42
38
 
43
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>&#62;) => Fulfillment`} />
39
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>>) => Fulfillment`} />
44
40
 
45
41
 
46
42
  ### state
@@ -2,10 +2,6 @@
2
2
  title: "GlobalSettings"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## GlobalSettings
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/global-settings/global-settings.entity.ts" sourceLine="14" packageName="@vendure/core" />
10
6
 
11
7
  Stores global settings for the whole application
@@ -34,7 +30,7 @@ class GlobalSettings extends VendureEntity implements HasCustomFields {
34
30
 
35
31
  ### constructor
36
32
 
37
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/global-settings#globalsettings'>GlobalSettings</a>&#62;) => GlobalSettings`} />
33
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/global-settings#globalsettings'>GlobalSettings</a>>) => GlobalSettings`} />
38
34
 
39
35
 
40
36
  ### availableLanguages
@@ -2,14 +2,10 @@
2
2
  title: "HistoryEntry"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## HistoryEntry
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/history-entry/history-entry.entity.ts" sourceLine="16" packageName="@vendure/core" />
10
6
 
11
- An abstract entity representing an entry in the history of an Order (<a href='/reference/typescript-api/entities/order-history-entry#orderhistoryentry'>OrderHistoryEntry</a>)
12
- or a Customer (<a href='/reference/typescript-api/entities/customer-history-entry#customerhistoryentry'>CustomerHistoryEntry</a>).
7
+ An abstract entity representing an entry in the history of an Order (<DocsLink href="/reference/typescript-api/entities/order-history-entry#orderhistoryentry">OrderHistoryEntry</DocsLink>)
8
+ or a Customer (<DocsLink href="/reference/typescript-api/entities/customer-history-entry#customerhistoryentry">CustomerHistoryEntry</DocsLink>).
13
9
 
14
10
  ```ts title="Signature"
15
11
  class HistoryEntry extends VendureEntity implements HasCustomFields {
@@ -2,10 +2,6 @@
2
2
  title: "Interfaces"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ChannelAware
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="17" packageName="@vendure/core" />
10
6
 
11
7
  Entities which can be assigned to Channels should implement this interface.
@@ -26,10 +22,6 @@ interface ChannelAware {
26
22
 
27
23
 
28
24
  </div>
29
-
30
-
31
- ## SoftDeletable
32
-
33
25
  <GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="28" packageName="@vendure/core" />
34
26
 
35
27
  Entities which can be soft deleted should implement this interface.
@@ -50,10 +42,6 @@ interface SoftDeletable {
50
42
 
51
43
 
52
44
  </div>
53
-
54
-
55
- ## Orderable
56
-
57
45
  <GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="39" packageName="@vendure/core" />
58
46
 
59
47
  Entities which can be ordered relative to their siblings in a list.
@@ -74,10 +62,6 @@ interface Orderable {
74
62
 
75
63
 
76
64
  </div>
77
-
78
-
79
- ## Taggable
80
-
81
65
  <GenerationInfo sourceFile="packages/core/src/common/types/common-types.ts" sourceLine="50" packageName="@vendure/core" />
82
66
 
83
67
  Entities which can have Tags applied to them.
@@ -98,10 +82,6 @@ interface Taggable {
98
82
 
99
83
 
100
84
  </div>
101
-
102
-
103
- ## Translatable
104
-
105
85
  <GenerationInfo sourceFile="packages/core/src/common/types/locale-types.ts" sourceLine="29" packageName="@vendure/core" />
106
86
 
107
87
  Entities which have localizable string properties should implement this type.
@@ -116,7 +96,7 @@ interface Translatable {
116
96
 
117
97
  ### translations
118
98
 
119
- <MemberInfo kind="property" type={`Array&#60;Translation&#60;<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>&#62;&#62;`} />
99
+ <MemberInfo kind="property" type={`Array<Translation<<a href='/reference/typescript-api/entities/vendure-entity#vendureentity'>VendureEntity</a>>>`} />
120
100
 
121
101
 
122
102
 
@@ -2,13 +2,9 @@
2
2
  title: "OrderHistoryEntry"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderHistoryEntry
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/history-entry/order-history-entry.entity.ts" sourceLine="14" packageName="@vendure/core" />
10
6
 
11
- Represents an event in the history of a particular <a href='/reference/typescript-api/entities/order#order'>Order</a>.
7
+ Represents an event in the history of a particular <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class OrderHistoryEntry extends HistoryEntry {
@@ -26,7 +22,7 @@ class OrderHistoryEntry extends HistoryEntry {
26
22
 
27
23
  ### constructor
28
24
 
29
- <MemberInfo kind="method" type={`(input: DeepPartial&#60;<a href='/reference/typescript-api/entities/order-history-entry#orderhistoryentry'>OrderHistoryEntry</a>&#62;) => OrderHistoryEntry`} />
25
+ <MemberInfo kind="method" type={`(input: DeepPartial<<a href='/reference/typescript-api/entities/order-history-entry#orderhistoryentry'>OrderHistoryEntry</a>>) => OrderHistoryEntry`} />
30
26
 
31
27
 
32
28
  ### order
@@ -2,13 +2,9 @@
2
2
  title: "OrderLineReference"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FulfillmentLine
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/fulfillment-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
10
6
 
11
- This entity represents a line from an <a href='/reference/typescript-api/entities/order#order'>Order</a> which has been fulfilled by a <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>.
7
+ This entity represents a line from an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which has been fulfilled by a <DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">Fulfillment</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class FulfillmentLine extends OrderLineReference {
@@ -28,7 +24,7 @@ class FulfillmentLine extends OrderLineReference {
28
24
 
29
25
  ### constructor
30
26
 
31
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/order-line-reference#fulfillmentline'>FulfillmentLine</a>&#62;) => FulfillmentLine`} />
27
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/order-line-reference#fulfillmentline'>FulfillmentLine</a>>) => FulfillmentLine`} />
32
28
 
33
29
 
34
30
  ### fulfillment
@@ -44,13 +40,9 @@ class FulfillmentLine extends OrderLineReference {
44
40
 
45
41
 
46
42
  </div>
47
-
48
-
49
- ## OrderLineReference
50
-
51
43
  <GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/order-line-reference.entity.ts" sourceLine="15" packageName="@vendure/core" />
52
44
 
53
- This is an abstract base class for entities which reference an <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>.
45
+ This is an abstract base class for entities which reference an <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>.
54
46
 
55
47
  ```ts title="Signature"
56
48
  class OrderLineReference extends VendureEntity {
@@ -87,13 +79,9 @@ class OrderLineReference extends VendureEntity {
87
79
 
88
80
 
89
81
  </div>
90
-
91
-
92
- ## OrderModificationLine
93
-
94
82
  <GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/order-modification-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
95
83
 
96
- This entity represents a line from an <a href='/reference/typescript-api/entities/order#order'>Order</a> which has been modified by an <a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>.
84
+ This entity represents a line from an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which has been modified by an <DocsLink href="/reference/typescript-api/entities/order-modification#ordermodification">OrderModification</DocsLink>.
97
85
 
98
86
  ```ts title="Signature"
99
87
  class OrderModificationLine extends OrderLineReference {
@@ -113,7 +101,7 @@ class OrderModificationLine extends OrderLineReference {
113
101
 
114
102
  ### constructor
115
103
 
116
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/order-line-reference#ordermodificationline'>OrderModificationLine</a>&#62;) => OrderModificationLine`} />
104
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/order-line-reference#ordermodificationline'>OrderModificationLine</a>>) => OrderModificationLine`} />
117
105
 
118
106
 
119
107
  ### modification
@@ -129,13 +117,9 @@ class OrderModificationLine extends OrderLineReference {
129
117
 
130
118
 
131
119
  </div>
132
-
133
-
134
- ## RefundLine
135
-
136
120
  <GenerationInfo sourceFile="packages/core/src/entity/order-line-reference/refund-line.entity.ts" sourceLine="16" packageName="@vendure/core" />
137
121
 
138
- This entity represents a line from an <a href='/reference/typescript-api/entities/order#order'>Order</a> which has been refunded by a <a href='/reference/typescript-api/entities/refund#refund'>Refund</a>.
122
+ This entity represents a line from an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which has been refunded by a <DocsLink href="/reference/typescript-api/entities/refund#refund">Refund</DocsLink>.
139
123
 
140
124
  ```ts title="Signature"
141
125
  class RefundLine extends OrderLineReference {
@@ -155,7 +139,7 @@ class RefundLine extends OrderLineReference {
155
139
 
156
140
  ### constructor
157
141
 
158
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/order-line-reference#refundline'>RefundLine</a>&#62;) => RefundLine`} />
142
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/order-line-reference#refundline'>RefundLine</a>>) => RefundLine`} />
159
143
 
160
144
 
161
145
  ### refund
@@ -2,13 +2,9 @@
2
2
  title: "OrderLine"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderLine
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/order-line/order-line.entity.ts" sourceLine="32" packageName="@vendure/core" />
10
6
 
11
- A single line on an <a href='/reference/typescript-api/entities/order#order'>Order</a> which contains information about the <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> and
7
+ A single line on an <DocsLink href="/reference/typescript-api/entities/order#order">Order</DocsLink> which contains information about the <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> and
12
8
  quantity ordered, as well as the price and tax information.
13
9
 
14
10
  ```ts title="Signature"
@@ -102,14 +98,14 @@ class OrderLine extends VendureEntity implements HasCustomFields {
102
98
 
103
99
  ### constructor
104
100
 
105
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>&#62;) => OrderLine`} />
101
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>>) => OrderLine`} />
106
102
 
107
103
 
108
104
  ### sellerChannel
109
105
 
110
106
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>`} />
111
107
 
112
- The <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> of the <a href='/reference/typescript-api/entities/seller#seller'>Seller</a> for a multivendor setup.
108
+ The <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> of the <DocsLink href="/reference/typescript-api/entities/seller#seller">Seller</DocsLink> for a multivendor setup.
113
109
  ### sellerChannelId
114
110
 
115
111
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
@@ -119,8 +115,8 @@ The <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> of
119
115
 
120
116
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a>`} />
121
117
 
122
- The <a href='/reference/typescript-api/entities/shipping-line#shippingline'>ShippingLine</a> to which this line has been assigned.
123
- This is determined by the configured <a href='/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy'>ShippingLineAssignmentStrategy</a>.
118
+ The <DocsLink href="/reference/typescript-api/entities/shipping-line#shippingline">ShippingLine</DocsLink> to which this line has been assigned.
119
+ This is determined by the configured <DocsLink href="/reference/typescript-api/shipping/shipping-line-assignment-strategy#shippinglineassignmentstrategy">ShippingLineAssignmentStrategy</DocsLink>.
124
120
  ### shippingLineId
125
121
 
126
122
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
@@ -130,7 +126,7 @@ This is determined by the configured <a href='/reference/typescript-api/shipping
130
126
 
131
127
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`} />
132
128
 
133
- The <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> which is being ordered.
129
+ The <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> which is being ordered.
134
130
  ### productVariantId
135
131
 
136
132
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
@@ -175,7 +171,7 @@ The <a href='/reference/typescript-api/entities/product-variant#productvariant'>
175
171
 
176
172
  <MemberInfo kind="property" type={`number`} />
177
173
 
178
- The quantity of this OrderLine at the time the order was placed (as per the <a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>).
174
+ The quantity of this OrderLine at the time the order was placed (as per the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>).
179
175
  ### initialListPrice
180
176
 
181
177
  <MemberInfo kind="property" type={`number`} />
@@ -187,7 +183,7 @@ the Order has been performed.
187
183
 
188
184
  <MemberInfo kind="property" type={`number`} />
189
185
 
190
- This is the price as listed by the ProductVariant (and possibly modified by the <a href='/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy'>OrderItemPriceCalculationStrategy</a>),
186
+ This is the price as listed by the ProductVariant (and possibly modified by the <DocsLink href="/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy">OrderItemPriceCalculationStrategy</DocsLink>),
191
187
  which, depending on the current Channel, may or may not include tax.
192
188
  ### listPriceIncludesTax
193
189
 
@@ -2,10 +2,6 @@
2
2
  title: "OrderModification"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderModification
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/order-modification/order-modification.entity.ts" sourceLine="21" packageName="@vendure/core" />
10
6
 
11
7
  An entity which represents a modification to an order which has been placed, and
@@ -44,7 +40,7 @@ class OrderModification extends VendureEntity {
44
40
 
45
41
  ### constructor
46
42
 
47
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>&#62;) => OrderModification`} />
43
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>>) => OrderModification`} />
48
44
 
49
45
 
50
46
  ### note
@@ -2,17 +2,13 @@
2
2
  title: "Order"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Order
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/order/order.entity.ts" sourceLine="43" packageName="@vendure/core" />
10
6
 
11
- An Order is created whenever a <a href='/reference/typescript-api/entities/customer#customer'>Customer</a> adds an item to the cart. It contains all the
12
- information required to fulfill an order: which <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>s in what quantities;
7
+ An Order is created whenever a <DocsLink href="/reference/typescript-api/entities/customer#customer">Customer</DocsLink> adds an item to the cart. It contains all the
8
+ information required to fulfill an order: which <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>s in what quantities;
13
9
  the shipping address and price; any applicable promotions; payments etc.
14
10
 
15
- An Order exists in a well-defined state according to the <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> type. A state machine
11
+ An Order exists in a well-defined state according to the <DocsLink href="/reference/typescript-api/orders/order-process#orderstate">OrderState</DocsLink> type. A state machine
16
12
  is used to govern the transition from one state to another.
17
13
 
18
14
  ```ts title="Signature"
@@ -96,7 +92,7 @@ class Order extends VendureEntity implements ChannelAware, HasCustomFields {
96
92
 
97
93
  ### constructor
98
94
 
99
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Order`} />
95
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Order`} />
100
96
 
101
97
 
102
98
  ### type
@@ -124,7 +120,7 @@ class Order extends VendureEntity implements ChannelAware, HasCustomFields {
124
120
  <MemberInfo kind="property" type={`string`} />
125
121
 
126
122
  A unique code for the Order, generated according to the
127
- <a href='/reference/typescript-api/orders/order-code-strategy#ordercodestrategy'>OrderCodeStrategy</a>. This should be used as an order reference
123
+ <DocsLink href="/reference/typescript-api/orders/order-code-strategy#ordercodestrategy">OrderCodeStrategy</DocsLink>. This should be used as an order reference
128
124
  for Customers, rather than the Order's id.
129
125
  ### state
130
126
 
@@ -138,14 +134,14 @@ for Customers, rather than the Order's id.
138
134
  Whether the Order is considered "active", meaning that the
139
135
  Customer can still make changes to it and has not yet completed
140
136
  the checkout process.
141
- This is governed by the <a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>.
137
+ This is governed by the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>.
142
138
  ### orderPlacedAt
143
139
 
144
140
  <MemberInfo kind="property" type={`Date`} />
145
141
 
146
142
  The date & time that the Order was placed, i.e. the Customer
147
143
  completed the checkout and the Order is no longer "active".
148
- This is governed by the <a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>.
144
+ This is governed by the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>.
149
145
  ### customer
150
146
 
151
147
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/entities/customer#customer'>Customer</a>`} />
@@ -232,7 +228,7 @@ i.e. the Order is no longer active.
232
228
  The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
233
229
  discounts which have been prorated (proportionally distributed) amongst the OrderItems.
234
230
  To get a total of all OrderLines which does not account for prorated discounts, use the
235
- sum of <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>'s `discountedLinePrice` values.
231
+ sum of <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>'s `discountedLinePrice` values.
236
232
  ### subTotalWithTax
237
233
 
238
234
  <MemberInfo kind="property" type={`number`} />
@@ -2,10 +2,6 @@
2
2
  title: "OrderableAsset"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderableAsset
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/asset/orderable-asset.entity.ts" sourceLine="18" packageName="@vendure/core" />
10
6
 
11
7
  This base class is extended in order to enable specific ordering of the one-to-many
@@ -37,7 +33,7 @@ class OrderableAsset extends VendureEntity implements Orderable {
37
33
 
38
34
  ### constructor
39
35
 
40
- <MemberInfo kind="method" type={`(input?: DeepPartial&#60;<a href='/reference/typescript-api/entities/orderable-asset#orderableasset'>OrderableAsset</a>&#62;) => OrderableAsset`} />
36
+ <MemberInfo kind="method" type={`(input?: DeepPartial<<a href='/reference/typescript-api/entities/orderable-asset#orderableasset'>OrderableAsset</a>>) => OrderableAsset`} />
41
37
 
42
38
 
43
39
  ### assetId