@vendure/dashboard 3.2.0

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 (382) hide show
  1. package/README.md +13 -0
  2. package/dist/plugin/.vendure-dashboard-temp/dev-config.js +227 -0
  3. package/dist/plugin/.vendure-dashboard-temp/dev-config.js.map +1 -0
  4. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/api/api-extensions.js +33 -0
  5. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/api/api-extensions.js.map +1 -0
  6. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/api/mv.resolver.js +69 -0
  7. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/api/mv.resolver.js.map +1 -0
  8. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-order-process.js +110 -0
  9. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-order-process.js.map +1 -0
  10. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-order-seller-strategy.js +134 -0
  11. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-order-seller-strategy.js.map +1 -0
  12. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-payment-handler.js +86 -0
  13. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-payment-handler.js.map +1 -0
  14. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-shipping-eligibility-checker.js +49 -0
  15. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-shipping-eligibility-checker.js.map +1 -0
  16. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-shipping-line-assignment-strategy.js +57 -0
  17. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/config/mv-shipping-line-assignment-strategy.js.map +1 -0
  18. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/constants.js +20 -0
  19. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/constants.js.map +1 -0
  20. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/multivendor.plugin.js +151 -0
  21. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/multivendor.plugin.js.map +1 -0
  22. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/payment/mv-connect-sdk.js +47 -0
  23. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/payment/mv-connect-sdk.js.map +1 -0
  24. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/service/mv.service.js +222 -0
  25. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/service/mv.service.js.map +1 -0
  26. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/types.js +4 -0
  27. package/dist/plugin/.vendure-dashboard-temp/example-plugins/multivendor-plugin/types.js.map +1 -0
  28. package/dist/plugin/.vendure-dashboard-temp/package.json +3 -0
  29. package/dist/plugin/.vendure-dashboard-temp/schema.graphql +6378 -0
  30. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/api-extensions.js +103 -0
  31. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/api-extensions.js.map +1 -0
  32. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/product-entity.resolver.js +105 -0
  33. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/product-entity.resolver.js.map +1 -0
  34. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/product-review-admin.resolver.js +183 -0
  35. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/product-review-admin.resolver.js.map +1 -0
  36. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/product-review-entity.resolver.js +113 -0
  37. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/product-review-entity.resolver.js.map +1 -0
  38. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/product-review-shop.resolver.js +112 -0
  39. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/api/product-review-shop.resolver.js.map +1 -0
  40. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/entities/product-review.entity.js +111 -0
  41. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/entities/product-review.entity.js.map +1 -0
  42. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/generated-admin-types.js +616 -0
  43. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/generated-admin-types.js.map +1 -0
  44. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/generated-shop-types.js +563 -0
  45. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/generated-shop-types.js.map +1 -0
  46. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/reviews-plugin.js +135 -0
  47. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/reviews-plugin.js.map +1 -0
  48. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/types.js +4 -0
  49. package/dist/plugin/.vendure-dashboard-temp/test-plugins/reviews/types.js.map +1 -0
  50. package/dist/plugin/.vendure-dashboard-temp/tsconfig.json +10 -0
  51. package/dist/plugin/config-loader.d.ts +27 -0
  52. package/dist/plugin/config-loader.js +141 -0
  53. package/dist/plugin/constants.d.ts +5 -0
  54. package/dist/plugin/constants.js +277 -0
  55. package/dist/plugin/index.d.ts +1 -0
  56. package/dist/plugin/index.js +1 -0
  57. package/dist/plugin/schema-generator.d.ts +5 -0
  58. package/dist/plugin/schema-generator.js +24 -0
  59. package/dist/plugin/ui-config.d.ts +3 -0
  60. package/dist/plugin/ui-config.js +35 -0
  61. package/dist/plugin/vite-plugin-admin-api-schema.d.ts +24 -0
  62. package/dist/plugin/vite-plugin-admin-api-schema.js +82 -0
  63. package/dist/plugin/vite-plugin-config-loader.d.ts +17 -0
  64. package/dist/plugin/vite-plugin-config-loader.js +56 -0
  65. package/dist/plugin/vite-plugin-config.d.ts +4 -0
  66. package/dist/plugin/vite-plugin-config.js +38 -0
  67. package/dist/plugin/vite-plugin-dashboard-metadata.d.ts +9 -0
  68. package/dist/plugin/vite-plugin-dashboard-metadata.js +52 -0
  69. package/dist/plugin/vite-plugin-gql-tada.d.ts +6 -0
  70. package/dist/plugin/vite-plugin-gql-tada.js +51 -0
  71. package/dist/plugin/vite-plugin-set-root.d.ts +4 -0
  72. package/dist/plugin/vite-plugin-set-root.js +15 -0
  73. package/dist/plugin/vite-plugin-ui-config.d.ts +15 -0
  74. package/dist/plugin/vite-plugin-ui-config.js +43 -0
  75. package/dist/plugin/vite-plugin-vendure-dashboard.d.ts +35 -0
  76. package/dist/plugin/vite-plugin-vendure-dashboard.js +81 -0
  77. package/index.html +15 -0
  78. package/lingui.config.js +12 -0
  79. package/package.json +118 -0
  80. package/src/app/app-providers.tsx +30 -0
  81. package/src/app/main.tsx +97 -0
  82. package/src/app/routeTree.gen.ts +1372 -0
  83. package/src/app/routes/__root.tsx +24 -0
  84. package/src/app/routes/_authenticated/_administrators/administrators.graphql.ts +79 -0
  85. package/src/app/routes/_authenticated/_administrators/administrators.tsx +86 -0
  86. package/src/app/routes/_authenticated/_administrators/administrators_.$id.tsx +155 -0
  87. package/src/app/routes/_authenticated/_administrators/components/role-permissions-display.tsx +133 -0
  88. package/src/app/routes/_authenticated/_assets/assets.tsx +19 -0
  89. package/src/app/routes/_authenticated/_channels/channels.graphql.ts +93 -0
  90. package/src/app/routes/_authenticated/_channels/channels.tsx +60 -0
  91. package/src/app/routes/_authenticated/_channels/channels_.$id.tsx +248 -0
  92. package/src/app/routes/_authenticated/_collections/collections.graphql.ts +133 -0
  93. package/src/app/routes/_authenticated/_collections/collections.tsx +195 -0
  94. package/src/app/routes/_authenticated/_collections/collections_.$id.tsx +224 -0
  95. package/src/app/routes/_authenticated/_collections/components/collection-contents-preview-table.tsx +127 -0
  96. package/src/app/routes/_authenticated/_collections/components/collection-contents-sheet.tsx +46 -0
  97. package/src/app/routes/_authenticated/_collections/components/collection-contents-table.tsx +82 -0
  98. package/src/app/routes/_authenticated/_collections/components/collection-filters-selector.tsx +91 -0
  99. package/src/app/routes/_authenticated/_countries/countries.graphql.ts +69 -0
  100. package/src/app/routes/_authenticated/_countries/countries.tsx +67 -0
  101. package/src/app/routes/_authenticated/_countries/countries_.$id.tsx +122 -0
  102. package/src/app/routes/_authenticated/_customer-groups/components/customer-group-members-sheet.tsx +44 -0
  103. package/src/app/routes/_authenticated/_customer-groups/components/customer-group-members-table.tsx +129 -0
  104. package/src/app/routes/_authenticated/_customer-groups/customer-groups.graphql.ts +71 -0
  105. package/src/app/routes/_authenticated/_customer-groups/customer-groups.tsx +68 -0
  106. package/src/app/routes/_authenticated/_customer-groups/customer-groups_.$id.tsx +111 -0
  107. package/src/app/routes/_authenticated/_customers/components/customer-address-card.tsx +155 -0
  108. package/src/app/routes/_authenticated/_customers/components/customer-address-form.tsx +344 -0
  109. package/src/app/routes/_authenticated/_customers/components/customer-group-controls.tsx +4 -0
  110. package/src/app/routes/_authenticated/_customers/components/customer-history/customer-history-container.tsx +78 -0
  111. package/src/app/routes/_authenticated/_customers/components/customer-history/customer-history.tsx +77 -0
  112. package/src/app/routes/_authenticated/_customers/components/customer-history/index.ts +3 -0
  113. package/src/app/routes/_authenticated/_customers/components/customer-history/use-customer-history.ts +169 -0
  114. package/src/app/routes/_authenticated/_customers/components/customer-order-table.tsx +88 -0
  115. package/src/app/routes/_authenticated/_customers/components/customer-status-badge.tsx +33 -0
  116. package/src/app/routes/_authenticated/_customers/customers.graphql.ts +204 -0
  117. package/src/app/routes/_authenticated/_customers/customers.tsx +82 -0
  118. package/src/app/routes/_authenticated/_customers/customers_.$id.tsx +274 -0
  119. package/src/app/routes/_authenticated/_facets/components/edit-facet-value.tsx +129 -0
  120. package/src/app/routes/_authenticated/_facets/components/facet-values-sheet.tsx +46 -0
  121. package/src/app/routes/_authenticated/_facets/components/facet-values-table.tsx +97 -0
  122. package/src/app/routes/_authenticated/_facets/facets.graphql.ts +104 -0
  123. package/src/app/routes/_authenticated/_facets/facets.tsx +97 -0
  124. package/src/app/routes/_authenticated/_facets/facets_.$id.tsx +139 -0
  125. package/src/app/routes/_authenticated/_global-settings/global-settings.graphql.ts +28 -0
  126. package/src/app/routes/_authenticated/_global-settings/global-settings.tsx +161 -0
  127. package/src/app/routes/_authenticated/_orders/components/order-address.tsx +58 -0
  128. package/src/app/routes/_authenticated/_orders/components/order-history/index.ts +3 -0
  129. package/src/app/routes/_authenticated/_orders/components/order-history/order-history-container.tsx +73 -0
  130. package/src/app/routes/_authenticated/_orders/components/order-history/order-history.tsx +96 -0
  131. package/src/app/routes/_authenticated/_orders/components/order-history/use-order-history.ts +171 -0
  132. package/src/app/routes/_authenticated/_orders/components/order-table.tsx +169 -0
  133. package/src/app/routes/_authenticated/_orders/components/order-tax-summary.tsx +39 -0
  134. package/src/app/routes/_authenticated/_orders/components/payment-details.tsx +61 -0
  135. package/src/app/routes/_authenticated/_orders/orders.graphql.ts +325 -0
  136. package/src/app/routes/_authenticated/_orders/orders.tsx +120 -0
  137. package/src/app/routes/_authenticated/_orders/orders_.$id.tsx +133 -0
  138. package/src/app/routes/_authenticated/_payment-methods/components/payment-eligibility-checker-selector.tsx +104 -0
  139. package/src/app/routes/_authenticated/_payment-methods/components/payment-handler-selector.tsx +100 -0
  140. package/src/app/routes/_authenticated/_payment-methods/payment-methods.graphql.ts +83 -0
  141. package/src/app/routes/_authenticated/_payment-methods/payment-methods.tsx +64 -0
  142. package/src/app/routes/_authenticated/_payment-methods/payment-methods_.$id.tsx +183 -0
  143. package/src/app/routes/_authenticated/_product-variants/components/variant-price-detail.tsx +87 -0
  144. package/src/app/routes/_authenticated/_product-variants/product-variants.graphql.ts +123 -0
  145. package/src/app/routes/_authenticated/_product-variants/product-variants.tsx +78 -0
  146. package/src/app/routes/_authenticated/_product-variants/product-variants_.$id.tsx +331 -0
  147. package/src/app/routes/_authenticated/_products/components/create-product-variants-dialog.tsx +228 -0
  148. package/src/app/routes/_authenticated/_products/components/create-product-variants.tsx +462 -0
  149. package/src/app/routes/_authenticated/_products/components/option-value-input.tsx +96 -0
  150. package/src/app/routes/_authenticated/_products/components/product-variants-table.tsx +87 -0
  151. package/src/app/routes/_authenticated/_products/products.graphql.ts +116 -0
  152. package/src/app/routes/_authenticated/_products/products.tsx +48 -0
  153. package/src/app/routes/_authenticated/_products/products_.$id.tsx +196 -0
  154. package/src/app/routes/_authenticated/_profile/profile.graphql.ts +23 -0
  155. package/src/app/routes/_authenticated/_profile/profile.tsx +122 -0
  156. package/src/app/routes/_authenticated/_promotions/components/promotion-actions-selector.tsx +107 -0
  157. package/src/app/routes/_authenticated/_promotions/components/promotion-conditions-selector.tsx +107 -0
  158. package/src/app/routes/_authenticated/_promotions/promotions.graphql.ts +96 -0
  159. package/src/app/routes/_authenticated/_promotions/promotions.tsx +61 -0
  160. package/src/app/routes/_authenticated/_promotions/promotions_.$id.tsx +235 -0
  161. package/src/app/routes/_authenticated/_roles/components/expandable-permissions.tsx +54 -0
  162. package/src/app/routes/_authenticated/_roles/components/permissions-grid.tsx +116 -0
  163. package/src/app/routes/_authenticated/_roles/roles.graphql.ts +67 -0
  164. package/src/app/routes/_authenticated/_roles/roles.tsx +96 -0
  165. package/src/app/routes/_authenticated/_roles/roles_.$id.tsx +142 -0
  166. package/src/app/routes/_authenticated/_sellers/sellers.graphql.ts +61 -0
  167. package/src/app/routes/_authenticated/_sellers/sellers.tsx +51 -0
  168. package/src/app/routes/_authenticated/_sellers/sellers_.$id.tsx +111 -0
  169. package/src/app/routes/_authenticated/_shipping-methods/components/fulfillment-handler-selector.tsx +56 -0
  170. package/src/app/routes/_authenticated/_shipping-methods/components/shipping-calculator-selector.tsx +101 -0
  171. package/src/app/routes/_authenticated/_shipping-methods/components/shipping-eligibility-checker-selector.tsx +101 -0
  172. package/src/app/routes/_authenticated/_shipping-methods/components/test-shipping-method-dialog.tsx +32 -0
  173. package/src/app/routes/_authenticated/_shipping-methods/shipping-methods.graphql.ts +83 -0
  174. package/src/app/routes/_authenticated/_shipping-methods/shipping-methods.tsx +55 -0
  175. package/src/app/routes/_authenticated/_shipping-methods/shipping-methods_.$id.tsx +171 -0
  176. package/src/app/routes/_authenticated/_stock-locations/stock-locations.graphql.ts +62 -0
  177. package/src/app/routes/_authenticated/_stock-locations/stock-locations.tsx +48 -0
  178. package/src/app/routes/_authenticated/_stock-locations/stock-locations_.$id.tsx +115 -0
  179. package/src/app/routes/_authenticated/_system/components/payload-dialog.tsx +34 -0
  180. package/src/app/routes/_authenticated/_system/healthchecks.tsx +93 -0
  181. package/src/app/routes/_authenticated/_system/job-queue.graphql.ts +43 -0
  182. package/src/app/routes/_authenticated/_system/job-queue.tsx +161 -0
  183. package/src/app/routes/_authenticated/_tax-categories/tax-categories.graphql.ts +63 -0
  184. package/src/app/routes/_authenticated/_tax-categories/tax-categories.tsx +65 -0
  185. package/src/app/routes/_authenticated/_tax-categories/tax-categories_.$id.tsx +115 -0
  186. package/src/app/routes/_authenticated/_tax-rates/tax-rates.graphql.ts +75 -0
  187. package/src/app/routes/_authenticated/_tax-rates/tax-rates.tsx +108 -0
  188. package/src/app/routes/_authenticated/_tax-rates/tax-rates_.$id.tsx +148 -0
  189. package/src/app/routes/_authenticated/_zones/components/zone-countries-add.tsx +0 -0
  190. package/src/app/routes/_authenticated/_zones/components/zone-countries-sheet.tsx +31 -0
  191. package/src/app/routes/_authenticated/_zones/components/zone-countries-table.tsx +79 -0
  192. package/src/app/routes/_authenticated/_zones/zones.graphql.ts +96 -0
  193. package/src/app/routes/_authenticated/_zones/zones.tsx +57 -0
  194. package/src/app/routes/_authenticated/_zones/zones_.$id.tsx +103 -0
  195. package/src/app/routes/_authenticated/index.tsx +194 -0
  196. package/src/app/routes/_authenticated.tsx +25 -0
  197. package/src/app/routes/login.tsx +48 -0
  198. package/src/app/styles.css +82 -0
  199. package/src/app/tailwindcss-animate.css +275 -0
  200. package/src/i18n/locales/de.po +1579 -0
  201. package/src/i18n/locales/en.po +1579 -0
  202. package/src/lib/components/data-display/boolean.tsx +23 -0
  203. package/src/lib/components/data-display/date-time.tsx +13 -0
  204. package/src/lib/components/data-display/json.tsx +5 -0
  205. package/src/lib/components/data-display/money.tsx +15 -0
  206. package/src/lib/components/data-input/affixed-input.tsx +49 -0
  207. package/src/lib/components/data-input/customer-group-input.tsx +72 -0
  208. package/src/lib/components/data-input/datetime-input.tsx +150 -0
  209. package/src/lib/components/data-input/facet-value-input.tsx +68 -0
  210. package/src/lib/components/data-input/money-input.tsx +112 -0
  211. package/src/lib/components/data-input/richt-text-input.tsx +99 -0
  212. package/src/lib/components/data-table/data-table-column-header.tsx +73 -0
  213. package/src/lib/components/data-table/data-table-faceted-filter.tsx +172 -0
  214. package/src/lib/components/data-table/data-table-filter-dialog.tsx +73 -0
  215. package/src/lib/components/data-table/data-table-pagination.tsx +87 -0
  216. package/src/lib/components/data-table/data-table-view-options.tsx +53 -0
  217. package/src/lib/components/data-table/data-table.tsx +218 -0
  218. package/src/lib/components/layout/app-layout.tsx +42 -0
  219. package/src/lib/components/layout/app-sidebar.tsx +34 -0
  220. package/src/lib/components/layout/channel-switcher.tsx +87 -0
  221. package/src/lib/components/layout/content-language-selector.tsx +41 -0
  222. package/src/lib/components/layout/generated-breadcrumbs.tsx +82 -0
  223. package/src/lib/components/layout/language-dialog.tsx +104 -0
  224. package/src/lib/components/layout/nav-main.tsx +178 -0
  225. package/src/lib/components/layout/nav-projects.tsx +81 -0
  226. package/src/lib/components/layout/nav-user.tsx +176 -0
  227. package/src/lib/components/layout/prerelease-popup.tsx +38 -0
  228. package/src/lib/components/login/login-form.tsx +173 -0
  229. package/src/lib/components/shared/alerts.tsx +20 -0
  230. package/src/lib/components/shared/animated-number.tsx +49 -0
  231. package/src/lib/components/shared/asset-gallery.tsx +433 -0
  232. package/src/lib/components/shared/asset-picker-dialog.tsx +72 -0
  233. package/src/lib/components/shared/asset-preview-dialog.tsx +48 -0
  234. package/src/lib/components/shared/asset-preview.tsx +345 -0
  235. package/src/lib/components/shared/assigned-facet-values.tsx +68 -0
  236. package/src/lib/components/shared/channel-code-label.tsx +7 -0
  237. package/src/lib/components/shared/channel-selector.tsx +51 -0
  238. package/src/lib/components/shared/configurable-operation-arg-input.tsx +51 -0
  239. package/src/lib/components/shared/configurable-operation-input.tsx +133 -0
  240. package/src/lib/components/shared/confirmation-dialog.tsx +58 -0
  241. package/src/lib/components/shared/copyable-text.tsx +31 -0
  242. package/src/lib/components/shared/country-selector.tsx +105 -0
  243. package/src/lib/components/shared/currency-selector.tsx +33 -0
  244. package/src/lib/components/shared/custom-fields-form.tsx +86 -0
  245. package/src/lib/components/shared/customer-address-form.tsx +330 -0
  246. package/src/lib/components/shared/customer-group-chip.tsx +30 -0
  247. package/src/lib/components/shared/customer-group-selector.tsx +62 -0
  248. package/src/lib/components/shared/customer-selector.tsx +107 -0
  249. package/src/lib/components/shared/detail-page-button.tsx +22 -0
  250. package/src/lib/components/shared/entity-assets.tsx +340 -0
  251. package/src/lib/components/shared/error-page.tsx +31 -0
  252. package/src/lib/components/shared/facet-value-chip.tsx +45 -0
  253. package/src/lib/components/shared/facet-value-selector.tsx +306 -0
  254. package/src/lib/components/shared/focal-point-control.tsx +65 -0
  255. package/src/lib/components/shared/form-field-wrapper.tsx +37 -0
  256. package/src/lib/components/shared/history-timeline/history-entry.tsx +112 -0
  257. package/src/lib/components/shared/history-timeline/history-note-checkbox.tsx +28 -0
  258. package/src/lib/components/shared/history-timeline/history-note-editor.tsx +60 -0
  259. package/src/lib/components/shared/history-timeline/history-note-input.tsx +39 -0
  260. package/src/lib/components/shared/history-timeline/history-timeline.tsx +56 -0
  261. package/src/lib/components/shared/icon-mark.tsx +18 -0
  262. package/src/lib/components/shared/language-selector.tsx +48 -0
  263. package/src/lib/components/shared/logo-mark.tsx +24 -0
  264. package/src/lib/components/shared/multi-select.tsx +159 -0
  265. package/src/lib/components/shared/option-value-input.tsx +95 -0
  266. package/src/lib/components/shared/paginated-list-data-table.tsx +520 -0
  267. package/src/lib/components/shared/permission-guard.tsx +21 -0
  268. package/src/lib/components/shared/rich-text-editor.tsx +0 -0
  269. package/src/lib/components/shared/role-code-label.tsx +8 -0
  270. package/src/lib/components/shared/role-selector.tsx +56 -0
  271. package/src/lib/components/shared/seller-selector.tsx +107 -0
  272. package/src/lib/components/shared/tax-category-selector.tsx +65 -0
  273. package/src/lib/components/shared/translatable-form-field.tsx +74 -0
  274. package/src/lib/components/shared/vendure-image.tsx +159 -0
  275. package/src/lib/components/shared/zone-selector.tsx +66 -0
  276. package/src/lib/components/ui/accordion.tsx +59 -0
  277. package/src/lib/components/ui/alert-dialog.tsx +128 -0
  278. package/src/lib/components/ui/alert.tsx +60 -0
  279. package/src/lib/components/ui/avatar.tsx +38 -0
  280. package/src/lib/components/ui/badge.tsx +38 -0
  281. package/src/lib/components/ui/breadcrumb.tsx +102 -0
  282. package/src/lib/components/ui/button.tsx +51 -0
  283. package/src/lib/components/ui/calendar.tsx +69 -0
  284. package/src/lib/components/ui/card.tsx +47 -0
  285. package/src/lib/components/ui/checkbox.tsx +27 -0
  286. package/src/lib/components/ui/collapsible.tsx +33 -0
  287. package/src/lib/components/ui/command.tsx +133 -0
  288. package/src/lib/components/ui/dialog.tsx +116 -0
  289. package/src/lib/components/ui/dropdown-menu.tsx +220 -0
  290. package/src/lib/components/ui/form.tsx +141 -0
  291. package/src/lib/components/ui/hover-card.tsx +36 -0
  292. package/src/lib/components/ui/input.tsx +19 -0
  293. package/src/lib/components/ui/label.tsx +21 -0
  294. package/src/lib/components/ui/pagination.tsx +127 -0
  295. package/src/lib/components/ui/popover.tsx +40 -0
  296. package/src/lib/components/ui/scroll-area.tsx +50 -0
  297. package/src/lib/components/ui/select.tsx +161 -0
  298. package/src/lib/components/ui/separator.tsx +26 -0
  299. package/src/lib/components/ui/sheet.tsx +118 -0
  300. package/src/lib/components/ui/sidebar.tsx +696 -0
  301. package/src/lib/components/ui/skeleton.tsx +13 -0
  302. package/src/lib/components/ui/sonner.tsx +27 -0
  303. package/src/lib/components/ui/switch.tsx +26 -0
  304. package/src/lib/components/ui/table.tsx +82 -0
  305. package/src/lib/components/ui/tabs.tsx +48 -0
  306. package/src/lib/components/ui/textarea.tsx +18 -0
  307. package/src/lib/components/ui/tooltip.tsx +51 -0
  308. package/src/lib/constants.ts +326 -0
  309. package/src/lib/framework/component-registry/component-registry.tsx +70 -0
  310. package/src/lib/framework/component-registry/dynamic-component.tsx +58 -0
  311. package/src/lib/framework/dashboard-widget/base-widget.tsx +97 -0
  312. package/src/lib/framework/dashboard-widget/latest-orders-widget/index.tsx +96 -0
  313. package/src/lib/framework/dashboard-widget/latest-orders-widget/latest-orders-widget.graphql.ts +35 -0
  314. package/src/lib/framework/dashboard-widget/metrics-widget/chart.tsx +24 -0
  315. package/src/lib/framework/dashboard-widget/metrics-widget/index.tsx +82 -0
  316. package/src/lib/framework/dashboard-widget/metrics-widget/metrics-widget.graphql.ts +14 -0
  317. package/src/lib/framework/dashboard-widget/orders-summary/index.tsx +167 -0
  318. package/src/lib/framework/dashboard-widget/orders-summary/order-summary-widget.graphql.ts +14 -0
  319. package/src/lib/framework/dashboard-widget/types.ts +22 -0
  320. package/src/lib/framework/dashboard-widget/widget-extensions.tsx +19 -0
  321. package/src/lib/framework/defaults.ts +219 -0
  322. package/src/lib/framework/document-introspection/add-custom-fields.spec.ts +242 -0
  323. package/src/lib/framework/document-introspection/add-custom-fields.ts +246 -0
  324. package/src/lib/framework/document-introspection/get-document-structure.spec.ts +310 -0
  325. package/src/lib/framework/document-introspection/get-document-structure.ts +460 -0
  326. package/src/lib/framework/document-introspection/hooks.ts +10 -0
  327. package/src/lib/framework/extension-api/define-dashboard-extension.ts +66 -0
  328. package/src/lib/framework/extension-api/extension-api-types.ts +58 -0
  329. package/src/lib/framework/extension-api/use-dashboard-extensions.ts +26 -0
  330. package/src/lib/framework/form-engine/form-schema-tools.ts +98 -0
  331. package/src/lib/framework/form-engine/use-generated-form.tsx +116 -0
  332. package/src/lib/framework/layout-engine/layout-extensions.ts +30 -0
  333. package/src/lib/framework/layout-engine/location-wrapper.tsx +96 -0
  334. package/src/lib/framework/layout-engine/page-layout.tsx +272 -0
  335. package/src/lib/framework/nav-menu/nav-menu-extensions.ts +66 -0
  336. package/src/lib/framework/page/detail-page-route-loader.tsx +48 -0
  337. package/src/lib/framework/page/detail-page.tsx +131 -0
  338. package/src/lib/framework/page/list-page.tsx +166 -0
  339. package/src/lib/framework/page/page-api.ts +9 -0
  340. package/src/lib/framework/page/page-types.ts +51 -0
  341. package/src/lib/framework/page/use-detail-page.ts +217 -0
  342. package/src/lib/framework/page/use-extended-router.tsx +69 -0
  343. package/src/lib/framework/registry/global-registry.ts +46 -0
  344. package/src/lib/framework/registry/registry-types.ts +15 -0
  345. package/src/lib/graphql/api.ts +61 -0
  346. package/src/lib/graphql/fragments.tsx +54 -0
  347. package/src/lib/graphql/graphql-env.d.ts +499 -0
  348. package/src/lib/graphql/graphql.ts +15 -0
  349. package/src/lib/hooks/use-auth.tsx +11 -0
  350. package/src/lib/hooks/use-channel.ts +12 -0
  351. package/src/lib/hooks/use-custom-field-config.ts +10 -0
  352. package/src/lib/hooks/use-grouped-permissions.ts +54 -0
  353. package/src/lib/hooks/use-local-format.ts +119 -0
  354. package/src/lib/hooks/use-mobile.ts +19 -0
  355. package/src/lib/hooks/use-page.tsx +11 -0
  356. package/src/lib/hooks/use-permissions.ts +22 -0
  357. package/src/lib/hooks/use-server-config.ts +4 -0
  358. package/src/lib/hooks/use-theme.ts +10 -0
  359. package/src/lib/hooks/use-user-settings.tsx +12 -0
  360. package/src/lib/index.ts +149 -0
  361. package/src/lib/lib/trans.tsx +16 -0
  362. package/src/lib/lib/utils.ts +60 -0
  363. package/src/lib/providers/auth.tsx +152 -0
  364. package/src/lib/providers/channel-provider.tsx +121 -0
  365. package/src/lib/providers/i18n-provider.tsx +28 -0
  366. package/src/lib/providers/server-config.tsx +279 -0
  367. package/src/lib/providers/theme-provider.tsx +54 -0
  368. package/src/lib/providers/user-settings.tsx +89 -0
  369. package/src/lib/virtual.d.ts +12 -0
  370. package/vite/config-loader.ts +181 -0
  371. package/vite/constants.ts +280 -0
  372. package/vite/index.ts +1 -0
  373. package/vite/schema-generator.ts +40 -0
  374. package/vite/ui-config.ts +60 -0
  375. package/vite/vite-plugin-admin-api-schema.ts +141 -0
  376. package/vite/vite-plugin-config-loader.ts +64 -0
  377. package/vite/vite-plugin-config.ts +42 -0
  378. package/vite/vite-plugin-dashboard-metadata.ts +58 -0
  379. package/vite/vite-plugin-gql-tada.ts +62 -0
  380. package/vite/vite-plugin-theme.ts +195 -0
  381. package/vite/vite-plugin-ui-config.ts +60 -0
  382. package/vite/vite-plugin-vendure-dashboard.ts +118 -0
