@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,14 +2,10 @@
2
2
  title: "InMemoryJobQueueStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## InMemoryJobQueueStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/in-memory-job-queue-strategy.ts" sourceLine="42" packageName="@vendure/core" />
10
6
 
11
- An in-memory <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a>. This is the default strategy if not using a dedicated
12
- JobQueue plugin (e.g. <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>). Not recommended for production, since
7
+ An in-memory <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink>. This is the default strategy if not using a dedicated
8
+ JobQueue plugin (e.g. <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink>). Not recommended for production, since
13
9
  the queue will be cleared when the server stops, and can only be used when the JobQueueService is
14
10
  started from the main server process:
15
11
 
@@ -2,18 +2,14 @@
2
2
  title: "JobQueue"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## JobQueue
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job-queue.ts" sourceLine="21" packageName="@vendure/core" />
10
6
 
11
- A JobQueue is used to process <a href='/reference/typescript-api/job-queue/job#job'>Job</a>s. A job is added to the queue via the
12
- `.add()` method, and the configured <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> will check for new jobs and process each
7
+ A JobQueue is used to process <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink>s. A job is added to the queue via the
8
+ `.add()` method, and the configured <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> will check for new jobs and process each
13
9
  according to the defined `process` function.
14
10
 
15
11
  *Note*: JobQueue instances should not be directly instantiated. Rather, the
