@databricks/appkit-ui 0.12.0 → 0.12.2

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 (357) hide show
  1. package/CLAUDE.md +155 -147
  2. package/dist/cli/commands/docs.js +80 -17
  3. package/dist/cli/commands/docs.js.map +1 -1
  4. package/dist/react/charts/area/index.d.ts +2 -2
  5. package/dist/react/charts/bar/index.d.ts +2 -2
  6. package/dist/react/charts/base.d.ts +2 -2
  7. package/dist/react/charts/base.d.ts.map +1 -1
  8. package/dist/react/charts/create-chart.d.ts +2 -2
  9. package/dist/react/charts/create-chart.d.ts.map +1 -1
  10. package/dist/react/charts/heatmap/index.d.ts +2 -2
  11. package/dist/react/charts/line/index.d.ts +2 -2
  12. package/dist/react/charts/pie/index.d.ts +3 -3
  13. package/dist/react/charts/radar/index.d.ts +2 -2
  14. package/dist/react/charts/scatter/index.d.ts +2 -2
  15. package/dist/react/charts/wrapper.d.ts +2 -2
  16. package/dist/react/charts/wrapper.d.ts.map +1 -1
  17. package/dist/react/table/data-table.d.ts +2 -2
  18. package/dist/react/table/data-table.d.ts.map +1 -1
  19. package/dist/react/ui/accordion.d.ts +5 -5
  20. package/dist/react/ui/accordion.d.ts.map +1 -1
  21. package/dist/react/ui/alert-dialog.d.ts +12 -12
  22. package/dist/react/ui/alert.d.ts +4 -4
  23. package/dist/react/ui/alert.d.ts.map +1 -1
  24. package/dist/react/ui/aspect-ratio.d.ts +2 -2
  25. package/dist/react/ui/avatar.d.ts +4 -4
  26. package/dist/react/ui/badge.d.ts +2 -2
  27. package/dist/react/ui/breadcrumb.d.ts +8 -8
  28. package/dist/react/ui/button-group.d.ts +4 -4
  29. package/dist/react/ui/button.d.ts +2 -2
  30. package/dist/react/ui/calendar.d.ts +3 -3
  31. package/dist/react/ui/card.d.ts +8 -8
  32. package/dist/react/ui/carousel.d.ts +6 -6
  33. package/dist/react/ui/chart.d.ts +19 -19
  34. package/dist/react/ui/chart.d.ts.map +1 -1
  35. package/dist/react/ui/checkbox.d.ts +2 -2
  36. package/dist/react/ui/collapsible.d.ts +4 -4
  37. package/dist/react/ui/command.d.ts +10 -10
  38. package/dist/react/ui/context-menu.d.ts +16 -16
  39. package/dist/react/ui/dialog.d.ts +11 -11
  40. package/dist/react/ui/drawer.d.ts +11 -11
  41. package/dist/react/ui/drawer.d.ts.map +1 -1
  42. package/dist/react/ui/dropdown-menu.d.ts +16 -16
  43. package/dist/react/ui/empty.d.ts +7 -7
  44. package/dist/react/ui/field.d.ts +11 -11
  45. package/dist/react/ui/form.d.ts +9 -9
  46. package/dist/react/ui/form.d.ts.map +1 -1
  47. package/dist/react/ui/hover-card.d.ts +4 -4
  48. package/dist/react/ui/input-group.d.ts +7 -7
  49. package/dist/react/ui/input-otp.d.ts +5 -5
  50. package/dist/react/ui/input.d.ts +2 -2
  51. package/dist/react/ui/item.d.ts +11 -11
  52. package/dist/react/ui/kbd.d.ts +3 -3
  53. package/dist/react/ui/label.d.ts +2 -2
  54. package/dist/react/ui/menubar.d.ts +17 -17
  55. package/dist/react/ui/navigation-menu.d.ts +9 -9
  56. package/dist/react/ui/pagination.d.ts +8 -8
  57. package/dist/react/ui/popover.d.ts +5 -5
  58. package/dist/react/ui/progress.d.ts +2 -2
  59. package/dist/react/ui/radio-group.d.ts +3 -3
  60. package/dist/react/ui/resizable.d.ts +4 -4
  61. package/dist/react/ui/scroll-area.d.ts +3 -3
  62. package/dist/react/ui/select.d.ts +11 -11
  63. package/dist/react/ui/separator.d.ts +2 -2
  64. package/dist/react/ui/sheet.d.ts +9 -9
  65. package/dist/react/ui/sidebar.d.ts +41 -24
  66. package/dist/react/ui/sidebar.d.ts.map +1 -1
  67. package/dist/react/ui/sidebar.js.map +1 -1
  68. package/dist/react/ui/skeleton.d.ts +2 -2
  69. package/dist/react/ui/slider.d.ts +2 -2
  70. package/dist/react/ui/sonner.d.ts +2 -2
  71. package/dist/react/ui/spinner.d.ts +2 -2
  72. package/dist/react/ui/switch.d.ts +2 -2
  73. package/dist/react/ui/table.d.ts +9 -9
  74. package/dist/react/ui/tabs.d.ts +5 -5
  75. package/dist/react/ui/textarea.d.ts +2 -2
  76. package/dist/react/ui/toggle-group.d.ts +3 -3
  77. package/dist/react/ui/toggle.d.ts +2 -2
  78. package/dist/react/ui/tooltip.d.ts +5 -5
  79. package/dist/react/ui/tooltip.d.ts.map +1 -1
  80. package/docs/{docs/api → api}/appkit/Class.AppKitError.md +8 -8
  81. package/docs/{docs/api → api}/appkit/Class.AuthenticationError.md +9 -9
  82. package/docs/{docs/api → api}/appkit/Class.ConfigurationError.md +9 -9
  83. package/docs/{docs/api → api}/appkit/Class.ConnectionError.md +9 -9
  84. package/docs/{docs/api → api}/appkit/Class.ExecutionError.md +9 -9
  85. package/docs/{docs/api → api}/appkit/Class.InitializationError.md +9 -9
  86. package/docs/{docs/api → api}/appkit/Class.Plugin.md +22 -2
  87. package/docs/{docs/api → api}/appkit/Class.ResourceRegistry.md +11 -11
  88. package/docs/{docs/api → api}/appkit/Class.ServerError.md +9 -9
  89. package/docs/{docs/api → api}/appkit/Class.TunnelError.md +9 -9
  90. package/docs/{docs/api → api}/appkit/Class.ValidationError.md +9 -9
  91. package/docs/{docs/api → api}/appkit/Function.createApp.md +32 -3
  92. package/docs/{docs/api → api}/appkit/Function.createLakebasePool.md +1 -1
  93. package/docs/{docs/api → api}/appkit/Function.generateDatabaseCredential.md +2 -2
  94. package/docs/{docs/api → api}/appkit/Function.getLakebaseOrmConfig.md +1 -1
  95. package/docs/{docs/api → api}/appkit/Function.getLakebasePgConfig.md +1 -1
  96. package/docs/{docs/api → api}/appkit/Function.getPluginManifest.md +1 -1
  97. package/docs/{docs/api → api}/appkit/Function.getUsernameWithApiLookup.md +1 -1
  98. package/docs/{docs/api → api}/appkit/Function.getWorkspaceClient.md +1 -1
  99. package/docs/{docs/api → api}/appkit/Interface.ResourceEntry.md +8 -8
  100. package/docs/{docs/api → api}/appkit/Interface.ResourceRequirement.md +1 -1
  101. package/docs/{docs/api → api}/appkit-ui/styling.md +1 -1
  102. package/docs/{docs/api → api}/appkit-ui/ui/Sidebar.md +304 -37
  103. package/docs/api/appkit.md +78 -0
  104. package/docs/{docs/api.md → api.md} +4 -4
  105. package/docs/{docs/app-management.md → app-management.md} +2 -2
  106. package/docs/{docs/architecture.md → architecture.md} +6 -6
  107. package/docs/{docs/configuration.md → configuration.md} +2 -2
  108. package/docs/development/ai-assisted-development.md +88 -0
  109. package/docs/{docs/development → development}/llm-guide.md +8 -7
  110. package/docs/{docs/development → development}/local-development.md +2 -2
  111. package/docs/{docs/development → development}/project-setup.md +11 -11
  112. package/docs/{docs/development → development}/remote-bridge.md +1 -1
  113. package/docs/{docs/development → development}/type-generation.md +2 -2
  114. package/docs/development.md +22 -0
  115. package/docs/plugins/analytics.md +169 -0
  116. package/docs/{docs/plugins → plugins}/custom-plugins.md +6 -6
  117. package/docs/{docs/plugins → plugins}/server.md +1 -1
  118. package/docs/{docs/plugins.md → plugins.md} +2 -2
  119. package/{docs/docs.md → docs.md} +36 -5
  120. package/llms.txt +155 -147
  121. package/package.json +2 -1
  122. package/docs/docs/api/appkit/Class.AppKitError/index.html +0 -79
  123. package/docs/docs/api/appkit/Class.AuthenticationError/index.html +0 -110
  124. package/docs/docs/api/appkit/Class.ConfigurationError/index.html +0 -112
  125. package/docs/docs/api/appkit/Class.ConnectionError/index.html +0 -120
  126. package/docs/docs/api/appkit/Class.ExecutionError/index.html +0 -116
  127. package/docs/docs/api/appkit/Class.InitializationError/index.html +0 -104
  128. package/docs/docs/api/appkit/Class.Plugin/index.html +0 -168
  129. package/docs/docs/api/appkit/Class.ResourceRegistry/index.html +0 -150
  130. package/docs/docs/api/appkit/Class.ServerError/index.html +0 -108
  131. package/docs/docs/api/appkit/Class.TunnelError/index.html +0 -108
  132. package/docs/docs/api/appkit/Class.ValidationError/index.html +0 -106
  133. package/docs/docs/api/appkit/Enumeration.RequestedClaimsPermissionSet/index.html +0 -21
  134. package/docs/docs/api/appkit/Enumeration.ResourceType/index.html +0 -53
  135. package/docs/docs/api/appkit/Function.appKitTypesPlugin/index.html +0 -24
  136. package/docs/docs/api/appkit/Function.createApp/index.html +0 -24
  137. package/docs/docs/api/appkit/Function.createLakebasePool/index.html +0 -24
  138. package/docs/docs/api/appkit/Function.generateDatabaseCredential/index.html +0 -30
  139. package/docs/docs/api/appkit/Function.getExecutionContext/index.html +0 -26
  140. package/docs/docs/api/appkit/Function.getLakebaseOrmConfig/index.html +0 -39
  141. package/docs/docs/api/appkit/Function.getLakebasePgConfig/index.html +0 -27
  142. package/docs/docs/api/appkit/Function.getPluginManifest/index.html +0 -26
  143. package/docs/docs/api/appkit/Function.getResourceRequirements/index.html +0 -28
  144. package/docs/docs/api/appkit/Function.getUsernameWithApiLookup/index.html +0 -35
  145. package/docs/docs/api/appkit/Function.getWorkspaceClient/index.html +0 -22
  146. package/docs/docs/api/appkit/Function.isSQLTypeMarker/index.html +0 -25
  147. package/docs/docs/api/appkit/Interface.BasePluginConfig/index.html +0 -28
  148. package/docs/docs/api/appkit/Interface.CacheConfig/index.html +0 -63
  149. package/docs/docs/api/appkit/Interface.DatabaseCredential/index.html +0 -28
  150. package/docs/docs/api/appkit/Interface.GenerateDatabaseCredentialRequest/index.html +0 -32
  151. package/docs/docs/api/appkit/Interface.ITelemetry/index.html +0 -73
  152. package/docs/docs/api/appkit/Interface.LakebasePoolConfig/index.html +0 -75
  153. package/docs/docs/api/appkit/Interface.PluginManifest/index.html +0 -67
  154. package/docs/docs/api/appkit/Interface.RequestedClaims/index.html +0 -26
  155. package/docs/docs/api/appkit/Interface.RequestedResource/index.html +0 -27
  156. package/docs/docs/api/appkit/Interface.ResourceEntry/index.html +0 -83
  157. package/docs/docs/api/appkit/Interface.ResourceFieldEntry/index.html +0 -26
  158. package/docs/docs/api/appkit/Interface.ResourceRequirement/index.html +0 -51
  159. package/docs/docs/api/appkit/Interface.StreamExecutionSettings/index.html +0 -26
  160. package/docs/docs/api/appkit/Interface.TelemetryConfig/index.html +0 -32
  161. package/docs/docs/api/appkit/Interface.ValidationResult/index.html +0 -29
  162. package/docs/docs/api/appkit/TypeAlias.ConfigSchema/index.html +0 -21
  163. package/docs/docs/api/appkit/TypeAlias.IAppRouter/index.html +0 -18
  164. package/docs/docs/api/appkit/TypeAlias.ResourcePermission/index.html +0 -18
  165. package/docs/docs/api/appkit/TypeAlias.ToPlugin/index.html +0 -23
  166. package/docs/docs/api/appkit/Variable.sql/index.html +0 -98
  167. package/docs/docs/api/appkit/index.html +0 -30
  168. package/docs/docs/api/appkit-ui/data/AreaChart/index.html +0 -29
  169. package/docs/docs/api/appkit-ui/data/BarChart/index.html +0 -29
  170. package/docs/docs/api/appkit-ui/data/DataTable/index.html +0 -36
  171. package/docs/docs/api/appkit-ui/data/DonutChart/index.html +0 -29
  172. package/docs/docs/api/appkit-ui/data/HeatmapChart/index.html +0 -35
  173. package/docs/docs/api/appkit-ui/data/LineChart/index.html +0 -29
  174. package/docs/docs/api/appkit-ui/data/PieChart/index.html +0 -29
  175. package/docs/docs/api/appkit-ui/data/RadarChart/index.html +0 -29
  176. package/docs/docs/api/appkit-ui/data/ScatterChart/index.html +0 -29
  177. package/docs/docs/api/appkit-ui/genie/GenieChat/index.html +0 -26
  178. package/docs/docs/api/appkit-ui/genie/GenieChatInput/index.html +0 -24
  179. package/docs/docs/api/appkit-ui/genie/GenieChatMessage/index.html +0 -24
  180. package/docs/docs/api/appkit-ui/genie/GenieChatMessageList/index.html +0 -24
  181. package/docs/docs/api/appkit-ui/index.html +0 -23
  182. package/docs/docs/api/appkit-ui/styling/index.html +0 -74
  183. package/docs/docs/api/appkit-ui/ui/Accordion/index.html +0 -48
  184. package/docs/docs/api/appkit-ui/ui/Alert/index.html +0 -41
  185. package/docs/docs/api/appkit-ui/ui/AlertDialog/index.html +0 -97
  186. package/docs/docs/api/appkit-ui/ui/AspectRatio/index.html +0 -27
  187. package/docs/docs/api/appkit-ui/ui/Avatar/index.html +0 -41
  188. package/docs/docs/api/appkit-ui/ui/Badge/index.html +0 -27
  189. package/docs/docs/api/appkit-ui/ui/Breadcrumb/index.html +0 -69
  190. package/docs/docs/api/appkit-ui/ui/Button/index.html +0 -27
  191. package/docs/docs/api/appkit-ui/ui/ButtonGroup/index.html +0 -38
  192. package/docs/docs/api/appkit-ui/ui/Calendar/index.html +0 -34
  193. package/docs/docs/api/appkit-ui/ui/Card/index.html +0 -69
  194. package/docs/docs/api/appkit-ui/ui/Carousel/index.html +0 -55
  195. package/docs/docs/api/appkit-ui/ui/ChartContainer/index.html +0 -58
  196. package/docs/docs/api/appkit-ui/ui/Checkbox/index.html +0 -27
  197. package/docs/docs/api/appkit-ui/ui/Collapsible/index.html +0 -41
  198. package/docs/docs/api/appkit-ui/ui/Command/index.html +0 -83
  199. package/docs/docs/api/appkit-ui/ui/ContextMenu/index.html +0 -111
  200. package/docs/docs/api/appkit-ui/ui/Dialog/index.html +0 -90
  201. package/docs/docs/api/appkit-ui/ui/Drawer/index.html +0 -90
  202. package/docs/docs/api/appkit-ui/ui/DropdownMenu/index.html +0 -111
  203. package/docs/docs/api/appkit-ui/ui/Empty/index.html +0 -54
  204. package/docs/docs/api/appkit-ui/ui/Field/index.html +0 -87
  205. package/docs/docs/api/appkit-ui/ui/FormControl/index.html +0 -59
  206. package/docs/docs/api/appkit-ui/ui/HoverCard/index.html +0 -39
  207. package/docs/docs/api/appkit-ui/ui/Input/index.html +0 -27
  208. package/docs/docs/api/appkit-ui/ui/InputGroup/index.html +0 -59
  209. package/docs/docs/api/appkit-ui/ui/InputOTP/index.html +0 -48
  210. package/docs/docs/api/appkit-ui/ui/Item/index.html +0 -78
  211. package/docs/docs/api/appkit-ui/ui/Kbd/index.html +0 -30
  212. package/docs/docs/api/appkit-ui/ui/Label/index.html +0 -27
  213. package/docs/docs/api/appkit-ui/ui/Menubar/index.html +0 -117
  214. package/docs/docs/api/appkit-ui/ui/NavigationMenu/index.html +0 -76
  215. package/docs/docs/api/appkit-ui/ui/Pagination/index.html +0 -69
  216. package/docs/docs/api/appkit-ui/ui/Popover/index.html +0 -45
  217. package/docs/docs/api/appkit-ui/ui/Progress/index.html +0 -27
  218. package/docs/docs/api/appkit-ui/ui/RadioGroup/index.html +0 -33
  219. package/docs/docs/api/appkit-ui/ui/ResizableHandle/index.html +0 -41
  220. package/docs/docs/api/appkit-ui/ui/ScrollArea/index.html +0 -34
  221. package/docs/docs/api/appkit-ui/ui/Select/index.html +0 -82
  222. package/docs/docs/api/appkit-ui/ui/Separator/index.html +0 -27
  223. package/docs/docs/api/appkit-ui/ui/Sheet/index.html +0 -76
  224. package/docs/docs/api/appkit-ui/ui/Sidebar/index.html +0 -183
  225. package/docs/docs/api/appkit-ui/ui/Skeleton/index.html +0 -27
  226. package/docs/docs/api/appkit-ui/ui/Slider/index.html +0 -27
  227. package/docs/docs/api/appkit-ui/ui/Spinner/index.html +0 -24
  228. package/docs/docs/api/appkit-ui/ui/Switch/index.html +0 -27
  229. package/docs/docs/api/appkit-ui/ui/Table/index.html +0 -69
  230. package/docs/docs/api/appkit-ui/ui/Tabs/index.html +0 -48
  231. package/docs/docs/api/appkit-ui/ui/Textarea/index.html +0 -27
  232. package/docs/docs/api/appkit-ui/ui/Toaster/index.html +0 -27
  233. package/docs/docs/api/appkit-ui/ui/Toggle/index.html +0 -27
  234. package/docs/docs/api/appkit-ui/ui/ToggleGroup/index.html +0 -33
  235. package/docs/docs/api/appkit-ui/ui/Tooltip/index.html +0 -46
  236. package/docs/docs/api/appkit.md +0 -78
  237. package/docs/docs/api/index.html +0 -28
  238. package/docs/docs/app-management/index.html +0 -106
  239. package/docs/docs/architecture/index.html +0 -71
  240. package/docs/docs/category/development/index.html +0 -16
  241. package/docs/docs/category/development.md +0 -3
  242. package/docs/docs/configuration/index.html +0 -66
  243. package/docs/docs/core-principles/index.html +0 -38
  244. package/docs/docs/development/ai-assisted-development/index.html +0 -33
  245. package/docs/docs/development/ai-assisted-development.md +0 -26
  246. package/docs/docs/development/index.html +0 -35
  247. package/docs/docs/development/llm-guide/index.html +0 -84
  248. package/docs/docs/development/local-development/index.html +0 -27
  249. package/docs/docs/development/project-setup/index.html +0 -69
  250. package/docs/docs/development/remote-bridge/index.html +0 -76
  251. package/docs/docs/development/type-generation/index.html +0 -65
  252. package/docs/docs/development.md +0 -22
  253. package/docs/docs/index.html +0 -58
  254. package/docs/docs/plugins/analytics/index.html +0 -53
  255. package/docs/docs/plugins/analytics.md +0 -66
  256. package/docs/docs/plugins/caching/index.html +0 -23
  257. package/docs/docs/plugins/custom-plugins/index.html +0 -49
  258. package/docs/docs/plugins/execution-context/index.html +0 -40
  259. package/docs/docs/plugins/index.html +0 -29
  260. package/docs/docs/plugins/lakebase/index.html +0 -62
  261. package/docs/docs/plugins/plugin-management/index.html +0 -44
  262. package/docs/docs/plugins/server/index.html +0 -45
  263. /package/docs/{docs/api → api}/appkit/Enumeration.RequestedClaimsPermissionSet.md +0 -0
  264. /package/docs/{docs/api → api}/appkit/Enumeration.ResourceType.md +0 -0
  265. /package/docs/{docs/api → api}/appkit/Function.appKitTypesPlugin.md +0 -0
  266. /package/docs/{docs/api → api}/appkit/Function.getExecutionContext.md +0 -0
  267. /package/docs/{docs/api → api}/appkit/Function.getResourceRequirements.md +0 -0
  268. /package/docs/{docs/api → api}/appkit/Function.isSQLTypeMarker.md +0 -0
  269. /package/docs/{docs/api → api}/appkit/Interface.BasePluginConfig.md +0 -0
  270. /package/docs/{docs/api → api}/appkit/Interface.CacheConfig.md +0 -0
  271. /package/docs/{docs/api → api}/appkit/Interface.DatabaseCredential.md +0 -0
  272. /package/docs/{docs/api → api}/appkit/Interface.GenerateDatabaseCredentialRequest.md +0 -0
  273. /package/docs/{docs/api → api}/appkit/Interface.ITelemetry.md +0 -0
  274. /package/docs/{docs/api → api}/appkit/Interface.LakebasePoolConfig.md +0 -0
  275. /package/docs/{docs/api → api}/appkit/Interface.PluginManifest.md +0 -0
  276. /package/docs/{docs/api → api}/appkit/Interface.RequestedClaims.md +0 -0
  277. /package/docs/{docs/api → api}/appkit/Interface.RequestedResource.md +0 -0
  278. /package/docs/{docs/api → api}/appkit/Interface.ResourceFieldEntry.md +0 -0
  279. /package/docs/{docs/api → api}/appkit/Interface.StreamExecutionSettings.md +0 -0
  280. /package/docs/{docs/api → api}/appkit/Interface.TelemetryConfig.md +0 -0
  281. /package/docs/{docs/api → api}/appkit/Interface.ValidationResult.md +0 -0
  282. /package/docs/{docs/api → api}/appkit/TypeAlias.ConfigSchema.md +0 -0
  283. /package/docs/{docs/api → api}/appkit/TypeAlias.IAppRouter.md +0 -0
  284. /package/docs/{docs/api → api}/appkit/TypeAlias.ResourcePermission.md +0 -0
  285. /package/docs/{docs/api → api}/appkit/TypeAlias.ToPlugin.md +0 -0
  286. /package/docs/{docs/api → api}/appkit/Variable.sql.md +0 -0
  287. /package/docs/{docs/api → api}/appkit-ui/data/AreaChart.md +0 -0
  288. /package/docs/{docs/api → api}/appkit-ui/data/BarChart.md +0 -0
  289. /package/docs/{docs/api → api}/appkit-ui/data/DataTable.md +0 -0
  290. /package/docs/{docs/api → api}/appkit-ui/data/DonutChart.md +0 -0
  291. /package/docs/{docs/api → api}/appkit-ui/data/HeatmapChart.md +0 -0
  292. /package/docs/{docs/api → api}/appkit-ui/data/LineChart.md +0 -0
  293. /package/docs/{docs/api → api}/appkit-ui/data/PieChart.md +0 -0
  294. /package/docs/{docs/api → api}/appkit-ui/data/RadarChart.md +0 -0
  295. /package/docs/{docs/api → api}/appkit-ui/data/ScatterChart.md +0 -0
  296. /package/docs/{docs/api → api}/appkit-ui/genie/GenieChat.md +0 -0
  297. /package/docs/{docs/api → api}/appkit-ui/genie/GenieChatInput.md +0 -0
  298. /package/docs/{docs/api → api}/appkit-ui/genie/GenieChatMessage.md +0 -0
  299. /package/docs/{docs/api → api}/appkit-ui/genie/GenieChatMessageList.md +0 -0
  300. /package/docs/{docs/api → api}/appkit-ui/ui/Accordion.md +0 -0
  301. /package/docs/{docs/api → api}/appkit-ui/ui/Alert.md +0 -0
  302. /package/docs/{docs/api → api}/appkit-ui/ui/AlertDialog.md +0 -0
  303. /package/docs/{docs/api → api}/appkit-ui/ui/AspectRatio.md +0 -0
  304. /package/docs/{docs/api → api}/appkit-ui/ui/Avatar.md +0 -0
  305. /package/docs/{docs/api → api}/appkit-ui/ui/Badge.md +0 -0
  306. /package/docs/{docs/api → api}/appkit-ui/ui/Breadcrumb.md +0 -0
  307. /package/docs/{docs/api → api}/appkit-ui/ui/Button.md +0 -0
  308. /package/docs/{docs/api → api}/appkit-ui/ui/ButtonGroup.md +0 -0
  309. /package/docs/{docs/api → api}/appkit-ui/ui/Calendar.md +0 -0
  310. /package/docs/{docs/api → api}/appkit-ui/ui/Card.md +0 -0
  311. /package/docs/{docs/api → api}/appkit-ui/ui/Carousel.md +0 -0
  312. /package/docs/{docs/api → api}/appkit-ui/ui/ChartContainer.md +0 -0
  313. /package/docs/{docs/api → api}/appkit-ui/ui/Checkbox.md +0 -0
  314. /package/docs/{docs/api → api}/appkit-ui/ui/Collapsible.md +0 -0
  315. /package/docs/{docs/api → api}/appkit-ui/ui/Command.md +0 -0
  316. /package/docs/{docs/api → api}/appkit-ui/ui/ContextMenu.md +0 -0
  317. /package/docs/{docs/api → api}/appkit-ui/ui/Dialog.md +0 -0
  318. /package/docs/{docs/api → api}/appkit-ui/ui/Drawer.md +0 -0
  319. /package/docs/{docs/api → api}/appkit-ui/ui/DropdownMenu.md +0 -0
  320. /package/docs/{docs/api → api}/appkit-ui/ui/Empty.md +0 -0
  321. /package/docs/{docs/api → api}/appkit-ui/ui/Field.md +0 -0
  322. /package/docs/{docs/api → api}/appkit-ui/ui/FormControl.md +0 -0
  323. /package/docs/{docs/api → api}/appkit-ui/ui/HoverCard.md +0 -0
  324. /package/docs/{docs/api → api}/appkit-ui/ui/Input.md +0 -0
  325. /package/docs/{docs/api → api}/appkit-ui/ui/InputGroup.md +0 -0
  326. /package/docs/{docs/api → api}/appkit-ui/ui/InputOTP.md +0 -0
  327. /package/docs/{docs/api → api}/appkit-ui/ui/Item.md +0 -0
  328. /package/docs/{docs/api → api}/appkit-ui/ui/Kbd.md +0 -0
  329. /package/docs/{docs/api → api}/appkit-ui/ui/Label.md +0 -0
  330. /package/docs/{docs/api → api}/appkit-ui/ui/Menubar.md +0 -0
  331. /package/docs/{docs/api → api}/appkit-ui/ui/NavigationMenu.md +0 -0
  332. /package/docs/{docs/api → api}/appkit-ui/ui/Pagination.md +0 -0
  333. /package/docs/{docs/api → api}/appkit-ui/ui/Popover.md +0 -0
  334. /package/docs/{docs/api → api}/appkit-ui/ui/Progress.md +0 -0
  335. /package/docs/{docs/api → api}/appkit-ui/ui/RadioGroup.md +0 -0
  336. /package/docs/{docs/api → api}/appkit-ui/ui/ResizableHandle.md +0 -0
  337. /package/docs/{docs/api → api}/appkit-ui/ui/ScrollArea.md +0 -0
  338. /package/docs/{docs/api → api}/appkit-ui/ui/Select.md +0 -0
  339. /package/docs/{docs/api → api}/appkit-ui/ui/Separator.md +0 -0
  340. /package/docs/{docs/api → api}/appkit-ui/ui/Sheet.md +0 -0
  341. /package/docs/{docs/api → api}/appkit-ui/ui/Skeleton.md +0 -0
  342. /package/docs/{docs/api → api}/appkit-ui/ui/Slider.md +0 -0
  343. /package/docs/{docs/api → api}/appkit-ui/ui/Spinner.md +0 -0
  344. /package/docs/{docs/api → api}/appkit-ui/ui/Switch.md +0 -0
  345. /package/docs/{docs/api → api}/appkit-ui/ui/Table.md +0 -0
  346. /package/docs/{docs/api → api}/appkit-ui/ui/Tabs.md +0 -0
  347. /package/docs/{docs/api → api}/appkit-ui/ui/Textarea.md +0 -0
  348. /package/docs/{docs/api → api}/appkit-ui/ui/Toaster.md +0 -0
  349. /package/docs/{docs/api → api}/appkit-ui/ui/Toggle.md +0 -0
  350. /package/docs/{docs/api → api}/appkit-ui/ui/ToggleGroup.md +0 -0
  351. /package/docs/{docs/api → api}/appkit-ui/ui/Tooltip.md +0 -0
  352. /package/docs/{docs/api → api}/appkit-ui.md +0 -0
  353. /package/docs/{docs/core-principles.md → core-principles.md} +0 -0
  354. /package/docs/{docs/plugins → plugins}/caching.md +0 -0
  355. /package/docs/{docs/plugins → plugins}/execution-context.md +0 -0
  356. /package/docs/{docs/plugins → plugins}/lakebase.md +0 -0
  357. /package/docs/{docs/plugins → plugins}/plugin-management.md +0 -0
