@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.
- package/CLAUDE.md +155 -147
- package/dist/cli/commands/docs.js +80 -17
- package/dist/cli/commands/docs.js.map +1 -1
- package/dist/react/charts/area/index.d.ts +2 -2
- package/dist/react/charts/bar/index.d.ts +2 -2
- package/dist/react/charts/base.d.ts +2 -2
- package/dist/react/charts/base.d.ts.map +1 -1
- package/dist/react/charts/create-chart.d.ts +2 -2
- package/dist/react/charts/create-chart.d.ts.map +1 -1
- package/dist/react/charts/heatmap/index.d.ts +2 -2
- package/dist/react/charts/line/index.d.ts +2 -2
- package/dist/react/charts/pie/index.d.ts +3 -3
- package/dist/react/charts/radar/index.d.ts +2 -2
- package/dist/react/charts/scatter/index.d.ts +2 -2
- package/dist/react/charts/wrapper.d.ts +2 -2
- package/dist/react/charts/wrapper.d.ts.map +1 -1
- package/dist/react/table/data-table.d.ts +2 -2
- package/dist/react/table/data-table.d.ts.map +1 -1
- package/dist/react/ui/accordion.d.ts +5 -5
- package/dist/react/ui/accordion.d.ts.map +1 -1
- package/dist/react/ui/alert-dialog.d.ts +12 -12
- package/dist/react/ui/alert.d.ts +4 -4
- package/dist/react/ui/alert.d.ts.map +1 -1
- package/dist/react/ui/aspect-ratio.d.ts +2 -2
- package/dist/react/ui/avatar.d.ts +4 -4
- package/dist/react/ui/badge.d.ts +2 -2
- package/dist/react/ui/breadcrumb.d.ts +8 -8
- package/dist/react/ui/button-group.d.ts +4 -4
- package/dist/react/ui/button.d.ts +2 -2
- package/dist/react/ui/calendar.d.ts +3 -3
- package/dist/react/ui/card.d.ts +8 -8
- package/dist/react/ui/carousel.d.ts +6 -6
- package/dist/react/ui/chart.d.ts +19 -19
- package/dist/react/ui/chart.d.ts.map +1 -1
- package/dist/react/ui/checkbox.d.ts +2 -2
- package/dist/react/ui/collapsible.d.ts +4 -4
- package/dist/react/ui/command.d.ts +10 -10
- package/dist/react/ui/context-menu.d.ts +16 -16
- package/dist/react/ui/dialog.d.ts +11 -11
- package/dist/react/ui/drawer.d.ts +11 -11
- package/dist/react/ui/drawer.d.ts.map +1 -1
- package/dist/react/ui/dropdown-menu.d.ts +16 -16
- package/dist/react/ui/empty.d.ts +7 -7
- package/dist/react/ui/field.d.ts +11 -11
- package/dist/react/ui/form.d.ts +9 -9
- package/dist/react/ui/form.d.ts.map +1 -1
- package/dist/react/ui/hover-card.d.ts +4 -4
- package/dist/react/ui/input-group.d.ts +7 -7
- package/dist/react/ui/input-otp.d.ts +5 -5
- package/dist/react/ui/input.d.ts +2 -2
- package/dist/react/ui/item.d.ts +11 -11
- package/dist/react/ui/kbd.d.ts +3 -3
- package/dist/react/ui/label.d.ts +2 -2
- package/dist/react/ui/menubar.d.ts +17 -17
- package/dist/react/ui/navigation-menu.d.ts +9 -9
- package/dist/react/ui/pagination.d.ts +8 -8
- package/dist/react/ui/popover.d.ts +5 -5
- package/dist/react/ui/progress.d.ts +2 -2
- package/dist/react/ui/radio-group.d.ts +3 -3
- package/dist/react/ui/resizable.d.ts +4 -4
- package/dist/react/ui/scroll-area.d.ts +3 -3
- package/dist/react/ui/select.d.ts +11 -11
- package/dist/react/ui/separator.d.ts +2 -2
- package/dist/react/ui/sheet.d.ts +9 -9
- package/dist/react/ui/sidebar.d.ts +41 -24
- package/dist/react/ui/sidebar.d.ts.map +1 -1
- package/dist/react/ui/sidebar.js.map +1 -1
- package/dist/react/ui/skeleton.d.ts +2 -2
- package/dist/react/ui/slider.d.ts +2 -2
- package/dist/react/ui/sonner.d.ts +2 -2
- package/dist/react/ui/spinner.d.ts +2 -2
- package/dist/react/ui/switch.d.ts +2 -2
- package/dist/react/ui/table.d.ts +9 -9
- package/dist/react/ui/tabs.d.ts +5 -5
- package/dist/react/ui/textarea.d.ts +2 -2
- package/dist/react/ui/toggle-group.d.ts +3 -3
- package/dist/react/ui/toggle.d.ts +2 -2
- package/dist/react/ui/tooltip.d.ts +5 -5
- package/dist/react/ui/tooltip.d.ts.map +1 -1
- package/docs/{docs/api → api}/appkit/Class.AppKitError.md +8 -8
- package/docs/{docs/api → api}/appkit/Class.AuthenticationError.md +9 -9
- package/docs/{docs/api → api}/appkit/Class.ConfigurationError.md +9 -9
- package/docs/{docs/api → api}/appkit/Class.ConnectionError.md +9 -9
- package/docs/{docs/api → api}/appkit/Class.ExecutionError.md +9 -9
- package/docs/{docs/api → api}/appkit/Class.InitializationError.md +9 -9
- package/docs/{docs/api → api}/appkit/Class.Plugin.md +22 -2
- package/docs/{docs/api → api}/appkit/Class.ResourceRegistry.md +11 -11
- package/docs/{docs/api → api}/appkit/Class.ServerError.md +9 -9
- package/docs/{docs/api → api}/appkit/Class.TunnelError.md +9 -9
- package/docs/{docs/api → api}/appkit/Class.ValidationError.md +9 -9
- package/docs/{docs/api → api}/appkit/Function.createApp.md +32 -3
- package/docs/{docs/api → api}/appkit/Function.createLakebasePool.md +1 -1
- package/docs/{docs/api → api}/appkit/Function.generateDatabaseCredential.md +2 -2
- package/docs/{docs/api → api}/appkit/Function.getLakebaseOrmConfig.md +1 -1
- package/docs/{docs/api → api}/appkit/Function.getLakebasePgConfig.md +1 -1
- package/docs/{docs/api → api}/appkit/Function.getPluginManifest.md +1 -1
- package/docs/{docs/api → api}/appkit/Function.getUsernameWithApiLookup.md +1 -1
- package/docs/{docs/api → api}/appkit/Function.getWorkspaceClient.md +1 -1
- package/docs/{docs/api → api}/appkit/Interface.ResourceEntry.md +8 -8
- package/docs/{docs/api → api}/appkit/Interface.ResourceRequirement.md +1 -1
- package/docs/{docs/api → api}/appkit-ui/styling.md +1 -1
- package/docs/{docs/api → api}/appkit-ui/ui/Sidebar.md +304 -37
- package/docs/api/appkit.md +78 -0
- package/docs/{docs/api.md → api.md} +4 -4
- package/docs/{docs/app-management.md → app-management.md} +2 -2
- package/docs/{docs/architecture.md → architecture.md} +6 -6
- package/docs/{docs/configuration.md → configuration.md} +2 -2
- package/docs/development/ai-assisted-development.md +88 -0
- package/docs/{docs/development → development}/llm-guide.md +8 -7
- package/docs/{docs/development → development}/local-development.md +2 -2
- package/docs/{docs/development → development}/project-setup.md +11 -11
- package/docs/{docs/development → development}/remote-bridge.md +1 -1
- package/docs/{docs/development → development}/type-generation.md +2 -2
- package/docs/development.md +22 -0
- package/docs/plugins/analytics.md +169 -0
- package/docs/{docs/plugins → plugins}/custom-plugins.md +6 -6
- package/docs/{docs/plugins → plugins}/server.md +1 -1
- package/docs/{docs/plugins.md → plugins.md} +2 -2
- package/{docs/docs.md → docs.md} +36 -5
- package/llms.txt +155 -147
- package/package.json +2 -1
- package/docs/docs/api/appkit/Class.AppKitError/index.html +0 -79
- package/docs/docs/api/appkit/Class.AuthenticationError/index.html +0 -110
- package/docs/docs/api/appkit/Class.ConfigurationError/index.html +0 -112
- package/docs/docs/api/appkit/Class.ConnectionError/index.html +0 -120
- package/docs/docs/api/appkit/Class.ExecutionError/index.html +0 -116
- package/docs/docs/api/appkit/Class.InitializationError/index.html +0 -104
- package/docs/docs/api/appkit/Class.Plugin/index.html +0 -168
- package/docs/docs/api/appkit/Class.ResourceRegistry/index.html +0 -150
- package/docs/docs/api/appkit/Class.ServerError/index.html +0 -108
- package/docs/docs/api/appkit/Class.TunnelError/index.html +0 -108
- package/docs/docs/api/appkit/Class.ValidationError/index.html +0 -106
- package/docs/docs/api/appkit/Enumeration.RequestedClaimsPermissionSet/index.html +0 -21
- package/docs/docs/api/appkit/Enumeration.ResourceType/index.html +0 -53
- package/docs/docs/api/appkit/Function.appKitTypesPlugin/index.html +0 -24
- package/docs/docs/api/appkit/Function.createApp/index.html +0 -24
- package/docs/docs/api/appkit/Function.createLakebasePool/index.html +0 -24
- package/docs/docs/api/appkit/Function.generateDatabaseCredential/index.html +0 -30
- package/docs/docs/api/appkit/Function.getExecutionContext/index.html +0 -26
- package/docs/docs/api/appkit/Function.getLakebaseOrmConfig/index.html +0 -39
- package/docs/docs/api/appkit/Function.getLakebasePgConfig/index.html +0 -27
- package/docs/docs/api/appkit/Function.getPluginManifest/index.html +0 -26
- package/docs/docs/api/appkit/Function.getResourceRequirements/index.html +0 -28
- package/docs/docs/api/appkit/Function.getUsernameWithApiLookup/index.html +0 -35
- package/docs/docs/api/appkit/Function.getWorkspaceClient/index.html +0 -22
- package/docs/docs/api/appkit/Function.isSQLTypeMarker/index.html +0 -25
- package/docs/docs/api/appkit/Interface.BasePluginConfig/index.html +0 -28
- package/docs/docs/api/appkit/Interface.CacheConfig/index.html +0 -63
- package/docs/docs/api/appkit/Interface.DatabaseCredential/index.html +0 -28
- package/docs/docs/api/appkit/Interface.GenerateDatabaseCredentialRequest/index.html +0 -32
- package/docs/docs/api/appkit/Interface.ITelemetry/index.html +0 -73
- package/docs/docs/api/appkit/Interface.LakebasePoolConfig/index.html +0 -75
- package/docs/docs/api/appkit/Interface.PluginManifest/index.html +0 -67
- package/docs/docs/api/appkit/Interface.RequestedClaims/index.html +0 -26
- package/docs/docs/api/appkit/Interface.RequestedResource/index.html +0 -27
- package/docs/docs/api/appkit/Interface.ResourceEntry/index.html +0 -83
- package/docs/docs/api/appkit/Interface.ResourceFieldEntry/index.html +0 -26
- package/docs/docs/api/appkit/Interface.ResourceRequirement/index.html +0 -51
- package/docs/docs/api/appkit/Interface.StreamExecutionSettings/index.html +0 -26
- package/docs/docs/api/appkit/Interface.TelemetryConfig/index.html +0 -32
- package/docs/docs/api/appkit/Interface.ValidationResult/index.html +0 -29
- package/docs/docs/api/appkit/TypeAlias.ConfigSchema/index.html +0 -21
- package/docs/docs/api/appkit/TypeAlias.IAppRouter/index.html +0 -18
- package/docs/docs/api/appkit/TypeAlias.ResourcePermission/index.html +0 -18
- package/docs/docs/api/appkit/TypeAlias.ToPlugin/index.html +0 -23
- package/docs/docs/api/appkit/Variable.sql/index.html +0 -98
- package/docs/docs/api/appkit/index.html +0 -30
- package/docs/docs/api/appkit-ui/data/AreaChart/index.html +0 -29
- package/docs/docs/api/appkit-ui/data/BarChart/index.html +0 -29
- package/docs/docs/api/appkit-ui/data/DataTable/index.html +0 -36
- package/docs/docs/api/appkit-ui/data/DonutChart/index.html +0 -29
- package/docs/docs/api/appkit-ui/data/HeatmapChart/index.html +0 -35
- package/docs/docs/api/appkit-ui/data/LineChart/index.html +0 -29
- package/docs/docs/api/appkit-ui/data/PieChart/index.html +0 -29
- package/docs/docs/api/appkit-ui/data/RadarChart/index.html +0 -29
- package/docs/docs/api/appkit-ui/data/ScatterChart/index.html +0 -29
- package/docs/docs/api/appkit-ui/genie/GenieChat/index.html +0 -26
- package/docs/docs/api/appkit-ui/genie/GenieChatInput/index.html +0 -24
- package/docs/docs/api/appkit-ui/genie/GenieChatMessage/index.html +0 -24
- package/docs/docs/api/appkit-ui/genie/GenieChatMessageList/index.html +0 -24
- package/docs/docs/api/appkit-ui/index.html +0 -23
- package/docs/docs/api/appkit-ui/styling/index.html +0 -74
- package/docs/docs/api/appkit-ui/ui/Accordion/index.html +0 -48
- package/docs/docs/api/appkit-ui/ui/Alert/index.html +0 -41
- package/docs/docs/api/appkit-ui/ui/AlertDialog/index.html +0 -97
- package/docs/docs/api/appkit-ui/ui/AspectRatio/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Avatar/index.html +0 -41
- package/docs/docs/api/appkit-ui/ui/Badge/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Breadcrumb/index.html +0 -69
- package/docs/docs/api/appkit-ui/ui/Button/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/ButtonGroup/index.html +0 -38
- package/docs/docs/api/appkit-ui/ui/Calendar/index.html +0 -34
- package/docs/docs/api/appkit-ui/ui/Card/index.html +0 -69
- package/docs/docs/api/appkit-ui/ui/Carousel/index.html +0 -55
- package/docs/docs/api/appkit-ui/ui/ChartContainer/index.html +0 -58
- package/docs/docs/api/appkit-ui/ui/Checkbox/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Collapsible/index.html +0 -41
- package/docs/docs/api/appkit-ui/ui/Command/index.html +0 -83
- package/docs/docs/api/appkit-ui/ui/ContextMenu/index.html +0 -111
- package/docs/docs/api/appkit-ui/ui/Dialog/index.html +0 -90
- package/docs/docs/api/appkit-ui/ui/Drawer/index.html +0 -90
- package/docs/docs/api/appkit-ui/ui/DropdownMenu/index.html +0 -111
- package/docs/docs/api/appkit-ui/ui/Empty/index.html +0 -54
- package/docs/docs/api/appkit-ui/ui/Field/index.html +0 -87
- package/docs/docs/api/appkit-ui/ui/FormControl/index.html +0 -59
- package/docs/docs/api/appkit-ui/ui/HoverCard/index.html +0 -39
- package/docs/docs/api/appkit-ui/ui/Input/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/InputGroup/index.html +0 -59
- package/docs/docs/api/appkit-ui/ui/InputOTP/index.html +0 -48
- package/docs/docs/api/appkit-ui/ui/Item/index.html +0 -78
- package/docs/docs/api/appkit-ui/ui/Kbd/index.html +0 -30
- package/docs/docs/api/appkit-ui/ui/Label/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Menubar/index.html +0 -117
- package/docs/docs/api/appkit-ui/ui/NavigationMenu/index.html +0 -76
- package/docs/docs/api/appkit-ui/ui/Pagination/index.html +0 -69
- package/docs/docs/api/appkit-ui/ui/Popover/index.html +0 -45
- package/docs/docs/api/appkit-ui/ui/Progress/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/RadioGroup/index.html +0 -33
- package/docs/docs/api/appkit-ui/ui/ResizableHandle/index.html +0 -41
- package/docs/docs/api/appkit-ui/ui/ScrollArea/index.html +0 -34
- package/docs/docs/api/appkit-ui/ui/Select/index.html +0 -82
- package/docs/docs/api/appkit-ui/ui/Separator/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Sheet/index.html +0 -76
- package/docs/docs/api/appkit-ui/ui/Sidebar/index.html +0 -183
- package/docs/docs/api/appkit-ui/ui/Skeleton/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Slider/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Spinner/index.html +0 -24
- package/docs/docs/api/appkit-ui/ui/Switch/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Table/index.html +0 -69
- package/docs/docs/api/appkit-ui/ui/Tabs/index.html +0 -48
- package/docs/docs/api/appkit-ui/ui/Textarea/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Toaster/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/Toggle/index.html +0 -27
- package/docs/docs/api/appkit-ui/ui/ToggleGroup/index.html +0 -33
- package/docs/docs/api/appkit-ui/ui/Tooltip/index.html +0 -46
- package/docs/docs/api/appkit.md +0 -78
- package/docs/docs/api/index.html +0 -28
- package/docs/docs/app-management/index.html +0 -106
- package/docs/docs/architecture/index.html +0 -71
- package/docs/docs/category/development/index.html +0 -16
- package/docs/docs/category/development.md +0 -3
- package/docs/docs/configuration/index.html +0 -66
- package/docs/docs/core-principles/index.html +0 -38
- package/docs/docs/development/ai-assisted-development/index.html +0 -33
- package/docs/docs/development/ai-assisted-development.md +0 -26
- package/docs/docs/development/index.html +0 -35
- package/docs/docs/development/llm-guide/index.html +0 -84
- package/docs/docs/development/local-development/index.html +0 -27
- package/docs/docs/development/project-setup/index.html +0 -69
- package/docs/docs/development/remote-bridge/index.html +0 -76
- package/docs/docs/development/type-generation/index.html +0 -65
- package/docs/docs/development.md +0 -22
- package/docs/docs/index.html +0 -58
- package/docs/docs/plugins/analytics/index.html +0 -53
- package/docs/docs/plugins/analytics.md +0 -66
- package/docs/docs/plugins/caching/index.html +0 -23
- package/docs/docs/plugins/custom-plugins/index.html +0 -49
- package/docs/docs/plugins/execution-context/index.html +0 -40
- package/docs/docs/plugins/index.html +0 -29
- package/docs/docs/plugins/lakebase/index.html +0 -62
- package/docs/docs/plugins/plugin-management/index.html +0 -44
- package/docs/docs/plugins/server/index.html +0 -45
- /package/docs/{docs/api → api}/appkit/Enumeration.RequestedClaimsPermissionSet.md +0 -0
- /package/docs/{docs/api → api}/appkit/Enumeration.ResourceType.md +0 -0
- /package/docs/{docs/api → api}/appkit/Function.appKitTypesPlugin.md +0 -0
- /package/docs/{docs/api → api}/appkit/Function.getExecutionContext.md +0 -0
- /package/docs/{docs/api → api}/appkit/Function.getResourceRequirements.md +0 -0
- /package/docs/{docs/api → api}/appkit/Function.isSQLTypeMarker.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.BasePluginConfig.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.CacheConfig.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.DatabaseCredential.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.GenerateDatabaseCredentialRequest.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.ITelemetry.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.LakebasePoolConfig.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.PluginManifest.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.RequestedClaims.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.RequestedResource.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.ResourceFieldEntry.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.StreamExecutionSettings.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.TelemetryConfig.md +0 -0
- /package/docs/{docs/api → api}/appkit/Interface.ValidationResult.md +0 -0
- /package/docs/{docs/api → api}/appkit/TypeAlias.ConfigSchema.md +0 -0
- /package/docs/{docs/api → api}/appkit/TypeAlias.IAppRouter.md +0 -0
- /package/docs/{docs/api → api}/appkit/TypeAlias.ResourcePermission.md +0 -0
- /package/docs/{docs/api → api}/appkit/TypeAlias.ToPlugin.md +0 -0
- /package/docs/{docs/api → api}/appkit/Variable.sql.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/AreaChart.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/BarChart.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/DataTable.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/DonutChart.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/HeatmapChart.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/LineChart.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/PieChart.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/RadarChart.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/data/ScatterChart.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/genie/GenieChat.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/genie/GenieChatInput.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/genie/GenieChatMessage.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/genie/GenieChatMessageList.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Accordion.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Alert.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/AlertDialog.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/AspectRatio.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Avatar.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Badge.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Breadcrumb.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Button.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/ButtonGroup.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Calendar.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Card.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Carousel.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/ChartContainer.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Checkbox.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Collapsible.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Command.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/ContextMenu.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Dialog.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Drawer.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/DropdownMenu.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Empty.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Field.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/FormControl.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/HoverCard.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Input.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/InputGroup.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/InputOTP.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Item.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Kbd.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Label.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Menubar.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/NavigationMenu.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Pagination.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Popover.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Progress.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/RadioGroup.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/ResizableHandle.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/ScrollArea.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Select.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Separator.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Sheet.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Skeleton.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Slider.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Spinner.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Switch.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Table.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Tabs.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Textarea.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Toaster.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Toggle.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/ToggleGroup.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui/ui/Tooltip.md +0 -0
- /package/docs/{docs/api → api}/appkit-ui.md +0 -0
- /package/docs/{docs/core-principles.md → core-principles.md} +0 -0
- /package/docs/{docs/plugins → plugins}/caching.md +0 -0
- /package/docs/{docs/plugins → plugins}/execution-context.md +0 -0
- /package/docs/{docs/plugins → plugins}/lakebase.md +0 -0
- /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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
26
|
-
| `config.cache?` | [`CacheConfig`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
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`](
|
|
14
|
+
| `config` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> |
|
|
15
15
|
|
|
16
16
|
## Returns[](#returns "Direct link to Returns")
|
|
17
17
|
|