@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (587) hide show
  1. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +3 -7
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +3 -7
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +4 -8
  4. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -5
  5. package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx +0 -4
  6. package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx +0 -4
  7. package/docs/reference/admin-ui-api/action-bar/page-location-id.mdx +0 -4
  8. package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -5
  9. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -9
  10. package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -5
  11. package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -5
  12. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +7 -23
  13. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -5
  14. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -8
  15. package/docs/reference/admin-ui-api/components/chip-component.mdx +0 -4
  16. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -8
  17. package/docs/reference/admin-ui-api/components/data-table-component.mdx +7 -11
  18. package/docs/reference/admin-ui-api/components/data-table2component.mdx +8 -12
  19. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -11
  20. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -5
  21. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -10
  22. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -5
  23. package/docs/reference/admin-ui-api/components/order-state-label-component.mdx +0 -4
  24. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -5
  25. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -6
  26. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -7
  27. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +2 -6
  28. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -5
  29. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -5
  30. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -5
  31. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -5
  32. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +5 -9
  33. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +2 -6
  34. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -5
  35. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -5
  36. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +24 -92
  37. package/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx +0 -4
  38. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +3 -7
  39. package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx +0 -4
  40. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +3 -7
  41. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -5
  42. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -5
  43. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -5
  44. package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx +0 -4
  45. package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx +0 -4
  46. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -6
  47. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -6
  48. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +7 -11
  49. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +2 -6
  50. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +9 -13
  51. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +2 -6
  52. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +4 -8
  53. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +8 -12
  54. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx +0 -4
  55. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx +0 -4
  56. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -7
  57. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +2 -6
  58. package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx +0 -4
  59. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +0 -4
  60. package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +0 -4
  61. package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +0 -4
  62. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +0 -4
  63. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +0 -4
  64. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +0 -4
  65. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +0 -4
  66. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +0 -4
  67. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +0 -4
  68. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +0 -4
  69. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -5
  70. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -5
  71. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -5
  72. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -5
  73. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -5
  74. package/docs/reference/admin-ui-api/react-components/page-block.mdx +0 -4
  75. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -5
  76. package/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx +0 -4
  77. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -5
  78. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +2 -6
  79. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -5
  80. package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx +0 -4
  81. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -5
  82. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx +0 -4
  83. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -5
  84. package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx +0 -4
  85. package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx +0 -4
  86. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -5
  87. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -5
  88. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -5
  89. package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx +0 -4
  90. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -5
  91. package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx +0 -4
  92. package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx +0 -4
  93. package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx +0 -4
  94. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -5
  95. package/docs/reference/admin-ui-api/services/data-service.mdx +11 -19
  96. package/docs/reference/admin-ui-api/services/modal-service.mdx +6 -22
  97. package/docs/reference/admin-ui-api/services/notification-service.mdx +0 -12
  98. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -5
  99. package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx +0 -4
  100. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +3 -39
  101. package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx +0 -4
  102. package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx +0 -4
  103. package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx +0 -20
  104. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +0 -4
  105. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +1 -5
  106. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +0 -4
  107. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +2 -6
  108. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -5
  109. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +7 -11
  110. package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx +0 -4
  111. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -5
  112. package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx +0 -4
  113. package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx +0 -4
  114. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -13
  115. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +4 -8
  116. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -12
  117. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -11
  118. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +6 -18
  119. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -11
  120. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -5
  121. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -5
  122. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +9 -21
  123. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +2 -6
  124. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +3 -7
  125. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +23 -27
  126. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +2 -6
  127. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -10
  128. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +4 -16
  129. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +10 -62
  130. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +0 -4
  131. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +2 -10
  132. package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -8
  133. package/docs/reference/core-plugins/email-plugin/index.mdx +5 -9
  134. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -12
  135. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +3 -31
  136. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -6
  137. package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx +0 -4
  138. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +2 -6
  139. package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -6
  140. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx +0 -4
  141. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +10 -14
  142. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +6 -14
  143. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +4 -8
  144. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -5
  145. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -10
  146. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -9
  147. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +6 -14
  148. package/docs/reference/core-plugins/sentry-plugin/index.mdx +0 -4
  149. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -5
  150. package/docs/reference/core-plugins/sentry-plugin/sentry-service.mdx +0 -4
  151. package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -7
  152. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +7 -15
  153. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -5
  154. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -5
  155. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -9
  156. package/docs/reference/core-plugins/telemetry-plugin/index.mdx +0 -4
  157. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +0 -8
  158. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +3 -7
  159. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +2 -6
  160. package/docs/reference/dashboard/components/asset-gallery.mdx +4 -12
  161. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +3 -11
  162. package/docs/reference/dashboard/components/channel-chip.mdx +1 -5
  163. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -5
  164. package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -4
  165. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -9
  166. package/docs/reference/dashboard/components/permission-guard.mdx +1 -9
  167. package/docs/reference/dashboard/components/vendure-image.mdx +7 -31
  168. package/docs/reference/dashboard/detail-views/detail-page.mdx +5 -13
  169. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -23
  170. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +4 -12
  171. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -5
  172. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -10
  173. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -5
  174. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -8
  175. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -9
  176. package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -21
  177. package/docs/reference/dashboard/extensions-api/history-entries.mdx +5 -21
  178. package/docs/reference/dashboard/extensions-api/login.mdx +0 -16
  179. package/docs/reference/dashboard/extensions-api/navigation.mdx +0 -8
  180. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -14
  181. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -8
  182. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -5
  183. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -5
  184. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -5
  185. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -5
  186. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -5
  187. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +2 -10
  188. package/docs/reference/dashboard/form-components/money-input.mdx +1 -5
  189. package/docs/reference/dashboard/form-components/number-input.mdx +1 -5
  190. package/docs/reference/dashboard/form-components/password-input.mdx +1 -5
  191. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -5
  192. package/docs/reference/dashboard/form-components/slug-input.mdx +0 -4
  193. package/docs/reference/dashboard/form-components/text-input.mdx +0 -4
  194. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -5
  195. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -9
  196. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -9
  197. package/docs/reference/dashboard/hooks/use-auth.mdx +6 -14
  198. package/docs/reference/dashboard/hooks/use-channel.mdx +3 -11
  199. package/docs/reference/dashboard/hooks/use-custom-field-config.mdx +0 -4
  200. package/docs/reference/dashboard/hooks/use-display-locale.mdx +0 -4
  201. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -5
  202. package/docs/reference/dashboard/hooks/use-local-format.mdx +0 -4
  203. package/docs/reference/dashboard/hooks/use-paginated-list.mdx +0 -4
  204. package/docs/reference/dashboard/hooks/use-permissions.mdx +0 -4
  205. package/docs/reference/dashboard/hooks/use-sorted-languages.mdx +0 -4
  206. package/docs/reference/dashboard/hooks/use-ui-language-loader.mdx +0 -4
  207. package/docs/reference/dashboard/hooks/use-widget-filters.mdx +0 -4
  208. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -15
  209. package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -4
  210. package/docs/reference/dashboard/list-views/data-table.mdx +11 -23
  211. package/docs/reference/dashboard/list-views/list-page.mdx +15 -23
  212. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +19 -27
  213. package/docs/reference/dashboard/page-layout/index.mdx +3 -11
  214. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +5 -17
  215. package/docs/reference/dashboard/page-layout/page-block.mdx +7 -23
  216. package/docs/reference/dashboard/page-layout/page-title.mdx +2 -6
  217. package/docs/reference/dashboard/page-layout/page.mdx +7 -15
  218. package/docs/reference/dashboard/page-layout/use-page-block.mdx +0 -4
  219. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -28
  220. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +0 -4
  221. package/docs/reference/typescript-api/assets/asset-options.mdx +0 -4
  222. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -5
  223. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -10
  224. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -4
  225. package/docs/reference/typescript-api/auth/auth-options.mdx +5 -9
  226. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +3 -7
  227. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -6
  228. package/docs/reference/typescript-api/auth/cookie-options.mdx +0 -4
  229. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +0 -4
  230. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +7 -11
  231. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +0 -4
  232. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +6 -10
  233. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +0 -4
  234. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -7
  235. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +0 -4
  236. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +3 -7
  237. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -6
  238. package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -28
  239. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +8 -20
  240. package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -4
  241. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -6
  242. package/docs/reference/typescript-api/cache/cache-config.mdx +2 -6
  243. package/docs/reference/typescript-api/cache/cache-service.mdx +6 -10
  244. package/docs/reference/typescript-api/cache/cache-strategy.mdx +5 -13
  245. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -11
  246. package/docs/reference/typescript-api/cache/index.mdx +5 -9
  247. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -11
  248. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +5 -9
  249. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -6
  250. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +8 -20
  251. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -7
  252. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -5
  253. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -5
  254. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -5
  255. package/docs/reference/typescript-api/common/async-queue.mdx +1 -5
  256. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -10
  257. package/docs/reference/typescript-api/common/currency-code.mdx +0 -4
  258. package/docs/reference/typescript-api/common/entity-relation-paths.mdx +0 -4
  259. package/docs/reference/typescript-api/common/i18n-service.mdx +0 -8
  260. package/docs/reference/typescript-api/common/id.mdx +1 -5
  261. package/docs/reference/typescript-api/common/injectable-strategy.mdx +3 -7
  262. package/docs/reference/typescript-api/common/injector.mdx +2 -6
  263. package/docs/reference/typescript-api/common/job-state.mdx +0 -4
  264. package/docs/reference/typescript-api/common/json-compatible.mdx +0 -4
  265. package/docs/reference/typescript-api/common/language-code.mdx +0 -4
  266. package/docs/reference/typescript-api/common/middleware.mdx +1 -5
  267. package/docs/reference/typescript-api/common/paginated-list.mdx +0 -4
  268. package/docs/reference/typescript-api/common/permission.mdx +1 -5
  269. package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -6
  270. package/docs/reference/typescript-api/common/process-context.mdx +0 -4
  271. package/docs/reference/typescript-api/common/vendure_version.mdx +0 -4
  272. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -5
  273. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +4 -8
  274. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +2 -6
  275. package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx +0 -4
  276. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -15
  277. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +12 -16
  278. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -5
  279. package/docs/reference/typescript-api/configuration/api-options.mdx +3 -7
  280. package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -7
  281. package/docs/reference/typescript-api/configuration/default-config.mdx +0 -4
  282. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +0 -4
  283. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -18
  284. package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -4
  285. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +6 -18
  286. package/docs/reference/typescript-api/configuration/entity-options.mdx +4 -12
  287. package/docs/reference/typescript-api/configuration/merge-config.mdx +0 -4
  288. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -9
  289. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +5 -17
  290. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +16 -20
  291. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -5
  292. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -5
  293. package/docs/reference/typescript-api/configuration/system-options.mdx +3 -7
  294. package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx +0 -4
  295. package/docs/reference/typescript-api/configuration/vendure-config.mdx +4 -8
  296. package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +0 -4
  297. package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx +0 -4
  298. package/docs/reference/typescript-api/custom-fields/index.mdx +1 -5
  299. package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +0 -4
  300. package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +0 -4
  301. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -5
  302. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -5
  303. package/docs/reference/typescript-api/data-access/calculated.mdx +3 -11
  304. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +2 -6
  305. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +3 -7
  306. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +2 -6
  307. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +5 -13
  308. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +16 -20
  309. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -6
  310. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -5
  311. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -8
  312. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -8
  313. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +5 -9
  314. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -8
  315. package/docs/reference/typescript-api/entities/address.mdx +2 -6
  316. package/docs/reference/typescript-api/entities/administrator.mdx +2 -6
  317. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -5
  318. package/docs/reference/typescript-api/entities/asset.mdx +1 -5
  319. package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -7
  320. package/docs/reference/typescript-api/entities/authentication-method.mdx +4 -16
  321. package/docs/reference/typescript-api/entities/channel.mdx +1 -5
  322. package/docs/reference/typescript-api/entities/collection.mdx +3 -7
  323. package/docs/reference/typescript-api/entities/country.mdx +4 -8
  324. package/docs/reference/typescript-api/entities/customer-group.mdx +2 -6
  325. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -6
  326. package/docs/reference/typescript-api/entities/customer.mdx +2 -6
  327. package/docs/reference/typescript-api/entities/facet-value.mdx +3 -7
  328. package/docs/reference/typescript-api/entities/facet.mdx +4 -8
  329. package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -6
  330. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -5
  331. package/docs/reference/typescript-api/entities/history-entry.mdx +2 -6
  332. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -21
  333. package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -6
  334. package/docs/reference/typescript-api/entities/order-line-reference.mdx +7 -23
  335. package/docs/reference/typescript-api/entities/order-line.mdx +8 -12
  336. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -5
  337. package/docs/reference/typescript-api/entities/order.mdx +8 -12
  338. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -5
  339. package/docs/reference/typescript-api/entities/payment-method.mdx +4 -8
  340. package/docs/reference/typescript-api/entities/payment.mdx +2 -6
  341. package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -7
  342. package/docs/reference/typescript-api/entities/product-option.mdx +3 -7
  343. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -5
  344. package/docs/reference/typescript-api/entities/product-variant.mdx +3 -7
  345. package/docs/reference/typescript-api/entities/product.mdx +3 -7
  346. package/docs/reference/typescript-api/entities/promotion.mdx +6 -10
  347. package/docs/reference/typescript-api/entities/province.mdx +2 -6
  348. package/docs/reference/typescript-api/entities/refund.mdx +1 -5
  349. package/docs/reference/typescript-api/entities/region.mdx +3 -7
  350. package/docs/reference/typescript-api/entities/role.mdx +2 -6
  351. package/docs/reference/typescript-api/entities/seller.mdx +2 -6
  352. package/docs/reference/typescript-api/entities/session.mdx +2 -6
  353. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -5
  354. package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -6
  355. package/docs/reference/typescript-api/entities/shipping-method.mdx +6 -10
  356. package/docs/reference/typescript-api/entities/stock-level.mdx +3 -7
  357. package/docs/reference/typescript-api/entities/stock-location.mdx +3 -7
  358. package/docs/reference/typescript-api/entities/stock-movement.mdx +6 -30
  359. package/docs/reference/typescript-api/entities/surcharge.mdx +2 -6
  360. package/docs/reference/typescript-api/entities/tag.mdx +1 -5
  361. package/docs/reference/typescript-api/entities/tax-category.mdx +2 -6
  362. package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -9
  363. package/docs/reference/typescript-api/entities/user.mdx +2 -6
  364. package/docs/reference/typescript-api/entities/vendure-entity.mdx +2 -6
  365. package/docs/reference/typescript-api/entities/zone.mdx +2 -6
  366. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -6
  367. package/docs/reference/typescript-api/errors/error-result-union.mdx +0 -4
  368. package/docs/reference/typescript-api/errors/error-types.mdx +1 -29
  369. package/docs/reference/typescript-api/errors/i18n-error.mdx +0 -4
  370. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -5
  371. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -6
  372. package/docs/reference/typescript-api/events/event-bus.mdx +10 -14
  373. package/docs/reference/typescript-api/events/event-types.mdx +80 -316
  374. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +0 -4
  375. package/docs/reference/typescript-api/events/vendure-event.mdx +0 -4
  376. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +8 -24
  377. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +8 -16
  378. package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -5
  379. package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -5
  380. package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx +0 -4
  381. package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -7
  382. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -5
  383. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -5
  384. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -5
  385. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -7
  386. package/docs/reference/typescript-api/import-export/asset-importer.mdx +3 -7
  387. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +0 -4
  388. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -8
  389. package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -5
  390. package/docs/reference/typescript-api/import-export/import-parser.mdx +13 -41
  391. package/docs/reference/typescript-api/import-export/importer.mdx +5 -9
  392. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -7
  393. package/docs/reference/typescript-api/import-export/populate.mdx +4 -8
  394. package/docs/reference/typescript-api/import-export/populator.mdx +2 -6
  395. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +10 -22
  396. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +6 -10
  397. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +10 -14
  398. package/docs/reference/typescript-api/job-queue/index.mdx +6 -10
  399. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -9
  400. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +4 -8
  401. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +4 -8
  402. package/docs/reference/typescript-api/job-queue/job-queue-options.mdx +0 -4
  403. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +10 -14
  404. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +4 -8
  405. package/docs/reference/typescript-api/job-queue/job.mdx +5 -17
  406. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +11 -15
  407. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +8 -12
  408. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +7 -11
  409. package/docs/reference/typescript-api/job-queue/types.mdx +6 -30
  410. package/docs/reference/typescript-api/logger/default-logger.mdx +0 -4
  411. package/docs/reference/typescript-api/logger/index.mdx +3 -7
  412. package/docs/reference/typescript-api/logger/log-level.mdx +0 -4
  413. package/docs/reference/typescript-api/logger/vendure-logger.mdx +0 -4
  414. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -5
  415. package/docs/reference/typescript-api/migration/migration-options.mdx +1 -5
  416. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -5
  417. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -5
  418. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +2 -6
  419. package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -5
  420. package/docs/reference/typescript-api/money/money-decorator.mdx +1 -5
  421. package/docs/reference/typescript-api/money/money-strategy.mdx +4 -8
  422. package/docs/reference/typescript-api/money/round-money.mdx +1 -5
  423. package/docs/reference/typescript-api/orders/active-order-service.mdx +7 -11
  424. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +4 -8
  425. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -6
  426. package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -5
  427. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -5
  428. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -11
  429. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -6
  430. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -5
  431. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -5
  432. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -5
  433. package/docs/reference/typescript-api/orders/merge-strategies.mdx +0 -16
  434. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -9
  435. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -9
  436. package/docs/reference/typescript-api/orders/order-interceptor.mdx +7 -11
  437. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -7
  438. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -9
  439. package/docs/reference/typescript-api/orders/order-options.mdx +4 -8
  440. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -5
  441. package/docs/reference/typescript-api/orders/order-process.mdx +16 -44
  442. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +6 -18
  443. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -5
  444. package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -5
  445. package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -5
  446. package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx +0 -4
  447. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +9 -13
  448. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +7 -19
  449. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +3 -7
  450. package/docs/reference/typescript-api/payment/payment-method-types.mdx +19 -63
  451. package/docs/reference/typescript-api/payment/payment-options.mdx +10 -14
  452. package/docs/reference/typescript-api/payment/payment-process.mdx +5 -9
  453. package/docs/reference/typescript-api/payment/payment-state.mdx +0 -4
  454. package/docs/reference/typescript-api/payment/payment-states.mdx +1 -5
  455. package/docs/reference/typescript-api/payment/payment-transition-data.mdx +0 -4
  456. package/docs/reference/typescript-api/payment/refund-process.mdx +5 -9
  457. package/docs/reference/typescript-api/payment/refund-state.mdx +0 -4
  458. package/docs/reference/typescript-api/payment/refund-states.mdx +1 -5
  459. package/docs/reference/typescript-api/payment/refund-transition-data.mdx +0 -4
  460. package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -7
  461. package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -9
  462. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +7 -19
  463. package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -4
  464. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +2 -6
  465. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -5
  466. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +0 -4
  467. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +3 -7
  468. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +4 -8
  469. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -10
  470. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -5
  471. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +9 -21
  472. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +4 -8
  473. package/docs/reference/typescript-api/promotions/promotion-action.mdx +32 -92
  474. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +9 -21
  475. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -6
  476. package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -5
  477. package/docs/reference/typescript-api/request/api-decorator.mdx +1 -5
  478. package/docs/reference/typescript-api/request/api-type.mdx +0 -4
  479. package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -5
  480. package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -5
  481. package/docs/reference/typescript-api/request/request-context-service.mdx +3 -7
  482. package/docs/reference/typescript-api/request/request-context.mdx +5 -9
  483. package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -14
  484. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -5
  485. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -9
  486. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +6 -10
  487. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -16
  488. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -6
  489. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -7
  490. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +8 -16
  491. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +4 -8
  492. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -5
  493. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +4 -8
  494. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +2 -6
  495. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +3 -15
  496. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +3 -7
  497. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -5
  498. package/docs/reference/typescript-api/services/administrator-service.mdx +7 -11
  499. package/docs/reference/typescript-api/services/asset-service.mdx +15 -27
  500. package/docs/reference/typescript-api/services/auth-service.mdx +7 -11
  501. package/docs/reference/typescript-api/services/channel-service.mdx +15 -19
  502. package/docs/reference/typescript-api/services/collection-service.mdx +23 -27
  503. package/docs/reference/typescript-api/services/country-service.mdx +8 -12
  504. package/docs/reference/typescript-api/services/customer-group-service.mdx +10 -14
  505. package/docs/reference/typescript-api/services/customer-service.mdx +37 -41
  506. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -5
  507. package/docs/reference/typescript-api/services/facet-service.mdx +12 -16
  508. package/docs/reference/typescript-api/services/facet-value-service.mdx +13 -17
  509. package/docs/reference/typescript-api/services/fulfillment-service.mdx +7 -11
  510. package/docs/reference/typescript-api/services/global-settings-service.mdx +3 -7
  511. package/docs/reference/typescript-api/services/history-service.mdx +9 -13
  512. package/docs/reference/typescript-api/services/initializer-service.mdx +0 -4
  513. package/docs/reference/typescript-api/services/order-service.mdx +76 -80
  514. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -6
  515. package/docs/reference/typescript-api/services/payment-method-service.mdx +11 -15
  516. package/docs/reference/typescript-api/services/payment-service.mdx +13 -17
  517. package/docs/reference/typescript-api/services/product-option-group-service.mdx +6 -10
  518. package/docs/reference/typescript-api/services/product-option-service.mdx +6 -10
  519. package/docs/reference/typescript-api/services/product-service.mdx +15 -19
  520. package/docs/reference/typescript-api/services/product-variant-service.mdx +29 -33
  521. package/docs/reference/typescript-api/services/promotion-service.mdx +10 -14
  522. package/docs/reference/typescript-api/services/province-service.mdx +6 -10
  523. package/docs/reference/typescript-api/services/role-service.mdx +12 -16
  524. package/docs/reference/typescript-api/services/search-service.mdx +2 -6
  525. package/docs/reference/typescript-api/services/seller-service.mdx +4 -8
  526. package/docs/reference/typescript-api/services/session-service.mdx +12 -16
  527. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -19
  528. package/docs/reference/typescript-api/services/shipping-method-service.mdx +9 -13
  529. package/docs/reference/typescript-api/services/slug-service.mdx +1 -5
  530. package/docs/reference/typescript-api/services/stock-level-service.mdx +8 -12
  531. package/docs/reference/typescript-api/services/stock-location-service.mdx +12 -16
  532. package/docs/reference/typescript-api/services/stock-movement-service.mdx +15 -19
  533. package/docs/reference/typescript-api/services/tag-service.mdx +6 -10
  534. package/docs/reference/typescript-api/services/tax-category-service.mdx +6 -10
  535. package/docs/reference/typescript-api/services/tax-rate-service.mdx +7 -11
  536. package/docs/reference/typescript-api/services/user-service.mdx +20 -24
  537. package/docs/reference/typescript-api/services/zone-service.mdx +9 -13
  538. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.mdx +0 -4
  539. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.mdx +0 -4
  540. package/docs/reference/typescript-api/settings-store/index.mdx +1 -5
  541. package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.mdx +0 -4
  542. package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.mdx +0 -4
  543. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -6
  544. package/docs/reference/typescript-api/settings-store/settings-store-registration.mdx +0 -4
  545. package/docs/reference/typescript-api/settings-store/settings-store-scope-function.mdx +0 -4
  546. package/docs/reference/typescript-api/settings-store/settings-store-scopes.mdx +0 -4
  547. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -6
  548. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -6
  549. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +7 -19
  550. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +4 -8
  551. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +3 -7
  552. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -7
  553. package/docs/reference/typescript-api/shipping/shipping-options.mdx +8 -12
  554. package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -4
  555. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -6
  556. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +5 -21
  557. package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -6
  558. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +2 -6
  559. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +2 -6
  560. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -5
  561. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -11
  562. package/docs/reference/typescript-api/tax/tax-options.mdx +0 -4
  563. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -6
  564. package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -5
  565. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -5
  566. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +3 -7
  567. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +2 -6
  568. package/docs/reference/typescript-api/testing/create-test-environment.mdx +3 -7
  569. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -5
  570. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -5
  571. package/docs/reference/typescript-api/testing/register-initializer.mdx +3 -7
  572. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -9
  573. package/docs/reference/typescript-api/testing/test-config.mdx +1 -5
  574. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +4 -8
  575. package/docs/reference/typescript-api/testing/test-environment.mdx +1 -5
  576. package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -5
  577. package/docs/reference/typescript-api/testing/test-server.mdx +2 -6
  578. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -5
  579. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +4 -12
  580. package/docs/reference/typescript-api/worker/vendure-worker.mdx +3 -7
  581. package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -4
  582. package/package.json +2 -2
  583. package/docs/reference/admin-ui-api/index.mdx +0 -4
  584. package/docs/reference/dashboard/index.mdx +0 -4
  585. package/docs/reference/graphql-api/admin/_index.mdx +0 -4
  586. package/docs/reference/graphql-api/shop/_index.mdx +0 -4
  587. package/docs/reference/typescript-api/_index.mdx +0 -4