package/llms.txt CHANGED
@@ -1,18 +1,15 @@
1
1
  ## For AI Agents/Assistants
2
2
 
3
- To view specific documentation files referenced below, use the appkit CLI:
3
+ The section names and doc paths below can be passed as the `<query>` argument:
4
4
 
5
5
  ```bash
6
- npx @databricks/appkit docs <path>
6
+ npx @databricks/appkit docs <query>
7
7
  ```
8
8
 
9
- Examples:
10
- - View main documentation: `npx @databricks/appkit docs`
11
- - View specific file: `npx @databricks/appkit docs ./docs/docs.md`
12
- - View API reference: `npx @databricks/appkit docs ./docs/docs/api.md`
13
- - View component docs: `npx @databricks/appkit docs ./docs/docs/api/appkit-ui/components/Sidebar.md`
14
-
15
- The CLI will display the documentation content directly in the terminal.
9
+ - View documentation index: `npx @databricks/appkit docs`
10
+ - View a section: `npx @databricks/appkit docs "appkit-ui API reference"`
11
+ - Full index (all API entries): `npx @databricks/appkit docs --full`
12
+ - View specific doc: `npx @databricks/appkit docs ./docs/plugins/analytics.md`
16
13
 
17
14
  ---
18
15
 
@@ -21,141 +18,152 @@ The CLI will display the documentation content directly in the terminal.
21
18
  > Node.js + React SDK for Databricks Apps. Built for humans and AI.
