@vendure/docs 0.0.0-202601210957 → 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 (582) hide show
  1. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -6
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -5
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -5
  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 +0 -4
  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 +1 -17
  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 +0 -4
  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 +0 -4
  17. package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -6
  18. package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -5
  19. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +0 -4
  20. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +0 -4
  21. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +0 -4
  22. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +0 -4
  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 +0 -4
  25. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +0 -4
  26. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +0 -4
  27. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -5
  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 +0 -4
  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 +1 -5
  33. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -5
  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 +2 -70
  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 +2 -6
  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 +2 -6
  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 +0 -4
  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 +0 -4
  47. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +0 -4
  48. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -5
  49. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -5
  50. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -5
  51. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -5
  52. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -5
  53. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +1 -5
  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 +0 -4
  57. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -5
  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 +0 -4
  70. package/docs/reference/admin-ui-api/react-components/card.mdx +0 -4
  71. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +0 -4
  72. package/docs/reference/admin-ui-api/react-components/form-field.mdx +0 -4
  73. package/docs/reference/admin-ui-api/react-components/link.mdx +0 -4
  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 +0 -4
  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 +0 -4
  78. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -5
  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 +0 -4
  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 +0 -4
  87. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +0 -4
  88. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +0 -4
  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 +0 -4
  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 +0 -4
  95. package/docs/reference/admin-ui-api/services/data-service.mdx +1 -9
  96. package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -17
  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 +0 -4
  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 +1 -37
  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 +1 -5
  108. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +0 -4
  109. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -9
  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 +0 -12
  115. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -7
  116. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +0 -4
  117. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +2 -10
  118. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +4 -16
  119. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +2 -10
  120. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -5
  121. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +0 -4
  122. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -13
  123. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -5
  124. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -5
  125. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -14
  126. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -5
  127. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +0 -8
  128. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +1 -13
  129. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -61
  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 +1 -9
  132. package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -8
  133. package/docs/reference/core-plugins/email-plugin/index.mdx +4 -8
  134. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +0 -8
  135. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -30
  136. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +0 -4
  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 +1 -5
  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 +1 -5
  142. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -9
  143. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -5
  144. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +0 -4
  145. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +0 -8
  146. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +0 -8
  147. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -9
  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 +3 -11
  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 +0 -4
  155. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +0 -8
  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 +1 -5
  159. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -5
  160. package/docs/reference/dashboard/components/asset-gallery.mdx +1 -9
  161. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -9
  162. package/docs/reference/dashboard/components/channel-chip.mdx +0 -4
  163. package/docs/reference/dashboard/components/detail-page-button.mdx +0 -4
  164. package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -4
  165. package/docs/reference/dashboard/components/facet-value-selector.mdx +0 -8
  166. package/docs/reference/dashboard/components/permission-guard.mdx +0 -8
  167. package/docs/reference/dashboard/components/vendure-image.mdx +5 -29
  168. package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -10
  169. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +0 -12
  170. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -9
  171. package/docs/reference/dashboard/extensions-api/action-bar.mdx +0 -4
  172. package/docs/reference/dashboard/extensions-api/alerts.mdx +0 -4
  173. package/docs/reference/dashboard/extensions-api/data-tables.mdx +0 -4
  174. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -8
  175. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +0 -8
  176. package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -21
  177. package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -19
  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 +0 -12
  181. package/docs/reference/dashboard/extensions-api/routes.mdx +0 -4
  182. package/docs/reference/dashboard/extensions-api/widgets.mdx +0 -4
  183. package/docs/reference/dashboard/form-components/affixed-input.mdx +0 -4
  184. package/docs/reference/dashboard/form-components/boolean-input.mdx +0 -4
  185. package/docs/reference/dashboard/form-components/checkbox-input.mdx +0 -4
  186. package/docs/reference/dashboard/form-components/date-time-input.mdx +0 -4
  187. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -9
  188. package/docs/reference/dashboard/form-components/money-input.mdx +0 -4
  189. package/docs/reference/dashboard/form-components/number-input.mdx +0 -4
  190. package/docs/reference/dashboard/form-components/password-input.mdx +0 -4
  191. package/docs/reference/dashboard/form-components/rich-text-input.mdx +0 -4
  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 +0 -4
  195. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -9
  196. package/docs/reference/dashboard/hooks/use-alerts.mdx +0 -8
  197. package/docs/reference/dashboard/hooks/use-auth.mdx +1 -9
  198. package/docs/reference/dashboard/hooks/use-channel.mdx +1 -9
  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 +0 -4
  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 +0 -12
  209. package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -4
  210. package/docs/reference/dashboard/list-views/data-table.mdx +1 -13
  211. package/docs/reference/dashboard/list-views/list-page.mdx +2 -10
  212. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -10
  213. package/docs/reference/dashboard/page-layout/index.mdx +2 -10
  214. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -14
  215. package/docs/reference/dashboard/page-layout/page-block.mdx +4 -20
  216. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -5
  217. package/docs/reference/dashboard/page-layout/page.mdx +4 -12
  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 +0 -4
  223. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +0 -4
  224. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -4
  225. package/docs/reference/typescript-api/auth/auth-options.mdx +4 -8
  226. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -5
  227. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +0 -4
  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 +3 -7
  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 +1 -5
  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 +0 -4
  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 +1 -5
  237. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -5
  238. package/docs/reference/typescript-api/auth/permission-definition.mdx +10 -26
  239. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -16
  240. package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -4
  241. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +0 -4
  242. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -5
  243. package/docs/reference/typescript-api/cache/cache-service.mdx +2 -6
  244. package/docs/reference/typescript-api/cache/cache-strategy.mdx +1 -9
  245. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -11
  246. package/docs/reference/typescript-api/cache/index.mdx +2 -6
  247. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -11
  248. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -5
  249. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +0 -4
  250. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -14
  251. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +2 -6
  252. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +0 -4
  253. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +0 -4
  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 +0 -4
  256. package/docs/reference/typescript-api/common/bootstrap.mdx +0 -8
  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 +1 -5
  262. package/docs/reference/typescript-api/common/injector.mdx +0 -4
  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 +3 -7
  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 +0 -4
  277. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -14
  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 +1 -5
  280. package/docs/reference/typescript-api/configuration/collection-filter.mdx +0 -4
  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 +0 -12
  284. package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -4
  285. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -14
  286. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -10
  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 +0 -8
  289. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +2 -14
  290. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -5
  291. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -5
  292. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +0 -4
  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 +2 -6
  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 +0 -4
  303. package/docs/reference/typescript-api/data-access/calculated.mdx +2 -10
  304. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -5
  305. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -6
  306. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -5
  307. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -9
  308. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -11
  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 +0 -4
  311. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +0 -4
  312. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +0 -4
  313. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +1 -5
  314. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +0 -4
  315. package/docs/reference/typescript-api/entities/address.mdx +1 -5
  316. package/docs/reference/typescript-api/entities/administrator.mdx +1 -5
  317. package/docs/reference/typescript-api/entities/anonymous-session.mdx +0 -4
  318. package/docs/reference/typescript-api/entities/asset.mdx +0 -4
  319. package/docs/reference/typescript-api/entities/authenticated-session.mdx +2 -6
  320. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -14
  321. package/docs/reference/typescript-api/entities/channel.mdx +0 -4
  322. package/docs/reference/typescript-api/entities/collection.mdx +1 -5
  323. package/docs/reference/typescript-api/entities/country.mdx +3 -7
  324. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -5
  325. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -5
  326. package/docs/reference/typescript-api/entities/customer.mdx +1 -5
  327. package/docs/reference/typescript-api/entities/facet-value.mdx +1 -5
  328. package/docs/reference/typescript-api/entities/facet.mdx +2 -6
  329. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -5
  330. package/docs/reference/typescript-api/entities/global-settings.mdx +0 -4
  331. package/docs/reference/typescript-api/entities/history-entry.mdx +2 -6
  332. package/docs/reference/typescript-api/entities/interfaces.mdx +0 -20
  333. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -5
  334. package/docs/reference/typescript-api/entities/order-line-reference.mdx +4 -20
  335. package/docs/reference/typescript-api/entities/order-line.mdx +7 -11
  336. package/docs/reference/typescript-api/entities/order-modification.mdx +0 -4
  337. package/docs/reference/typescript-api/entities/order.mdx +7 -11
  338. package/docs/reference/typescript-api/entities/orderable-asset.mdx +0 -4
  339. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -6
  340. package/docs/reference/typescript-api/entities/payment.mdx +1 -5
  341. package/docs/reference/typescript-api/entities/product-option-group.mdx +1 -5
  342. package/docs/reference/typescript-api/entities/product-option.mdx +1 -5
  343. package/docs/reference/typescript-api/entities/product-variant-price.mdx +0 -4
  344. package/docs/reference/typescript-api/entities/product-variant.mdx +1 -5
  345. package/docs/reference/typescript-api/entities/product.mdx +1 -5
  346. package/docs/reference/typescript-api/entities/promotion.mdx +2 -6
  347. package/docs/reference/typescript-api/entities/province.mdx +1 -5
  348. package/docs/reference/typescript-api/entities/refund.mdx +0 -4
  349. package/docs/reference/typescript-api/entities/region.mdx +2 -6
  350. package/docs/reference/typescript-api/entities/role.mdx +1 -5
  351. package/docs/reference/typescript-api/entities/seller.mdx +1 -5
  352. package/docs/reference/typescript-api/entities/session.mdx +2 -6
  353. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +0 -4
  354. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -5
  355. package/docs/reference/typescript-api/entities/shipping-method.mdx +2 -6
  356. package/docs/reference/typescript-api/entities/stock-level.mdx +2 -6
  357. package/docs/reference/typescript-api/entities/stock-location.mdx +2 -6
  358. package/docs/reference/typescript-api/entities/stock-movement.mdx +1 -25
  359. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -5
  360. package/docs/reference/typescript-api/entities/tag.mdx +0 -4
  361. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -5
  362. package/docs/reference/typescript-api/entities/tax-rate.mdx +4 -8
  363. package/docs/reference/typescript-api/entities/user.mdx +1 -5
  364. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -5
  365. package/docs/reference/typescript-api/entities/zone.mdx +1 -5
  366. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +0 -4
  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 +0 -4
  372. package/docs/reference/typescript-api/events/event-bus.mdx +6 -10
  373. package/docs/reference/typescript-api/events/event-types.mdx +50 -286
  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 +3 -19
  377. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -12
  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 +2 -6
  386. package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -6
  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 +0 -4
  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 +8 -36
  391. package/docs/reference/typescript-api/import-export/importer.mdx +2 -6
  392. package/docs/reference/typescript-api/import-export/initial-data.mdx +0 -4
  393. package/docs/reference/typescript-api/import-export/populate.mdx +3 -7
  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 +5 -17
  396. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -7
  397. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -6
  398. package/docs/reference/typescript-api/job-queue/index.mdx +4 -8
  399. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +0 -4
  400. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +1 -5
  401. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -6
  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 +4 -8
  404. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +1 -5
  405. package/docs/reference/typescript-api/job-queue/job.mdx +2 -14
  406. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -7
  407. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +2 -6
  408. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +4 -8
  409. package/docs/reference/typescript-api/job-queue/types.mdx +5 -29
  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 +0 -4
  415. package/docs/reference/typescript-api/migration/migration-options.mdx +1 -5
  416. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +0 -4
  417. package/docs/reference/typescript-api/migration/run-migrations.mdx +0 -4
  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 +1 -5
  424. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +1 -5
  425. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -5
  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 +2 -10
  429. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -5
  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 +0 -4
  432. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +0 -4
  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 +0 -8
  435. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +0 -8
  436. package/docs/reference/typescript-api/orders/order-interceptor.mdx +4 -8
  437. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +2 -6
  438. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -9
  439. package/docs/reference/typescript-api/orders/order-options.mdx +2 -6
  440. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +0 -4
  441. package/docs/reference/typescript-api/orders/order-process.mdx +12 -40
  442. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -15
  443. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +0 -4
  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 +3 -7
  448. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +3 -15
  449. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -5
  450. package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -60
  451. package/docs/reference/typescript-api/payment/payment-options.mdx +7 -11
  452. package/docs/reference/typescript-api/payment/payment-process.mdx +1 -5
  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 +1 -5
  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 +3 -15
  463. package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -4
  464. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -5
  465. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +0 -4
  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 +2 -6
  468. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -6
  469. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -9
  470. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +0 -4
  471. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +4 -16
  472. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -7
  473. package/docs/reference/typescript-api/promotions/promotion-action.mdx +10 -70
  474. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +4 -16
  475. package/docs/reference/typescript-api/promotions/promotion-options.mdx +0 -4
  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 +1 -5
  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 +2 -6
  487. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +0 -12
  488. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -6
  489. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +0 -4
  490. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +3 -11
  491. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -7
  492. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +0 -4
  493. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -5
  494. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -5
  495. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -13
  496. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -5
  497. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +0 -4
  498. package/docs/reference/typescript-api/services/administrator-service.mdx +1 -5
  499. package/docs/reference/typescript-api/services/asset-service.mdx +2 -14
  500. package/docs/reference/typescript-api/services/auth-service.mdx +3 -7
  501. package/docs/reference/typescript-api/services/channel-service.mdx +3 -7
  502. package/docs/reference/typescript-api/services/collection-service.mdx +3 -7
  503. package/docs/reference/typescript-api/services/country-service.mdx +1 -5
  504. package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -6
  505. package/docs/reference/typescript-api/services/customer-service.mdx +13 -17
  506. package/docs/reference/typescript-api/services/entity-slug-service.mdx +0 -4
  507. package/docs/reference/typescript-api/services/facet-service.mdx +1 -5
  508. package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -5
  509. package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -7
  510. package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -5
  511. package/docs/reference/typescript-api/services/history-service.mdx +1 -5
  512. package/docs/reference/typescript-api/services/initializer-service.mdx +0 -4
  513. package/docs/reference/typescript-api/services/order-service.mdx +24 -28
  514. package/docs/reference/typescript-api/services/order-testing-service.mdx +0 -4
  515. package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -5
  516. package/docs/reference/typescript-api/services/payment-service.mdx +6 -10
  517. package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -5
  518. package/docs/reference/typescript-api/services/product-option-service.mdx +1 -5
  519. package/docs/reference/typescript-api/services/product-service.mdx +2 -6
  520. package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -11
  521. package/docs/reference/typescript-api/services/promotion-service.mdx +1 -5
  522. package/docs/reference/typescript-api/services/province-service.mdx +1 -5
  523. package/docs/reference/typescript-api/services/role-service.mdx +1 -5
  524. package/docs/reference/typescript-api/services/search-service.mdx +0 -4
  525. package/docs/reference/typescript-api/services/seller-service.mdx +1 -5
  526. package/docs/reference/typescript-api/services/session-service.mdx +4 -8
  527. package/docs/reference/typescript-api/services/settings-store-service.mdx +0 -4
  528. package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -5
  529. package/docs/reference/typescript-api/services/slug-service.mdx +0 -4
  530. package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -9
  531. package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -9
  532. package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -12
  533. package/docs/reference/typescript-api/services/tag-service.mdx +1 -5
  534. package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -5
  535. package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -5
  536. package/docs/reference/typescript-api/services/user-service.mdx +8 -12
  537. package/docs/reference/typescript-api/services/zone-service.mdx +1 -5
  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 +0 -4
  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 +1 -5
  549. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +4 -16
  550. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +1 -5
  551. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -5
  552. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +2 -6
  553. package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -7
  554. package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -4
  555. package/docs/reference/typescript-api/state-machine/fsm.mdx +0 -4
  556. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -17
  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 +2 -10
  562. package/docs/reference/typescript-api/tax/tax-options.mdx +0 -4
  563. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -5
  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 +1 -5
  567. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -5
  568. package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -6
  569. package/docs/reference/typescript-api/testing/error-result-guard.mdx +0 -4
  570. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -5
  571. package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -6
  572. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +0 -4
  573. package/docs/reference/typescript-api/testing/test-config.mdx +1 -5
  574. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -5
  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 +0 -4
  578. package/docs/reference/typescript-api/testing/testing-logger.mdx +0 -4
  579. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -10
  580. package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -5
  581. package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -4
  582. package/package.json +2 -2
