@vendure/docs 0.0.0-202601211609 → 0.0.0-202601221206

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 (381) hide show
  1. package/dist/dates.generated.d.ts +2 -0
  2. package/dist/dates.generated.d.ts.map +1 -0
  3. package/dist/dates.generated.js +811 -0
  4. package/dist/dates.generated.js.map +1 -0
  5. package/dist/manifest.d.ts.map +1 -1
  6. package/dist/manifest.js +4 -2
  7. package/dist/manifest.js.map +1 -1
  8. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  9. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  10. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  11. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  12. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +5 -5
  13. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +3 -3
  14. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  15. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  16. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  17. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  18. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  20. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  21. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  22. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  23. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  24. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  26. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  27. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  28. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  29. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  30. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  31. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  32. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +1 -1
  33. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  34. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  35. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  36. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  37. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  38. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +2 -2
  39. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +6 -6
  40. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  41. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  47. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  48. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  49. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  50. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  51. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  52. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  53. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  54. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  55. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  56. package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
  57. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  58. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  59. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  60. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  61. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  62. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  63. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  64. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  65. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  66. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  67. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  68. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  69. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  70. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  71. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  72. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  73. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  74. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  75. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  76. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
  77. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  78. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  79. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  80. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  81. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  82. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  83. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  84. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  85. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  86. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  87. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  88. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  89. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  90. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  91. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
  92. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  93. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  94. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  95. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  96. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  97. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  98. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  99. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  100. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  101. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  102. package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
  103. package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
  104. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
  105. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
  106. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  107. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  108. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  109. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  110. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  111. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  112. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  113. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  114. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  115. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  116. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  117. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  118. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  119. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  120. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  121. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  122. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  123. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  124. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  125. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  126. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  127. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  128. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  129. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  130. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  131. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  132. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  133. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  134. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  135. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  136. package/docs/reference/dashboard/page-layout/page.mdx +2 -2
  137. package/docs/reference/graphql-api/admin/_index.mdx +11 -0
  138. package/docs/reference/graphql-api/shop/_index.mdx +11 -0
  139. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  140. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  141. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  142. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  143. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  144. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  145. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  146. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +2 -2
  147. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  148. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  149. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  150. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  151. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  152. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  153. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  154. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  155. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  156. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  157. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  158. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
  159. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  160. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  161. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  162. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  163. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  164. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  165. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  166. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  167. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  168. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
  169. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  170. package/docs/reference/typescript-api/configuration/collection-filter.mdx +2 -2
  171. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +4 -4
  172. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -2
  173. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  174. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  175. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  176. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +14 -14
  177. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  178. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  179. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  180. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  181. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  182. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  183. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  184. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  185. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  186. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  187. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  188. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  189. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  190. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  191. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  192. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  194. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  196. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  197. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  198. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  199. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  200. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  202. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  203. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  204. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  205. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  207. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  208. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  209. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  210. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  212. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  213. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  214. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  215. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  216. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  217. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  219. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  220. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  221. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  225. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  227. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  228. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  229. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  230. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  231. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  232. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  233. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  234. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  235. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  236. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  237. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  238. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  239. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  240. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  241. package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
  242. package/docs/reference/typescript-api/events/event-types.mdx +1 -1
  243. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
  244. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  245. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  246. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  247. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  248. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  249. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  250. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  251. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  252. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  253. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  254. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  255. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  256. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  257. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  258. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  259. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
  260. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  261. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  262. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  263. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  264. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +2 -2
  265. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  266. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  267. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  268. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  270. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  271. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  273. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  274. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  275. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  276. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  277. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  278. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  279. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  280. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  281. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  282. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  283. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  284. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  285. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +5 -5
  286. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
  287. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
  288. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  289. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  290. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  291. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  292. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  293. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  294. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  295. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  296. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  297. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  298. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  299. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  300. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  301. package/docs/reference/typescript-api/promotions/promotion-action.mdx +12 -12
  302. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +3 -3
  303. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  304. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  305. package/docs/reference/typescript-api/request/request-context.mdx +2 -2
  306. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  307. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
  308. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  309. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  310. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  311. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  312. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  313. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  314. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  315. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  316. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  317. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  318. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  319. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  320. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  321. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  322. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  323. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  324. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  325. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  326. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  327. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  328. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  329. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  330. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  331. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  332. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  333. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  334. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  335. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  336. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  337. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  338. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  339. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  340. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  341. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  342. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  343. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  344. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  345. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  346. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  347. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  348. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  349. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  350. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  351. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  352. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  353. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  354. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  355. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  356. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  357. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  358. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +2 -2
  359. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
  360. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
  361. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  362. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  363. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
  364. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  365. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  366. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  367. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  368. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  369. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  370. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  371. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  372. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  373. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  374. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  375. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  376. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  377. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  378. package/package.json +10 -4
  379. package/src/dates.generated.ts +811 -0
  380. package/src/index.ts +2 -0
  381. package/src/manifest.ts +995 -0
