@vendure/docs 0.0.0-202601201656 → 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 (378) hide show
  1. package/dist/manifest.d.ts +1 -2
  2. package/dist/manifest.d.ts.map +1 -1
  3. package/dist/manifest.js +55 -1
  4. package/dist/manifest.js.map +1 -1
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  6. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  7. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  8. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  9. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
  10. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
  11. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  12. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  13. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  14. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  15. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  16. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  17. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  18. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  20. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  21. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  22. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  23. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  24. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  26. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  27. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  28. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  29. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
  30. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
  31. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  32. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  33. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  34. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  35. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
  36. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
  37. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  38. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  39. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  40. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  41. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  47. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  48. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  49. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  50. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  51. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  52. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  53. package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
  54. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  55. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  56. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
  57. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  58. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  59. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  60. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  61. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  62. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  63. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  64. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  65. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  66. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  67. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  68. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  69. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
  70. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  71. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  72. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  73. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
  74. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  75. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  76. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  77. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  78. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  79. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  80. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  81. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  82. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  83. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  84. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  85. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  86. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  87. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  88. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
  89. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  90. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  91. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  92. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  93. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  94. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  95. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  96. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  97. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  98. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  99. package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
  100. package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
  101. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
  102. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
  103. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  104. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  105. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  106. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  107. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  108. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  109. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  110. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  114. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  115. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  116. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  117. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  118. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  119. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  120. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  121. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  122. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  123. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  124. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  125. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  126. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  127. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  128. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  129. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  130. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  131. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  132. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  133. package/docs/reference/dashboard/page-layout/page.mdx +3 -3
  134. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  135. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  136. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  137. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  138. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  139. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  140. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  141. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
  142. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  143. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  144. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  145. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  146. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  147. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  148. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  149. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  150. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  151. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  152. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  153. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
  154. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  155. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  156. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  157. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  158. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  159. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  160. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  161. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  162. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  163. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
  164. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  165. package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
  166. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
  167. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
  168. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  169. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  170. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  171. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
  172. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  173. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  174. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  175. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  176. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  177. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
  178. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  179. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  180. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  181. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  182. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  183. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  184. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  185. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  186. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  188. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  189. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  190. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  191. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  192. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  194. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  195. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  196. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  197. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  199. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  200. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  201. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  202. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  204. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  205. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  206. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  207. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  208. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  209. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  210. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  211. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  212. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  213. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  215. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  216. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  217. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  220. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  221. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  224. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  225. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  227. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  228. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  229. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  230. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  231. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  232. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  233. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  234. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  235. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  236. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  237. package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
  238. package/docs/reference/typescript-api/events/event-types.mdx +30 -30
  239. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
  240. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  241. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  242. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  243. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  244. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  245. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  246. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  247. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  248. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  249. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  250. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  251. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  252. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  253. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  254. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  255. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
  256. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  257. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  258. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  259. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  260. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
  261. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  262. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  263. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  264. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  266. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  267. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  268. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  270. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  271. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  273. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  274. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  275. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  276. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  277. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  278. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  279. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  280. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  281. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
  282. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
  283. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
  284. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  285. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  286. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  287. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  288. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  289. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  290. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  291. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  292. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  293. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  294. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  295. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  296. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  297. package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
  298. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
  299. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  300. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  301. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  302. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
  303. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  304. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  305. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  306. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  307. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  308. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  309. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  310. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  311. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  312. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  313. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  314. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  315. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  316. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  317. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  318. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  319. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  320. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  321. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  322. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  323. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  324. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  325. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  326. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  327. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  328. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  329. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  330. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  331. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  332. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  333. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  334. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  335. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  336. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  337. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  338. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  339. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  340. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  341. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  342. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  343. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  344. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  345. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  346. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  347. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  348. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  349. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  350. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  351. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  352. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  353. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
  354. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
  355. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
  356. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  357. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  358. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
  359. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  360. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  361. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  362. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  363. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  364. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  365. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  366. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  367. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  368. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  369. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  370. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  371. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  372. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  373. package/package.json +2 -2
  374. package/docs/reference/admin-ui-api/index.mdx +0 -4
  375. package/docs/reference/dashboard/index.mdx +0 -4
  376. package/docs/reference/graphql-api/admin/_index.mdx +0 -4
  377. package/docs/reference/graphql-api/shop/_index.mdx +0 -4
  378. package/docs/reference/typescript-api/_index.mdx +0 -4