@@ -2,10 +2,6 @@
2
2
  title: "VendureEntityEvent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## VendureEntityEvent
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/event-bus/vendure-entity-event.ts" sourceLine="12" packageName="@vendure/core" />
10
6
 
11
7
  The base class for all entity events used by the EventBus system.
@@ -2,10 +2,6 @@
2
2
  title: "VendureEvent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## VendureEvent
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/event-bus/vendure-event.ts" sourceLine="7" packageName="@vendure/core" />
10
6
 
11
7
  The base class for all events used by the EventBus system.
@@ -2,13 +2,9 @@
2
2
  title: "FulfillmentHandler"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FulfillmentHandler
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="149" packageName="@vendure/core" />
10
6
 
11
- A FulfillmentHandler is used when creating a new <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>. When the `addFulfillmentToOrder` mutation
7
+ A FulfillmentHandler is used when creating a new <DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">Fulfillment</DocsLink>. When the `addFulfillmentToOrder` mutation
12
8
  is executed, the specified handler will be used and it's `createFulfillment` method is called. This method
13
9
  may perform async tasks such as calling a 3rd-party shipping API to register a new shipment and receive
14
10
  a tracking code. This data can then be returned and will be incorporated into the created Fulfillment.
@@ -87,7 +83,7 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
87
83
  constructor(config: FulfillmentHandlerConfig<T>)
