@databricks/appkit-ui 0.96.0 → 0.97.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/CLAUDE.md +16 -7
  2. package/dist/js/database/client.d.ts +2 -2
  3. package/dist/js/database/client.js +1 -1
  4. package/dist/js/database/client.js.map +1 -1
  5. package/dist/react/beta.d.ts +2 -2
  6. package/dist/react/beta.js +1 -2
  7. package/dist/react/hooks/use-database-list.d.ts +4 -4
  8. package/dist/react/hooks/use-database-list.d.ts.map +1 -1
  9. package/dist/react/hooks/use-database-list.js +1 -2
  10. package/dist/react/hooks/use-database-list.js.map +1 -1
  11. package/dist/react/hooks/use-database-read.d.ts +4 -41
  12. package/dist/react/hooks/use-database-read.d.ts.map +1 -1
  13. package/dist/react/hooks/use-database-read.js +7 -68
  14. package/dist/react/hooks/use-database-read.js.map +1 -1
  15. package/dist/react/hooks/use-database-record.d.ts +3 -3
  16. package/dist/react/hooks/use-database-record.d.ts.map +1 -1
  17. package/dist/react/hooks/use-database-record.js +2 -3
  18. package/dist/react/hooks/use-database-record.js.map +1 -1
  19. package/dist/react/hooks/use-database-write.d.ts +3 -3
  20. package/dist/react/hooks/use-database-write.js.map +1 -1
  21. package/dist/shared/src/database/api-types.d.ts +1 -4
  22. package/dist/shared/src/database/api-types.d.ts.map +1 -1
  23. package/dist/shared/src/database/index.d.ts +3 -0
  24. package/dist/shared/src/database/operations.d.ts +11 -0
  25. package/dist/shared/src/database/operations.d.ts.map +1 -0
  26. package/dist/shared/src/index.d.ts +1 -0
  27. package/dist/workspace-client/modular.d.ts.map +1 -1
  28. package/dist/workspace-client/modular.js +19 -2
  29. package/dist/workspace-client/modular.js.map +1 -1
  30. package/docs/api/appkit/Class.DatabaseValidationError.md +1 -1
  31. package/docs/api/appkit/Function.defineOperation.md +61 -0
  32. package/docs/api/appkit/Function.definePolicy.md +52 -0
  33. package/docs/api/appkit/Function.defineSchema.md +1 -1
  34. package/docs/api/appkit/Interface.Actor.md +21 -0
  35. package/docs/api/appkit/Interface.DatabaseOperationContract.md +30 -0
  36. package/docs/api/appkit/Interface.DatabaseRoutes.md +30 -0
  37. package/docs/api/appkit/Interface.OperationContext.md +75 -0
  38. package/docs/api/appkit/Interface.OperationDefinition.md +77 -0
  39. package/docs/api/appkit/Interface.PolicyContext.md +49 -0
  40. package/docs/api/appkit/Interface.PolicyDenial.md +21 -0
  41. package/docs/api/appkit/TypeAlias.DatabricksAppKitDatabaseOperations.md +8 -0
  42. package/docs/api/appkit/TypeAlias.IDatabaseConfig.md +0 -10
  43. package/docs/api/appkit/TypeAlias.OperationMethod.md +8 -0
  44. package/docs/api/appkit/TypeAlias.OperationWireInput.md +14 -0
  45. package/docs/api/appkit/TypeAlias.OperationWireOutput.md +14 -0
  46. package/docs/api/appkit/TypeAlias.Policy.md +15 -0
  47. package/docs/api/appkit/TypeAlias.PolicyDecision.md +8 -0
  48. package/docs/api/appkit.md +60 -51
  49. package/docs/plugins/database.md +17 -70
  50. package/llms.txt +16 -7
  51. package/package.json +1 -1
  52. package/sbom.cdx.json +1 -1
  53. package/docs/api/appkit/Interface.EntityMutationHooks.md +0 -173
  54. package/docs/api/appkit/Interface.HookApp.md +0 -12
  55. package/docs/api/appkit/Interface.HookContext.md +0 -21
  56. package/docs/api/appkit/Interface.ReadSerializerContext.md +0 -21
  57. package/docs/api/appkit/TypeAlias.EntityHooks.md +0 -25
  58. package/docs/api/appkit/TypeAlias.ReadSerializer.md +0 -19
package/llms.txt CHANGED
@@ -72,7 +72,7 @@ npx @databricks/appkit docs <query>
72
72
  - [Class: AuthenticationError](./docs/api/appkit/Class.AuthenticationError.md): Error thrown when authentication fails.
73
73
  - [Class: ConfigurationError](./docs/api/appkit/Class.ConfigurationError.md): Error thrown when configuration is missing or invalid.