@@ -61,7 +61,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
61
61
 
62
62
  ### transformControlValueAccessorValue
63
63
 
64
- <MemberInfo kind="property" type={`(value: FacetValueFragment[]) =&#62; any[]`} />
64
+ <MemberInfo kind="property" type={`(value: FacetValueFragment[]) => any[]`} />
65
65
 
66
66
 
67
67
  ### searchInput$
@@ -76,7 +76,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
76
76
 
77
77
  ### searchResults$
78
78
 
79
- <MemberInfo kind="property" type={`Observable&#60;FacetValueFragment[]&#62;`} />
79
+ <MemberInfo kind="property" type={`Observable<FacetValueFragment[]>`} />
80
80
 
81
81
 
82
82
  ### selectedIds$
@@ -86,12 +86,12 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
86
86
 
87
87
  ### onChangeFn
88
88
 
89
- <MemberInfo kind="property" type={`(val: any) =&#62; void`} />
89
+ <MemberInfo kind="property" type={`(val: any) => void`} />
90
90
 
91
91
 
92
92
  ### onTouchFn
93
93
 
94
- <MemberInfo kind="property" type={`() =&#62; void`} />
94
+ <MemberInfo kind="property" type={`() => void`} />
95
95
 
96
96
 
97
97
  ### disabled
@@ -101,7 +101,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
101
101
 
102
102
  ### value
103
103
 
104
- <MemberInfo kind="property" type={`Array&#60;string | FacetValueFragment&#62;`} />
104
+ <MemberInfo kind="property" type={`Array<string | FacetValueFragment>`} />
105
105
 
106
106
 
107
107
  ### constructor
@@ -146,7 +146,7 @@ class FacetValueSelectorComponent implements OnInit, OnDestroy, ControlValueAcce
146
146
 
147
147
  ### writeValue
148
148
 
149
- <MemberInfo kind="method" type={`(obj: string | FacetValueFragment[] | Array&#60;string | number&#62; | null) => void`} />
149
+ <MemberInfo kind="method" type={`(obj: string | FacetValueFragment[] | Array<string | number> | null) => void`} />
150
150
 
151
151
 
152
152
 
