@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: "ActiveOrderService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ActiveOrderService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/active-order/active-order.service.ts" sourceLine="18" packageName="@vendure/core" />
10
6
 
11
7
  This helper class is used to get a reference to the active Order from the current RequestContext.
@@ -52,7 +48,7 @@ being present.
52
48
 
53
49
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`} since="1.9.0" />
54
50
 
55
- Retrieves the active Order based on the configured <a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>.
51
+ Retrieves the active Order based on the configured <DocsLink href="/reference/typescript-api/orders/active-order-strategy#activeorderstrategy">ActiveOrderStrategy</DocsLink>.
56
52
  ### getActiveOrder
57
53
 
58
54
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: { [strategyName: string]: any } | undefined, createIfNotExists: true) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
@@ -2,17 +2,13 @@
2
2
  title: "ActiveOrderStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ActiveOrderStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/active-order-strategy.ts" sourceLine="127" packageName="@vendure/core" since="1.9.0" />
10
6
 
11
7
  This strategy is used to determine the active Order for all order-related operations in
12
8
  the Shop API. By default, all the Shop API operations that relate to the active Order (e.g.
13
9
  `activeOrder`, `addItemToOrder`, `applyCouponCode` etc.) will implicitly create a new Order
14
10
  and set it on the current Session, and then read the session to obtain the active Order.
15
- This behaviour is defined by the <a href='/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy'>DefaultActiveOrderStrategy</a>.
11
+ This behaviour is defined by the <DocsLink href="/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy">DefaultActiveOrderStrategy</DocsLink>.
16
12
 
17
13
  The `InputType` generic argument should correspond to the input type defined by the
18
14
  `defineInputType()` method.
@@ -2,10 +2,6 @@
2
2
  title: "ChangedPriceHandlingStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ChangedPriceHandlingStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/changed-price-handling-strategy.ts" sourceLine="24" packageName="@vendure/core" />
10
6
 
11
7
  This strategy defines how we handle the situation where an item exists in an Order, and
@@ -43,7 +39,7 @@ interface ChangedPriceHandlingStrategy extends InjectableStrategy {
43
39
 
44
40
  This method is called when adding to or adjusting OrderLines, if the latest price
45
41
  (as determined by the ProductVariant price, potentially modified by the configured
46
- <a href='/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy'>OrderItemPriceCalculationStrategy</a>) differs from the initial price at the time
42
+ <DocsLink href="/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy">OrderItemPriceCalculationStrategy</DocsLink>) differs from the initial price at the time
47
43
  that the OrderLine was created.
48
44
 
49
45
 
@@ -2,13 +2,9 @@
2
2
  title: "CustomOrderStates"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## CustomOrderStates
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="11" packageName="@vendure/core" />
10
6
 
11
- An interface to extend standard <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>.
7
+ An interface to extend standard <DocsLink href="/reference/typescript-api/orders/order-process#orderstate">OrderState</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  interface CustomOrderStates {
@@ -2,13 +2,9 @@
2
2
  title: "DefaultActiveOrderStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DefaultActiveOrderStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/default-active-order-strategy.ts" sourceLine="18" packageName="@vendure/core" since="1.9.0" />
10
6
 
11
- The default <a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>, which uses the current <a href='/reference/typescript-api/entities/session#session'>Session</a> to determine
7
+ The default <DocsLink href="/reference/typescript-api/orders/active-order-strategy#activeorderstrategy">ActiveOrderStrategy</DocsLink>, which uses the current <DocsLink href="/reference/typescript-api/entities/session#session">Session</DocsLink> to determine
12
8
  the active Order, and requires no additional input in the Shop API since it is based on the
13
9
  session which is part of the RequestContext.
14
10
 
@@ -2,13 +2,9 @@
2
2
  title: "DefaultGuestCheckoutStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DefaultGuestCheckoutStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/default-guest-checkout-strategy.ts" sourceLine="64" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
- The default implementation of the <a href='/reference/typescript-api/orders/guest-checkout-strategy#guestcheckoutstrategy'>GuestCheckoutStrategy</a>. This strategy allows
7
+ The default implementation of the <DocsLink href="/reference/typescript-api/orders/guest-checkout-strategy#guestcheckoutstrategy">GuestCheckoutStrategy</DocsLink>. This strategy allows
12
8
  guest checkouts by default, but can be configured to disallow them.
13
9
 
14
10
  *Example*
@@ -58,13 +54,9 @@ class DefaultGuestCheckoutStrategy implements GuestCheckoutStrategy {
58
54
 
59
55
 
60
56
  </div>
61
-
62
-
63
- ## DefaultGuestCheckoutStrategyOptions
64
-
65
57
  <GenerationInfo sourceFile="packages/core/src/config/order/default-guest-checkout-strategy.ts" sourceLine="20" packageName="@vendure/core" since="2.0.0" />
66
58
 
67
- Options available for the <a href='/reference/typescript-api/orders/default-guest-checkout-strategy#defaultguestcheckoutstrategy'>DefaultGuestCheckoutStrategy</a>.
59
+ Options available for the <DocsLink href="/reference/typescript-api/orders/default-guest-checkout-strategy#defaultguestcheckoutstrategy">DefaultGuestCheckoutStrategy</DocsLink>.
68
60
 
69
61
  ```ts title="Signature"