@@ -20,7 +20,7 @@ class DataService {
20
20
 
21
21
  ### query
22
22
 
23
- <MemberInfo kind="method" type={`(query: `DocumentNode | TypedDocumentNode<T, V>`, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} />
23
+ <MemberInfo kind="method" type={`(query: DocumentNode | TypedDocumentNode<T, V>, variables?: V, fetchPolicy: WatchQueryFetchPolicy = 'cache-and-network', options: ExtendedQueryOptions = {}) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} />
24
24
 
25
25
  Perform a GraphQL query. Returns a <DocsLink href="/reference/admin-ui-api/services/data-service#queryresult">QueryResult</DocsLink> which allows further control over
26
26
  they type of result returned, e.g. stream of values, single value etc.
@@ -41,7 +41,7 @@ const result$ = this.dataService.query(gql`
41
41
  ```
42
42
  ### mutate
43
43
 
44
- <MemberInfo kind="method" type={`(mutation: `DocumentNode | TypedDocumentNode<T, V>`, variables?: V, update?: `MutationUpdaterFunction<T, V, any, any>`, options: ExtendedQueryOptions = {}) => `Observable<T>``} />
44
+ <MemberInfo kind="method" type={`(mutation: DocumentNode | TypedDocumentNode<T, V>, variables?: V, update?: MutationUpdaterFunction<T, V, any, any>, options: ExtendedQueryOptions = {}) => Observable<T>`} />
45
45
 
46
46
  Perform a GraphQL mutation.
47
47
 
@@ -84,43 +84,43 @@ class QueryResult<T, V extends Record<string, any> = Record<string, any>> {
84
84
 
85
85
  ### constructor
86
86
 
87
- <MemberInfo kind="method" type={`(queryRef: `QueryRef<T, V>`, apollo: Apollo, customFieldMap: `Map<string, `<a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>`[]>`) => QueryResult`} />
87
+ <MemberInfo kind="method" type={`(queryRef: QueryRef<T, V>, apollo: Apollo, customFieldMap: Map<string, <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]>) => QueryResult`} />
88
88
 
89
89
 
90
90
  ### refetchOnChannelChange
91
91
 
92
- <MemberInfo kind="method" type={`() => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} />
92
+ <MemberInfo kind="method" type={`() => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} />
93
93
 
94
94
  Re-fetch this query whenever the active Channel changes.
95
95
  ### refetchOnCustomFieldsChange
96
96
 
97
- <MemberInfo kind="method" type={`(customFieldsToInclude$: `Observable<string[]>`) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a>`<T, V>``} since="3.0.4" />
97
+ <MemberInfo kind="method" type={`(customFieldsToInclude$: Observable<string[]>) => <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a><T, V>`} since="3.0.4" />
98
98
 
99
99
  Re-fetch this query whenever the custom fields change, updating the query to include the
100
100
  specified custom fields.
101
101
  ### single$
102
102
 
103
- <MemberInfo kind="property" type={``Observable<T>``} />
103
+ <MemberInfo kind="property" type={`Observable<T>`} />
104
104
 
105
105
  Returns an Observable which emits a single result and then completes.
106
106
  ### stream$
107
107
 
108
- <MemberInfo kind="property" type={``Observable<T>``} />
108
+ <MemberInfo kind="property" type={`Observable<T>`} />
109
109
 
110
110
  Returns an Observable which emits until unsubscribed.
111
111
  ### ref
112
112
 
113
- <MemberInfo kind="property" type={``QueryRef<T, V>``} />
113
+ <MemberInfo kind="property" type={`QueryRef<T, V>`} />
114
114
 
115
115
 
116
116
  ### mapSingle
117
117
 
118
- <MemberInfo kind="method" type={`(mapFn: `(item: T) => R`) => `Observable<R>``} />
118
+ <MemberInfo kind="method" type={`(mapFn: (item: T) => R) => Observable<R>`} />
119
119
 
120
120
  Returns a single-result Observable after applying the map function.
121
121
  ### mapStream
122
122
 
123
- <MemberInfo kind="method" type={`(mapFn: `(item: T) => R`) => `Observable<R>``} />
123
+ <MemberInfo kind="method" type={`(mapFn: (item: T) => R) => Observable<R>`} />
124
124
 
125
125
  Returns a multiple-result Observable after applying the map function.
126
126
  ### destroy
@@ -24,7 +24,7 @@ class ModalService {
24
24
 
25
25
  ### fromComponent
26
26
 
27
- <MemberInfo kind="method" type={`(component: `Type<T> &#38; Type<`<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a>`<R>>`, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a>`<T>`) => `Observable<R | undefined>``} />
27
+ <MemberInfo kind="method" type={`(component: Type<T> &#38; Type<<a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a><R>>, options?: <a href='/reference/admin-ui-api/services/modal-service#modaloptions'>ModalOptions</a><T>) => Observable<R | undefined>`} />
28
28
 
29
29
  Create a modal from a component. The component must implement the <DocsLink href="/reference/admin-ui-api/services/modal-service#dialog">Dialog</DocsLink> interface.
30
30
  Additionally, the component should include templates for the title and the buttons to be
@@ -68,7 +68,7 @@ class MyDialog implements Dialog {
68
68
  ```
69
69
  ### dialog
70
70
 
71
- <MemberInfo kind="method" type={`(config: <a href='/reference/admin-ui-api/services/modal-service#dialogconfig'>DialogConfig</a>`<T>`) => `Observable<T | undefined>``} />
71
+ <MemberInfo kind="method" type={`(config: <a href='/reference/admin-ui-api/services/modal-service#dialogconfig'>DialogConfig</a><T>) => Observable<T | undefined>`} />
72
72
 
73
73
  Displays a modal dialog with the provided title, body and buttons.
74
74
 
@@ -89,7 +89,7 @@ interface Dialog<R = any> {
89
89
 
90
90
  ### resolveWith
91
91
 
92
- <MemberInfo kind="property" type={``(result?: R) => void``} />
92
+ <MemberInfo kind="property" type={`(result?: R) => void`} />
93
93
 
94
94
  Function to be invoked in order to close the dialog when the action is complete.
95
95
  The Observable returned from the .fromComponent() method will emit the value passed
@@ -130,7 +130,7 @@ interface DialogConfig<T> {
130
130
 
131
131
  ### buttons
132
132
 
133
- <MemberInfo kind="property" type={``Array<DialogButtonConfig<T>>``} />
133
+ <MemberInfo kind="property" type={`Array<DialogButtonConfig<T>>`} />
134
134
 
135
135
 
136
136
  ### size
@@ -174,7 +174,7 @@ When true, the "x" icon is shown
174
174
  and clicking it or the mask will close the dialog
175
175
  ### locals
176
176
 
177
- <MemberInfo kind="property" type={``Partial<T>``} />
177
+ <MemberInfo kind="property" type={`Partial<T>`} />
178
178
 
179
179
  Values to be passed directly to the component being instantiated inside the dialog.
180
180
 
@@ -50,7 +50,7 @@ The name of the tab to display in the UI.
50
50
  The priority of the tab. Tabs with a lower priority will be displayed first.
51
51
  ### component
52
52
 
53
- <MemberInfo kind="property" type={``Type<any> | ReturnType<typeof `<a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>`>``} />
53
+ <MemberInfo kind="property" type={`Type<any> | ReturnType<typeof <a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>>`} />
54
54
 
55
55
  The component to render at the route of the tab.
56
56
  ### routeConfig
@@ -45,7 +45,7 @@ will be copied into the Admin UI app, including all TypeScript source files, htm
45
45
  scss style sheets etc.
46
46
  ### ngModules
47
47
 
48
- <MemberInfo kind="property" type={``Array<`<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionsharedmodule'>AdminUiExtensionSharedModule</a> | <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionlazymodule'>AdminUiExtensionLazyModule</a>`>``} />
48
+ <MemberInfo kind="property" type={`Array<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionsharedmodule'>AdminUiExtensionSharedModule</a> | <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionlazymodule'>AdminUiExtensionLazyModule</a>>`} />
49
49
 
50
50
  One or more Angular modules which extend the default Admin UI.
51
51
  ### providers
@@ -48,7 +48,7 @@ Admin UI. This option can be used to override this default build with a differen
48
48
  version, e.g. one pre-compiled with one or more ui extensions.
49
49
  ### adminUiConfig
50
50
 
51
- <MemberInfo kind="property" type={``Partial<`<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>`>``} />
51
+ <MemberInfo kind="property" type={`Partial<<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>>`} />
52
52
 
53
53
  Allows the contents of the `vendure-ui-config.json` file to be set, e.g.
54
54
  for specifying the Vendure GraphQL API host, available UI languages, etc.
@@ -76,7 +76,7 @@ class AdminUiPlugin implements NestModule {
76
76
 
77
77
  ### init
78
78
 
79
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => `Type<`<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>`>``} />
79
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type<<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>>`} />
80
80
 
81
81
  Set the plugin options
82
82
  ### configure
@@ -38,7 +38,7 @@ The route to the asset server.
38
38
  The local directory to which assets will be uploaded when using the <DocsLink href="/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy">LocalAssetStorageStrategy</DocsLink>.
39
39
  ### assetUrlPrefix
40
40
 
41
- <MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`, identifier: string) => string)``} />
41
+ <MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) => string)`} />
42
42
 
43
43
  The complete URL prefix of the asset files. For example, "https://demo.vendure.io/assets/". A
44
44
  function can also be provided to handle more complex cases, such as serving multiple domains
@@ -86,7 +86,7 @@ Defines how previews are generated for a given Asset binary. By default, this us
86
86
  the <DocsLink href="/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy">SharpAssetPreviewStrategy</DocsLink>
87
87
  ### storageStrategyFactory
88
88
 
89
- <MemberInfo kind="property" type={`( options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>`, ) => `<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>` | Promise<`<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>`>``} default={``() => `<a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`} />
89
+ <MemberInfo kind="property" type={`( options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>, ) => <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise<<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>>`} default={`() => <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>`} />
90
90
 
91
91
  A function which can be used to configure an <DocsLink href="/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy">AssetStorageStrategy</DocsLink>. This is useful e.g. if you wish to store your assets
92
92
  using a cloud storage provider. By default, the <DocsLink href="/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy">LocalAssetStorageStrategy</DocsLink> is used.
@@ -29,7 +29,7 @@ interface ImageTransformStrategy extends InjectableStrategy {
29
29
 
30
30
  ### getImageTransformParameters
31
31
 
32
- <MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => `Promise<`<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`> | `<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
32
+ <MemberInfo kind="method" type={`(args: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
33
33
 
34
34
  Given the input parameters, return the parameters which should be used to transform the image.
35
35
 
@@ -166,7 +166,7 @@ class AssetServerPlugin implements NestModule, OnApplicationBootstrap, OnApplica
166
166
 
167
167
  ### init
168
168
 
169
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => `Type<`<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>`>``} />
169
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type<<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>>`} />
170
170
 
171
171
  Set the plugin options.
172
172
  ### constructor
@@ -26,42 +26,42 @@ class LocalAssetStorageStrategy implements AssetStorageStrategy {
26
26
 
27
27
  ### toAbsoluteUrl
28
28
 
29
- <MemberInfo kind="property" type={``((reqest: Request, identifier: string) => string) | undefined``} />
29
+ <MemberInfo kind="property" type={`((reqest: Request, identifier: string) => string) | undefined`} />
30
30
 
31
31
 
32
32
  ### constructor
33
33
 
34
- <MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: `(reqest: Request, identifier: string) => string`) => LocalAssetStorageStrategy`} />
34
+ <MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) => string) => LocalAssetStorageStrategy`} />
35
35
 
