@vendure/docs 0.0.0-202601211609 → 0.0.0-202601220950

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 (371) hide show
  1. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  4. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  5. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +5 -5
  6. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
  7. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  8. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  9. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  10. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  11. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  13. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  15. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  16. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  17. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  18. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  20. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  21. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  22. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  23. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  24. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +1 -1
  26. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  27. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  28. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  29. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  30. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  31. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
  32. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
  33. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  34. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  35. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  36. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  37. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  38. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  39. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  40. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  41. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  47. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  48. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  49. package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
  50. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  51. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  52. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  53. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  54. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  55. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  56. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  57. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  58. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  59. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  60. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  61. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  62. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  63. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  64. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  65. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  66. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  67. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  68. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  69. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  70. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  71. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  72. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  73. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  74. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  75. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  76. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  77. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  78. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  79. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  80. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  81. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  82. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  83. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  84. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
  85. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  86. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  87. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  88. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  89. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  90. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  91. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  92. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  93. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  94. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  95. package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
  96. package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
  97. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
  98. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
  99. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  100. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  101. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  102. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  103. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  104. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  105. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  106. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  107. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  108. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  109. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  110. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  114. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  115. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  116. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  117. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  118. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  119. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  120. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  121. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  122. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  123. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  124. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  125. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  126. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  127. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  128. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  129. package/docs/reference/dashboard/page-layout/page.mdx +2 -2
  130. package/docs/reference/graphql-api/admin/_index.mdx +11 -0
  131. package/docs/reference/graphql-api/shop/_index.mdx +11 -0
  132. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  133. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  134. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  135. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  136. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  137. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  138. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  139. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +2 -2
  140. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  141. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  142. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  143. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  144. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  145. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  146. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  147. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  148. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  149. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  150. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  151. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
  152. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  153. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  154. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  155. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  156. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  157. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  158. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  159. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  160. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  161. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
  162. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  163. package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
  164. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +4 -4
  165. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
  166. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  167. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  168. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  169. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +14 -14
  170. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  171. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  172. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  173. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  174. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  175. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  176. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  177. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  178. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  179. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  180. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  181. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  182. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  183. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  184. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  185. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  186. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  188. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  189. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  190. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  191. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  192. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  194. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  196. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  197. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  199. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  200. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  202. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  204. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  205. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  207. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  208. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  209. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  210. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  212. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  213. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  214. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  215. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  216. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  217. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  220. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  221. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  222. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  225. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  227. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  228. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  229. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  230. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  231. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  232. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  233. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  234. package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
  235. package/docs/reference/typescript-api/events/event-types.mdx +1 -1
  236. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
  237. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  238. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  239. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  240. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  241. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  242. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  243. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  244. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  245. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  246. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  247. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  248. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  249. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  250. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  251. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  252. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
  253. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  254. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  255. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  256. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  257. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +2 -2
  258. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  259. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  260. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  261. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  262. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  263. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  264. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  266. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  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/order-by-code-access-strategy.mdx +1 -1
  270. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  271. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  272. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  273. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  274. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  275. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  276. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  277. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  278. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +5 -5
  279. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
  280. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
  281. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  282. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  283. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  284. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  285. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  286. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  287. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  288. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  289. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  290. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  291. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  292. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  293. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  294. package/docs/reference/typescript-api/promotions/promotion-action.mdx +12 -12
  295. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +3 -3
  296. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  297. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  298. package/docs/reference/typescript-api/request/request-context.mdx +2 -2
  299. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  300. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
  301. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  302. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  303. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  304. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  305. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  306. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  307. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  308. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  309. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  310. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  311. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  312. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  313. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  314. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  315. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  316. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  317. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  318. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  319. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  320. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  321. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  322. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  323. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  324. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  325. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  326. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  327. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  328. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  329. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  330. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  331. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  332. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  333. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  334. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  335. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  336. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  337. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  338. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  339. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  340. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  341. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  342. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  343. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  344. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  345. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  346. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  347. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  348. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  349. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  350. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  351. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +2 -2
  352. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
  353. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
  354. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  355. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  356. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
  357. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  358. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  359. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  360. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  361. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  362. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  363. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  364. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  365. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  366. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  367. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  368. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  369. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  370. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  371. package/package.json +6 -3