@@ -62,7 +62,7 @@ class ObjectTreeComponent implements OnChanges {
62
62
 
63
63
  ### entries
64
64
 
65
- <MemberInfo kind="property" type={`Array&#60;{ key: string; value: any }&#62;`} />
65
+ <MemberInfo kind="property" type={`Array<{ key: string; value: any }>`} />
66
66
 
67
67
 
68
68
  ### constructor
@@ -46,7 +46,7 @@ class ProductVariantSelectorComponent implements OnInit {
46
46
 
47
47
  ### searchResults$
48
48
 
49
- <MemberInfo kind="property" type={`Observable&#60;ProductSelectorSearchQuery['search']['items']&#62;`} />
49
+ <MemberInfo kind="property" type={`Observable<ProductSelectorSearchQuery['search']['items']>`} />
50
50
 
51
51
 
52
52
  ### productSelected
@@ -54,12 +54,12 @@ class RichTextEditorComponent implements ControlValueAccessor, AfterViewInit, On
54
54
 
55
55
  ### onChange
56
56
 
57
- <MemberInfo kind="property" type={`(val: any) =&#62; void`} />
57
+ <MemberInfo kind="property" type={`(val: any) => void`} />
58
58
 
59
59
 
60
60
  ### onTouch
61
61
 
62
- <MemberInfo kind="property" type={`() =&#62; void`} />
62
+ <MemberInfo kind="property" type={`() => void`} />
63
63
 
64
64
 
65
65
  ### constructor
@@ -50,7 +50,7 @@ class ZoneSelectorComponent implements ControlValueAccessor {
50
50
 
51
51
  ### transformControlValueAccessorValue
52
52
 
53
- <MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined) =&#62; any`} />
53
+ <MemberInfo kind="property" type={`(value: <a href='/reference/typescript-api/entities/zone#zone'>Zone</a> | undefined) => any`} />
54
54
 
55
55
 
56
56
  ### selectedId$
@@ -60,12 +60,12 @@ class ZoneSelectorComponent implements ControlValueAccessor {
60
60
 
61
61
  ### onChangeFn
62
62
 
63
- <MemberInfo kind="property" type={`(val: any) =&#62; void`} />
63
+ <MemberInfo kind="property" type={`(val: any) => void`} />
64
64
 
65
65
 
66
66
  ### onTouchFn
67
67
 
68
- <MemberInfo kind="property" type={`() =&#62; void`} />
68
+ <MemberInfo kind="property" type={`() => void`} />
69
69
 
70
70
 
71
71
  ### disabled
@@ -27,7 +27,7 @@ interface CustomDetailComponentConfig {
27
27
 
28
28
  ### component
29
29
 
30
- <MemberInfo kind="property" type={`Type&#60;<a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a>&#62;`} />
30
+ <MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a>>`} />
31
31
 
32
32
 
33
33
  ### providers
@@ -22,7 +22,7 @@ interface CustomDetailComponent {
22
22
 
23
23
  ### entity$
24
24
 
25
- <MemberInfo kind="property" type={`Observable&#60;any&#62;`} />
25
+ <MemberInfo kind="property" type={`Observable<any>`} />
26
26
 
27
27
 
28
28
  ### detailForm
@@ -31,24 +31,24 @@ interface HistoryEntryComponent {
31
31
  The HistoryEntry data.
32
32
  ### getDisplayType
33
33
 
34
- <MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) =&#62; TimelineDisplayType`} />
34
+ <MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => TimelineDisplayType`} />
35
35
 
36
36
  Defines whether this entry is highlighted with a "success", "error" etc. color.
37
37
  ### isFeatured
38
38
 
39
- <MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) =&#62; boolean`} />
39
+ <MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => boolean`} />
40
40
 
41
41
  Featured entries are always expanded. Non-featured entries start of collapsed and can be clicked
42
42
  to expand.
43
43
  ### getName
44
44
 
45
- <MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) =&#62; string | undefined`} />
45
+ <MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => string | undefined`} />
46
46
 
47
47
  Returns the name of the person who did this action. For example, it could be the Customer's name
48
48
  or "Administrator".
49
49
  ### getIconShape
50
50
 
51
- <MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) =&#62; string | string[] | undefined`} />
51
+ <MemberInfo kind="property" type={`(entry: TimelineHistoryEntry) => string | string[] | undefined`} />
52
52
 
53
53
  Optional Clarity icon shape to display with the entry. Examples: `'note'`, `['success-standard', 'is-solid']`
54
54
 
@@ -26,7 +26,7 @@ interface HistoryEntryConfig {
26
26
  The type should correspond to the custom HistoryEntryType string.
27
27
  ### component
28
28
 
29
- <MemberInfo kind="property" type={`Type&#60;<a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a>&#62;`} />
29
+ <MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-history-entry-components/history-entry-component#historyentrycomponent'>HistoryEntryComponent</a>>`} />
30
30
 
31
31
  The component to be rendered for this history entry type.
32
32
 
@@ -41,7 +41,7 @@ class BooleanFormInputComponent implements FormInputComponent {
41
41
 
42
42
  ### config
43
43
 
44
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'boolean-form-input'&#62;`} />
44
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'boolean-form-input'>`} />
45
45
 
46
46
 
47
47
 
@@ -177,12 +177,12 @@ class CombinationModeFormInputComponent implements FormInputComponent, OnInit {
177
177
 
178
178
  ### config
179
179
 
180
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'combination-mode-form-input'&#62;`} />
180
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'combination-mode-form-input'>`} />
181
181
 
182
182
 
183
183
  ### selectable$
184
184
 
185
- <MemberInfo kind="property" type={`Observable&#60;boolean&#62;`} />
185
+ <MemberInfo kind="property" type={`Observable<boolean>`} />
186
186
 
187
187
 
188
188
  ### constructor
@@ -249,12 +249,12 @@ class CurrencyFormInputComponent implements FormInputComponent {
249
249
 
250
250
  ### currencyCode$
251
251
 
252
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>&#62;`} />
252
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/currency-code#currencycode'>CurrencyCode</a>>`} />
253
253
 
254
254
 
255
255
  ### config
256
256
 
257
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'currency-form-input'&#62;`} />
257
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'currency-form-input'>`} />
258
258
 
259
259
 
260
260
  ### constructor
@@ -305,17 +305,17 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
305
305
 
306
306
  ### formControl
307
307
 
308
- <MemberInfo kind="property" type={`FormControl&#60;string | { id: string }&#62;`} />
308
+ <MemberInfo kind="property" type={`FormControl<string | { id: string }>`} />
309
309
 
310
310
 
311
311
  ### customerGroups$
312
312
 
313
- <MemberInfo kind="property" type={`Observable&#60;GetCustomerGroupsQuery['customerGroups']['items']&#62;`} />
313
+ <MemberInfo kind="property" type={`Observable<GetCustomerGroupsQuery['customerGroups']['items']>`} />
314
314
 
315
315
 
316
316
  ### config
317
317
 
318
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'customer-group-form-input'&#62;`} />
318
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'customer-group-form-input'>`} />
319
319
 
320
320
 
321
321
  ### constructor
@@ -330,7 +330,7 @@ class CustomerGroupFormInputComponent implements FormInputComponent, OnInit {
330
330
 
331
331
  ### selectGroup
332
332
 
333
- <MemberInfo kind="method" type={`(group: ItemOf&#60;GetCustomerGroupsQuery, 'customerGroups'&#62;) => `} />
333
+ <MemberInfo kind="method" type={`(group: ItemOf<GetCustomerGroupsQuery, 'customerGroups'>) => `} />
334
334
 
335
335
 
336
336
  ### compareWith
@@ -383,7 +383,7 @@ class DateFormInputComponent implements FormInputComponent {
383
383
 
384
384
  ### config
385
385
 
386
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'date-form-input'&#62;`} />
386
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'date-form-input'>`} />
387
387
 
388
388
 
389
389
  ### min
@@ -513,7 +513,7 @@ class NumberFormInputComponent implements FormInputComponent {
513
513
 
514
514
  ### config
515
515
 
516
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'number-form-input'&#62;`} />
516
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'number-form-input'>`} />
517
517
 
518
518
 
519
519
  ### prefix
@@ -635,17 +635,17 @@ class ProductSelectorFormInputComponent implements FormInputComponent, OnInit {
635
635
 
636
636
  ### formControl
637
637
 
638
- <MemberInfo kind="property" type={`FormControl&#60;Array&#60;string | { id: string }&#62;&#62;`} />
638
+ <MemberInfo kind="property" type={`FormControl<Array<string | { id: string }>>`} />
639
639
 
640
640
 
641
641
  ### config
642
642
 
643
- <MemberInfo kind="property" type={`DefaultFormComponentUiConfig&#60;'product-selector-form-input'&#62;`} />
643
+ <MemberInfo kind="property" type={`DefaultFormComponentUiConfig<'product-selector-form-input'>`} />
644
644
 
645
645
 
646
646
  ### selection$
647
647
 
648
- <MemberInfo kind="property" type={`Observable&#60;Array&#60;GetProductVariantQuery['productVariant']&#62;&#62;`} />
648
+ <MemberInfo kind="property" type={`Observable<Array<GetProductVariantQuery['productVariant']>>`} />
649
649
 
650
650
 
651
651
  ### constructor
@@ -757,7 +757,7 @@ class RichTextFormInputComponent implements FormInputComponent {
757
757
 
758
758
  ### config
759
759
 
760
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'rich-text-form-input'&#62;`} />
760
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'rich-text-form-input'>`} />
761
761
 
762
762
 
763
763
 
@@ -808,12 +808,12 @@ class SelectFormInputComponent implements FormInputComponent, OnInit {
808
808
 
809
809
  ### config
810
810
 
811
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'select-form-input'&#62; &#38; CustomFieldConfigFragment`} />
811
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'select-form-input'> &#38; CustomFieldConfigFragment`} />
812
812
 
813
813
 
814
814
  ### uiLanguage$
815
815
 
816
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>&#62;`} />
816
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
817
817
 
818
818
 
819
819
  ### options
@@ -887,12 +887,12 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
887
887
 
888
888
  ### config
889
889
 
890
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'struct-form-input'&#62;`} />
890
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'struct-form-input'>`} />
891
891
 
892
892
 
893
893
  ### uiLanguage$
894
894
 
895
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>&#62;`} />
895
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
896
896
 
897
897
 
898
898
  ### structFormGroup
@@ -902,7 +902,7 @@ class StructFormInputComponent implements FormInputComponent, OnInit, OnDestroy
902
902
 
903
903
  ### fields
904
904
 
905
- <MemberInfo kind="property" type={`Array&#60;{ def: StructCustomFieldFragment['fields'][number]; formControl: FormControl; }&#62;`} />
905
+ <MemberInfo kind="property" type={`Array<{ def: StructCustomFieldFragment['fields'][number]; formControl: FormControl; }>`} />
906
906
 
907
907
 
908
908
  ### constructor
@@ -964,7 +964,7 @@ class TextFormInputComponent implements FormInputComponent {
964
964
 
965
965
  ### config
966
966
 
967
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'text-form-input'&#62;`} />
967
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'text-form-input'>`} />
968
968
 
969
969
 
970
970
  ### prefix
@@ -1020,7 +1020,7 @@ class TextareaFormInputComponent implements FormInputComponent {
1020
1020
 
1021
1021
  ### config
1022
1022
 
1023
- <MemberInfo kind="property" type={`DefaultFormComponentConfig&#60;'textarea-form-input'&#62;`} />
1023
+ <MemberInfo kind="property" type={`DefaultFormComponentConfig<'textarea-form-input'>`} />
1024
1024
 
1025
1025
 
1026
1026
  ### spellcheck
@@ -66,5 +66,5 @@ Parameters
66
66
 
67
67
  ### component
68
68
 
69
- <MemberInfo kind="parameter" type={`Type&#60;<a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>&#62;`} />
69
+ <MemberInfo kind="parameter" type={`Type<<a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>>`} />
70
70
 
@@ -33,7 +33,7 @@ The location in the UI where the custom component should be placed.
33
33
  The column in the table where the custom component should be placed.
34
34
  ### component
35
35
 
36
- <MemberInfo kind="property" type={`Type&#60;<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a>&#62;`} />
36
+ <MemberInfo kind="property" type={`Type<<a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a>>`} />
37
37
 
38
38
  The component to render in the table cell. This component should implement the
39
39
  <a href='/reference/admin-ui-api/custom-table-components/custom-column-component#customcolumncomponent'>CustomColumnComponent</a> interface.
@@ -23,7 +23,7 @@ interface DashboardWidgetConfig {
23
23
 
24
24
  ### loadComponent
25
25
 
26
- <MemberInfo kind="property" type={`() =&#62; Promise&#60;Type&#60;any&#62;&#62; | Type&#60;any&#62;`} />
26
+ <MemberInfo kind="property" type={`() => Promise<Type<any>> | Type<any>`} />
27
27
 
28
28
  Used to specify the widget component. Supports both eager- and lazy-loading.
29
29
 
@@ -24,7 +24,7 @@ class IfMultichannelDirective extends IfDirectiveBase<[]> {
24
24
  constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, dataService: DataService)
25
25
  }
26
26
  ```
27
- * Extends: <code>IfDirectiveBase&#60;[]&#62;</code>
27
+ * Extends: <code>IfDirectiveBase<[]></code>
28
28
 
29
29
 
30
30
 
@@ -32,7 +32,7 @@ class IfMultichannelDirective extends IfDirectiveBase<[]> {
32
32
 
33
33
  ### constructor
34
34
 
35
- <MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef&#60;any&#62;, dataService: <a href='/reference/admin-ui-api/services/data-service#dataservice'>DataService</a>) => IfMultichannelDirective`} />
35
+ <MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, dataService: <a href='/reference/admin-ui-api/services/data-service#dataservice'>DataService</a>) => IfMultichannelDirective`} />
36
36
 
37
37
 
38
38
 
@@ -26,7 +26,7 @@ class IfPermissionsDirective extends IfDirectiveBase<Array<Permission[] | null>>
26
26
  constructor(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService)
27
27
  }
28
28
  ```
29
- * Extends: <code>IfDirectiveBase&#60;Array&#60;<a href='/reference/typescript-api/common/permission#permission'>Permission</a>[] | null&#62;&#62;</code>
29
+ * Extends: <code>IfDirectiveBase<Array<<a href='/reference/typescript-api/common/permission#permission'>Permission</a>[] | null>></code>
30
30
 
31
31
 
32
32
 
@@ -34,7 +34,7 @@ class IfPermissionsDirective extends IfDirectiveBase<Array<Permission[] | null>>
34
34
 
35
35
  ### constructor
36
36
 
37
- <MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef&#60;any&#62;, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService) => IfPermissionsDirective`} />
37
+ <MemberInfo kind="method" type={`(_viewContainer: ViewContainerRef, templateRef: TemplateRef<any>, changeDetectorRef: ChangeDetectorRef, permissionsService: PermissionsService) => IfPermissionsDirective`} />
38
38
 
39
39
 
40
40
 
@@ -74,17 +74,17 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
74
74
 
75
75
  ### entity$
76
76
 
77
- <MemberInfo kind="property" type={`Observable&#60;Entity&#62;`} />
77
+ <MemberInfo kind="property" type={`Observable<Entity>`} />
78
78
 
79
79
 
80
80
  ### availableLanguages$
81
81
 
82
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]&#62;`} />
82
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]>`} />
83
83
 
84
84
 
85
85
  ### languageCode$
86
86
 
87
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>&#62;`} />
87
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
88
88
 