22
19
 
23
20
 
24
- ## Appkit
25
-
26
- - [Getting started](./docs/docs.md): Learn how to get started with AppKit.
27
- - [API reference](./docs/docs/api.md): This section contains the API reference for the AppKit packages.
28
- - [@databricks/appkit](./docs/docs/api/appkit.md): Core library for building Databricks applications with type-safe SQL queries,
29
- - [Abstract Class: AppKitError](./docs/docs/api./docs/Class.AppKitError.md): Base error class for all AppKit errors.
30
- - [Class: AuthenticationError](./docs/docs/api./docs/Class.AuthenticationError.md): Error thrown when authentication fails.
31
- - [Class: ConfigurationError](./docs/docs/api./docs/Class.ConfigurationError.md): Error thrown when configuration is missing or invalid.
32
- - [Class: ConnectionError](./docs/docs/api./docs/Class.ConnectionError.md): Error thrown when a connection or network operation fails.
33
- - [Class: ExecutionError](./docs/docs/api./docs/Class.ExecutionError.md): Error thrown when an operation execution fails.
34
- - [Class: InitializationError](./docs/docs/api./docs/Class.InitializationError.md): Error thrown when a service or component is not properly initialized.
35
- - [Abstract Class: Plugin<TConfig>](./docs/docs/api./docs/Class.Plugin.md): Base abstract class for creating AppKit plugins.
36
- - [Class: ResourceRegistry](./docs/docs/api./docs/Class.ResourceRegistry.md): Central registry for tracking plugin resource requirements.
37
- - [Class: ServerError](./docs/docs/api./docs/Class.ServerError.md): Error thrown when server lifecycle operations fail.
38
- - [Class: TunnelError](./docs/docs/api./docs/Class.TunnelError.md): Error thrown when remote tunnel operations fail.
39
- - [Class: ValidationError](./docs/docs/api./docs/Class.ValidationError.md): Error thrown when input validation fails.
40
- - [Enumeration: RequestedClaimsPermissionSet](./docs/docs/api./docs/Enumeration.RequestedClaimsPermissionSet.md): Permission set for Unity Catalog table access
41
- - [Enumeration: ResourceType](./docs/docs/api./docs/Enumeration.ResourceType.md): Resource types from schema $defs.resourceType.enum
42
- - [Function: appKitTypesPlugin()](./docs/docs/api./docs/Function.appKitTypesPlugin.md): Vite plugin to generate types for AppKit queries.
43
- - [Function: createApp()](./docs/docs/api./docs/Function.createApp.md): Bootstraps AppKit with the provided configuration.
44
- - [Function: createLakebasePool()](./docs/docs/api./docs/Function.createLakebasePool.md): Create a Lakebase pool with appkit's logger integration.
45
- - [Function: generateDatabaseCredential()](./docs/docs/api./docs/Function.generateDatabaseCredential.md): Generate OAuth credentials for Postgres database connection using the proper Postgres API.
46
- - [Function: getExecutionContext()](./docs/docs/api./docs/Function.getExecutionContext.md): Get the current execution context.
47
- - [Function: getLakebaseOrmConfig()](./docs/docs/api./docs/Function.getLakebaseOrmConfig.md): Get Lakebase connection configuration for ORMs that don't accept pg.Pool directly.
48
- - [Function: getLakebasePgConfig()](./docs/docs/api./docs/Function.getLakebasePgConfig.md): Get Lakebase connection configuration for PostgreSQL clients.
49
- - [Function: getPluginManifest()](./docs/docs/api./docs/Function.getPluginManifest.md): Loads and validates the manifest from a plugin constructor.
50
- - [Function: getResourceRequirements()](./docs/docs/api./docs/Function.getResourceRequirements.md): Gets the resource requirements from a plugin's manifest.
51
- - [Function: getUsernameWithApiLookup()](./docs/docs/api./docs/Function.getUsernameWithApiLookup.md): Resolves the PostgreSQL username for a Lakebase connection.
52
- - [Function: getWorkspaceClient()](./docs/docs/api./docs/Function.getWorkspaceClient.md): Get workspace client from config or SDK default auth chain
53
- - [Function: isSQLTypeMarker()](./docs/docs/api./docs/Function.isSQLTypeMarker.md): Type guard to check if a value is a SQL type marker
54
- - [Interface: BasePluginConfig](./docs/docs/api./docs/Interface.BasePluginConfig.md): Base configuration interface for AppKit plugins
55
- - [Interface: CacheConfig](./docs/docs/api./docs/Interface.CacheConfig.md): Configuration for caching
56
- - [Interface: DatabaseCredential](./docs/docs/api./docs/Interface.DatabaseCredential.md): Database credentials with OAuth token for Postgres connection
57
- - [Interface: GenerateDatabaseCredentialRequest](./docs/docs/api./docs/Interface.GenerateDatabaseCredentialRequest.md): Request parameters for generating database OAuth credentials
58
- - [Interface: ITelemetry](./docs/docs/api./docs/Interface.ITelemetry.md): Plugin-facing interface for OpenTelemetry instrumentation.
59
- - [Interface: LakebasePoolConfig](./docs/docs/api./docs/Interface.LakebasePoolConfig.md): Configuration for creating a Lakebase connection pool
60
- - [Interface: PluginManifest](./docs/docs/api./docs/Interface.PluginManifest.md): Plugin manifest that declares metadata and resource requirements.
61
- - [Interface: RequestedClaims](./docs/docs/api./docs/Interface.RequestedClaims.md): Optional claims for fine-grained Unity Catalog table permissions
62
- - [Interface: RequestedResource](./docs/docs/api./docs/Interface.RequestedResource.md): Resource to request permissions for in Unity Catalog
63
- - [Interface: ResourceEntry](./docs/docs/api./docs/Interface.ResourceEntry.md): Internal representation of a resource in the registry.
64
- - [Interface: ResourceFieldEntry](./docs/docs/api./docs/Interface.ResourceFieldEntry.md): Defines a single field for a resource. Each field has its own environment variable and optional description.
65
- - [Interface: ResourceRequirement](./docs/docs/api./docs/Interface.ResourceRequirement.md): Declares a resource requirement for a plugin.
66
- - [Interface: StreamExecutionSettings](./docs/docs/api./docs/Interface.StreamExecutionSettings.md): Configuration for streaming execution with default and user-scoped settings
67
- - [Interface: TelemetryConfig](./docs/docs/api./docs/Interface.TelemetryConfig.md): OpenTelemetry configuration for AppKit applications
68
- - [Interface: ValidationResult](./docs/docs/api./docs/Interface.ValidationResult.md): Result of validating all registered resources against the environment.
69
- - [Type Alias: ConfigSchema](./docs/docs/api./docs/TypeAlias.ConfigSchema.md): Configuration schema definition for plugin config.
70
- - [Type Alias: IAppRouter](./docs/docs/api./docs/TypeAlias.IAppRouter.md): Express router type for plugin route registration
71
- - [Type Alias: ResourcePermission](./docs/docs/api./docs/TypeAlias.ResourcePermission.md): Union of all possible permission levels across all resource types.
72
- - [Type Alias: ToPlugin()<T, U, N>](./docs/docs/api./docs/TypeAlias.ToPlugin.md): Type Parameters
73
- - [Variable: sql](./docs/docs/api./docs/Variable.sql.md): SQL helper namespace
74
- - [@databricks/appkit-ui](./docs/docs/api/appkit-ui.md): The library provides a set of UI primitives for building Databricks apps in React.
75
- - [AreaChart](./docs/docs/api/appkit-ui/data/AreaChart.md): Area Chart component for trend visualization with filled areas.
76
- - [BarChart](./docs/docs/api/appkit-ui/data/BarChart.md): Bar Chart component for categorical comparisons.
77
- - [DataTable](./docs/docs/api/appkit-ui/data/DataTable.md): Production-ready data table with automatic data fetching and state management
78
- - [DonutChart](./docs/docs/api/appkit-ui/data/DonutChart.md): Donut Chart component (Pie chart with inner radius).
79
- - [HeatmapChart](./docs/docs/api/appkit-ui/data/HeatmapChart.md): Heatmap Chart component for matrix-style data visualization.
80
- - [LineChart](./docs/docs/api/appkit-ui/data/LineChart.md): Line Chart component for time-series and trend visualization.
81
- - [PieChart](./docs/docs/api/appkit-ui/data/PieChart.md): Pie Chart component for proportional data visualization.
82
- - [RadarChart](./docs/docs/api/appkit-ui/data/RadarChart.md): Radar Chart component for multi-dimensional data comparison.
83
- - [ScatterChart](./docs/docs/api/appkit-ui/data/ScatterChart.md): Scatter Chart component for correlation and distribution visualization.
84
- - [GenieChat](./docs/docs/api/appkit-ui/genie/GenieChat.md): Full-featured chat interface for a single Databricks AI/BI Genie space. Handles message streaming, conversation history, and auto-reconnection via SSE.
85
- - [GenieChatInput](./docs/docs/api/appkit-ui/genie/GenieChatInput.md): Auto-expanding textarea input with a send button for chat messages. Submits on Enter (Shift+Enter for newline).
86
- - [GenieChatMessage](./docs/docs/api/appkit-ui/genie/GenieChatMessage.md): Renders a single Genie message bubble with optional expandable SQL query attachments.
87
- - [GenieChatMessageList](./docs/docs/api/appkit-ui/genie/GenieChatMessageList.md): Scrollable message list that renders Genie chat messages with auto-scroll, skeleton loaders, and a streaming indicator.
88
- - [Styling](./docs/docs/api/appkit-ui/styling.md): This guide covers how to style AppKit UI components using CSS variables and theming.
89
- - [Accordion](./docs/docs/api/appkit-ui/ui/Accordion.md): Collapsible content sections organized in a vertical stack
90
- - [Alert](./docs/docs/api/appkit-ui/ui/Alert.md): Displays important information with optional icon and multiple variants
91
- - [AlertDialog](./docs/docs/api/appkit-ui/ui/AlertDialog.md): Modal dialog that interrupts the user with critical information requiring immediate action
92
- - [AspectRatio](./docs/docs/api/appkit-ui/ui/AspectRatio.md): Container that maintains a specific aspect ratio for its content
93
- - [Avatar](./docs/docs/api/appkit-ui/ui/Avatar.md): Displays user profile picture or initials in a circular container
94
- - [Badge](./docs/docs/api/appkit-ui/ui/Badge.md): Small label for displaying status, categories, or counts
95
- - [Breadcrumb](./docs/docs/api/appkit-ui/ui/Breadcrumb.md): Navigation component showing the current page's location in the site hierarchy
96
- - [Button](./docs/docs/api/appkit-ui/ui/Button.md): Clickable button with multiple variants and sizes
97
- - [ButtonGroup](./docs/docs/api/appkit-ui/ui/ButtonGroup.md): Container for grouping related buttons together with shared borders
98
- - [Calendar](./docs/docs/api/appkit-ui/ui/Calendar.md): Date picker component for selecting single dates or date ranges
99
- - [Card](./docs/docs/api/appkit-ui/ui/Card.md): Container for grouping related content with header, body, and footer sections
100
- - [Carousel](./docs/docs/api/appkit-ui/ui/Carousel.md): Slideshow component for cycling through content with navigation controls
101
- - [ChartContainer](./docs/docs/api/appkit-ui/ui/ChartContainer.md): Container for rendering data visualizations using Recharts
102
- - [Checkbox](./docs/docs/api/appkit-ui/ui/Checkbox.md): Checkbox input for selecting multiple options
103
- - [Collapsible](./docs/docs/api/appkit-ui/ui/Collapsible.md): Interactive component that expands and collapses content
104
- - [Command](./docs/docs/api/appkit-ui/ui/Command.md): Command palette for keyboard-driven navigation and actions
105
- - [ContextMenu](./docs/docs/api/appkit-ui/ui/ContextMenu.md): Menu triggered by right-clicking an element
106
- - [Dialog](./docs/docs/api/appkit-ui/ui/Dialog.md): Modal dialog that overlays the page content
107
- - [Drawer](./docs/docs/api/appkit-ui/ui/Drawer.md): Draggable panel that slides in from screen edges
108
- - [DropdownMenu](./docs/docs/api/appkit-ui/ui/DropdownMenu.md): Menu that displays when triggered by a button or element
109
- - [Empty](./docs/docs/api/appkit-ui/ui/Empty.md): Empty state component for displaying no-data scenarios
110
- - [Field](./docs/docs/api/appkit-ui/ui/Field.md): Form field wrapper with label and input positioning
111
- - [FormControl](./docs/docs/api/appkit-ui/ui/FormControl.md): Wrapper for form control elements with accessibility attributes
112
- - [HoverCard](./docs/docs/api/appkit-ui/ui/HoverCard.md): Content card that appears when hovering over an element
113
- - [Input](./docs/docs/api/appkit-ui/ui/Input.md): Text input field for single-line user input
114
- - [InputGroup](./docs/docs/api/appkit-ui/ui/InputGroup.md): Container for combining input fields with addons and buttons
115
- - [InputOTP](./docs/docs/api/appkit-ui/ui/InputOTP.md): One-time password input with individual character slots
116
- - [Item](./docs/docs/api/appkit-ui/ui/Item.md): Flexible container for list items with media, content, and actions
117
- - [Kbd](./docs/docs/api/appkit-ui/ui/Kbd.md): Visual representation of keyboard keys
118
- - [Label](./docs/docs/api/appkit-ui/ui/Label.md): Text label associated with form controls
119
- - [Menubar](./docs/docs/api/appkit-ui/ui/Menubar.md): Horizontal menu bar with dropdown menus
120
- - [NavigationMenu](./docs/docs/api/appkit-ui/ui/NavigationMenu.md): Horizontal navigation menu with dropdown submenus
121
- - [Pagination](./docs/docs/api/appkit-ui/ui/Pagination.md): Navigation component for paginated content
122
- - [Popover](./docs/docs/api/appkit-ui/ui/Popover.md): Floating content panel anchored to a trigger element
123
- - [Progress](./docs/docs/api/appkit-ui/ui/Progress.md): Visual indicator showing task completion percentage
124
- - [RadioGroup](./docs/docs/api/appkit-ui/ui/RadioGroup.md): Group of radio buttons for selecting a single option
125
- - [ResizableHandle](./docs/docs/api/appkit-ui/ui/ResizableHandle.md): Draggable handle for resizing panels
126
- - [ScrollArea](./docs/docs/api/appkit-ui/ui/ScrollArea.md): Container with custom scrollbars for overflow content
127
- - [Select](./docs/docs/api/appkit-ui/ui/Select.md): Dropdown control for selecting a value from a list
128
- - [Separator](./docs/docs/api/appkit-ui/ui/Separator.md): Visual divider line between content sections
129
- - [Sheet](./docs/docs/api/appkit-ui/ui/Sheet.md): Sliding panel that overlays content from screen edges
130
- - [Sidebar](./docs/docs/api/appkit-ui/ui/Sidebar.md): Collapsible navigation sidebar with mobile support
131
- - [Skeleton](./docs/docs/api/appkit-ui/ui/Skeleton.md): Loading placeholder with pulsing animation
132
- - [Slider](./docs/docs/api/appkit-ui/ui/Slider.md): Draggable input for selecting numeric values within a range
133
- - [Spinner](./docs/docs/api/appkit-ui/ui/Spinner.md): Animated loading indicator
134
- - [Switch](./docs/docs/api/appkit-ui/ui/Switch.md): Toggle control for switching between on and off states
135
- - [Table](./docs/docs/api/appkit-ui/ui/Table.md): Structured data display with rows and columns
136
- - [Tabs](./docs/docs/api/appkit-ui/ui/Tabs.md): Tabbed interface for organizing content into separate panels
137
- - [Textarea](./docs/docs/api/appkit-ui/ui/Textarea.md): Multi-line text input field
138
- - [Toaster](./docs/docs/api/appkit-ui/ui/Toaster.md): Toast notification system for displaying temporary messages
139
- - [Toggle](./docs/docs/api/appkit-ui/ui/Toggle.md): Button that toggles between pressed and unpressed states
140
- - [ToggleGroup](./docs/docs/api/appkit-ui/ui/ToggleGroup.md): Group of toggle buttons for selecting one or more options
141
- - [Tooltip](./docs/docs/api/appkit-ui/ui/Tooltip.md): Brief informational message that appears on hover
142
- - [App management](./docs/docs/app-management.md): Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps.
143
- - [Architecture](./docs/docs/architecture.md): AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions.
144
- - [Development](./docs/docs/category/development.md): Guides for developing AppKit applications
145
- - [Configuration](./docs/docs/configuration.md): This guide covers environment variables and configuration options for AppKit applications.
146
- - [Core principles](./docs/docs/core-principles.md): Learn about the fundamental concepts and principles behind AppKit.
147
- - [Development](./docs/docs/development.md): AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with MCP, and remote tunneling to deployed backends.
148
- - [AI-Assisted development](./docs/docs/development/ai-assisted-development.md): AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.
149
- - [LLM Guide](./docs/docs/development/llm-guide.md): This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.
150
- - [Local development](./docs/docs/development/local-development.md): Once your app is bootstrapped according to the Quick start guide, you can start the development server with hot reload for both UI and backend code.
151
- - [Project setup](./docs/docs/development/project-setup.md): This guide covers the recommended project structure and scaffolding for AppKit applications.
152
- - [Remote Bridge](./docs/docs/development/remote-bridge.md): Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.
153
- - [Type generation](./docs/docs/development/type-generation.md): AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.
154
- - [Plugins](./docs/docs/plugins.md): Plugins are modular extensions that add capabilities to your AppKit application. They follow a defined lifecycle and have access to shared services like caching, telemetry, and streaming.
155
- - [Analytics plugin](./docs/docs/plugins/analytics.md): Enables SQL query execution against Databricks SQL Warehouses.
156
- - [Caching](./docs/docs/plugins/caching.md): AppKit provides both global and plugin-level caching capabilities.
157
- - [Creating custom plugins](./docs/docs/plugins/custom-plugins.md): If you need custom API routes or background logic, implement an AppKit plugin. The fastest way is to use the CLI:
158
- - [Execution context](./docs/docs/plugins/execution-context.md): AppKit manages Databricks authentication via two contexts:
159
- - [Lakebase plugin](./docs/docs/plugins/lakebase.md): Currently, the Lakebase plugin currently requires a one-time manual setup to connect your Databricks App with your Lakebase database. An automated setup process is planned for an upcoming future release.
160
- - [Plugin management](./docs/docs/plugins/plugin-management.md): AppKit includes a CLI for managing plugins. All commands are available under npx @databricks/appkit plugin.
161
- - [Server plugin](./docs/docs/plugins/server.md): Provides HTTP server capabilities with development and production modes.
21
+ ## General docs
22
+
23
+ - [Getting started](./docs.md): Learn how to get started with AppKit.
24
+ - [API reference](./docs/api.md): This section contains the API reference for the AppKit packages.
25
+ - [App management](./docs/app-management.md): Manage your AppKit application throughout its lifecycle using the Databricks CLI. This guide covers deploying, starting, stopping, monitoring, and deleting apps.
26
+ - [Architecture](./docs/architecture.md): AppKit follows a plugin-based architecture designed for building production-ready Databricks applications. This document provides a high-level overview of the system components and their interactions.
27
+ - [Configuration](./docs/configuration.md): This guide covers environment variables and configuration options for AppKit applications.
28
+ - [Core principles](./docs/core-principles.md): Learn about the fundamental concepts and principles behind AppKit.
29
+ - [Development](./docs/development.md): AppKit provides multiple development workflows to suit different needs: local development with hot reload, AI-assisted development with Agent Skills, and remote tunneling to deployed backends.
30
+ - [Plugins](./docs/plugins.md): Plugins are modular extensions that add capabilities to your AppKit application. They follow a defined lifecycle and have access to shared services like caching, telemetry, and streaming.
31
+
32
+ ## Development
33
+
34
+ - [AI-Assisted development](./docs/development/ai-assisted-development.md): AppKit integrates with AI coding assistants through the Agent Skills.
35
+ - [LLM Guide](./docs/development/llm-guide.md): This document provides prescriptive guidance for AI coding assistants generating code with Databricks AppKit. It is intentionally opinionated to ensure consistent, production-ready code generation.
36
+ - [Local development](./docs/development/local-development.md): Once your app is bootstrapped according to the Manual quick start guide, you can start the development server with hot reload for both UI and backend code.
37
+ - [Project setup](./docs/development/project-setup.md): This guide covers the recommended project structure and scaffolding for AppKit applications.
38
+ - [Remote Bridge](./docs/development/remote-bridge.md): Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.
39
+ - [Type generation](./docs/development/type-generation.md): AppKit can automatically generate TypeScript types for your SQL queries, providing end-to-end type safety from database to UI.
40
+
41
+ ## Plugins
42
+
43
+ - [Analytics plugin](./docs/plugins/analytics.md): Enables SQL query execution against Databricks SQL Warehouses.
44
+ - [Caching](./docs/plugins/caching.md): AppKit provides both global and plugin-level caching capabilities.
45
+ - [Creating custom plugins](./docs/plugins/custom-plugins.md): If you need custom API routes or background logic, implement an AppKit plugin. The fastest way is to use the CLI:
46
+ - [Execution context](./docs/plugins/execution-context.md): AppKit manages Databricks authentication via two contexts:
47
+ - [Lakebase plugin](./docs/plugins/lakebase.md): Currently, the Lakebase plugin currently requires a one-time manual setup to connect your Databricks App with your Lakebase database. An automated setup process is planned for an upcoming future release.
48
+ - [Plugin management](./docs/plugins/plugin-management.md): AppKit includes a CLI for managing plugins. All commands are available under npx @databricks/appkit plugin.
49
+ - [Server plugin](./docs/plugins/server.md): Provides HTTP server capabilities with development and production modes.
50
+
51
+ ## appkit API reference [collapsed]
52
+
53
+ - [@databricks/appkit](./docs/api/appkit.md): Core library for building Databricks applications with type-safe SQL queries,
54
+ - [Abstract Class: AppKitError](./docs/api/appkit/Class.AppKitError.md): Base error class for all AppKit errors.
55
+ - [Class: AuthenticationError](./docs/api/appkit/Class.AuthenticationError.md): Error thrown when authentication fails.
56
+ - [Class: ConfigurationError](./docs/api/appkit/Class.ConfigurationError.md): Error thrown when configuration is missing or invalid.
57
+ - [Class: ConnectionError](./docs/api/appkit/Class.ConnectionError.md): Error thrown when a connection or network operation fails.
58
+ - [Class: ExecutionError](./docs/api/appkit/Class.ExecutionError.md): Error thrown when an operation execution fails.
59
+ - [Class: InitializationError](./docs/api/appkit/Class.InitializationError.md): Error thrown when a service or component is not properly initialized.
60
+ - [Abstract Class: Plugin<TConfig>](./docs/api/appkit/Class.Plugin.md): Base abstract class for creating AppKit plugins.
61
+ - [Class: ResourceRegistry](./docs/api/appkit/Class.ResourceRegistry.md): Central registry for tracking plugin resource requirements.
62
+ - [Class: ServerError](./docs/api/appkit/Class.ServerError.md): Error thrown when server lifecycle operations fail.
63
+ - [Class: TunnelError](./docs/api/appkit/Class.TunnelError.md): Error thrown when remote tunnel operations fail.
64
+ - [Class: ValidationError](./docs/api/appkit/Class.ValidationError.md): Error thrown when input validation fails.
65
+ - [Enumeration: RequestedClaimsPermissionSet](./docs/api/appkit/Enumeration.RequestedClaimsPermissionSet.md): Permission set for Unity Catalog table access
66
+ - [Enumeration: ResourceType](./docs/api/appkit/Enumeration.ResourceType.md): Resource types from schema $defs.resourceType.enum
67
+ - [Function: appKitTypesPlugin()](./docs/api/appkit/Function.appKitTypesPlugin.md): Vite plugin to generate types for AppKit queries.
68
+ - [Function: createApp()](./docs/api/appkit/Function.createApp.md): Bootstraps AppKit with the provided configuration.
69
+ - [Function: createLakebasePool()](./docs/api/appkit/Function.createLakebasePool.md): Create a Lakebase pool with appkit's logger integration.
70
+ - [Function: generateDatabaseCredential()](./docs/api/appkit/Function.generateDatabaseCredential.md): Generate OAuth credentials for Postgres database connection using the proper Postgres API.
71
+ - [Function: getExecutionContext()](./docs/api/appkit/Function.getExecutionContext.md): Get the current execution context.
72
+ - [Function: getLakebaseOrmConfig()](./docs/api/appkit/Function.getLakebaseOrmConfig.md): Get Lakebase connection configuration for ORMs that don't accept pg.Pool directly.
73
+ - [Function: getLakebasePgConfig()](./docs/api/appkit/Function.getLakebasePgConfig.md): Get Lakebase connection configuration for PostgreSQL clients.
74
+ - [Function: getPluginManifest()](./docs/api/appkit/Function.getPluginManifest.md): Loads and validates the manifest from a plugin constructor.
75
+ - [Function: getResourceRequirements()](./docs/api/appkit/Function.getResourceRequirements.md): Gets the resource requirements from a plugin's manifest.
76
+ - [Function: getUsernameWithApiLookup()](./docs/api/appkit/Function.getUsernameWithApiLookup.md): Resolves the PostgreSQL username for a Lakebase connection.
77
+ - [Function: getWorkspaceClient()](./docs/api/appkit/Function.getWorkspaceClient.md): Get workspace client from config or SDK default auth chain
78
+ - [Function: isSQLTypeMarker()](./docs/api/appkit/Function.isSQLTypeMarker.md): Type guard to check if a value is a SQL type marker
79
+ - [Interface: BasePluginConfig](./docs/api/appkit/Interface.BasePluginConfig.md): Base configuration interface for AppKit plugins
80
+ - [Interface: CacheConfig](./docs/api/appkit/Interface.CacheConfig.md): Configuration for caching
81
+ - [Interface: DatabaseCredential](./docs/api/appkit/Interface.DatabaseCredential.md): Database credentials with OAuth token for Postgres connection
82
+ - [Interface: GenerateDatabaseCredentialRequest](./docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md): Request parameters for generating database OAuth credentials
83
+ - [Interface: ITelemetry](./docs/api/appkit/Interface.ITelemetry.md): Plugin-facing interface for OpenTelemetry instrumentation.
84
+ - [Interface: LakebasePoolConfig](./docs/api/appkit/Interface.LakebasePoolConfig.md): Configuration for creating a Lakebase connection pool
85
+ - [Interface: PluginManifest](./docs/api/appkit/Interface.PluginManifest.md): Plugin manifest that declares metadata and resource requirements.
86
+ - [Interface: RequestedClaims](./docs/api/appkit/Interface.RequestedClaims.md): Optional claims for fine-grained Unity Catalog table permissions
87
+ - [Interface: RequestedResource](./docs/api/appkit/Interface.RequestedResource.md): Resource to request permissions for in Unity Catalog
88
+ - [Interface: ResourceEntry](./docs/api/appkit/Interface.ResourceEntry.md): Internal representation of a resource in the registry.
89
+ - [Interface: ResourceFieldEntry](./docs/api/appkit/Interface.ResourceFieldEntry.md): Defines a single field for a resource. Each field has its own environment variable and optional description.
90
+ - [Interface: ResourceRequirement](./docs/api/appkit/Interface.ResourceRequirement.md): Declares a resource requirement for a plugin.
91
+ - [Interface: StreamExecutionSettings](./docs/api/appkit/Interface.StreamExecutionSettings.md): Configuration for streaming execution with default and user-scoped settings
92
+ - [Interface: TelemetryConfig](./docs/api/appkit/Interface.TelemetryConfig.md): OpenTelemetry configuration for AppKit applications
93
+ - [Interface: ValidationResult](./docs/api/appkit/Interface.ValidationResult.md): Result of validating all registered resources against the environment.
94
+ - [Type Alias: ConfigSchema](./docs/api/appkit/TypeAlias.ConfigSchema.md): Configuration schema definition for plugin config.
95
+ - [Type Alias: IAppRouter](./docs/api/appkit/TypeAlias.IAppRouter.md): Express router type for plugin route registration
96
+ - [Type Alias: ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md): Union of all possible permission levels across all resource types.
97
+ - [Type Alias: ToPlugin()<T, U, N>](./docs/api/appkit/TypeAlias.ToPlugin.md): Type Parameters
98
+ - [Variable: sql](./docs/api/appkit/Variable.sql.md): SQL helper namespace
99
+
100
+ ## appkit-ui API reference [collapsed]
101
+
102
+ - [@databricks/appkit-ui](./docs/api/appkit-ui.md): The library provides a set of UI primitives for building Databricks apps in React.
103
+ - [AreaChart](./docs/api/appkit-ui/data/AreaChart.md): Area Chart component for trend visualization with filled areas.
104
+ - [BarChart](./docs/api/appkit-ui/data/BarChart.md): Bar Chart component for categorical comparisons.
105
+ - [DataTable](./docs/api/appkit-ui/data/DataTable.md): Production-ready data table with automatic data fetching and state management
106
+ - [DonutChart](./docs/api/appkit-ui/data/DonutChart.md): Donut Chart component (Pie chart with inner radius).
107
+ - [HeatmapChart](./docs/api/appkit-ui/data/HeatmapChart.md): Heatmap Chart component for matrix-style data visualization.
108
+ - [LineChart](./docs/api/appkit-ui/data/LineChart.md): Line Chart component for time-series and trend visualization.
109
+ - [PieChart](./docs/api/appkit-ui/data/PieChart.md): Pie Chart component for proportional data visualization.
110
+ - [RadarChart](./docs/api/appkit-ui/data/RadarChart.md): Radar Chart component for multi-dimensional data comparison.
111
+ - [ScatterChart](./docs/api/appkit-ui/data/ScatterChart.md): Scatter Chart component for correlation and distribution visualization.
112
+ - [GenieChat](./docs/api/appkit-ui/genie/GenieChat.md): Full-featured chat interface for a single Databricks AI/BI Genie space. Handles message streaming, conversation history, and auto-reconnection via SSE.
113
+ - [GenieChatInput](./docs/api/appkit-ui/genie/GenieChatInput.md): Auto-expanding textarea input with a send button for chat messages. Submits on Enter (Shift+Enter for newline).
114
+ - [GenieChatMessage](./docs/api/appkit-ui/genie/GenieChatMessage.md): Renders a single Genie message bubble with optional expandable SQL query attachments.
115
+ - [GenieChatMessageList](./docs/api/appkit-ui/genie/GenieChatMessageList.md): Scrollable message list that renders Genie chat messages with auto-scroll, skeleton loaders, and a streaming indicator.
116
+ - [Styling](./docs/api/appkit-ui/styling.md): This guide covers how to style AppKit UI components using CSS variables and theming.
117
+ - [Accordion](./docs/api/appkit-ui/ui/Accordion.md): Collapsible content sections organized in a vertical stack
118
+ - [Alert](./docs/api/appkit-ui/ui/Alert.md): Displays important information with optional icon and multiple variants
119
+ - [AlertDialog](./docs/api/appkit-ui/ui/AlertDialog.md): Modal dialog that interrupts the user with critical information requiring immediate action
120
+ - [AspectRatio](./docs/api/appkit-ui/ui/AspectRatio.md): Container that maintains a specific aspect ratio for its content
121
+ - [Avatar](./docs/api/appkit-ui/ui/Avatar.md): Displays user profile picture or initials in a circular container
122
+ - [Badge](./docs/api/appkit-ui/ui/Badge.md): Small label for displaying status, categories, or counts
123
+ - [Breadcrumb](./docs/api/appkit-ui/ui/Breadcrumb.md): Navigation component showing the current page's location in the site hierarchy
124
+ - [Button](./docs/api/appkit-ui/ui/Button.md): Clickable button with multiple variants and sizes
125
+ - [ButtonGroup](./docs/api/appkit-ui/ui/ButtonGroup.md): Container for grouping related buttons together with shared borders
126
+ - [Calendar](./docs/api/appkit-ui/ui/Calendar.md): Date picker component for selecting single dates or date ranges
127
+ - [Card](./docs/api/appkit-ui/ui/Card.md): Container for grouping related content with header, body, and footer sections
128
+ - [Carousel](./docs/api/appkit-ui/ui/Carousel.md): Slideshow component for cycling through content with navigation controls
129
+ - [ChartContainer](./docs/api/appkit-ui/ui/ChartContainer.md): Container for rendering data visualizations using Recharts
130
+ - [Checkbox](./docs/api/appkit-ui/ui/Checkbox.md): Checkbox input for selecting multiple options
131
+ - [Collapsible](./docs/api/appkit-ui/ui/Collapsible.md): Interactive component that expands and collapses content
132
+ - [Command](./docs/api/appkit-ui/ui/Command.md): Command palette for keyboard-driven navigation and actions
133
+ - [ContextMenu](./docs/api/appkit-ui/ui/ContextMenu.md): Menu triggered by right-clicking an element
134
+ - [Dialog](./docs/api/appkit-ui/ui/Dialog.md): Modal dialog that overlays the page content
135
+ - [Drawer](./docs/api/appkit-ui/ui/Drawer.md): Draggable panel that slides in from screen edges
136
+ - [DropdownMenu](./docs/api/appkit-ui/ui/DropdownMenu.md): Menu that displays when triggered by a button or element
137
+ - [Empty](./docs/api/appkit-ui/ui/Empty.md): Empty state component for displaying no-data scenarios
138
+ - [Field](./docs/api/appkit-ui/ui/Field.md): Form field wrapper with label and input positioning
139
+ - [FormControl](./docs/api/appkit-ui/ui/FormControl.md): Wrapper for form control elements with accessibility attributes
140
+ - [HoverCard](./docs/api/appkit-ui/ui/HoverCard.md): Content card that appears when hovering over an element
141
+ - [Input](./docs/api/appkit-ui/ui/Input.md): Text input field for single-line user input
142
+ - [InputGroup](./docs/api/appkit-ui/ui/InputGroup.md): Container for combining input fields with addons and buttons
143
+ - [InputOTP](./docs/api/appkit-ui/ui/InputOTP.md): One-time password input with individual character slots
144
+ - [Item](./docs/api/appkit-ui/ui/Item.md): Flexible container for list items with media, content, and actions
145
+ - [Kbd](./docs/api/appkit-ui/ui/Kbd.md): Visual representation of keyboard keys
146
+ - [Label](./docs/api/appkit-ui/ui/Label.md): Text label associated with form controls
147
+ - [Menubar](./docs/api/appkit-ui/ui/Menubar.md): Horizontal menu bar with dropdown menus
148
+ - [NavigationMenu](./docs/api/appkit-ui/ui/NavigationMenu.md): Horizontal navigation menu with dropdown submenus
149
+ - [Pagination](./docs/api/appkit-ui/ui/Pagination.md): Navigation component for paginated content
150
+ - [Popover](./docs/api/appkit-ui/ui/Popover.md): Floating content panel anchored to a trigger element
151
+ - [Progress](./docs/api/appkit-ui/ui/Progress.md): Visual indicator showing task completion percentage
152
+ - [RadioGroup](./docs/api/appkit-ui/ui/RadioGroup.md): Group of radio buttons for selecting a single option
153
+ - [ResizableHandle](./docs/api/appkit-ui/ui/ResizableHandle.md): Draggable handle for resizing panels
154
+ - [ScrollArea](./docs/api/appkit-ui/ui/ScrollArea.md): Container with custom scrollbars for overflow content
155
+ - [Select](./docs/api/appkit-ui/ui/Select.md): Dropdown control for selecting a value from a list
156
+ - [Separator](./docs/api/appkit-ui/ui/Separator.md): Visual divider line between content sections
157
+ - [Sheet](./docs/api/appkit-ui/ui/Sheet.md): Sliding panel that overlays content from screen edges
158
+ - [Sidebar](./docs/api/appkit-ui/ui/Sidebar.md): Collapsible navigation sidebar with mobile support
159
+ - [Skeleton](./docs/api/appkit-ui/ui/Skeleton.md): Loading placeholder with pulsing animation
160
+ - [Slider](./docs/api/appkit-ui/ui/Slider.md): Draggable input for selecting numeric values within a range
161
+ - [Spinner](./docs/api/appkit-ui/ui/Spinner.md): Animated loading indicator
162
+ - [Switch](./docs/api/appkit-ui/ui/Switch.md): Toggle control for switching between on and off states
163
+ - [Table](./docs/api/appkit-ui/ui/Table.md): Structured data display with rows and columns
164
+ - [Tabs](./docs/api/appkit-ui/ui/Tabs.md): Tabbed interface for organizing content into separate panels
165
+ - [Textarea](./docs/api/appkit-ui/ui/Textarea.md): Multi-line text input field
166
+ - [Toaster](./docs/api/appkit-ui/ui/Toaster.md): Toast notification system for displaying temporary messages
167
+ - [Toggle](./docs/api/appkit-ui/ui/Toggle.md): Button that toggles between pressed and unpressed states
168
+ - [ToggleGroup](./docs/api/appkit-ui/ui/ToggleGroup.md): Group of toggle buttons for selecting one or more options
169
+ - [Tooltip](./docs/api/appkit-ui/ui/Tooltip.md): Brief informational message that appears on hover
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@databricks/appkit-ui",
3
3
  "type": "module",
4
- "version": "0.12.0",
4
+ "version": "0.12.2",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/databricks/appkit.git"
@@ -12,6 +12,7 @@
12
12
  "bin",
13
13
  "scripts",
14
14
  "docs",
15
+ "docs.md",
15
16
  "CLAUDE.md",
16
17
  "llms.txt",
17
18
  "README.md",