@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211038

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 (585) hide show
  1. package/dist/manifest.d.ts.map +1 -1
  2. package/dist/manifest.js +2 -0
  3. package/dist/manifest.js.map +1 -1
  4. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +2 -6
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +1 -5
  6. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +1 -5
  7. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +1 -5
  8. package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx +0 -4
  9. package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx +0 -4
  10. package/docs/reference/admin-ui-api/action-bar/page-location-id.mdx +0 -4
  11. package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +1 -5
  12. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +0 -4
  13. package/docs/reference/admin-ui-api/alerts/alert-context.mdx +1 -5
  14. package/docs/reference/admin-ui-api/alerts/register-alert.mdx +1 -5
  15. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +1 -17
  16. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +1 -5
  17. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +0 -4
  18. package/docs/reference/admin-ui-api/components/chip-component.mdx +0 -4
  19. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +0 -4
  20. package/docs/reference/admin-ui-api/components/data-table-component.mdx +2 -6
  21. package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -5
  22. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +0 -4
  23. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +0 -4
  24. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +0 -4
  25. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +0 -4
  26. package/docs/reference/admin-ui-api/components/order-state-label-component.mdx +0 -4
  27. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +0 -4
  28. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +0 -4
  29. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +0 -4
  30. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -5
  31. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +1 -5
  32. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +0 -4
  33. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +1 -5
  34. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -5
  35. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +1 -5
  36. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -5
  37. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -5
  38. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +1 -5
  39. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +2 -70
  40. package/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx +0 -4
  41. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +2 -6
  42. package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx +0 -4
  43. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +2 -6
  44. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +1 -5
  45. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +0 -4
  46. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +1 -5
  47. package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx +0 -4
  48. package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx +0 -4
  49. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +0 -4
  50. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +0 -4
  51. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -5
  52. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -5
  53. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -5
  54. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -5
  55. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -5
  56. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +1 -5
  57. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx +0 -4
  58. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx +0 -4
  59. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +0 -4
  60. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -5
  61. package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx +0 -4
  62. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +0 -4
  63. package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +0 -4
  64. package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +0 -4
  65. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +0 -4
  66. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +0 -4
  67. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +0 -4
  68. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +0 -4
  69. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +0 -4
  70. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +0 -4
  71. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +0 -4
  72. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +0 -4
  73. package/docs/reference/admin-ui-api/react-components/card.mdx +0 -4
  74. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +0 -4
  75. package/docs/reference/admin-ui-api/react-components/form-field.mdx +0 -4
  76. package/docs/reference/admin-ui-api/react-components/link.mdx +0 -4
  77. package/docs/reference/admin-ui-api/react-components/page-block.mdx +0 -4
  78. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +0 -4
  79. package/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx +0 -4
  80. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +0 -4
  81. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -5
  82. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +1 -5
  83. package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx +0 -4
  84. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +1 -5
  85. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx +0 -4
  86. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +0 -4
  87. package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx +0 -4
  88. package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx +0 -4
  89. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +0 -4
  90. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +0 -4
  91. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +0 -4
  92. package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx +0 -4
  93. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +0 -4
  94. package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx +0 -4
  95. package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx +0 -4
  96. package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx +0 -4
  97. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +0 -4
  98. package/docs/reference/admin-ui-api/services/data-service.mdx +1 -9
  99. package/docs/reference/admin-ui-api/services/modal-service.mdx +1 -17
  100. package/docs/reference/admin-ui-api/services/notification-service.mdx +0 -12
  101. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +0 -4
  102. package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx +0 -4
  103. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -37
  104. package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx +0 -4
  105. package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx +0 -4
  106. package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx +0 -20
  107. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +0 -4
  108. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +1 -5
  109. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +0 -4
  110. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -5
  111. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +0 -4
  112. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +5 -9
  113. package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx +0 -4
  114. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -5
  115. package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx +0 -4
  116. package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx +0 -4
  117. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +0 -12
  118. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +3 -7
  119. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +0 -4
  120. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +2 -10
  121. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +4 -16
  122. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +2 -10
  123. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +1 -5
  124. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +0 -4
  125. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -13
  126. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -5
  127. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -5
  128. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +10 -14
  129. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -5
  130. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +0 -8
  131. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +1 -13
  132. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +9 -61
  133. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +0 -4
  134. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -9
  135. package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -8
  136. package/docs/reference/core-plugins/email-plugin/index.mdx +4 -8
  137. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +0 -8
  138. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -30
  139. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +0 -4
  140. package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx +0 -4
  141. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -5
  142. package/docs/reference/core-plugins/harden-plugin/index.mdx +2 -6
  143. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx +0 -4
  144. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -5
  145. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +1 -9
  146. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -5
  147. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +0 -4
  148. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +0 -8
  149. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +0 -8
  150. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +1 -9
  151. package/docs/reference/core-plugins/sentry-plugin/index.mdx +0 -4
  152. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +1 -5
  153. package/docs/reference/core-plugins/sentry-plugin/sentry-service.mdx +0 -4
  154. package/docs/reference/core-plugins/stellate-plugin/index.mdx +3 -7
  155. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +3 -11
  156. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +1 -5
  157. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +0 -4
  158. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +0 -8
  159. package/docs/reference/core-plugins/telemetry-plugin/index.mdx +0 -4
  160. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +0 -8
  161. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +1 -5
  162. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -5
  163. package/docs/reference/dashboard/components/asset-gallery.mdx +1 -9
  164. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +1 -9
  165. package/docs/reference/dashboard/components/channel-chip.mdx +0 -4
  166. package/docs/reference/dashboard/components/detail-page-button.mdx +0 -4
  167. package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -4
  168. package/docs/reference/dashboard/components/facet-value-selector.mdx +0 -8
  169. package/docs/reference/dashboard/components/permission-guard.mdx +0 -8
  170. package/docs/reference/dashboard/components/vendure-image.mdx +5 -29
  171. package/docs/reference/dashboard/detail-views/detail-page.mdx +2 -10
  172. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +0 -12
  173. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -9
  174. package/docs/reference/dashboard/extensions-api/action-bar.mdx +0 -4
  175. package/docs/reference/dashboard/extensions-api/alerts.mdx +0 -4
  176. package/docs/reference/dashboard/extensions-api/data-tables.mdx +0 -4
  177. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -8
  178. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +0 -8
  179. package/docs/reference/dashboard/extensions-api/form-components.mdx +1 -21
  180. package/docs/reference/dashboard/extensions-api/history-entries.mdx +3 -19
  181. package/docs/reference/dashboard/extensions-api/login.mdx +0 -16
  182. package/docs/reference/dashboard/extensions-api/navigation.mdx +0 -8
  183. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +0 -12
  184. package/docs/reference/dashboard/extensions-api/routes.mdx +0 -4
  185. package/docs/reference/dashboard/extensions-api/widgets.mdx +0 -4
  186. package/docs/reference/dashboard/form-components/affixed-input.mdx +0 -4
  187. package/docs/reference/dashboard/form-components/boolean-input.mdx +0 -4
  188. package/docs/reference/dashboard/form-components/checkbox-input.mdx +0 -4
  189. package/docs/reference/dashboard/form-components/date-time-input.mdx +0 -4
  190. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -9
  191. package/docs/reference/dashboard/form-components/money-input.mdx +0 -4
  192. package/docs/reference/dashboard/form-components/number-input.mdx +0 -4
  193. package/docs/reference/dashboard/form-components/password-input.mdx +0 -4
  194. package/docs/reference/dashboard/form-components/rich-text-input.mdx +0 -4
  195. package/docs/reference/dashboard/form-components/slug-input.mdx +0 -4
  196. package/docs/reference/dashboard/form-components/text-input.mdx +0 -4
  197. package/docs/reference/dashboard/form-components/textarea-input.mdx +0 -4
  198. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +1 -9
  199. package/docs/reference/dashboard/hooks/use-alerts.mdx +0 -8
  200. package/docs/reference/dashboard/hooks/use-auth.mdx +1 -9
  201. package/docs/reference/dashboard/hooks/use-channel.mdx +1 -9
  202. package/docs/reference/dashboard/hooks/use-custom-field-config.mdx +0 -4
  203. package/docs/reference/dashboard/hooks/use-display-locale.mdx +0 -4
  204. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +0 -4
  205. package/docs/reference/dashboard/hooks/use-local-format.mdx +0 -4
  206. package/docs/reference/dashboard/hooks/use-paginated-list.mdx +0 -4
  207. package/docs/reference/dashboard/hooks/use-permissions.mdx +0 -4
  208. package/docs/reference/dashboard/hooks/use-sorted-languages.mdx +0 -4
  209. package/docs/reference/dashboard/hooks/use-ui-language-loader.mdx +0 -4
  210. package/docs/reference/dashboard/hooks/use-widget-filters.mdx +0 -4
  211. package/docs/reference/dashboard/list-views/bulk-actions.mdx +0 -12
  212. package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -4
  213. package/docs/reference/dashboard/list-views/data-table.mdx +1 -13
  214. package/docs/reference/dashboard/list-views/list-page.mdx +2 -10
  215. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +2 -10
  216. package/docs/reference/dashboard/page-layout/index.mdx +2 -10
  217. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +2 -14
  218. package/docs/reference/dashboard/page-layout/page-block.mdx +4 -20
  219. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -5
  220. package/docs/reference/dashboard/page-layout/page.mdx +4 -12
  221. package/docs/reference/dashboard/page-layout/use-page-block.mdx +0 -4
  222. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +4 -28
  223. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +0 -4
  224. package/docs/reference/typescript-api/assets/asset-options.mdx +0 -4
  225. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +0 -4
  226. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +0 -4
  227. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -4
  228. package/docs/reference/typescript-api/auth/auth-options.mdx +4 -8
  229. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -5
  230. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +0 -4
  231. package/docs/reference/typescript-api/auth/cookie-options.mdx +0 -4
  232. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +0 -4
  233. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +3 -7
  234. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +0 -4
  235. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +1 -5
  236. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +0 -4
  237. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +0 -4
  238. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +0 -4
  239. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +1 -5
  240. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -5
  241. package/docs/reference/typescript-api/auth/permission-definition.mdx +10 -26
  242. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -16
  243. package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -4
  244. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +0 -4
  245. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -5
  246. package/docs/reference/typescript-api/cache/cache-service.mdx +2 -6
  247. package/docs/reference/typescript-api/cache/cache-strategy.mdx +1 -9
  248. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +3 -11
  249. package/docs/reference/typescript-api/cache/index.mdx +2 -6
  250. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +3 -11
  251. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -5
  252. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +0 -4
  253. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +2 -14
  254. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +2 -6
  255. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +0 -4
  256. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +0 -4
  257. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +1 -5
  258. package/docs/reference/typescript-api/common/async-queue.mdx +0 -4
  259. package/docs/reference/typescript-api/common/bootstrap.mdx +0 -8
  260. package/docs/reference/typescript-api/common/currency-code.mdx +0 -4
  261. package/docs/reference/typescript-api/common/entity-relation-paths.mdx +0 -4
  262. package/docs/reference/typescript-api/common/i18n-service.mdx +0 -8
  263. package/docs/reference/typescript-api/common/id.mdx +1 -5
  264. package/docs/reference/typescript-api/common/injectable-strategy.mdx +1 -5
  265. package/docs/reference/typescript-api/common/injector.mdx +0 -4
  266. package/docs/reference/typescript-api/common/job-state.mdx +0 -4
  267. package/docs/reference/typescript-api/common/json-compatible.mdx +0 -4
  268. package/docs/reference/typescript-api/common/language-code.mdx +0 -4
  269. package/docs/reference/typescript-api/common/middleware.mdx +1 -5
  270. package/docs/reference/typescript-api/common/paginated-list.mdx +0 -4
  271. package/docs/reference/typescript-api/common/permission.mdx +1 -5
  272. package/docs/reference/typescript-api/common/price-calculation-result.mdx +2 -6
  273. package/docs/reference/typescript-api/common/process-context.mdx +0 -4
  274. package/docs/reference/typescript-api/common/vendure_version.mdx +0 -4
  275. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +1 -5
  276. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +3 -7
  277. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +2 -6
  278. package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx +0 -4
  279. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +0 -4
  280. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +10 -14
  281. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +1 -5
  282. package/docs/reference/typescript-api/configuration/api-options.mdx +1 -5
  283. package/docs/reference/typescript-api/configuration/collection-filter.mdx +0 -4
  284. package/docs/reference/typescript-api/configuration/default-config.mdx +0 -4
  285. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +0 -4
  286. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +0 -12
  287. package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -4
  288. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +2 -14
  289. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -10
  290. package/docs/reference/typescript-api/configuration/merge-config.mdx +0 -4
  291. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +0 -8
  292. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +2 -14
  293. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -5
  294. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +1 -5
  295. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +0 -4
  296. package/docs/reference/typescript-api/configuration/system-options.mdx +3 -7
  297. package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx +0 -4
  298. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -6
  299. package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +0 -4
  300. package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx +0 -4
  301. package/docs/reference/typescript-api/custom-fields/index.mdx +1 -5
  302. package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +0 -4
  303. package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +0 -4
  304. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +1 -5
  305. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +0 -4
  306. package/docs/reference/typescript-api/data-access/calculated.mdx +2 -10
  307. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -5
  308. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +2 -6
  309. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -5
  310. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -9
  311. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +7 -11
  312. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +2 -6
  313. package/docs/reference/typescript-api/default-search-plugin/index.mdx +0 -4
  314. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +0 -4
  315. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +0 -4
  316. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +1 -5
  317. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +0 -4
  318. package/docs/reference/typescript-api/entities/address.mdx +1 -5
  319. package/docs/reference/typescript-api/entities/administrator.mdx +1 -5
  320. package/docs/reference/typescript-api/entities/anonymous-session.mdx +0 -4
  321. package/docs/reference/typescript-api/entities/asset.mdx +0 -4
  322. package/docs/reference/typescript-api/entities/authenticated-session.mdx +2 -6
  323. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -14
  324. package/docs/reference/typescript-api/entities/channel.mdx +0 -4
  325. package/docs/reference/typescript-api/entities/collection.mdx +1 -5
  326. package/docs/reference/typescript-api/entities/country.mdx +3 -7
  327. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -5
  328. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -5
  329. package/docs/reference/typescript-api/entities/customer.mdx +1 -5
  330. package/docs/reference/typescript-api/entities/facet-value.mdx +1 -5
  331. package/docs/reference/typescript-api/entities/facet.mdx +2 -6
  332. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -5
  333. package/docs/reference/typescript-api/entities/global-settings.mdx +0 -4
  334. package/docs/reference/typescript-api/entities/history-entry.mdx +2 -6
  335. package/docs/reference/typescript-api/entities/interfaces.mdx +0 -20
  336. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -5
  337. package/docs/reference/typescript-api/entities/order-line-reference.mdx +4 -20
  338. package/docs/reference/typescript-api/entities/order-line.mdx +7 -11
  339. package/docs/reference/typescript-api/entities/order-modification.mdx +0 -4
  340. package/docs/reference/typescript-api/entities/order.mdx +7 -11
  341. package/docs/reference/typescript-api/entities/orderable-asset.mdx +0 -4
  342. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -6
  343. package/docs/reference/typescript-api/entities/payment.mdx +1 -5
  344. package/docs/reference/typescript-api/entities/product-option-group.mdx +1 -5
  345. package/docs/reference/typescript-api/entities/product-option.mdx +1 -5
  346. package/docs/reference/typescript-api/entities/product-variant-price.mdx +0 -4
  347. package/docs/reference/typescript-api/entities/product-variant.mdx +1 -5
  348. package/docs/reference/typescript-api/entities/product.mdx +1 -5
  349. package/docs/reference/typescript-api/entities/promotion.mdx +2 -6
  350. package/docs/reference/typescript-api/entities/province.mdx +1 -5
  351. package/docs/reference/typescript-api/entities/refund.mdx +0 -4
  352. package/docs/reference/typescript-api/entities/region.mdx +2 -6
  353. package/docs/reference/typescript-api/entities/role.mdx +1 -5
  354. package/docs/reference/typescript-api/entities/seller.mdx +1 -5
  355. package/docs/reference/typescript-api/entities/session.mdx +2 -6
  356. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +0 -4
  357. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -5
  358. package/docs/reference/typescript-api/entities/shipping-method.mdx +2 -6
  359. package/docs/reference/typescript-api/entities/stock-level.mdx +2 -6
  360. package/docs/reference/typescript-api/entities/stock-location.mdx +2 -6
  361. package/docs/reference/typescript-api/entities/stock-movement.mdx +1 -25
  362. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -5
  363. package/docs/reference/typescript-api/entities/tag.mdx +0 -4
  364. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -5
  365. package/docs/reference/typescript-api/entities/tax-rate.mdx +4 -8
  366. package/docs/reference/typescript-api/entities/user.mdx +1 -5
  367. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -5
  368. package/docs/reference/typescript-api/entities/zone.mdx +1 -5
  369. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +0 -4
  370. package/docs/reference/typescript-api/errors/error-result-union.mdx +0 -4
  371. package/docs/reference/typescript-api/errors/error-types.mdx +1 -29
  372. package/docs/reference/typescript-api/errors/i18n-error.mdx +0 -4
  373. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +1 -5
  374. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +0 -4
  375. package/docs/reference/typescript-api/events/event-bus.mdx +6 -10
  376. package/docs/reference/typescript-api/events/event-types.mdx +50 -286
  377. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +0 -4
  378. package/docs/reference/typescript-api/events/vendure-event.mdx +0 -4
  379. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -19
  380. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -12
  381. package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +1 -5
  382. package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +1 -5
  383. package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx +0 -4
  384. package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +3 -7
  385. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -5
  386. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -5
  387. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -5
  388. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +2 -6
  389. package/docs/reference/typescript-api/import-export/asset-importer.mdx +2 -6
  390. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +0 -4
  391. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +0 -4
  392. package/docs/reference/typescript-api/import-export/import-export-options.mdx +1 -5
  393. package/docs/reference/typescript-api/import-export/import-parser.mdx +8 -36
  394. package/docs/reference/typescript-api/import-export/importer.mdx +2 -6
  395. package/docs/reference/typescript-api/import-export/initial-data.mdx +0 -4
  396. package/docs/reference/typescript-api/import-export/populate.mdx +3 -7
  397. package/docs/reference/typescript-api/import-export/populator.mdx +2 -6
  398. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -17
  399. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -7
  400. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -6
  401. package/docs/reference/typescript-api/job-queue/index.mdx +4 -8
  402. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +0 -4
  403. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +1 -5
  404. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -6
  405. package/docs/reference/typescript-api/job-queue/job-queue-options.mdx +0 -4
  406. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +4 -8
  407. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +1 -5
  408. package/docs/reference/typescript-api/job-queue/job.mdx +2 -14
  409. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +3 -7
  410. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +2 -6
  411. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +4 -8
  412. package/docs/reference/typescript-api/job-queue/types.mdx +5 -29
  413. package/docs/reference/typescript-api/logger/default-logger.mdx +0 -4
  414. package/docs/reference/typescript-api/logger/index.mdx +3 -7
  415. package/docs/reference/typescript-api/logger/log-level.mdx +0 -4
  416. package/docs/reference/typescript-api/logger/vendure-logger.mdx +0 -4
  417. package/docs/reference/typescript-api/migration/generate-migration.mdx +0 -4
  418. package/docs/reference/typescript-api/migration/migration-options.mdx +1 -5
  419. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +0 -4
  420. package/docs/reference/typescript-api/migration/run-migrations.mdx +0 -4
  421. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +2 -6
  422. package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -5
  423. package/docs/reference/typescript-api/money/money-decorator.mdx +1 -5
  424. package/docs/reference/typescript-api/money/money-strategy.mdx +4 -8
  425. package/docs/reference/typescript-api/money/round-money.mdx +1 -5
  426. package/docs/reference/typescript-api/orders/active-order-service.mdx +1 -5
  427. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +1 -5
  428. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -5
  429. package/docs/reference/typescript-api/orders/custom-order-states.mdx +1 -5
  430. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -5
  431. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +2 -10
  432. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -5
  433. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -5
  434. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +0 -4
  435. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +0 -4
  436. package/docs/reference/typescript-api/orders/merge-strategies.mdx +0 -16
  437. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +0 -8
  438. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +0 -8
  439. package/docs/reference/typescript-api/orders/order-interceptor.mdx +4 -8
  440. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +2 -6
  441. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -9
  442. package/docs/reference/typescript-api/orders/order-options.mdx +2 -6
  443. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +0 -4
  444. package/docs/reference/typescript-api/orders/order-process.mdx +12 -40
  445. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -15
  446. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +0 -4
  447. package/docs/reference/typescript-api/payment/default-payment-process.mdx +1 -5
  448. package/docs/reference/typescript-api/payment/default-refund-process.mdx +1 -5
  449. package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx +0 -4
  450. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +3 -7
  451. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +3 -15
  452. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -5
  453. package/docs/reference/typescript-api/payment/payment-method-types.mdx +16 -60
  454. package/docs/reference/typescript-api/payment/payment-options.mdx +7 -11
  455. package/docs/reference/typescript-api/payment/payment-process.mdx +1 -5
  456. package/docs/reference/typescript-api/payment/payment-state.mdx +0 -4
  457. package/docs/reference/typescript-api/payment/payment-states.mdx +1 -5
  458. package/docs/reference/typescript-api/payment/payment-transition-data.mdx +0 -4
  459. package/docs/reference/typescript-api/payment/refund-process.mdx +1 -5
  460. package/docs/reference/typescript-api/payment/refund-state.mdx +0 -4
  461. package/docs/reference/typescript-api/payment/refund-states.mdx +1 -5
  462. package/docs/reference/typescript-api/payment/refund-transition-data.mdx +0 -4
  463. package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +3 -7
  464. package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +1 -9
  465. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +3 -15
  466. package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -4
  467. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -5
  468. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +0 -4
  469. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +0 -4
  470. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +2 -6
  471. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -6
  472. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -9
  473. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +0 -4
  474. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +4 -16
  475. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +3 -7
  476. package/docs/reference/typescript-api/promotions/promotion-action.mdx +10 -70
  477. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +4 -16
  478. package/docs/reference/typescript-api/promotions/promotion-options.mdx +0 -4
  479. package/docs/reference/typescript-api/request/allow-decorator.mdx +1 -5
  480. package/docs/reference/typescript-api/request/api-decorator.mdx +1 -5
  481. package/docs/reference/typescript-api/request/api-type.mdx +0 -4
  482. package/docs/reference/typescript-api/request/ctx-decorator.mdx +1 -5
  483. package/docs/reference/typescript-api/request/relations-decorator.mdx +1 -5
  484. package/docs/reference/typescript-api/request/request-context-service.mdx +1 -5
  485. package/docs/reference/typescript-api/request/request-context.mdx +5 -9
  486. package/docs/reference/typescript-api/request/transaction-decorator.mdx +2 -14
  487. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +1 -5
  488. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +1 -9
  489. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +2 -6
  490. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +0 -12
  491. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +2 -6
  492. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +0 -4
  493. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +3 -11
  494. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +3 -7
  495. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +0 -4
  496. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +1 -5
  497. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -5
  498. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +1 -13
  499. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +1 -5
  500. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +0 -4
  501. package/docs/reference/typescript-api/services/administrator-service.mdx +1 -5
  502. package/docs/reference/typescript-api/services/asset-service.mdx +2 -14
  503. package/docs/reference/typescript-api/services/auth-service.mdx +3 -7
  504. package/docs/reference/typescript-api/services/channel-service.mdx +3 -7
  505. package/docs/reference/typescript-api/services/collection-service.mdx +3 -7
  506. package/docs/reference/typescript-api/services/country-service.mdx +1 -5
  507. package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -6
  508. package/docs/reference/typescript-api/services/customer-service.mdx +13 -17
  509. package/docs/reference/typescript-api/services/entity-slug-service.mdx +0 -4
  510. package/docs/reference/typescript-api/services/facet-service.mdx +1 -5
  511. package/docs/reference/typescript-api/services/facet-value-service.mdx +1 -5
  512. package/docs/reference/typescript-api/services/fulfillment-service.mdx +3 -7
  513. package/docs/reference/typescript-api/services/global-settings-service.mdx +1 -5
  514. package/docs/reference/typescript-api/services/history-service.mdx +1 -5
  515. package/docs/reference/typescript-api/services/initializer-service.mdx +0 -4
  516. package/docs/reference/typescript-api/services/order-service.mdx +24 -28
  517. package/docs/reference/typescript-api/services/order-testing-service.mdx +0 -4
  518. package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -5
  519. package/docs/reference/typescript-api/services/payment-service.mdx +6 -10
  520. package/docs/reference/typescript-api/services/product-option-group-service.mdx +1 -5
  521. package/docs/reference/typescript-api/services/product-option-service.mdx +1 -5
  522. package/docs/reference/typescript-api/services/product-service.mdx +2 -6
  523. package/docs/reference/typescript-api/services/product-variant-service.mdx +7 -11
  524. package/docs/reference/typescript-api/services/promotion-service.mdx +1 -5
  525. package/docs/reference/typescript-api/services/province-service.mdx +1 -5
  526. package/docs/reference/typescript-api/services/role-service.mdx +1 -5
  527. package/docs/reference/typescript-api/services/search-service.mdx +0 -4
  528. package/docs/reference/typescript-api/services/seller-service.mdx +1 -5
  529. package/docs/reference/typescript-api/services/session-service.mdx +4 -8
  530. package/docs/reference/typescript-api/services/settings-store-service.mdx +0 -4
  531. package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -5
  532. package/docs/reference/typescript-api/services/slug-service.mdx +0 -4
  533. package/docs/reference/typescript-api/services/stock-level-service.mdx +5 -9
  534. package/docs/reference/typescript-api/services/stock-location-service.mdx +5 -9
  535. package/docs/reference/typescript-api/services/stock-movement-service.mdx +8 -12
  536. package/docs/reference/typescript-api/services/tag-service.mdx +1 -5
  537. package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -5
  538. package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -5
  539. package/docs/reference/typescript-api/services/user-service.mdx +8 -12
  540. package/docs/reference/typescript-api/services/zone-service.mdx +1 -5
  541. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.mdx +0 -4
  542. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.mdx +0 -4
  543. package/docs/reference/typescript-api/settings-store/index.mdx +1 -5
  544. package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.mdx +0 -4
  545. package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.mdx +0 -4
  546. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +0 -4
  547. package/docs/reference/typescript-api/settings-store/settings-store-registration.mdx +0 -4
  548. package/docs/reference/typescript-api/settings-store/settings-store-scope-function.mdx +0 -4
  549. package/docs/reference/typescript-api/settings-store/settings-store-scopes.mdx +0 -4
  550. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +2 -6
  551. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -5
  552. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +4 -16
  553. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +1 -5
  554. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -5
  555. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +2 -6
  556. package/docs/reference/typescript-api/shipping/shipping-options.mdx +3 -7
  557. package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -4
  558. package/docs/reference/typescript-api/state-machine/fsm.mdx +0 -4
  559. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +1 -17
  560. package/docs/reference/typescript-api/state-machine/transitions.mdx +2 -6
  561. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +2 -6
  562. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +2 -6
  563. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -5
  564. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +2 -10
  565. package/docs/reference/typescript-api/tax/tax-options.mdx +0 -4
  566. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -5
  567. package/docs/reference/typescript-api/telemetry/instrument.mdx +1 -5
  568. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -5
  569. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +1 -5
  570. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -5
  571. package/docs/reference/typescript-api/testing/create-test-environment.mdx +2 -6
  572. package/docs/reference/typescript-api/testing/error-result-guard.mdx +0 -4
  573. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +1 -5
  574. package/docs/reference/typescript-api/testing/register-initializer.mdx +2 -6
  575. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +0 -4
  576. package/docs/reference/typescript-api/testing/test-config.mdx +1 -5
  577. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +1 -5
  578. package/docs/reference/typescript-api/testing/test-environment.mdx +1 -5
  579. package/docs/reference/typescript-api/testing/test-server-options.mdx +1 -5
  580. package/docs/reference/typescript-api/testing/test-server.mdx +0 -4
  581. package/docs/reference/typescript-api/testing/testing-logger.mdx +0 -4
  582. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -10
  583. package/docs/reference/typescript-api/worker/vendure-worker.mdx +1 -5
  584. package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -4
  585. package/package.json +2 -2