89
89
 
90
90
  ### languageCode
@@ -94,7 +94,7 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
94
94
 
95
95
  ### isNew$
96
96
 
97
- <MemberInfo kind="property" type={`Observable&#60;boolean&#62;`} />
97
+ <MemberInfo kind="property" type={`Observable<boolean>`} />
98
98
 
99
99
 
100
100
  ### id
@@ -149,12 +149,12 @@ class BaseDetailComponent<Entity extends { id: string; updatedAt?: string }> imp
149
149
 
150
150
  ### setCustomFieldFormValues
151
151
 
152
- <MemberInfo kind="method" type={`(customFields: <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[], formGroup: AbstractControl | null, entity: T, currentTranslation?: TranslationOf&#60;T&#62;) => `} />
152
+ <MemberInfo kind="method" type={`(customFields: <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[], formGroup: AbstractControl | null, entity: T, currentTranslation?: TranslationOf<T>) => `} />
153
153
 
154
154
 
155
155
  ### getCustomFieldConfig
156
156
 
157
- <MemberInfo kind="method" type={`(key: Exclude&#60;keyof <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>, '__typename'&#62;) => <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]`} />
157
+ <MemberInfo kind="method" type={`(key: Exclude<keyof <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>, '__typename'>) => <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]`} />
158
158
 
