@databricks/appkit-ui 0.72.0 → 0.73.0

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

@@ -0,0 +1,173 @@
+# Interface: EntityMutationHooks\<TTable>
+
+Mutation lifecycle for one entity. A before hook may return a replacement payload, which is revalidated against the trusted schema before it is persisted. Every hook, the mutation, and any write a hook issues through `ctx.app.database` share one transaction, so a rejection anywhere rolls all of them back. Throw `DatabaseValidationError` to answer a generated route with `422`; any other failure stays an opaque server error.
+
+## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
+
+| Type Parameter              | Default type |
+| --------------------------- | ------------ |
+| `TTable` *extends* `string` | `string`     |
+
+## Methods[​](#methods "Direct link to Methods")
+
+### afterCreate()?[​](#aftercreate "Direct link to afterCreate()?")
+
+```ts
+optional afterCreate(row: FacetOf<TTable, "row">, context: HookContext): MaybePromise<void>;
+
+```
+
+#### Parameters[​](#parameters "Direct link to Parameters")
+
+| Parameter | Type                                                              |
+| --------- | ----------------------------------------------------------------- |
+| `row`     | `FacetOf`<`TTable`, `"row"`>                                      |
+| `context` | [`HookContext`](./docs/api/appkit/Interface.HookContext.md) |
+
+#### Returns[​](#returns "Direct link to Returns")
+
+`MaybePromise`<`void`>
+
+***
+
+### afterDelete()?[​](#afterdelete "Direct link to afterDelete()?")
+
+```ts
+optional afterDelete(id: IdValue, context: HookContext): MaybePromise<void>;
+
+```
+
+#### Parameters[​](#parameters-1 "Direct link to Parameters")
+
+| Parameter | Type                                                              |
+| --------- | ----------------------------------------------------------------- |
+| `id`      | `IdValue`                                                         |
+| `context` | [`HookContext`](./docs/api/appkit/Interface.HookContext.md) |
+
+#### Returns[​](#returns-1 "Direct link to Returns")
+
+`MaybePromise`<`void`>
+
+***
+
+### afterUpdate()?[​](#afterupdate "Direct link to afterUpdate()?")
+
+```ts
+optional afterUpdate(row: FacetOf<TTable, "row">, context: HookContext): MaybePromise<void>;
+
+```
+
+#### Parameters[​](#parameters-2 "Direct link to Parameters")
+
+| Parameter | Type                                                              |
+| --------- | ----------------------------------------------------------------- |
+| `row`     | `FacetOf`<`TTable`, `"row"`>                                      |
+| `context` | [`HookContext`](./docs/api/appkit/Interface.HookContext.md) |
+
+#### Returns[​](#returns-2 "Direct link to Returns")
+
+`MaybePromise`<`void`>
+
+***
+
+### afterUpsert()?[​](#afterupsert "Direct link to afterUpsert()?")
+
+```ts
+optional afterUpsert(row: FacetOf<TTable, "row">, context: HookContext): MaybePromise<void>;
+
+```
+
+#### Parameters[​](#parameters-3 "Direct link to Parameters")
+
+| Parameter | Type                                                              |
+| --------- | ----------------------------------------------------------------- |
+| `row`     | `FacetOf`<`TTable`, `"row"`>                                      |
+| `context` | [`HookContext`](./docs/api/appkit/Interface.HookContext.md) |
+
+#### Returns[​](#returns-3 "Direct link to Returns")
+
+`MaybePromise`<`void`>
+
+***
+
+### beforeCreate()?[​](#beforecreate "Direct link to beforeCreate()?")
+
+```ts
+optional beforeCreate(values: FacetOf<TTable, "insert">, context: HookContext): MaybePromise<void | FacetOf<TTable, "insert">>;
+
+```
+
+#### Parameters[​](#parameters-4 "Direct link to Parameters")
+
+| Parameter | Type                                                              |
+| --------- | ----------------------------------------------------------------- |
+| `values`  | `FacetOf`<`TTable`, `"insert"`>                                   |
+| `context` | [`HookContext`](./docs/api/appkit/Interface.HookContext.md) |
+
+#### Returns[​](#returns-4 "Direct link to Returns")
+
+`MaybePromise`<`void` | `FacetOf`<`TTable`, `"insert"`>>
+
+***
+
+### beforeDelete()?[​](#beforedelete "Direct link to beforeDelete()?")
+
+```ts
+optional beforeDelete(id: IdValue, context: HookContext): MaybePromise<void>;
+
+```
+
+#### Parameters[​](#parameters-5 "Direct link to Parameters")
+
+| Parameter | Type                                                              |
+| --------- | ----------------------------------------------------------------- |
+| `id`      | `IdValue`                                                         |
+| `context` | [`HookContext`](./docs/api/appkit/Interface.HookContext.md) |
+
+#### Returns[​](#returns-5 "Direct link to Returns")
+
+`MaybePromise`<`void`>
+
+***
+
+### beforeUpdate()?[​](#beforeupdate "Direct link to beforeUpdate()?")
+
+```ts
+optional beforeUpdate(
+   id: IdValue, 
+   values: FacetOf<TTable, "update">, 
+context: HookContext): MaybePromise<void | FacetOf<TTable, "update">>;
+
+```
+
+#### Parameters[​](#parameters-6 "Direct link to Parameters")
+
+| Parameter | Type                                                              |
+| --------- | ----------------------------------------------------------------- |
+| `id`      | `IdValue`                                                         |
+| `values`  | `FacetOf`<`TTable`, `"update"`>                                   |
+| `context` | [`HookContext`](./docs/api/appkit/Interface.HookContext.md) |
+
+#### Returns[​](#returns-6 "Direct link to Returns")
+
+`MaybePromise`<`void` | `FacetOf`<`TTable`, `"update"`>>
+
+***
+
+### beforeUpsert()?[​](#beforeupsert "Direct link to beforeUpsert()?")
+
+```ts
+optional beforeUpsert(values: FacetOf<TTable, "insert">, context: HookContext): MaybePromise<void | FacetOf<TTable, "insert">>;
+
+```
+
+#### Parameters[​](#parameters-7 "Direct link to Parameters")
+
+| Parameter | Type                                                              |
+| --------- | ----------------------------------------------------------------- |
+| `values`  | `FacetOf`<`TTable`, `"insert"`>                                   |
+| `context` | [`HookContext`](./docs/api/appkit/Interface.HookContext.md) |
+
+#### Returns[​](#returns-7 "Direct link to Returns")
+
+`MaybePromise`<`void` | `FacetOf`<`TTable`, `"insert"`>>

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