74
74
  - [Class: ConnectionError](./docs/api/appkit/Class.ConnectionError.md): Error thrown when a connection or network operation fails.
75
- - [Class: DatabaseValidationError](./docs/api/appkit/Class.DatabaseValidationError.md): Deliberate validation failure raised by a database mutation hook. Generated
75
+ - [Class: DatabaseValidationError](./docs/api/appkit/Class.DatabaseValidationError.md): Deliberate validation failure. An explicit transaction callback can throw it,
76
76
  - [Class: DatabricksAdapter](./docs/api/appkit/Class.DatabricksAdapter.md): Adapter that talks directly to Databricks Model Serving /invocations endpoint.
77
77
  - [Class: ExecutionError](./docs/api/appkit/Class.ExecutionError.md): Error thrown when an operation execution fails.
78
78
  - [Class: IdentityExpiredError](./docs/api/appkit/Class.IdentityExpiredError.md): The downstream service rejected the active caller's credentials.
@@ -106,6 +106,8 @@ npx @databricks/appkit docs <query>
106
106
  - [Function: defineEval()](./docs/api/appkit/Function.defineEval.md): Define an agent eval. Default-export the result from a
107
107
  - [Function: defineEvalConfig()](./docs/api/appkit/Function.defineEvalConfig.md): Define per-directory eval config. Default-export from evals.config.ts.
108
108
  - [Function: defineManifest()](./docs/api/appkit/Function.defineManifest.md): Validates a raw manifest (typically a manifest.json import) against the
109
+ - [Function: defineOperation()](./docs/api/appkit/Function.defineOperation.md): Call Signature
110
+ - [Function: definePolicy()](./docs/api/appkit/Function.definePolicy.md): Call Signature
109
111
  - [Function: defineSchema()](./docs/api/appkit/Function.defineSchema.md): Compile one declared schema. The returned type keeps the table names the
110
112
  - [Function: defineTool()](./docs/api/appkit/Function.defineTool.md): Defines a single tool entry for a plugin's internal registry.
111
113
  - [Function: discoverEvalConfigs()](./docs/api/appkit/Function.discoverEvalConfigs.md): Discover the per-agent evals.config.ts (from defineEvalConfig) at
@@ -178,6 +180,7 @@ npx @databricks/appkit docs <query>
178
180
  - [Function: userTurns()](./docs/api/appkit/Function.userTurns.md): Extract every user-message content, in order, from an MLflow
179
181
  - [Function: uuid()](./docs/api/appkit/Function.uuid.md): Returns
180
182
  - [Function: varchar()](./docs/api/appkit/Function.varchar.md): Parameters
183
+ - [Interface: Actor](./docs/api/appkit/Interface.Actor.md): The authenticated caller. The HTTP boundary resolves it before any policy runs.
181
184
  - [Interface: AgentAdapter](./docs/api/appkit/Interface.AgentAdapter.md): Properties
182
185
  - [Interface: AgentDefinition](./docs/api/appkit/Interface.AgentDefinition.md): Properties
183
186
  - [Interface: AgentInput](./docs/api/appkit/Interface.AgentInput.md): Properties
@@ -193,7 +196,9 @@ npx @databricks/appkit docs <query>
193
196
  - [Interface: CallerContext](./docs/api/appkit/Interface.CallerContext.md): Caller identity and workspace for one immutable execution scope.
194
197
  - [Interface: CustomJudgeSpec](./docs/api/appkit/Interface.CustomJudgeSpec.md): A custom LLM-judge definition: a prompt template and choice→score mapping.
195
198
  - [Interface: DatabaseCredential](./docs/api/appkit/Interface.DatabaseCredential.md): Database credentials with OAuth token for Postgres connection
199
+ - [Interface: DatabaseOperationContract](./docs/api/appkit/Interface.DatabaseOperationContract.md): The browser-safe contract of one generated operation. input and output
196
200
  - [Interface: DatabaseRegistry](./docs/api/appkit/Interface.DatabaseRegistry.md): CANONICAL augmentation target. Empty by default; the generated database.d.ts
201
+ - [Interface: DatabaseRoutes](./docs/api/appkit/Interface.DatabaseRoutes.md): The generated route entry. schema and each module stay lazy, so importing
197
202
  - [Interface: DatabaseValidationIssue](./docs/api/appkit/Interface.DatabaseValidationIssue.md): One rejected field; path names public columns, never their values.
198
203
  - [Interface: DatabricksAuth](./docs/api/appkit/Interface.DatabricksAuth.md): Resolved Databricks host + bearer token for the eval runner's REST calls.