159
159
 
160
160
  ### setQueryParam
@@ -45,7 +45,7 @@ class BaseEntityResolver<T> {
45
45
 
46
46
  ### constructor
47
47
 
48
- <MemberInfo kind="method" type={`(router: Router, emptyEntity: T, entityStream: (id: string) =&#62; Observable&#60;T | null | undefined&#62;) => BaseEntityResolver`} />
48
+ <MemberInfo kind="method" type={`(router: Router, emptyEntity: T, entityStream: (id: string) => Observable<T | null | undefined>) => BaseEntityResolver`} />
49
49
 
50
50
 
51
51
 
@@ -61,27 +61,27 @@ class BaseListComponent<ResultType, ItemType, VariableType extends Record<string
61
61
 
62
62
  ### result$
63
63
 
64
- <MemberInfo kind="property" type={`Observable&#60;ResultType&#62;`} />
64
+ <MemberInfo kind="property" type={`Observable<ResultType>`} />
65
65
 
66
66
 
67
67
  ### items$
68
68
 
69
- <MemberInfo kind="property" type={`Observable&#60;ItemType[]&#62;`} />
69
+ <MemberInfo kind="property" type={`Observable<ItemType[]>`} />
70
70
 
71
71
 
72
72
  ### totalItems$
73
73
 
74
- <MemberInfo kind="property" type={`Observable&#60;number&#62;`} />
74
+ <MemberInfo kind="property" type={`Observable<number>`} />
75
75
 
76
76
 
77
77
  ### itemsPerPage$
78
78
 
79
- <MemberInfo kind="property" type={`Observable&#60;number&#62;`} />
79
+ <MemberInfo kind="property" type={`Observable<number>`} />
80
80
 
81
81
 
82
82
  ### currentPage$
83
83
 
84
- <MemberInfo kind="property" type={`Observable&#60;number&#62;`} />
84
+ <MemberInfo kind="property" type={`Observable<number>`} />
85
85
 
86
86
 
87
87
  ### destroy$
@@ -106,12 +106,12 @@ class BaseListComponent<ResultType, ItemType, VariableType extends Record<string
106
106
 
107
107
  ### setQueryFn
108
108
 
109
- <MemberInfo kind="method" type={`(listQueryFn: ListQueryFn&#60;ResultType&#62;, mappingFn: MappingFn&#60;ItemType, ResultType&#62;, onPageChangeFn?: OnPageChangeFn&#60;VariableType&#62;, defaults?: { take: number; skip: number }) => `} />
109
+ <MemberInfo kind="method" type={`(listQueryFn: ListQueryFn<ResultType>, mappingFn: MappingFn<ItemType, ResultType>, onPageChangeFn?: OnPageChangeFn<VariableType>, defaults?: { take: number; skip: number }) => `} />
110
110
 
111
111
  Sets the fetch function for the list being implemented.
112
112
  ### refreshListOnChanges
113
113
 
114
- <MemberInfo kind="method" type={`(streams: Array&#60;Observable&#60;any&#62;&#62;) => `} />
114
+ <MemberInfo kind="method" type={`(streams: Array<Observable<any>>) => `} />
115
115
 
116
116
  Accepts a list of Observables which will trigger a refresh of the list when any of them emit.
117
117
  ### setPageNumber
@@ -126,7 +126,7 @@ Sets the current page number in the url.
126
126
  Sets the number of items per page in the url.
127
127
  ### setVisibleColumns
128
128
 
129
- <MemberInfo kind="method" type={`(columns: Array&#60;DataTable2ColumnComponent&#60;any&#62;&#62;) => `} />
129
+ <MemberInfo kind="method" type={`(columns: Array<DataTable2ColumnComponent<any>>) => `} />
130
130
 
131
131
 
132
132
  ### refresh
@@ -47,5 +47,5 @@ Parameters
47
47
 
48
48
  ### config
49
49
 
50
- <MemberInfo kind="parameter" type={`{ component: Type&#60;<a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a>&#60;T, Field&#62;&#62;; query: T; entityKey: R; getBreadcrumbs?: (entity: ResultOf&#60;T&#62;[R]) =&#62; BreadcrumbValue; variables?: T extends TypedDocumentNode&#60;any, infer V&#62; ? Omit&#60;V, 'id'&#62; : never; }`} />
50
+ <MemberInfo kind="parameter" type={`{ component: Type<<a href='/reference/admin-ui-api/list-detail-views/typed-base-detail-component#typedbasedetailcomponent'>TypedBaseDetailComponent</a><T, Field>>; query: T; entityKey: R; getBreadcrumbs?: (entity: ResultOf<T>[R]) => BreadcrumbValue; variables?: T extends TypedDocumentNode<any, infer V> ? Omit<V, 'id'> : never; }`} />
51
51
 
@@ -19,7 +19,7 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
19
19
  init() => ;
20
20
  }
