@vendure/docs 0.0.0-202601280949 → 0.0.0-202601281114

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 (386) hide show
  1. package/dist/dates.generated.js +385 -385
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -2
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -1
  4. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -1
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -1
  6. package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -1
  7. package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -1
  8. package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -1
  9. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +2 -2
  10. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -1
  11. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -2
  13. package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  15. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -1
  16. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -1
  17. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +2 -2
  18. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  20. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +2 -2
  21. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -1
  22. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
  23. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -2
  24. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -2
  25. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -1
  26. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -1
  27. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  28. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
  29. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  30. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
  31. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  32. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
  33. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
  34. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  35. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  36. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -1
  37. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -1
  38. package/docs/reference/admin-ui-api/services/data-service.mdx +1 -1
  39. package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -1
  40. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +6 -8
  41. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +1 -1
  42. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +2 -2
  43. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +1 -1
  44. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  45. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -5
  46. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +2 -2
  47. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  48. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -3
  49. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
  50. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +3 -3
  51. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +5 -5
  52. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +3 -3
  53. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -1
  54. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -1
  55. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  56. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
  57. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -10
  58. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  59. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  60. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  61. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -9
  62. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
  63. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +3 -3
  64. package/docs/reference/core-plugins/email-plugin/index.mdx +4 -4
  65. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
  66. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
  67. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  68. package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -2
  69. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
  70. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -1
  71. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -1
  72. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -1
  73. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -1
  74. package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -3
  75. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -3
  76. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -1
  77. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
  78. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -1
  79. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  80. package/docs/reference/dashboard/components/asset-gallery.mdx +1 -1
  81. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -1
  82. package/docs/reference/dashboard/components/vendure-image.mdx +5 -5
  83. package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -2
  84. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
  85. package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -1
  86. package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -3
  87. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  88. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -1
  89. package/docs/reference/dashboard/hooks/use-auth.mdx +1 -1
  90. package/docs/reference/dashboard/hooks/use-channel.mdx +1 -1
  91. package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
  92. package/docs/reference/dashboard/list-views/list-page.mdx +2 -2
  93. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -2
  94. package/docs/reference/dashboard/page-layout/index.mdx +2 -2
  95. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -2
  96. package/docs/reference/dashboard/page-layout/page-block.mdx +4 -4
  97. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  98. package/docs/reference/dashboard/page-layout/page.mdx +4 -4
  99. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -4
  100. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
  101. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  102. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
  103. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
  104. package/docs/reference/typescript-api/auth/auth-options.mdx +4 -4
  105. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  106. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
  107. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
  108. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  109. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
  110. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -1
  111. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
  112. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
  113. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
  114. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  115. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +2 -2
  116. package/docs/reference/typescript-api/auth/permission-definition.mdx +12 -12
  117. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +5 -5
  118. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
  119. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  120. package/docs/reference/typescript-api/cache/cache-service.mdx +2 -2
  121. package/docs/reference/typescript-api/cache/cache-strategy.mdx +2 -2
  122. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -3
  123. package/docs/reference/typescript-api/cache/index.mdx +2 -2
  124. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -3
  125. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +2 -2
  126. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -2
  127. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +3 -3
  128. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -1
  129. package/docs/reference/typescript-api/common/id.mdx +1 -1
  130. package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -1
  131. package/docs/reference/typescript-api/common/middleware.mdx +1 -1
  132. package/docs/reference/typescript-api/common/permission.mdx +1 -1
  133. package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -2
  134. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -1
  135. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -3
  136. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +3 -3
  137. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -10
  138. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -1
  139. package/docs/reference/typescript-api/configuration/api-options.mdx +1 -1
  140. package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
  141. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
  142. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  143. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +5 -5
  144. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  145. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
  146. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +4 -4
  147. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +2 -2
  148. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -1
  149. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  150. package/docs/reference/typescript-api/configuration/system-options.mdx +3 -3
  151. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  152. package/docs/reference/typescript-api/custom-fields/index.mdx +1 -1
  153. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -1
  154. package/docs/reference/typescript-api/data-access/calculated.mdx +2 -2
  155. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  156. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -2
  157. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  158. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
  159. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -7
  160. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -2
  161. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
  162. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
  163. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +2 -2
  164. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
  165. package/docs/reference/typescript-api/entities/address.mdx +2 -2
  166. package/docs/reference/typescript-api/entities/administrator.mdx +3 -3
  167. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  168. package/docs/reference/typescript-api/entities/asset.mdx +2 -2
  169. package/docs/reference/typescript-api/entities/authenticated-session.mdx +3 -3
  170. package/docs/reference/typescript-api/entities/authentication-method.mdx +5 -5
  171. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  172. package/docs/reference/typescript-api/entities/collection.mdx +3 -3
  173. package/docs/reference/typescript-api/entities/country.mdx +4 -4
  174. package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
  175. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +2 -2
  176. package/docs/reference/typescript-api/entities/customer.mdx +3 -3
  177. package/docs/reference/typescript-api/entities/facet-value.mdx +3 -3
  178. package/docs/reference/typescript-api/entities/facet.mdx +4 -4
  179. package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
  180. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  181. package/docs/reference/typescript-api/entities/history-entry.mdx +3 -3
  182. package/docs/reference/typescript-api/entities/order-history-entry.mdx +2 -2
  183. package/docs/reference/typescript-api/entities/order-line-reference.mdx +8 -8
  184. package/docs/reference/typescript-api/entities/order-line.mdx +8 -8
  185. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  186. package/docs/reference/typescript-api/entities/order.mdx +9 -9
  187. package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
  188. package/docs/reference/typescript-api/entities/payment-method.mdx +4 -4
  189. package/docs/reference/typescript-api/entities/payment.mdx +2 -2
  190. package/docs/reference/typescript-api/entities/product-option-group.mdx +3 -3
  191. package/docs/reference/typescript-api/entities/product-option.mdx +3 -3
  192. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/product-variant.mdx +3 -3
  194. package/docs/reference/typescript-api/entities/product.mdx +3 -3
  195. package/docs/reference/typescript-api/entities/promotion.mdx +3 -3
  196. package/docs/reference/typescript-api/entities/province.mdx +2 -2
  197. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/region.mdx +4 -4
  199. package/docs/reference/typescript-api/entities/role.mdx +3 -3
  200. package/docs/reference/typescript-api/entities/seller.mdx +3 -3
  201. package/docs/reference/typescript-api/entities/session.mdx +3 -3
  202. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
  204. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  205. package/docs/reference/typescript-api/entities/stock-level.mdx +3 -3
  206. package/docs/reference/typescript-api/entities/stock-location.mdx +4 -4
  207. package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
  208. package/docs/reference/typescript-api/entities/surcharge.mdx +2 -2
  209. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  210. package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
  211. package/docs/reference/typescript-api/entities/tax-rate.mdx +5 -5
  212. package/docs/reference/typescript-api/entities/user.mdx +3 -3
  213. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/zone.mdx +2 -2
  215. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
  216. package/docs/reference/typescript-api/errors/error-types.mdx +8 -8
  217. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -1
  218. package/docs/reference/typescript-api/events/event-bus.mdx +6 -6
  219. package/docs/reference/typescript-api/events/event-types.mdx +109 -109
  220. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
  221. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
  222. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +5 -5
  223. package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -1
  224. package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -1
  225. package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -3
  226. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +2 -2
  227. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +2 -2
  228. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +2 -2
  229. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +3 -3
  230. package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -2
  231. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
  232. package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -1
  233. package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -8
  234. package/docs/reference/typescript-api/import-export/importer.mdx +2 -2
  235. package/docs/reference/typescript-api/import-export/populate.mdx +3 -3
  236. package/docs/reference/typescript-api/import-export/populator.mdx +2 -2
  237. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  238. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +4 -4
  239. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +4 -4
  240. package/docs/reference/typescript-api/job-queue/index.mdx +4 -4
  241. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
  242. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +2 -2
  243. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  244. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -4
  245. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +2 -2
  246. package/docs/reference/typescript-api/job-queue/job.mdx +2 -2
  247. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -3
  248. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +4 -4
  249. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +5 -5
  250. package/docs/reference/typescript-api/job-queue/types.mdx +5 -5
  251. package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
  252. package/docs/reference/typescript-api/logger/index.mdx +3 -3
  253. package/docs/reference/typescript-api/migration/migration-options.mdx +1 -1
  254. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +3 -3
  255. package/docs/reference/typescript-api/money/default-money-strategy.mdx +2 -2
  256. package/docs/reference/typescript-api/money/money-decorator.mdx +1 -1
  257. package/docs/reference/typescript-api/money/money-strategy.mdx +5 -5
  258. package/docs/reference/typescript-api/money/round-money.mdx +1 -1
  259. package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -1
  260. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -2
  261. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +2 -2
  262. package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -1
  263. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +2 -2
  264. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +3 -3
  265. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +2 -2
  266. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +2 -2
  267. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  268. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
  270. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
  271. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
  272. package/docs/reference/typescript-api/orders/order-interceptor.mdx +5 -5
  273. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +3 -3
  274. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +2 -2
  275. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  276. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  277. package/docs/reference/typescript-api/orders/order-process.mdx +13 -13
  278. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +5 -5
  279. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  280. package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -1
  281. package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -1
  282. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +4 -4
  283. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +5 -5
  284. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
  285. package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -16
  286. package/docs/reference/typescript-api/payment/payment-options.mdx +7 -7
  287. package/docs/reference/typescript-api/payment/payment-process.mdx +2 -2
  288. package/docs/reference/typescript-api/payment/payment-states.mdx +1 -1
  289. package/docs/reference/typescript-api/payment/refund-process.mdx +2 -2
  290. package/docs/reference/typescript-api/payment/refund-states.mdx +1 -1
  291. package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -3
  292. package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -1
  293. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -3
  294. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  295. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  296. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
  297. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -2
  298. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  299. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +2 -2
  300. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  301. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  302. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -3
  303. package/docs/reference/typescript-api/promotions/promotion-action.mdx +20 -20
  304. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +6 -6
  305. package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -1
  306. package/docs/reference/typescript-api/request/api-decorator.mdx +1 -1
  307. package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -1
  308. package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -1
  309. package/docs/reference/typescript-api/request/request-context-service.mdx +1 -1
  310. package/docs/reference/typescript-api/request/request-context.mdx +5 -5
  311. package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -2
  312. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -1
  313. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -1
  314. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +3 -3
  315. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -2
  316. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +4 -4
  317. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -3
  318. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -1
  319. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  320. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -1
  321. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -1
  322. package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
  323. package/docs/reference/typescript-api/services/asset-service.mdx +3 -3
  324. package/docs/reference/typescript-api/services/auth-service.mdx +3 -3
  325. package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
  326. package/docs/reference/typescript-api/services/collection-service.mdx +3 -3
  327. package/docs/reference/typescript-api/services/country-service.mdx +1 -1
  328. package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
  329. package/docs/reference/typescript-api/services/customer-service.mdx +13 -13
  330. package/docs/reference/typescript-api/services/facet-service.mdx +1 -1
  331. package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -1
  332. package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -3
  333. package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -1
  334. package/docs/reference/typescript-api/services/history-service.mdx +1 -1
  335. package/docs/reference/typescript-api/services/order-service.mdx +24 -24
  336. package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
  337. package/docs/reference/typescript-api/services/payment-service.mdx +6 -6
  338. package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -1
  339. package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
  340. package/docs/reference/typescript-api/services/product-service.mdx +2 -2
  341. package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -7
  342. package/docs/reference/typescript-api/services/promotion-service.mdx +1 -1
  343. package/docs/reference/typescript-api/services/province-service.mdx +1 -1
  344. package/docs/reference/typescript-api/services/role-service.mdx +1 -1
  345. package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
  346. package/docs/reference/typescript-api/services/session-service.mdx +4 -4
  347. package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
  348. package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -5
  349. package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -5
  350. package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -8
  351. package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
  352. package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
  353. package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
  354. package/docs/reference/typescript-api/services/user-service.mdx +8 -8
  355. package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
  356. package/docs/reference/typescript-api/settings-store/index.mdx +1 -1
  357. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -2
  358. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +2 -2
  359. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +5 -5
  360. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
  361. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
  362. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +3 -3
  363. package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -3
  364. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -1
  365. package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -2
  366. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +3 -3
  367. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +3 -3
  368. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +2 -2
  369. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +3 -3
  370. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +2 -2
  371. package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -1
  372. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +2 -2
  373. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -1
  374. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  375. package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -2
  376. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -1
  377. package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -2
  378. package/docs/reference/typescript-api/testing/test-config.mdx +1 -1
  379. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -1
  380. package/docs/reference/typescript-api/testing/test-environment.mdx +1 -1
  381. package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -1
  382. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  383. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  384. package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -1
  385. package/package.json +1 -1
  386. package/src/dates.generated.ts +385 -385