36
36
 
37
37
  ### writeFileFromStream
38
38
 
39
- <MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => `Promise<string>``} />
39
+ <MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise<string>`} />
40
40
 
41
41
 
42
42
  ### writeFileFromBuffer
43
43
 
44
- <MemberInfo kind="method" type={`(fileName: string, data: Buffer) => `Promise<string>``} />
44
+ <MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`} />
45
45
 
46
46
 
47
47
  ### fileExists
48
48
 
49
- <MemberInfo kind="method" type={`(fileName: string) => `Promise<boolean>``} />
49
+ <MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`} />
50
50
 
51
51
 
52
52
  ### readFileToBuffer
53
53
 
54
- <MemberInfo kind="method" type={`(identifier: string) => `Promise<Buffer>``} />
54
+ <MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`} />
55
55
 
56
56
 
57
57
  ### readFileToStream
58
58
 
59
- <MemberInfo kind="method" type={`(identifier: string) => `Promise<Stream>``} />
59
+ <MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`} />
60
60
 
61
61
 
62
62
  ### deleteFile
63
63
 
64
- <MemberInfo kind="method" type={`(identifier: string) => `Promise<void>``} />
64
+ <MemberInfo kind="method" type={`(identifier: string) => Promise<void>`} />
65
65
 