199
204
  - [Interface: DatasetRow](./docs/api/appkit/Interface.DatasetRow.md): One row of a managed evaluation dataset. inputs are the kwargs passed to the
@@ -203,7 +208,6 @@ npx @databricks/appkit docs <query>
203
208
  - [Interface: DownloadResponse](./docs/api/appkit/Interface.DownloadResponse.md): Response object for file downloads containing a readable stream.
204
209
  - [Interface: DriveResult](./docs/api/appkit/Interface.DriveResult.md): What a driver returns for a single t.send.
205
210
  - [Interface: EndpointConfig](./docs/api/appkit/Interface.EndpointConfig.md): Properties
206
- - [Interface: EntityMutationHooks<TTable>](./docs/api/appkit/Interface.EntityMutationHooks.md): Mutation lifecycle for one entity. A before hook may return a replacement
207
211
  - [Interface: EvalDefinition](./docs/api/appkit/Interface.EvalDefinition.md): A single eval, default-exported from a *.eval.ts file.
208
212
  - [Interface: EvalDriver](./docs/api/appkit/Interface.EvalDriver.md): Abstraction over how the agent is driven. The HTTP driver posts to a running
209
213
  - [Interface: EvalResult](./docs/api/appkit/Interface.EvalResult.md): The outcome of running one eval.
@@ -215,8 +219,6 @@ npx @databricks/appkit docs <query>
215
219
  - [Interface: FunctionTool](./docs/api/appkit/Interface.FunctionTool.md): Properties
216
220
  - [Interface: GenerateDatabaseCredentialRequest](./docs/api/appkit/Interface.GenerateDatabaseCredentialRequest.md): Request parameters for generating database OAuth credentials
217
221
  - [Interface: GenerationParams](./docs/api/appkit/Interface.GenerationParams.md): Optional generation parameters forwarded to the OpenAI-compatible serving
218
- - [Interface: HookApp](./docs/api/appkit/Interface.HookApp.md): The only capability a hook receives: entities bound to its transaction.
219
- - [Interface: HookContext](./docs/api/appkit/Interface.HookContext.md): Which entity is being mutated, and the surface a hook may write through.
220
222
  - [Interface: HostedSupervisorTool](./docs/api/appkit/Interface.HostedSupervisorTool.md): Tagged record returned by every supervisorTools factory. The
221
223
  - [Interface: HttpDriverOptions](./docs/api/appkit/Interface.HttpDriverOptions.md): Properties
222
224
  - [Interface: IAiSearchConfig](./docs/api/appkit/Interface.IAiSearchConfig.md): Base configuration interface for AppKit plugins
@@ -234,12 +236,15 @@ npx @databricks/appkit docs <query>
234
236
  - [Interface: MatchResult](./docs/api/appkit/Interface.MatchResult.md): Result of a deterministic matcher run against a value.
