@databricks/appkit-ui 0.36.0 → 0.38.0

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 (59) hide show
  1. package/CLAUDE.md +3 -2
  2. package/NOTICE.md +1 -0
  3. package/dist/cli/commands/plugin/add-resource/add-resource.js.map +1 -1
  4. package/dist/cli/commands/plugin/create/resource-defaults.js +2 -1
  5. package/dist/cli/commands/plugin/create/resource-defaults.js.map +1 -1
  6. package/dist/cli/commands/plugin/schema-resources.js +34 -51
  7. package/dist/cli/commands/plugin/schema-resources.js.map +1 -1
  8. package/dist/cli/commands/plugin/sync/sync.js +20 -6
  9. package/dist/cli/commands/plugin/sync/sync.js.map +1 -1
  10. package/dist/cli/commands/plugin/validate/validate-manifest.js +71 -157
  11. package/dist/cli/commands/plugin/validate/validate-manifest.js.map +1 -1
  12. package/dist/cli/commands/plugin/validate/validate.js +2 -2
  13. package/dist/cli/commands/plugin/validate/validate.js.map +1 -1
  14. package/dist/cli/commands/setup.js +2 -2
  15. package/dist/cli/commands/setup.js.map +1 -1
  16. package/dist/react/charts/options.js +2 -1
  17. package/dist/react/charts/options.js.map +1 -1
  18. package/dist/react/hooks/index.d.ts +1 -0
  19. package/dist/react/hooks/index.js +1 -0
  20. package/dist/react/hooks/use-mobile.d.ts +5 -0
  21. package/dist/react/hooks/use-mobile.d.ts.map +1 -0
  22. package/dist/react/index.d.ts +2 -1
  23. package/dist/react/index.js +2 -1
  24. package/dist/react/table/data-table.js +2 -2
  25. package/dist/react/table/data-table.js.map +1 -1
  26. package/dist/react/ui/sidebar.js +1 -1
  27. package/dist/schemas/manifest.d.ts +1139 -0
  28. package/dist/schemas/manifest.d.ts.map +1 -0
  29. package/dist/schemas/manifest.js +524 -0
  30. package/dist/schemas/manifest.js.map +1 -0
  31. package/dist/shared/src/plugin.d.ts +1 -0
  32. package/dist/shared/src/plugin.d.ts.map +1 -1
  33. package/dist/shared/src/schemas/manifest.d.ts +1 -0
  34. package/docs/api/appkit/Enumeration.ResourceType.md +1 -1
  35. package/docs/api/appkit/Interface.PluginManifest.md +57 -3
  36. package/docs/api/appkit/Interface.ResourceEntry.md +6 -4
  37. package/docs/api/appkit/Interface.ResourceRequirement.md +7 -61
  38. package/docs/api/appkit/TypeAlias.ResourceFieldEntry.md +6 -0
  39. package/docs/api/appkit/Variable.agents.md +1 -1
  40. package/docs/api/appkit.md +12 -12
  41. package/docs/app-management.md +1 -1
  42. package/docs/development/ai-assisted-development.md +2 -2
  43. package/docs/development/local-development.md +1 -1
  44. package/docs/development/remote-bridge.md +1 -1
  45. package/docs/development/templates.md +118 -12
  46. package/docs/development.md +1 -1
  47. package/docs/plugins/agents.md +8 -4
  48. package/docs/plugins/custom-plugins.md +33 -23
  49. package/docs/plugins/lakebase.md +1 -1
  50. package/docs/plugins/manifest.md +293 -0
  51. package/docs.md +2 -2
  52. package/llms.txt +3 -2
  53. package/package.json +5 -4
  54. package/sbom.cdx.json +1 -1
  55. package/dist/schemas/plugin-manifest.generated.d.ts +0 -182
  56. package/dist/schemas/plugin-manifest.generated.d.ts.map +0 -1
  57. package/dist/schemas/plugin-manifest.schema.json +0 -489
  58. package/dist/schemas/template-plugins.schema.json +0 -113
  59. package/docs/api/appkit/Interface.ResourceFieldEntry.md +0 -82
package/llms.txt CHANGED
@@ -52,6 +52,7 @@ npx @databricks/appkit docs <query>
52
52
  - [Genie plugin](./docs/plugins/genie.md): Integrates Databricks AI/BI Genie spaces into your AppKit application, enabling natural language data queries via a conversational interface.
53
53
  - [Jobs plugin](./docs/plugins/jobs.md): Trigger and monitor Databricks Lakeflow Jobs from your AppKit application.
54
54
  - [Lakebase plugin](./docs/plugins/lakebase.md): Provides a PostgreSQL connection pool for Databricks Lakebase Autoscaling with automatic OAuth token refresh.
55
+ - [Plugin manifest](./docs/plugins/manifest.md): Every plugin ships a manifest.json next to its source code. The manifest declares plugin metadata, the Databricks resources the plugin needs, and any structured rules a scaffolding agent must honor when running databricks apps init. It is consumed at three stages:
55
56
  - [Model Serving plugin](./docs/plugins/model-serving.md): Provides an authenticated proxy to Databricks Model Serving endpoints, with invoke and streaming support.
