@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957

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