66
66
 
67
67
 
@@ -61,7 +61,7 @@ class PresetOnlyStrategy implements ImageTransformStrategy {
61
61
  <MemberInfo kind="method" type={`({
62
62
  input,
63
63
  availablePresets,
64
- }: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => `Promise<`<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`> | `<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
64
+ }: <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#getimagetransformparametersargs'>GetImageTransformParametersArgs</a>) => Promise<<a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>> | <a href='/reference/core-plugins/asset-server-plugin/image-transform-strategy#imagetransformparameters'>ImageTransformParameters</a>`} />
65
65
 
66
66
 
67
67
 
@@ -41,7 +41,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
41
41
 
42
42
  ### constructor
43
43
 
44
- <MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: `(request: Request, identifier: string) => string`) => S3AssetStorageStrategy`} />
44
+ <MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string) => string) => S3AssetStorageStrategy`} />
45
45
 
46
46
 
47
47
  ### init
@@ -51,7 +51,7 @@ class S3AssetStorageStrategy implements AssetStorageStrategy {
51
51
 
52
52
  ### destroy
53
53
 
54
- <MemberInfo kind="property" type={``(() => void | Promise<void>) | undefined``} />
54
+ <MemberInfo kind="property" type={`(() => void | Promise<void>) | undefined`} />
55
55
 
56
56
 
57
57
  ### writeFileFromBuffer
@@ -43,7 +43,7 @@ class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
43
43
 
44
44
  ### generatePreviewImage
45
45
 
46
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => `Promise<Buffer>``} />
46
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`} />
47
47
 