@@ -2,13 +2,9 @@
2
2
  title: "ProductVariantService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ProductVariantService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/product-variant.service.ts" sourceLine="70" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class ProductVariantService {
@@ -70,7 +66,7 @@ class ProductVariantService {
70
66
 
71
67
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: ListQueryOptions<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>>`} />
72
68
 
73
- Returns a <a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a> of all ProductVariants associated with the given Collection.
69
+ Returns a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> of all ProductVariants associated with the given Collection.
74
70
  ### getProductVariantChannels
75
71
 
76
72
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]>`} />
@@ -85,12 +81,12 @@ Returns all Channels to which the ProductVariant is assigned.
85
81
 
86
82
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>`} />
87
83
 
88
- Returns the ProductVariant associated with the given <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>.
84
+ Returns the ProductVariant associated with the given <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink>.
89
85
  ### getOptionsForVariant
90
86
 
91
87
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, variantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>>>>`} />
92
88
 
93
- Returns the <a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>s for the given ProductVariant.
89
+ Returns the <DocsLink href="/reference/typescript-api/entities/product-option#productoption">ProductOption</DocsLink>s for the given ProductVariant.
94
90
  ### getFacetValuesForVariant
95
91
 
96
92
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, variantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>>>`} />
@@ -115,7 +111,7 @@ as well as the local and global `outOfStockThreshold` settings.
115
111
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, variant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>) => Promise<string>`} />
116
112
 