@@ -2,10 +2,6 @@
2
2
  title: "LocaleCurrencyPipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleCurrencyPipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-currency.pipe.ts" sourceLine="20" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Formats a Vendure monetary value (in cents) into the correct format for the configured currency and display
@@ -2,10 +2,6 @@
2
2
  title: "LocaleDatePipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleDatePipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-date.pipe.ts" sourceLine="19" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A replacement of the Angular DatePipe which makes use of the Intl API
@@ -2,10 +2,6 @@
2
2
  title: "LocaleLanguageNamePipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleLanguageNamePipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-language-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Displays a human-readable name for a given ISO 639-1 language code.
@@ -2,10 +2,6 @@
2
2
  title: "LocaleRegionNamePipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## LocaleRegionNamePipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/locale-region-name.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Displays a human-readable name for a given region.
@@ -2,10 +2,6 @@
2
2
  title: "TimeAgoPipe"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## TimeAgoPipe
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/shared/pipes/time-ago.pipe.ts" sourceLine="18" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Converts a date into the format "3 minutes ago", "5 hours ago" etc.
@@ -2,10 +2,6 @@
2
2
  title: "ActionBar"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ActionBar
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/ActionBar.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A container for the primary actions on a list or detail page
@@ -2,10 +2,6 @@
2
2
  title: "Card"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Card
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/Card.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A card component which can be used to group related content.
@@ -2,10 +2,6 @@
2
2
  title: "CdsIcon"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## CdsIcon
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/CdsIcon.tsx" sourceLine="47" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A React wrapper for the Clarity UI icon component.
@@ -2,10 +2,6 @@
2
2
  title: "FormField"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## FormField
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/FormField.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A wrapper around form fields which provides a label, tooltip and error message.
@@ -2,10 +2,6 @@
2
2
  title: "Link"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## Link
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/Link.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A React component which renders an anchor tag and navigates to the specified route when clicked.
@@ -2,10 +2,6 @@
2
2
  title: "PageBlock"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PageBlock
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/PageBlock.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A container for page content which provides a consistent width and spacing.
@@ -2,10 +2,6 @@
2
2
  title: "PageDetailLayout"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PageDetailLayout
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/PageDetailLayout.tsx" sourceLine="22" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A responsive container for detail views with a main content area and an optional sidebar.
@@ -2,10 +2,6 @@
2
2
  title: "RichTextEditor"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## RichTextEditor
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-components/RichTextEditor.tsx" sourceLine="60" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A rich text editor component which uses ProseMirror (rich text editor) under the hood.
@@ -2,10 +2,6 @@
2
2
  title: "ReactCustomDetailComponentConfig"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ReactCustomDetailComponentConfig
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Configures a React-based component to be placed in a detail page in the given location.
@@ -2,13 +2,9 @@
2
2
  title: "ReactDataTableComponentConfig"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ReactDataTableComponentConfig
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts" sourceLine="19" packageName="@vendure/admin-ui" />
10
6
 