16
- <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a> `createQueue()` method should be used (see that service
12
+ <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink> `createQueue()` method should be used (see that service
17
13
  for example usage).
18
14
 
19
15
  ```ts title="Signature"
@@ -46,7 +42,7 @@ class JobQueue<Data extends JobData<Data> = object> {
46
42
 
47
43
  <MemberInfo kind="method" type={`(data: Data, options?: JobOptions<Data>) => Promise<<a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a><Data>>`} />
48
44
 
49
- Adds a new <a href='/reference/typescript-api/job-queue/job#job'>Job</a> to the queue. The resolved <a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a> allows the
45
+ Adds a new <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink> to the queue. The resolved <DocsLink href="/reference/typescript-api/job-queue/subscribable-job#subscribablejob">SubscribableJob</DocsLink> allows the
50
46
  calling code to subscribe to updates to the Job:
51
47
 
52
48
  *Example*
@@ -2,10 +2,6 @@
2
2
  title: "InspectableJobQueueStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## InspectableJobQueueStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/job-queue/inspectable-job-queue-strategy.ts" sourceLine="14" packageName="@vendure/core" />
10
6
 
11
7
  Defines a job queue strategy that can be inspected using the default admin ui
@@ -2,14 +2,10 @@
2
2
  title: "JobBufferStorageStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## JobBufferStorageStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/job-buffer-storage-strategy.ts" sourceLine="19" packageName="@vendure/core" since="1.3.0" />
10
6
 
11
7
  This strategy defines where to store jobs that have been collected by a
12
- <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>.
8
+ <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>.
13
9
 
14
10
  :::info
15
11
 
@@ -2,16 +2,12 @@
2
2
  title: "JobBuffer"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## JobBuffer
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/job-buffer.ts" sourceLine="83" packageName="@vendure/core" since="1.3.0" />
10
6
 
11
7
  A JobBuffer is used to temporarily prevent jobs from being sent to the job queue for processing.
12
8
  Instead, it collects certain jobs (as specified by the `collect()` method), and stores them.
13
9
 
14
- How these buffered jobs are stored is determined by the configured <a href='/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy'>JobBufferStorageStrategy</a>.
10
+ How these buffered jobs are stored is determined by the configured <DocsLink href="/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy">JobBufferStorageStrategy</DocsLink>.
15
11
 
16
12
  The JobBuffer can be thought of as a kind of "interceptor" of jobs. That is, when a JobBuffer is active,
17
13
  it sits in between calls to `JobQueue.add()` and the actual adding of the job to the queue.
@@ -62,7 +58,7 @@ export class CollectionJobBuffer implements JobBuffer<ApplyCollectionFiltersJobD
62
58
  }
63
59
  ```
64
60
 
65
- A JobBuffer is used by adding it to the <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a>, at which point it will become active
61
+ A JobBuffer is used by adding it to the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>, at which point it will become active
66
62
  and start collecting jobs.
67
63
 
68
64
  At some later point, the buffer can be flushed, causing the buffered jobs to be passed through the
@@ -2,10 +2,6 @@
2
2
  title: "JobQueueOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## JobQueueOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="960" packageName="@vendure/core" />
10
6
 
11
7
  Options related to the built-in job queue.
@@ -2,13 +2,9 @@
2
2
  title: "JobQueueService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## JobQueueService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job-queue.service.ts" sourceLine="49" packageName="@vendure/core" />
10
6
 
11
- The JobQueueService is used to create new <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a> instances and access
7
+ The JobQueueService is used to create new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instances and access
12
8
  existing jobs.
13
9
 
14
10
  *Example*
@@ -67,7 +63,7 @@ class JobQueueService implements OnModuleDestroy {
67
63
 
68
64
  <MemberInfo kind="method" type={`(options: <a href='/reference/typescript-api/job-queue/types#createqueueoptions'>CreateQueueOptions</a><Data>) => Promise<<a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a><Data>>`} />
69
65
 
70
- Configures and creates a new <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a> instance.
66
+ Configures and creates a new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instance.
71
67
  ### start
72
68
 
73
69
  <MemberInfo kind="method" type={`() => Promise<void>`} />
@@ -77,13 +73,13 @@ Configures and creates a new <a href='/reference/typescript-api/job-queue/#jobqu
77
73
 
78
74
  <MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any>) => `} since="1.3.0" />
79
75
 
80
- Adds a <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>, which will make it active and begin collecting
76
+ Adds a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>, which will make it active and begin collecting
81
77
  jobs to buffer.
82
78
  ### removeBuffer
83
79
 
84
80
  <MemberInfo kind="method" type={`(buffer: <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a><any>) => `} since="1.3.0" />
85
81
 
86
- Removes a <a href='/reference/typescript-api/job-queue/job-buffer#jobbuffer'>JobBuffer</a>, prevent it from collecting and buffering any
82
+ Removes a <DocsLink href="/reference/typescript-api/job-queue/job-buffer#jobbuffer">JobBuffer</DocsLink>, prevent it from collecting and buffering any
87
83
  subsequent jobs.
88
84
  ### bufferSize
89
85
 
@@ -2,13 +2,9 @@
2
2
  title: "JobQueueStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## JobQueueStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/job-queue/job-queue-strategy.ts" sourceLine="24" packageName="@vendure/core" />
10
6
 
11
- Defines how the jobs in the <a href='/reference/typescript-api/job-queue/job-queue-service#jobqueueservice'>JobQueueService</a> are persisted and
7
+ Defines how the jobs in the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink> are persisted and
12
8
  accessed. Custom strategies can be defined to make use of external
13
9
  services such as Redis.
14
10
 
@@ -2,15 +2,11 @@
2
2
  title: "Job"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Job
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/job.ts" sourceLine="37" packageName="@vendure/core" />
10
6
 
11
7
  A Job represents a piece of work to be run in the background, i.e. outside the request-response cycle.
12
8
  It is intended to be used for long-running work triggered by API requests. Jobs should now generally
13
- be directly instantiated. Rather, the <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a> `add()` method should be used to create and
9
+ be directly instantiated. Rather, the <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> `add()` method should be used to create and
14
10
  add a new Job to a queue.
15
11
 
16
12
  ```ts title="Signature"
@@ -129,7 +125,7 @@ class Job<T extends JobData<T> = any> {
129
125
  <MemberInfo kind="method" type={`() => `} />
130
126
 
131
127
  Calling this signifies that the job work has started. This method should be
132
- called in the <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> `next()` method.
128
+ called in the <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> `next()` method.
133
129
  ### setProgress
134
130
 
135
131
  <MemberInfo kind="method" type={`(percent: number) => `} />
@@ -170,10 +166,6 @@ Used to register event handler for job events
170
166
 
171
167
 
172
168
  </div>
173
-
174
-
175
- ## JobEventType
176
-
177
169
  <GenerationInfo sourceFile="packages/core/src/job-queue/job.ts" sourceLine="15" packageName="@vendure/core" />
178
170
 
179
171
  An event raised by a Job.
@@ -181,10 +173,6 @@ An event raised by a Job.
181
173
  ```ts title="Signature"
182
174
  type JobEventType = 'progress'
183
175
  ```
184
-
185
-
186
- ## JobEventListener
187
-
188
176
  <GenerationInfo sourceFile="packages/core/src/job-queue/job.ts" sourceLine="24" packageName="@vendure/core" />
189
177
 
190
178
  The signature of the event handler expected by the `Job.on()` method.
@@ -2,17 +2,13 @@
2
2
  title: "PollingJobQueueStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PollingJobQueueStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/polling-job-queue-strategy.ts" sourceLine="242" packageName="@vendure/core" />
10
6
 
11
- This class allows easier implementation of <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> in a polling style.
12
- Instead of providing <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> `start()` you should provide a `next` method.
7
+ This class allows easier implementation of <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> in a polling style.
8
+ Instead of providing <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> `start()` you should provide a `next` method.
13
9
 
14
10
  This class should be extended by any strategy which does not support a push-based system
15
- to notify on new jobs. It is used by the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a> and <a href='/reference/typescript-api/job-queue/in-memory-job-queue-strategy#inmemoryjobqueuestrategy'>InMemoryJobQueueStrategy</a>.
11
+ to notify on new jobs. It is used by the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink> and <DocsLink href="/reference/typescript-api/job-queue/in-memory-job-queue-strategy#inmemoryjobqueuestrategy">InMemoryJobQueueStrategy</DocsLink>.
16
12
 
17
13
  ```ts title="Signature"
18
14
  class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
@@ -2,14 +2,10 @@
2
2
  title: "SqlJobQueueStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SqlJobQueueStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/sql-job-queue-strategy.ts" sourceLine="22" packageName="@vendure/core" />
10
6
 
11
- A <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> which uses the configured SQL database to persist jobs in the queue.
12
- This strategy is used by the <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a>.
7
+ A <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> which uses the configured SQL database to persist jobs in the queue.
8
+ This strategy is used by the <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink>.
13
9
 
14
10
  ```ts title="Signature"
15
11
  class SqlJobQueueStrategy extends PollingJobQueueStrategy implements InspectableJobQueueStrategy {
@@ -2,16 +2,12 @@
2
2
  title: "SubscribableJob"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## SubscribableJob
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="59" packageName="@vendure/core" />
10
6
 
11
7
  This is a type of Job object that allows you to subscribe to updates to the Job. It is returned
12
- by the <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a>'s `add()` method. Note that the subscription capability is only supported
13
- if the <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> implements the <a href='/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy'>InspectableJobQueueStrategy</a> interface (e.g.
14
- the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a> does support this).
8
+ by the <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink>'s `add()` method. Note that the subscription capability is only supported
9
+ if the <DocsLink href="/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy">JobQueueStrategy</DocsLink> implements the <DocsLink href="/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy">InspectableJobQueueStrategy</DocsLink> interface (e.g.
10
+ the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink> does support this).
15
11
 
16
12
  ```ts title="Signature"
17
13
  class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
@@ -37,7 +33,7 @@ class SubscribableJob<T extends JobData<T> = any> extends Job<T> {
37
33
  Returns an Observable stream of updates to the Job. Works by polling the current JobQueueStrategy's `findOne()` method
38
34
  to obtain updates. If the updates are not subscribed to, then no polling occurs.
39
35
 
40
- Polling interval, timeout and other options may be configured with an options arguments <a href='/reference/typescript-api/job-queue/types#jobupdateoptions'>JobUpdateOptions</a>.
36
+ Polling interval, timeout and other options may be configured with an options arguments <DocsLink href="/reference/typescript-api/job-queue/types#jobupdateoptions">JobUpdateOptions</DocsLink>.
41
37
 
42
38
 
43
39
  </div>
@@ -2,10 +2,6 @@
2
2
  title: "Types"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## BackoffStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/job-queue/polling-job-queue-strategy.ts" sourceLine="22" packageName="@vendure/core" />
10
6
 
11
7
  Defines the backoff strategy used when retrying failed jobs. Returns the delay in
@@ -14,13 +10,9 @@ ms that should pass before the failed job is retried.
14
10
  ```ts title="Signature"
15
11
  type BackoffStrategy = (queueName: string, attemptsMade: number, job: Job) => number
16
12
  ```
17
-
18
-
19
- ## JobUpdate
20
-
21
13
  <GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="23" packageName="@vendure/core" />
22
14
 
23
- Job update status as returned from the <a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a>'s `update()` method.
15
+ Job update status as returned from the <DocsLink href="/reference/typescript-api/job-queue/subscribable-job#subscribablejob">SubscribableJob</DocsLink>'s `update()` method.
24
16
 
25
17
  ```ts title="Signature"
26
18
  type JobUpdate<T extends JobData<T>> = Pick<
@@ -28,13 +20,9 @@ type JobUpdate<T extends JobData<T>> = Pick<
28
20
  'id' | 'state' | 'progress' | 'result' | 'error' | 'data'
29
21
  >
30
22
  ```
31
-
32
-
33
- ## JobUpdateOptions
34
-
35
23
  <GenerationInfo sourceFile="packages/core/src/job-queue/subscribable-job.ts" sourceLine="35" packageName="@vendure/core" />
36
24
 
37
- Job update options, that you can specify by calling <a href='/reference/typescript-api/job-queue/subscribable-job#subscribablejob'>SubscribableJob</a> `updates` method.
25
+ Job update options, that you can specify by calling <DocsLink href="/reference/typescript-api/job-queue/subscribable-job#subscribablejob">SubscribableJob</DocsLink> `updates` method.
38
26
 
39
27
  ```ts title="Signature"
40
28
  type JobUpdateOptions = {
@@ -64,13 +52,9 @@ type JobUpdateOptions = {
64
52
 
65
53
 
66
54
  </div>
67
-
68
-
69
- ## CreateQueueOptions
70
-
71
55
  <GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="15" packageName="@vendure/core" />
72
56
 
73
- Used to configure a new <a href='/reference/typescript-api/job-queue/#jobqueue'>JobQueue</a> instance.
57
+ Used to configure a new <DocsLink href="/reference/typescript-api/job-queue/#jobqueue">JobQueue</DocsLink> instance.
74
58
 
75
59
  ```ts title="Signature"
76
60
  interface CreateQueueOptions<T extends JobData<T>> {
@@ -95,24 +79,16 @@ should resolve when the job is complete, or be rejected in case of an error.
95
79
 
96
80
 
97
81
  </div>
98
-
99
-
100
- ## JobData
101
-
102
82
  <GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="37" packageName="@vendure/core" />
103
83
 
104
- A JSON-serializable data type which provides a <a href='/reference/typescript-api/job-queue/job#job'>Job</a>with the data it needs to be processed.
84
+ A JSON-serializable data type which provides a <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink>with the data it needs to be processed.
105
85
 
106
86
  ```ts title="Signature"
107
87
  type JobData<T> = JsonCompatible<T>
108
88
  ```
109
-
110
-
111
- ## JobConfig
112
-
113
89
  <GenerationInfo sourceFile="packages/core/src/job-queue/types.ts" sourceLine="46" packageName="@vendure/core" />
114
90
 
115
- Used to instantiate a new <a href='/reference/typescript-api/job-queue/job#job'>Job</a>
91
+ Used to instantiate a new <DocsLink href="/reference/typescript-api/job-queue/job#job">Job</DocsLink>
116
92
 
117
93
  ```ts title="Signature"
118
94
  interface JobConfig<T extends JobData<T>> {
@@ -2,10 +2,6 @@
2
2
  title: "DefaultLogger"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DefaultLogger
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/logger/default-logger.ts" sourceLine="25" packageName="@vendure/core" />
10
6
 
11
7
  The default logger, which logs to the console (stdout) with optional timestamps. Since this logger is part of the
@@ -2,10 +2,6 @@
2
2
  title: "Logger"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Logger
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/logger/vendure-logger.ts" sourceLine="136" packageName="@vendure/core" />
10
6
 
11
7
  The Logger is responsible for all logging in a Vendure application.
@@ -20,14 +16,14 @@ import { Logger } from '@vendure/core';
20
16
  Logger.info(`Some log message`, 'My Vendure Plugin');
21
17
  ```
22
18
 
23
- The actual implementation - where the logs are written to - is defined by the <a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a>
24
- instance configured in the <a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>. By default, the <a href='/reference/typescript-api/logger/default-logger#defaultlogger'>DefaultLogger</a> is used, which
19
+ The actual implementation - where the logs are written to - is defined by the <DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">VendureLogger</DocsLink>
20
+ instance configured in the <DocsLink href="/reference/typescript-api/configuration/vendure-config#vendureconfig">VendureConfig</DocsLink>. By default, the <DocsLink href="/reference/typescript-api/logger/default-logger#defaultlogger">DefaultLogger</DocsLink> is used, which
25
21
  logs to the console.
26
22
 
27
23
  ## Implementing a custom logger
28
24
 
29
25
  A custom logger can be passed to the `logger` config option by creating a class which implements the
30
- <a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a> interface. For example, here is how you might go about implementing a logger which
26
+ <DocsLink href="/reference/typescript-api/logger/vendure-logger#vendurelogger">VendureLogger</DocsLink> interface. For example, here is how you might go about implementing a logger which
31
27
  logs to a file:
32
28
 
33
29
  *Example*
@@ -2,10 +2,6 @@
2
2
  title: "LogLevel"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LogLevel
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/logger/vendure-logger.ts" sourceLine="9" packageName="@vendure/core" />
10
6
 
11
7
  An enum of valid logging levels.
@@ -2,10 +2,6 @@
2
2
  title: "VendureLogger"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## VendureLogger
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/logger/vendure-logger.ts" sourceLine="47" packageName="@vendure/core" />
10
6
 
11
7
  The VendureLogger interface defines the shape of a logger service which may be provided in
@@ -2,10 +2,6 @@
2
2
  title: "GenerateMigration"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## generateMigration
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="118" packageName="@vendure/core" />
10
6
 
11
7
  Generates a new migration file based on any schema changes (e.g. adding or removing CustomFields).
@@ -2,13 +2,9 @@
2
2
  title: "MigrationOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## MigrationOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="19" packageName="@vendure/core" />
10
6
 
11
- Configuration for generating a new migration script via <a href='/reference/typescript-api/migration/generate-migration#generatemigration'>generateMigration</a>.
7
+ Configuration for generating a new migration script via <DocsLink href="/reference/typescript-api/migration/generate-migration#generatemigration">generateMigration</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  interface MigrationOptions {
@@ -2,10 +2,6 @@
2
2
  title: "RevertLastMigration"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## revertLastMigration
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="89" packageName="@vendure/core" />
10
6
 
11
7
  Reverts the last applied database migration. See [TypeORM migration docs](https://typeorm.io/#/migrations)
@@ -2,10 +2,6 @@
2
2
  title: "RunMigrations"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## runMigrations
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/migrate.ts" sourceLine="40" packageName="@vendure/core" />
10
6
 
11
7
  Runs any pending database migrations. See [TypeORM migration docs](https://typeorm.io/#/migrations)
@@ -2,17 +2,13 @@
2
2
  title: "BigIntMoneyStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## BigIntMoneyStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/entity/bigint-money-strategy.ts" sourceLine="18" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
- A <a href='/reference/typescript-api/money/money-strategy#moneystrategy'>MoneyStrategy</a> that stores monetary values as a `bigint` type in the database, which
7
+ A <DocsLink href="/reference/typescript-api/money/money-strategy#moneystrategy">MoneyStrategy</DocsLink> that stores monetary values as a `bigint` type in the database, which
12
8
  allows values up to ~9 quadrillion to be stored (limited by JavaScript's `MAX_SAFE_INTEGER` limit).
13
9
 
14
10
  This strategy also slightly differs in the way rounding is performed, with rounding being done _after_
15
- multiplying the unit price, rather than before (as is the case with the <a href='/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy'>DefaultMoneyStrategy</a>.
11
+ multiplying the unit price, rather than before (as is the case with the <DocsLink href="/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy">DefaultMoneyStrategy</DocsLink>.
16
12
 
17
13
  ```ts title="Signature"
18
14
  class BigIntMoneyStrategy implements MoneyStrategy {
@@ -2,13 +2,9 @@
2
2
  title: "DefaultMoneyStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DefaultMoneyStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/entity/default-money-strategy.ts" sourceLine="14" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
- A <a href='/reference/typescript-api/money/money-strategy#moneystrategy'>MoneyStrategy</a> that stores monetary values as a `int` type in the database.
7
+ A <DocsLink href="/reference/typescript-api/money/money-strategy#moneystrategy">MoneyStrategy</DocsLink> that stores monetary values as a `int` type in the database.
12
8
  The storage configuration and rounding logic replicates the behaviour of Vendure pre-2.0.
13
9
 
14
10
  ```ts title="Signature"
@@ -2,14 +2,10 @@
2
2
  title: "Money Decorator"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Money
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/entity/money.decorator.ts" sourceLine="26" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
7
  Use this decorator for any entity field that is storing a monetary value.
12
- This allows the column type to be defined by the configured <a href='/reference/typescript-api/money/money-strategy#moneystrategy'>MoneyStrategy</a>.
8
+ This allows the column type to be defined by the configured <DocsLink href="/reference/typescript-api/money/money-strategy#moneystrategy">MoneyStrategy</DocsLink>.
13
9
 
14
10
  ```ts title="Signature"
15
11
  function Money(options?: MoneyColumnOptions): void
@@ -2,14 +2,10 @@
2
2
  title: "MoneyStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## MoneyStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/entity/money-strategy.ts" sourceLine="63" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
7
  The MoneyStrategy defines how monetary values are stored and manipulated. The MoneyStrategy
12
- is defined in <a href='/reference/typescript-api/configuration/entity-options#entityoptions'>EntityOptions</a>:
8
+ is defined in <DocsLink href="/reference/typescript-api/configuration/entity-options#entityoptions">EntityOptions</DocsLink>:
13
9
 
14
10
  *Example*
15
11
 
@@ -23,11 +19,11 @@ const config: VendureConfig = {
23
19
 
24
20
  ## Range
25
21
 
26
- The <a href='/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy'>DefaultMoneyStrategy</a> uses an `int` field in the database, which puts an
22
+ The <DocsLink href="/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy">DefaultMoneyStrategy</DocsLink> uses an `int` field in the database, which puts an
27
23
  effective limit of ~21.4 million on any stored value. For certain use cases
28
24
  (e.g. business sales with very high amounts, or currencies with very large
29
25
  denominations), this may cause issues. In this case, you can use the
30
- <a href='/reference/typescript-api/money/big-int-money-strategy#bigintmoneystrategy'>BigIntMoneyStrategy</a> which will use the `bigint` type to store monetary values,
26
+ <DocsLink href="/reference/typescript-api/money/big-int-money-strategy#bigintmoneystrategy">BigIntMoneyStrategy</DocsLink> which will use the `bigint` type to store monetary values,
31
27
  giving an effective upper limit of over 9 quadrillion.
32
28
 
33
29
  ## Precision
@@ -98,7 +94,7 @@ UI as to how many decimal places to display.
98
94
  <MemberInfo kind="method" type={`(value: number, quantity?: number) => number`} />
99
95
 
100
96
  Defines the logic used to round monetary values. For instance, the default behavior
101
- in the <a href='/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy'>DefaultMoneyStrategy</a> is to round the value, then multiply.
97
+ in the <DocsLink href="/reference/typescript-api/money/default-money-strategy#defaultmoneystrategy">DefaultMoneyStrategy</DocsLink> is to round the value, then multiply.
102
98
 
103
99
  ```ts
104
100
  return Math.round(value * quantity);
@@ -2,13 +2,9 @@
2
2
  title: "RoundMoney"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## roundMoney
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/common/round-money.ts" sourceLine="13" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
- Rounds a monetary value according to the configured <a href='/reference/typescript-api/money/money-strategy#moneystrategy'>MoneyStrategy</a>.
7
+ Rounds a monetary value according to the configured <DocsLink href="/reference/typescript-api/money/money-strategy#moneystrategy">MoneyStrategy</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  function roundMoney(value: number, quantity: = 1): number