@@ -221,21 +221,21 @@ interface OrderInterceptor extends InjectableStrategy {
221
221
 
222
222
  ### willAddItemToOrder
223
223
 
224
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: WillAddItemToOrderInput) => `Promise<void | string> | void | string``} />
224
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: WillAddItemToOrderInput) => Promise<void | string> | void | string`} />
225
225
 
226
226
  Called when a new item is about to be added to the order,
227
227
  as in the `addItemToOrder` mutation or the `addItemToOrder()` / `addItemsToOrder()` method
228
228
  of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
229
229
  ### willAdjustOrderLine
230
230
 
231
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: WillAdjustOrderLineInput) => `Promise<void | string> | void | string``} />
231
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, input: WillAdjustOrderLineInput) => Promise<void | string> | void | string`} />
232
232
 
233
233
  Called when an existing order line is about to be adjusted,
234
234
  as in the `adjustOrderLine` mutation or the `adjustOrderLine()` / `adjustOrderLines()` method
235
235
  of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
236
236
  ### willRemoveItemFromOrder
237
237
 
238
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => `Promise<void | string> | void | string``} />
238
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => Promise<void | string> | void | string`} />
239
239
 
240
240
  Called when an item is about to be removed from the order,
241
241
  as in the `removeItemFromOrder` mutation or the `removeItemFromOrder()` / `removeItemsFromOrder()` method
@@ -72,7 +72,7 @@ interface OrderItemPriceCalculationStrategy extends InjectableStrategy {
72
72
 
73
73
  ### calculateUnitPrice
74
74
 
75
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, orderLineCustomFields: { [key: string]: any }, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, quantity: number) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>` | Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``} />
75
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, orderLineCustomFields: { [key: string]: any }, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, quantity: number) => <a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a> | Promise<<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>>`} />
76
76
 
77
77
  Receives the ProductVariant to be added to the Order as well as any OrderLine custom fields and returns
78
78
  the price for a single unit.
@@ -57,7 +57,7 @@ Defines the logic used to calculate the unit price of an OrderLine when adding a
57
57
  item to an Order.
58
58
  ### process
59
59
 
60
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a>`<any>>``} default={`[]`} />
60
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/orders/order-process#orderprocess'>OrderProcess</a><any>>`} default={`[]`} />
61
61
 
62
62
  Allows the definition of custom states and transition logic for the order process state machine.
63
63
  Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/orders/order-process#orderprocess">OrderProcess</DocsLink> interface.
@@ -113,7 +113,7 @@ will be reflected in the GraphQL `OrderLine.unitPrice[WithTax]ChangeSinceAdded`
113
113
  Defines the point of the order process at which the Order is set as "placed".
114
114
  ### activeOrderStrategy
115
115
 
116
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>`<any> | Array<`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a>`<any>>``} default={`<a href='/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy'>DefaultActiveOrderStrategy</a>`} since="1.9.0" />
116
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a><any> | Array<<a href='/reference/typescript-api/orders/active-order-strategy#activeorderstrategy'>ActiveOrderStrategy</a><any>>`} default={`<a href='/reference/typescript-api/orders/default-active-order-strategy#defaultactiveorderstrategy'>DefaultActiveOrderStrategy</a>`} since="1.9.0" />
117
117
 
118
118
  Defines the strategy used to determine the active Order when interacting with Shop API operations
119
119
  such as `activeOrder` and `addItemToOrder`. By default, the strategy uses the active Session.
@@ -36,7 +36,7 @@ interface OrderPlacedStrategy extends InjectableStrategy {
36
36
 
37
37
  ### shouldSetAsPlaced
38
38
 
39
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `boolean | Promise<boolean>``} />
39
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => boolean | Promise<boolean>`} />
40
40
 
41
41
  This method is called whenever an _active_ Order transitions from one state to another.