@@ -0,0 +1,48 @@
1
+ import { NEW_ENTITY_PATH } from '@/constants.js';
2
+
3
+ import { PageBreadcrumb } from '@/components/layout/generated-breadcrumbs.js';
4
+ import { TypedDocumentNode } from '@graphql-typed-document-node/core';
5
+ import { FileBaseRouteOptions } from '@tanstack/react-router';
6
+ import { getQueryName, getQueryTypeFieldInfo } from '../document-introspection/get-document-structure.js';
7
+ import { DetailEntity } from './page-types.js';
8
+ import { getDetailQueryOptions } from './use-detail-page.js';
9
+ import { addCustomFields } from '../document-introspection/add-custom-fields.js';
10
+ export interface DetailPageRouteLoaderConfig<T extends TypedDocumentNode<any, any>> {
11
+ queryDocument: T;
12
+ breadcrumb: (isNew: boolean, entity: DetailEntity<T>) => Array<PageBreadcrumb | undefined>;
13
+ }
14
+
15
+ export function detailPageRouteLoader<T extends TypedDocumentNode<any, any>>({
16
+ queryDocument,
17
+ breadcrumb,
18
+ }: DetailPageRouteLoaderConfig<T>) {
19
+ const loader: FileBaseRouteOptions<any, any>['loader'] = async ({
20
+ context,
21
+ params,
22
+ }: {
23
+ context: any;
24
+ params: any;
25
+ }) => {
26
+ if (!params.id) {
27
+ throw new Error('ID param is required');
28
+ }
29
+ const isNew = params.id === NEW_ENTITY_PATH;
30
+ const result = isNew
31
+ ? null
32
+ : await context.queryClient.ensureQueryData(
33
+ getDetailQueryOptions(addCustomFields(queryDocument), { id: params.id }),
34
+ { id: params.id },
35
+ );
36
+
37
+ const entityField = getQueryName(queryDocument);
38
+ const entityName = getQueryTypeFieldInfo(queryDocument)?.type;
39
+
40
+ if (!isNew && !result[entityField]) {
41
+ throw new Error(`${entityName} with the ID ${params.id} was not found`);
42
+ }
43
+ return {
44
+ breadcrumb: breadcrumb(isNew, result?.[entityField]),
45
+ };
46
+ };
47
+ return loader;
48
+ }
@@ -0,0 +1,131 @@
1
+ import { FormFieldWrapper } from '@/components/shared/form-field-wrapper.js';
2
+ import { Input } from '@/components/ui/input.js';
3
+ import { useDetailPage } from '@/framework/page/use-detail-page.js';
4
+ import { Trans } from '@/lib/trans.js';
5
+ import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
6
+ import { AnyRoute } from '@tanstack/react-router';
7
+ import { ResultOf, VariablesOf } from 'gql.tada';
8
+
9
+ import { DateTimeInput } from '@/components/data-input/datetime-input.js';
10
+ import { Button } from '@/components/ui/button.js';
11
+ import { Checkbox } from '@/components/ui/checkbox.js';
12
+ import { toast } from 'sonner';
13
+ import { getOperationVariablesFields } from '../document-introspection/get-document-structure.js';
14
+ import {
15
+ DetailFormGrid,
16
+ Page,
17
+ PageActionBar,
18
+ PageActionBarLeft,
19
+ PageActionBarRight,
20
+ PageBlock,
21
+ PageLayout,
22
+ PageTitle,
23
+ } from '../layout-engine/page-layout.js';
24
+ import { DetailEntityPath } from './page-types.js';
25
+
26
+ export interface DetailPageProps<
27
+ T extends TypedDocumentNode<any, any>,
28
+ C extends TypedDocumentNode<any, any>,
29
+ U extends TypedDocumentNode<any, any>,
30
+ EntityField extends keyof ResultOf<T> = DetailEntityPath<T>,
31
+ > {
32
+ pageId: string;
33
+ route: AnyRoute;
34
+ title: (entity: ResultOf<T>[EntityField]) => string;
35
+ queryDocument: T;
36
+ createDocument?: C;
37
+ updateDocument: U;
38
+ setValuesForUpdate: (entity: ResultOf<T>[EntityField]) => VariablesOf<U>['input'];
39
+ }
40
+
41
+ export function DetailPage<
42
+ T extends TypedDocumentNode<any, any>,
43
+ C extends TypedDocumentNode<any, any>,
44
+ U extends TypedDocumentNode<any, any>,
45
+ >({
46
+ pageId,
47
+ route,
48
+ queryDocument,
49
+ createDocument,
50
+ updateDocument,
51
+ setValuesForUpdate,
52
+ title,
53
+ }: DetailPageProps<T, C, U>) {
54
+ const params = route.useParams();
55
+
56
+ const { form, submitHandler, entity, isPending, resetForm } = useDetailPage<any, any, any>({
57
+ queryDocument,
58
+ updateDocument,
59
+ createDocument,
60
+ params: { id: params.id },
61
+ setValuesForUpdate,
62
+ onSuccess: () => {
63
+ toast.success('Updated successfully');
64
+ resetForm();
65
+ },
66
+ onError: error => {
67
+ toast.error('Failed to update', {
68
+ description: error instanceof Error ? error.message : 'Unknown error',
69
+ });
70
+ },
71
+ });
72
+
73
+ const updateFields = getOperationVariablesFields(updateDocument);
74
+
75
+ return (
76
+ <Page pageId={pageId} form={form} submitHandler={submitHandler}>
77
+ <PageActionBar>
78
+ <PageActionBarLeft>
79
+ <PageTitle>{title(entity)}</PageTitle>
80
+ </PageActionBarLeft>
81
+ <PageActionBarRight>
82
+ <Button
83
+ type="submit"
84
+ disabled={!form.formState.isDirty || !form.formState.isValid || isPending}
85
+ >
86
+ <Trans>Update</Trans>
87
+ </Button>
88
+ </PageActionBarRight>
89
+ </PageActionBar>
90
+ <PageLayout>
91
+ <PageBlock column="main" blockId="main-form">
92
+ <DetailFormGrid>
93
+ {updateFields.map(fieldInfo => {
94
+ if (fieldInfo.name === 'id' && fieldInfo.type === 'ID') {
95
+ return null;
96
+ }
97
+ return (
98
+ <FormFieldWrapper
99
+ key={fieldInfo.name}
100
+ control={form.control}
101
+ name={fieldInfo.name as never}
102
+ label={fieldInfo.name}
103
+ render={({ field }) => {
104
+ switch (fieldInfo.type) {
105
+ case 'Int':
106
+ case 'Float':
107
+ return (
108
+ <Input
109
+ type="number"
110
+ value={field.value}
111
+ onChange={e => field.onChange(e.target.valueAsNumber)}
112
+ />
113
+ );
114
+ case 'DateTime':
115
+ return <DateTimeInput {...field} />;
116
+ case 'Boolean':
117
+ return <Checkbox {...field} />;
118
+ case 'String':
119
+ default:
120
+ return <Input {...field} />;
121
+ }
122
+ }}
123
+ />
124
+ );
125
+ })}
126
+ </DetailFormGrid>
127
+ </PageBlock>
128
+ </PageLayout>
129
+ </Page>
130
+ );
131
+ }
@@ -0,0 +1,166 @@
1
+ import {
2
+ AdditionalColumns,
3
+ CustomizeColumnConfig,
4
+ FacetedFilterConfig,
5
+ ListQueryOptionsShape,
6
+ ListQueryShape,
7
+ PaginatedListDataTable,
8
+ RowAction,
9
+ } from '@/components/shared/paginated-list-data-table.js';
10
+ import { TypedDocumentNode } from '@graphql-typed-document-node/core';
11
+ import { AnyRoute, AnyRouter, useNavigate } from '@tanstack/react-router';
12
+ import { ColumnFiltersState, SortingState, Table } from '@tanstack/react-table';
13
+ import { TableOptions } from '@tanstack/table-core';
14
+ import { ResultOf } from 'gql.tada';
15
+ import { addCustomFields } from '../document-introspection/add-custom-fields.js';
16
+ import {
17
+ FullWidthPageBlock,
18
+ Page,
19
+ PageActionBar,
20
+ PageLayout,
21
+ PageTitle,
22
+ } from '../layout-engine/page-layout.js';
23
+
24
+ type ListQueryFields<T extends TypedDocumentNode<any, any>> = {
25
+ [Key in keyof ResultOf<T>]: ResultOf<T>[Key] extends { items: infer U }
26
+ ? U extends any[]
27
+ ? U[number]
28
+ : never
29
+ : never;
30
+ }[keyof ResultOf<T>];
31
+
32
+ export interface ListPageProps<
33
+ T extends TypedDocumentNode<U, V>,
34
+ U extends ListQueryShape,
35
+ V extends ListQueryOptionsShape,
36
+ AC extends AdditionalColumns<T>,
37
+ > {
38
+ pageId?: string;
39
+ route: AnyRoute | (() => AnyRoute);
40
+ title: string | React.ReactElement;
41
+ listQuery: T;
42
+ deleteMutation?: TypedDocumentNode<any, { id: string }>;
43
+ transformVariables?: (variables: V) => V;
44
+ onSearchTermChange?: (searchTerm: string) => NonNullable<V['options']>['filter'];
45
+ customizeColumns?: CustomizeColumnConfig<T>;
46
+ additionalColumns?: AC;
47
+ defaultColumnOrder?: (keyof ListQueryFields<T> | keyof AC)[];
48
+ defaultSort?: SortingState;
49
+ defaultVisibility?: Partial<Record<keyof ListQueryFields<T> | keyof AC, boolean>>;
50
+ children?: React.ReactNode;
51
+ facetedFilters?: FacetedFilterConfig<T>;
52
+ rowActions?: RowAction<ListQueryFields<T>>[];
53
+ transformData?: (data: any[]) => any[];
54
+ setTableOptions?: (table: TableOptions<any>) => TableOptions<any>;
55
+ }
56
+
57
+ export function ListPage<
58
+ T extends TypedDocumentNode<U, V>,
59
+ U extends Record<string, any> = any,
60
+ V extends ListQueryOptionsShape = ListQueryOptionsShape,
61
+ AC extends AdditionalColumns<T> = AdditionalColumns<T>,
62
+ >({
63
+ pageId,
64
+ title,
65
+ listQuery,
66
+ deleteMutation,
67
+ transformVariables,
68
+ customizeColumns,
69
+ additionalColumns,
70
+ defaultColumnOrder,
71
+ defaultSort,
72
+ route: routeOrFn,
73
+ defaultVisibility,
74
+ onSearchTermChange,
75
+ facetedFilters,
76
+ children,
77
+ rowActions,
78
+ transformData,
79
+ setTableOptions,
80
+ }: ListPageProps<T, U, V, AC>) {
81
+ const route = typeof routeOrFn === 'function' ? routeOrFn() : routeOrFn;
82
+ const routeSearch = route.useSearch();
83
+ const navigate = useNavigate<AnyRouter>({ from: route.fullPath });
84
+
85
+ const pagination = {
86
+ page: routeSearch.page ? parseInt(routeSearch.page) : 1,
87
+ itemsPerPage: routeSearch.perPage ? parseInt(routeSearch.perPage) : 10,
88
+ };
89
+
90
+ const sorting: SortingState = (routeSearch.sort ?? '')
91
+ .split(',')
92
+ .filter((s: string) => s.length)
93
+ .map((s: string) => {
94
+ return {
95
+ id: s.replace(/^-/, ''),
96
+ desc: s.startsWith('-'),
97
+ };
98
+ });
99
+
100
+ if (defaultSort && !sorting.length) {
101
+ sorting.push(...defaultSort);
102
+ }
103
+
104
+ function sortToString(sortingStates?: SortingState) {
105
+ return sortingStates?.map(s => `${s.desc ? '-' : ''}${s.id}`).join(',');
106
+ }
107
+
108
+ function persistListStateToUrl(
109
+ table: Table<any>,
110
+ listState: {
111
+ page?: number;
112
+ perPage?: number;
113
+ sort?: SortingState;
114
+ filters?: ColumnFiltersState;
115
+ },
116
+ ) {
117
+ const tableState = table.getState();
118
+ const page = listState.page || tableState.pagination.pageIndex + 1;
119
+ const perPage = listState.perPage || tableState.pagination.pageSize;
120
+ const sort = sortToString(listState.sort ?? tableState.sorting);
121
+ const filters = listState.filters ?? tableState.columnFilters;
122
+ navigate({
123
+ search: () => ({ sort, page, perPage, filters: filters.length ? filters : undefined }) as never,
124
+ });
125
+ }
126
+
127
+ const listQueryWithCustomFields = addCustomFields(listQuery);
128
+
129
+ return (
130
+ <Page pageId={pageId}>
131
+ <PageTitle>{title}</PageTitle>
132
+ <PageActionBar>{children}</PageActionBar>
133
+ <PageLayout>
134
+ <FullWidthPageBlock blockId="list-table">
135
+ <PaginatedListDataTable
136
+ listQuery={listQueryWithCustomFields}
137
+ deleteMutation={deleteMutation}
138
+ transformVariables={transformVariables}
139
+ customizeColumns={customizeColumns as any}
140
+ additionalColumns={additionalColumns as any}
141
+ defaultColumnOrder={defaultColumnOrder}
142
+ defaultVisibility={defaultVisibility}
143
+ onSearchTermChange={onSearchTermChange}
144
+ page={pagination.page}
145
+ itemsPerPage={pagination.itemsPerPage}
146
+ sorting={sorting}
147
+ columnFilters={routeSearch.filters}
148
+ onPageChange={(table, page, perPage) => {
149
+ persistListStateToUrl(table, { page, perPage });
150
+ }}
151
+ onSortChange={(table, sorting) => {
152
+ persistListStateToUrl(table, { sort: sorting });
153
+ }}
154
+ onFilterChange={(table, filters) => {
155
+ persistListStateToUrl(table, { filters });
156
+ }}
157
+ facetedFilters={facetedFilters}
158
+ rowActions={rowActions}
159
+ setTableOptions={setTableOptions}
160
+ transformData={transformData}
161
+ />
162
+ </FullWidthPageBlock>
163
+ </PageLayout>
164
+ </Page>
165
+ );
166
+ }
@@ -0,0 +1,9 @@
1
+ import { DashboardRouteDefinition } from '@/framework/extension-api/extension-api-types.js';
2
+
3
+ export const extensionRoutes = new Map<string, DashboardRouteDefinition>();
4
+
5
+ export function registerRoute(config: DashboardRouteDefinition) {
6
+ if (config.path) {
7
+ extensionRoutes.set(config.path, config);
8
+ }
9
+ }
@@ -0,0 +1,51 @@
1
+ import { ResultOf, TypedDocumentNode } from '@graphql-typed-document-node/core';
2
+
3
+ // Type that identifies a paginated list structure (has items array and totalItems)
4
+ type IsEntity<T> = T extends { id: string } ? true : false;
5
+
6
+ // Helper type to extract string keys from an object
7
+ type StringKeys<T> = T extends object ? Extract<keyof T, string> : never;
8
+
9
+ /**
10
+ * @description
11
+ * This type is used to extract the path to the entity from the query result.
12
+ *
13
+ * For example, if you have a query like this:
14
+ *
15
+ * ```graphql
16
+ * query GetEntity($id: ID!) {
17
+ * entity(id: $id) {
18
+ * id
19
+ * name
20
+ * }
21
+ * }
22
+ * ```
23
+ *
24
+ * The `DetailEntityPath` type will be `'entity'`.
25
+ */
26
+ export type DetailEntityPath<T extends TypedDocumentNode<any, any>> = {
27
+ [K in StringKeys<ResultOf<T>>]: NonNullable<ResultOf<T>[K]> extends object
28
+ ? IsEntity<NonNullable<ResultOf<T>[K]>> extends true
29
+ ? K
30
+ : never
31
+ : never;
32
+ }[StringKeys<ResultOf<T>>];
33
+
34
+ /**
35
+ * @description
36
+ * This type is used to extract the entity from the query result.
37
+ *
38
+ * For example, if you have a query like this:
39
+ *
40
+ * ```graphql
41
+ * query GetEntity($id: ID!) {
42
+ * entity(id: $id) {
43
+ * id
44
+ * name
45
+ * }
46
+ * }
47
+
48
+ * ```
49
+ * The `DetailEntity` type will be `{ id: string, name: string }`.
50
+ */
51
+ export type DetailEntity<T extends TypedDocumentNode<any, any>> = ResultOf<T>[DetailEntityPath<T>];
@@ -0,0 +1,217 @@
1
+ import { NEW_ENTITY_PATH } from '@/constants.js';
2
+ import { api, Variables } from '@/graphql/api.js';
3
+ import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
4
+ import {
5
+ DefinedInitialDataOptions,
6
+ queryOptions,
7
+ useMutation,
8
+ useQueryClient,
9
+ useSuspenseQuery,
10
+ } from '@tanstack/react-query';
11
+ import { ResultOf, VariablesOf } from 'gql.tada';
12
+ import { DocumentNode } from 'graphql';
13
+ import { FormEvent } from 'react';
14
+ import { UseFormReturn } from 'react-hook-form';
15
+
16
+ import { addCustomFields } from '../document-introspection/add-custom-fields.js';
17
+ import { getMutationName, getQueryName } from '../document-introspection/get-document-structure.js';
18
+ import { useGeneratedForm } from '../form-engine/use-generated-form.js';
19
+
20
+ import { DetailEntityPath } from './page-types.js';
21
+
22
+ // Utility type to remove null from a type union
23
+ type RemoveNull<T> = T extends null ? never : T;
24
+
25
+ type RemoveNullFields<T> = {
26
+ [K in keyof T]: RemoveNull<T[K]>;
27
+ };
28
+
29
+ export interface DetailPageOptions<
30
+ T extends TypedDocumentNode<any, any>,
31
+ C extends TypedDocumentNode<any, any>,
32
+ U extends TypedDocumentNode<any, any>,
33
+ EntityField extends keyof ResultOf<T> = DetailEntityPath<T>,
34
+ VarNameCreate extends keyof VariablesOf<C> = 'input',
35
+ VarNameUpdate extends keyof VariablesOf<U> = 'input',
36
+ > {
37
+ /**
38
+ * @description
39
+ * The query document to fetch the entity.
40
+ */
41
+ queryDocument: T;
42
+ /**
43
+ * @description
44
+ * The field of the query document that contains the entity.
45
+ */
46
+ entityField?: EntityField;
47
+ /**
48
+ * @description
49
+ * The parameters used to identify the entity.
50
+ */
51
+ params: {
52
+ id: string;
53
+ };
54
+ /**
55
+ * @description
56
+ * The document to create the entity.
57
+ */
58
+ createDocument?: C;
59
+ /**
60
+ * @description
61
+ * The document to update the entity.
62
+ */
63
+ updateDocument?: U;
64
+ /**
65
+ * @description
66
+ * The function to set the values for the update document.
67
+ */
68
+ setValuesForUpdate: (entity: NonNullable<ResultOf<T>[EntityField]>) => VariablesOf<U>[VarNameUpdate];
69
+ transformCreateInput?: (input: VariablesOf<C>[VarNameCreate]) => VariablesOf<C>[VarNameCreate];
70
+ transformUpdateInput?: (input: VariablesOf<U>[VarNameUpdate]) => VariablesOf<U>[VarNameUpdate];
71
+ /**
72
+ * @description
73
+ * The function to call when the update is successful.
74
+ */
75
+ onSuccess?: (entity: ResultOf<C>[keyof ResultOf<C>] | ResultOf<U>[keyof ResultOf<U>]) => void;
76
+ /**
77
+ * @description
78
+ * The function to call when the update is successful.
79
+ */
80
+ onError?: (error: unknown) => void;
81
+ }
82
+
83
+ export function getDetailQueryOptions<T, V extends Variables = Variables>(
84
+ document: TypedDocumentNode<T, V> | DocumentNode,
85
+ variables: V,
86
+ ): DefinedInitialDataOptions {
87
+ const queryName = getQueryName(document);
88
+ return queryOptions({
89
+ queryKey: ['DetailPage', queryName, variables],
90
+ queryFn: () => api.query(document, variables),
91
+ }) as DefinedInitialDataOptions;
92
+ }
93
+
94
+ /**
95
+ * @description
96
+ * Adds a "customFields" property to the translations if the entity has translations.
97
+ */
98
+ export type DetailPageTranslations<
99
+ T extends TypedDocumentNode<any, any>,
100
+ EntityField extends keyof ResultOf<T>,
101
+ > = 'translations' extends keyof NonNullable<ResultOf<T>[EntityField]>
102
+ ? Array<NonNullable<ResultOf<T>[EntityField]>['translations'][number] & { customFields?: any }>
103
+ : undefined;
104
+
105
+ /**
106
+ * @description
107
+ * Adds a "customFields" property to the entity and a "translations" property to the entity.
108
+ */
109
+ export type DetailPageEntity<
110
+ T extends TypedDocumentNode<any, any>,
111
+ EntityField extends keyof ResultOf<T>,
112
+ > = ResultOf<T>[EntityField] & {
113
+ customFields?: any;
114
+ translations: DetailPageTranslations<T, EntityField>;
115
+ };
116
+
117
+ export interface UseDetailPageResult<
118
+ T extends TypedDocumentNode<any, any>,
119
+ C extends TypedDocumentNode<any, any>,
120
+ U extends TypedDocumentNode<any, any>,
121
+ EntityField extends keyof ResultOf<T>,
122
+ > {
123
+ form: UseFormReturn<RemoveNullFields<VariablesOf<U>['input']>>;
124
+ submitHandler: (event: FormEvent<HTMLFormElement>) => void;
125
+ entity?: DetailPageEntity<T, EntityField>;
126
+ isPending: boolean;
127
+ refreshEntity: () => void;
128
+ resetForm: () => void;
129
+ }
130
+
131
+ /**
132
+ * @description
133
+ * This hook is used to create an entity detail page which can read
134
+ * and update an entity.
135
+ */
136
+ export function useDetailPage<
137
+ T extends TypedDocumentNode<any, any>,
138
+ C extends TypedDocumentNode<any, any>,
139
+ U extends TypedDocumentNode<any, any>,
140
+ EntityField extends keyof ResultOf<T> = keyof ResultOf<T>,
141
+ VarNameUpdate extends keyof VariablesOf<U> = 'input',
142
+ VarNameCreate extends keyof VariablesOf<C> = 'input',
143
+ >(
144
+ options: DetailPageOptions<T, C, U, EntityField, VarNameCreate, VarNameUpdate>,
145
+ ): UseDetailPageResult<T, C, U, EntityField> {
146
+ const {
147
+ queryDocument,
148
+ createDocument,
149
+ updateDocument,
150
+ setValuesForUpdate,
151
+ transformCreateInput,
152
+ transformUpdateInput,
153
+ params,
154
+ entityField,
155
+ onSuccess,
156
+ onError,
157
+ } = options;
158
+ const isNew = params.id === NEW_ENTITY_PATH;
159
+ const queryClient = useQueryClient();
160
+ const detailQueryOptions = getDetailQueryOptions(addCustomFields(queryDocument), {
161
+ id: isNew ? '__NEW__' : params.id,
162
+ });
163
+ const detailQuery = useSuspenseQuery(detailQueryOptions);
164
+ const entityQueryField = entityField ?? getQueryName(queryDocument);
165
+ const entity = (detailQuery?.data as any)[entityQueryField] as
166
+ | DetailPageEntity<T, EntityField>
167
+ | undefined;
168
+
169
+ const resetForm = () => {
170
+ form.reset(form.getValues());
171
+ };
172
+
173
+ const createMutation = useMutation({
174
+ mutationFn: createDocument ? api.mutate(createDocument) : undefined,
175
+ onSuccess: data => {
176
+ if (createDocument) {
177
+ const createMutationName = getMutationName(createDocument);
178
+ onSuccess?.((data as any)[createMutationName]);
179
+ }
180
+ },
181
+ });
182
+
183
+ const updateMutation = useMutation({
184
+ mutationFn: updateDocument ? api.mutate(updateDocument) : undefined,
185
+ onSuccess: data => {
186
+ if (updateDocument) {
187
+ const updateMutationName = getMutationName(updateDocument);
188
+ onSuccess?.((data as any)[updateMutationName]);
189
+ void queryClient.invalidateQueries({ queryKey: detailQueryOptions.queryKey });
190
+ }
191
+ },
192
+ onError,
193
+ });
194
+
195
+ const document = isNew ? (createDocument ?? updateDocument) : updateDocument;
196
+ const { form, submitHandler } = useGeneratedForm({
197
+ document,
198
+ entity,
199
+ setValues: setValuesForUpdate,
200
+ onSubmit(values: any) {
201
+ if (isNew) {
202
+ createMutation.mutate({ input: transformCreateInput?.(values) ?? values });
203
+ } else {
204
+ updateMutation.mutate({ input: transformUpdateInput?.(values) ?? values });
205
+ }
206
+ },
207
+ });
208
+
209
+ return {
210
+ form: form as any,
211
+ submitHandler,
212
+ entity,
213
+ isPending: updateMutation.isPending || detailQuery?.isPending,
214
+ refreshEntity: detailQuery.refetch,
215
+ resetForm,
216
+ };
217
+ }
@@ -0,0 +1,69 @@
1
+ import { ErrorPage } from '@/components/shared/error-page.js';
2
+ import { useDashboardExtensions } from '@/framework/extension-api/use-dashboard-extensions.js';
3
+ import { ListPage } from '@/framework/page/list-page.js';
4
+ import { extensionRoutes } from '@/framework/page/page-api.js';
5
+ import { AUTHENTICATED_ROUTE_PREFIX } from '@/constants.js';
6
+ import { AnyRoute, createRoute, Router } from '@tanstack/react-router';
7
+ import { useMemo } from 'react';
8
+
9
+ /**
10
+ * Extends the TanStack Router with additional routes for each dashboard
11
+ * extension.
12
+ */
13
+ export const useExtendedRouter = (router: Router<AnyRoute, any, any>) => {
14
+ const { extensionsLoaded } = useDashboardExtensions();
15
+
16
+ return useMemo(() => {
17
+ if (!extensionsLoaded) {
18
+ return router;
19
+ }
20
+
21
+ const authenticatedRouteIndex = router.routeTree.children.findIndex(
22
+ (r: AnyRoute) => r.id === AUTHENTICATED_ROUTE_PREFIX,
23
+ );
24
+
25
+ if (authenticatedRouteIndex === -1) {
26
+ return router;
27
+ }
28
+
29
+ let authenticatedRoute: AnyRoute = router.routeTree.children[authenticatedRouteIndex];
30
+
31
+ const newRoutes: AnyRoute[] = [];
32
+ // Create new routes for each extension
33
+ for (const [path, config] of extensionRoutes.entries()) {
34
+ const pathWithoutLeadingSlash = path.startsWith('/') ? path.slice(1) : path;
35
+ if (
36
+ authenticatedRoute.children.findIndex((r: AnyRoute) => r.path === pathWithoutLeadingSlash) >
37
+ -1
38
+ ) {
39
+ // Skip if the route already exists
40
+ continue;
41
+ }
42
+
43
+ const newRoute: AnyRoute = createRoute({
44
+ path: `/${pathWithoutLeadingSlash}`,
45
+ getParentRoute: () => authenticatedRoute,
46
+ loader: config.loader,
47
+ component: () => config.component(newRoute),
48
+ errorComponent: ({ error }) => <ErrorPage message={error.message} />,
49
+ });
50
+ newRoutes.push(newRoute);
51
+ }
52
+
53
+ const childrenWithoutAuthenticated = router.routeTree.children.filter(
54
+ (r: AnyRoute) => r.id !== AUTHENTICATED_ROUTE_PREFIX,
55
+ );
56
+
57
+ // Create a new router with the modified route tree
58
+ const newRouter = new Router({
59
+ routeTree: router.routeTree.addChildren([
60
+ ...childrenWithoutAuthenticated,
61
+ authenticatedRoute.addChildren([...authenticatedRoute.children, ...newRoutes]),
62
+ ]),
63
+ basepath: router.basepath,
64
+ defaultPreload: router.options.defaultPreload,
65
+ defaultPreloadDelay: router.options.defaultPreloadDelay,
66
+ });
67
+ return newRouter;
68
+ }, [router, extensionsLoaded]);
69
+ };