117
113
  Returns the stockLevel to display to the customer, as specified by the configured
118
- <a href='/reference/typescript-api/products-stock/stock-display-strategy#stockdisplaystrategy'>StockDisplayStrategy</a>.
114
+ <DocsLink href="/reference/typescript-api/products-stock/stock-display-strategy#stockdisplaystrategy">StockDisplayStrategy</DocsLink>.
119
115
  ### getFulfillableStockLevel
120
116
 
121
117
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, variant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>) => Promise<number>`} />
@@ -136,7 +132,7 @@ for those variants which are tracking inventory.
136
132
 
137
133
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, price: number, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, currencyCode?: <a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>, customFields?: CustomFieldsObject) => Promise<<a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a>>`} />
138
134
 
139
- Creates a <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> for the given ProductVariant/Channel combination.
135
+ Creates a <DocsLink href="/reference/typescript-api/entities/product-variant-price#productvariantprice">ProductVariantPrice</DocsLink> for the given ProductVariant/Channel combination.
140
136
  If the `currencyCode` is not specified, the default currency of the Channel will be used.
141
137
  ### deleteProductVariantPrice
142
138
 
@@ -167,7 +163,7 @@ Populates the `price` field with the price for the specified channel.
167
163
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignProductVariantsToChannelInput) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>>`} />
168
164
 
169
165
  Assigns the specified ProductVariants to the specified Channel. In doing so, it will create a new
170
- <a href='/reference/typescript-api/entities/product-variant-price#productvariantprice'>ProductVariantPrice</a> and also assign the associated Product and any Assets to the Channel too.
166
+ <DocsLink href="/reference/typescript-api/entities/product-variant-price#productvariantprice">ProductVariantPrice</DocsLink> and also assign the associated Product and any Assets to the Channel too.
171
167
  ### removeProductVariantsFromChannel
172
168
 
173
169
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemoveProductVariantsFromChannelInput) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>>`} />
@@ -2,13 +2,9 @@
2
2
  title: "PromotionService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PromotionService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/promotion.service.ts" sourceLine="57" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class PromotionService {
@@ -2,13 +2,9 @@
2
2
  title: "ProvinceService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ProvinceService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/province.service.ts" sourceLine="32" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/province#province'>Province</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/province#province">Province</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class ProvinceService {
@@ -2,13 +2,9 @@
2
2
  title: "RoleService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## RoleService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/role.service.ts" sourceLine="55" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/role#role'>Role</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/role#role">Role</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class RoleService {
@@ -2,10 +2,6 @@
2
2
  title: "SearchService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SearchService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/search.service.ts" sourceLine="15" packageName="@vendure/core" />
10
6
 
11
7
  This service allows a concrete search service to override its behaviour
@@ -2,13 +2,9 @@
2
2
  title: "SellerService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SellerService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/seller.service.ts" sourceLine="26" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/seller#seller'>Seller</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/seller#seller">Seller</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class SellerService {
@@ -2,13 +2,9 @@
2
2
  title: "SessionService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SessionService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/session.service.ts" sourceLine="33" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/session#session'>Session</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/session#session">Session</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class SessionService implements EntitySubscriberInterface, OnApplicationBootstrap {
@@ -47,12 +43,12 @@ class SessionService implements EntitySubscriberInterface, OnApplicationBootstra
47
43
 
48
44
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>, authenticationStrategyName: string) => Promise<<a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>>`} />
49
45
 
50
- Creates a new <a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a>. To be used after successful authentication.
46
+ Creates a new <DocsLink href="/reference/typescript-api/entities/authenticated-session#authenticatedsession">AuthenticatedSession</DocsLink>. To be used after successful authentication.
51
47
  ### createAnonymousSession
52
48
 
53
49
  <MemberInfo kind="method" type={`() => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>>`} />
54
50
 
55
- Create an <a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a> and caches it using the configured <a href='/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy'>SessionCacheStrategy</a>,
51
+ Create an <DocsLink href="/reference/typescript-api/entities/anonymous-session#anonymoussession">AnonymousSession</DocsLink> and caches it using the configured <DocsLink href="/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy">SessionCacheStrategy</DocsLink>,
56
52
  and returns the cached session object.
57
53
  ### getSessionFromToken
58
54
 
@@ -63,7 +59,7 @@ Returns the cached session object matching the given session token.
63
59
 
64
60
  <MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/entities/authenticated-session#authenticatedsession'>AuthenticatedSession</a> | <a href='/reference/typescript-api/entities/anonymous-session#anonymoussession'>AnonymousSession</a>) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>`} />