42
42
  If it resolves to `true`, then the Order will be set as "placed", which means:
@@ -34,22 +34,22 @@ interface OrderProcess<State extends keyof CustomOrderStates | string> extends I
34
34
 
35
35
  ### transitions
36
36
 
37
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | `<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>`> &#38; Partial<`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<`<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>` | State>>``} />
37
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a> | State>>`} />
38
38
 
39
39
 
40
40
  ### onTransitionStart
41
41
 
42
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | `<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>`>``} />
42
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>>`} />
43
43
 
44
44
 
45
45
  ### onTransitionEnd
46
46
 
47
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | `<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>`>``} />
47
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, <a href='/reference/typescript-api/orders/order-process#ordertransitiondata'>OrderTransitionData</a>>`} />
48
48
 
49
49
 
50
50
  ### onTransitionError
51
51
 
52
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | `<a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>`>``} />
52
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>>`} />
53
53
 
54
54
 
55
55
 
@@ -36,7 +36,7 @@ interface OrderSellerStrategy extends InjectableStrategy {
36
36
 
37
37
  ### setOrderLineSellerChannel
38
38
 
39
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>` | undefined | Promise<`<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>` | undefined>``} />
39
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>) => <a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | undefined | Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a> | undefined>`} />
40
40
 
41
41
  This method is called whenever a new OrderLine is added to the Order via the `addItemToOrder` mutation or the
42
42
  underlying `addItemToOrder()` method of the <DocsLink href="/reference/typescript-api/services/order-service#orderservice">OrderService</DocsLink>.
@@ -45,13 +45,13 @@ It should return the Channel to which this OrderLine will be assigned, which wil
45
45
  <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink> `sellerChannel` property.
46
46
  ### splitOrder
47
47
 
48
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>`[] | Promise<`<a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>`[]>``} />
48
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => <a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>[] | Promise<<a href='/reference/typescript-api/orders/order-seller-strategy#splitordercontents'>SplitOrderContents</a>[]>`} />
49
49
 
50
50
  Upon checkout (by default, when the Order moves from "active" to "inactive" according to the <DocsLink href="/reference/typescript-api/orders/order-placed-strategy#orderplacedstrategy">OrderPlacedStrategy</DocsLink>),
51
51
  this method will be called in order to split the Order into multiple Orders, one for each Seller.
52
52
  ### afterSellerOrdersCreated
53
53
 
54
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, aggregateOrder: <a href='/reference/typescript-api/entities/order#order'>Order</a>, sellerOrders: <a href='/reference/typescript-api/entities/order#order'>Order</a>[]) => `void | Promise<void>``} />
54
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, aggregateOrder: <a href='/reference/typescript-api/entities/order#order'>Order</a>, sellerOrders: <a href='/reference/typescript-api/entities/order#order'>Order</a>[]) => void | Promise<void>`} />
55
55
 
56
56
  This method is called after splitting the orders, including calculating the totals for each of the seller Orders.
57
57
  This method can be used to set platform fee surcharges on the seller Orders as well as perform any payment processing
@@ -32,7 +32,7 @@ interface StockAllocationStrategy extends InjectableStrategy {
32
32
 
33
33
  ### shouldAllocateStock
34
34
 
35
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => `boolean | Promise<boolean>``} />
35
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fromState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, toState: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => boolean | Promise<boolean>`} />
36
36
 
37
37
  This method is called whenever an Order transitions from one state to another.
38
38
  If it resolves to `true`, then stock will be allocated for this order.
@@ -23,14 +23,14 @@ interface PaymentMethodConfigOptions<T extends ConfigArgs> extends ConfigurableO
23
23
 
24
24
  ### createPayment
25
25
 
26
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createpaymentfn'>CreatePaymentFn</a>`<T>``} />
26
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createpaymentfn'>CreatePaymentFn</a><T>`} />
27
27
 
28
28
  This function provides the logic for creating a payment. For example,
29
29
  it may call out to a third-party service with the data and should return a
