@databricks/appkit-ui 0.12.0 → 0.12.1

package/docs/{docs/api → api}/appkit/Class.TunnelError.md

@@ -12,7 +12,7 @@ throw new TunnelError("Failed to parse WebSocket message", { cause: parseError }
 
 ## Extends[​](#extends "Direct link to Extends")
 
-* [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md)
+* [`AppKitError`](./docs/api/appkit/Class.AppKitError.md)
 
 ## Constructors[​](#constructors "Direct link to Constructors")
 
@@ -41,7 +41,7 @@ new TunnelError(message: string, options?: {
 
 #### Inherited from[​](#inherited-from "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`constructor`](/appkit/docs/api/appkit/Class.AppKitError.md#constructor)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`constructor`](./docs/api/appkit/Class.AppKitError.md#constructor)
 
 ## Properties[​](#properties "Direct link to Properties")
 
@@ -56,7 +56,7 @@ Optional cause of the error
 
 #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`cause`](/appkit/docs/api/appkit/Class.AppKitError.md#cause)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`cause`](./docs/api/appkit/Class.AppKitError.md#cause)
 
 ***
 
@@ -71,7 +71,7 @@ Error code for programmatic error handling
 
 #### Overrides[​](#overrides "Direct link to Overrides")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`code`](/appkit/docs/api/appkit/Class.AppKitError.md#code)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`code`](./docs/api/appkit/Class.AppKitError.md#code)
 
 ***
 
@@ -86,7 +86,7 @@ Additional context for the error
 
 #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`context`](/appkit/docs/api/appkit/Class.AppKitError.md#context)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`context`](./docs/api/appkit/Class.AppKitError.md#context)
 
 ***
 
@@ -101,7 +101,7 @@ Whether this error type is generally safe to retry
 
 #### Overrides[​](#overrides-1 "Direct link to Overrides")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`isRetryable`](/appkit/docs/api/appkit/Class.AppKitError.md#isretryable)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`isRetryable`](./docs/api/appkit/Class.AppKitError.md#isretryable)
 
 ***
 
@@ -116,7 +116,7 @@ HTTP status code suggestion (can be overridden)
 
 #### Overrides[​](#overrides-2 "Direct link to Overrides")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`statusCode`](/appkit/docs/api/appkit/Class.AppKitError.md#statuscode)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`statusCode`](./docs/api/appkit/Class.AppKitError.md#statuscode)
 
 ## Methods[​](#methods "Direct link to Methods")
 
@@ -135,7 +135,7 @@ Convert error to JSON for logging/serialization. Sensitive values in context are
 
 #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toJSON`](/appkit/docs/api/appkit/Class.AppKitError.md#tojson)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toJSON`](./docs/api/appkit/Class.AppKitError.md#tojson)
 
 ***
 
@@ -154,7 +154,7 @@ Create a human-readable string representation
 
 #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toString`](/appkit/docs/api/appkit/Class.AppKitError.md#tostring)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toString`](./docs/api/appkit/Class.AppKitError.md#tostring)
 
 ***
 

package/docs/{docs/api → api}/appkit/Class.ValidationError.md

@@ -12,7 +12,7 @@ throw new ValidationError("maxPoolSize must be at least 1", { context: { value:
 
 ## Extends[​](#extends "Direct link to Extends")
 
-* [`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md)
+* [`AppKitError`](./docs/api/appkit/Class.AppKitError.md)
 
 ## Constructors[​](#constructors "Direct link to Constructors")
 
@@ -41,7 +41,7 @@ new ValidationError(message: string, options?: {
 
 #### Inherited from[​](#inherited-from "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`constructor`](/appkit/docs/api/appkit/Class.AppKitError.md#constructor)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`constructor`](./docs/api/appkit/Class.AppKitError.md#constructor)
 
 ## Properties[​](#properties "Direct link to Properties")
 
@@ -56,7 +56,7 @@ Optional cause of the error
 
 #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`cause`](/appkit/docs/api/appkit/Class.AppKitError.md#cause)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`cause`](./docs/api/appkit/Class.AppKitError.md#cause)
 
 ***
 
@@ -71,7 +71,7 @@ Error code for programmatic error handling
 
 #### Overrides[​](#overrides "Direct link to Overrides")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`code`](/appkit/docs/api/appkit/Class.AppKitError.md#code)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`code`](./docs/api/appkit/Class.AppKitError.md#code)
 
 ***
 
@@ -86,7 +86,7 @@ Additional context for the error
 
 #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`context`](/appkit/docs/api/appkit/Class.AppKitError.md#context)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`context`](./docs/api/appkit/Class.AppKitError.md#context)
 
 ***
 
@@ -101,7 +101,7 @@ Whether this error type is generally safe to retry
 
 #### Overrides[​](#overrides-1 "Direct link to Overrides")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`isRetryable`](/appkit/docs/api/appkit/Class.AppKitError.md#isretryable)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`isRetryable`](./docs/api/appkit/Class.AppKitError.md#isretryable)
 
 ***
 
@@ -116,7 +116,7 @@ HTTP status code suggestion (can be overridden)
 
 #### Overrides[​](#overrides-2 "Direct link to Overrides")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`statusCode`](/appkit/docs/api/appkit/Class.AppKitError.md#statuscode)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`statusCode`](./docs/api/appkit/Class.AppKitError.md#statuscode)
 
 ## Methods[​](#methods "Direct link to Methods")
 
@@ -135,7 +135,7 @@ Convert error to JSON for logging/serialization. Sensitive values in context are
 
 #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toJSON`](/appkit/docs/api/appkit/Class.AppKitError.md#tojson)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toJSON`](./docs/api/appkit/Class.AppKitError.md#tojson)
 
 ***
 
@@ -154,7 +154,7 @@ Create a human-readable string representation
 
 #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
 
-[`AppKitError`](/appkit/docs/api/appkit/Class.AppKitError.md).[`toString`](/appkit/docs/api/appkit/Class.AppKitError.md#tostring)
+[`AppKitError`](./docs/api/appkit/Class.AppKitError.md).[`toString`](./docs/api/appkit/Class.AppKitError.md#tostring)
 
 ***
 

package/docs/{docs/api → api}/appkit/Function.createApp.md

@@ -22,11 +22,11 @@ Bootstraps AppKit with the provided configuration.
 
 | Parameter           | Type                                                                                                                                                                                                                     |
 | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `config`            | { `cache?`: [`CacheConfig`](/appkit/docs/api/appkit/Interface.CacheConfig.md); `client?`: `WorkspaceClient`; `plugins?`: `T`; `telemetry?`: [`TelemetryConfig`](/appkit/docs/api/appkit/Interface.TelemetryConfig.md); } |
-| `config.cache?`     | [`CacheConfig`](/appkit/docs/api/appkit/Interface.CacheConfig.md)                                                                                                                                                        |
+| `config`            | { `cache?`: [`CacheConfig`](./docs/api/appkit/Interface.CacheConfig.md); `client?`: `WorkspaceClient`; `plugins?`: `T`; `telemetry?`: [`TelemetryConfig`](./docs/api/appkit/Interface.TelemetryConfig.md); } |
+| `config.cache?`     | [`CacheConfig`](./docs/api/appkit/Interface.CacheConfig.md)                                                                                                                                                        |
 | `config.client?`    | `WorkspaceClient`                                                                                                                                                                                                        |
 | `config.plugins?`   | `T`                                                                                                                                                                                                                      |
-| `config.telemetry?` | [`TelemetryConfig`](/appkit/docs/api/appkit/Interface.TelemetryConfig.md)                                                                                                                                                |
+| `config.telemetry?` | [`TelemetryConfig`](./docs/api/appkit/Interface.TelemetryConfig.md)                                                                                                                                                |
 
 ## Returns[​](#returns "Direct link to Returns")
 

package/docs/{docs/api → api}/appkit/Function.createLakebasePool.md

@@ -11,7 +11,7 @@ Create a Lakebase pool with appkit's logger integration. Telemetry automatically
 
 | Parameter | Type                                                                                       | Description                 |
 | --------- | ------------------------------------------------------------------------------------------ | --------------------------- |
-| `config?` | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> | Lakebase pool configuration |
+| `config?` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> | Lakebase pool configuration |
 
 ## Returns[​](#returns "Direct link to Returns")
 

package/docs/{docs/api → api}/appkit/Function.generateDatabaseCredential.md

@@ -14,11 +14,11 @@ This generates a time-limited OAuth token (expires after 1 hour) that can be use
 | Parameter         | Type                                                                                                          | Description                                                       |
 | ----------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
 | `workspaceClient` | `WorkspaceClient`                                                                                             | Databricks workspace client for authentication                    |
-| `request`         | [`GenerateDatabaseCredentialRequest`](/appkit/docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md) | Request parameters including endpoint path and optional UC claims |
+| `request`         | [`GenerateDatabaseCredentialRequest`](./docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md) | Request parameters including endpoint path and optional UC claims |
 
 ## Returns[​](#returns "Direct link to Returns")
 
-`Promise`<[`DatabaseCredential`](/appkit/docs/api/appkit/Interface.DatabaseCredential.md)>
+`Promise`<[`DatabaseCredential`](./docs/api/appkit/Interface.DatabaseCredential.md)>
 
 Database credentials with OAuth token and expiration time
 

package/docs/{docs/api → api}/appkit/Function.getLakebaseOrmConfig.md

@@ -26,7 +26,7 @@ Returns connection config with field names compatible with common ORMs:
 
 | Parameter | Type                                                                                       | Description                                                     |
 | --------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
-| `config?` | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> | Optional configuration (reads from environment if not provided) |
+| `config?` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> | Optional configuration (reads from environment if not provided) |
 
 ## Returns[​](#returns "Direct link to Returns")
 

package/docs/{docs/api → api}/appkit/Function.getLakebasePgConfig.md

@@ -20,7 +20,7 @@ Used internally by createLakebasePool().
 
 | Parameter    | Type                                                                                       | Description                                                             |
 | ------------ | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
-| `config?`    | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> | Optional configuration (reads from environment if not provided)         |
+| `config?`    | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> | Optional configuration (reads from environment if not provided)         |
 | `telemetry?` | `DriverTelemetry`                                                                          | Optional pre-initialized telemetry (created internally if not provided) |
 | `logger?`    | `Logger`                                                                                   | Optional logger (silent if not provided)                                |
 

package/docs/{docs/api → api}/appkit/Function.getPluginManifest.md

@@ -15,7 +15,7 @@ Loads and validates the manifest from a plugin constructor. Normalizes string ty
 
 ## Returns[​](#returns "Direct link to Returns")
 
-[`PluginManifest`](/appkit/docs/api/appkit/Interface.PluginManifest.md)
+[`PluginManifest`](./docs/api/appkit/Interface.PluginManifest.md)
 
 The validated, normalized plugin manifest
 

package/docs/{docs/api → api}/appkit/Function.getUsernameWithApiLookup.md

@@ -22,7 +22,7 @@ Returns `undefined` if all attempts fail rather than throwing, so the caller can
 
 | Parameter | Type                                                                                       |
 | --------- | ------------------------------------------------------------------------------------------ |
-| `config?` | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> |
+| `config?` | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> |
 
 ## Returns[​](#returns "Direct link to Returns")
 

package/docs/{docs/api → api}/appkit/Function.getWorkspaceClient.md

@@ -11,7 +11,7 @@ Get workspace client from config or SDK default auth chain
 
 | Parameter | Type                                                                                       |
 | --------- | ------------------------------------------------------------------------------------------ |
-| `config`  | `Partial`<[`LakebasePoolConfig`](/appkit/docs/api/appkit/Interface.LakebasePoolConfig.md)> |
+| `config`  | `Partial`<[`LakebasePoolConfig`](./docs/api/appkit/Interface.LakebasePoolConfig.md)> |
 
 ## Returns[​](#returns "Direct link to Returns")
 

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/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) 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

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

@@ -20,7 +20,7 @@ The backend SDK that provides the plugin architecture and core functionality. It
 * Cache management and streaming capabilities
 * Type generation for SQL queries
 
-See the [Plugins](/appkit/docs/plugins.md) and [API reference](/appkit/docs/api/appkit.md) documentation for detailed information.
+See the [Plugins](./docs/plugins.md) and [API reference](./docs/api/appkit.md) documentation for detailed information.
 
 ### @databricks/appkit-ui[​](#databricksappkit-ui "Direct link to @databricks/appkit-ui")
 
@@ -31,7 +31,7 @@ A React UI library with pre-built components optimized for data applications:
 * Data visualization components
 * Type-safe integration with backend queries
 
-See the [API reference](/appkit/docs/api/appkit-ui.md) for component documentation.
+See the [API reference](./docs/api/appkit-ui.md) for component documentation.
 
 ## Application layers[​](#application-layers "Direct link to Application layers")
 
@@ -63,7 +63,7 @@ Integration with Databricks services:
 
 ## See also[​](#see-also "Direct link to See also")
 
-* [Plugins](/appkit/docs/plugins.md): Deep dive into the plugin system
-* [API reference](/appkit/docs/api.md): Complete API documentation
-* [Development](/appkit/docs/development.md): Explore development workflows
-* [Core Principles](/appkit/docs/core-principles.md): Learn about AppKit's design philosophy
+* [Plugins](./docs/plugins.md): Deep dive into the plugin system
+* [API reference](./docs/api.md): Complete API documentation
+* [Development](./docs/development.md): Explore development workflows
+* [Core Principles](./docs/core-principles.md): Learn about AppKit's design philosophy

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

@@ -146,5 +146,5 @@ For advanced Databricks Apps configuration (authorization, networking, resource
 
 ## See also[​](#see-also "Direct link to See also")
 
-* [App management](/appkit/docs/app-management.md) - Deploying and managing apps
-* [Plugins](/appkit/docs/plugins.md) - Plugin configuration options
+* [App management](./docs/app-management.md) - Deploying and managing apps
+* [Plugins](./docs/plugins.md) - Plugin configuration options

package/docs/{docs/development → development}/ai-assisted-development.md

@@ -4,7 +4,7 @@
 
 * [Node.js](https://nodejs.org) v22+ environment with `npm`
 * Databricks CLI (v0.287.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
-* A new Databricks app with AppKit installed. See the [Quick start](/appkit/docs.md#quick-start) for more details.
+* A new Databricks app with AppKit installed. See the [Quick start](./docs.md#quick-start) for more details.
 
 AppKit-specific agent skills for AI coding assistants are coming soon. This documentation will be updated with instructions when available.
 
@@ -20,7 +20,9 @@ If you're building applications using AppKit packages, reference the `llms.txt`
 2. Use the `npx @databricks/appkit docs` command to view the documentation in the terminal.
 
 ```bash
-npx @databricks/appkit docs # returns the llms.txt file content with all available documentation pages
-npx @databricks/appkit docs <path> # for specific documentation file
+npx @databricks/appkit docs            # documentation index with section overview
+npx @databricks/appkit docs "appkit-ui API reference"  # view a specific section
+npx @databricks/appkit docs --full     # full index with all API entries
+npx @databricks/appkit docs ./docs.md  # view a specific documentation file
 
 ```

package/docs/{docs/development → development}/llm-guide.md

@@ -46,17 +46,18 @@ View API reference (docs only, NOT for scaffolding):
 
 ```bash
 # ONLY for viewing documentation - do NOT use for init/scaffold
-npx @databricks/appkit docs <path>
+npx @databricks/appkit docs <query>
 
 ```
 
-**IMPORTANT**: ALWAYS run `npx @databricks/appkit docs` (no path) FIRST to see available pages. DO NOT guess paths - use the index to find correct paths.
+**IMPORTANT**: ALWAYS run `npx @databricks/appkit docs` (no query) FIRST to see the documentation index. DO NOT guess paths - use the index to find correct paths.
 
-Examples of known paths:
+Examples:
 
-* Root index: `npx @databricks/appkit docs`
-* API reference: `npx @databricks/appkit docs ./docs/docs/api.md`
-* Component docs: `npx @databricks/appkit docs ./docs/docs/api/appkit-ui/components/Sidebar.md`
+* Documentation index: `npx @databricks/appkit docs`
+* View a section: `npx @databricks/appkit docs "appkit-ui API reference"`
+* Full index (all API entries): `npx @databricks/appkit docs --full`
+* View specific doc: `npx @databricks/appkit docs ./docs/plugins/analytics.md`
 
 ## LLM checklist (before finalizing code)[​](#llm-checklist-before-finalizing-code "Direct link to LLM checklist (before finalizing code)")
 

package/docs/{docs/development → development}/local-development.md

@@ -4,9 +4,9 @@
 
 * [Node.js](https://nodejs.org) v22+ environment with `npm`
 * Databricks CLI (v0.287.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
-* A new Databricks app with AppKit installed. See the [Quick start](/appkit/docs.md#quick-start) for more details.
+* A new Databricks app with AppKit installed. See the [Quick start](./docs.md#quick-start) for more details.
 
-Once your app is bootstrapped according to the [Quick start](/appkit/docs.md#quick-start) guide, you can start the development server with hot reload for both UI and backend code.
+Once your app is bootstrapped according to the [Quick start](./docs.md#quick-start) guide, you can start the development server with hot reload for both UI and backend code.
 
 In the application root directory, run the following command to start the development server:
 

package/docs/{docs/development → development}/project-setup.md

@@ -241,6 +241,6 @@ Then create `config/queries/` and add your `.sql` files.
 
 ## See also[​](#see-also "Direct link to See also")
 
-* [Local development](/appkit/docs/development/local-development.md) - Running the dev server
-* [Configuration](/appkit/docs/configuration.md) - Environment variables
-* [Plugins](/appkit/docs/plugins.md) - Plugin configuration
+* [Local development](./docs/development/local-development.md) - Running the dev server
+* [Configuration](./docs/configuration.md) - Environment variables
+* [Plugins](./docs/plugins.md) - Plugin configuration

package/docs/{docs/development → development}/remote-bridge.md

@@ -4,7 +4,7 @@
 
 * [Node.js](https://nodejs.org) v22+ environment with `npm`
 * Databricks CLI (v0.287.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
-* A new Databricks app with AppKit installed. See the [Quick start](/appkit/docs.md#quick-start) for more details.
+* A new Databricks app with AppKit installed. See the [Quick start](./docs.md#quick-start) for more details.
 
 Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.
 

package/docs/{docs/development → development}/type-generation.md

@@ -106,5 +106,5 @@ data?.forEach(row => {
 
 ## See also[​](#see-also "Direct link to See also")
 
-* [Plugins](/appkit/docs/plugins.md) - Analytics plugin configuration
-* [API Reference](/appkit/docs/api/appkit-ui.md) - Complete UI components API documentation
+* [Plugins](./docs/plugins.md) - Analytics plugin configuration
+* [API Reference](./docs/api/appkit-ui.md) - Complete UI components API documentation