@databricks/appkit-ui 0.12.0 → 0.12.2

package/docs/{docs/api → api}/appkit/Interface.ResourceEntry.md

@@ -4,7 +4,7 @@ Internal representation of a resource in the registry. Extends ResourceRequireme
 
 ## Extends[​](#extends "Direct link to Extends")
 
-* [`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md)
+* [`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md)
 
 ## Properties[​](#properties "Direct link to Properties")
 
@@ -19,7 +19,7 @@ Unique alias for this resource within the plugin (e.g., 'warehouse', 'secrets').
 
 #### Inherited from[​](#inherited-from "Direct link to Inherited from")
 
-[`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md).[`alias`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md#alias)
+[`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`alias`](./docs/api/appkit/Interface.ResourceRequirement.md#alias)
 
 ***
 
@@ -34,7 +34,7 @@ Human-readable description of why this resource is needed
 
 #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
 
-[`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md).[`description`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md#description)
+[`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`description`](./docs/api/appkit/Interface.ResourceRequirement.md#description)
 
 ***
 
@@ -49,7 +49,7 @@ Map of field name to env and optional description. Single-value types use one ke
 
 #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
 
-[`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md).[`fields`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md#fields)
+[`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`fields`](./docs/api/appkit/Interface.ResourceRequirement.md#fields)
 
 ***
 
@@ -64,7 +64,7 @@ Required permission level for the resource
 
 #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
 
-[`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md).[`permission`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md#permission)
+[`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`permission`](./docs/api/appkit/Interface.ResourceRequirement.md#permission)
 
 ***
 
@@ -101,7 +101,7 @@ Whether this resource is required (true) or optional (false)
 
 #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
 
-[`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md).[`required`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md#required)
+[`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`required`](./docs/api/appkit/Interface.ResourceRequirement.md#required)
 
 ***
 
@@ -127,7 +127,7 @@ Stable key for machine use (env naming, composite keys, app.yaml). Required.
 
 #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")
 
-[`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md).[`resourceKey`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md#resourcekey)
+[`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`resourceKey`](./docs/api/appkit/Interface.ResourceRequirement.md#resourcekey)
 
 ***
 
@@ -142,7 +142,7 @@ Type of Databricks resource required
 
 #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")
 
-[`ResourceRequirement`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md).[`type`](/appkit/docs/api/appkit/Interface.ResourceRequirement.md#type)
+[`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`type`](./docs/api/appkit/Interface.ResourceRequirement.md#type)
 
 ***
 

package/docs/{docs/api → api}/appkit/Interface.ResourceRequirement.md

@@ -4,7 +4,7 @@ Declares a resource requirement for a plugin. Can be defined statically in a man
 
 ## Extended by[​](#extended-by "Direct link to Extended by")
 
-* [`ResourceEntry`](/appkit/docs/api/appkit/Interface.ResourceEntry.md)
+* [`ResourceEntry`](./docs/api/appkit/Interface.ResourceEntry.md)
 
 ## Properties[​](#properties "Direct link to Properties")
 

package/docs/{docs/api → api}/appkit-ui/styling.md

@@ -78,4 +78,4 @@ Where:
 
 ## See also[​](#see-also "Direct link to See also")
 
-* [API Reference](/appkit/docs/api/appkit-ui.md) - Complete UI components API documentation
+* [API Reference](./docs/api/appkit-ui.md) - Complete UI components API documentation

package/docs/{docs/api → api}/appkit-ui/ui/Sidebar.md

@@ -2,6 +2,271 @@
 
 Collapsible navigation sidebar with mobile support
 
+## Example[​](#example "Direct link to Example")
+
+<!-- -->
+
+```tsx
+import {
+    Button,
+    DropdownMenu,
+    DropdownMenuContent,
+    DropdownMenuGroup,
+    DropdownMenuItem,
+    DropdownMenuTrigger,
+    Sidebar,
+    SidebarContent,
+    SidebarGroup,
+    SidebarGroupContent,
+    SidebarGroupLabel,
+    SidebarHeader,
+    SidebarInput,
+    SidebarInset,
+    SidebarMenu,
+    SidebarMenuButton,
+    SidebarMenuItem,
+    SidebarProvider,
+    SidebarRail,
+    SidebarTrigger,
+    Item,
+    ItemActions,
+    ItemContent,
+    ItemDescription,
+    ItemTitle,
+    Label,
+} from "@databricks/appkit-ui/react"
+import { useState } from "react"
+
+export default function SidebarExample() {
+    const data = {
+        versions: ["1.0.1", "1.1.0-alpha", "2.0.0-beta1"],
+        navMain: [
+            {
+                title: "Getting Started",
+                url: "#",
+                items: [
+                    {
+                        title: "Installation",
+                        url: "#",
+                    },
+                    {
+                        title: "Project Structure",
+                        url: "#",
+                    },
+                ],
+            },
+            {
+                title: "Build Your Application",
+                url: "#",
+                items: [
+                    {
+                        title: "Routing",
+                        url: "#",
+                    },
+                    {
+                        title: "Data Fetching",
+                        url: "#",
+                        isActive: true,
+                    },
+                    {
+                        title: "Rendering",
+                        url: "#",
+                    },
+                    {
+                        title: "Caching",
+                        url: "#",
+                    },
+                    {
+                        title: "Styling",
+                        url: "#",
+                    },
+                    {
+                        title: "Optimizing",
+                        url: "#",
+                    },
+                    {
+                        title: "Configuring",
+                        url: "#",
+                    },
+                    {
+                        title: "Testing",
+                        url: "#",
+                    },
+                    {
+                        title: "Authentication",
+                        url: "#",
+                    },
+                    {
+                        title: "Deploying",
+                        url: "#",
+                    },
+                    {
+                        title: "Upgrading",
+                        url: "#",
+                    },
+                    {
+                        title: "Examples",
+                        url: "#",
+                    },
+                ],
+            },
+            {
+                title: "API Reference",
+                url: "#",
+                items: [
+                    {
+                        title: "Components",
+                        url: "#",
+                    },
+                    {
+                        title: "File Conventions",
+                        url: "#",
+                    },
+                    {
+                        title: "Functions",
+                        url: "#",
+                    },
+                    {
+                        title: "next.config.js Options",
+                        url: "#",
+                    },
+                    {
+                        title: "CLI",
+                        url: "#",
+                    },
+                    {
+                        title: "Edge Runtime",
+                        url: "#",
+                    },
+                ],
+            },
+            {
+                title: "Architecture",
+                url: "#",
+                items: [
+                    {
+                        title: "Accessibility",
+                        url: "#",
+                    },
+                    {
+                        title: "Fast Refresh",
+                        url: "#",
+                    },
+                    {
+                        title: "Next.js Compiler",
+                        url: "#",
+                    },
+                    {
+                        title: "Supported Browsers",
+                        url: "#",
+                    },
+                    {
+                        title: "Turbopack",
+                        url: "#",
+                    },
+                ],
+            },
+        ],
+    }
+
+    const [selectedVersion, setSelectedVersion] = useState(data.versions[0])
+
+    return (
+        <SidebarProvider>
+            <Sidebar>
+                <SidebarHeader>
+                    <SidebarMenu>
+                        <SidebarMenuItem>
+                            <DropdownMenu>
+                                <DropdownMenuTrigger asChild>
+                                    <SidebarMenuButton
+                                        size="lg"
+                                        className="data-open:bg-sidebar-accent data-open:text-sidebar-accent-foreground"
+                                    >
+                                        <Item className="p-0 w-full" size="sm">
+                                            <ItemContent>
+                                                <ItemTitle className="text-sm">Documentation</ItemTitle>
+                                                <ItemDescription>v{selectedVersion}</ItemDescription>
+                                            </ItemContent>
+                                            <ItemActions className="ml-auto">
+                                                <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="size-4 shrink-0 opacity-50"><path d="m7 15 5 5 5-5"/><path d="m7 9 5-5 5 5"/></svg>
+                                            </ItemActions>
+                                        </Item>
+                                    </SidebarMenuButton>
+                                </DropdownMenuTrigger>
+                                <DropdownMenuContent>
+                                    <DropdownMenuGroup>
+                                        {data.versions.map((version) => (
+                                            <DropdownMenuItem
+                                                key={version}
+                                                onSelect={() => setSelectedVersion(version)}
+                                            >
+                                                v{version}{" "}
+                                                {version === selectedVersion && (
+                                                    <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="ml-auto size-4"><path d="M20 6 9 17l-5-5"/></svg>
+                                                )}
+                                            </DropdownMenuItem>
+                                        ))}
+                                    </DropdownMenuGroup>
+                                </DropdownMenuContent>
+                            </DropdownMenu>
+                        </SidebarMenuItem>
+                    </SidebarMenu>
+                    <form>
+                        <SidebarGroup className="py-0">
+                            <SidebarGroupContent className="relative">
+                                <Label htmlFor="search" className="sr-only">
+                                    Search
+                                </Label>
+                                <SidebarInput
+                                    id="search"
+                                    placeholder="Search the docs..."
+                                    className="pl-8"
+                                />
+                                <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className="pointer-events-none absolute top-1/2 left-2 size-4 -translate-y-1/2 opacity-50 select-none"><circle cx="11" cy="11" r="8"/><path d="m21 21-4.35-4.35"/></svg>
+                            </SidebarGroupContent>
+                        </SidebarGroup>
+                    </form>
+                </SidebarHeader>
+                <SidebarContent>
+                    {data.navMain.map((item) => (
+                        <SidebarGroup key={item.title}>
+                            <SidebarGroupLabel>{item.title}</SidebarGroupLabel>
+                            <SidebarGroupContent>
+                                <SidebarMenu>
+                                    {item.items.map((subItem) => (
+                                        <SidebarMenuItem key={subItem.title}>
+                                            <SidebarMenuButton asChild isActive={subItem.isActive}>
+                                                <a href={subItem.url}>{subItem.title}</a>
+                                            </SidebarMenuButton>
+                                        </SidebarMenuItem>
+                                    ))}
+                                </SidebarMenu>
+                            </SidebarGroupContent>
+                        </SidebarGroup>
+                    ))}
+                </SidebarContent>
+                <SidebarRail />
+            </Sidebar>
+            <SidebarInset>
+                <header className="flex h-16 shrink-0 items-center gap-2 border-b px-4">
+                    <SidebarTrigger className="-ml-1" />
+                </header>
+                <div className="flex flex-1 flex-col gap-4 p-4">
+                    <div className="grid auto-rows-min gap-4 md:grid-cols-3">
+                        <div className="bg-muted/50 aspect-video rounded-xl" />
+                        <div className="bg-muted/50 aspect-video rounded-xl" />
+                        <div className="bg-muted/50 aspect-video rounded-xl" />
+                    </div>
+                    <div className="bg-muted/50 min-h-[100vh] flex-1 rounded-xl md:min-h-min" />
+                </div>
+            </SidebarInset>
+        </SidebarProvider>
+    )
+}
+
+```
+
 ## Sidebar[​](#sidebar-1 "Direct link to Sidebar")
 
 Collapsible navigation sidebar with mobile support
@@ -10,11 +275,11 @@ Collapsible navigation sidebar with mobile support
 
 ### Props[​](#props "Direct link to Props")
 
-| Prop          | Type   | Required | Default     | Description |
-| ------------- | ------ | -------- | ----------- | ----------- |
-| `side`        | `enum` |          | `left`      | -           |
-| `variant`     | `enum` |          | `sidebar`   | -           |
-| `collapsible` | `enum` |          | `offcanvas` | -           |
+| Prop          | Type   | Required | Default     | Description                                                                                                                           |
+| ------------- | ------ | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `side`        | `enum` |          | `left`      | Which side of the viewport the sidebar appears on                                                                                     |
+| `variant`     | `enum` |          | `sidebar`   | Visual style: `"sidebar"` (standard with border), `"floating"` (rounded with shadow), or `"inset"` (content area gets rounded margin) |
+| `collapsible` | `enum` |          | `offcanvas` | Collapse behavior: `"offcanvas"` (slides off-screen), `"icon"` (collapses to icon width), or `"none"` (always expanded)               |
 
 ### Usage[​](#usage "Direct link to Usage")
 
@@ -90,9 +355,9 @@ Action button displayed next to a sidebar group label
 
 ### Props[​](#props-4 "Direct link to Props")
 
-| Prop      | Type      | Required | Default | Description |
-| --------- | --------- | -------- | ------- | ----------- |
-| `asChild` | `boolean` |          | `false` | -           |
+| Prop      | Type      | Required | Default | Description                                    |
+| --------- | --------- | -------- | ------- | ---------------------------------------------- |
+| `asChild` | `boolean` |          | `false` | Render as child element instead of default tag |
 
 ### Usage[​](#usage-4 "Direct link to Usage")
 
@@ -130,9 +395,9 @@ Label heading for a sidebar group
 
 ### Props[​](#props-6 "Direct link to Props")
 
-| Prop      | Type      | Required | Default | Description |
-| --------- | --------- | -------- | ------- | ----------- |
-| `asChild` | `boolean` |          | `false` | -           |
+| Prop      | Type      | Required | Default | Description                                    |
+| --------- | --------- | -------- | ------- | ---------------------------------------------- |
+| `asChild` | `boolean` |          | `false` | Render as child element instead of default tag |
 
 ### Usage[​](#usage-6 "Direct link to Usage")
 
@@ -227,10 +492,10 @@ Action button displayed alongside a menu item
 
 ### Props[​](#props-11 "Direct link to Props")
 
-| Prop          | Type      | Required | Default | Description |
-| ------------- | --------- | -------- | ------- | ----------- |
-| `asChild`     | `boolean` |          | `false` | -           |
-| `showOnHover` | `boolean` |          | `false` | -           |
+| Prop          | Type      | Required | Default | Description                                    |
+| ------------- | --------- | -------- | ------- | ---------------------------------------------- |
+| `asChild`     | `boolean` |          | `false` | Render as child element instead of default tag |
+| `showOnHover` | `boolean` |          | `false` | Only show when parent menu item is hovered     |
 
 ### Usage[​](#usage-11 "Direct link to Usage")
 
@@ -266,13 +531,13 @@ import { SidebarMenuBadge } from '@databricks/appkit-ui';
 
 ### Props[​](#props-13 "Direct link to Props")
 
-| Prop       | Type                                                              | Required | Default   | Description |
-| ---------- | ----------------------------------------------------------------- | -------- | --------- | ----------- |
-| `asChild`  | `boolean`                                                         |          | `false`   | -           |
-| `isActive` | `boolean`                                                         |          | `false`   | -           |
-| `tooltip`  | `string \| (TooltipContentProps & RefAttributes<HTMLDivElement>)` |          | -         | -           |
-| `variant`  | `"default" \| "outline" \| null`                                  |          | `default` | -           |
-| `size`     | `"default" \| "sm" \| "lg" \| null`                               |          | `default` | -           |
+| Prop       | Type                                                              | Required | Default   | Description                                          |
+| ---------- | ----------------------------------------------------------------- | -------- | --------- | ---------------------------------------------------- |
+| `asChild`  | `boolean`                                                         |          | `false`   | Render as child element instead of default tag       |
+| `isActive` | `boolean`                                                         |          | `false`   | Whether this item is currently active/selected       |
+| `tooltip`  | `string \| (TooltipContentProps & RefAttributes<HTMLDivElement>)` |          | -         | Tooltip shown when sidebar is collapsed to icon mode |
+| `variant`  | `"default" \| "outline" \| null`                                  |          | `default` | -                                                    |
+| `size`     | `"default" \| "sm" \| "lg" \| null`                               |          | `default` | -                                                    |
 
 ### Usage[​](#usage-13 "Direct link to Usage")
 
@@ -310,9 +575,9 @@ Loading skeleton placeholder for menu items
 
 ### Props[​](#props-15 "Direct link to Props")
 
-| Prop       | Type      | Required | Default | Description |
-| ---------- | --------- | -------- | ------- | ----------- |
-| `showIcon` | `boolean` |          | `false` | -           |
+| Prop       | Type      | Required | Default | Description                                                  |
+| ---------- | --------- | -------- | ------- | ------------------------------------------------------------ |
+| `showIcon` | `boolean` |          | `false` | Show a circular icon placeholder alongside the text skeleton |
 
 ### Usage[​](#usage-15 "Direct link to Usage")
 
@@ -350,11 +615,11 @@ Button for submenu items
 
 ### Props[​](#props-17 "Direct link to Props")
 
-| Prop       | Type      | Required | Default | Description |
-| ---------- | --------- | -------- | ------- | ----------- |
-| `asChild`  | `boolean` |          | `false` | -           |
-| `size`     | `enum`    |          | `md`    | -           |
-| `isActive` | `boolean` |          | `false` | -           |
+| Prop       | Type      | Required | Default | Description                                            |
+| ---------- | --------- | -------- | ------- | ------------------------------------------------------ |
+| `asChild`  | `boolean` |          | `false` | Render as child element instead of default tag         |
+| `size`     | `enum`    |          | `md`    | Text size of the submenu button                        |
+| `isActive` | `boolean` |          | `false` | Whether this submenu item is currently active/selected |
 
 ### Usage[​](#usage-17 "Direct link to Usage")
 
@@ -390,11 +655,11 @@ import { SidebarMenuSubItem } from '@databricks/appkit-ui';
 
 ### Props[​](#props-19 "Direct link to Props")
 
-| Prop           | Type                        | Required | Default | Description |
-| -------------- | --------------------------- | -------- | ------- | ----------- |
-| `defaultOpen`  | `boolean`                   |          | `true`  | -           |
-| `open`         | `boolean`                   |          | -       | -           |
-| `onOpenChange` | `((open: boolean) => void)` |          | -       | -           |
+| Prop           | Type                        | Required | Default | Description                               |
+| -------------- | --------------------------- | -------- | ------- | ----------------------------------------- |
+| `defaultOpen`  | `boolean`                   |          | `true`  | Initial open state for uncontrolled usage |
+| `open`         | `boolean`                   |          | -       | Controlled open state                     |
+| `onOpenChange` | `((open: boolean) => void)` |          | -       | Callback when open state changes          |
 
 ### Usage[​](#usage-19 "Direct link to Usage")
 
@@ -478,13 +743,15 @@ Hook to access sidebar state and controls
 
 ### Props[​](#props-23 "Direct link to Props")
 
-This component extends standard HTML element attributes.
+This hook takes no parameters.
 
 ### Usage[​](#usage-23 "Direct link to Usage")
 
 ```tsx
 import { useSidebar } from '@databricks/appkit-ui';
 
-<useSidebar /* props */ />
+function MyComponent() {
+  const sidebar = useSidebar();
+}
 
 ```

package/docs/api/appkit.md

@@ -0,0 +1,78 @@
+# @databricks/appkit
+
+Core library for building Databricks applications with type-safe SQL queries, plugin architecture, and React integration.
+
+## Enumerations[​](#enumerations "Direct link to Enumerations")
+
+| Enumeration                                                                                         | Description                                        |
+| --------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
+| [RequestedClaimsPermissionSet](./docs/api/appkit/Enumeration.RequestedClaimsPermissionSet.md) | Permission set for Unity Catalog table access      |
+| [ResourceType](./docs/api/appkit/Enumeration.ResourceType.md)                                 | Resource types from schema $defs.resourceType.enum |
+
+## Classes[​](#classes "Direct link to Classes")
+
+| Class                                                                       | Description                                                                                                                                    |
+| --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| [AppKitError](./docs/api/appkit/Class.AppKitError.md)                 | Base error class for all AppKit errors. Provides a consistent structure for error handling across the framework.                               |
+| [AuthenticationError](./docs/api/appkit/Class.AuthenticationError.md) | Error thrown when authentication fails. Use for missing tokens, invalid credentials, or authorization failures.                                |
+| [ConfigurationError](./docs/api/appkit/Class.ConfigurationError.md)   | Error thrown when configuration is missing or invalid. Use for missing environment variables, invalid settings, or setup issues.               |
+| [ConnectionError](./docs/api/appkit/Class.ConnectionError.md)         | Error thrown when a connection or network operation fails. Use for database pool errors, API failures, timeouts, etc.                          |
+| [ExecutionError](./docs/api/appkit/Class.ExecutionError.md)           | Error thrown when an operation execution fails. Use for statement failures, canceled operations, or unexpected states.                         |
+| [InitializationError](./docs/api/appkit/Class.InitializationError.md) | Error thrown when a service or component is not properly initialized. Use when accessing services before they are ready.                       |
+| [Plugin](./docs/api/appkit/Class.Plugin.md)                           | Base abstract class for creating AppKit plugins.                                                                                               |
+| [ResourceRegistry](./docs/api/appkit/Class.ResourceRegistry.md)       | Central registry for tracking plugin resource requirements. Deduplication uses type + resourceKey (machine-stable); alias is for display only. |
+| [ServerError](./docs/api/appkit/Class.ServerError.md)                 | Error thrown when server lifecycle operations fail. Use for server start/stop issues, configuration conflicts, etc.                            |
+| [TunnelError](./docs/api/appkit/Class.TunnelError.md)                 | Error thrown when remote tunnel operations fail. Use for tunnel connection issues, message parsing failures, etc.                              |
+| [ValidationError](./docs/api/appkit/Class.ValidationError.md)         | Error thrown when input validation fails. Use for invalid parameters, missing required fields, or type mismatches.                             |
+
+## Interfaces[​](#interfaces "Direct link to Interfaces")
+
+| Interface                                                                                                   | Description                                                                                                                                                                                                                                                   |
+| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [BasePluginConfig](./docs/api/appkit/Interface.BasePluginConfig.md)                                   | Base configuration interface for AppKit plugins                                                                                                                                                                                                               |
+| [CacheConfig](./docs/api/appkit/Interface.CacheConfig.md)                                             | Configuration for caching                                                                                                                                                                                                                                     |
+| [DatabaseCredential](./docs/api/appkit/Interface.DatabaseCredential.md)                               | Database credentials with OAuth token for Postgres connection                                                                                                                                                                                                 |
+| [GenerateDatabaseCredentialRequest](./docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md) | Request parameters for generating database OAuth credentials                                                                                                                                                                                                  |
+| [ITelemetry](./docs/api/appkit/Interface.ITelemetry.md)                                               | Plugin-facing interface for OpenTelemetry instrumentation. Provides a thin abstraction over OpenTelemetry APIs for plugins.                                                                                                                                   |
+| [LakebasePoolConfig](./docs/api/appkit/Interface.LakebasePoolConfig.md)                               | Configuration for creating a Lakebase connection pool                                                                                                                                                                                                         |
+| [PluginManifest](./docs/api/appkit/Interface.PluginManifest.md)                                       | Plugin manifest that declares metadata and resource requirements. Attached to plugin classes as a static property.                                                                                                                                            |
+| [RequestedClaims](./docs/api/appkit/Interface.RequestedClaims.md)                                     | Optional claims for fine-grained Unity Catalog table permissions When specified, the returned token will be scoped to only the requested tables                                                                                                               |
+| [RequestedResource](./docs/api/appkit/Interface.RequestedResource.md)                                 | Resource to request permissions for in Unity Catalog                                                                                                                                                                                                          |
+| [ResourceEntry](./docs/api/appkit/Interface.ResourceEntry.md)                                         | Internal representation of a resource in the registry. Extends ResourceRequirement with resolution state and plugin ownership.                                                                                                                                |
+| [ResourceFieldEntry](./docs/api/appkit/Interface.ResourceFieldEntry.md)                               | Defines a single field for a resource. Each field has its own environment variable and optional description. Single-value types use one key (e.g. id); multi-value types (database, secret) use multiple (e.g. instance\_name, database\_name or scope, key). |
+| [ResourceRequirement](./docs/api/appkit/Interface.ResourceRequirement.md)                             | Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().                                                                                                                           |
+| [StreamExecutionSettings](./docs/api/appkit/Interface.StreamExecutionSettings.md)                     | Configuration for streaming execution with default and user-scoped settings                                                                                                                                                                                   |
+| [TelemetryConfig](./docs/api/appkit/Interface.TelemetryConfig.md)                                     | OpenTelemetry configuration for AppKit applications                                                                                                                                                                                                           |
+| [ValidationResult](./docs/api/appkit/Interface.ValidationResult.md)                                   | Result of validating all registered resources against the environment.                                                                                                                                                                                        |
+
+## Type Aliases[​](#type-aliases "Direct link to Type Aliases")
+
+| Type Alias                                                                    | Description                                                                                                 |
+| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| [ConfigSchema](./docs/api/appkit/TypeAlias.ConfigSchema.md)             | Configuration schema definition for plugin config. Re-exported from the standard JSON Schema Draft 7 types. |
+| [IAppRouter](./docs/api/appkit/TypeAlias.IAppRouter.md)                 | Express router type for plugin route registration                                                           |
+| [ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md) | Union of all possible permission levels across all resource types.                                          |
+| [ToPlugin](./docs/api/appkit/TypeAlias.ToPlugin.md)                     | -                                                                                                           |
+
+## Variables[​](#variables "Direct link to Variables")
+
+| Variable                                       | Description          |
+| ---------------------------------------------- | -------------------- |
+| [sql](./docs/api/appkit/Variable.sql.md) | SQL helper namespace |
+
+## Functions[​](#functions "Direct link to Functions")
+
+| Function                                                                                     | Description                                                                                                                                     |
+| -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| [appKitTypesPlugin](./docs/api/appkit/Function.appKitTypesPlugin.md)                   | Vite plugin to generate types for AppKit queries. Calls generateFromEntryPoint under the hood.                                                  |
+| [createApp](./docs/api/appkit/Function.createApp.md)                                   | Bootstraps AppKit with the provided configuration.                                                                                              |
+| [createLakebasePool](./docs/api/appkit/Function.createLakebasePool.md)                 | Create a Lakebase pool with appkit's logger integration. Telemetry automatically uses appkit's OpenTelemetry configuration via global registry. |
+| [generateDatabaseCredential](./docs/api/appkit/Function.generateDatabaseCredential.md) | Generate OAuth credentials for Postgres database connection using the proper Postgres API.                                                      |
+| [getExecutionContext](./docs/api/appkit/Function.getExecutionContext.md)               | Get the current execution context.                                                                                                              |
+| [getLakebaseOrmConfig](./docs/api/appkit/Function.getLakebaseOrmConfig.md)             | Get Lakebase connection configuration for ORMs that don't accept pg.Pool directly.                                                              |
+| [getLakebasePgConfig](./docs/api/appkit/Function.getLakebasePgConfig.md)               | Get Lakebase connection configuration for PostgreSQL clients.                                                                                   |
+| [getPluginManifest](./docs/api/appkit/Function.getPluginManifest.md)                   | Loads and validates the manifest from a plugin constructor. Normalizes string type/permission to strict ResourceType/ResourcePermission.        |
+| [getResourceRequirements](./docs/api/appkit/Function.getResourceRequirements.md)       | Gets the resource requirements from a plugin's manifest.                                                                                        |
+| [getUsernameWithApiLookup](./docs/api/appkit/Function.getUsernameWithApiLookup.md)     | Resolves the PostgreSQL username for a Lakebase connection.                                                                                     |
+| [getWorkspaceClient](./docs/api/appkit/Function.getWorkspaceClient.md)                 | Get workspace client from config or SDK default auth chain                                                                                      |
+| [isSQLTypeMarker](./docs/api/appkit/Function.isSQLTypeMarker.md)                       | Type guard to check if a value is a SQL type marker                                                                                             |

package/docs/{docs/api.md → api.md}

@@ -4,14 +4,14 @@ This section contains the API reference for the AppKit packages.
 
 ## Modules[​](#modules "Direct link to Modules")
 
-* [`appkit`](/appkit/docs/api/appkit.md) - Core library. Provides the core functionality for building Databricks applications.
-* [`appkit-ui`](/appkit/docs/api/appkit-ui.md) - UI components library. Provides a set of UI primitives for building Databricks apps in [React](https://react.dev/).
+* [`appkit`](./docs/api/appkit.md) - Core library. Provides the core functionality for building Databricks applications.
+* [`appkit-ui`](./docs/api/appkit-ui.md) - UI components library. Provides a set of UI primitives for building Databricks apps in [React](https://react.dev/).
 
-Learn more about the architecture of AppKit in the [architecture](/appkit/docs/architecture.md) document.
+Learn more about the architecture of AppKit in the [architecture](./docs/architecture.md) document.
 
 ## Getting started[​](#getting-started "Direct link to Getting started")
 
-To learn how to get started with AppKit, see the [getting started guide](/appkit/docs.md) for AI-assisted and manual quick start options.
+To learn how to get started with AppKit, see the [getting started guide](./docs.md) for AI-assisted and manual quick start options.
 
 ## Installation[​](#installation "Direct link to Installation")
 

package/docs/{docs/app-management.md → app-management.md}

@@ -9,11 +9,11 @@ Manage your AppKit application throughout its lifecycle using the Databricks CLI
 
 ## Create app[​](#create-app "Direct link to Create app")
 
-See the [Quick start](/appkit/docs.md#quick-start) section to create a new Databricks app with AppKit installed.
+See the [Quick start](./docs.md#quick-start-options) section to create a new Databricks app with AppKit installed.
 
 ## Configuration[​](#configuration "Direct link to Configuration")
 
-Before deploying your app, you need to configure it. See the [Configuration guide](/appkit/docs/configuration.md) for details on:
+Before deploying your app, you need to configure it. See the [Configuration guide](./docs/configuration.md) for details on:
 
 * `app.yaml` configuration and command specification
 * Environment variables and SQL warehouse binding