30
30
  <DocsLink href="/reference/typescript-api/payment/payment-method-types#createpaymentresult">CreatePaymentResult</DocsLink> object contains the details of the payment.
31
31
  ### settlePayment
32
32
 
33
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a>`<T>``} />
33
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentfn'>SettlePaymentFn</a><T>`} />
34
34
 
35
35
  This function provides the logic for settling a payment, also known as "capturing".
36
36
  For payment integrations that settle/capture the payment on creation (i.e. the
@@ -38,7 +38,7 @@ For payment integrations that settle/capture the payment on creation (i.e. the
38
38
  need only return `{ success: true }`.
39
39
  ### cancelPayment
40
40
 
41
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentfn'>CancelPaymentFn</a>`<T>``} since="1.7.0" />
41
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentfn'>CancelPaymentFn</a><T>`} since="1.7.0" />
42
42
 
43
43
  This function provides the logic for cancelling a payment, which would be invoked when a call is
44
44
  made to the `cancelPayment` mutation in the Admin API. Cancelling a payment can apply
@@ -47,7 +47,7 @@ completed the payment. It allows the incomplete payment to be cleaned up on the
47
47
  if it gets cancelled via Vendure.
48
48
  ### createRefund
49
49
 
50
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createrefundfn'>CreateRefundFn</a>`<T>``} />
50
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-types#createrefundfn'>CreateRefundFn</a><T>`} />
51
51
 
52
52
  This function provides the logic for refunding a payment created with this
53
53
  payment method. Some payment providers may not provide the facility to
@@ -55,7 +55,7 @@ programmatically create a refund. In such a case, this method should be
55
55
  omitted and any Refunds will have to be settled manually by an administrator.
56
56
  ### onStateTransitionStart
57
57
 
58
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>`>``} />
58
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
59
59
 
60
60
  This function, when specified, will be invoked before any transition from one <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> to another.
61
61
  The return value (a sync / async `boolean`) is used to determine whether the transition is permitted.
@@ -35,7 +35,7 @@ class PaymentMethodEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends
35
35
 
36
36
  ### constructor
37
37
 
38
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitycheckerconfig'>PaymentMethodEligibilityCheckerConfig</a>`<T>`) => PaymentMethodEligibilityChecker`} />
38
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitycheckerconfig'>PaymentMethodEligibilityCheckerConfig</a><T>) => PaymentMethodEligibilityChecker`} />
39
39
 
40
40
 
41
41
 
@@ -59,7 +59,7 @@ interface PaymentMethodEligibilityCheckerConfig<T extends ConfigArgs> extends Co
59
59
 
60
60
  ### check
61
61
 
62
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-eligibility-checker#checkpaymentmethodeligibilitycheckerfn'>CheckPaymentMethodEligibilityCheckerFn</a>`<T>``} />
62
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/payment/payment-method-eligibility-checker#checkpaymentmethodeligibilitycheckerfn'>CheckPaymentMethodEligibilityCheckerFn</a><T>`} />
63
63
 
64
64
 
65
65
 
@@ -70,7 +70,7 @@ class PaymentMethodHandler<T extends ConfigArgs = ConfigArgs> extends Configurab
70
70
 
71
71
  ### constructor
72
72
 
73
- <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions'>PaymentMethodConfigOptions</a>`<T>`) => PaymentMethodHandler`} />
73
+ <MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/payment/payment-method-config-options#paymentmethodconfigoptions'>PaymentMethodConfigOptions</a><T>) => PaymentMethodHandler`} />
74
74
 
75
75
 
76
76
 
@@ -27,7 +27,7 @@ Typically this should equal the Order total, unless multiple payment methods
27
27
  are being used for the order.
28
28
  ### state
29
29
 
30
- <MemberInfo kind="property" type={``Exclude<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`, 'Error'>``} />
30
+ <MemberInfo kind="property" type={`Exclude<<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, 'Error'>`} />
31
31
 
32
32
  The <DocsLink href="/reference/typescript-api/payment/payment-state#paymentstate">PaymentState</DocsLink> of the resulting Payment.
33
33
 
@@ -190,7 +190,7 @@ interface SettlePaymentErrorResult {
190
190
 
191
191
  ### state
192
192
 
193
- <MemberInfo kind="property" type={``Exclude<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`, 'Settled'>``} />
193
+ <MemberInfo kind="property" type={`Exclude<<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, 'Settled'>`} />
194
194
 
195
195
  The state to transition this Payment to upon unsuccessful settlement.
196
196
  Defaults to `Error`. Note that if using a different state, it must be
@@ -261,7 +261,7 @@ interface CancelPaymentErrorResult {
261
261
 
262
262
  ### state
263
263
 
264
- <MemberInfo kind="property" type={``Exclude<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`, 'Cancelled'>``} />
264
+ <MemberInfo kind="property" type={`Exclude<<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, 'Cancelled'>`} />
265
265
 
266
266
  The state to transition this Payment to upon unsuccessful cancellation.
267
267
  Defaults to `Error`. Note that if using a different state, it must be
@@ -32,18 +32,18 @@ Defines which <DocsLink href="/reference/typescript-api/payment/payment-method-e
32
32
  <DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>s
33
33
  ### customPaymentProcess
34
34
 
35
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>`<any>>``} />
35
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} />
36
36
 
37
37
 
38
38
  ### process
39
39
 
40
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a>`<any>>``} default={`<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>`} since="2.0.0" />
40
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/payment-process#paymentprocess'>PaymentProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>`} since="2.0.0" />
41
41
 