65
61
 
66
- Serializes a <a href='/reference/typescript-api/entities/session#session'>Session</a> instance into a simplified plain object suitable for caching.
62
+ Serializes a <DocsLink href="/reference/typescript-api/entities/session#session">Session</DocsLink> instance into a simplified plain object suitable for caching.
67
63
  ### setActiveOrder
68
64
 
69
65
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, serializedSession: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>>`} />
@@ -2,10 +2,6 @@
2
2
  title: "SettingsStoreService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SettingsStoreService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/settings-store/settings-store.service.ts" sourceLine="50" packageName="@vendure/core" since="3.4.0" />
10
6
 
11
7
  The SettingsStoreService provides a flexible settings storage system with support for
@@ -2,13 +2,9 @@
2
2
  title: "ShippingMethodService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ShippingMethodService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/shipping-method.service.ts" sourceLine="45" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/shipping-method#shippingmethod">ShippingMethod</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class ShippingMethodService {
@@ -2,10 +2,6 @@
2
2
  title: "SlugService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SlugService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/slug.service.ts" sourceLine="13" packageName="@vendure/core" since="3.5.0" />
10
6
 
11
7
  A service that handles slug generation using the configured SlugStrategy.
@@ -2,10 +2,6 @@
2
2
  title: "StockLevelService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## StockLevelService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/stock-level.service.ts" sourceLine="23" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
7
  The StockLevelService is responsible for managing the stock levels of ProductVariants.
@@ -34,7 +30,7 @@ class StockLevelService {
34
30
 
35
31
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>>`} />
36
32
 
