@databricks/appkit-ui 0.20.2 → 0.21.0

package/dist/schemas/plugin-manifest.generated.d.ts

@@ -0,0 +1,178 @@
+//#region src/schemas/plugin-manifest.generated.d.ts
+/**
+ * Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().
+ *
+ * This interface was referenced by `PluginManifest`'s JSON-Schema
+ * via the `definition` "resourceRequirement".
+ */
+type ResourceRequirement = ({
+  type: ResourceType;
+  /**
+   * Human-readable label for UI/display only. Deduplication uses resourceKey, not alias.
+   */
+  alias: string;
+  /**
+   * Stable key for machine use: deduplication, env naming, composite keys, app.yaml. Required for registry lookup.
+   */
+  resourceKey: string;
+  /**
+   * Human-readable description of why this resource is needed
+   */
+  description: string;
+  /**
+   * Required permission level. Validated per resource type by the allOf/if-then rules below.
+   */
+  permission: string;
+  /**
+   * Map of field name to env and optional description. Single-value types use one key (e.g. id); multi-value (database, secret) use multiple (e.g. instance_name, database_name or scope, key).
+   */
+  fields?: {
+    [k: string]: ResourceFieldEntry;
+  };
+});
+/**
+ * Type of Databricks resource
+ *
+ * This interface was referenced by `PluginManifest`'s JSON-Schema
+ * via the `definition` "resourceType".
+ */
+type ResourceType = ("secret" | "job" | "sql_warehouse" | "serving_endpoint" | "volume" | "vector_search_index" | "uc_function" | "uc_connection" | "database" | "postgres" | "genie_space" | "experiment" | "app");
+/**
+ * Schema for Databricks AppKit plugin manifest files. Defines plugin metadata, resource requirements, and configuration options.
+ */
+interface PluginManifest {
+  /**
+   * Reference to the JSON Schema for validation
+   */
+  $schema?: string;
+  /**
+   * Plugin identifier. Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens.
+   */
+  name: string;
+  /**
+   * Human-readable display name for UI and CLI
+   */
+  displayName: string;
+  /**
+   * Brief description of what the plugin does
+   */
+  description: string;
+  /**
+   * Databricks resource requirements for this plugin
+   */
+  resources: {
+    /**
+     * Resources that must be available for the plugin to function
+     */
+    required: ResourceRequirement[];
+    /**
+     * Resources that enhance functionality but are not mandatory
+     */
+    optional: ResourceRequirement[];
+  };
+  /**
+   * Configuration schema for the plugin
+   */
+  config?: {
+    schema?: ConfigSchema;
+  };
+  /**
+   * Author name or organization
+   */
+  author?: string;
+  /**
+   * Plugin version (semver format)
+   */
+  version?: string;
+  /**
+   * URL to the plugin's source repository
+   */
+  repository?: string;
+  /**
+   * Keywords for plugin discovery
+   */
+  keywords?: string[];
+  /**
+   * SPDX license identifier
+   */
+  license?: string;
+  /**
+   * Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning).
+   */
+  onSetupMessage?: string;
+  /**
+   * When true, this plugin is excluded from the template plugins manifest (appkit.plugins.json) during sync.
+   */
+  hidden?: boolean;
+}
+/**
+ * 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).
+ *
+ * This interface was referenced by `PluginManifest`'s JSON-Schema
+ * via the `definition` "resourceFieldEntry".
+ */
+interface ResourceFieldEntry {
+  /**
+   * Environment variable name for this field
+   */
+  env?: string;
+  /**
+   * Human-readable description for this field
+   */
+  description?: string;
+  /**
+   * When true, this field is excluded from Databricks bundle configuration (databricks.yml) generation.
+   */
+  bundleIgnore?: boolean;
+  /**
+   * Example values showing the expected format for this field
+   */
+  examples?: string[];
+  /**
+   * When true, this field is only generated for local .env files. The Databricks Apps platform auto-injects it at deploy time.
+   */
+  localOnly?: boolean;
+  /**
+   * Static value for this field. Used when no prompted or resolved value exists.
+   */
+  value?: string;
+  /**
+   * Named resolver prefixed by resource type (e.g., 'postgres:host'). The CLI resolves this value during the init prompt flow.
+   */
+  resolve?: string;
+}
+/**
+ * This interface was referenced by `PluginManifest`'s JSON-Schema
+ * via the `definition` "configSchema".
+ */
+interface ConfigSchema {
+  type: ("object" | "array" | "string" | "number" | "boolean");
+  properties?: {
+    [k: string]: ConfigSchemaProperty;
+  };
+  items?: ConfigSchema;
+  required?: string[];
+  additionalProperties?: boolean;
+}
+/**
+ * This interface was referenced by `PluginManifest`'s JSON-Schema
+ * via the `definition` "configSchemaProperty".
+ */
+interface ConfigSchemaProperty {
+  type: ("object" | "array" | "string" | "number" | "boolean" | "integer");
+  description?: string;
+  default?: unknown;
+  enum?: unknown[];
+  properties?: {
+    [k: string]: ConfigSchemaProperty;
+  };
+  items?: ConfigSchemaProperty;
+  minimum?: number;
+  maximum?: number;
+  minLength?: number;
+  maxLength?: number;
+  required?: string[];
+}
+//#endregion
+export { PluginManifest, ResourceFieldEntry, ResourceRequirement };
+//# sourceMappingURL=plugin-manifest.generated.d.ts.map