42
42
  Allows the definition of custom states and transition logic for the payment process state machine.
43
43
  Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/payment-process#paymentprocess">PaymentProcess</DocsLink> interface.
44
44
  ### refundProcess
45
45
 
46
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a>`<any>>``} default={`<a href='/reference/typescript-api/payment/default-refund-process#defaultrefundprocess'>defaultRefundProcess</a>`} />
46
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/payment/refund-process#refundprocess'>RefundProcess</a><any>>`} default={`<a href='/reference/typescript-api/payment/default-refund-process#defaultrefundprocess'>defaultRefundProcess</a>`} />
47
47
 
48
48
  Allows the definition of custom states and transition logic for the refund process state machine.
49
49
  Takes an array of objects implementing the <DocsLink href="/reference/typescript-api/payment/refund-process#refundprocess">RefundProcess</DocsLink> interface.
@@ -34,22 +34,22 @@ interface PaymentProcess<State extends keyof CustomPaymentStates | string> exten
34
34
 
35
35
  ### transitions
36
36
 
37
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | `<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`> &#38; Partial<`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<`<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>` | State>>``} />
37
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a> | State>>`} />
38
38
 
39
39
 
40
40
  ### onTransitionStart
41
41
 
42
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | `<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>`>``} />
42
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
43
43
 
44
44
 
45
45
  ### onTransitionEnd
46
46
 
47
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | `<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>`>``} />
47
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>, <a href='/reference/typescript-api/payment/payment-transition-data#paymenttransitiondata'>PaymentTransitionData</a>>`} />
48
48
 
49
49
 
50
50
  ### onTransitionError
51
51
 
52
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | `<a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>`>``} />
52
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>>`} />
53
53
 
54
54
 
55
55
 
@@ -27,22 +27,22 @@ interface RefundProcess<State extends keyof CustomRefundStates | string> extends
27
27
 
28
28
  ### transitions
29
29
 
30
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<State, State | `<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>`> &#38; Partial<`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a>`<`<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>` | State>>``} />
30
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><State, State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>> &#38; Partial<<a href='/reference/typescript-api/state-machine/transitions#transitions'>Transitions</a><<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a> | State>>`} />
31
31
 
32
32
 
33
33
  ### onTransitionStart
34
34
 
35
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a>`<State | `<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>`>``} />
35
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>>`} />
36
36
 
37
37
 
38
38
  ### onTransitionEnd
39
39
 