37
- Returns the StockLevel for the given <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> and <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>.
33
+ Returns the StockLevel for the given <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> and <DocsLink href="/reference/typescript-api/entities/stock-location#stocklocation">StockLocation</DocsLink>.
38
34
  ### getStockLevelsForVariant
39
35
 
40
36
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]>`} />
@@ -44,18 +40,18 @@ Returns the StockLevel for the given <a href='/reference/typescript-api/entities
44
40
 
45
41
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>>`} />
46
42
 
47
- Returns the available stock (on hand and allocated) for the given <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>. This is determined
48
- by the configured <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>.
43
+ Returns the available stock (on hand and allocated) for the given <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink>. This is determined
44
+ by the configured <DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink>.
49
45
  ### updateStockOnHandForLocation
50
46
 
51
47
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>, change: number) => `} />
52
48
 
53
- Updates the `stockOnHand` for the given <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> and <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>.
49
+ Updates the `stockOnHand` for the given <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> and <DocsLink href="/reference/typescript-api/entities/stock-location#stocklocation">StockLocation</DocsLink>.
54
50
  ### updateStockAllocatedForLocation
55
51
 
56
52
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLocationId: <a href='/reference/typescript-api/common/id#id'>ID</a>, change: number) => `} />
57
53
 
58
- Updates the `stockAllocated` for the given <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> and <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>.
54
+ Updates the `stockAllocated` for the given <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> and <DocsLink href="/reference/typescript-api/entities/stock-location#stocklocation">StockLocation</DocsLink>.
59
55
 