@@ -11,7 +11,7 @@ class InternalServerError extends I18nError {
11
11
  constructor(message: string, variables: { [key: string]: string | number } = {})
12
12
  }
13
13
  ```
14
- * Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
14
+ * Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
15
15
 
16
16
 
17
17
 
@@ -34,7 +34,7 @@ class UserInputError extends I18nError {
34
34
  constructor(message: string, variables: { [key: string]: string | number } = {})
35
35
  }
36
36
  ```
37
- * Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
37
+ * Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
38
38
 
39
39
 
40
40
 
@@ -57,7 +57,7 @@ class IllegalOperationError extends I18nError {
57
57
  constructor(message: string, variables: { [key: string]: string | number } = {})
58
58
  }
59
59
  ```
60
- * Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
60
+ * Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
61
61
 
62
62
 
63
63
 
@@ -80,7 +80,7 @@ class UnauthorizedError extends I18nError {
80
80
  constructor()
81
81
  }
82
82
  ```
83
- * Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
83
+ * Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
84
84
 
85
85
 
86
86
 
@@ -104,7 +104,7 @@ class ForbiddenError extends I18nError {
104
104
  constructor(logLevel: LogLevel = LogLevel.Warn)
105
105
  }
106
106
  ```
107
- * Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
107
+ * Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
108
108
 
109
109
 
110
110
 
@@ -120,7 +120,7 @@ class ForbiddenError extends I18nError {
120
120
  </div>
121
121
  <GenerationInfo sourceFile="packages/core/src/common/error/errors.ts" sourceLine="81" packageName="@vendure/core" />
122
122
 
123
- This error should be thrown when a <DocsLink href="/reference/typescript-api/entities/channel#channel">Channel</DocsLink> cannot be found based on the provided
123
+ This error should be thrown when a [Channel](/reference/typescript-api/entities/channel#channel) cannot be found based on the provided
124
124
  channel token.
125
125
 
126
126
  ```ts title="Signature"