48
48
 
49
49
 
@@ -88,7 +88,7 @@ class DashboardPlugin implements NestModule {
88
88
 
89
89
  ### init
90
90
 
91
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => `Type<`<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>`>``} />
91
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/dashboard-plugin/dashboard-plugin-options#dashboardpluginoptions'>DashboardPluginOptions</a>) => Type<<a href='/reference/core-plugins/dashboard-plugin/#dashboardplugin'>DashboardPlugin</a>>`} />
92
92
 
93
93
  Set the plugin options
94
94
  ### configure
@@ -170,7 +170,7 @@ bulk operation is executed.
170
170
  Configuration of the internal Elasticsearch query.
171
171
  ### customProductMappings
172
172
 
173
- <MemberInfo kind="property" type={``{ [fieldName: string]: CustomMapping< [`<a href='/reference/typescript-api/entities/product#product'>Product</a>, <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`] >; }``} />
173
+ <MemberInfo kind="property" type={`{ [fieldName: string]: CustomMapping< [<a href='/reference/typescript-api/entities/product#product'>Product</a>, <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>] >; }`} />
174
174
 
175
175
  Custom mappings may be defined which will add the defined data to the
176
176
  Elasticsearch index and expose that data via the SearchResult GraphQL type,
@@ -233,7 +233,7 @@ query SearchProducts($input: SearchInput!) {
233
233
  ```
234
234
  ### customProductVariantMappings
235
235
 
236
- <MemberInfo kind="property" type={``{ [fieldName: string]: CustomMapping<[`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`]>; }``} />
236
+ <MemberInfo kind="property" type={`{ [fieldName: string]: CustomMapping<[<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]>; }`} />
237
237
 
238
238
  This config option defines custom mappings which are accessible when the "groupByProduct" and "groupBySKU"
239
239
  input options are both set to `false`. In addition, custom product mappings can be accessed by using
@@ -274,7 +274,7 @@ and also performs optimizations to minimize the amount of work that needs to be
274
274
  the worker.
275
275
  ### hydrateProductRelations
276
276
 
277
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>`<`<a href='/reference/typescript-api/entities/product#product'>Product</a>`>>``} default={`[]`} since="1.3.0" />
277
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><<a href='/reference/typescript-api/entities/product#product'>Product</a>>>`} default={`[]`} since="1.3.0" />
278
278
 
279
279
  Additional product relations that will be fetched from DB while reindexing. This can be used
280
280
  in combination with `customProductMappings` to ensure that the required relations are joined
@@ -297,13 +297,13 @@ before the `product` object is passed to the `valueFn`.
297
297
  ```