40
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a>`<State | `<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>`>``} />
40
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionendfn'>OnTransitionEndFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, <a href='/reference/typescript-api/payment/refund-transition-data#refundtransitiondata'>RefundTransitionData</a>>`} />
41
41
 
42
42
 
43
43
  ### onTransitionError
44
44
 
45
- <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a>`<State | `<a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>`>``} />
45
+ <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionerrorfn'>OnTransitionErrorFn</a><State | <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>>`} />
46
46
 
47
47
 
48
48
 
@@ -44,7 +44,7 @@ The plugin may extend the default Vendure GraphQL admin api by providing extende
44
44
  schema definitions and any required resolvers.
45
45
  ### entities
46
46
 
47
- <MemberInfo kind="property" type={``Array<Type<any>> | (() => Array<Type<any>>)``} />
47
+ <MemberInfo kind="property" type={`Array<Type<any>> | (() => Array<Type<any>>)`} />
48
48
 
49
49
  The plugin may define custom [TypeORM database entities](https://typeorm.io/#/entities).
50
50
  ### dashboard
@@ -94,7 +94,7 @@ interface APIExtensionDefinition {
94
94
 
95
95
  ### schema
96
96
 
97
- <MemberInfo kind="property" type={``DocumentNode | ((schema?: GraphQLSchema) => DocumentNode | undefined)``} />
97
+ <MemberInfo kind="property" type={`DocumentNode | ((schema?: GraphQLSchema) => DocumentNode | undefined)`} />
98
98
 
99
99
  Extensions to the schema.
100
100
  Passes the current schema as an optional argument, allowing the extension to be based on the existing schema.
@@ -109,13 +109,13 @@ const schema = gql`extend type SearchReindexResponse {
109
109
  ```
110
110
  ### resolvers
111
111
 
112
- <MemberInfo kind="property" type={``Array<Type<any>> | (() => Array<Type<any>>)``} />
112
+ <MemberInfo kind="property" type={`Array<Type<any>> | (() => Array<Type<any>>)`} />
113
113
 
114
114
  An array of resolvers for the schema extensions. Should be defined as [Nestjs GraphQL resolver](https://docs.nestjs.com/graphql/resolvers-map)
115
115
  classes, i.e. using the Nest `@Resolver()` decorator etc.
116
116
  ### scalars
117
117
 
118
- <MemberInfo kind="property" type={``Record<string, GraphQLScalarType> | (() => Record<string, GraphQLScalarType>)``} since="1.7.0" />
118
+ <MemberInfo kind="property" type={`Record<string, GraphQLScalarType> | (() => Record<string, GraphQLScalarType>)`} since="1.7.0" />
119
119
 
120
120
  A map of GraphQL scalar types which should correspond to any custom scalars defined in your schema.
121
121
  Read more about defining custom scalars in the
@@ -21,7 +21,7 @@ interface CatalogOptions {
21
21
 
22
22
  ### collectionFilters
23
23
 
24
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a>`<any>>``} default={`defaultCollectionFilters`} />
24
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/configuration/collection-filter#collectionfilter'>CollectionFilter</a><any>>`} default={`defaultCollectionFilters`} />
25
25
 
26
26
  Allows custom <DocsLink href="/reference/typescript-api/configuration/collection-filter#collectionfilter">CollectionFilter</DocsLink>s to be defined.
27
27
  ### productVariantPriceSelectionStrategy
@@ -25,7 +25,7 @@ class DefaultProductVariantPriceCalculationStrategy implements ProductVariantPri
25
25
 
26
26
  ### calculate
27
27
 
28
- <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => `Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``} />
28
+ <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => Promise<<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>>`} />
29
29
 
30
30
 
31
31
 
@@ -34,7 +34,7 @@ class DefaultStockLocationStrategy extends BaseStockLocationStrategy {
34
34
 
35
35
  ### forAllocation
36
36
 
37
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
37
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
38
38
 
39
39
 
40
40
 
@@ -26,12 +26,12 @@ class MultiChannelStockLocationStrategy extends BaseStockLocationStrategy {
26
26
 
27
27
  ### getAvailableStock
28
28
 
29
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => `Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>`>``} />
29
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>>`} />
30
30
 
31
31
  Returns the available stock for the given ProductVariant, taking into account the active Channel.
32
32
  ### forAllocation
33
33
 
34
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => `Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
34
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
35
35
 
36
36
  This method takes into account whether the stock location is applicable to the active channel.
37
37
  It furthermore respects the `trackInventory` and `outOfStockThreshold` settings of the ProductVariant,
@@ -26,7 +26,7 @@ interface ProductVariantPriceCalculationStrategy extends InjectableStrategy {
26
26
 
27
27
  ### calculate
28
28
 
29
- <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => `Promise<`<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>`>``} />
29
+ <MemberInfo kind="method" type={`(args: <a href='/reference/typescript-api/products-stock/product-variant-price-calculation-strategy#productvariantpricecalculationargs'>ProductVariantPriceCalculationArgs</a>) => Promise<<a href='/reference/typescript-api/common/price-calculation-result#pricecalculationresult'>PriceCalculationResult</a>>`} />
30
30
 
31
31
 
32
32
 
@@ -33,7 +33,7 @@ interface StockDisplayStrategy extends InjectableStrategy {
33
33
 
34
34
  ### getStockLevel
35
35
 
36
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, saleableStockLevel: number) => `string | Promise<string>``} />
36
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariant: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, saleableStockLevel: number) => string | Promise<string>`} />
37
37
 
38
38
  Returns a string representing the stock level, which will be used directly
39
39
  in the GraphQL `ProductVariant.stockLevel` field.
@@ -57,31 +57,31 @@ interface StockLocationStrategy extends InjectableStrategy {
57
57
 
58
58
  ### getAvailableStock
59
59
 
60
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>` | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>`>``} />
60
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, stockLevels: <a href='/reference/typescript-api/entities/stock-level#stocklevel'>StockLevel</a>[]) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a> | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#availablestock'>AvailableStock</a>>`} />
61
61
 
62
62
  Returns the available stock for the given ProductVariant, taking into account
63
63
  the stock levels at each StockLocation.
64
64
  ### forAllocation
65
65
 
66
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
66
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
67
67
 
68
68
  Determines which StockLocations should be used to when allocating stock when
69
69
  and Order is placed.
70
70
  ### forRelease
71
71
 
72
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
72
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
73
73
 
74
74
  Determines which StockLocations should be used to when releasing allocated
75
75
  stock when an OrderLine is cancelled before being fulfilled.
76
76
  ### forSale
77
77
 
78
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
78
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
79
79
 
80
80
  Determines which StockLocations should be used to when creating a Sale
81
81
  and reducing the stockOnHand upon fulfillment.
82
82
  ### forCancellation
83
83
 
84
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[] | Promise<`<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>`[]>``} />
84
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, stockLocations: <a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>[], orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, quantity: number) => <a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[] | Promise<<a href='/reference/typescript-api/products-stock/stock-location-strategy#locationwithquantity'>LocationWithQuantity</a>[]>`} />
85
85
 
86
86
  Determines which StockLocations should be used to when creating a Cancellation
87
87
  of an OrderLine which has already been fulfilled.
@@ -63,7 +63,7 @@ class FacetValueChecker implements OnModuleInit {
63
63
 
64
64
  ### hasFacetValues
65
65
 
66
- <MemberInfo kind="method" type={`(orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, facetValueIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => `Promise<boolean>``} />
66
+ <MemberInfo kind="method" type={`(orderLine: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>, facetValueIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[], ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<boolean>`} />
67
67
 
68
68
  Checks a given <DocsLink href="/reference/typescript-api/entities/order-line#orderline">OrderLine</DocsLink> against the facetValueIds and returns
69
69
  `true` if the associated <DocsLink href="/reference/typescript-api/entities/product-variant#productvariant">ProductVariant</DocsLink> & <DocsLink href="/reference/typescript-api/entities/product#product">Product</DocsLink> together