@@ -15,6 +15,34 @@ Target agent id. Defaults to the eval's parent `server/agents/<id>` dir.
 
 ***
 
+### dataset?[​](#dataset "Direct link to dataset?")
+
+```ts
+optional dataset: {
+  limit?: number;
+  table: string;
+};
+
+```
+
+Run this eval once per row of a Databricks managed evaluation dataset (a Unity Catalog `catalog.schema.table` with `inputs`/`expectations` columns). Each row is bound to `t.input`/`t.expected`. Requires the runner to have a workspace client + warehouse (`--warehouse-id`). Omit for a single-run eval.
+
+#### limit?[​](#limit "Direct link to limit?")
+
+```ts
+optional limit: number;
+
+```
+
+#### table[​](#table "Direct link to table")
+
+```ts
+table: string;
+
+```
+
+***
+
 ### description?[​](#description "Direct link to description?")
 
 ```ts

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

@@ -4,6 +4,21 @@ Abstraction over how the agent is driven. The HTTP driver posts to a running app
 
 ## Methods[​](#methods "Direct link to Methods")
 
+### reset()?[​](#reset "Direct link to reset()?")
+
+```ts
+optional reset(): void;
+
+```
+
+Drop the current conversation so the next `send` starts a fresh thread. Optional: drivers without a session concept omit it.
+
+#### Returns[​](#returns "Direct link to Returns")
+
+`void`
+
+***
+
 ### send()[​](#send "Direct link to send()")
 
 ```ts
@@ -17,6 +32,6 @@ send(message: string): Promise<DriveResult>;
 | --------- | -------- |
 | `message` | `string` |
 
-#### Returns[​](#returns "Direct link to Returns")
+#### Returns[​](#returns-1 "Direct link to Returns")
 
 `Promise`<[`DriveResult`](./docs/api/appkit/Interface.DriveResult.md)>

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

@@ -0,0 +1,12 @@
+# Interface: HookApp
+
+The only capability a hook receives: entities bound to its transaction.
+
+## Properties[​](#properties "Direct link to Properties")
+
+### database[​](#database "Direct link to database")
+
+```ts
+readonly database: TransactionClient;
+
+```

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

@@ -0,0 +1,21 @@
+# Interface: HookContext
+
+Which entity is being mutated, and the surface a hook may write through.
+
+## Properties[​](#properties "Direct link to Properties")
+
+### app[​](#app "Direct link to app")
+
+```ts
+readonly app: HookApp;
+
+```
+
+***
+
+### entity[​](#entity "Direct link to entity")
+
+```ts
+readonly entity: string;
+
+```

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