@@ -128,7 +128,7 @@ class ChannelNotFoundError extends I18nError {
128
128
  constructor(token: string)
129
129
  }
130
130
  ```
131
- * Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
131
+ * Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
132
132
 
133
133
 
134
134
 
@@ -152,7 +152,7 @@ class EntityNotFoundError extends I18nError {
152
152
  constructor(entityName: keyof typeof coreEntitiesMap | string, id: ID)
153
153
  }
154
154
  ```
155
- * Extends: <DocsLink href="/reference/typescript-api/errors/i18n-error#i18nerror">`I18nError`</DocsLink>
155
+ * Extends: [`I18nError`](/reference/typescript-api/errors/i18n-error#i18nerror)
156
156
 
157
157
 
158
158
 
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/core/src/common/error/error-result.ts" sourceLine="71" packageName="@vendure/core" />
6
6
 
7
- Returns true if the <DocsLink href="/reference/typescript-api/errors/error-result-union#errorresultunion">ErrorResultUnion</DocsLink> is actually an ErrorResult type. This is useful when dealing with
7
+ Returns true if the [ErrorResultUnion](/reference/typescript-api/errors/error-result-union#errorresultunion) is actually an ErrorResult type. This is useful when dealing with
8
8
  certain internal service method that return an ErrorResultUnion.
9
9
 
10
10
  *Example*
@@ -8,9 +8,9 @@ The EventBus is used to globally publish events which can then be subscribed to.
8
8
 
9
9
  Events are published whenever certain actions take place within the Vendure server, for example:
10
10
 
11
- * when a Product is updated (<DocsLink href="/reference/typescript-api/events/event-types#productevent">ProductEvent</DocsLink>)
12
- * when an Order transitions state (<DocsLink href="/reference/typescript-api/events/event-types#orderstatetransitionevent">OrderStateTransitionEvent</DocsLink>)
13
- * when a Customer registers a new account (<DocsLink href="/reference/typescript-api/events/event-types#accountregistrationevent">AccountRegistrationEvent</DocsLink>)
11
+ * when a Product is updated ([ProductEvent](/reference/typescript-api/events/event-types#productevent))
12
+ * when an Order transitions state ([OrderStateTransitionEvent](/reference/typescript-api/events/event-types#orderstatetransitionevent))
13
+ * when a Customer registers a new account ([AccountRegistrationEvent](/reference/typescript-api/events/event-types#accountregistrationevent))
14
14
 
15
15
  Using the EventBus it is possible to subscribe to an take action when these events occur.
16
16
  This is done with the `.ofType()` method, which takes an event type and returns an rxjs observable
@@ -80,7 +80,7 @@ await eventBus.publish(new SomeEvent());
80
80
  <MemberInfo kind="method" type={`(type: Type<T>) => Observable<T>`} />
81
81
 
82
82
  Returns an RxJS Observable stream of events of the given type.
83
- If the event contains a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> object, the subscriber
83
+ If the event contains a [RequestContext](/reference/typescript-api/request/request-context#requestcontext) object, the subscriber
84
84
  will only get called after any active database transactions are complete.
85
85
 
86
86
  This means that the subscriber function can safely access all updated
@@ -90,7 +90,7 @@ data related to the event.
90
90
  <MemberInfo kind="method" type={`(predicate: (event: <a href='/reference/typescript-api/events/vendure-event#vendureevent'>VendureEvent</a>) => boolean) => Observable<T>`} />
91
91
 
92
92
  Returns an RxJS Observable stream of events filtered by a custom predicate.
93
- If the event contains a <DocsLink href="/reference/typescript-api/request/request-context#requestcontext">RequestContext</DocsLink> object, the subscriber
93
+ If the event contains a [RequestContext](/reference/typescript-api/request/request-context#requestcontext) object, the subscriber
94
94
  will only get called after any active database transactions are complete.
95
95
 
96
96
  This means that the subscriber function can safely access all updated
@@ -109,7 +109,7 @@ the triggering code to fail if the handler fails.
109
109
  This API should be used with caution, as errors or performance issues in the handler can cause the
110
110
  associated operation to be slow or fail entirely. For this reason, any handler which takes longer than
111
111
  100ms to execute will log a warning. Any non-trivial task to be performed in a blocking event handler
112
- should be offloaded to a background job using the <DocsLink href="/reference/typescript-api/job-queue/job-queue-service#jobqueueservice">JobQueueService</DocsLink>.
112
+ should be offloaded to a background job using the [JobQueueService](/reference/typescript-api/job-queue/job-queue-service#jobqueueservice).
113
113
 
114
114
  Also, be aware that the handler will be executed in the _same database transaction_ as the code which published
115
115
  the event (as long as you pass the `ctx` object from the event to any TransactionalConnection calls).