56
57
  - [Plugin management](./docs/plugins/plugin-management.md): AppKit includes a CLI for managing plugins. All commands are available under npx @databricks/appkit plugin.
57
58
  - [Server plugin](./docs/plugins/server.md): Provides HTTP server capabilities with development and production modes.
@@ -76,7 +77,7 @@ npx @databricks/appkit docs <query>
76
77
  - [Class: TunnelError](./docs/api/appkit/Class.TunnelError.md): Error thrown when remote tunnel operations fail.
77
78
  - [Class: ValidationError](./docs/api/appkit/Class.ValidationError.md): Error thrown when input validation fails.
78
79
  - [Enumeration: RequestedClaimsPermissionSet](./docs/api/appkit/Enumeration.RequestedClaimsPermissionSet.md): Permission set for Unity Catalog table access
79
- - [Enumeration: ResourceType](./docs/api/appkit/Enumeration.ResourceType.md): Resource types from schema $defs.resourceType.enum
80
+ - [Enumeration: ResourceType](./docs/api/appkit/Enumeration.ResourceType.md): Resource types from resourceTypeSchema.options
80
81
  - [Function: agentIdFromMarkdownPath()](./docs/api/appkit/Function.agentIdFromMarkdownPath.md): Derives the logical agent id from a markdown path. When the file is named
81
82
  - [Function: appKitServingTypesPlugin()](./docs/api/appkit/Function.appKitServingTypesPlugin.md): Vite plugin to generate TypeScript types for AppKit serving endpoints.
82
83
  - [Function: appKitTypesPlugin()](./docs/api/appkit/Function.appKitTypesPlugin.md): Vite plugin to generate types for AppKit queries.
@@ -141,7 +142,6 @@ npx @databricks/appkit docs <query>
141
142
  - [Interface: RequestedClaims](./docs/api/appkit/Interface.RequestedClaims.md): Optional claims for fine-grained Unity Catalog table permissions
142
143
  - [Interface: RequestedResource](./docs/api/appkit/Interface.RequestedResource.md): Resource to request permissions for in Unity Catalog
143
144
  - [Interface: ResourceEntry](./docs/api/appkit/Interface.ResourceEntry.md): Internal representation of a resource in the registry.
144
- - [Interface: 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. instancename, databasename or scope, key).
145
145
  - [Interface: ResourceRequirement](./docs/api/appkit/Interface.ResourceRequirement.md): Declares a resource requirement for a plugin.
146
146
  - [Interface: RunAgentInput](./docs/api/appkit/Interface.RunAgentInput.md): Properties
147
147
  - [Interface: RunAgentResult](./docs/api/appkit/Interface.RunAgentResult.md): Properties
@@ -174,6 +174,7 @@ npx @databricks/appkit docs <query>
174
174
  - [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().
175
175
  - [Type Alias: Plugins](./docs/api/appkit/TypeAlias.Plugins.md): Plugin map passed to the function form of AgentDefinition.tools.
176
176
  - [Type Alias: ResolvedToolEntry](./docs/api/appkit/TypeAlias.ResolvedToolEntry.md): Internal tool-index entry after a tool record has been resolved to a dispatchable form.
177
+ - [Type Alias: ResourceFieldEntry](./docs/api/appkit/TypeAlias.ResourceFieldEntry.md)
177
178
  - [Type Alias: ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md): Union of all possible permission levels across all resource types.
178
179
  - [Type Alias: ServingFactory](./docs/api/appkit/TypeAlias.ServingFactory.md): Factory function returned by AppKit.serving.
179
180
  - [Type Alias: ToolRegistry](./docs/api/appkit/TypeAlias.ToolRegistry.md)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@databricks/appkit-ui",
3
3
  "type": "module",
4
- "version": "0.36.0",
4
+ "version": "0.38.0",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
7
7
  "type": "git",
@@ -37,6 +37,7 @@
37
37
  "clean": "rm -rf dist tmp",
38
38
  "dist": "tsx ../../tools/dist-appkit.ts",
39
39
  "tarball": "rm -rf tmp && pnpm dist && npm pack ./tmp --pack-destination ./tmp",
40
+ "tarball:prerelease": "rm -rf tmp && SHORTSHA=$(git rev-parse --short HEAD) && pnpm dist --prerelease $SHORTSHA && npm pack ./tmp --pack-destination ./tmp",
40
41
  "typecheck": "tsc --noEmit",
41
42
  "postinstall": "node scripts/postinstall.js"
42
43
  },
@@ -87,10 +88,10 @@
87
88
  "tailwind-merge": "3.4.0",
88
89
  "vaul": "1.1.2",
89
90
  "@ast-grep/napi": "0.37.0",
90
- "ajv": "8.17.1",
91
- "ajv-formats": "3.0.1",
91
+ "@standard-schema/spec": "1.1.0",
92
92
  "@clack/prompts": "1.0.1",
93
- "commander": "12.1.0"
93
+ "commander": "12.1.0",
94
+ "zod": "4.3.6"
94
95
  },
95
96
  "peerDependencies": {
96
97
  "react": "^18.0.0 || ^19.0.0",