60
56
 
61
57
  </div>
@@ -2,13 +2,9 @@
2
2
  title: "StockLocationService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## StockLocationService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/stock-location.service.ts" sourceLine="41" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/stock-location#stocklocation">StockLocation</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class StockLocationService {
@@ -90,25 +86,25 @@ permission on the target channel. StockLocations cannot be removed from the defa
90
86
  <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>, quantity: number) => `} />
91
87
 
92
88
  Returns the locations and quantities to use for allocating stock when an OrderLine is created.
93
- This uses the configured <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>.
89
+ This uses the configured <DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink>.
94
90
  ### getReleaseLocations
95
91
 
96
92
  <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>, quantity: number) => `} />
97
93
 
98
94
  Returns the locations and quantities to use for releasing allocated stock when an OrderLine is cancelled
99
- or modified. This uses the configured <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>.
95
+ or modified. This uses the configured <DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink>.
100
96
  ### getSaleLocations
101
97
 
102
98
  <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>, quantity: number) => `} />
103
99
 
104
100
  Returns the locations and quantities to use for creating sales when an Order is fulfilled.
105
- This uses the configured <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>.
101
+ This uses the configured <DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink>.
106
102
  ### getCancellationLocations
107
103
 
108
104
  <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>, quantity: number) => `} />
109
105
 
110
106
  Returns the locations and quantities to use for cancelling sales when an OrderLine is cancelled
111
- after fulfillment. This uses the configured <a href='/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy'>StockLocationStrategy</a>.
107
+ after fulfillment. This uses the configured <DocsLink href="/reference/typescript-api/products-stock/stock-location-strategy#stocklocationstrategy">StockLocationStrategy</DocsLink>.
112
108
 
113
109
 
114
110
  </div>
@@ -2,13 +2,9 @@
2
2
  title: "StockMovementService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## StockMovementService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/stock-movement.service.ts" sourceLine="41" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/stock-movement#stockmovement'>StockMovement</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">StockMovement</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class StockMovementService {
@@ -46,32 +42,32 @@ class StockMovementService {
46
42
 
47
43
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: StockMovementListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/stock-movement#stockmovement'>StockMovement</a>>>`} />
48
44
 
49
- Returns a <a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a> of all StockMovements associated with the specified ProductVariant.
45
+ Returns a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> of all StockMovements associated with the specified ProductVariant.
50
46
  ### adjustProductVariantStock
51
47
 
52
48
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockOnHandNumberOrInput: number | StockLevelInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a>[]>`} />
53
49
 
54
- Adjusts the stock level of the ProductVariant, creating a new <a href='/reference/typescript-api/entities/stock-movement#stockadjustment'>StockAdjustment</a> entity
50
+ Adjusts the stock level of the ProductVariant, creating a new <DocsLink href="/reference/typescript-api/entities/stock-movement#stockadjustment">StockAdjustment</DocsLink> entity
55
51
  in the process.
56
52
  ### createAllocationsForOrder
57
53
 
58
54
  <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>) => Promise<<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]>`} />