package/dist/schemas/plugin-manifest.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-manifest.generated.d.ts","names":[],"sources":["../../src/schemas/plugin-manifest.generated.ts"],"mappings":";;AAQA;;;;;KAAY,mBAAA;EACZ,IAAA,EAAM,YAAA;EAQN;;;EAJA,KAAA;EAiBC;;;EAbD,WAAA;EAsBY;;;EAlBZ,WAAA;EAkBwB;AAgGxB;;EA9GA,UAAA;EAsIU;;;EAlIV,MAAA;IAAA,CACC,CAAA,WAAY,kBAAA;EAAA;AAAA;;;;;;;KASD,YAAA;;;;UAgGK,cAAA;;;;EAIjB,OAAA;;;;EAIA,IAAA;;;;EAIA,WAAA;;;;EAIA,WAAA;;;;EAIA,SAAA;;;;IAIA,QAAA,EAAU,mBAAA;;;;IAIV,QAAA,EAAU,mBAAA;EAAA;;;;EAKV,MAAA;IACA,MAAA,GAAS,YAAA;EAAA;;;;EAKT,MAAA;;;;EAIA,OAAA;;;;EAIA,UAAA;;;;EAIA,QAAA;;;;EAIA,OAAA;;;;EAIA,cAAA;;;;EAIA,MAAA;AAAA;;;;;;;UAQiB,kBAAA;;;;EAIjB,GAAA;;;;EAIA,WAAA;;;;EAIA,YAAA;;;;EAIA,QAAA;;;;EAIA,SAAA;;;;EAIA,KAAA;;;;EAIA,OAAA;AAAA;;;;;UAMiB,YAAA;EACjB,IAAA;EACA,UAAA;IAAA,CACC,CAAA,WAAY,oBAAA;EAAA;EAEb,KAAA,GAAQ,YAAA;EACR,QAAA;EACA,oBAAA;AAAA;;;;;UAMiB,oBAAA;EACjB,IAAA;EACA,WAAA;EACA,OAAA;EACA,IAAA;EACA,UAAA;IAAA,CACC,CAAA,WAAY,oBAAA;EAAA;EAEb,KAAA,GAAQ,oBAAA;EACR,OAAA;EACA,OAAA;EACA,SAAA;EACA,SAAA;EACA,QAAA;AAAA"}

package/dist/schemas/plugin-manifest.schema.json