88
84
  }
89
85
  ```
90
- * Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a>&#60;T&#62;</code>
86
+ * Extends: <code><a href='/reference/typescript-api/configurable-operation-def/#configurableoperationdef'>ConfigurableOperationDef</a><T></code>
91
87
 
92
88
 
93
89
 
@@ -95,19 +91,15 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
95
91
 
96
92
  ### constructor
97
93
 
98
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandlerconfig'>FulfillmentHandlerConfig</a>&#60;T&#62;) => FulfillmentHandler`} />
94
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandlerconfig'>FulfillmentHandlerConfig</a><T>) => FulfillmentHandler`} />
99
95
 
100
96
 
101
97
 
102
98
 
103
99
  </div>
104
-
105
-
106
- ## FulfillmentHandlerConfig
107
-
108
100
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="48" packageName="@vendure/core" />
109
101
 
110
- The configuration object used to instantiate a <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a>.
102
+ The configuration object used to instantiate a <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler">FulfillmentHandler</DocsLink>.
111
103
 
112
104
  ```ts title="Signature"
113
105
  interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOperationDefOptions<T> {
@@ -115,7 +107,7 @@ interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOpe
115
107
  onFulfillmentTransition?: OnTransitionStartFn<FulfillmentState, FulfillmentTransitionData>;
116
108
  }
117
109
  ```