298
298
  ### hydrateProductVariantRelations
299
299
 
300
- <MemberInfo kind="property" type={``Array<`<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a>`<`<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>`>>``} default={`[]`} since="1.3.0" />
300
+ <MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>`} default={`[]`} since="1.3.0" />
301
301
 
302
302
  Additional variant relations that will be fetched from DB while reindexing. See
303
303
  `hydrateProductRelations` for more explanation and a usage example.
304
304
  ### extendSearchInputType
305
305
 
306
- <MemberInfo kind="property" type={``{ [name: string]: PrimitiveTypeVariations<GraphQlPrimitive>; }``} default={`{}`} since="1.3.0" />
306
+ <MemberInfo kind="property" type={`{ [name: string]: PrimitiveTypeVariations<GraphQlPrimitive>; }`} default={`{}`} since="1.3.0" />
307
307
 
308
308
  Allows the `SearchInput` type to be extended with new input fields. This allows arbitrary
309
309
  data to be passed in, which can then be used e.g. in the `mapQuery()` function or
@@ -459,7 +459,7 @@ The interval used to group search results into buckets according to price range.
459
459
  ```
460
460
  ### mapQuery
461
461
 
462
- <MemberInfo kind="property" type={``( query: any, input: ElasticSearchInput, searchConfig: DeepRequired<`<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>`>, channelId: `<a href='/reference/typescript-api/common/id#id'>ID</a>, enabledOnly: boolean, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`, ) => any``} />
462
+ <MemberInfo kind="property" type={`( query: any, input: ElasticSearchInput, searchConfig: DeepRequired<<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>>, channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>, enabledOnly: boolean, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ) => any`} />
463
463
 
464
464
  This config option allows the the modification of the whole (already built) search query. This allows
465
465
  for e.g. wildcard / fuzzy searches on the index.
@@ -498,7 +498,7 @@ mapQuery: (query, input, searchConfig, channelId, enabledOnly, ctx) => {
498
498
  ```
499
499
  ### scriptFields
500
500
 
501
- <MemberInfo kind="property" type={``{ [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> }``} since="1.3.0" />
501
+ <MemberInfo kind="property" type={`{ [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> }`} since="1.3.0" />
502
502
 
503
503
  Sets `script_fields` inside the elasticsearch body which allows returning a script evaluation for each hit.
504
504
 
@@ -559,7 +559,7 @@ searchConfig: {
559
559
  ```
560
560
  ### mapSort
561
561
 
562
- <MemberInfo kind="property" type={``(sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput``} default={`{}`} since="1.4.0" />
562
+ <MemberInfo kind="property" type={`(sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput`} default={`{}`} since="1.4.0" />
563
563
 
564
564
  Allows extending the `sort` input of the elasticsearch body as covered in
565
565
  [Elasticsearch sort docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html)
@@ -180,7 +180,7 @@ class ElasticsearchPlugin implements OnApplicationBootstrap {
180
180
 
181
181
  ### init
182
182
 
183
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => `Type<`<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>`>``} />
183
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => Type<<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>>`} />
184
184
 
185
185
 
186
186
 
@@ -20,7 +20,7 @@ class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent
20
20
 
21
21
  ### constructor
22
22
 
23
- <MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>`<InputEvent, Data>`, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>`<T>`, event: `Type<InputEvent>`) => EmailEventHandlerWithAsyncData`} />
23
+ <MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a><InputEvent, Data>, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a><T>, event: Type<InputEvent>) => EmailEventHandlerWithAsyncData`} />
24
24
 
25
25
 
26
26
 
@@ -152,18 +152,18 @@ class EmailEventHandler<T extends string = string, Event extends EventWithContex
152
152
 
153
153
  ### constructor
154
154
 
155
- <MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a>`<T>`, event: `Type<Event>`) => EmailEventHandler`} />
155
+ <MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a><T>, event: Type<Event>) => EmailEventHandler`} />
156
156
 
