@databricks/appkit 0.21.0 → 0.23.0

package/docs/api/appkit/Class.Plugin.md

@@ -251,7 +251,65 @@ A proxied plugin instance that executes as the user
 
 #### Throws[​](#throws "Direct link to Throws")
 
-AuthenticationError if user token is not available in request headers (production only). In development mode (`NODE_ENV=development`), falls back to the service principal instead of throwing.
+AuthenticationError if user token is not available in request headers (production only). In development mode (`NODE_ENV=development`), skips user impersonation instead of throwing.
+
+***
+
+### clientConfig()[​](#clientconfig "Direct link to clientConfig()")
+
+```ts
+clientConfig(): Record<string, unknown>;
+
+```
+
+Returns startup config to expose to the client. Override this to surface server-side values that are safe to publish to the frontend, such as feature flags, resource IDs, or other app boot settings.
+
+This runs once when the server starts, so it should not depend on request-scoped or user-specific state.
+
+String values that match non-public environment variables are redacted unless you intentionally expose them via a matching `PUBLIC_APPKIT_` env var.
+
+Values must be JSON-serializable plain data (no functions, Dates, classes, Maps, Sets, BigInts, or circular references). By default returns an empty object (plugin contributes nothing to client config).
+
+On the client, read the config with the `usePluginClientConfig` hook (React) or the `getPluginClientConfig` function (vanilla JS), both from `@databricks/appkit-ui`.
+
+#### Returns[​](#returns-3 "Direct link to Returns")
+
+`Record`<`string`, `unknown`>
+
+#### Example[​](#example "Direct link to Example")
+
+```ts
+// Server — plugin definition
+class MyPlugin extends Plugin<MyConfig> {
+  clientConfig() {
+    return {
+      warehouseId: this.config.warehouseId,
+      features: { darkMode: true },
+    };
+  }
+}
+
+// Client — React component
+import { usePluginClientConfig } from "@databricks/appkit-ui/react";
+
+interface MyPluginConfig { warehouseId: string; features: { darkMode: boolean } }
+
+const config = usePluginClientConfig<MyPluginConfig>("myPlugin");
+config.warehouseId; // "abc-123"
+
+// Client — vanilla JS
+import { getPluginClientConfig } from "@databricks/appkit-ui/js";
+
+const config = getPluginClientConfig<MyPluginConfig>("myPlugin");
+
+```
+
+#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")
+
+```ts
+BasePlugin.clientConfig
+
+```
 
 ***
 