59
55
 
60
- Creates a new <a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a> for each OrderLine in the Order. For ProductVariants
56
+ Creates a new <DocsLink href="/reference/typescript-api/entities/stock-movement#allocation">Allocation</DocsLink> for each OrderLine in the Order. For ProductVariants
61
57
  which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
62
58
  increased, indicating that this quantity of stock is allocated and cannot be sold.
63
59
  ### createAllocationsForOrderLines
64
60
 
65
61
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lines: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>[]>`} />
66
62
 
67
- Creates a new <a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a> for each of the given OrderLines. For ProductVariants
63
+ Creates a new <DocsLink href="/reference/typescript-api/entities/stock-movement#allocation">Allocation</DocsLink> for each of the given OrderLines. For ProductVariants
68
64
  which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
69
65
  increased, indicating that this quantity of stock is allocated and cannot be sold.
70
66
  ### createSalesForOrder
71
67
 
72
68
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lines: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>[]>`} />
73
69
 
74
- Creates <a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a>s for each OrderLine in the Order. For ProductVariants
70
+ Creates <DocsLink href="/reference/typescript-api/entities/stock-movement#sale">Sale</DocsLink>s for each OrderLine in the Order. For ProductVariants
75
71
  which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
76
72
  reduced and the `stockOnHand` value is also reduced by the OrderLine quantity, indicating
77
73
  that the stock is no longer allocated, but is actually sold and no longer available.
@@ -79,14 +75,14 @@ that the stock is no longer allocated, but is actually sold and no longer availa
79
75
 
80
76
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lineInputs: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a>[]>`} />
81
77
 
82
- Creates a <a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a> for each of the specified OrderItems. For ProductVariants
78
+ Creates a <DocsLink href="/reference/typescript-api/entities/stock-movement#cancellation">Cancellation</DocsLink> for each of the specified OrderItems. For ProductVariants
83
79
  which are configured to track stock levels, the `ProductVariant.stockOnHand` value is
84
80
  increased for each Cancellation, allowing that stock to be sold again.
85
81
  ### createReleasesForOrderLines
86
82
 
87
83
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, lineInputs: OrderLineInput[]) => Promise<<a href='/reference/typescript-api/entities/stock-movement#release'>Release</a>[]>`} />
88
84
 
89
- Creates a <a href='/reference/typescript-api/entities/stock-movement#release'>Release</a> for each of the specified OrderItems. For ProductVariants
85
+ Creates a <DocsLink href="/reference/typescript-api/entities/stock-movement#release">Release</DocsLink> for each of the specified OrderItems. For ProductVariants
90
86
  which are configured to track stock levels, the `ProductVariant.stockAllocated` value is
91
87
  reduced, indicating that this stock is once again available to buy.
92
88
 
@@ -2,13 +2,9 @@
2
2
  title: "TagService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TagService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/tag.service.ts" sourceLine="25" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/tag#tag'>Tag</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/tag#tag">Tag</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class TagService {
@@ -2,13 +2,9 @@
2
2
  title: "TaxCategoryService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TaxCategoryService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/tax-category.service.ts" sourceLine="29" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/tax-category#taxcategory">TaxCategory</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class TaxCategoryService {
@@ -2,13 +2,9 @@
2
2
  title: "TaxRateService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TaxRateService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/tax-rate.service.ts" sourceLine="37" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/tax-rate#taxrate">TaxRate</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class TaxRateService {
@@ -2,13 +2,9 @@
2
2
  title: "UserService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## UserService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/user.service.ts" sourceLine="38" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/user#user'>User</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/user#user">User</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class UserService {
@@ -57,19 +53,19 @@ class UserService {
57
53
 
58
54
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string, password?: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | PasswordValidationError>`} />
59
55
 
60
- Creates a new User with the special `customer` Role and using the <a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a>.
56
+ Creates a new User with the special `customer` Role and using the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink>.
61
57
  ### addNativeAuthenticationMethod
62
58
 
63
59
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>, identifier: string, password?: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | PasswordValidationError>`} />
64
60
 
65
- Adds a new <a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a> to the User. If the <a href='/reference/typescript-api/auth/auth-options#authoptions'>AuthOptions</a> `requireVerification`
61
+ Adds a new <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> to the User. If the <DocsLink href="/reference/typescript-api/auth/auth-options#authoptions">AuthOptions</DocsLink> `requireVerification`
66
62
  is set to `true` (as is the default), the User will be marked as unverified until the email verification
