@databricks/appkit 0.11.2 → 0.12.1
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 -143
- package/NOTICE.md +1 -0
- package/dist/_virtual/_rolldown/runtime.js +0 -2
- package/dist/appkit/package.js +1 -1
- package/dist/cli/commands/docs.js +80 -17
- package/dist/cli/commands/docs.js.map +1 -1
- package/dist/connectors/genie/client.js +208 -0
- package/dist/connectors/genie/client.js.map +1 -0
- package/dist/connectors/genie/defaults.js +10 -0
- package/dist/connectors/genie/defaults.js.map +1 -0
- package/dist/connectors/genie/index.js +5 -0
- package/dist/connectors/genie/poll-waiter.js +54 -0
- package/dist/connectors/genie/poll-waiter.js.map +1 -0
- package/dist/connectors/genie/types.d.ts +11 -0
- package/dist/connectors/genie/types.d.ts.map +1 -0
- package/dist/connectors/index.js +4 -0
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/logging/index.js +16 -0
- package/dist/plugins/genie/defaults.js +13 -0
- package/dist/plugins/genie/defaults.js.map +1 -0
- package/dist/plugins/genie/genie.d.ts +44 -0
- package/dist/plugins/genie/genie.d.ts.map +1 -0
- package/dist/plugins/genie/genie.js +141 -0
- package/dist/plugins/genie/genie.js.map +1 -0
- package/dist/plugins/genie/index.js +4 -0
- package/dist/plugins/genie/manifest.js +11 -0
- package/dist/plugins/genie/manifest.js.map +1 -0
- package/dist/plugins/genie/manifest.json +43 -0
- package/dist/plugins/genie/types.d.ts +14 -0
- package/dist/plugins/genie/types.d.ts.map +1 -0
- package/dist/plugins/index.js +3 -0
- package/dist/plugins/lakebase/manifest.json +1 -1
- package/dist/registry/types.generated.js.map +1 -1
- package/dist/shared/src/genie.d.ts +48 -0
- package/dist/shared/src/genie.d.ts.map +1 -0
- 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 +2 -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 +3 -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/api/appkit-ui/genie/GenieChat.md +43 -0
- package/docs/api/appkit-ui/genie/GenieChatInput.md +27 -0
- package/docs/api/appkit-ui/genie/GenieChatMessage.md +25 -0
- package/docs/api/appkit-ui/genie/GenieChatMessageList.md +26 -0
- package/docs/{docs/api → api}/appkit-ui/styling.md +1 -1
- 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/{docs/development → development}/ai-assisted-development.md +5 -3
- package/docs/{docs/development → development}/llm-guide.md +7 -6
- package/docs/{docs/development → development}/local-development.md +2 -2
- package/docs/{docs/development → development}/project-setup.md +3 -3
- 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/{docs/plugins → plugins}/analytics.md +1 -1
- package/docs/{docs/plugins → plugins}/custom-plugins.md +6 -6
- package/docs/{docs/plugins → plugins}/lakebase.md +25 -24
- package/docs/{docs/plugins.md → plugins.md} +2 -2
- package/{docs/docs.md → docs.md} +4 -4
- package/llms.txt +155 -143
- 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/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/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/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/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/Sidebar.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}/plugin-management.md +0 -0
- /package/docs/{docs/plugins → plugins}/server.md +0 -0
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { dirname, join } from "node:path";
|
|
2
|
+
import { readFileSync } from "node:fs";
|
|
3
|
+
import { fileURLToPath } from "node:url";
|
|
4
|
+
|
|
5
|
+
//#region src/plugins/genie/manifest.ts
|
|
6
|
+
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
7
|
+
const genieManifest = JSON.parse(readFileSync(join(__dirname, "manifest.json"), "utf-8"));
|
|
8
|
+
|
|
9
|
+
//#endregion
|
|
10
|
+
export { genieManifest };
|
|
11
|
+
//# sourceMappingURL=manifest.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"manifest.js","names":[],"sources":["../../../src/plugins/genie/manifest.ts"],"sourcesContent":["import { readFileSync } from \"node:fs\";\nimport { dirname, join } from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport type { PluginManifest } from \"../../registry\";\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport const genieManifest: PluginManifest = JSON.parse(\n readFileSync(join(__dirname, \"manifest.json\"), \"utf-8\"),\n) as PluginManifest;\n"],"mappings":";;;;;AAKA,MAAM,YAAY,QAAQ,cAAc,OAAO,KAAK,IAAI,CAAC;AAEzD,MAAa,gBAAgC,KAAK,MAChD,aAAa,KAAK,WAAW,gBAAgB,EAAE,QAAQ,CACxD"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "genie",
|
|
3
|
+
"displayName": "Genie Plugin",
|
|
4
|
+
"description": "AI/BI Genie space integration for natural language data queries",
|
|
5
|
+
"resources": {
|
|
6
|
+
"required": [
|
|
7
|
+
{
|
|
8
|
+
"type": "genie_space",
|
|
9
|
+
"alias": "Genie Space",
|
|
10
|
+
"resourceKey": "genie-space",
|
|
11
|
+
"description": "Genie Space for AI-powered data queries. Space IDs configured via plugin config.",
|
|
12
|
+
"permission": "CAN_RUN",
|
|
13
|
+
"fields": {
|
|
14
|
+
"id": {
|
|
15
|
+
"env": "DATABRICKS_GENIE_SPACE_ID",
|
|
16
|
+
"description": "Default Genie Space ID"
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"optional": []
|
|
22
|
+
},
|
|
23
|
+
"config": {
|
|
24
|
+
"schema": {
|
|
25
|
+
"type": "object",
|
|
26
|
+
"properties": {
|
|
27
|
+
"spaces": {
|
|
28
|
+
"type": "object",
|
|
29
|
+
"description": "Map of alias names to Genie Space IDs",
|
|
30
|
+
"additionalProperties": {
|
|
31
|
+
"type": "string"
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
"timeout": {
|
|
35
|
+
"type": "number",
|
|
36
|
+
"default": 120000,
|
|
37
|
+
"description": "Genie polling timeout in ms. Set to 0 for indefinite."
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"required": ["spaces"]
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { BasePluginConfig } from "../../shared/src/plugin.js";
|
|
2
|
+
import { GenieAttachmentResponse, GenieMessageResponse, GenieStreamEvent } from "../../shared/src/genie.js";
|
|
3
|
+
import { GenieConversationHistoryResponse } from "../../connectors/genie/types.js";
|
|
4
|
+
|
|
5
|
+
//#region src/plugins/genie/types.d.ts
|
|
6
|
+
interface IGenieConfig extends BasePluginConfig {
|
|
7
|
+
/** Map of alias → Genie Space ID. Defaults to { default: DATABRICKS_GENIE_SPACE_ID } if omitted. */
|
|
8
|
+
spaces?: Record<string, string>;
|
|
9
|
+
/** Genie polling timeout in ms. Set to 0 for indefinite. Default: 120000 (2 min) */
|
|
10
|
+
timeout?: number;
|
|
11
|
+
}
|
|
12
|
+
//#endregion
|
|
13
|
+
export { IGenieConfig };
|
|
14
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","names":[],"sources":["../../../src/plugins/genie/types.ts"],"sourcesContent":[],"mappings":";;;;;UAUiB,YAAA,SAAqB;;EAArB,MAAA,CAAA,EAEN,MAFmB,CAAA,MAAA,EAAA,MAAA,CAAA;EAAA;SAEnB,CAAA,EAAA,MAAA"}
|
package/dist/plugins/index.js
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import { analyticsManifest } from "./analytics/manifest.js";
|
|
2
2
|
import { AnalyticsPlugin, analytics } from "./analytics/analytics.js";
|
|
3
3
|
import "./analytics/index.js";
|
|
4
|
+
import { genieManifest } from "./genie/manifest.js";
|
|
5
|
+
import { GeniePlugin, genie } from "./genie/genie.js";
|
|
6
|
+
import "./genie/index.js";
|
|
4
7
|
import { lakebaseManifest } from "./lakebase/manifest.js";
|
|
5
8
|
import { LakebasePlugin, lakebase } from "./lakebase/lakebase.js";
|
|
6
9
|
import "./lakebase/index.js";
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"displayName": "Lakebase",
|
|
5
5
|
"description": "SQL query execution against Databricks Lakebase Autoscaling",
|
|
6
6
|
"onSetupMessage": "Configure environment variables before running or deploying the app.\nSee: https://databricks.github.io/appkit/docs/plugins/lakebase",
|
|
7
|
-
"hidden":
|
|
7
|
+
"hidden": false,
|
|
8
8
|
"resources": {
|
|
9
9
|
"required": [],
|
|
10
10
|
"optional": []
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.generated.js","names":[],"sources":["../../src/registry/types.generated.ts"],"sourcesContent":["// AUTO-GENERATED from packages/shared/src/schemas/plugin-manifest.schema.json\n// Do not edit. Run: pnpm exec tsx tools/generate-registry-types.ts\n\n/** Resource types from schema $defs.resourceType.enum */\nexport enum ResourceType {\n SECRET = \"secret\",\n JOB = \"job\",\n SQL_WAREHOUSE = \"sql_warehouse\",\n SERVING_ENDPOINT = \"serving_endpoint\",\n VOLUME = \"volume\",\n VECTOR_SEARCH_INDEX = \"vector_search_index\",\n UC_FUNCTION = \"uc_function\",\n UC_CONNECTION = \"uc_connection\",\n DATABASE = \"database\",\n GENIE_SPACE = \"genie_space\",\n EXPERIMENT = \"experiment\",\n APP = \"app\",\n}\n\n// ============================================================================\n// Permissions per resource type (from schema permission $defs)\n// ============================================================================\n/** Permissions for SECRET resources */\nexport type SecretPermission = \"READ\" | \"WRITE\" | \"MANAGE\";\n\n/** Permissions for JOB resources */\nexport type JobPermission = \"CAN_VIEW\" | \"CAN_MANAGE_RUN\" | \"CAN_MANAGE\";\n\n/** Permissions for SQL_WAREHOUSE resources */\nexport type SqlWarehousePermission = \"CAN_USE\" | \"CAN_MANAGE\";\n\n/** Permissions for SERVING_ENDPOINT resources */\nexport type ServingEndpointPermission = \"CAN_VIEW\" | \"CAN_QUERY\" | \"CAN_MANAGE\";\n\n/** Permissions for VOLUME resources */\nexport type VolumePermission = \"READ_VOLUME\" | \"WRITE_VOLUME\";\n\n/** Permissions for VECTOR_SEARCH_INDEX resources */\nexport type VectorSearchIndexPermission = \"SELECT\";\n\n/** Permissions for UC_FUNCTION resources */\nexport type UcFunctionPermission = \"EXECUTE\";\n\n/** Permissions for UC_CONNECTION resources */\nexport type UcConnectionPermission = \"USE_CONNECTION\";\n\n/** Permissions for DATABASE resources */\nexport type DatabasePermission = \"CAN_CONNECT_AND_CREATE\";\n\n/** Permissions for GENIE_SPACE resources */\nexport type GenieSpacePermission = \"CAN_VIEW\" | \"CAN_RUN\" | \"CAN_EDIT\" | \"CAN_MANAGE\";\n\n/** Permissions for EXPERIMENT resources */\nexport type ExperimentPermission = \"CAN_READ\" | \"CAN_EDIT\" | \"CAN_MANAGE\";\n\n/** Permissions for APP resources */\nexport type AppPermission = \"CAN_USE\";\n\n/** Union of all possible permission levels across all resource types. */\nexport type ResourcePermission =\n | SecretPermission\n | JobPermission\n | SqlWarehousePermission\n | ServingEndpointPermission\n | VolumePermission\n | VectorSearchIndexPermission\n | UcFunctionPermission\n | UcConnectionPermission\n | DatabasePermission\n | GenieSpacePermission\n | ExperimentPermission\n | AppPermission;\n\n/** Permission hierarchy per resource type (weakest to strongest). Schema enum order. */\nexport const PERMISSION_HIERARCHY_BY_TYPE: Record<ResourceType, readonly ResourcePermission[]> = {\n [ResourceType.SECRET]: [\"READ\", \"WRITE\", \"MANAGE\"],\n [ResourceType.JOB]: [\"CAN_VIEW\", \"CAN_MANAGE_RUN\", \"CAN_MANAGE\"],\n [ResourceType.SQL_WAREHOUSE]: [\"CAN_USE\", \"CAN_MANAGE\"],\n [ResourceType.SERVING_ENDPOINT]: [\"CAN_VIEW\", \"CAN_QUERY\", \"CAN_MANAGE\"],\n [ResourceType.VOLUME]: [\"READ_VOLUME\", \"WRITE_VOLUME\"],\n [ResourceType.VECTOR_SEARCH_INDEX]: [\"SELECT\"],\n [ResourceType.UC_FUNCTION]: [\"EXECUTE\"],\n [ResourceType.UC_CONNECTION]: [\"USE_CONNECTION\"],\n [ResourceType.DATABASE]: [\"CAN_CONNECT_AND_CREATE\"],\n [ResourceType.GENIE_SPACE]: [\"CAN_VIEW\", \"CAN_RUN\", \"CAN_EDIT\", \"CAN_MANAGE\"],\n [ResourceType.EXPERIMENT]: [\"CAN_READ\", \"CAN_EDIT\", \"CAN_MANAGE\"],\n [ResourceType.APP]: [\"CAN_USE\"],\n} as const;\n\n/** Set of valid permissions per type (for validation). */\nexport const PERMISSIONS_BY_TYPE: Record<ResourceType, readonly ResourcePermission[]> = PERMISSION_HIERARCHY_BY_TYPE;\n"],"mappings":";;AAIA,IAAY,
|
|
1
|
+
{"version":3,"file":"types.generated.js","names":[],"sources":["../../src/registry/types.generated.ts"],"sourcesContent":["// AUTO-GENERATED from packages/shared/src/schemas/plugin-manifest.schema.json\n// Do not edit. Run: pnpm exec tsx tools/generate-registry-types.ts\n\n/** Resource types from schema $defs.resourceType.enum */\nexport enum ResourceType {\n SECRET = \"secret\",\n JOB = \"job\",\n SQL_WAREHOUSE = \"sql_warehouse\",\n SERVING_ENDPOINT = \"serving_endpoint\",\n VOLUME = \"volume\",\n VECTOR_SEARCH_INDEX = \"vector_search_index\",\n UC_FUNCTION = \"uc_function\",\n UC_CONNECTION = \"uc_connection\",\n DATABASE = \"database\",\n GENIE_SPACE = \"genie_space\",\n EXPERIMENT = \"experiment\",\n APP = \"app\",\n}\n\n// ============================================================================\n// Permissions per resource type (from schema permission $defs)\n// ============================================================================\n/** Permissions for SECRET resources */\nexport type SecretPermission = \"READ\" | \"WRITE\" | \"MANAGE\";\n\n/** Permissions for JOB resources */\nexport type JobPermission = \"CAN_VIEW\" | \"CAN_MANAGE_RUN\" | \"CAN_MANAGE\";\n\n/** Permissions for SQL_WAREHOUSE resources */\nexport type SqlWarehousePermission = \"CAN_USE\" | \"CAN_MANAGE\";\n\n/** Permissions for SERVING_ENDPOINT resources */\nexport type ServingEndpointPermission = \"CAN_VIEW\" | \"CAN_QUERY\" | \"CAN_MANAGE\";\n\n/** Permissions for VOLUME resources */\nexport type VolumePermission = \"READ_VOLUME\" | \"WRITE_VOLUME\";\n\n/** Permissions for VECTOR_SEARCH_INDEX resources */\nexport type VectorSearchIndexPermission = \"SELECT\";\n\n/** Permissions for UC_FUNCTION resources */\nexport type UcFunctionPermission = \"EXECUTE\";\n\n/** Permissions for UC_CONNECTION resources */\nexport type UcConnectionPermission = \"USE_CONNECTION\";\n\n/** Permissions for DATABASE resources */\nexport type DatabasePermission = \"CAN_CONNECT_AND_CREATE\";\n\n/** Permissions for GENIE_SPACE resources */\nexport type GenieSpacePermission = \"CAN_VIEW\" | \"CAN_RUN\" | \"CAN_EDIT\" | \"CAN_MANAGE\";\n\n/** Permissions for EXPERIMENT resources */\nexport type ExperimentPermission = \"CAN_READ\" | \"CAN_EDIT\" | \"CAN_MANAGE\";\n\n/** Permissions for APP resources */\nexport type AppPermission = \"CAN_USE\";\n\n/** Union of all possible permission levels across all resource types. */\nexport type ResourcePermission =\n | SecretPermission\n | JobPermission\n | SqlWarehousePermission\n | ServingEndpointPermission\n | VolumePermission\n | VectorSearchIndexPermission\n | UcFunctionPermission\n | UcConnectionPermission\n | DatabasePermission\n | GenieSpacePermission\n | ExperimentPermission\n | AppPermission;\n\n/** Permission hierarchy per resource type (weakest to strongest). Schema enum order. */\nexport const PERMISSION_HIERARCHY_BY_TYPE: Record<ResourceType, readonly ResourcePermission[]> = {\n [ResourceType.SECRET]: [\"READ\", \"WRITE\", \"MANAGE\"],\n [ResourceType.JOB]: [\"CAN_VIEW\", \"CAN_MANAGE_RUN\", \"CAN_MANAGE\"],\n [ResourceType.SQL_WAREHOUSE]: [\"CAN_USE\", \"CAN_MANAGE\"],\n [ResourceType.SERVING_ENDPOINT]: [\"CAN_VIEW\", \"CAN_QUERY\", \"CAN_MANAGE\"],\n [ResourceType.VOLUME]: [\"READ_VOLUME\", \"WRITE_VOLUME\"],\n [ResourceType.VECTOR_SEARCH_INDEX]: [\"SELECT\"],\n [ResourceType.UC_FUNCTION]: [\"EXECUTE\"],\n [ResourceType.UC_CONNECTION]: [\"USE_CONNECTION\"],\n [ResourceType.DATABASE]: [\"CAN_CONNECT_AND_CREATE\"],\n [ResourceType.GENIE_SPACE]: [\"CAN_VIEW\", \"CAN_RUN\", \"CAN_EDIT\", \"CAN_MANAGE\"],\n [ResourceType.EXPERIMENT]: [\"CAN_READ\", \"CAN_EDIT\", \"CAN_MANAGE\"],\n [ResourceType.APP]: [\"CAN_USE\"],\n} as const;\n\n/** Set of valid permissions per type (for validation). */\nexport const PERMISSIONS_BY_TYPE: Record<ResourceType, readonly ResourcePermission[]> = PERMISSION_HIERARCHY_BY_TYPE;\n"],"mappings":";;AAIA,IAAY,eAAL;AACL;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;KACD;;AAyDD,MAAa,+BAAoF;EAC9F,aAAa,SAAS;EAAC;EAAQ;EAAS;EAAS;EACjD,aAAa,MAAM;EAAC;EAAY;EAAkB;EAAa;EAC/D,aAAa,gBAAgB,CAAC,WAAW,aAAa;EACtD,aAAa,mBAAmB;EAAC;EAAY;EAAa;EAAa;EACvE,aAAa,SAAS,CAAC,eAAe,eAAe;EACrD,aAAa,sBAAsB,CAAC,SAAS;EAC7C,aAAa,cAAc,CAAC,UAAU;EACtC,aAAa,gBAAgB,CAAC,iBAAiB;EAC/C,aAAa,WAAW,CAAC,yBAAyB;EAClD,aAAa,cAAc;EAAC;EAAY;EAAW;EAAY;EAAa;EAC5E,aAAa,aAAa;EAAC;EAAY;EAAY;EAAa;EAChE,aAAa,MAAM,CAAC,UAAU;CAChC;;AAGD,MAAa,sBAA2E"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
//#region ../shared/src/genie.d.ts
|
|
2
|
+
/** SSE event discriminated union produced by streamSendMessage and streamConversation */
|
|
3
|
+
type GenieStreamEvent = {
|
|
4
|
+
type: "message_start";
|
|
5
|
+
conversationId: string;
|
|
6
|
+
messageId: string;
|
|
7
|
+
spaceId: string;
|
|
8
|
+
} | {
|
|
9
|
+
type: "status";
|
|
10
|
+
status: string;
|
|
11
|
+
} | {
|
|
12
|
+
type: "message_result";
|
|
13
|
+
message: GenieMessageResponse;
|
|
14
|
+
} | {
|
|
15
|
+
type: "query_result";
|
|
16
|
+
attachmentId: string;
|
|
17
|
+
statementId: string;
|
|
18
|
+
data: unknown;
|
|
19
|
+
} | {
|
|
20
|
+
type: "error";
|
|
21
|
+
error: string;
|
|
22
|
+
};
|
|
23
|
+
/** Cleaned response — subset of SDK GenieMessage */
|
|
24
|
+
interface GenieMessageResponse {
|
|
25
|
+
messageId: string;
|
|
26
|
+
conversationId: string;
|
|
27
|
+
spaceId: string;
|
|
28
|
+
status: string;
|
|
29
|
+
content: string;
|
|
30
|
+
attachments?: GenieAttachmentResponse[];
|
|
31
|
+
error?: string;
|
|
32
|
+
}
|
|
33
|
+
interface GenieAttachmentResponse {
|
|
34
|
+
attachmentId?: string;
|
|
35
|
+
query?: {
|
|
36
|
+
title?: string;
|
|
37
|
+
description?: string;
|
|
38
|
+
query?: string;
|
|
39
|
+
statementId?: string;
|
|
40
|
+
};
|
|
41
|
+
text?: {
|
|
42
|
+
content?: string;
|
|
43
|
+
};
|
|
44
|
+
suggestedQuestions?: string[];
|
|
45
|
+
}
|
|
46
|
+
//#endregion
|
|
47
|
+
export { GenieAttachmentResponse, GenieMessageResponse, GenieStreamEvent };
|
|
48
|
+
//# sourceMappingURL=genie.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"genie.d.ts","names":[],"sources":["../../../../shared/src/genie.ts"],"sourcesContent":[],"mappings":";;AACY,KAAA,gBAAA,GAAgB;EAkBX,IAAA,EAAA,eAAA;EAUA,cAAA,EAAA,MAAA;;;;;;;;WApBsB;;;;;;;;;;;UAUtB,oBAAA;;;;;;gBAMD;;;UAIC,uBAAA"}
|
|
@@ -27,14 +27,14 @@ console.error(error.toJSON()); // Safe for logging, sensitive values redacted
|
|
|
27
27
|
|
|
28
28
|
## Extended by[](#extended-by "Direct link to Extended by")
|
|
29
29
|
|
|
30
|
-
* [`AuthenticationError`](
|
|
31
|
-
* [`ConfigurationError`](
|
|
32
|
-
* [`ConnectionError`](
|
|
33
|
-
* [`ExecutionError`](
|
|
34
|
-
* [`InitializationError`](
|
|
35
|
-
* [`ServerError`](
|
|
36
|
-
* [`TunnelError`](
|
|
37
|
-
* [`ValidationError`](
|
|
30
|
+
* [`AuthenticationError`](./docs/api/appkit/Class.AuthenticationError.md)
|
|
31
|
+
* [`ConfigurationError`](./docs/api/appkit/Class.ConfigurationError.md)
|
|
32
|
+
* [`ConnectionError`](./docs/api/appkit/Class.ConnectionError.md)
|
|
33
|
+
* [`ExecutionError`](./docs/api/appkit/Class.ExecutionError.md)
|
|
34
|
+
* [`InitializationError`](./docs/api/appkit/Class.InitializationError.md)
|
|
35
|
+
* [`ServerError`](./docs/api/appkit/Class.ServerError.md)
|
|
36
|
+
* [`TunnelError`](./docs/api/appkit/Class.TunnelError.md)
|
|
37
|
+
* [`ValidationError`](./docs/api/appkit/Class.ValidationError.md)
|
|
38
38
|
|
|
39
39
|
## Constructors[](#constructors "Direct link to Constructors")
|
|
40
40
|
|
|
@@ -12,7 +12,7 @@ throw new AuthenticationError("Failed to generate credentials", { cause: origina
|
|
|
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 AuthenticationError(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 ConfigurationError("Warehouse ID not found", { context: { env: "produc
|
|
|
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 ConfigurationError(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 ConnectionError("No response received from SQL Warehouse API");
|
|
|
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 ConnectionError(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 ExecutionError("Statement was canceled");
|
|
|
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 ExecutionError(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 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")
|