@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
@@ -12,7 +12,7 @@ throw new InitializationError("ServiceContext not initialized. Call ServiceConte
12
12
 
13
13
  ## Extends[​](#extends "Direct link to Extends")
14
14
 
15
- * [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md)
15
+ * [`AppKitError`](./docs/api/appkit/Class.AppKitError.md)
16
16
 
17
17
  ## Constructors[​](#constructors "Direct link to Constructors")
18
18
 
@@ -41,7 +41,7 @@ new InitializationError(message: string, options?: {
41
41
 
42
42
  #### Inherited from[​](#inherited-from "Direct link to Inherited from")
43
43
 
44
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`constructor`](/appkit/docs/api/appkit/Class.AppKitError.md#constructor)
44
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`constructor`](./docs/api/appkit/Class.AppKitError.md#constructor)
45
45
 
46
46
  ## Properties[​](#properties "Direct link to Properties")
47
47
 
@@ -56,7 +56,7 @@ Optional cause of the error
56
56
 
57
57
  #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
58
58
 
59
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`cause`](/appkit/docs/api/appkit/Class.AppKitError.md#cause)
59
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`cause`](./docs/api/appkit/Class.AppKitError.md#cause)
60
60
 
61
61
  ***
62
62
 
@@ -71,7 +71,7 @@ Error code for programmatic error handling
71
71
 
72
72
  #### Overrides[​](#overrides "Direct link to Overrides")
73
73
 
74
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`code`](/appkit/docs/api/appkit/Class.AppKitError.md#code)
74
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`code`](./docs/api/appkit/Class.AppKitError.md#code)
75
75
 
76
76
  ***
77
77
 
@@ -86,7 +86,7 @@ Additional context for the error
86
86
 
87
87
  #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
88
88
 
89
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`context`](/appkit/docs/api/appkit/Class.AppKitError.md#context)
89
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`context`](./docs/api/appkit/Class.AppKitError.md#context)
90
90
 
91
91
  ***
92
92
 
@@ -101,7 +101,7 @@ Whether this error type is generally safe to retry
101
101
 
102
102
  #### Overrides[​](#overrides-1 "Direct link to Overrides")
103
103
 
104
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`isRetryable`](/appkit/docs/api/appkit/Class.AppKitError.md#isretryable)
104
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`isRetryable`](./docs/api/appkit/Class.AppKitError.md#isretryable)
105
105
 
106
106
  ***
107
107
 
@@ -116,7 +116,7 @@ HTTP status code suggestion (can be overridden)
116
116
 
117
117
  #### Overrides[​](#overrides-2 "Direct link to Overrides")
118
118
 
119
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`statusCode`](/appkit/docs/api/appkit/Class.AppKitError.md#statuscode)
119
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`statusCode`](./docs/api/appkit/Class.AppKitError.md#statuscode)
120
120
 
121
121
  ## Methods[​](#methods "Direct link to Methods")
122
122
 
@@ -135,7 +135,7 @@ Convert error to JSON for logging/serialization. Sensitive values in context are
135
135
 
136
136
  #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
137
137
 
138
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toJSON`](/appkit/docs/api/appkit/Class.AppKitError.md#tojson)
138
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toJSON`](./docs/api/appkit/Class.AppKitError.md#tojson)
139
139
 
140
140
  ***
141
141
 
@@ -154,7 +154,7 @@ Create a human-readable string representation
154
154
 
155
155
  #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
156
156
 
157
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toString`](/appkit/docs/api/appkit/Class.AppKitError.md#tostring)
157
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toString`](./docs/api/appkit/Class.AppKitError.md#tostring)
158
158
 
159
159
  ***
160
160
 
@@ -87,7 +87,7 @@ class MyPlugin extends Plugin<MyConfig> {
87
87
 
88
88
  | Type Parameter | Default type |
89
89
  | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
90
- | `TConfig` *extends* [`BasePluginConfig`](/appkit/docs/api/appkit/Interface.BasePluginConfig.md) | [`BasePluginConfig`](/appkit/docs/api/appkit/Interface.BasePluginConfig.md) |
90
+ | `TConfig` *extends* [`BasePluginConfig`](./docs/api/appkit/Interface.BasePluginConfig.md) | [`BasePluginConfig`](./docs/api/appkit/Interface.BasePluginConfig.md) |
91
91
 
92
92
  ## Implements[​](#implements "Direct link to Implements")
93
93
 
@@ -310,7 +310,7 @@ userKey?: string): Promise<void>;
310
310
  | ---------- | ----------------------------------------------------------------------------------------- |
311
311
  | `res` | `IAppResponse` |
312
312
  | `fn` | `StreamExecuteHandler`<`T`> |
313
- | `options` | [`StreamExecutionSettings`](/appkit/docs/api/appkit/Interface.StreamExecutionSettings.md) |
313
+ | `options` | [`StreamExecutionSettings`](./docs/api/appkit/Interface.StreamExecutionSettings.md) |
314
314
  | `userKey?` | `string` |
315
315
 
316
316
  #### Returns[​](#returns-4 "Direct link to Returns")
@@ -328,10 +328,30 @@ exports(): unknown;
328
328
 
329
329
  Returns the public exports for this plugin. Override this to define a custom public API. By default, returns an empty object.
330
330
 
331
+ The returned object becomes the plugin's public API on the AppKit instance (e.g. `appkit.myPlugin.method()`). AppKit automatically binds method context and adds `asUser(req)` for user-scoped execution.
332
+
331
333
  #### Returns[​](#returns-5 "Direct link to Returns")
332
334
 
333
335
  `unknown`
334
336
 
337
+ #### Example[​](#example "Direct link to Example")
338
+
339
+ ```ts
340
+ class MyPlugin extends Plugin {
341
+ name = "myPlugin";
342
+ private getData() { return []; }
343
+
344
+ exports() {
345
+ return { getData: this.getData };
346
+ }
347
+ }
348
+
349
+ // After registration:
350
+ const appkit = await createApp({ plugins: [myPlugin()] });
351
+ appkit.myPlugin.getData();
352
+
353
+ ```
354
+
335
355
  #### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")
336
356
 
337
357
  ```ts
@@ -66,13 +66,13 @@ enforceValidation(): ValidationResult;
66
66
 
67
67
  Validates all registered resources and enforces the result.
68
68
 
69
- * In production: throws a [ConfigurationError](/appkit/docs/api/appkit/Class.ConfigurationError.md) if any required resources are missing.
69
+ * In production: throws a [ConfigurationError](./docs/api/appkit/Class.ConfigurationError.md) if any required resources are missing.
70
70
  * In development (`NODE_ENV=development`): logs a warning but continues, unless `APPKIT_STRICT_VALIDATION=true` is set, in which case throws like production.
71
71
  * When all resources are valid: logs a debug message with the count.
72
72
 
73
73
  #### Returns[​](#returns-3 "Direct link to Returns")
74
74
 
75
- [`ValidationResult`](/appkit/docs/api/appkit/Interface.ValidationResult.md)
75
+ [`ValidationResult`](./docs/api/appkit/Interface.ValidationResult.md)
76
76
 
77
77
  ValidationResult with validity status, missing resources, and all resources
78
78
 
@@ -100,7 +100,7 @@ Gets a specific resource by type and resourceKey (dedup key).
100
100
 
101
101
  #### Returns[​](#returns-4 "Direct link to Returns")
102
102
 
103
- [`ResourceEntry`](/appkit/docs/api/appkit/Interface.ResourceEntry.md) | `undefined`
103
+ [`ResourceEntry`](./docs/api/appkit/Interface.ResourceEntry.md) | `undefined`
104
104
 
105
105
  The resource entry if found, undefined otherwise
106
106
 
@@ -117,7 +117,7 @@ Retrieves all registered resources. Returns a copy of the array to prevent exter
117
117
 
118
118
  #### Returns[​](#returns-5 "Direct link to Returns")
119
119
 
120
- [`ResourceEntry`](/appkit/docs/api/appkit/Interface.ResourceEntry.md)\[]
120
+ [`ResourceEntry`](./docs/api/appkit/Interface.ResourceEntry.md)\[]
121
121
 
122
122
  Array of all registered resource entries
123
123
 
@@ -140,7 +140,7 @@ Gets all resources required by a specific plugin.
140
140
 
141
141
  #### Returns[​](#returns-6 "Direct link to Returns")
142
142
 
143
- [`ResourceEntry`](/appkit/docs/api/appkit/Interface.ResourceEntry.md)\[]
143
+ [`ResourceEntry`](./docs/api/appkit/Interface.ResourceEntry.md)\[]
144
144
 
145
145
  Array of resources where the plugin is listed as a requester
146
146
 
@@ -157,7 +157,7 @@ Gets all optional resources (where required=false).
157
157
 
158
158
  #### Returns[​](#returns-7 "Direct link to Returns")
159
159
 
160
- [`ResourceEntry`](/appkit/docs/api/appkit/Interface.ResourceEntry.md)\[]
160
+ [`ResourceEntry`](./docs/api/appkit/Interface.ResourceEntry.md)\[]
161
161
 
162
162
  Array of optional resource entries
163
163
 
@@ -174,7 +174,7 @@ Gets all required resources (where required=true).
174
174
 
175
175
  #### Returns[​](#returns-8 "Direct link to Returns")
176
176
 
177
- [`ResourceEntry`](/appkit/docs/api/appkit/Interface.ResourceEntry.md)\[]
177
+ [`ResourceEntry`](./docs/api/appkit/Interface.ResourceEntry.md)\[]
178
178
 
179
179
  Array of required resource entries
180
180
 
@@ -200,7 +200,7 @@ Registers a resource requirement for a plugin. If a resource with the same type+
200
200
  | Parameter | Type | Description |
201
201
  | ---------- | --------------------------------------------------------------------------------- | ------------------------------------------- |
202
202
  | `plugin` | `string` | Name of the plugin registering the resource |
203
- | `resource` | [`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md) | Resource requirement specification |
203
+ | `resource` | [`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md) | Resource requirement specification |
204
204
 
205
205
  #### Returns[​](#returns-9 "Direct link to Returns")
206
206
 
@@ -238,7 +238,7 @@ Only required resources affect the `valid` status - optional resources are check
238
238
 
239
239
  #### Returns[​](#returns-11 "Direct link to Returns")
240
240
 
241
- [`ValidationResult`](/appkit/docs/api/appkit/Interface.ValidationResult.md)
241
+ [`ValidationResult`](./docs/api/appkit/Interface.ValidationResult.md)
242
242
 
243
243
  ValidationResult with validity status, missing resources, and all resources
244
244
 
@@ -269,7 +269,7 @@ Formats a highly visible warning banner for dev-mode missing resources. Uses box
269
269
 
270
270
  | Parameter | Type | Description |
271
271
  | --------- | ------------------------------------------------------------------------ | --------------------------------- |
272
- | `missing` | [`ResourceEntry`](/appkit/docs/api/appkit/Interface.ResourceEntry.md)\[] | Array of missing resource entries |
272
+ | `missing` | [`ResourceEntry`](./docs/api/appkit/Interface.ResourceEntry.md)\[] | Array of missing resource entries |
273
273
 
274
274
  #### Returns[​](#returns-12 "Direct link to Returns")
275
275
 
@@ -292,7 +292,7 @@ Formats missing resources into a human-readable error message.
292
292
 
293
293
  | Parameter | Type | Description |
294
294
  | --------- | ------------------------------------------------------------------------ | --------------------------------- |
295
- | `missing` | [`ResourceEntry`](/appkit/docs/api/appkit/Interface.ResourceEntry.md)\[] | Array of missing resource entries |
295
+ | `missing` | [`ResourceEntry`](./docs/api/appkit/Interface.ResourceEntry.md)\[] | Array of missing resource entries |
296
296
 
297
297
  #### Returns[​](#returns-13 "Direct link to Returns")
298
298
 
@@ -12,7 +12,7 @@ throw new ServerError("Server not started");
12
12
 
13
13
  ## Extends[​](#extends "Direct link to Extends")
14
14
 
15
- * [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md)
15
+ * [`AppKitError`](./docs/api/appkit/Class.AppKitError.md)
16
16
 
17
17
  ## Constructors[​](#constructors "Direct link to Constructors")
18
18
 
@@ -41,7 +41,7 @@ new ServerError(message: string, options?: {
41
41
 
42
42
  #### Inherited from[​](#inherited-from "Direct link to Inherited from")
43
43
 
44
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`constructor`](/appkit/docs/api/appkit/Class.AppKitError.md#constructor)
44
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`constructor`](./docs/api/appkit/Class.AppKitError.md#constructor)
45
45
 
46
46
  ## Properties[​](#properties "Direct link to Properties")
47
47
 
@@ -56,7 +56,7 @@ Optional cause of the error
56
56
 
57
57
  #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
58
58
 
59
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`cause`](/appkit/docs/api/appkit/Class.AppKitError.md#cause)
59
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`cause`](./docs/api/appkit/Class.AppKitError.md#cause)
60
60
 
61
61
  ***
62
62
 
@@ -71,7 +71,7 @@ Error code for programmatic error handling
71
71
 
72
72
  #### Overrides[​](#overrides "Direct link to Overrides")
73
73
 
74
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`code`](/appkit/docs/api/appkit/Class.AppKitError.md#code)
74
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`code`](./docs/api/appkit/Class.AppKitError.md#code)
75
75
 
76
76
  ***
77
77
 
@@ -86,7 +86,7 @@ Additional context for the error
86
86
 
87
87
  #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
88
88
 
89
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`context`](/appkit/docs/api/appkit/Class.AppKitError.md#context)
89
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`context`](./docs/api/appkit/Class.AppKitError.md#context)
90
90
 
91
91
  ***
92
92
 
@@ -101,7 +101,7 @@ Whether this error type is generally safe to retry
101
101
 
102
102
  #### Overrides[​](#overrides-1 "Direct link to Overrides")
103
103
 
104
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`isRetryable`](/appkit/docs/api/appkit/Class.AppKitError.md#isretryable)
104
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`isRetryable`](./docs/api/appkit/Class.AppKitError.md#isretryable)
105
105
 
106
106
  ***
107
107
 
@@ -116,7 +116,7 @@ HTTP status code suggestion (can be overridden)
116
116
 
117
117
  #### Overrides[​](#overrides-2 "Direct link to Overrides")
118
118
 
119
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`statusCode`](/appkit/docs/api/appkit/Class.AppKitError.md#statuscode)
119
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`statusCode`](./docs/api/appkit/Class.AppKitError.md#statuscode)
120
120
 
121
121
  ## Methods[​](#methods "Direct link to Methods")
122
122
 
@@ -135,7 +135,7 @@ Convert error to JSON for logging/serialization. Sensitive values in context are
135
135
 
136
136
  #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
137
137
 
138
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toJSON`](/appkit/docs/api/appkit/Class.AppKitError.md#tojson)
138
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toJSON`](./docs/api/appkit/Class.AppKitError.md#tojson)
139
139
 
140
140
  ***
141
141
 
@@ -154,7 +154,7 @@ Create a human-readable string representation
154
154
 
155
155
  #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
156
156
 
157
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toString`](/appkit/docs/api/appkit/Class.AppKitError.md#tostring)
157
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toString`](./docs/api/appkit/Class.AppKitError.md#tostring)
158
158
 
159
159
  ***
160
160
 
@@ -12,7 +12,7 @@ throw new TunnelError("Failed to parse WebSocket message", { cause: parseError }
12
12
 
13
13
  ## Extends[​](#extends "Direct link to Extends")
14
14
 
15
- * [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md)
15
+ * [`AppKitError`](./docs/api/appkit/Class.AppKitError.md)
16
16
 
17
17
  ## Constructors[​](#constructors "Direct link to Constructors")
18
18
 
@@ -41,7 +41,7 @@ new TunnelError(message: string, options?: {
41
41
 
42
42
  #### Inherited from[​](#inherited-from "Direct link to Inherited from")
43
43
 
44
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`constructor`](/appkit/docs/api/appkit/Class.AppKitError.md#constructor)
44
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`constructor`](./docs/api/appkit/Class.AppKitError.md#constructor)
45
45
 
46
46
  ## Properties[​](#properties "Direct link to Properties")
47
47
 
@@ -56,7 +56,7 @@ Optional cause of the error
56
56
 
57
57
  #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
58
58
 
59
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`cause`](/appkit/docs/api/appkit/Class.AppKitError.md#cause)
59
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`cause`](./docs/api/appkit/Class.AppKitError.md#cause)
60
60
 
61
61
  ***
62
62
 
@@ -71,7 +71,7 @@ Error code for programmatic error handling
71
71
 
72
72
  #### Overrides[​](#overrides "Direct link to Overrides")
73
73
 
74
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`code`](/appkit/docs/api/appkit/Class.AppKitError.md#code)
74
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`code`](./docs/api/appkit/Class.AppKitError.md#code)
75
75
 
76
76
  ***
77
77
 
@@ -86,7 +86,7 @@ Additional context for the error
86
86
 
87
87
  #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
88
88
 
89
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`context`](/appkit/docs/api/appkit/Class.AppKitError.md#context)
89
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`context`](./docs/api/appkit/Class.AppKitError.md#context)
90
90
 
91
91
  ***
92
92
 
@@ -101,7 +101,7 @@ Whether this error type is generally safe to retry
101
101
 
102
102
  #### Overrides[​](#overrides-1 "Direct link to Overrides")
103
103
 
104
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`isRetryable`](/appkit/docs/api/appkit/Class.AppKitError.md#isretryable)
104
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`isRetryable`](./docs/api/appkit/Class.AppKitError.md#isretryable)
105
105
 
106
106
  ***
107
107
 
@@ -116,7 +116,7 @@ HTTP status code suggestion (can be overridden)
116
116
 
117
117
  #### Overrides[​](#overrides-2 "Direct link to Overrides")
118
118
 
119
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`statusCode`](/appkit/docs/api/appkit/Class.AppKitError.md#statuscode)
119
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`statusCode`](./docs/api/appkit/Class.AppKitError.md#statuscode)
120
120
 
121
121
  ## Methods[​](#methods "Direct link to Methods")
122
122
 
@@ -135,7 +135,7 @@ Convert error to JSON for logging/serialization. Sensitive values in context are
135
135
 
136
136
  #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
137
137
 
138
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toJSON`](/appkit/docs/api/appkit/Class.AppKitError.md#tojson)
138
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toJSON`](./docs/api/appkit/Class.AppKitError.md#tojson)
139
139
 
140
140
  ***
141
141
 
@@ -154,7 +154,7 @@ Create a human-readable string representation
154
154
 
155
155
  #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
156
156
 
157
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toString`](/appkit/docs/api/appkit/Class.AppKitError.md#tostring)
157
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toString`](./docs/api/appkit/Class.AppKitError.md#tostring)
158
158
 
159
159
  ***
160
160
 
@@ -12,7 +12,7 @@ throw new ValidationError("maxPoolSize must be at least 1", { context: { value:
12
12
 
13
13
  ## Extends[​](#extends "Direct link to Extends")
14
14
 
15
- * [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md)
15
+ * [`AppKitError`](./docs/api/appkit/Class.AppKitError.md)
16
16
 
17
17
  ## Constructors[​](#constructors "Direct link to Constructors")
18
18
 
@@ -41,7 +41,7 @@ new ValidationError(message: string, options?: {
41
41
 
42
42
  #### Inherited from[​](#inherited-from "Direct link to Inherited from")
43
43
 
44
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`constructor`](/appkit/docs/api/appkit/Class.AppKitError.md#constructor)
44
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`constructor`](./docs/api/appkit/Class.AppKitError.md#constructor)
45
45
 
46
46
  ## Properties[​](#properties "Direct link to Properties")
47
47
 
@@ -56,7 +56,7 @@ Optional cause of the error
56
56
 
57
57
  #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
58
58
 
59
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`cause`](/appkit/docs/api/appkit/Class.AppKitError.md#cause)
59
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`cause`](./docs/api/appkit/Class.AppKitError.md#cause)
60
60
 
61
61
  ***
62
62
 
@@ -71,7 +71,7 @@ Error code for programmatic error handling
71
71
 
72
72
  #### Overrides[​](#overrides "Direct link to Overrides")
73
73
 
74
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`code`](/appkit/docs/api/appkit/Class.AppKitError.md#code)
74
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`code`](./docs/api/appkit/Class.AppKitError.md#code)
75
75
 
76
76
  ***
77
77
 
@@ -86,7 +86,7 @@ Additional context for the error
86
86
 
87
87
  #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
88
88
 
89
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`context`](/appkit/docs/api/appkit/Class.AppKitError.md#context)
89
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`context`](./docs/api/appkit/Class.AppKitError.md#context)
90
90
 
91
91
  ***
92
92
 
@@ -101,7 +101,7 @@ Whether this error type is generally safe to retry
101
101
 
102
102
  #### Overrides[​](#overrides-1 "Direct link to Overrides")
103
103
 
104
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`isRetryable`](/appkit/docs/api/appkit/Class.AppKitError.md#isretryable)
104
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`isRetryable`](./docs/api/appkit/Class.AppKitError.md#isretryable)
105
105
 
106
106
  ***
107
107
 
@@ -116,7 +116,7 @@ HTTP status code suggestion (can be overridden)
116
116
 
117
117
  #### Overrides[​](#overrides-2 "Direct link to Overrides")
118
118
 
119
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`statusCode`](/appkit/docs/api/appkit/Class.AppKitError.md#statuscode)
119
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`statusCode`](./docs/api/appkit/Class.AppKitError.md#statuscode)
120
120
 
121
121
  ## Methods[​](#methods "Direct link to Methods")
122
122
 
@@ -135,7 +135,7 @@ Convert error to JSON for logging/serialization. Sensitive values in context are
135
135
 
136
136
  #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
137
137
 
138
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toJSON`](/appkit/docs/api/appkit/Class.AppKitError.md#tojson)
138
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toJSON`](./docs/api/appkit/Class.AppKitError.md#tojson)
139
139
 
140
140
  ***
141
141
 
@@ -154,7 +154,7 @@ Create a human-readable string representation
154
154
 
155
155
  #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
156
156
 
157
- [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toString`](/appkit/docs/api/appkit/Class.AppKitError.md#tostring)
157
+ [`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toString`](./docs/api/appkit/Class.AppKitError.md#tostring)
158
158
 
159
159
  ***
160
160
 
@@ -12,6 +12,8 @@ function createApp<T>(config: {
12
12
 
13
13
  Bootstraps AppKit with the provided configuration.
14
14
 
15
+ Initializes telemetry, cache, and service context, then registers plugins in phase order (core, normal, deferred) and awaits their setup. The returned object maps each plugin name to its `exports()` API, with an `asUser(req)` method for user-scoped execution.
16
+
15
17
  ## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
16
18
 
17
19
  | Type Parameter |
@@ -22,12 +24,39 @@ Bootstraps AppKit with the provided configuration.
22
24
 
23
25
  | Parameter | Type |
24
26
  | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
25
- | `config` | { `cache?`: [`CacheConfig`](/appkit/docs/api/appkit/Interface.CacheConfig.md); `client?`: `WorkspaceClient`; `plugins?`: `T`; `telemetry?`: [`TelemetryConfig`](/appkit/docs/api/appkit/Interface.TelemetryConfig.md); } |
26
- | `config.cache?` | [`CacheConfig`](/appkit/docs/api/appkit/Interface.CacheConfig.md) |
27
+ | `config` | { `cache?`: [`CacheConfig`](./docs/api/appkit/Interface.CacheConfig.md); `client?`: `WorkspaceClient`; `plugins?`: `T`; `telemetry?`: [`TelemetryConfig`](./docs/api/appkit/Interface.TelemetryConfig.md); } |
28
+ | `config.cache?` | [`CacheConfig`](./docs/api/appkit/Interface.CacheConfig.md) |
27
29
  | `config.client?` | `WorkspaceClient` |
28
30
  | `config.plugins?` | `T` |
29
- | `config.telemetry?` | [`TelemetryConfig`](/appkit/docs/api/appkit/Interface.TelemetryConfig.md) |
31
+ | `config.telemetry?` | [`TelemetryConfig`](./docs/api/appkit/Interface.TelemetryConfig.md) |
30
32
 
31
33
  ## Returns[​](#returns "Direct link to Returns")
32
34
 
33
35
  `Promise`<`PluginMap`<`T`>>
36
+
37
+ A `PluginMap` keyed by plugin name with typed exports
38
+
39
+ ## Examples[​](#examples "Direct link to Examples")
40
+
41
+ ```ts
42
+ import { createApp, server } from "@databricks/appkit";
43
+
44
+ await createApp({
45
+ plugins: [server()],
46
+ });
47
+
48
+ ```
49
+
50
+ ```ts
51
+ import { createApp, server, analytics } from "@databricks/appkit";
52
+
53
+ const appkit = await createApp({
54
+ plugins: [server({ autoStart: false }), analytics({})],
55
+ });
56
+
57
+ appkit.server.extend((app) => {
58
+ app.get("/custom", (_req, res) => res.json({ ok: true }));
59
+ });
60
+ await appkit.server.start();
61
+
62
+ ```
@@ -11,7 +11,7 @@ Create a Lakebase pool with appkit's logger integration. Telemetry automatically
11
11
 
12
12
  | Parameter | Type | Description |
13
13
  | --------- | ------------------------------------------------------------------------------------------ | --------------------------- |
14
- | `config?` | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> | Lakebase pool configuration |
14
+ | `config?` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> | Lakebase pool configuration |
15
15
 
16
16
  ## Returns[​](#returns "Direct link to Returns")
17
17
 
@@ -14,11 +14,11 @@ This generates a time-limited OAuth token (expires after 1 hour) that can be use
14
14
  | Parameter | Type | Description |
15
15
  | ----------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
16
16
  | `workspaceClient` | `WorkspaceClient` | Databricks workspace client for authentication |
17
- | `request` | [`GenerateDatabaseCredentialRequest`](/appkit/docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md) | Request parameters including endpoint path and optional UC claims |
17
+ | `request` | [`GenerateDatabaseCredentialRequest`](./docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md) | Request parameters including endpoint path and optional UC claims |
18
18
 
19
19
  ## Returns[​](#returns "Direct link to Returns")
20
20
 
21
- `Promise`<[`DatabaseCredential`](/appkit/docs/api/appkit/Interface.DatabaseCredential.md)>
21
+ `Promise`<[`DatabaseCredential`](./docs/api/appkit/Interface.DatabaseCredential.md)>
22
22
 
23
23
  Database credentials with OAuth token and expiration time
24
24
 
@@ -26,7 +26,7 @@ Returns connection config with field names compatible with common ORMs:
26
26
 
27
27
  | Parameter | Type | Description |
28
28
  | --------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
29
- | `config?` | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> | Optional configuration (reads from environment if not provided) |
29
+ | `config?` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> | Optional configuration (reads from environment if not provided) |
30
30
 
31
31
  ## Returns[​](#returns "Direct link to Returns")
32
32
 
@@ -20,7 +20,7 @@ Used internally by createLakebasePool().
20
20
 
21
21
  | Parameter | Type | Description |
22
22
  | ------------ | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
23
- | `config?` | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> | Optional configuration (reads from environment if not provided) |
23
+ | `config?` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> | Optional configuration (reads from environment if not provided) |
24
24
  | `telemetry?` | `DriverTelemetry` | Optional pre-initialized telemetry (created internally if not provided) |
25
25
  | `logger?` | `Logger` | Optional logger (silent if not provided) |
26
26
 
@@ -15,7 +15,7 @@ Loads and validates the manifest from a plugin constructor. Normalizes string ty
15
15
 
16
16
  ## Returns[​](#returns "Direct link to Returns")
17
17
 
18
- [`PluginManifest`](/appkit/docs/api/appkit/Interface.PluginManifest.md)
18
+ [`PluginManifest`](./docs/api/appkit/Interface.PluginManifest.md)
19
19
 
20
20
  The validated, normalized plugin manifest
21
21
 
@@ -22,7 +22,7 @@ Returns `undefined` if all attempts fail rather than throwing, so the caller can
22
22
 
23
23
  | Parameter | Type |
24
24
  | --------- | ------------------------------------------------------------------------------------------ |
25
- | `config?` | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> |
25
+ | `config?` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> |
26
26
 
27
27
  ## Returns[​](#returns "Direct link to Returns")
28
28
 
@@ -11,7 +11,7 @@ Get workspace client from config or SDK default auth chain
11
11
 
12
12
  | Parameter | Type |
13
13
  | --------- | ------------------------------------------------------------------------------------------ |
14
- | `config` | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> |
14
+ | `config` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> |
15
15
 
16
16
  ## Returns[​](#returns "Direct link to Returns")
17
17