11
- Configures a <a href='/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent'>CustomDetailComponent</a> to be placed in the given location.
7
+ Configures a <DocsLink href="/reference/admin-ui-api/custom-detail-components/custom-detail-component#customdetailcomponent">CustomDetailComponent</DocsLink> to be placed in the given location.
12
8
 
13
9
  ```ts title="Signature"
14
10
  interface ReactDataTableComponentConfig {
@@ -2,14 +2,10 @@
2
2
  title: "RegisterReactCustomDetailComponent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## registerReactCustomDetailComponent
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-custom-detail-component.ts" sourceLine="40" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Registers a React component to be rendered in a detail page in the given location.
12
- Components used as custom detail components can make use of the <a href='/reference/admin-ui-api/react-hooks/use-detail-component-data#usedetailcomponentdata'>useDetailComponentData</a> hook.
8
+ Components used as custom detail components can make use of the <DocsLink href="/reference/admin-ui-api/react-hooks/use-detail-component-data#usedetailcomponentdata">useDetailComponentData</DocsLink> hook.
13
9
 
14
10
  ```ts title="Signature"
15
11
  function registerReactCustomDetailComponent(config: ReactCustomDetailComponentConfig): void
@@ -2,10 +2,6 @@
2
2
  title: "RegisterReactDataTableComponent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## registerReactDataTableComponent
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-data-table-component.ts" sourceLine="90" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Registers a React component to be rendered in a data table in the given location.
@@ -2,13 +2,9 @@
2
2
  title: "RegisterReactFormInputComponent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## registerReactFormInputComponent
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-form-input-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
10
6
 