21
21
  ```
22
- * Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a>&#60;NonNullable&#60;ResultOf&#60;T&#62;[Field]&#62;&#62;</code>
22
+ * Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-detail-component#basedetailcomponent'>BaseDetailComponent</a><NonNullable<ResultOf<T>[Field]>></code>
23
23
 
24
24
 
25
25
 
@@ -27,12 +27,12 @@ class TypedBaseDetailComponent<T extends TypedDocumentNode<any, any>, Field exte
27
27
 
28
28
  ### result$
29
29
 
30
- <MemberInfo kind="property" type={`Observable&#60;ResultOf&#60;T&#62;&#62;`} />
30
+ <MemberInfo kind="property" type={`Observable<ResultOf<T>>`} />
31
31
 
32
32
 
33
33
  ### entity
34
34
 
35
- <MemberInfo kind="property" type={`ResultOf&#60;T&#62;[Field]`} />
35
+ <MemberInfo kind="property" type={`ResultOf<T>[Field]`} />
36
36
 
37
37
 
38
38
  ### constructor
@@ -35,7 +35,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
35
35
  getCustomFieldConfig(key: Exclude<keyof CustomFields, '__typename'> | string) => CustomFieldConfig[];
36
36
  }
37
37
  ```
38
- * Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a>&#60;ResultOf&#60;T&#62;, ItemOf&#60;ResultOf&#60;T&#62;, Field&#62;, VariablesOf&#60;T&#62;&#62;</code>
38
+ * Extends: <code><a href='/reference/admin-ui-api/list-detail-views/base-list-component#baselistcomponent'>BaseListComponent</a><ResultOf<T>, ItemOf<ResultOf<T>, Field>, VariablesOf<T>></code>
39
39
 
40
40
 
41
41
  * Implements: <code>OnInit</code>
@@ -46,12 +46,12 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
46
46
 
47
47
  ### availableLanguages$
48
48
 
49
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]&#62;`} />
49
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>[]>`} />
50
50
 
51
51
 
52
52
  ### contentLanguage$
53
53
 
54
- <MemberInfo kind="property" type={`Observable&#60;<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>&#62;`} />
54
+ <MemberInfo kind="property" type={`Observable<<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>>`} />
55
55
 