@@ -0,0 +1,34 @@
+# Interface: ReadEvalDatasetOptions
+
+## Properties[​](#properties "Direct link to Properties")
+
+### limit?[​](#limit "Direct link to limit?")
+
+```ts
+optional limit: number;
+
+```
+
+Optional row cap.
+
+***
+
+### table[​](#table "Direct link to table")
+
+```ts
+table: string;
+
+```
+
+Fully-qualified UC table: `catalog.schema.table`.
+
+***
+
+### warehouseId[​](#warehouseid "Direct link to warehouseId")
+
+```ts
+warehouseId: string;
+
+```
+
+SQL warehouse id to run the read against.

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

@@ -0,0 +1,21 @@
+# Interface: ReadSerializerContext
+
+Which entity and generated operation produced the row being shaped.
+
+## Properties[​](#properties "Direct link to Properties")
+
+### entity[​](#entity "Direct link to entity")
+
+```ts
+readonly entity: string;
+
+```
+
+***
+
+### operation[​](#operation "Direct link to operation")
+
+```ts
+readonly operation: "detail" | "list";
+
+```

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

@@ -24,6 +24,17 @@ Stable id for the eval (e.g. its file path relative to the evals dir).
 
 ***
 
+### row?[​](#row "Direct link to row?")
+
+```ts
+optional row: DatasetRow;
+
+```
+
+Dataset row bound to `t.input`/`t.expected` for dataset-driven evals.
+
+***
+
 ### strict?[​](#strict "Direct link to strict?")
 
 ```ts

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

@@ -190,3 +190,25 @@ optional timeoutMs: number;
 ```
 
 Per-turn wall-clock timeout (ms) before a turn is failed. Defaults to 120s.