11
- Registers a React component to be used as a <a href='/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent'>FormInputComponent</a>.
7
+ Registers a React component to be used as a <DocsLink href="/reference/admin-ui-api/custom-input-components/form-input-component#forminputcomponent">FormInputComponent</DocsLink>.
12
8
 
13
9
  ```ts title="Signature"
14
10
  function registerReactFormInputComponent(id: string, component: ElementType): void
@@ -2,10 +2,6 @@
2
2
  title: "RegisterReactRouteComponentOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## RegisterReactRouteComponentOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-route-component.ts" sourceLine="15" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Configuration for a React-based route component.
@@ -2,10 +2,6 @@
2
2
  title: "RegisterReactRouteComponent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## registerReactRouteComponent
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/register-react-route-component.ts" sourceLine="30" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Registers a React component to be used as a route component.
@@ -2,10 +2,6 @@
2
2
  title: "UseDetailComponentData"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useDetailComponentData
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-detail-component-data.ts" sourceLine="34" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Provides the data available to React-based CustomDetailComponents.
@@ -2,10 +2,6 @@
2
2
  title: "UseFormControl"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useFormControl
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-form-control.ts" sourceLine="31" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Provides access to the current FormControl value and a method to update the value.
@@ -2,10 +2,6 @@
2
2
  title: "UseInjector"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useInjector
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-injector.ts" sourceLine="27" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Exposes the Angular injector which allows the injection of services into React components.
@@ -2,10 +2,6 @@
2
2
  title: "UseLazyQuery"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useLazyQuery
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="119" packageName="@vendure/admin-ui" since="2.2.0" />
10
6
 
11
7
  A React hook which allows you to execute a GraphQL query lazily.
@@ -2,10 +2,6 @@
2
2
  title: "UseMutation"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useMutation
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="181" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A React hook which allows you to execute a GraphQL mutation.
@@ -2,10 +2,6 @@
2
2
  title: "UsePageMetadata"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## usePageMetadata
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-page-metadata.ts" sourceLine="31" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Provides functions for setting the current page title and breadcrumb.
@@ -2,10 +2,6 @@
2
2
  title: "UseQuery"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useQuery
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-query.ts" sourceLine="43" packageName="@vendure/admin-ui" />
10
6
 
11
7
  A React hook which provides access to the results of a GraphQL query.
@@ -2,10 +2,6 @@
2
2
  title: "UseRichTextEditor"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useRichTextEditor
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-rich-text-editor.ts" sourceLine="40" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Provides access to the ProseMirror (rich text editor) instance.
@@ -2,10 +2,6 @@
2
2
  title: "UseRouteParams"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## useRouteParams
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/react/src/react-hooks/use-route-params.ts" sourceLine="23" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Provides access to the current route params and query params.
@@ -2,10 +2,6 @@
2
2
  title: "RegisterRouteComponentOptions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## RegisterRouteComponentOptions
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-route-component.ts" sourceLine="19" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Configuration for a route component.
@@ -2,10 +2,6 @@
2
2
  title: "RegisterRouteComponent"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## registerRouteComponent
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-route-component.ts" sourceLine="79" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Registers an Angular standalone component to be rendered in a route.
@@ -2,10 +2,6 @@
2
2
  title: "DataService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## DataService
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/data/providers/data.service.ts" sourceLine="34" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Used to interact with the Admin API via GraphQL queries. Internally this service uses the
@@ -26,7 +22,7 @@ class DataService {
26
22
 
27
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>`} />
28
24
 