@@ -261,13 +319,18 @@ AuthenticationError if user token is not available in request headers (productio
 protected execute<T>(
    fn: (signal?: AbortSignal) => Promise<T>, 
    options: PluginExecutionSettings, 
-userKey?: string): Promise<T | undefined>;
+userKey?: string): Promise<ExecutionResult<T>>;
 
 ```
 
 Execute a function with the plugin's interceptor chain.
 
-All errors are caught and `undefined` is returned (production-safe). Route handlers should check for `undefined` and respond with an appropriate error status.
+Returns an [ExecutionResult](./docs/api/appkit/TypeAlias.ExecutionResult.md) discriminated union:
+
+* `{ ok: true, data: T }` on success
+* `{ ok: false, status: number, message: string }` on failure
+
+Errors are never thrown — the method is production-safe.
 
 #### Type Parameters[​](#type-parameters-1 "Direct link to Type Parameters")
 
@@ -283,9 +346,9 @@ All errors are caught and `undefined` is returned (production-safe). Route handl
 | `options`  | `PluginExecutionSettings`                    |
 | `userKey?` | `string`                                     |
 
-#### Returns[​](#returns-3 "Direct link to Returns")
+#### Returns[​](#returns-4 "Direct link to Returns")
 
-`Promise`<`T` | `undefined`>
+`Promise`<[`ExecutionResult`](./docs/api/appkit/TypeAlias.ExecutionResult.md)<`T`>>
 
 ***
 
@@ -315,7 +378,7 @@ userKey?: string): Promise<void>;
 | `options`  | [`StreamExecutionSettings`](./docs/api/appkit/Interface.StreamExecutionSettings.md) |
 | `userKey?` | `string`                                                                                  |
 
-#### Returns[​](#returns-4 "Direct link to Returns")
+#### Returns[​](#returns-5 "Direct link to Returns")
 
 `Promise`<`void`>
 
@@ -332,11 +395,11 @@ Returns the public exports for this plugin. Override this to define a custom pub
 
 The returned object becomes the plugin's public API on the AppKit instance (e.g. `appkit.myPlugin.method()`). AppKit automatically binds method context and adds `asUser(req)` for user-scoped execution.
 
-#### Returns[​](#returns-5 "Direct link to Returns")
+#### Returns[​](#returns-6 "Direct link to Returns")
 
 `unknown`
 
-#### Example[​](#example "Direct link to Example")
+#### Example[​](#example-1 "Direct link to Example")
 
 ```ts
 class MyPlugin extends Plugin {
@@ -353,7 +416,7 @@ appkit.myPlugin.getData();
 
 ```
 
-#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")
+#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")
 
 ```ts
 BasePlugin.exports
@@ -369,11 +432,11 @@ getEndpoints(): PluginEndpointMap;
 
 ```
 
-#### Returns[​](#returns-6 "Direct link to Returns")
+#### Returns[​](#returns-7 "Direct link to Returns")
 
 `PluginEndpointMap`
 
-#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")
+#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")
 
 ```ts
 BasePlugin.getEndpoints
@@ -389,11 +452,11 @@ getSkipBodyParsingPaths(): ReadonlySet<string>;
 
 ```
 
-#### Returns[​](#returns-7 "Direct link to Returns")
+#### Returns[​](#returns-8 "Direct link to Returns")
 
 `ReadonlySet`<`string`>
 
-#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")
+#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")
 
 ```ts
 BasePlugin.getSkipBodyParsingPaths
@@ -415,11 +478,11 @@ injectRoutes(_: Router): void;
 | --------- | -------- |
 | `_`       | `Router` |
 
-#### Returns[​](#returns-8 "Direct link to Returns")
+#### Returns[​](#returns-9 "Direct link to Returns")
 
 `void`
 
-#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")
+#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")
 
 ```ts
 BasePlugin.injectRoutes
@@ -442,7 +505,7 @@ protected registerEndpoint(name: string, path: string): void;
 | `name`    | `string` |
 | `path`    | `string` |
 
-#### Returns[​](#returns-9 "Direct link to Returns")
+#### Returns[​](#returns-10 "Direct link to Returns")
 
 `void`
 
@@ -465,7 +528,7 @@ Returns the `x-forwarded-user` header when present. In development mode (`NODE_E
 | --------- | --------- |
 | `req`     | `Request` |
 
-#### Returns[​](#returns-10 "Direct link to Returns")
+#### Returns[​](#returns-11 "Direct link to Returns")
 
 `string`
 
@@ -495,7 +558,7 @@ protected route<_TResponse>(router: Router, config: RouteConfig): void;
 | `router`  | `Router`      |
 | `config`  | `RouteConfig` |
 
-#### Returns[​](#returns-11 "Direct link to Returns")
+#### Returns[​](#returns-12 "Direct link to Returns")
 
 `void`
 
@@ -508,11 +571,11 @@ setup(): Promise<void>;
 
 ```
 
-#### Returns[​](#returns-12 "Direct link to Returns")
+#### Returns[​](#returns-13 "Direct link to Returns")
 
 `Promise`<`void`>
 
-#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")
+#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")
 
 ```ts
 BasePlugin.setup

package/docs/api/appkit/Function.appKitServingTypesPlugin.md

@@ -0,0 +1,24 @@
+# Function: appKitServingTypesPlugin()
+
+```ts
+function appKitServingTypesPlugin(options?: AppKitServingTypesPluginOptions): Plugin$1;
+
+```
+
+Vite plugin to generate TypeScript types for AppKit serving endpoints. Fetches OpenAPI schemas from Databricks and generates a .d.ts with ServingEndpointRegistry module augmentation.
+
+Endpoint discovery order:
+
+1. Explicit `endpoints` option (override)
+2. AST extraction from server file (server/index.ts or server/server.ts)
+3. DATABRICKS\_SERVING\_ENDPOINT\_NAME env var (single default endpoint)
+
+## Parameters[​](#parameters "Direct link to Parameters")
+
+| Parameter  | Type                              |
+| ---------- | --------------------------------- |
+| `options?` | `AppKitServingTypesPluginOptions` |
+
+## Returns[​](#returns "Direct link to Returns")
+
+`Plugin$1`

package/docs/api/appkit/Function.extractServingEndpoints.md

@@ -0,0 +1,22 @@
+# Function: extractServingEndpoints()
+
+```ts
+function extractServingEndpoints(serverFilePath: string): 
+  | Record<string, EndpointConfig>
+  | null;
+
+```
+
+Extract serving endpoint config from a server file by AST-parsing it. Looks for `serving({ endpoints: { alias: { env: "..." }, ... } })` calls and extracts the endpoint alias names and their environment variable mappings.
+
+## Parameters[​](#parameters "Direct link to Parameters")
+
+| Parameter        | Type     | Description                            |
+| ---------------- | -------- | -------------------------------------- |
+| `serverFilePath` | `string` | Absolute path to the server entry file |
+
+## Returns[​](#returns "Direct link to Returns")
+
+\| `Record`<`string`, [`EndpointConfig`](./docs/api/appkit/Interface.EndpointConfig.md)> | `null`
+
+Extracted endpoint config, or null if not found or not extractable

package/docs/api/appkit/Function.findServerFile.md

@@ -0,0 +1,20 @@
+# Function: findServerFile()
+
+```ts
+function findServerFile(basePath: string): string | null;
+
+```
+
+Find the server entry file by checking candidate paths in order.
+
+## Parameters[​](#parameters "Direct link to Parameters")
+
+| Parameter  | Type     | Description                           |
+| ---------- | -------- | ------------------------------------- |
+| `basePath` | `string` | Project root directory to search from |
+
+## Returns[​](#returns "Direct link to Returns")
+
+`string` | `null`
+
+Absolute path to the server file, or null if none found

package/docs/api/appkit/Interface.EndpointConfig.md

@@ -0,0 +1,23 @@
+# Interface: EndpointConfig
+
+## Properties[​](#properties "Direct link to Properties")
+
+### env[​](#env "Direct link to env")
+
+```ts
+env: string;
+
+```
+
+Environment variable holding the endpoint name.
+
+***
+
+### servedModel?[​](#servedmodel "Direct link to servedModel?")
+
+```ts
+optional servedModel: string;
+
+```
+
+Target a specific served model (bypasses traffic routing).

package/docs/api/appkit/Interface.ServingEndpointEntry.md

@@ -0,0 +1,30 @@
+# Interface: ServingEndpointEntry
+
+Shape of a single registry entry.
+
+## Properties[​](#properties "Direct link to Properties")
+
+### chunk[​](#chunk "Direct link to chunk")
+
+```ts
+chunk: unknown;
+
+```
+
+***
+
+### request[​](#request "Direct link to request")
+
+```ts
+request: Record<string, unknown>;
+
+```
+
+***
+
+### response[​](#response "Direct link to response")
+
+```ts
+response: unknown;
+
+```

package/docs/api/appkit/Interface.ServingEndpointRegistry.md

@@ -0,0 +1,3 @@
+# Interface: ServingEndpointRegistry
+
+Registry interface for serving endpoint type generation. Empty by default — augmented by the Vite type generator's `.d.ts` output via module augmentation. When populated, provides autocomplete for alias names and typed request/response/chunk per endpoint.

package/docs/api/appkit/TypeAlias.ExecutionResult.md

@@ -0,0 +1,36 @@
+# Type Alias: ExecutionResult\<T>
+
+```ts
+type ExecutionResult<T> = 
+  | {
+  data: T;
+  ok: true;
+}
+  | {
+  message: string;
+  ok: false;
+  status: number;
+};
+
+```
+
+Discriminated union for plugin execution results.
+
+Replaces the previous `T | undefined` return type on `execute()`.
+
+On failure, the HTTP status code is preserved from:
+
+* `AppKitError` subclasses (via `statusCode`)
+* Any `Error` with a numeric `statusCode` property (e.g. `ApiError`)
+* All other errors default to status 500
+
+In production, error messages from non-AppKitError sources are handled as:
+
+* 4xx errors: original message is preserved (client-facing by design)
+* 5xx errors: replaced with "Server error" to prevent information leakage
+
+## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
+
+| Type Parameter |
+| -------------- |
+| `T`            |

package/docs/api/appkit/TypeAlias.ServingFactory.md

@@ -0,0 +1,15 @@
+# Type Alias: ServingFactory
+
+```ts
+type ServingFactory = keyof ServingEndpointRegistry extends never ? (alias?: string) => ServingEndpointHandle : <K>(alias: K) => ServingEndpointHandle<ServingEndpointRegistry[K]["request"], ServingEndpointRegistry[K]["response"]>;
+
+```
+
+Factory function returned by `AppKit.serving`.
+
+This is a conditional type that adapts based on whether `ServingEndpointRegistry` has been populated via module augmentation (generated by `appKitServingTypesPlugin()`):
+
+* **Registry empty (default):** `(alias?: string) => ServingEndpointHandle` — accepts any alias string with untyped request/response.
+* **Registry populated:** `<K>(alias: K) => ServingEndpointHandle<...>` — restricts `alias` to known endpoint keys and infers typed request/response from the registry entry.
+
+Run `appKitServingTypesPlugin()` in your Vite config to generate the registry augmentation and enable full type safety.

package/docs/api/appkit.md

@@ -27,32 +27,37 @@ Core library for building Databricks applications with type-safe SQL queries, pl
 
 ## 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 the CacheInterceptor. Controls TTL, size limits, storage backend, and probabilistic cleanup.                                                                                                                                                |
-| [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. Extends the shared PluginManifest with strict resource types.                                                                              |
-| [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(). Narrows the generated base: type → ResourceType enum, permission → ResourcePermission union.                              |
-| [StreamExecutionSettings](./docs/api/appkit/Interface.StreamExecutionSettings.md)                     | Execution settings for streaming endpoints. Extends PluginExecutionSettings with SSE stream configuration.                                                                                                                                                    |
-| [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.                                                                                                                                                                                        |
+| Interface                                                                                                   | Description                                                                                                                                                                                                                                                     |
+| ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [BasePluginConfig](./docs/api/appkit/Interface.BasePluginConfig.md)                                   | Base configuration interface for AppKit plugins                                                                                                                                                                                                                 |
+| [CacheConfig](./docs/api/appkit/Interface.CacheConfig.md)                                             | Configuration for the CacheInterceptor. Controls TTL, size limits, storage backend, and probabilistic cleanup.                                                                                                                                                  |
+| [DatabaseCredential](./docs/api/appkit/Interface.DatabaseCredential.md)                               | Database credentials with OAuth token for Postgres connection                                                                                                                                                                                                   |
+| [EndpointConfig](./docs/api/appkit/Interface.EndpointConfig.md)                                       | -                                                                                                                                                                                                                                                               |
+| [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. Extends the shared PluginManifest with strict resource types.                                                                                |
+| [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(). Narrows the generated base: type → ResourceType enum, permission → ResourcePermission union.                                |
+| [ServingEndpointEntry](./docs/api/appkit/Interface.ServingEndpointEntry.md)                           | Shape of a single registry entry.                                                                                                                                                                                                                               |
+| [ServingEndpointRegistry](./docs/api/appkit/Interface.ServingEndpointRegistry.md)                     | Registry interface for serving endpoint type generation. Empty by default — augmented by the Vite type generator's `.d.ts` output via module augmentation. When populated, provides autocomplete for alias names and typed request/response/chunk per endpoint. |
+| [StreamExecutionSettings](./docs/api/appkit/Interface.StreamExecutionSettings.md)                     | Execution settings for streaming endpoints. Extends PluginExecutionSettings with SSE stream configuration.                                                                                                                                                      |
+| [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. |
+| [ExecutionResult](./docs/api/appkit/TypeAlias.ExecutionResult.md)       | Discriminated union for plugin execution results.                                                           |
 | [IAppRouter](./docs/api/appkit/TypeAlias.IAppRouter.md)                 | Express router type for plugin route registration                                                           |
 | [PluginData](./docs/api/appkit/TypeAlias.PluginData.md)                 | Tuple of plugin class, config, and name. Created by `toPlugin()` and passed to `createApp()`.               |
 | [ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md) | Union of all possible permission levels across all resource types.                                          |
+| [ServingFactory](./docs/api/appkit/TypeAlias.ServingFactory.md)         | Factory function returned by `AppKit.serving`.                                                              |
 | [ToPlugin](./docs/api/appkit/TypeAlias.ToPlugin.md)                     | Factory function type returned by `toPlugin()`. Accepts optional config and returns a PluginData tuple.     |
 
 ## Variables[​](#variables "Direct link to Variables")
@@ -63,17 +68,20 @@ Core library for building Databricks applications with type-safe SQL queries, pl
 
 ## 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                                                                                             |
+| Function                                                                                     | Description                                                                                                                                                                                                                   |
+| -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [appKitServingTypesPlugin](./docs/api/appkit/Function.appKitServingTypesPlugin.md)     | Vite plugin to generate TypeScript types for AppKit serving endpoints. Fetches OpenAPI schemas from Databricks and generates a .d.ts with ServingEndpointRegistry module augmentation.                                        |
+| [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.                                                                               |
+| [extractServingEndpoints](./docs/api/appkit/Function.extractServingEndpoints.md)       | Extract serving endpoint config from a server file by AST-parsing it. Looks for `serving({ endpoints: { alias: { env: "..." }, ... } })` calls and extracts the endpoint alias names and their environment variable mappings. |
+| [findServerFile](./docs/api/appkit/Function.findServerFile.md)                         | Find the server entry file by checking candidate paths in order.                                                                                                                                                              |
+| [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/app-management.md

@@ -5,7 +5,7 @@ Manage your AppKit application throughout its lifecycle using the Databricks CLI
 ## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
 
 * [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).
+* Databricks CLI (v0.295.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
 
 ## Create app[​](#create-app "Direct link to Create app")
 

package/docs/architecture.md

@@ -59,7 +59,7 @@ The Node.js backend layer built with `@databricks/appkit`:
 Integration with Databricks services:
 
 * **SQL Warehouses**: Execute analytical queries with Arrow or JSON format
-* **Lakebase V1 (Provisioned)**: Access data from Lakebase Provisioned. Support for Lakebase Autoscaling coming soon.
+* **Lakebase Autoscaling**: OLTP database access with automatic OAuth token refresh
 
 ## See also[​](#see-also "Direct link to See also")
 

package/docs/development/ai-assisted-development.md

@@ -3,7 +3,7 @@
 ## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
 
 * [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).
+* Databricks CLI (v0.295.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 [Bootstrap a new Databricks app](./docs.md#quick-start-options) for more details.
 
 AppKit integrates with AI coding assistants through the Agent Skills.
@@ -13,7 +13,7 @@ AppKit integrates with AI coding assistants through the Agent Skills.
 To install the Databricks Agent Skills for your preferred AI assistant, run:
 
 ```bash
-databricks experimental aitools skills install
+databricks experimental aitools install
 
 ```
 

package/docs/development/local-development.md

@@ -3,7 +3,7 @@
 ## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
 
 * [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).
+* Databricks CLI (v0.295.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 [Bootstrap a new Databricks app](./docs.md#quick-start-options) for more details.
 
 Once your app is bootstrapped according to the [Manual quick start](./docs.md#manual-quick-start) guide, you can start the development server with hot reload for both UI and backend code.

package/docs/development/remote-bridge.md

@@ -3,7 +3,7 @@
 ## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
 
 * [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).
+* Databricks CLI (v0.295.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 [Bootstrap a new Databricks app](./docs.md#quick-start-options) 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.