56
56
 
57
57
  ### dataService
@@ -91,7 +91,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
91
91
 
92
92
  ### configure
93
93
 
94
- <MemberInfo kind="method" type={`(config: { document: T; getItems: (data: ResultOf&#60;T&#62;) =&#62; { items: Array&#60;ItemOf&#60;ResultOf&#60;T&#62;, Field&#62;&#62;; totalItems: number }; setVariables?: (skip: number, take: number) =&#62; VariablesOf&#60;T&#62;; refreshListOnChanges?: Array&#60;Observable&#60;any&#62;&#62;; }) => `} />
94
+ <MemberInfo kind="method" type={`(config: { document: T; getItems: (data: ResultOf<T>) => { items: Array<ItemOf<ResultOf<T>, Field>>; totalItems: number }; setVariables?: (skip: number, take: number) => VariablesOf<T>; refreshListOnChanges?: Array<Observable<any>>; }) => `} />
95
95
 
96
96
 
97
97
  ### ngOnInit
@@ -101,12 +101,12 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
101
101
 
102
102
  ### createFilterCollection
103
103
 
104
- <MemberInfo kind="method" type={`() => DataTableFilterCollection&#60;NonNullable&#60;NonNullable&#60;Vars['options']&#62;['filter']&#62;&#62;`} />
104
+ <MemberInfo kind="method" type={`() => DataTableFilterCollection<NonNullable<NonNullable<Vars['options']>['filter']>>`} />
105
105
 
106
106
 
107
107
  ### createSortCollection
108
108
 
109
- <MemberInfo kind="method" type={`() => DataTableSortCollection&#60;NonNullable&#60;NonNullable&#60;Vars['options']&#62;['sort']&#62;&#62;`} />
109
+ <MemberInfo kind="method" type={`() => DataTableSortCollection<NonNullable<NonNullable<Vars['options']>['sort']>>`} />
110
110
 
111
111
 
112
112
  ### setLanguage
@@ -116,7 +116,7 @@ class TypedBaseListComponent<T extends TypedDocumentNode<any, Vars>, Field exten
116
116
 
117
117
  ### getCustomFieldConfig
118
118
 
119
- <MemberInfo kind="method" type={`(key: Exclude&#60;keyof <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>, '__typename'&#62; | string) => <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]`} />
119
+ <MemberInfo kind="method" type={`(key: Exclude<keyof <a href='/reference/typescript-api/custom-fields/#customfields'>CustomFields</a>, '__typename'> | string) => <a href='/reference/typescript-api/custom-fields/custom-field-config#customfieldconfig'>CustomFieldConfig</a>[]`} />
120
120
 
121
121
 
122
122