118
- * Extends: <code><a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a>&#60;T&#62;</code>
110
+ * Extends: <code><a href='/reference/typescript-api/configurable-operation-def/configurable-operation-def-options#configurableoperationdefoptions'>ConfigurableOperationDefOptions</a><T></code>
119
111
 
120
112
 
121
113
 
@@ -123,7 +115,7 @@ interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOpe
123
115
 
124
116
  ### createFulfillment
125
117
 
126
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#createfulfillmentfn'>CreateFulfillmentFn</a>&#60;T&#62;`} />
118
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/fulfillment/fulfillment-handler#createfulfillmentfn'>CreateFulfillmentFn</a><T>`} />
127
119
 
128
120
  Invoked when the `addFulfillmentToOrder` mutation is executed with this handler selected.
129
121
 
@@ -131,10 +123,10 @@ If an Error is thrown from within this function, no Fulfillment is created and t
131
123
  result will be returned.
132
124
  ### onFulfillmentTransition
133
125
 
134
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>&#60;<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>&#62;`} />
126
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`} />
135
127
 
136
128
  This allows the handler to intercept state transitions of the created Fulfillment. This works much in the
137
- same way as the <a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a> `onTransitionStart` method (i.e. returning `false` or
129
+ same way as the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> `onTransitionStart` method (i.e. returning `false` or
138
130
  `string` will be interpreted as an error and prevent the state transition), except that it is only invoked
139
131
  on Fulfillments which were created with this particular FulfillmentHandler.
140
132
 
@@ -143,10 +135,6 @@ shipping API.
143
135
 
144
136
 
145
137
  </div>
146
-
147
-
148
- ## CreateFulfillmentFn
149
-
150
138
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="33" packageName="@vendure/core" />
151
139
 
152
140
  The function called when creating a new Fulfillment
@@ -159,10 +147,6 @@ type CreateFulfillmentFn<T extends ConfigArgs> = (
159
147
  args: ConfigArgValues<T>,
160
148
  ) => CreateFulfillmentResult | Promise<CreateFulfillmentResult>
161
149
  ```