157
157
 
158
158
  ### filter
159
159
 
160
- <MemberInfo kind="method" type={`(filterFn: `(event: Event) => boolean`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
160
+ <MemberInfo kind="method" type={`(filterFn: (event: Event) => boolean) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
161
161
 
162
162
  Defines a predicate function which is used to determine whether the event will trigger an email.
163
163
  Multiple filter functions may be defined.
164
164
  ### setRecipient
165
165
 
166
- <MemberInfo kind="method" type={`(setRecipientFn: `(event: Event) => string`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
166
+ <MemberInfo kind="method" type={`(setRecipientFn: (event: Event) => string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
167
167
 
168
168
  A function which defines how the recipient email address should be extracted from the incoming event.
169
169
 
@@ -172,35 +172,35 @@ Or with a formatted name (includes unicode support): `'Ноде Майлер <fo
172
172
  Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
173
173
  ### setLanguageCode
174
174
 
175
- <MemberInfo kind="method" type={`(setLanguageCodeFn: `(event: Event) => `<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} since="1.8.0" />
175
+ <MemberInfo kind="method" type={`(setLanguageCodeFn: (event: Event) => <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} since="1.8.0" />
176
176
 
177
177
  A function which allows to override the language of the email. If not defined, the language from the context will be used.
178
178
  ### setTemplateVars
179
179
 
180
- <MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a>`<Event>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
180
+ <MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
181
181
 
182
182
  A function which returns an object hash of variables which will be made available to the Handlebars template
183
183
  and subject line for interpolation.
184
184
  ### setSubject
185
185
 
186
- <MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a>`<Event>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
186
+ <MemberInfo kind="method" type={`(defaultSubject: string | <a href='/reference/core-plugins/email-plugin/email-plugin-types#setsubjectfn'>SetSubjectFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
187
187
 
188
188
  Sets the default subject of the email. The subject string may use Handlebars variables defined by the
189
189
  setTemplateVars() method.
190
190
  ### setFrom
191
191
 
192
- <MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
192
+ <MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
193
193
 
194
194
  Sets the default from field of the email. The from string may use Handlebars variables defined by the
195
195
  setTemplateVars() method.
196
196
  ### setOptionalAddressFields
197
197
 
198
- <MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a>`<Event>`) => `} since="1.1.0" />
198
+ <MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a><Event>) => `} since="1.1.0" />
199
199
 
200
200
  A function which allows <DocsLink href="/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields">OptionalAddressFields</DocsLink> to be specified such as "cc" and "bcc".
201
201
  ### setMetadata
202
202
 
203
- <MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a>`<Event>`) => `} since="3.1.0" />
203
+ <MemberInfo kind="method" type={`(optionalSetMetadataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setmetadatafn'>SetMetadataFn</a><Event>) => `} since="3.1.0" />
204
204
 
205
205
  A function which allows <DocsLink href="/reference/core-plugins/email-plugin/email-plugin-types#emailmetadata">EmailMetadata</DocsLink> to be specified for the email. This can be used
206
206
  to store arbitrary data about the email which can be used for tracking or other purposes.
@@ -225,7 +225,7 @@ It will be exposed in the <DocsLink href="/reference/core-plugins/email-plugin/e
225
225
  the order in another available way.
226
226
  ### setAttachments
227
227
 
228
- <MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a>`<Event>`) => `} />
228
+ <MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a><Event>) => `} />
229
229
 
230
230
  Defines one or more files to be attached to the email. An attachment can be specified
231
231
  as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
@@ -253,13 +253,13 @@ const testAttachmentHandler = new EmailEventListener('activate-voucher')
253
253
  ```
254
254
  ### addTemplate
255
255
 
256
- <MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
256
+ <MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
257
257
 
258
258
  Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
259
259
  templates for channels or languageCodes other than the default.
260
260
  ### loadData
261
261
 
262
- <MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a>`<Event, R>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a>`<R, T, Event, `<a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>EventWithAsyncData</a>`<Event, R>>``} />
262
+ <MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a><Event, R>) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a><R, T, Event, <a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>EventWithAsyncData</a><Event, R>>`} />
263
263
 