235
237
  - [Interface: McpConnectAllResult](./docs/api/appkit/Interface.McpConnectAllResult.md): Per-endpoint outcome of AppKitMcpClient.connectAll. Callers (the
236
238
  - [Interface: Message](./docs/api/appkit/Interface.Message.md): Properties
239
+ - [Interface: OperationContext<In, R>](./docs/api/appkit/Interface.OperationContext.md): What allow and execute receive: the policy context and the loaded resource.
240
+ - [Interface: OperationDefinition<M, I, O, R, Name>](./docs/api/appkit/Interface.OperationDefinition.md): One immutable operation descriptor. Nothing in it runs until a request does.
237
241
  - [Interface: PluginManifest<TName>](./docs/api/appkit/Interface.PluginManifest.md): Plugin manifest that declares metadata and resource requirements.
238
242
  - [Interface: PluginToolkitProvider](./docs/api/appkit/Interface.PluginToolkitProvider.md): Minimum shape every entry in the Plugins map must expose. Core
243
+ - [Interface: PolicyContext<In>](./docs/api/appkit/Interface.PolicyContext.md): What every authorization callback receives, the resource lookup included.
244
+ - [Interface: PolicyDenial](./docs/api/appkit/Interface.PolicyDenial.md): An explicit refusal. reason stays on the server; HTTP and logs do not receive it.
239
245
  - [Interface: PostResult](./docs/api/appkit/Interface.PostResult.md): Structured result for a best-effort POST that must not throw.
240
246
  - [Interface: PromptContext](./docs/api/appkit/Interface.PromptContext.md): Context passed to baseSystemPrompt callbacks.
241
247
  - [Interface: ReadEvalDatasetOptions](./docs/api/appkit/Interface.ReadEvalDatasetOptions.md): Properties
242
- - [Interface: ReadSerializerContext](./docs/api/appkit/Interface.ReadSerializerContext.md): Which entity and generated operation produced the row being shaped.
243
248
  - [Interface: RegisteredAgent](./docs/api/appkit/Interface.RegisteredAgent.md): Properties
244
249
  - [Interface: ReportOutcome](./docs/api/appkit/Interface.ReportOutcome.md): Properties
245
250
  - [Interface: RequestedClaims](./docs/api/appkit/Interface.RequestedClaims.md): Optional claims for fine-grained Unity Catalog table permissions
@@ -287,7 +292,7 @@ npx @databricks/appkit docs <query>
287
292
  - [Type Alias: DatabaseApiWriteOperation](./docs/api/appkit/TypeAlias.DatabaseApiWriteOperation.md): Generated HTTP write operations.
288
293
  - [Type Alias: DatabaseApiWritesConfig<TSchema>](./docs/api/appkit/TypeAlias.DatabaseApiWritesConfig.md): All writes by default; false keeps reads only, and an object narrows writes.
289
294
  - [Type Alias: DatabaseExports](./docs/api/appkit/TypeAlias.DatabaseExports.md): Typed database API published by the plugin.
290
- - [Type Alias: EntityHooks<TTable>](./docs/api/appkit/TypeAlias.EntityHooks.md): Response shaping and mutation lifecycle declared for one table.
295
+ - [Type Alias: DatabricksAppKitDatabaseOperations](./docs/api/appkit/TypeAlias.DatabricksAppKitDatabaseOperations.md): The same global registry, available as a module type for package exports.
291
296
  - [Type Alias: EvalProgress](./docs/api/appkit/TypeAlias.EvalProgress.md)
292
297
  - [Type Alias: ExecutionContext](./docs/api/appkit/TypeAlias.ExecutionContext.md)
293
298
  - [Type Alias: ExecutionResult<T>](./docs/api/appkit/TypeAlias.ExecutionResult.md): Discriminated union for plugin execution results.
@@ -300,9 +305,13 @@ npx @databricks/appkit docs <query>
300
305
  - [Type Alias: IDatabaseConfig<TSchema>](./docs/api/appkit/TypeAlias.IDatabaseConfig.md): Configuration for one schema-bound DatabasePlugin instance.
301
306
  - [Type Alias: JobsExport()](./docs/api/appkit/TypeAlias.JobsExport.md): Public API shape of the jobs plugin.
302
307
  - [Type Alias: Matcher()](./docs/api/appkit/TypeAlias.Matcher.md): A deterministic matcher: inspects a string value and returns a result.
308
+ - [Type Alias: OperationMethod](./docs/api/appkit/TypeAlias.OperationMethod.md): HTTP methods an operation can answer; the browser client reads the same union.
309
+ - [Type Alias: OperationWireInput<Operation>](./docs/api/appkit/TypeAlias.OperationWireInput.md): The JSON a caller sends to an operation; a bigint travels as a string or safe integer.
310
+ - [Type Alias: OperationWireOutput<Operation>](./docs/api/appkit/TypeAlias.OperationWireOutput.md): The JSON a successful call answers with; without an output schema there is none.
303
311
  - [Type Alias: PluginData<T, U, N>](./docs/api/appkit/TypeAlias.PluginData.md): Tuple of plugin class, config, and name. Created by toPlugin() and passed to createApp().
304
312
  - [Type Alias: Plugins](./docs/api/appkit/TypeAlias.Plugins.md): Plugin map passed to the function form of AgentDefinition.tools.
305
- - [Type Alias: ReadSerializer()](./docs/api/appkit/TypeAlias.ReadSerializer.md): Shape one already private-safe row before it reaches the wire. A Promise
313
+ - [Type Alias: Policy<In, R>](./docs/api/appkit/TypeAlias.Policy.md): A reusable authorization rule, with or without a resource lookup.
314
+ - [Type Alias: PolicyDecision](./docs/api/appkit/TypeAlias.PolicyDecision.md): Only literal true admits. False and an explicit denial refuse.
306
315
  - [Type Alias: ResolvedToolEntry](./docs/api/appkit/TypeAlias.ResolvedToolEntry.md): Internal tool-index entry after a tool record has been resolved to a dispatchable form.
307
316
  - [Type Alias: ResourceFieldEntry](./docs/api/appkit/TypeAlias.ResourceFieldEntry.md)
308
317
  - [Type Alias: ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md): Union of all possible permission levels across all resource types.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@databricks/appkit-ui",
3
3
  "type": "module",
4
- "version": "0.96.0",
4
+ "version": "0.97.1",
5
5
  "license": "Apache-2.0",
6
6
  "sideEffects": [
7
7
  "**/*.css"