162
-
163
-
164
- ## CreateFulfillmentResult
165
-
166
150
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="23" packageName="@vendure/core" />
167
151
 
168
152
 
@@ -2,24 +2,16 @@
2
2
  title: "FulfillmentProcess"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## defaultFulfillmentProcess
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/default-fulfillment-process.ts" sourceLine="45" packageName="@vendure/core" since="2.0.0" />
10
6
 
11
- The default <a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>. This process includes the following actions:
7
+ The default <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink>. This process includes the following actions:
12
8
 
13
9
  - Executes the configured `FulfillmentHandler.onFulfillmentTransition()` before any state
14
10
  transition.
15
- - On cancellation of a Fulfillment, creates the necessary <a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a> & <a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>
11
+ - On cancellation of a Fulfillment, creates the necessary <DocsLink href="/reference/typescript-api/entities/stock-movement#cancellation">Cancellation</DocsLink> & <DocsLink href="/reference/typescript-api/entities/stock-movement#allocation">Allocation</DocsLink>
16
12
  stock movement records.
17
13
  - When a Fulfillment transitions from the `Created` to `Pending` state, the necessary
18
- <a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a> stock movements are created.
19
-
20
-
21
-
22
- ## FulfillmentProcess
14
+ <DocsLink href="/reference/typescript-api/entities/stock-movement#sale">Sale</DocsLink> stock movements are created.
23
15
 