@@ -185,6 +185,7 @@
     },
     "resourceFieldEntry": {
       "type": "object",
+      "description": "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).",
       "properties": {
         "env": {
           "type": "string",
@@ -225,6 +226,7 @@
     },
     "resourceRequirement": {
       "type": "object",
+      "description": "Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().",
       "required": ["type", "alias", "resourceKey", "description", "permission"],
       "properties": {
         "type": {

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

@@ -1,6 +1,6 @@
 # Interface: CacheConfig
 
-Configuration for caching
+Configuration for the CacheInterceptor. Controls TTL, size limits, storage backend, and probabilistic cleanup.
 
 ## Indexable[​](#indexable "Direct link to Indexable")
 

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

@@ -1,6 +1,15 @@
 # Interface: PluginManifest\<TName>
 
-Plugin manifest that declares metadata and resource requirements. Attached to plugin classes as a static property.
+Plugin manifest that declares metadata and resource requirements. Attached to plugin classes as a static property. Extends the shared PluginManifest with strict resource types.
+
+## See[​](#see "Direct link to See")
+
+* `packages/shared/src/schemas/plugin-manifest.generated.ts` `PluginManifest` — generated base
+* SharedPluginManifest — shared re-export with JSONSchema7 config
+
+## Extends[​](#extends "Direct link to Extends")
+
+* `Omit`<`SharedPluginManifest`, `"resources"` | `"config"`>
 
 ## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
 
@@ -17,7 +26,14 @@ optional author: string;
 
 ```
 
-Optional metadata for community plugins
+Author name or organization
+
+#### Inherited from[​](#inherited-from "Direct link to Inherited from")
+
+```ts
+Omit.author
+
+```
 
 ***
 
@@ -30,7 +46,7 @@ optional config: {
 
 ```
 
-Configuration schema for the plugin. Defines the shape and validation rules for plugin config.
+Configuration schema for the plugin. Uses JSONSchema7 instead of the generated ConfigSchema (which is too restrictive).
 
 #### schema[​](#schema "Direct link to schema")
 
@@ -50,6 +66,13 @@ description: string;
 
 Brief description of what the plugin does
 
+#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
+
+```ts
+Omit.description
+
+```
+
 ***
 
 ### displayName[​](#displayname "Direct link to displayName")
@@ -59,7 +82,14 @@ displayName: string;
 
 ```
 
-Human-readable display name for UI/CLI
+Human-readable display name for UI and CLI
+
+#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
+
+```ts
+Omit.displayName
+
+```
 
 ***
 
@@ -70,7 +100,14 @@ optional hidden: boolean;
 
 ```
 
-When true, excluded from the template plugins manifest during sync.
+When true, this plugin is excluded from the template plugins manifest (appkit.plugins.json) during sync.
+
+#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
+
+```ts
+Omit.hidden
+
+```
 
 ***
 
@@ -81,6 +118,15 @@ optional keywords: string[];
 
 ```
 
+Keywords for plugin discovery
+
+#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
+
+```ts
+Omit.keywords
+
+```
+
 ***
 
 ### license?[​](#license "Direct link to license?")
@@ -90,6 +136,15 @@ optional license: string;
 
 ```
 
+SPDX license identifier
+
+#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")
+
+```ts
+Omit.license
+
+```
+
 ***
 
 ### name[​](#name "Direct link to name")
@@ -101,6 +156,31 @@ name: TName;
 
 Plugin identifier — the single source of truth for the plugin's name
 
+#### Overrides[​](#overrides "Direct link to Overrides")
+
+```ts
+Omit.name
+
+```
+
+***
+
+### onSetupMessage?[​](#onsetupmessage "Direct link to onSetupMessage?")
+
+```ts
+optional onSetupMessage: string;
+
+```
+
+Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning).
+
+#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")
+
+```ts
+Omit.onSetupMessage
+
+```
+
 ***
 
 ### repository?[​](#repository "Direct link to repository?")
@@ -110,6 +190,15 @@ optional repository: string;
 
 ```
 
+URL to the plugin's source repository
+
+#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")
+
+```ts
+Omit.repository
+
+```
+
 ***
 
 ### resources[​](#resources "Direct link to resources")
@@ -122,7 +211,7 @@ resources: {
 
 ```
 
-Resource requirements declaration
+Resource requirements declaration (with strict ResourceRequirement types)
 
 #### optional[​](#optional "Direct link to optional")
 
@@ -150,3 +239,12 @@ Resources that must be available for the plugin to function
 optional version: string;
 
 ```
+
+Plugin version (semver format)
+
+#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")
+
+```ts
+Omit.version
+
+```

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

@@ -15,7 +15,7 @@ alias: string;
 
 ```
 
-Unique alias for this resource within the plugin (e.g., 'warehouse', 'secrets'). Used for UI/display.
+Human-readable label for UI/display only. Deduplication uses resourceKey, not alias.
 
 #### Inherited from[​](#inherited-from "Direct link to Inherited from")
 
@@ -45,7 +45,7 @@ fields: Record<string, ResourceFieldEntry>;
 
 ```
 
-Map of field name to env and optional description. Single-value types use one key (e.g. id); multi-value (database, secret) use multiple keys.
+Map of field name to env and optional description. Single-value types use one key (e.g. id); multi-value (database, secret) use multiple (e.g. instance\_name, database\_name or scope, key).
 
 #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
 
@@ -60,7 +60,7 @@ permission: ResourcePermission;
 
 ```
 
-Required permission level for the resource
+Required permission level for the resource (narrowed to union)
 
 #### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
 
@@ -97,8 +97,6 @@ required: boolean;
 
 ```
 
-Whether this resource is required (true) or optional (false)
-
 #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
 
 [`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`required`](./docs/api/appkit/Interface.ResourceRequirement.md#required)
@@ -123,7 +121,7 @@ resourceKey: string;
 
 ```
 
-Stable key for machine use (env naming, composite keys, app.yaml). Required.
+Stable key for machine use: deduplication, env naming, composite keys, app.yaml. Required for registry lookup.
 
 #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")
 
@@ -138,7 +136,7 @@ type: ResourceType;
 
 ```
 
-Type of Databricks resource required
+Type of Databricks resource required (narrowed to enum)
 
 #### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")
 

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

@@ -2,6 +2,8 @@
 
 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).
 
+This interface was referenced by `PluginManifest`'s JSON-Schema via the `definition` "resourceFieldEntry".
+
 ## Properties[​](#properties "Direct link to Properties")
 
 ### bundleIgnore?[​](#bundleignore "Direct link to bundleIgnore?")

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

@@ -1,6 +1,15 @@
 # Interface: ResourceRequirement
 
-Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().
+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.
+
+## See[​](#see "Direct link to See")
+
+* `packages/shared/src/schemas/plugin-manifest.generated.ts` `ResourceRequirement` — generated base
+* SharedResourceRequirement — shared re-export with runtime `fields` and `required`
+
+## Extends[​](#extends "Direct link to Extends")
+
+* `ResourceRequirement`
 
 ## Extended by[​](#extended-by "Direct link to Extended by")
 
@@ -15,7 +24,14 @@ alias: string;
 
 ```
 
-Unique alias for this resource within the plugin (e.g., 'warehouse', 'secrets'). Used for UI/display.
+Human-readable label for UI/display only. Deduplication uses resourceKey, not alias.
+
+#### Inherited from[​](#inherited-from "Direct link to Inherited from")
+
+```ts
+SharedResourceRequirement.alias
+
+```
 
 ***
 
@@ -28,6 +44,13 @@ description: string;
 
 Human-readable description of why this resource is needed
 
+#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
+
+```ts
+SharedResourceRequirement.description
+
+```
+
 ***
 
 ### fields[​](#fields "Direct link to fields")
@@ -37,7 +60,14 @@ fields: Record<string, ResourceFieldEntry>;
 
 ```
 
-Map of field name to env and optional description. Single-value types use one key (e.g. id); multi-value (database, secret) use multiple keys.
+Map of field name to env and optional description. Single-value types use one key (e.g. id); multi-value (database, secret) use multiple (e.g. instance\_name, database\_name or scope, key).
+
+#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
+
+```ts
+SharedResourceRequirement.fields
+
+```
 
 ***
 
@@ -48,7 +78,14 @@ permission: ResourcePermission;
 
 ```
 
-Required permission level for the resource
+Required permission level for the resource (narrowed to union)
+
+#### Overrides[​](#overrides "Direct link to Overrides")
+
+```ts
+SharedResourceRequirement.permission
+
+```
 
 ***
 
@@ -59,7 +96,12 @@ required: boolean;
 
 ```
 
-Whether this resource is required (true) or optional (false)
+#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
+
+```ts
+SharedResourceRequirement.required
+
+```
 
 ***
 
@@ -70,7 +112,14 @@ resourceKey: string;
 
 ```
 
-Stable key for machine use (env naming, composite keys, app.yaml). Required.
+Stable key for machine use: deduplication, env naming, composite keys, app.yaml. Required for registry lookup.
+
+#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
+
+```ts
+SharedResourceRequirement.resourceKey
+
+```
 
 ***
 
@@ -81,4 +130,11 @@ type: ResourceType;
 
 ```
 
-Type of Databricks resource required
+Type of Databricks resource required (narrowed to enum)
+
+#### Overrides[​](#overrides-1 "Direct link to Overrides")
+
+```ts
+SharedResourceRequirement.type
+
+```

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

@@ -1,6 +1,6 @@
 # Interface: StreamExecutionSettings
 
-Configuration for streaming execution with default and user-scoped settings
+Execution settings for streaming endpoints. Extends PluginExecutionSettings with SSE stream configuration.
 
 ## Properties[​](#properties "Direct link to Properties")
 

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

@@ -9,6 +9,8 @@ type PluginData<T, U, N> = {
 
 ```
 
+Tuple of plugin class, config, and name. Created by `toPlugin()` and passed to `createApp()`.
+
 ## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
 
 | Type Parameter |

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

@@ -5,6 +5,8 @@ type ToPlugin<T, U, N> = (config?: U) => PluginData<T, U, N>;
 
 ```
 
+Factory function type returned by `toPlugin()`. Accepts optional config and returns a PluginData tuple.
+
 ## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
 
 | Type Parameter         |

package/docs/api/appkit.md

@@ -30,18 +30,18 @@ Core library for building Databricks applications with type-safe SQL queries, pl
 | 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                                                                                                                                                                                                                                     |
+| [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.                                                                                                                                            |
+| [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().                                                                                                                           |
-| [StreamExecutionSettings](./docs/api/appkit/Interface.StreamExecutionSettings.md)                     | Configuration for streaming execution with default and user-scoped settings                                                                                                                                                                                   |
+| [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.                                                                                                                                                                                        |
 
@@ -51,9 +51,9 @@ Core library for building Databricks applications with type-safe SQL queries, pl
 | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
 | [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                                                           |
-| [PluginData](./docs/api/appkit/TypeAlias.PluginData.md)                 | -                                                                                                           |
+| [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.                                          |
-| [ToPlugin](./docs/api/appkit/TypeAlias.ToPlugin.md)                     | -                                                                                                           |
+| [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")