29
- Perform a GraphQL query. Returns a <a href='/reference/admin-ui-api/services/data-service#queryresult'>QueryResult</a> which allows further control over
25
+ Perform a GraphQL query. Returns a <DocsLink href="/reference/admin-ui-api/services/data-service#queryresult">QueryResult</DocsLink> which allows further control over
30
26
  they type of result returned, e.g. stream of values, single value etc.
31
27
 
32
28
  *Example*
@@ -65,10 +61,6 @@ const result$ = this.dataService.mutate(gql`
65
61
 
66
62
 
67
63
  </div>
68
-
69
-
70
- ## QueryResult
71
-
72
64
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/data/query-result.ts" sourceLine="31" packageName="@vendure/admin-ui" />
73
65
 
74
66
  This class wraps the Apollo Angular QueryRef object and exposes some getters
@@ -2,10 +2,6 @@
2
2
  title: "ModalService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## ModalService
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.service.ts" sourceLine="21" packageName="@vendure/admin-ui" />
10
6
 
11
7
  This service is responsible for instantiating a ModalDialog component and
@@ -30,7 +26,7 @@ class ModalService {
30
26
 
31
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>`} />
32
28
 
33
- Create a modal from a component. The component must implement the <a href='/reference/admin-ui-api/services/modal-service#dialog'>Dialog</a> interface.
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.
34
30
  Additionally, the component should include templates for the title and the buttons to be