24
16
  <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-process.ts" sourceLine="26" packageName="@vendure/core" since="2.0.0" />
25
17
 
@@ -28,7 +20,7 @@ in, and how it may transition from one state to another. Using the `onTransition
28
20
  FulfillmentProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
29
21
  hook allows logic to be executed after a state change.
30
22
 
31
- For detailed description of the interface members, see the <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a> docs.
23
+ For detailed description of the interface members, see the <DocsLink href="/reference/typescript-api/state-machine/state-machine-config#statemachineconfig">StateMachineConfig</DocsLink> docs.
32
24
 
33
25
  ```ts title="Signature"
34
26
  interface FulfillmentProcess<State extends keyof CustomFulfillmentStates | string> extends InjectableStrategy {
@@ -47,22 +39,22 @@ interface FulfillmentProcess<State extends keyof CustomFulfillmentStates | strin
47
39
 
48
40
  ### transitions
49
41
 
50
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>&#60;State, State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>&#62; &#38; Partial&#60;<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>&#60;<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a> | State&#62;&#62;`} />
42
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a> | State>>`} />
51
43
 
52
44
 
53
45
  ### onTransitionStart
54
46
 
55
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>&#60;State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>&#62;`} />
47
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`} />
56
48
 
57
49
 
58
50
  ### onTransitionEnd
59
51
 
60
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>&#60;State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>&#62;`} />
52
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`} />
61
53
 
62
54
 
63
55
  ### onTransitionError
64
56
 
65
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>&#60;State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>&#62;`} />
57
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>>`} />
66
58
 
67
59
 
68
60
 
@@ -2,14 +2,10 @@
2
2
  title: "FulfillmentState"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FulfillmentState
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/fulfillment-state-machine/fulfillment-state.ts" sourceLine="29" packageName="@vendure/core" />
10
6
 
11
7
  These are the default states of the fulfillment process. By default, they will be extended
12
- by the <a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a> to also include `Shipped` and `Delivered`.
8
+ by the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess">defaultFulfillmentProcess</DocsLink> to also include `Shipped` and `Delivered`.
13
9
 
14
10
  ```ts title="Signature"
15
11
  type FulfillmentState = | 'Created'
@@ -2,13 +2,9 @@
2
2
  title: "FulfillmentStates"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FulfillmentStates
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/fulfillment-state-machine/fulfillment-state.ts" sourceLine="19" packageName="@vendure/core" />
10
6
 
11
- An interface to extend standard <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>.
7
+ An interface to extend standard <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate">FulfillmentState</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  interface FulfillmentStates {
@@ -2,10 +2,6 @@
2
2
  title: "FulfillmentTransitionData"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FulfillmentTransitionData
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/service/helpers/fulfillment-state-machine/fulfillment-state.ts" sourceLine="42" packageName="@vendure/core" />
10
6
 
11
7
  The data which is passed to the state transition handler of the FulfillmentStateMachine.
@@ -2,10 +2,6 @@
2
2
  title: "HealthCheckRegistryService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## HealthCheckRegistryService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/health-check/health-check-registry.service.ts" sourceLine="47" packageName="@vendure/core" />
10
6
 
11
7
  This service is used to register health indicator functions to be included in the
@@ -21,12 +17,12 @@ Plugins which rely on external services (web services, databases etc.) can make
21
17
  service to add a check for that dependency to the Vendure health check.
22
18
 
23
19
 
24
- Since v1.6.0, the preferred way to implement a custom health check is by creating a new <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a>
20
+ Since v1.6.0, the preferred way to implement a custom health check is by creating a new <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink>
25
21
  and then passing it to the `systemOptions.healthChecks` array.
26
- See the <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> docs for an example configuration.
22
+ See the <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> docs for an example configuration.
27
23
 
28
24
  The alternative way to register a health check is by injecting this service directly into your
29
- plugin module. To use it in your plugin, you'll need to import the <a href='/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule'>PluginCommonModule</a>:
25
+ plugin module. To use it in your plugin, you'll need to import the <DocsLink href="/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule">PluginCommonModule</DocsLink>:
30
26
 
31
27
  *Example*
32
28
 
@@ -2,10 +2,6 @@
2
2
  title: "HealthCheckStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## HealthCheckStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/system/health-check-strategy.ts" sourceLine="48" packageName="@vendure/core" />
10
6
 
11
7
  This strategy defines health checks which are included as part of the
@@ -19,7 +15,7 @@ Custom strategies should be added to the `systemOptions.healthChecks` array.
19
15
  By default, Vendure includes the `TypeORMHealthCheckStrategy`, so if you set the value of the `healthChecks`
20
16
  array, be sure to include it manually.
21
17
 
22
- Vendure also ships with the <a href='/reference/typescript-api/health-check/http-health-check-strategy#httphealthcheckstrategy'>HttpHealthCheckStrategy</a>, which is convenient
18
+ Vendure also ships with the <DocsLink href="/reference/typescript-api/health-check/http-health-check-strategy#httphealthcheckstrategy">HttpHealthCheckStrategy</DocsLink>, which is convenient
23
19
  for adding a health check dependent on an HTTP ping.