264
264
  Allows data to be loaded asynchronously which can then be used as template variables.
265
265
  The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
@@ -285,7 +285,7 @@ new EmailEventListener('order-confirmation')
285
285
  ```
286
286
  ### setMockEvent
287
287
 
288
- <MemberInfo kind="method" type={`(event: `Omit<Event, 'ctx' | 'data'>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
288
+ <MemberInfo kind="method" type={`(event: Omit<Event, 'ctx' | 'data'>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
289
289
 
290
290
  Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
291
291
  from this handler, which is useful when developing the email templates.
@@ -29,7 +29,7 @@ class EmailEventListener<T extends string> {
29
29
 
30
30
  ### on
31
31
 
32
- <MemberInfo kind="method" type={`(event: `Type<Event>`) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<T, Event>``} />
32
+ <MemberInfo kind="method" type={`(event: Type<Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
33
33
 
34
34
  Defines the event to listen for.
35
35
 
@@ -25,12 +25,12 @@ interface EmailGenerator<T extends string = any, E extends VendureEvent = any> e
25
25
 
26
26
  ### onInit
27
27
 
28
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => `void | Promise<void>``} />
28
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => void | Promise<void>`} />
29
29
 
30
30
  Any necessary setup can be performed here.
31
31
  ### generate
32
32
 
33
- <MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => `Pick<`<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>`, 'from' | 'subject' | 'body'>``} />
33
+ <MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => Pick<<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, 'from' | 'subject' | 'body'>`} />
34
34
 
35
35
  Given a subject and body from an email template, this method generates the final
36
36
  interpolated email text.
@@ -39,12 +39,12 @@ An optional TemplateLoader which can be used to load templates from a custom loc
39
39
  The default uses the FileBasedTemplateLoader which loads templates from `<project root>/vendure/email/templates`
40
40
  ### transport
41
41
 
42
- <MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | (( injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`, ) => `<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>` | Promise<`<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>`>)``} />
42
+ <MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | (( injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ) => <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | Promise<<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>>)`} />
43
43
 
44
44
  Configures how the emails are sent.
45
45
  ### handlers
46
46
 
47
- <MemberInfo kind="property" type={``Array<`<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`<string, any>>``} />
47
+ <MemberInfo kind="property" type={`Array<<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><string, any>>`} />
48
48
 
49
49
  An array of <DocsLink href="/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler">EmailEventHandler</DocsLink>s which define which Vendure events will trigger
50
50
  emails, and how those emails are generated.
@@ -60,7 +60,7 @@ interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialize
60
60
 
61
61
  ### attachments
62
62
 
63
- <MemberInfo kind="property" type={``Array<Type extends 'serialized' ? SerializedAttachment : Attachment>``} />
63
+ <MemberInfo kind="property" type={`Array<Type extends 'serialized' ? SerializedAttachment : Attachment>`} />
64
64
 
65
65
 
66
66
  ### cc
@@ -52,7 +52,7 @@ interface EmailSender extends InjectableStrategy {
52
52
 
53
53
  ### send
54
54
 
55
- <MemberInfo kind="property" type={`(email: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, options: <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>`) => void | Promise<void>``} />
55
+ <MemberInfo kind="property" type={`(email: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, options: <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>) => void | Promise<void>`} />
56
56
 
57
57
 
58
58
 
@@ -286,7 +286,7 @@ class EmailPlugin implements OnApplicationBootstrap, OnApplicationShutdown, Nest
286
286
 
287
287
  ### init
288
288
 
289
- <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a> | <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailplugindevmodeoptions'>EmailPluginDevModeOptions</a>) => `Type<`<a href='/reference/core-plugins/email-plugin/#emailplugin'>EmailPlugin</a>`>``} />
289
+ <MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a> | <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailplugindevmodeoptions'>EmailPluginDevModeOptions</a>) => Type<<a href='/reference/core-plugins/email-plugin/#emailplugin'>EmailPlugin</a>>`} />
290
290
 
291
291
 
292
292
  ### onApplicationShutdown