@databricks/appkit 0.72.0 → 0.74.0

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`>

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

@@ -0,0 +1,19 @@
+# Type Alias: TransactionClient
+
+```ts
+type TransactionClient = { readonly [K in EntityName]: TypedEntityClient<K> } & {
+  sql: SqlTag;
+};
+
+```
+
+Entity and SQL capabilities bound to one transaction.
+
+## Type Declaration[​](#type-declaration "Direct link to Type Declaration")
+
+### sql[​](#sql "Direct link to sql")
+
+```ts
+readonly sql: SqlTag;
+
+```