24
20
 
25
21
  :::info
@@ -2,13 +2,9 @@
2
2
  title: "HttpHealthCheckStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## HttpHealthCheckStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/health-check/http-health-check-strategy.ts" sourceLine="37" packageName="@vendure/core" />
10
6
 
11
- A <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> used to check health by pinging a url. Internally it uses
7
+ A <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> used to check health by pinging a url. Internally it uses
12
8
  the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
13
9
 
14
10
  *Example*
@@ -2,13 +2,9 @@
2
2
  title: "TypeORMHealthCheckStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TypeORMHealthCheckStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/health-check/typeorm-health-check-strategy.ts" sourceLine="38" packageName="@vendure/core" />
10
6
 
11
- A <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> used to check the health of the database. This health
7
+ A <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> used to check the health of the database. This health
12
8
  check is included by default, but can be customized by explicitly adding it to the
13
9
  `systemOptions.healthChecks` array:
14
10
 
@@ -2,16 +2,12 @@
2
2
  title: "AssetImportStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## AssetImportStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/asset-import-strategy/asset-import-strategy.ts" sourceLine="25" packageName="@vendure/core" since="1.7.0" />
10
6
 
11
7
  The AssetImportStrategy determines how asset files get imported based on the path given in the
12
- import CSV or via the <a href='/reference/typescript-api/import-export/asset-importer#assetimporter'>AssetImporter</a> `getAssets()` method.
8
+ import CSV or via the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> `getAssets()` method.
13
9
 
14
- The <a href='/reference/typescript-api/import-export/default-asset-import-strategy#defaultassetimportstrategy'>DefaultAssetImportStrategy</a> is able to load files from either the local filesystem
10
+ The <DocsLink href="/reference/typescript-api/import-export/default-asset-import-strategy#defaultassetimportstrategy">DefaultAssetImportStrategy</DocsLink> is able to load files from either the local filesystem
15
11
  or from a remote URL.
16
12
 
17
13
  A custom strategy could be created which could e.g. get the asset file from an S3 bucket.