67
63
  flow is completed.
68
64
  ### createAdminUser
69
65
 
70
66
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string, password: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
71
67
 
72
- Creates a new verified User using the <a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a>.
68
+ Creates a new verified User using the <DocsLink href="/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy">NativeAuthenticationStrategy</DocsLink>.
73
69
  ### softDelete
74
70
 
75
71
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => `} />
@@ -79,7 +75,7 @@ Creates a new verified User using the <a href='/reference/typescript-api/auth/na
79
75
 
80
76
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
81
77
 
82
- Sets the <a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a> `verificationToken` as part of the User email verification
78
+ Sets the <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> `verificationToken` as part of the User email verification
83
79
  flow.
84
80
  ### verifyUserByToken
85
81
 
@@ -93,7 +89,7 @@ If valid, the User will be set to `verified: true`.
93
89
 
94
90
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, emailAddress: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
95
91
 
96
- Sets the <a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a> `passwordResetToken` as part of the User password reset
92
+ Sets the <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> `passwordResetToken` as part of the User password reset
97
93
  flow.
98
94
  ### resetPasswordByToken
99
95
 
@@ -113,7 +109,7 @@ an Administrator is setting a new email address.
113
109
 
114
110
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
115
111
 
116
- Sets the <a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a> `identifierChangeToken` as part of the User email address change
112
+ Sets the <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink> `identifierChangeToken` as part of the User email address change
117
113
  flow.
118
114
  ### changeIdentifierByToken
119
115
 
@@ -125,7 +121,7 @@ new email address, with the token previously set using the `setIdentifierChangeT
125
121
 
126
122
  <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, currentPassword: string, newPassword: string) => Promise<boolean | InvalidCredentialsError | PasswordValidationError>`} />
127
123
 
128
- Updates the password for a User with the <a href='/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod'>NativeAuthenticationMethod</a>.
124
+ Updates the password for a User with the <DocsLink href="/reference/typescript-api/entities/authentication-method#nativeauthenticationmethod">NativeAuthenticationMethod</DocsLink>.
129
125
 
130
126
 
131
127
  </div>
@@ -2,13 +2,9 @@
2
2
  title: "ZoneService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ZoneService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/services/zone.service.ts" sourceLine="38" packageName="@vendure/core" />
10
6
 
11
- Contains methods relating to <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> entities.
7
+ Contains methods relating to <DocsLink href="/reference/typescript-api/entities/zone#zone">Zone</DocsLink> entities.
12
8
 
13
9
  ```ts title="Signature"
14
10
  class ZoneService {
@@ -2,10 +2,6 @@
2
2
  title: "CleanupOrphanedSettingsStoreEntriesOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## CleanupOrphanedSettingsStoreEntriesOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/settings-store/settings-store-types.ts" sourceLine="270" packageName="@vendure/core" since="3.4.0" />
10
6
 
11
7
  Options for cleaning up orphaned settings store entries.
@@ -2,10 +2,6 @@
2
2
  title: "CleanupOrphanedSettingsStoreEntriesResult"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## CleanupOrphanedSettingsStoreEntriesResult
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/settings-store/settings-store-types.ts" sourceLine="308" packageName="@vendure/core" since="3.4.0" />
10
6
 
11
7
  Result of a cleanup operation for orphaned settings store entries.
@@ -2,13 +2,9 @@
2
2
  title: "SettingsStore"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## cleanOrphanedSettingsStoreTask
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/settings-store/clean-orphaned-settings-store-task.ts" sourceLine="39" packageName="@vendure/core" since="3.4.0" />
10
6
 
11
- A <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a> that cleans up orphaned settings store entries from the database.
7
+ A <DocsLink href="/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask">ScheduledTask</DocsLink> that cleans up orphaned settings store entries from the database.
12
8
  Orphaned entries are entries that no longer have corresponding field definitions
13
9
  in the settings store configuration.
14
10
 
@@ -2,10 +2,6 @@
2
2
  title: "OrphanedSettingsStoreEntry"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## OrphanedSettingsStoreEntry
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/settings-store/settings-store-types.ts" sourceLine="237" packageName="@vendure/core" since="3.4.0" />
10
6
 
11
7
  Represents an orphaned settings store entry that no longer has a corresponding
@@ -2,10 +2,6 @@
2
2
  title: "SetSettingsStoreValueResult"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SetSettingsStoreValueResult
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/settings-store/settings-store-types.ts" sourceLine="209" packageName="@vendure/core" since="3.4.0" />
10
6
 
11
7
  Result type for settings store set operations, providing detailed feedback