70
62
  interface DefaultGuestCheckoutStrategyOptions {
@@ -2,13 +2,9 @@
2
2
  title: "DefaultOrderItemPriceCalculationStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DefaultOrderItemPriceCalculationStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/default-order-item-price-calculation-strategy.ts" sourceLine="14" packageName="@vendure/core" />
10
6
 
11
- The default <a href='/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy'>OrderItemPriceCalculationStrategy</a>, which simply passes through the price of
7
+ The default <DocsLink href="/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy">OrderItemPriceCalculationStrategy</DocsLink>, which simply passes through the price of
12
8
  the ProductVariant without performing any calculations
13
9
 
14
10
  ```ts title="Signature"
@@ -2,13 +2,9 @@
2
2
  title: "DefaultOrderPlacedStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DefaultOrderPlacedStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/default-order-placed-strategy.ts" sourceLine="14" packageName="@vendure/core" />
10
6
 
11
- The default <a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>. The order is set as "placed" when it transitions from
7
+ The default <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>. The order is set as "placed" when it transitions from
12
8
  'ArrangingPayment' to either 'PaymentAuthorized' or 'PaymentSettled'.
13
9
 
14
10
  ```ts title="Signature"
@@ -2,10 +2,6 @@
2
2
  title: "DefaultStockAllocationStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DefaultStockAllocationStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/default-stock-allocation-strategy.ts" sourceLine="14" packageName="@vendure/core" />
10
6
 
11
7
  Allocates stock when the Order transitions from `ArrangingPayment` to either
@@ -2,10 +2,6 @@
2
2
  title: "GuestCheckoutStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## GuestCheckoutStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/guest-checkout-strategy.ts" sourceLine="33" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
7
  A strategy that determines how to deal with guest checkouts - i.e. when a customer
@@ -2,10 +2,6 @@
2
2
  title: "Merge Strategies"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## MergeOrdersStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/merge-orders-strategy.ts" sourceLine="15" packageName="@vendure/core" />
10
6
 
11
7
  Merges both Orders. If the guest order contains items which are already in the
@@ -30,10 +26,6 @@ class MergeOrdersStrategy implements OrderMergeStrategy {
30
26
 
31
27
 
32
28
  </div>
33
-
34
-
35
- ## UseExistingStrategy
36
-
37
29
  <GenerationInfo sourceFile="packages/core/src/config/order/use-existing-strategy.ts" sourceLine="13" packageName="@vendure/core" />
38
30
 
39
31
  The guest order is discarded and the existing order is used as the active order.
@@ -57,10 +49,6 @@ class UseExistingStrategy implements OrderMergeStrategy {
57
49
 
58
50
 
59
51
  </div>
60
-
61
-
62
- ## UseGuestIfExistingEmptyStrategy
63
-
64
52
  <GenerationInfo sourceFile="packages/core/src/config/order/use-guest-if-existing-empty-strategy.ts" sourceLine="13" packageName="@vendure/core" />
65
53
 
66
54
  If the existing order is empty, then the guest order is used. Otherwise the existing order is used.
@@ -84,10 +72,6 @@ class UseGuestIfExistingEmptyStrategy implements OrderMergeStrategy {
84
72
 
85
73
 
86
74
  </div>
87
-
88
-
89
- ## UseGuestStrategy
90
-
91
75
  <GenerationInfo sourceFile="packages/core/src/config/order/use-guest-strategy.ts" sourceLine="13" packageName="@vendure/core" />
92
76
 
93
77
  Any existing order is discarded and the guest order is set as the active order.
@@ -2,10 +2,6 @@
2
2
  title: "OrderByCodeAccessStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderByCodeAccessStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/order-by-code-access-strategy.ts" sourceLine="38" packageName="@vendure/core" since="1.1.0" />
10
6
 
11
7
  The OrderByCodeAccessStrategy determines how access to a placed Order via the
@@ -53,10 +49,6 @@ Gives or denies permission to access the requested Order
53
49
 
54
50
 
55
51
  </div>
56
-
57
-
58
- ## DefaultOrderByCodeAccessStrategy
59
-
60
52
  <GenerationInfo sourceFile="packages/core/src/config/order/order-by-code-access-strategy.ts" sourceLine="57" packageName="@vendure/core" />
61
53
 
62
54
  The default OrderByCodeAccessStrategy used by Vendure. It permitts permanent access to
@@ -2,10 +2,6 @@
2
2
  title: "OrderCodeStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderCodeStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/order-code-strategy.ts" sourceLine="39" packageName="@vendure/core" />
10
6
 
11
7
  The OrderCodeStrategy determines how Order codes are generated.
@@ -57,10 +53,6 @@ Generates the order code.
57
53
 
58
54
 
59
55
  </div>
60
-
61
-
62
- ## DefaultOrderCodeStrategy
63
-
64
56
  <GenerationInfo sourceFile="packages/core/src/config/order/order-code-strategy.ts" sourceLine="55" packageName="@vendure/core" />
65
57
 
66
58
  The default OrderCodeStrategy generates a random string consisting
@@ -2,10 +2,6 @@
2
2
  title: "OrderInterceptor"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderInterceptor
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/order-interceptor.ts" sourceLine="214" packageName="@vendure/core" since="3.1.0" />
10
6
 
11
7
  An OrderInterceptor is a class which can be used to intercept and modify the behavior of order-related
@@ -35,7 +31,7 @@ OrderInterceptors are executed when the following mutations are called:
35
31
  - `adjustOrderLine`
36
32
  - `removeItemFromOrder`
37
33
 
38
- Additionally, if you are working directly with the <a href='/reference/typescript-api/services/order-service#orderservice'>OrderService</a>, the following methods will trigger
34
+ Additionally, if you are working directly with the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>, the following methods will trigger
39
35
  any registered OrderInterceptors:
40
36
 
41
37
  - `addItemToOrder`
@@ -229,21 +225,21 @@ interface OrderInterceptor extends InjectableStrategy {
229
225
 
230
226
  Called when a new item is about to be added to the order,
231
227
  as in the `addItemToOrder` mutation or the `addItemToOrder()` / `addItemsToOrder()` method
232
- of the <a href='/reference/typescript-api/services/order-service#orderservice'>OrderService</a>.
228
+ of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
233
229
  ### willAdjustOrderLine
234
230
 
235
231
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: WillAdjustOrderLineInput) => Promise<void | string> | void | string`} />
236
232
 
237
233
  Called when an existing order line is about to be adjusted,
238
234
  as in the `adjustOrderLine` mutation or the `adjustOrderLine()` / `adjustOrderLines()` method
239
- of the <a href='/reference/typescript-api/services/order-service#orderservice'>OrderService</a>.
235
+ of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
240
236
  ### willRemoveItemFromOrder
241
237
 
242
238
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => Promise<void | string> | void | string`} />
243
239
 
244
240
  Called when an item is about to be removed from the order,
245
241
  as in the `removeItemFromOrder` mutation or the `removeItemFromOrder()` / `removeItemsFromOrder()` method
246
- of the <a href='/reference/typescript-api/services/order-service#orderservice'>OrderService</a>.
242
+ of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
247
243
 
248
244
 
249
245
  </div>
@@ -2,14 +2,10 @@
2
2
  title: "OrderItemPriceCalculationStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderItemPriceCalculationStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/order-item-price-calculation-strategy.ts" sourceLine="60" packageName="@vendure/core" />
10
6
 
11
7
  The OrderItemPriceCalculationStrategy defines the listPrice of an OrderLine when adding an item to an Order. By default the
12
- <a href='/reference/typescript-api/orders/default-order-item-price-calculation-strategy#defaultorderitempricecalculationstrategy'>DefaultOrderItemPriceCalculationStrategy</a> is used.
8
+ <DocsLink href="/reference/typescript-api/orders/default-order-item-price-calculation-strategy#defaultorderitempricecalculationstrategy">DefaultOrderItemPriceCalculationStrategy</DocsLink> is used.
13
9
 
14
10
  :::info
15
11
 
@@ -82,7 +78,7 @@ Receives the ProductVariant to be added to the Order as well as any OrderLine cu
82
78
  the price for a single unit.
83
79
 
84
80
  Note: if you have any `relation` type custom fields defined on the OrderLine entity, they will only be
85
- passed in to this method if they are set to `eager: true`. Otherwise, you can use the <a href='/reference/typescript-api/data-access/entity-hydrator#entityhydrator'>EntityHydrator</a>to join the missing relations.
81
+ passed in to this method if they are set to `eager: true`. Otherwise, you can use the <DocsLink href="/reference/typescript-api/data-access/entity-hydrator#entityhydrator">EntityHydrator</DocsLink>to join the missing relations.
86
82
 
87
83
  Note: the `quantity` argument was added in v2.0.0
88
84
 
@@ -2,10 +2,6 @@
2
2
  title: "OrderMergeStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderMergeStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/order-merge-strategy.ts" sourceLine="48" packageName="@vendure/core" />
10
6
 
11
7
  An OrderMergeStrategy defines what happens when a Customer with an existing Order
@@ -41,13 +37,9 @@ with the active customer.
41
37
 
42
38
 
43
39
  </div>
44
-
45
-
46
- ## MergedOrderLine
47
-
48
40
  <GenerationInfo sourceFile="packages/core/src/config/order/order-merge-strategy.ts" sourceLine="15" packageName="@vendure/core" />
49
41
 
50
- The result of the <a href='/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy'>OrderMergeStrategy</a> `merge` method.
42
+ The result of the <DocsLink href="/reference/typescript-api/orders/order-merge-strategy#ordermergestrategy">OrderMergeStrategy</DocsLink> `merge` method.
51
43
 
52
44
  ```ts title="Signature"
53
45
  interface MergedOrderLine {
@@ -2,10 +2,6 @@
2
2
  title: "OrderOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="521" packageName="@vendure/core" />
10
6
 
11
7
 
@@ -64,7 +60,7 @@ item to an Order.
64
60
  <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a><any>>`} default={`[]`} />
65
61
 
66
62
  Allows the definition of custom states and transition logic for the order process state machine.
67
- Takes an array of objects implementing the <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> interface.
63
+ Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> interface.
68
64
  ### stockAllocationStrategy
69
65
 
70
66
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/stock-allocation-strategy#stockallocationstrategy'>StockAllocationStrategy</a>`} default={`<a href='/reference/typescript-api/orders/default-stock-allocation-strategy#defaultstockallocationstrategy'>DefaultStockAllocationStrategy</a>`} />
@@ -138,7 +134,7 @@ Defines how we deal with guest checkouts.
138
134
 
139
135
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/order-interceptor#orderinterceptor'>OrderInterceptor</a>[]`} default={`[]`} since="3.1.0" />
140
136
 
141
- An array of <a href='/reference/typescript-api/orders/order-interceptor#orderinterceptor'>OrderInterceptor</a>s which can be used to modify the behavior of the Order process.
137
+ An array of <DocsLink href="/reference/typescript-api/orders/order-interceptor#orderinterceptor">OrderInterceptor</DocsLink>s which can be used to modify the behavior of the Order process.
142
138
 
143
139
 
144
140
  </div>
@@ -2,10 +2,6 @@
2
2
  title: "OrderPlacedStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderPlacedStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/order-placed-strategy.ts" sourceLine="24" packageName="@vendure/core" />
10
6
 
11
7
  This strategy is responsible for deciding at which stage in the order process
@@ -2,10 +2,6 @@
2
2
  title: "OrderProcess"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderProcess
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/order-process.ts" sourceLine="35" packageName="@vendure/core" />
10
6
 
11
7
  An OrderProcess is used to define the way the order process works as in: what states an Order can be
@@ -13,7 +9,7 @@ in, and how it may transition from one state to another. Using the `onTransition
13
9
  OrderProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
14
10
  hook allows logic to be executed after a state change.
15
11
 
16
- For detailed description of the interface members, see the <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a> docs.
12
+ For detailed description of the interface members, see the <DocsLink href="/reference/typescript-api/state-machine/state-machine-config#statemachineconfig">StateMachineConfig</DocsLink> docs.
17
13
 
18
14
  :::info
19
15
 
@@ -59,14 +55,10 @@ interface OrderProcess<State extends keyof CustomOrderStates | string> extends I
59
55
 
60
56
 
61
57
  </div>
62
-
63
-
64
- ## DefaultOrderProcessOptions
65
-
66
58
  <GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="50" packageName="@vendure/core" since="2.0.0" />
67
59
 
68
- Options which can be passed to the <a href='/reference/typescript-api/orders/order-process#configuredefaultorderprocess'>configureDefaultOrderProcess</a> function
69
- to configure an instance of the default <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a>. By default, all
60
+ Options which can be passed to the <DocsLink href="/reference/typescript-api/orders/order-process#configuredefaultorderprocess">configureDefaultOrderProcess</DocsLink> function
61
+ to configure an instance of the default <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink>. By default, all
70
62
  options are set to `true`.
71
63
 
72
64
  ```ts title="Signature"
@@ -150,13 +142,9 @@ the Order are part of a Fulfillment which itself is in the `Shipped` state.
150
142
 
151
143
 
152
144
  </div>
153
-
154
-
155
- ## configureDefaultOrderProcess
156
-
157
145
  <GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="163" packageName="@vendure/core" since="2.0.0" />
158
146
 
159
- Used to configure a customized instance of the default <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> that ships with Vendure.
147
+ Used to configure a customized instance of the default <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> that ships with Vendure.
160
148
  Using this function allows you to turn off certain checks and constraints that are enabled by default.
161
149
 
162
150
  ```ts
@@ -175,8 +163,8 @@ export const config: VendureConfig = {
175
163
  },
176
164
  };
177
165
  ```
178
- The <a href='/reference/typescript-api/orders/order-process#defaultorderprocessoptions'>DefaultOrderProcessOptions</a> type defines all available options. If you require even
179
- more customization, you can create your own implementation of the <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> interface.
166
+ The <DocsLink href="/reference/typescript-api/orders/order-process#defaultorderprocessoptions">DefaultOrderProcessOptions</DocsLink> type defines all available options. If you require even
167
+ more customization, you can create your own implementation of the <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> interface.
180
168
 
181
169
  ```ts title="Signature"
182
170
  function configureDefaultOrderProcess(options: DefaultOrderProcessOptions): void
@@ -187,38 +175,26 @@ Parameters
187
175
 
188
176
  <MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/orders/order-process#defaultorderprocessoptions'>DefaultOrderProcessOptions</a>`} />
189
177
 
190
-
191
-
192
- ## defaultOrderProcess
193
-
194
178
  <GenerationInfo sourceFile="packages/core/src/config/order/default-order-process.ts" sourceLine="475" packageName="@vendure/core" since="2.0.0" />
195
179
 
196
- This is the built-in <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> that ships with Vendure. A customized version of this process
197
- can be created using the <a href='/reference/typescript-api/orders/order-process#configuredefaultorderprocess'>configureDefaultOrderProcess</a> function, which allows you to pass in an object
180
+ This is the built-in <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> that ships with Vendure. A customized version of this process
181
+ can be created using the <DocsLink href="/reference/typescript-api/orders/order-process#configuredefaultorderprocess">configureDefaultOrderProcess</DocsLink> function, which allows you to pass in an object
198
182
  to enable/disable certain checks.
199
183
 
200
-
201
-
202
- ## OrderStates
203
-
204
184
  <GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="21" packageName="@vendure/core" since="2.0.0" />
205
185
 
206
- An interface to extend the <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> type.
186
+ An interface to extend the <DocsLink href="/reference/typescript-api/orders/order-process#orderstate">OrderState</DocsLink> type.
207
187
 
208
188
  ```ts title="Signature"
209
189
  interface OrderStates {
210
190
 
211
191
  }
212
192
  ```
213
-
214
-
215
- ## OrderState
216
-
217
193
  <GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="42" packageName="@vendure/core" />
218
194
 
219
195
  These are the default states of the Order process. They can be augmented and
220
- modified by using the <a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a> `process` property, and by default
221
- the <a href='/reference/typescript-api/orders/order-process#defaultorderprocess'>defaultOrderProcess</a> will add the states
196
+ modified by using the <DocsLink href="/reference/typescript-api/orders/order-options#orderoptions">OrderOptions</DocsLink> `process` property, and by default
197
+ the <DocsLink href="/reference/typescript-api/orders/order-process#defaultorderprocess">defaultOrderProcess</DocsLink> will add the states
222
198
 
223
199
  - `ArrangingPayment`
224
200
  - `PaymentAuthorized`
@@ -238,13 +214,9 @@ type OrderState = | 'Created'
238
214
  | keyof CustomOrderStates
239
215
  | keyof OrderStates
240
216
  ```
241
-
242
-
243
- ## OrderTransitionData
244
-
245
217
  <GenerationInfo sourceFile="packages/core/src/service/helpers/order-state-machine/order-state.ts" sourceLine="57" packageName="@vendure/core" />
246
218
 
247
- This is the object passed to the <a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a> state transition hooks.
219
+ This is the object passed to the <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> state transition hooks.
248
220
 
249
221
  ```ts title="Signature"
250
222
  interface OrderTransitionData {
@@ -2,10 +2,6 @@
2
2
  title: "OrderSellerStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrderSellerStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/order-seller-strategy.ts" sourceLine="43" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
7
  This strategy defines how an Order can be split into multiple sub-orders for the use-case of
@@ -43,15 +39,15 @@ interface OrderSellerStrategy extends InjectableStrategy {
43
39
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | undefined | Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | undefined>`} />
44
40
 
45
41
  This method is called whenever a new OrderLine is added to the Order via the `addItemToOrder` mutation or the
46
- underlying `addItemToOrder()` method of the <a href='/reference/typescript-api/services/order-service#orderservice'>OrderService</a>.
42
+ underlying `addItemToOrder()` method of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
47
43
 
48
44
  It should return the Channel to which this OrderLine will be assigned, which will be used to set the
49
- <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a> `sellerChannel` property.
45
+ <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink> `sellerChannel` property.
50
46
  ### splitOrder
51
47
 
52
48
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>[] | Promise<<a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>[]>`} />
53
49
 
54
- Upon checkout (by default, when the Order moves from "active" to "inactive" according to the <a href='/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy'>OrderPlacedStrategy</a>),
50
+ Upon checkout (by default, when the Order moves from "active" to "inactive" according to the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>),
55
51
  this method will be called in order to split the Order into multiple Orders, one for each Seller.
56
52
  ### afterSellerOrdersCreated
57
53
 
@@ -63,10 +59,6 @@ needed.
63
59
 
64
60
 
65
61
  </div>
66
-
67
-
68
- ## DefaultOrderSellerStrategy
69
-
70
62
  <GenerationInfo sourceFile="packages/core/src/config/order/default-order-seller-strategy.ts" sourceLine="11" packageName="@vendure/core" since="2.0.0" />
71
63
 
72
64
  The DefaultOrderSellerStrategy treats the Order as single-vendor.
@@ -79,10 +71,6 @@ class DefaultOrderSellerStrategy implements OrderSellerStrategy {
79
71
  * Implements: <code><a href='/reference/typescript-api/orders/order-seller-strategy#ordersellerstrategy'>OrderSellerStrategy</a></code>
80
72
 
81
73
 
82
-
83
-
84
- ## SplitOrderContents
85
-
86
74
  <GenerationInfo sourceFile="packages/core/src/config/order/order-seller-strategy.ts" sourceLine="19" packageName="@vendure/core" since="2.0.0" />
87
75
 
88
76
  The contents of the aggregate Order which make up a single seller Order.
@@ -2,10 +2,6 @@
2
2
  title: "StockAllocationStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## StockAllocationStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/order/stock-allocation-strategy.ts" sourceLine="20" packageName="@vendure/core" />
10
6
 
11
7
  This strategy is responsible for deciding at which stage in the order process
@@ -2,11 +2,7 @@
2
2
  title: "DefaultPaymentProcess"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## defaultPaymentProcess
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/payment/default-payment-process.ts" sourceLine="26" packageName="@vendure/core" />
10
6
 
11
- The default <a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>
7
+ The default <DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink>
12
8
 
@@ -2,11 +2,7 @@
2
2
  title: "DefaultRefundProcess"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## defaultRefundProcess
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/refund/default-refund-process.ts" sourceLine="16" packageName="@vendure/core" />
10
6
 
11
- The default <a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a>.
7
+ The default <DocsLink href="/reference/typescript-api/payment/refund-process#refundprocess">RefundProcess</DocsLink>.
12
8