+
+***
+
+### warehouseId?[​](#warehouseid "Direct link to warehouseId?")
+
+```ts
+optional warehouseId: string;
+
+```
+
+SQL warehouse id used to read managed evaluation datasets.
+
+***
+
+### workspaceClient?[​](#workspaceclient "Direct link to workspaceClient?")
+
+```ts
+optional workspaceClient: WorkspaceClient;
+
+```
+
+Workspace client used to read managed evaluation datasets (for evals that declare `dataset`). Required alongside [warehouseId](#warehouseid) for those evals.

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

@@ -4,6 +4,28 @@ The `t` context passed to an eval's `test` function.
 
 ## Properties[​](#properties "Direct link to Properties")
 
+### expected[​](#expected "Direct link to expected")
+
+```ts
+readonly expected: Record<string, unknown> | undefined;
+
+```
+
+The current dataset row's `expectations` (ground truth / guidelines), or `undefined` when the row has none or the eval isn't dataset-driven.
+
+***
+
+### input[​](#input "Direct link to input")
+
+```ts
+readonly input: Record<string, unknown>;
+
+```
+
+The current dataset row's `inputs` when the eval is dataset-driven (see [EvalDefinition.dataset](./docs/api/appkit/Interface.EvalDefinition.md#dataset)); `{}` for a plain single-run eval.
+
+***
+
 ### judge[​](#judge "Direct link to judge")
 
 ```ts
@@ -15,7 +37,7 @@ judge: {
 
 ```
 
-LLM-as-judge scoring of the last reply (via autoevals → a Databricks judge model). Each returns a scored, soft-by-default assertion; chain `.atLeast(n)` to set the pass threshold or `.gate()` to make it a hard gate. Requires the judge to be configured (`--judge-model`).
+LLM-as-judge scoring of the last reply (via autoevals → a Databricks judge model). Each returns a scored assertion that gates by default (a miss fails the eval); chain `.atLeast(n)` to change the pass threshold or `.soft()` to demote to a tracked-only metric. Requires the judge to be configured (`--judge-model`).
 
 #### closedQA()[​](#closedqa "Direct link to closedQA()")
 
@@ -152,6 +174,21 @@ Assert a value against a matcher, e.g. `t.check(t.reply, includes("Sunny"))`.
 
 ***
 
+### reset()[​](#reset "Direct link to reset()")
+
+```ts
+reset(): void;
+
+```
+
+Start a fresh conversation: the next `send` opens a new thread with no history. Use to run several independent one-shot checks in one test. Consecutive `send`s (without a `reset`) stay in one multi-turn conversation.
+
+#### Returns[​](#returns-5 "Direct link to Returns")
+
+`void`
+
+***
+
 ### send()[​](#send "Direct link to send()")
 
 ```ts
@@ -167,7 +204,7 @@ Send a user message to the agent and capture its response.
 | --------- | -------- |
 | `message` | `string` |
 
-#### Returns[​](#returns-5 "Direct link to Returns")
+#### Returns[​](#returns-6 "Direct link to Returns")
 
 `Promise`<`void`>
 
@@ -188,7 +225,7 @@ Skip this eval with an optional reason.
 | --------- | -------- |
 | `reason?` | `string` |
 
-#### Returns[​](#returns-6 "Direct link to Returns")
+#### Returns[​](#returns-7 "Direct link to Returns")
 
 `never`
 
@@ -203,6 +240,6 @@ succeeded(): AssertionHandle;
 
 Assert the last turn completed successfully (gate by default).
 
-#### Returns[​](#returns-7 "Direct link to Returns")
+#### Returns[​](#returns-8 "Direct link to Returns")
 
 [`AssertionHandle`](./docs/api/appkit/Interface.AssertionHandle.md)

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

@@ -0,0 +1,53 @@
+# Type Alias: DatabaseApiConfig\<TSchema>
+
+```ts
+type DatabaseApiConfig<TSchema> = 
+  | boolean
+  | {
+  tables?: readonly SchemaTableName<TSchema>[];
+  writes?: DatabaseApiWritesConfig<TSchema>;
+};
+
+```
+
+Full generated CRUD for every declared table by default. Set false to disable all generated routes, or use an object to restrict tables and writes. Keyed routes require a public primary key; upsert stays programmatic. Route names must start with a letter, contain only letters, digits, `_`, or `-`, be at most 64 characters, and be unique ignoring case. Invalid names fail setup; exclude internal tables with `api.tables` or use `api: false`.
+
+Routes run as the app's service principal and apply no per-user filter, so anyone the app admits receives every enabled operation. An exposed table also becomes includable from its neighbours; a relation whose target stays off cannot be included.
+
+Text filters accept caller-supplied `like`/`ilike` patterns; a server-side `statement_timeout` cancels a pattern that would otherwise hold its pooled connection to completion.
+
+## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
+
+| Type Parameter                                                              |
+| --------------------------------------------------------------------------- |
+| `TSchema` *extends* [`Schema`](./docs/api/appkit/Interface.Schema.md) |
+
+## Type Declaration[​](#type-declaration "Direct link to Type Declaration")
+
+`boolean`
+
+```ts
+{
+  tables?: readonly SchemaTableName<TSchema>[];
+  writes?: DatabaseApiWritesConfig<TSchema>;
+}
+
+```
+
+### tables?[​](#tables "Direct link to tables?")
+
+```ts
+readonly optional tables: readonly SchemaTableName<TSchema>[];
+
+```
+
+Tables that remain exposed. Defaults to every declared table.
+
+### writes?[​](#writes "Direct link to writes?")
+
+```ts
+readonly optional writes: DatabaseApiWritesConfig<TSchema>;
+
+```
+
+All writes by default. Set false for read-only routes.

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

@@ -0,0 +1,8 @@
+# Type Alias: DatabaseApiWriteOperation
+
+```ts
+type DatabaseApiWriteOperation = "create" | "update" | "delete";
+
+```
+
+Generated HTTP write operations.

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

@@ -0,0 +1,49 @@
+# Type Alias: DatabaseApiWritesConfig\<TSchema>
+
+```ts
+type DatabaseApiWritesConfig<TSchema> = 
+  | boolean
+  | {
+  operations?: readonly DatabaseApiWriteOperation[];
+  tables?: readonly SchemaTableName<TSchema>[];
+};
+
+```
+
+All writes by default; false keeps reads only, and an object narrows writes.
+
+## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
+
+| Type Parameter                                                              |
+| --------------------------------------------------------------------------- |
+| `TSchema` *extends* [`Schema`](./docs/api/appkit/Interface.Schema.md) |
+
+## Type Declaration[​](#type-declaration "Direct link to Type Declaration")
+
+`boolean`
+
+```ts
+{
+  operations?: readonly DatabaseApiWriteOperation[];
+  tables?: readonly SchemaTableName<TSchema>[];
+}
+
+```
+
+### operations?[​](#operations "Direct link to operations?")
+
+```ts
+readonly optional operations: readonly DatabaseApiWriteOperation[];
+
+```
+
+Operations that remain enabled. Defaults to create, update, and delete.
+
+### tables?[​](#tables "Direct link to tables?")
+
+```ts
+readonly optional tables: readonly SchemaTableName<TSchema>[];
+
+```
+
+Tables that remain writable. Defaults to every exposed table.

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

@@ -26,9 +26,9 @@ transaction<T>(callback: (tx: TransactionClient) => Promise<T>): Promise<T>;
 
 #### Parameters[​](#parameters "Direct link to Parameters")
 
-| Parameter  | Type                                          |
-| ---------- | --------------------------------------------- |
-| `callback` | (`tx`: `TransactionClient`) => `Promise`<`T`> |
+| Parameter  | Type                                                                                                    |
+| ---------- | ------------------------------------------------------------------------------------------------------- |
+| `callback` | (`tx`: [`TransactionClient`](./docs/api/appkit/TypeAlias.TransactionClient.md)) => `Promise`<`T`> |
 
 #### Returns[​](#returns "Direct link to Returns")
 

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

@@ -0,0 +1,25 @@
+# Type Alias: EntityHooks\<TTable>
+
+```ts
+type EntityHooks<TTable> = EntityMutationHooks<TTable> & {
+  serialize?: ReadSerializer;
+};
+
+```
+
+Response shaping and mutation lifecycle declared for one table.
+
+## Type Declaration[​](#type-declaration "Direct link to Type Declaration")
+
+### serialize?[​](#serialize "Direct link to serialize?")
+
+```ts
+readonly optional serialize: ReadSerializer;
+
+```
+
+## Type Parameters[​](#type-parameters "Direct link to Type Parameters")
+
+| Type Parameter              | Default type |
+| --------------------------- | ------------ |
+| `TTable` *extends* `string` | `string`     |

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

@@ -2,8 +2,8 @@
 
 ```ts
 type IDatabaseConfig<TSchema> = {
-  crudRoutes?: CrudRoutesConfig<TSchema>;
-  hooks?: { readonly [TTable in SchemaTableName<TSchema>]?: { serialize?: ReadSerializer } };
+  api?: DatabaseApiConfig<TSchema>;
+  hooks?: { readonly [TTable in SchemaTableName<TSchema>]?: EntityHooks<TTable> };
   schema: TSchema;
 };
 
@@ -19,10 +19,21 @@ Configuration for one schema-bound DatabasePlugin instance.
 
 ## Properties[​](#properties "Direct link to Properties")
 
-### crudRoutes?[​](#crudroutes "Direct link to crudRoutes?")
+### api?[​](#api "Direct link to api?")
 
 ```ts
-readonly optional crudRoutes: CrudRoutesConfig<TSchema>;
+readonly optional api: DatabaseApiConfig<TSchema>;
+
+```
+
+Generated HTTP CRUD is enabled for all tables by default, using the app's service principal. Every admitted caller receives the enabled operations; no per-user or per-row authorization is applied. This plugin does not support OBO. Use custom routes for application-specific authorization.
+
+Set `false` to disable routes, `{ writes: false }` for reads only, or `{ tables: ["notes"] }` to expose only selected tables. To disable delete, use `{ writes: { operations: ["create", "update"] } }`.
+
+#### Default Value[​](#default-value "Direct link to Default Value")
+
+```ts
+true
 
 ```
 
@@ -31,7 +42,7 @@ readonly optional crudRoutes: CrudRoutesConfig<TSchema>;
 ### hooks?[​](#hooks "Direct link to hooks?")
 
 ```ts
-readonly optional hooks: { readonly [TTable in SchemaTableName<TSchema>]?: { serialize?: ReadSerializer } };
+readonly optional hooks: { readonly [TTable in SchemaTableName<TSchema>]?: EntityHooks<TTable> };
 
 ```
 

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

@@ -0,0 +1,19 @@
+# Type Alias: ReadSerializer()
+
+```ts
+type ReadSerializer = (row: Record<string, unknown>, context: ReadSerializerContext) => Record<string, unknown>;
+
+```
+
+Shape one already private-safe row before it reaches the wire. A `Promise` is not assignable to the return type, so an async callback fails to compile: serializers run inside the response path and must not add latency there.
+
+## Parameters[​](#parameters "Direct link to Parameters")
+
+| Parameter | Type                                                                                  |
+| --------- | ------------------------------------------------------------------------------------- |
+| `row`     | `Record`<`string`, `unknown`>                                                         |
+| `context` | [`ReadSerializerContext`](./docs/api/appkit/Interface.ReadSerializerContext.md) |
+
+## Returns[​](#returns "Direct link to Returns")
+
+`Record`<`string`, `unknown`>