@@ -36,7 +32,7 @@ interface AssetImportStrategy extends InjectableStrategy {
36
32
 
37
33
  ### getStreamFromPath
38
34
 
39
- <MemberInfo kind="method" type={`(assetPath: string) => Readable | Promise&#60;Readable&#62;`} />
35
+ <MemberInfo kind="method" type={`(assetPath: string) => Readable | Promise<Readable>`} />
40
36
 
41
37
  Given an asset path, this method should return a Stream of file data. This could
42
38
  e.g. be read from a file system or fetch from a remote location.
@@ -2,15 +2,11 @@
2
2
  title: "AssetImporter"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## AssetImporter
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/asset-importer/asset-importer.ts" sourceLine="17" packageName="@vendure/core" />
10
6
 
11
- This service creates new <a href='/reference/typescript-api/entities/asset#asset'>Asset</a> entities based on string paths provided in the CSV
7
+ This service creates new <DocsLink href="/reference/typescript-api/entities/asset#asset">Asset</DocsLink> entities based on string paths provided in the CSV
12
8
  import format. The source files are resolved by joining the value of `importExportOptions.importAssetsDir`
13
- with the asset path. This service is used internally by the <a href='/reference/typescript-api/import-export/importer#importer'>Importer</a> service.
9
+ with the asset path. This service is used internally by the <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink> service.
14
10
 
15
11
  ```ts title="Signature"
16
12
  class AssetImporter {
@@ -22,7 +18,7 @@ class AssetImporter {
22
18
 
23
19
  ### getAssets
24
20
 
25
- <MemberInfo kind="method" type={`(assetPaths: string[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;{ assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]; errors: string[] }&#62;`} />
21
+ <MemberInfo kind="method" type={`(assetPaths: string[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<{ assets: <a href='/reference/typescript-api/entities/asset#asset'>Asset</a>[]; errors: string[] }>`} />
26
22
 
27
23
  Creates Asset entities for the given paths, using the assetMap cache to prevent the
28
24
  creation of duplicates.
@@ -2,10 +2,6 @@
2
2
  title: "DefaultAssetImportStrategy"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DefaultAssetImportStrategy
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/asset-import-strategy/default-asset-import-strategy.ts" sourceLine="50" packageName="@vendure/core" since="1.7.0" />
10
6
 
11
7
  The DefaultAssetImportStrategy is able to import paths from the local filesystem (taking into account the
@@ -2,10 +2,6 @@
2
2
  title: "FastImporterService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FastImporterService
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/importer/fast-importer.service.ts" sourceLine="41" packageName="@vendure/core" />
10
6
 
11
7
  A service to import entities into the database. This replaces the regular `create` methods of the service layer with faster
@@ -38,17 +34,17 @@ Passing a `channel` argument means that Products and ProductVariants will be ass
38
34
  to that Channel.
39
35
  ### createProduct
40
36
 
41
- <MemberInfo kind="method" type={`(input: CreateProductInput) => Promise&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>&#62;`} />
37
+ <MemberInfo kind="method" type={`(input: CreateProductInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`} />
42
38
 
43
39
 
44
40
  ### createProductOptionGroup
45
41
 
46
- <MemberInfo kind="method" type={`(input: CreateProductOptionGroupInput) => Promise&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>&#62;`} />
42
+ <MemberInfo kind="method" type={`(input: CreateProductOptionGroupInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`} />
47
43
 
48
44
 
49
45
  ### createProductOption
50
46
 
51
- <MemberInfo kind="method" type={`(input: CreateProductOptionInput) => Promise&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>&#62;`} />
47
+ <MemberInfo kind="method" type={`(input: CreateProductOptionInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`} />
52
48
 
53
49
 
54
50
  ### addOptionGroupToProduct
@@ -58,7 +54,7 @@ to that Channel.
58
54
 
59
55
  ### createProductVariant
60
56
 
61
- <MemberInfo kind="method" type={`(input: CreateProductVariantInput) => Promise&#60;<a href='/reference/typescript-api/common/id#id'>ID</a>&#62;`} />
57
+ <MemberInfo kind="method" type={`(input: CreateProductVariantInput) => Promise<<a href='/reference/typescript-api/common/id#id'>ID</a>>`} />
62
58
 
63
59
 
64
60
 
@@ -2,10 +2,6 @@
2
2
  title: "ImportExportOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ImportExportOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="936" packageName="@vendure/core" />
10
6
 
11
7
  Options related to importing & exporting data.
@@ -29,7 +25,7 @@ The directory in which assets to be imported are located.
29
25
  <MemberInfo kind="property" type={`<a href='/reference/typescript-api/import-export/asset-import-strategy#assetimportstrategy'>AssetImportStrategy</a>`} since="1.7.0" />
30
26
 
31
27
  This strategy determines how asset files get imported based on the path given in the
32
- import CSV or via the <a href='/reference/typescript-api/import-export/asset-importer#assetimporter'>AssetImporter</a> `getAssets()` method.
28
+ import CSV or via the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> `getAssets()` method.
33
29
 
34
30
 
35
31
  </div>
@@ -2,14 +2,10 @@
2
2
  title: "ImportParser"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ImportParser
8
-
9
5
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="152" packageName="@vendure/core" />
10
6
 
11
7
  Validates and parses CSV files into a data structure which can then be used to created new entities.
12
- This is used internally by the <a href='/reference/typescript-api/import-export/importer#importer'>Importer</a>.
8
+ This is used internally by the <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink>.
13
9
 
14
10
  ```ts title="Signature"
15
11
  class ImportParser {
@@ -21,21 +17,17 @@ class ImportParser {
21
17
 
22
18
  ### parseProducts
23
19
 
24
- <MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise&#60;<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a>&#60;<a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>&#62;&#62;`} />
20
+ <MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise<<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a><<a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>>>`} />
25
21
 
26
22
  Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and
27
- returns a data structure which can then be used to populate Vendure using the <a href='/reference/typescript-api/import-export/fast-importer-service#fastimporterservice'>FastImporterService</a>.
23
+ returns a data structure which can then be used to populate Vendure using the <DocsLink href="/reference/typescript-api/import-export/fast-importer-service#fastimporterservice">FastImporterService</DocsLink>.
28
24
 
29
25
 
30
26
  </div>
31
-
32
-
33
- ## ParsedOptionGroup
34
-
35
27
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="45" packageName="@vendure/core" />
36
28
 
37
29
  The intermediate representation of an OptionGroup after it has been parsed
38
- by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
30
+ by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
39
31
 
40
32
  ```ts title="Signature"
41
33
  interface ParsedOptionGroup {
@@ -51,20 +43,16 @@ interface ParsedOptionGroup {
51
43
 
52
44
  ### translations
53
45
 
54
- <MemberInfo kind="property" type={`Array&#60;{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; name: string; values: string[]; }&#62;`} />
46
+ <MemberInfo kind="property" type={`Array<{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; name: string; values: string[]; }>`} />
55
47
 
56
48
 
57
49
 
58
50
 
59
51
  </div>
60
-
61
-
62
- ## ParsedFacet
63
-
64
52
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="61" packageName="@vendure/core" />
65
53
 
66
54
  The intermediate representation of a Facet after it has been parsed
67
- by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
55
+ by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
68
56
 
69
57
  ```ts title="Signature"
70
58
  interface ParsedFacet {
@@ -80,20 +68,16 @@ interface ParsedFacet {
80
68
 
81
69
  ### translations
82
70
 
83
- <MemberInfo kind="property" type={`Array&#60;{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; facet: string; value: string; }&#62;`} />
71
+ <MemberInfo kind="property" type={`Array<{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; facet: string; value: string; }>`} />
84
72
 
85
73
 
86
74
 
87
75
 
88
76
  </div>
89
-
90
-
91
- ## ParsedProductVariant
92
-
93
77
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="77" packageName="@vendure/core" />
94
78
 
95
79
  The intermediate representation of a ProductVariant after it has been parsed
96
- by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
80
+ by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
97
81
 
98
82
  ```ts title="Signature"
99
83
  interface ParsedProductVariant {
@@ -153,20 +137,16 @@ interface ParsedProductVariant {
153
137
 
154
138
  ### translations
155
139
 
156
- <MemberInfo kind="property" type={`Array&#60;{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; optionValues: string[]; customFields: { [name: string]: string; }; }&#62;`} />
140
+ <MemberInfo kind="property" type={`Array<{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; optionValues: string[]; customFields: { [name: string]: string; }; }>`} />
157
141
 
158
142
 
159
143
 
160
144
 
161
145
  </div>
162
-
163
-
164
- ## ParsedProduct
165
-
166
146
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="102" packageName="@vendure/core" />
167
147
 
168
148
  The intermediate representation of a Product after it has been parsed
169
- by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
149
+ by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
170
150
 
171
151
  ```ts title="Signature"
172
152
  interface ParsedProduct {
@@ -204,20 +184,16 @@ interface ParsedProduct {
204
184
 
205
185
  ### translations
206
186
 
207
- <MemberInfo kind="property" type={`Array&#60;{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; name: string; slug: string; description: string; customFields: { [name: string]: string; }; }&#62;`} />
187
+ <MemberInfo kind="property" type={`Array<{ languageCode: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>; name: string; slug: string; description: string; customFields: { [name: string]: string; }; }>`} />
208
188
 
209
189
 
210
190
 
211
191
 
212
192
  </div>
213
-
214
-
215
- ## ParsedProductWithVariants
216
-
217
193
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="125" packageName="@vendure/core" />
218
194
 
219
195
  The data structure into which an import CSV file is parsed by the
220
- <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a> `parseProducts()` method.
196
+ <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> `parseProducts()` method.
221
197
 
222
198
  ```ts title="Signature"
223
199
  interface ParsedProductWithVariants {
@@ -241,13 +217,9 @@ interface ParsedProductWithVariants {
241
217
 
242
218
 
243
219
  </div>
244
-
245
-
246
- ## ParseResult
247
-
248
220
  <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="137" packageName="@vendure/core" />
249
221
 
250
- The result returned by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a> `parseProducts()` method.
222
+ The result returned by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> `parseProducts()` method.
251
223
 
252
224
  ```ts title="Signature"
253
225
  interface ParseResult<T> {