35
31
  displayed in the modal dialog. See example:
36
32
 
@@ -78,10 +74,6 @@ Displays a modal dialog with the provided title, body and buttons.
78
74
 
79
75
 
80
76
  </div>
81
-
82
-
83
- ## Dialog
84
-
85
77
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="9" packageName="@vendure/admin-ui" />
86
78
 
87
79
  Any component intended to be used with the ModalService.fromComponent() method must implement
@@ -105,10 +97,6 @@ to this method and then complete.
105
97
 
106
98
 
107
99
  </div>
108
-
109
-
110
- ## DialogConfig
111
-
112
100
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="33" packageName="@vendure/admin-ui" />
113
101
 
114
102
  Configures a generic modal dialog.
@@ -153,10 +141,6 @@ interface DialogConfig<T> {
153
141
 
154
142
 
155
143
  </div>
156
-
157
-
158
- ## ModalOptions
159
-
160
144
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/modal/modal.types.ts" sourceLine="48" packageName="@vendure/admin-ui" />
161
145
 
162
146
  Options to configure the behaviour of the modal.
@@ -2,10 +2,6 @@
2
2
  title: "NotificationService"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## NotificationService
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="54" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Provides toast notification functionality.
@@ -70,10 +66,6 @@ Display a toast notification.
70
66
 
71
67
 
72
68
  </div>
73
-
74
-
75
- ## NotificationType
76
-
77
69
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="14" packageName="@vendure/admin-ui" />
78
70
 
79
71
  The types of notification available.
@@ -81,10 +73,6 @@ The types of notification available.
81
73
  ```ts title="Signature"
82
74
  type NotificationType = 'info' | 'success' | 'error' | 'warning'
83
75
  ```
84
-
85
-
86
- ## ToastConfig
87
-
88
76
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/notification/notification.service.ts" sourceLine="23" packageName="@vendure/admin-ui" />
89
77
 
90
78
  Configuration for a toast notification.
@@ -2,10 +2,6 @@
2
2
  title: "PageTabConfig"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## PageTabConfig
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/page/page.service.ts" sourceLine="14" packageName="@vendure/admin-ui" />
10
6
 
11
7
  The object used to configure a new page tab.
@@ -2,10 +2,6 @@
2
2
  title: "RegisterPageTab"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## registerPageTab
8
-
9
5
  <GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-page-tab.ts" sourceLine="24" packageName="@vendure/admin-ui" />
10
6
 
11
7
  Add a tab to an existing list or detail page.
@@ -2,10 +2,6 @@
2
2
  title: "AdminUiExtension"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## AdminUiExtension
8
-
9
5
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="130" packageName="@vendure/ui-devkit" />
10
6
 
11
7
  Defines extensions to the Admin UI application by specifying additional
@@ -166,14 +162,10 @@ exclude: ['**/*.spec.ts']
166
162
 
167
163
 
168
164
  </div>
169
-
170
-
171
- ## TranslationExtension
172
-
173
165
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="18" packageName="@vendure/ui-devkit" />
174
166
 
175
167
  Defines extensions to the Admin UI translations. Can be used as a stand-alone extension definition which only adds translations
176
- without adding new UI functionality, or as part of a full <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextension'>AdminUiExtension</a>.
168
+ without adding new UI functionality, or as part of a full <DocsLink href="/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextension">AdminUiExtension</DocsLink>.
177
169
 
178
170
  ```ts title="Signature"
179
171
  interface TranslationExtension {
@@ -203,10 +195,6 @@ translations: {
203
195
 
204
196
 
205
197
  </div>
206
-
207
-
208
- ## StaticAssetExtension
209
-
210
198
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="44" packageName="@vendure/ui-devkit" />
211
199
 
212
200
  Defines extensions which copy static assets to the custom Admin UI application source asset directory.
@@ -228,10 +216,6 @@ directory.
228
216
 
229
217
 
230
218
  </div>
231
-
232
-
233
- ## GlobalStylesExtension
234
-
235
219
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="60" packageName="@vendure/ui-devkit" />
236
220
 
237
221
  Defines extensions which add global styles to the custom Admin UI application.
@@ -253,10 +237,6 @@ incorporated into the Admin UI app global stylesheet.
253
237
 
254
238
 
255
239
  </div>
256
-
257
-
258
- ## SassVariableOverridesExtension
259
-
260
240
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="76" packageName="@vendure/ui-devkit" />
261
241
 
262
242
  Defines an extension which allows overriding Clarity Design System's Sass variables used in styles on the Admin UI.
@@ -278,10 +258,6 @@ default values defined in Clarity.
278
258
 
279
259
 
280
260
  </div>
281
-
282
-
283
- ## UiExtensionRouteDefinition
284
-
285
261
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="92" packageName="@vendure/ui-devkit" />
286
262
 
287
263
  Defines a route which will be added to the Admin UI application.
@@ -319,10 +295,6 @@ This is useful when the extension is intended to replace the default Admin UI, r
319
295
 
320
296
 
321
297
  </div>
322
-
323
-
324
- ## StaticAssetDefinition
325
-
326
298
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="280" packageName="@vendure/ui-devkit" />
327
299
 
328
300
  A static asset can be provided as a path to the asset, or as an object containing a path and a new
@@ -331,10 +303,6 @@ name, which will cause the compiler to copy and then rename the asset.
331
303
  ```ts title="Signature"
332
304
  type StaticAssetDefinition = string | { path: string; rename: string }
333
305
  ```
334
-
335
-
336
- ## AdminUiExtensionSharedModule
337
-
338
306
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="289" packageName="@vendure/ui-devkit" />
339
307
 
340
308
  Configuration defining a single NgModule with which to extend the Admin UI.
@@ -369,10 +337,6 @@ The name of the extension module class.
369
337
 
370
338
 
371
339
  </div>
372
-
373
-
374
- ## AdminUiExtensionLazyModule
375
-
376
340
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="316" packageName="@vendure/ui-devkit" />
377
341
 
378
342
  Configuration defining a single NgModule with which to extend the Admin UI.
@@ -2,10 +2,6 @@
2
2
  title: "CompileUiExtensions"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## compileUiExtensions
8
-
9
5
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/compile.ts" sourceLine="36" packageName="@vendure/ui-devkit" />
10
6
 
11
7
  Compiles the Admin UI app with the specified extensions.
@@ -2,10 +2,6 @@
2
2
  title: "Helpers"
3
3
  generated: true
4
4
  ---
5
-
6
-
7
- ## setBranding
8
-
9
5
  <GenerationInfo sourceFile="packages/ui-devkit/src/compiler/helpers.ts" sourceLine="26" packageName="@vendure/ui-devkit" />
10
6
 
11
7
  A helper function to simplify the process of setting custom branding images.