@databricks/appkit-ui 0.47.1 → 0.49.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 (42) hide show
  1. package/CLAUDE.md +11 -1
  2. package/dist/cli/commands/lint.js +6 -0
  3. package/dist/cli/commands/lint.js.map +1 -1
  4. package/dist/react/index.d.ts +4 -1
  5. package/dist/react/index.js +3 -1
  6. package/dist/react/ui-variants/index.d.ts +2 -0
  7. package/dist/react/ui-variants/variant.d.ts +21 -0
  8. package/dist/react/ui-variants/variant.d.ts.map +1 -0
  9. package/dist/react/ui-variants/variant.js +15 -0
  10. package/dist/react/ui-variants/variant.js.map +1 -0
  11. package/dist/react/ui-variants/variants.d.ts +87 -0
  12. package/dist/react/ui-variants/variants.d.ts.map +1 -0
  13. package/dist/react/ui-variants/variants.js +199 -0
  14. package/dist/react/ui-variants/variants.js.map +1 -0
  15. package/dist/schemas/manifest.d.ts +1 -0
  16. package/dist/schemas/manifest.d.ts.map +1 -1
  17. package/dist/schemas/manifest.js +1 -0
  18. package/dist/schemas/manifest.js.map +1 -1
  19. package/dist/shared/src/plugin.d.ts.map +1 -1
  20. package/docs/api/appkit/Class.DatabricksAdapter.md +34 -0
  21. package/docs/api/appkit/Class.SupervisorApiAdapter.md +121 -0
  22. package/docs/api/appkit/Function.fromSupervisorApi.md +63 -0
  23. package/docs/api/appkit/Function.isSupervisorTool.md +18 -0
  24. package/docs/api/appkit/Interface.AgentAdapter.md +24 -0
  25. package/docs/api/appkit/Interface.AgentInput.md +13 -0
  26. package/docs/api/appkit/Interface.HostedSupervisorTool.md +21 -0
  27. package/docs/api/appkit/Interface.PluginManifest.md +27 -9
  28. package/docs/api/appkit/Interface.SupervisorApiAdapterOptions.md +38 -0
  29. package/docs/api/appkit/Interface.SupervisorExtension.md +12 -0
  30. package/docs/api/appkit/Interface.WorkspaceClientLike.md +67 -0
  31. package/docs/api/appkit/TypeAlias.AgentTool.md +3 -2
  32. package/docs/api/appkit/TypeAlias.ResolvedToolEntry.md +167 -0
  33. package/docs/api/appkit/TypeAlias.SupervisorTool.md +45 -0
  34. package/docs/api/appkit/Variable.SUPERVISOR_EXTENSION_KEY.md +8 -0
  35. package/docs/api/appkit/Variable.supervisorTools.md +176 -0
  36. package/docs/api/appkit.md +118 -108
  37. package/docs/plugins/agents.md +131 -1
  38. package/docs/plugins/manifest.md +12 -11
  39. package/llms.txt +11 -1
  40. package/package.json +1 -1
  41. package/sbom.cdx.json +1 -1
  42. package/scripts/postinstall.js +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"manifest.js","names":[],"sources":["../../src/schemas/manifest.ts"],"sourcesContent":["/**\n * Zod-authoring module for AppKit plugin manifest schemas.\n *\n * Single source of truth for the plugin manifest contract. JSON Schema\n * artifacts published at the docs URL are emitted from these schemas via\n * `tools/generate-json-schema.ts` and live only in `docs/static/schemas/`\n * (no package-internal copies).\n *\n * - Cross-field constraints (cycle/dangling-reference checks, `<PROFILE>`\n * placeholder, post-scaffold instruction non-empty) are refinements\n * co-located with the shape they constrain. Validation is driven through\n * the Standard Schema interface from `validate-manifest.ts`.\n * - `templateFieldEntrySchema` is a transform that emits `origin` from\n * `localOnly`/`value`/`resolve`. The input slot is still allowed so\n * re-parsing previously-synced template manifests does not fail, but the\n * transform always overwrites it — drift-by-construction for hand-edits.\n * - `discoveryDescriptorSchema` is a discriminated union over a `type`\n * literal. The `kind` variant references one of the well-known\n * `resourceKind` values for which AppKit owns the CLI command map (see\n * `RESOURCE_KIND_COMMANDS` below). The `cli` variant is the escape hatch\n * carrying the existing free-form fields (with the `<PROFILE>`\n * refinement). Hierarchical context for volumes (catalog/schema parent\n * walk) is encoded via the kind's `parents` array, not via dependsOn.\n * - Scaffolding rule items carry a `maxLength` (120 chars) so\n * `rules.never[]` / `rules.must[]` / `rules.should[]` stay short\n * directives by contract, and the canonical `TEMPLATE_SCAFFOLDING`\n * constant lives co-located with the scaffolding schemas (sync.ts\n * imports it).\n */\n\nimport { z } from \"zod\";\n\n// ── Resource type + per-type permission enums ────────────────────────────\n\nexport const resourceTypeSchema = z\n .enum([\n \"secret\",\n \"job\",\n \"sql_warehouse\",\n \"serving_endpoint\",\n \"volume\",\n \"vector_search_index\",\n \"uc_function\",\n \"uc_connection\",\n \"database\",\n \"postgres\",\n \"genie_space\",\n \"experiment\",\n \"app\",\n ])\n .describe(\"Type of Databricks resource\");\n\nexport const secretPermissionSchema = z\n .enum([\"READ\", \"WRITE\", \"MANAGE\"])\n .describe(\"Permission for secret resources (order: weakest to strongest)\");\n\nexport const jobPermissionSchema = z\n .enum([\"CAN_VIEW\", \"CAN_MANAGE_RUN\", \"CAN_MANAGE\"])\n .describe(\"Permission for job resources (order: weakest to strongest)\");\n\nexport const sqlWarehousePermissionSchema = z\n .enum([\"CAN_USE\", \"CAN_MANAGE\"])\n .describe(\n \"Permission for SQL warehouse resources (order: weakest to strongest)\",\n );\n\nexport const servingEndpointPermissionSchema = z\n .enum([\"CAN_VIEW\", \"CAN_QUERY\", \"CAN_MANAGE\"])\n .describe(\n \"Permission for serving endpoint resources (order: weakest to strongest)\",\n );\n\nexport const volumePermissionSchema = z\n .enum([\"READ_VOLUME\", \"WRITE_VOLUME\"])\n .describe(\"Permission for Unity Catalog volume resources\");\n\nexport const vectorSearchIndexPermissionSchema = z\n .enum([\"SELECT\"])\n .describe(\"Permission for vector search index resources\");\n\nexport const ucFunctionPermissionSchema = z\n .enum([\"EXECUTE\"])\n .describe(\"Permission for Unity Catalog function resources\");\n\nexport const ucConnectionPermissionSchema = z\n .enum([\"USE_CONNECTION\"])\n .describe(\"Permission for Unity Catalog connection resources\");\n\nexport const databasePermissionSchema = z\n .enum([\"CAN_CONNECT_AND_CREATE\"])\n .describe(\"Permission for database resources\");\n\nexport const postgresPermissionSchema = z\n .enum([\"CAN_CONNECT_AND_CREATE\"])\n .describe(\"Permission for Postgres resources\");\n\nexport const genieSpacePermissionSchema = z\n .enum([\"CAN_VIEW\", \"CAN_RUN\", \"CAN_EDIT\", \"CAN_MANAGE\"])\n .describe(\n \"Permission for Genie Space resources (order: weakest to strongest)\",\n );\n\nexport const experimentPermissionSchema = z\n .enum([\"CAN_READ\", \"CAN_EDIT\", \"CAN_MANAGE\"])\n .describe(\n \"Permission for MLflow experiment resources (order: weakest to strongest)\",\n );\n\nexport const appPermissionSchema = z\n .enum([\"CAN_USE\"])\n .describe(\"Permission for Databricks App resources\");\n\n// ── Discovery descriptor (discriminated union) ───────────────────────────\n\n/**\n * Well-known Databricks resource kinds for which AppKit owns the CLI\n * command map. Plugins reference one of these via the `kind` variant of the\n * discovery descriptor; everything else falls back to the free-form `cli`\n * variant.\n *\n * Kept narrow on purpose: each entry costs an addition to\n * `RESOURCE_KIND_COMMANDS` below, which is the single source of truth for\n * how that kind is enumerated.\n */\nexport const resourceKindSchema = z\n .enum([\n \"warehouse\",\n \"genie_space\",\n \"postgres_project\",\n \"postgres_branch\",\n \"postgres_database\",\n \"volume\",\n ])\n .describe(\n \"Well-known Databricks resource kind whose listing command is owned by AppKit (see RESOURCE_KIND_COMMANDS).\",\n );\n\nexport const kindDiscoveryDescriptorSchema = z\n .object({\n type: z\n .literal(\"kind\")\n .describe(\n \"Discriminator: 'kind' uses the AppKit-owned command map for the named resourceKind.\",\n ),\n resourceKind: resourceKindSchema.describe(\n \"Reference to a well-known Databricks resource kind. AppKit owns the CLI command, response shape, and unwrap rules.\",\n ),\n select: z\n .string()\n .optional()\n .describe(\n \"Field name in the parsed CLI response used as the selected value (e.g., 'id'). Defaults to the kind's natural identifier when omitted.\",\n ),\n display: z\n .string()\n .optional()\n .describe(\n \"Field name in the parsed CLI response shown to the user in selection UI. Defaults to `select` if omitted.\",\n ),\n dependsOn: z\n .string()\n .optional()\n .describe(\n \"Name of a sibling field within the same resource that must be resolved first. Used to express ordering dependencies between resource fields.\",\n ),\n shortcut: z\n .string()\n .optional()\n .describe(\n \"Single-value fast-path command that returns exactly one value, skipping interactive selection.\",\n ),\n })\n .strict()\n .describe(\n \"Discovery via a well-known resource kind. AppKit owns the CLI command and unwrap rules for the named kind.\",\n );\n\n/**\n * Shell metacharacters rejected on free-form CLI command strings. Catches the\n * common foot-guns (statement separators, pipes, redirects via shell, command\n * substitution, newlines). Not a security boundary on its own — executors must\n * always pass these via argv, never shell-exec the string. Angle brackets are\n * permitted because `<PROFILE>` (and future `<…>` placeholders) are part of\n * the command-template convention.\n */\nconst SHELL_METACHAR_RE = /[;|&`$\\n\\r]/;\n\nexport const cliDiscoveryDescriptorSchema = z\n .object({\n type: z\n .literal(\"cli\")\n .describe(\n \"Discriminator: 'cli' uses a free-form Databricks CLI command supplied by the plugin.\",\n ),\n cliCommand: z\n .string()\n .describe(\n \"Databricks CLI command that lists resources. Must include <PROFILE>. Shell metacharacters (;|&`$ and newlines) are rejected; for first-party Databricks resources prefer the `kind` variant which uses AppKit's typed command map.\",\n ),\n selectField: z\n .string()\n .describe(\n \"jq-style path to the field used as the selected value (e.g., '.id', '.name').\",\n ),\n displayField: z\n .string()\n .optional()\n .describe(\n \"jq-style path to the field shown to the user in selection UI. Defaults to selectField if omitted.\",\n ),\n dependsOn: z\n .string()\n .optional()\n .describe(\n \"Name of a sibling field within the same resource that must be resolved first. Used to express ordering dependencies between resource fields.\",\n ),\n shortcut: z\n .string()\n .optional()\n .describe(\n \"Single-value fast-path command that returns exactly one value, skipping interactive selection. Shell metacharacters are rejected.\",\n ),\n })\n .strict()\n .refine((descriptor) => descriptor.cliCommand.includes(\"<PROFILE>\"), {\n message: \"must include <PROFILE> placeholder\",\n path: [\"cliCommand\"],\n })\n .refine((descriptor) => !SHELL_METACHAR_RE.test(descriptor.cliCommand), {\n message:\n \"must not contain shell metacharacters (;|&`$ or newlines); use the `kind` variant for typed Databricks resources\",\n path: [\"cliCommand\"],\n })\n .refine(\n (descriptor) =>\n descriptor.shortcut === undefined ||\n !SHELL_METACHAR_RE.test(descriptor.shortcut),\n {\n message: \"must not contain shell metacharacters (;|&`$ or newlines)\",\n path: [\"shortcut\"],\n },\n )\n .describe(\n \"Discovery via a free-form Databricks CLI command. Escape hatch — prefer the `kind` variant when a typed resourceKind covers the resource. This shape is intentionally minimal and may tighten further in future versions.\",\n );\n\nexport const discoveryDescriptorSchema = z\n .discriminatedUnion(\"type\", [\n kindDiscoveryDescriptorSchema,\n cliDiscoveryDescriptorSchema,\n ])\n .describe(\n \"Describes how the CLI discovers values for a resource field. 'kind' references a well-known Databricks resource kind whose command is owned by AppKit; 'cli' is the escape hatch carrying a free-form Databricks CLI command.\",\n );\n\n// ── Resource kind → CLI command map ──────────────────────────────────────\n\n/**\n * Descriptor for how a well-known resource kind is listed via the\n * Databricks CLI.\n *\n * - `command` is the CLI invocation template. It carries two kinds of\n * placeholders:\n * - `<PROFILE>` — substituted with the user's CLI profile by the runner.\n * - `{<fieldName>}` — substituted with the resolved value of the named\n * sibling field (used for `dependsOn` chains).\n * - `unwrap`, when set, is the JSON path into the response wrapper (e.g.,\n * `\"warehouses\"` for `{ warehouses: [...] }`). Omitted when the response\n * is already a flat array.\n * - `parents`, when set, lists transient query inputs the runner must\n * collect (as free-text prompts) before invoking the command. Each\n * `parents[i]` value substitutes the matching `{name}` placeholder in\n * the command string. Unlike `dependsOn` (which references a sibling\n * field on the same resource), `parents` covers inputs that aren't\n * persisted as fields on the resource.\n */\nexport type ResourceKindCommand = {\n command: string;\n unwrap?: string;\n parents?: readonly string[];\n};\n\n/**\n * Single source of truth for AppKit-owned discovery commands.\n *\n * To add a new resource kind: extend `resourceKindSchema` and add an entry\n * here. Plugins reference the kind via `discovery: { type: \"kind\",\n * resourceKind: \"...\" }` and inherit the command + response shape.\n *\n * `unwrap` defaults are unset: the existing core plugin manifests use simple\n * jq paths (`.id`, `.name`, `.full_name`), implying the listed CLI commands\n * return flat arrays. Refine in a follow-up if a kind's CLI returns wrapped\n * data.\n *\n * Volume's catalog/schema parent context is supplied via the `parents`\n * array, which the runner collects from the user as free-text prompts\n * before invoking the listing command.\n */\nexport const RESOURCE_KIND_COMMANDS: Record<\n z.infer<typeof resourceKindSchema>,\n { command: string; unwrap?: string; parents?: readonly string[] }\n> = {\n warehouse: {\n command: \"databricks warehouses list --profile <PROFILE> --output json\",\n },\n genie_space: {\n command: \"databricks genie list-spaces --profile <PROFILE> --output json\",\n },\n postgres_project: {\n command:\n \"databricks postgres list-projects --profile <PROFILE> --output json\",\n },\n postgres_branch: {\n // {project} is a placeholder for the resolved value of the `project`\n // sibling field (declared via `dependsOn: \"project\"` on the kind variant).\n // The Databricks CLI requires the parent project resource name (format\n // `projects/{project_id}`) as a positional argument.\n command:\n \"databricks postgres list-branches {project} --profile <PROFILE> --output json\",\n },\n postgres_database: {\n // {branch} is a placeholder for the resolved value of the `branch`\n // sibling field (declared via `dependsOn: \"branch\"` on the kind variant).\n command:\n \"databricks postgres list-databases {branch} --profile <PROFILE> --output json\",\n },\n volume: {\n // `parents` declares free-text user prompts the runner must collect before\n // invoking the discovery command. Each `parents[i]` value substitutes the\n // matching `{name}` placeholder in the command string above. Unlike\n // `dependsOn` (which references a sibling field on the same resource),\n // `parents` covers transient query inputs that aren't persisted as fields.\n command:\n \"databricks volumes list {catalog} {schema} --profile <PROFILE> --output json\",\n parents: [\"catalog\", \"schema\"] as const,\n },\n};\n\n// ── Resource field entry (plugin manifest variant) ───────────────────────\n\nexport const resourceFieldEntrySchema = z\n .object({\n env: z\n .string()\n .regex(/^[A-Z][A-Z0-9_]*$/)\n .optional()\n .describe(\"Environment variable name for this field\"),\n description: z\n .string()\n .optional()\n .describe(\"Human-readable description for this field\"),\n bundleIgnore: z\n .boolean()\n .optional()\n .describe(\n \"When true, this field is excluded from Databricks bundle configuration (databricks.yml) generation.\",\n ),\n examples: z\n .array(z.string())\n .optional()\n .describe(\"Example values showing the expected format for this field\"),\n localOnly: z\n .boolean()\n .optional()\n .describe(\n \"When true, this field is only generated for local .env files. The Databricks Apps platform auto-injects it at deploy time.\",\n ),\n value: z\n .string()\n .optional()\n .describe(\n \"Static value for this field. Used when no prompted or resolved value exists.\",\n ),\n resolve: z\n .string()\n .regex(/^[a-z_]+:[a-zA-Z]+$/)\n .optional()\n .describe(\n \"Named resolver prefixed by resource type (e.g., 'postgres:host'). The CLI resolves this value during the init prompt flow.\",\n ),\n discovery: discoveryDescriptorSchema.optional(),\n })\n .strict()\n .describe(\n \"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).\",\n );\n\n// ── Resource requirement (per-type permission discriminator) ─────────────\n\n/**\n * Build a per-type variant. Each variant fixes `type` to a literal and constrains\n * `permission` to the matching enum, mirroring the existing JSON Schema's\n * `allOf + if/then` block. `fields` and the rest of the shape come from a\n * shared base.\n */\nconst resourceRequirementBaseShape = {\n alias: z\n .string()\n .min(1)\n .describe(\n \"Human-readable label for UI/display only. Deduplication uses resourceKey, not alias.\",\n ),\n resourceKey: z\n .string()\n .regex(/^[a-z][a-z0-9-]*$/)\n .describe(\n \"Stable key for machine use: deduplication, env naming, composite keys, app.yaml. Required for registry lookup.\",\n ),\n description: z\n .string()\n .min(1)\n .describe(\"Human-readable description of why this resource is needed\"),\n fields: z\n .record(z.string(), resourceFieldEntrySchema)\n .refine((obj) => Object.keys(obj).length >= 1, {\n message: \"fields must contain at least one entry\",\n })\n .optional()\n .describe(\n \"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).\",\n ),\n};\n\n/**\n * Adds the cycle/dangling-reference cross-field check to a resource variant.\n * Iterates the resource's `fields`, validates each `discovery.dependsOn` target\n * is a sibling field name, then runs DFS over the dependsOn graph to detect\n * cycles. Issue paths target either the offending field's `dependsOn` slot or\n * the resource itself for cycles.\n */\nfunction refineResourceDependsOn(\n resource: { fields?: Record<string, { discovery?: { dependsOn?: string } }> },\n ctx: z.core.$RefinementCtx,\n): void {\n if (!resource.fields) return;\n const fieldNames = new Set(Object.keys(resource.fields));\n\n // Pass 1: validate dependsOn references and build the dependency graph.\n const deps = new Map<string, string>();\n for (const [name, field] of Object.entries(resource.fields)) {\n const dep = field.discovery?.dependsOn;\n if (!dep) continue;\n if (!fieldNames.has(dep)) {\n ctx.addIssue({\n code: \"custom\",\n path: [\"fields\", name, \"discovery\", \"dependsOn\"],\n message: `references non-existent sibling field '${dep}'`,\n });\n }\n deps.set(name, dep);\n }\n\n // Pass 2: detect cycles via DFS. Emit one issue per cycle found.\n const visited = new Set<string>();\n const visiting = new Set<string>();\n\n function dfs(node: string, chain: string[]): string[] | null {\n if (visiting.has(node)) return [...chain, node];\n if (visited.has(node)) return null;\n visiting.add(node);\n const next = deps.get(node);\n if (next) {\n const cycle = dfs(next, [...chain, node]);\n if (cycle) return cycle;\n }\n visiting.delete(node);\n visited.add(node);\n return null;\n }\n\n for (const node of deps.keys()) {\n if (visited.has(node)) continue;\n const cycle = dfs(node, []);\n if (cycle) {\n ctx.addIssue({\n code: \"custom\",\n path: [],\n message: `discovery.dependsOn creates a cycle: ${cycle.join(\" → \")}`,\n });\n // One cycle error per resource is enough.\n break;\n }\n }\n}\n\nfunction makeResourceVariant<\n TType extends z.ZodLiteral<string>,\n TPerm extends z.ZodTypeAny,\n>(typeLiteral: TType, permission: TPerm) {\n return z\n .object({\n type: typeLiteral,\n ...resourceRequirementBaseShape,\n permission: permission.describe(\n \"Required permission level. Validated per resource type.\",\n ),\n })\n .strict()\n .superRefine(refineResourceDependsOn);\n}\n\nexport const resourceRequirementSchema = z\n .discriminatedUnion(\"type\", [\n makeResourceVariant(z.literal(\"secret\"), secretPermissionSchema),\n makeResourceVariant(z.literal(\"job\"), jobPermissionSchema),\n makeResourceVariant(\n z.literal(\"sql_warehouse\"),\n sqlWarehousePermissionSchema,\n ),\n makeResourceVariant(\n z.literal(\"serving_endpoint\"),\n servingEndpointPermissionSchema,\n ),\n makeResourceVariant(z.literal(\"volume\"), volumePermissionSchema),\n makeResourceVariant(\n z.literal(\"vector_search_index\"),\n vectorSearchIndexPermissionSchema,\n ),\n makeResourceVariant(z.literal(\"uc_function\"), ucFunctionPermissionSchema),\n makeResourceVariant(\n z.literal(\"uc_connection\"),\n ucConnectionPermissionSchema,\n ),\n makeResourceVariant(z.literal(\"database\"), databasePermissionSchema),\n makeResourceVariant(z.literal(\"postgres\"), postgresPermissionSchema),\n makeResourceVariant(z.literal(\"genie_space\"), genieSpacePermissionSchema),\n makeResourceVariant(z.literal(\"experiment\"), experimentPermissionSchema),\n makeResourceVariant(z.literal(\"app\"), appPermissionSchema),\n ])\n .describe(\n \"Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().\",\n );\n\n// ── Config schema (recursive) ────────────────────────────────────────────\n\nexport const configSchemaPropertySchema: z.ZodType = z.lazy(() =>\n z\n .object({\n type: z.enum([\n \"object\",\n \"array\",\n \"string\",\n \"number\",\n \"boolean\",\n \"integer\",\n ]),\n description: z.string().optional(),\n default: z.unknown().optional(),\n enum: z.array(z.unknown()).optional(),\n properties: z.record(z.string(), configSchemaPropertySchema).optional(),\n items: configSchemaPropertySchema.optional(),\n minimum: z.number().optional(),\n maximum: z.number().optional(),\n minLength: z.number().int().min(0).optional(),\n maxLength: z.number().int().min(0).optional(),\n required: z.array(z.string()).optional(),\n // `additionalProperties` is a standard JSON Schema keyword used by core\n // plugin manifests (e.g., serving, vector-search, genie) to constrain\n // dictionary-shaped properties. Allowed on nested property entries as\n // either a boolean or a sub-schema, mirroring JSON Schema semantics.\n additionalProperties: z\n .union([z.boolean(), configSchemaPropertySchema])\n .optional(),\n })\n .strict(),\n);\n\nexport const configSchemaSchema: z.ZodType = z.lazy(() =>\n z\n .object({\n type: z.enum([\"object\", \"array\", \"string\", \"number\", \"boolean\"]),\n properties: z.record(z.string(), configSchemaPropertySchema).optional(),\n items: configSchemaSchema.optional(),\n required: z.array(z.string()).optional(),\n additionalProperties: z.boolean().optional(),\n })\n .strict(),\n);\n\n// ── Plugin-level scaffolding rules ───────────────────────────────────────\n\n/**\n * Per-item upper bound on plugin-level scaffolding rule strings. Matches the\n * template-level `SCAFFOLDING_RULE_MAX_LENGTH` defined below — rules at both\n * levels are short directives, not prose. The literal value lives here (and\n * not by reference to the template-side constant) because this declaration\n * is read in source order and the template constant is declared later.\n */\nconst PLUGIN_SCAFFOLDING_RULE_MAX_LENGTH = 120;\n\nconst pluginScaffoldingRuleItemSchema = z\n .string()\n .min(1)\n .max(\n PLUGIN_SCAFFOLDING_RULE_MAX_LENGTH,\n `rule entries must be ≤ ${PLUGIN_SCAFFOLDING_RULE_MAX_LENGTH} chars`,\n );\n\nexport const pluginScaffoldingRulesSchema = z\n .object({\n must: z\n .array(pluginScaffoldingRuleItemSchema)\n .optional()\n .describe(\"Actions the scaffolding agent must always perform.\"),\n should: z\n .array(pluginScaffoldingRuleItemSchema)\n .optional()\n .describe(\"Recommended actions for the scaffolding agent.\"),\n never: z\n .array(pluginScaffoldingRuleItemSchema)\n .optional()\n .describe(\"Actions the scaffolding agent must never perform.\"),\n })\n .strict()\n .superRefine((rules, ctx) => {\n // (a) Reject duplicate entries within any single array.\n const buckets: Array<[\"must\" | \"should\" | \"never\", string[] | undefined]> =\n [\n [\"must\", rules.must],\n [\"should\", rules.should],\n [\"never\", rules.never],\n ];\n for (const [bucketName, items] of buckets) {\n if (!items) continue;\n const seen = new Map<string, number>();\n items.forEach((item, idx) => {\n const prev = seen.get(item);\n if (prev === undefined) {\n seen.set(item, idx);\n return;\n }\n ctx.addIssue({\n code: \"custom\",\n path: [bucketName, idx],\n message: `duplicate rule entry: \"${item}\" already declared at index ${prev}`,\n });\n });\n }\n // (b) Reject a string that appears in more than one of must/should/never.\n type Bucket = \"must\" | \"should\" | \"never\";\n const owner = new Map<string, Bucket>();\n for (const [bucketName, items] of buckets) {\n if (!items) continue;\n for (let i = 0; i < items.length; i++) {\n const item = items[i];\n const existing = owner.get(item);\n if (existing === undefined) {\n owner.set(item, bucketName);\n continue;\n }\n if (existing !== bucketName) {\n ctx.addIssue({\n code: \"custom\",\n path: [bucketName, i],\n message: `rule entry \"${item}\" appears in both '${existing}' and '${bucketName}'; rules must belong to exactly one bucket`,\n });\n }\n }\n }\n })\n .describe(\n \"Structured rules for scaffolding agents declared at the plugin level. Each rule is a short directive (≤120 chars).\",\n );\n\n// ── Plugin manifest (root) ───────────────────────────────────────────────\n\nexport const pluginManifestSchema = z\n .object({\n $schema: z\n .string()\n .optional()\n .describe(\"Reference to the JSON Schema for validation\"),\n name: z\n .string()\n .regex(/^[a-z][a-z0-9-]*$/)\n .describe(\n \"Plugin identifier. Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens.\",\n ),\n displayName: z\n .string()\n .min(1)\n .describe(\"Human-readable display name for UI and CLI\"),\n description: z\n .string()\n .min(1)\n .describe(\"Brief description of what the plugin does\"),\n resources: z\n .object({\n required: z\n .array(resourceRequirementSchema)\n .describe(\n \"Resources that must be available for the plugin to function\",\n ),\n optional: z\n .array(resourceRequirementSchema)\n .describe(\n \"Resources that enhance functionality but are not mandatory\",\n ),\n })\n .strict()\n .describe(\"Databricks resource requirements for this plugin\"),\n config: z\n .object({\n schema: configSchemaSchema.optional(),\n })\n .strict()\n .optional()\n .describe(\"Configuration schema for the plugin\"),\n author: z.string().optional().describe(\"Author name or organization\"),\n version: z\n .string()\n .regex(/^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.]+)?$/)\n .optional()\n .describe(\"Plugin version (semver format)\"),\n repository: z\n .url()\n .optional()\n .describe(\"URL to the plugin's source repository\"),\n keywords: z\n .array(z.string())\n .optional()\n .describe(\"Keywords for plugin discovery\"),\n license: z.string().optional().describe(\"SPDX license identifier\"),\n onSetupMessage: z\n .string()\n .optional()\n .describe(\n \"Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning).\",\n ),\n hidden: z\n .boolean()\n .optional()\n .describe(\n \"When true, this plugin is excluded from the template plugins manifest (appkit.plugins.json) during sync.\",\n ),\n stability: z\n .enum([\"beta\", \"ga\"])\n .optional()\n .describe(\n \"Plugin stability level. Beta plugins may have breaking API changes between minor releases but are on a path to GA. GA (general availability) plugins follow semver strictly.\",\n ),\n scaffolding: z\n .object({\n rules: pluginScaffoldingRulesSchema\n .optional()\n .describe(\n \"Structured rules for scaffolding agents declared at the plugin level.\",\n ),\n })\n .strict()\n .optional()\n .describe(\n \"Plugin-level scaffolding metadata consumed by scaffolding agents. Symmetric with template-level `scaffolding`.\",\n ),\n })\n .strict()\n .describe(\n \"Schema for Databricks AppKit plugin manifest files. Defines plugin metadata, resource requirements, and configuration options.\",\n );\n\n// ── Origin enum ──────────────────────────────────────────────────────────\n\nexport const originSchema = z\n .enum([\"user\", \"platform\", \"static\", \"cli\"])\n .describe(\n \"How the field value is determined. Computed during sync, not authored by plugin developers.\",\n );\n\n// ── Template field entry (origin computed by transform) ─────────────────\n\n/**\n * Derives the canonical origin of a resource field value from its shape.\n *\n * - `localOnly: true` → `\"platform\"` (auto-injected by the Databricks Apps\n * platform at deploy time; takes precedence over `value`/`resolve`).\n * - `value !== undefined` → `\"static\"` (hardcoded value).\n * - `resolve !== undefined` → `\"cli\"` (resolved by the CLI during init).\n * - else → `\"user\"` (user must provide the value at init time).\n *\n * Co-located with `templateFieldEntrySchema` because the transform is the\n * only consumer. Kept private so any other \"origin computation\" goes\n * through the schema rather than re-implementing the rules.\n */\nfunction computeOriginFromField(field: {\n localOnly?: boolean;\n value?: string;\n resolve?: string;\n}): z.infer<typeof originSchema> {\n if (field.localOnly) return \"platform\";\n if (field.value !== undefined) return \"static\";\n if (field.resolve !== undefined) return \"cli\";\n return \"user\";\n}\n\n/**\n * Template field entry: extends the plugin manifest field entry with an\n * optional `origin` input slot, then runs a `.transform()` that overwrites\n * `origin` with the computed value. Allowing `origin` on input means\n * re-parsing a previously-synced template manifest does not fail; emitting\n * `origin` always means hand-edits in synced JSON are silently corrected\n * on the next parse — drift-by-construction.\n */\nexport const templateFieldEntrySchema = resourceFieldEntrySchema\n .extend({ origin: originSchema.optional() })\n .transform((field) => ({\n ...field,\n origin: computeOriginFromField(field),\n }));\n\n// ── Template resource requirement (uses templateFieldEntrySchema) ────────\n\nconst templateResourceRequirementBaseShape = {\n alias: z\n .string()\n .min(1)\n .describe(\"Human-readable label for UI/display only.\"),\n resourceKey: z\n .string()\n .regex(/^[a-z][a-z0-9-]*$/)\n .describe(\n \"Stable key for machine use: deduplication, env naming, composite keys.\",\n ),\n description: z\n .string()\n .min(1)\n .describe(\"Human-readable description of why this resource is needed\"),\n fields: z\n .record(z.string(), templateFieldEntrySchema)\n .refine((obj) => Object.keys(obj).length >= 1, {\n message: \"fields must contain at least one entry\",\n })\n .optional()\n .describe(\"Map of field name to field entry with computed origin.\"),\n};\n\nfunction makeTemplateResourceVariant<\n TType extends z.ZodLiteral<string>,\n TPerm extends z.ZodTypeAny,\n>(typeLiteral: TType, permission: TPerm) {\n return z\n .object({\n type: typeLiteral,\n ...templateResourceRequirementBaseShape,\n permission: permission.describe(\n \"Required permission level. Validated per resource type.\",\n ),\n })\n .strict()\n .superRefine(refineResourceDependsOn);\n}\n\nexport const templateResourceRequirementSchema = z\n .discriminatedUnion(\"type\", [\n makeTemplateResourceVariant(z.literal(\"secret\"), secretPermissionSchema),\n makeTemplateResourceVariant(z.literal(\"job\"), jobPermissionSchema),\n makeTemplateResourceVariant(\n z.literal(\"sql_warehouse\"),\n sqlWarehousePermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"serving_endpoint\"),\n servingEndpointPermissionSchema,\n ),\n makeTemplateResourceVariant(z.literal(\"volume\"), volumePermissionSchema),\n makeTemplateResourceVariant(\n z.literal(\"vector_search_index\"),\n vectorSearchIndexPermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"uc_function\"),\n ucFunctionPermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"uc_connection\"),\n ucConnectionPermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"database\"),\n databasePermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"postgres\"),\n postgresPermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"genie_space\"),\n genieSpacePermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"experiment\"),\n experimentPermissionSchema,\n ),\n makeTemplateResourceVariant(z.literal(\"app\"), appPermissionSchema),\n ])\n .describe(\n \"Resource requirement with template-specific field entries (includes computed origin).\",\n );\n\n// ── Template plugin (extends plugin manifest) ────────────────────────────\n\nexport const templatePluginSchema = z\n .object({\n name: z\n .string()\n .regex(/^[a-z][a-z0-9-]*$/)\n .describe(\n \"Plugin identifier. Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens.\",\n ),\n displayName: z\n .string()\n .min(1)\n .describe(\"Human-readable display name for UI and CLI\"),\n description: z\n .string()\n .min(1)\n .describe(\"Brief description of what the plugin does\"),\n package: z\n .string()\n .min(1)\n .describe(\"NPM package name that provides this plugin\"),\n requiredByTemplate: z\n .boolean()\n .optional()\n .describe(\n \"When true, this plugin is required by the template and cannot be deselected during CLI init. The user will only be prompted to configure its resources. When absent or false, the plugin is optional and the user can choose whether to include it.\",\n ),\n onSetupMessage: z\n .string()\n .optional()\n .describe(\n \"Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning).\",\n ),\n stability: z\n .enum([\"beta\", \"ga\"])\n .optional()\n .describe(\n \"Plugin stability level. Beta is heading to GA; APIs may change between minor releases. GA (general availability) follows semver.\",\n ),\n scaffolding: z\n .object({\n rules: pluginScaffoldingRulesSchema\n .optional()\n .describe(\n \"Structured rules for scaffolding agents propagated from the plugin manifest.\",\n ),\n })\n .strict()\n .optional()\n .describe(\n \"Plugin-level scaffolding metadata propagated from the plugin manifest.\",\n ),\n resources: z\n .object({\n required: z\n .array(templateResourceRequirementSchema)\n .describe(\n \"Resources that must be available for the plugin to function\",\n ),\n optional: z\n .array(templateResourceRequirementSchema)\n .describe(\n \"Resources that enhance functionality but are not mandatory\",\n ),\n })\n .strict()\n .describe(\"Databricks resource requirements for this plugin\"),\n })\n .strict()\n .describe(\"Plugin manifest with package source information\");\n\n// ── Scaffolding descriptor ───────────────────────────────────────────────\n\nexport const scaffoldingFlagSchema = z\n .object({\n description: z.string().describe(\"Human-readable description of the flag.\"),\n required: z.boolean().optional().describe(\"Whether this flag is required.\"),\n pattern: z\n .string()\n .optional()\n .describe(\"Regex pattern for validating the flag value.\"),\n default: z.string().optional().describe(\"Default value for this flag.\"),\n })\n .strict()\n .describe(\"A flag for the scaffolding command.\");\n\n/**\n * Per-item upper bound on scaffolding rule strings. The intent is to enforce\n * \"short directive\" by contract — long paragraphs fail validation and force\n * authors to split prose into discrete actionable items.\n */\nconst SCAFFOLDING_RULE_MAX_LENGTH = 120;\n\nconst scaffoldingRuleItemSchema = z\n .string()\n .max(\n SCAFFOLDING_RULE_MAX_LENGTH,\n `rule item must be ≤ ${SCAFFOLDING_RULE_MAX_LENGTH} chars`,\n );\n\nexport const scaffoldingRulesSchema = z\n .object({\n never: z\n .array(scaffoldingRuleItemSchema)\n .optional()\n .describe(\"Actions the scaffolding agent must never perform.\"),\n must: z\n .array(scaffoldingRuleItemSchema)\n .optional()\n .describe(\"Actions the scaffolding agent must always perform.\"),\n should: z\n .array(scaffoldingRuleItemSchema)\n .optional()\n .describe(\n \"Recommended actions for the scaffolding agent (parity with plugin-level rules).\",\n ),\n })\n .strict()\n .describe(\"Structured rules for scaffolding agents.\");\n\nexport const scaffoldingDescriptorSchema = z\n .object({\n command: z\n .string()\n .describe(\"The scaffolding command (e.g., 'databricks apps init').\"),\n flags: z\n .record(z.string(), scaffoldingFlagSchema)\n .optional()\n .describe(\"Map of flag name to flag descriptor.\"),\n rules: scaffoldingRulesSchema\n .optional()\n .describe(\"Structured rules for scaffolding agents.\"),\n })\n .strict()\n .describe(\n \"Describes the scaffolding command, flags, and rules for project initialization.\",\n );\n\n/**\n * Canonical scaffolding descriptor for the `databricks apps init` command,\n * embedded in v2.0 template manifests to guide scaffolding agents.\n *\n * Co-located with `scaffoldingDescriptorSchema` so any change to the rule set\n * (or the schema's `maxLength` ceiling) shows up next to its consumer. The\n * `satisfies` annotation gives compile-time validation that the literal\n * matches the schema's input shape; if a `must`/`never` entry exceeds the\n * `maxLength` ceiling at runtime, `scaffoldingDescriptorSchema.parse` would\n * surface the breach in tests.\n */\nexport const TEMPLATE_SCAFFOLDING = {\n command: \"databricks apps init\",\n flags: {\n \"--name\": {\n description:\n \"Project name — sets {{.projectName}} in package.json, databricks.yml, and .env. Required for non-interactive scaffolding.\",\n required: true,\n pattern: \"^[a-z][a-z0-9-]*$\",\n },\n \"--template\": {\n description: \"Template path (local directory or GitHub URL)\",\n required: false,\n },\n \"--version\": {\n description: \"AppKit version to use; defaults to auto-detected\",\n required: false,\n },\n \"--features\": {\n description:\n \"Plugins to enable (comma-separated, no spaces; must match keys in this manifest's plugins map)\",\n required: false,\n pattern: \"^[a-zA-Z0-9_-]+(,[a-zA-Z0-9_-]+)*$\",\n },\n \"--set\": {\n description:\n \"Set resource values (format: plugin.resourceKey.field=value, repeatable)\",\n required: false,\n },\n \"--output-dir\": {\n description: \"Directory to write the project to\",\n required: false,\n },\n \"--description\": {\n description: \"App description\",\n required: false,\n },\n \"--run\": {\n description: \"Run the app after creation (none, dev, dev-remote)\",\n required: false,\n },\n \"--auto-approve\": {\n description:\n \"Pass as a bare flag (no value) to skip prompts for optional resources. Not recommended for agent-driven init — conflicts with the 'ask user when in doubt' rule.\",\n required: false,\n },\n \"--profile\": {\n description:\n \"Databricks CLI profile to use for authentication (global flag)\",\n required: false,\n },\n },\n rules: {\n must: [\n \"Treat `databricks apps init` output as starter code, not requirements; adapt or replace it to match the requested app\",\n \"Keep all secrets and credentials only in app.yaml, databricks.yml, and/or .env\",\n ],\n should: [\"ask user when in doubt of resource to use for plugin\"],\n never: [\n \"guess resources when multiple or no options are available\",\n \"embed secrets in files that will go to the client-bundle\",\n ],\n },\n} satisfies z.infer<typeof scaffoldingDescriptorSchema>;\n\n// ── Template plugins manifest (root) ─────────────────────────────────────\n\nexport const templatePluginsManifestSchema = z\n .object({\n $schema: z\n .string()\n .optional()\n .describe(\"Reference to the JSON Schema for validation\"),\n version: z\n .enum([\"1.0\", \"1.1\", \"2.0\"])\n .describe(\"Schema version for the template plugins manifest\"),\n plugins: z\n .record(z.string(), templatePluginSchema)\n .describe(\"Map of plugin name to plugin manifest with package source\"),\n scaffolding: scaffoldingDescriptorSchema\n .optional()\n .describe(\n \"Describes the scaffolding command and its configuration for project initialization.\",\n ),\n })\n .strict()\n .superRefine((value, ctx) => {\n if (value.version === \"2.0\" && !value.scaffolding) {\n ctx.addIssue({\n code: \"custom\",\n path: [\"scaffolding\"],\n message: \"scaffolding is required when version is '2.0'\",\n });\n }\n })\n .describe(\n \"Aggregated plugin manifest for AppKit templates. Read by Databricks CLI during init to discover available plugins and their resource requirements.\",\n );\n\n// ── Inferred types ───────────────────────────────────────────────────────\n\nexport type ResourceType = z.infer<typeof resourceTypeSchema>;\nexport type SecretPermission = z.infer<typeof secretPermissionSchema>;\nexport type JobPermission = z.infer<typeof jobPermissionSchema>;\nexport type SqlWarehousePermission = z.infer<\n typeof sqlWarehousePermissionSchema\n>;\nexport type ServingEndpointPermission = z.infer<\n typeof servingEndpointPermissionSchema\n>;\nexport type VolumePermission = z.infer<typeof volumePermissionSchema>;\nexport type VectorSearchIndexPermission = z.infer<\n typeof vectorSearchIndexPermissionSchema\n>;\nexport type UcFunctionPermission = z.infer<typeof ucFunctionPermissionSchema>;\nexport type UcConnectionPermission = z.infer<\n typeof ucConnectionPermissionSchema\n>;\nexport type DatabasePermission = z.infer<typeof databasePermissionSchema>;\nexport type PostgresPermission = z.infer<typeof postgresPermissionSchema>;\nexport type GenieSpacePermission = z.infer<typeof genieSpacePermissionSchema>;\nexport type ExperimentPermission = z.infer<typeof experimentPermissionSchema>;\nexport type AppPermission = z.infer<typeof appPermissionSchema>;\nexport type ResourceKind = z.infer<typeof resourceKindSchema>;\nexport type KindDiscoveryDescriptor = z.infer<\n typeof kindDiscoveryDescriptorSchema\n>;\nexport type CliDiscoveryDescriptor = z.infer<\n typeof cliDiscoveryDescriptorSchema\n>;\nexport type DiscoveryDescriptor = z.infer<typeof discoveryDescriptorSchema>;\nexport type ResourceFieldEntry = z.infer<typeof resourceFieldEntrySchema>;\nexport type ResourceRequirement = z.infer<typeof resourceRequirementSchema>;\nexport type ConfigSchemaProperty = z.infer<typeof configSchemaPropertySchema>;\nexport type ConfigSchema = z.infer<typeof configSchemaSchema>;\nexport type PluginScaffoldingRules = z.infer<\n typeof pluginScaffoldingRulesSchema\n>;\nexport type PluginManifest = z.infer<typeof pluginManifestSchema>;\nexport type Origin = z.infer<typeof originSchema>;\n// Template-side types use `z.input` so callers can construct a TemplatePlugin\n// from a parsed PluginManifest before the field-level origin transform runs.\n// `writeManifest` parses every field through `templateFieldEntrySchema` at\n// write-time, so the on-disk shape always has origin populated. The runtime\n// invariant: origin is *always* present after sync writes; the type slot\n// stays optional so the in-memory pipeline does not need to fabricate origin\n// before assignment.\nexport type TemplateFieldEntry = z.input<typeof templateFieldEntrySchema>;\nexport type TemplateResourceRequirement = z.input<\n typeof templateResourceRequirementSchema\n>;\nexport type TemplatePlugin = z.input<typeof templatePluginSchema>;\nexport type ScaffoldingFlag = z.infer<typeof scaffoldingFlagSchema>;\nexport type ScaffoldingRules = z.infer<typeof scaffoldingRulesSchema>;\nexport type ScaffoldingDescriptor = z.infer<typeof scaffoldingDescriptorSchema>;\nexport type TemplatePluginsManifest = z.input<\n typeof templatePluginsManifestSchema\n>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,MAAa,qBAAqB,EAC/B,KAAK;CACJ;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC,CACD,SAAS,8BAA8B;AAE1C,MAAa,yBAAyB,EACnC,KAAK;CAAC;CAAQ;CAAS;CAAS,CAAC,CACjC,SAAS,gEAAgE;AAE5E,MAAa,sBAAsB,EAChC,KAAK;CAAC;CAAY;CAAkB;CAAa,CAAC,CAClD,SAAS,6DAA6D;AAEzE,MAAa,+BAA+B,EACzC,KAAK,CAAC,WAAW,aAAa,CAAC,CAC/B,SACC,uEACD;AAEH,MAAa,kCAAkC,EAC5C,KAAK;CAAC;CAAY;CAAa;CAAa,CAAC,CAC7C,SACC,0EACD;AAEH,MAAa,yBAAyB,EACnC,KAAK,CAAC,eAAe,eAAe,CAAC,CACrC,SAAS,gDAAgD;AAE5D,MAAa,oCAAoC,EAC9C,KAAK,CAAC,SAAS,CAAC,CAChB,SAAS,+CAA+C;AAE3D,MAAa,6BAA6B,EACvC,KAAK,CAAC,UAAU,CAAC,CACjB,SAAS,kDAAkD;AAE9D,MAAa,+BAA+B,EACzC,KAAK,CAAC,iBAAiB,CAAC,CACxB,SAAS,oDAAoD;AAEhE,MAAa,2BAA2B,EACrC,KAAK,CAAC,yBAAyB,CAAC,CAChC,SAAS,oCAAoC;AAEhD,MAAa,2BAA2B,EACrC,KAAK,CAAC,yBAAyB,CAAC,CAChC,SAAS,oCAAoC;AAEhD,MAAa,6BAA6B,EACvC,KAAK;CAAC;CAAY;CAAW;CAAY;CAAa,CAAC,CACvD,SACC,qEACD;AAEH,MAAa,6BAA6B,EACvC,KAAK;CAAC;CAAY;CAAY;CAAa,CAAC,CAC5C,SACC,2EACD;AAEH,MAAa,sBAAsB,EAChC,KAAK,CAAC,UAAU,CAAC,CACjB,SAAS,0CAA0C;;;;;;;;;;;AActD,MAAa,qBAAqB,EAC/B,KAAK;CACJ;CACA;CACA;CACA;CACA;CACA;CACD,CAAC,CACD,SACC,6GACD;AAEH,MAAa,gCAAgC,EAC1C,OAAO;CACN,MAAM,EACH,QAAQ,OAAO,CACf,SACC,sFACD;CACH,cAAc,mBAAmB,SAC/B,qHACD;CACD,QAAQ,EACL,QAAQ,CACR,UAAU,CACV,SACC,yIACD;CACH,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SACC,4GACD;CACH,WAAW,EACR,QAAQ,CACR,UAAU,CACV,SACC,+IACD;CACH,UAAU,EACP,QAAQ,CACR,UAAU,CACV,SACC,iGACD;CACJ,CAAC,CACD,QAAQ,CACR,SACC,6GACD;;;;;;;;;AAUH,MAAM,oBAAoB;AAE1B,MAAa,+BAA+B,EACzC,OAAO;CACN,MAAM,EACH,QAAQ,MAAM,CACd,SACC,uFACD;CACH,YAAY,EACT,QAAQ,CACR,SACC,qOACD;CACH,aAAa,EACV,QAAQ,CACR,SACC,gFACD;CACH,cAAc,EACX,QAAQ,CACR,UAAU,CACV,SACC,oGACD;CACH,WAAW,EACR,QAAQ,CACR,UAAU,CACV,SACC,+IACD;CACH,UAAU,EACP,QAAQ,CACR,UAAU,CACV,SACC,oIACD;CACJ,CAAC,CACD,QAAQ,CACR,QAAQ,eAAe,WAAW,WAAW,SAAS,YAAY,EAAE;CACnE,SAAS;CACT,MAAM,CAAC,aAAa;CACrB,CAAC,CACD,QAAQ,eAAe,CAAC,kBAAkB,KAAK,WAAW,WAAW,EAAE;CACtE,SACE;CACF,MAAM,CAAC,aAAa;CACrB,CAAC,CACD,QACE,eACC,WAAW,aAAa,UACxB,CAAC,kBAAkB,KAAK,WAAW,SAAS,EAC9C;CACE,SAAS;CACT,MAAM,CAAC,WAAW;CACnB,CACF,CACA,SACC,4NACD;AAEH,MAAa,4BAA4B,EACtC,mBAAmB,QAAQ,CAC1B,+BACA,6BACD,CAAC,CACD,SACC,gOACD;AAuFH,MAAa,2BAA2B,EACrC,OAAO;CACN,KAAK,EACF,QAAQ,CACR,MAAM,oBAAoB,CAC1B,UAAU,CACV,SAAS,2CAA2C;CACvD,aAAa,EACV,QAAQ,CACR,UAAU,CACV,SAAS,4CAA4C;CACxD,cAAc,EACX,SAAS,CACT,UAAU,CACV,SACC,sGACD;CACH,UAAU,EACP,MAAM,EAAE,QAAQ,CAAC,CACjB,UAAU,CACV,SAAS,4DAA4D;CACxE,WAAW,EACR,SAAS,CACT,UAAU,CACV,SACC,6HACD;CACH,OAAO,EACJ,QAAQ,CACR,UAAU,CACV,SACC,+EACD;CACH,SAAS,EACN,QAAQ,CACR,MAAM,sBAAsB,CAC5B,UAAU,CACV,SACC,6HACD;CACH,WAAW,0BAA0B,UAAU;CAChD,CAAC,CACD,QAAQ,CACR,SACC,8PACD;;;;;;;AAUH,MAAM,+BAA+B;CACnC,OAAO,EACJ,QAAQ,CACR,IAAI,EAAE,CACN,SACC,uFACD;CACH,aAAa,EACV,QAAQ,CACR,MAAM,oBAAoB,CAC1B,SACC,iHACD;CACH,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4DAA4D;CACxE,QAAQ,EACL,OAAO,EAAE,QAAQ,EAAE,yBAAyB,CAC5C,QAAQ,QAAQ,OAAO,KAAK,IAAI,CAAC,UAAU,GAAG,EAC7C,SAAS,0CACV,CAAC,CACD,UAAU,CACV,SACC,8LACD;CACJ;;;;;;;;AASD,SAAS,wBACP,UACA,KACM;AACN,KAAI,CAAC,SAAS,OAAQ;CACtB,MAAM,aAAa,IAAI,IAAI,OAAO,KAAK,SAAS,OAAO,CAAC;CAGxD,MAAM,uBAAO,IAAI,KAAqB;AACtC,MAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,SAAS,OAAO,EAAE;EAC3D,MAAM,MAAM,MAAM,WAAW;AAC7B,MAAI,CAAC,IAAK;AACV,MAAI,CAAC,WAAW,IAAI,IAAI,CACtB,KAAI,SAAS;GACX,MAAM;GACN,MAAM;IAAC;IAAU;IAAM;IAAa;IAAY;GAChD,SAAS,0CAA0C,IAAI;GACxD,CAAC;AAEJ,OAAK,IAAI,MAAM,IAAI;;CAIrB,MAAM,0BAAU,IAAI,KAAa;CACjC,MAAM,2BAAW,IAAI,KAAa;CAElC,SAAS,IAAI,MAAc,OAAkC;AAC3D,MAAI,SAAS,IAAI,KAAK,CAAE,QAAO,CAAC,GAAG,OAAO,KAAK;AAC/C,MAAI,QAAQ,IAAI,KAAK,CAAE,QAAO;AAC9B,WAAS,IAAI,KAAK;EAClB,MAAM,OAAO,KAAK,IAAI,KAAK;AAC3B,MAAI,MAAM;GACR,MAAM,QAAQ,IAAI,MAAM,CAAC,GAAG,OAAO,KAAK,CAAC;AACzC,OAAI,MAAO,QAAO;;AAEpB,WAAS,OAAO,KAAK;AACrB,UAAQ,IAAI,KAAK;AACjB,SAAO;;AAGT,MAAK,MAAM,QAAQ,KAAK,MAAM,EAAE;AAC9B,MAAI,QAAQ,IAAI,KAAK,CAAE;EACvB,MAAM,QAAQ,IAAI,MAAM,EAAE,CAAC;AAC3B,MAAI,OAAO;AACT,OAAI,SAAS;IACX,MAAM;IACN,MAAM,EAAE;IACR,SAAS,wCAAwC,MAAM,KAAK,MAAM;IACnE,CAAC;AAEF;;;;AAKN,SAAS,oBAGP,aAAoB,YAAmB;AACvC,QAAO,EACJ,OAAO;EACN,MAAM;EACN,GAAG;EACH,YAAY,WAAW,SACrB,0DACD;EACF,CAAC,CACD,QAAQ,CACR,YAAY,wBAAwB;;AAGzC,MAAa,4BAA4B,EACtC,mBAAmB,QAAQ;CAC1B,oBAAoB,EAAE,QAAQ,SAAS,EAAE,uBAAuB;CAChE,oBAAoB,EAAE,QAAQ,MAAM,EAAE,oBAAoB;CAC1D,oBACE,EAAE,QAAQ,gBAAgB,EAC1B,6BACD;CACD,oBACE,EAAE,QAAQ,mBAAmB,EAC7B,gCACD;CACD,oBAAoB,EAAE,QAAQ,SAAS,EAAE,uBAAuB;CAChE,oBACE,EAAE,QAAQ,sBAAsB,EAChC,kCACD;CACD,oBAAoB,EAAE,QAAQ,cAAc,EAAE,2BAA2B;CACzE,oBACE,EAAE,QAAQ,gBAAgB,EAC1B,6BACD;CACD,oBAAoB,EAAE,QAAQ,WAAW,EAAE,yBAAyB;CACpE,oBAAoB,EAAE,QAAQ,WAAW,EAAE,yBAAyB;CACpE,oBAAoB,EAAE,QAAQ,cAAc,EAAE,2BAA2B;CACzE,oBAAoB,EAAE,QAAQ,aAAa,EAAE,2BAA2B;CACxE,oBAAoB,EAAE,QAAQ,MAAM,EAAE,oBAAoB;CAC3D,CAAC,CACD,SACC,sIACD;AAIH,MAAa,6BAAwC,EAAE,WACrD,EACG,OAAO;CACN,MAAM,EAAE,KAAK;EACX;EACA;EACA;EACA;EACA;EACA;EACD,CAAC;CACF,aAAa,EAAE,QAAQ,CAAC,UAAU;CAClC,SAAS,EAAE,SAAS,CAAC,UAAU;CAC/B,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,UAAU;CACrC,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,2BAA2B,CAAC,UAAU;CACvE,OAAO,2BAA2B,UAAU;CAC5C,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,UAAU;CAC7C,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,UAAU;CAC7C,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAKxC,sBAAsB,EACnB,MAAM,CAAC,EAAE,SAAS,EAAE,2BAA2B,CAAC,CAChD,UAAU;CACd,CAAC,CACD,QAAQ,CACZ;AAED,MAAa,qBAAgC,EAAE,WAC7C,EACG,OAAO;CACN,MAAM,EAAE,KAAK;EAAC;EAAU;EAAS;EAAU;EAAU;EAAU,CAAC;CAChE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,2BAA2B,CAAC,UAAU;CACvE,OAAO,mBAAmB,UAAU;CACpC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CACxC,sBAAsB,EAAE,SAAS,CAAC,UAAU;CAC7C,CAAC,CACD,QAAQ,CACZ;;;;;;;;AAWD,MAAM,qCAAqC;AAE3C,MAAM,kCAAkC,EACrC,QAAQ,CACR,IAAI,EAAE,CACN,IACC,oCACA,0BAA0B,mCAAmC,QAC9D;AAEH,MAAa,+BAA+B,EACzC,OAAO;CACN,MAAM,EACH,MAAM,gCAAgC,CACtC,UAAU,CACV,SAAS,qDAAqD;CACjE,QAAQ,EACL,MAAM,gCAAgC,CACtC,UAAU,CACV,SAAS,iDAAiD;CAC7D,OAAO,EACJ,MAAM,gCAAgC,CACtC,UAAU,CACV,SAAS,oDAAoD;CACjE,CAAC,CACD,QAAQ,CACR,aAAa,OAAO,QAAQ;CAE3B,MAAM,UACJ;EACE,CAAC,QAAQ,MAAM,KAAK;EACpB,CAAC,UAAU,MAAM,OAAO;EACxB,CAAC,SAAS,MAAM,MAAM;EACvB;AACH,MAAK,MAAM,CAAC,YAAY,UAAU,SAAS;AACzC,MAAI,CAAC,MAAO;EACZ,MAAM,uBAAO,IAAI,KAAqB;AACtC,QAAM,SAAS,MAAM,QAAQ;GAC3B,MAAM,OAAO,KAAK,IAAI,KAAK;AAC3B,OAAI,SAAS,QAAW;AACtB,SAAK,IAAI,MAAM,IAAI;AACnB;;AAEF,OAAI,SAAS;IACX,MAAM;IACN,MAAM,CAAC,YAAY,IAAI;IACvB,SAAS,0BAA0B,KAAK,8BAA8B;IACvE,CAAC;IACF;;CAIJ,MAAM,wBAAQ,IAAI,KAAqB;AACvC,MAAK,MAAM,CAAC,YAAY,UAAU,SAAS;AACzC,MAAI,CAAC,MAAO;AACZ,OAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;GACrC,MAAM,OAAO,MAAM;GACnB,MAAM,WAAW,MAAM,IAAI,KAAK;AAChC,OAAI,aAAa,QAAW;AAC1B,UAAM,IAAI,MAAM,WAAW;AAC3B;;AAEF,OAAI,aAAa,WACf,KAAI,SAAS;IACX,MAAM;IACN,MAAM,CAAC,YAAY,EAAE;IACrB,SAAS,eAAe,KAAK,qBAAqB,SAAS,SAAS,WAAW;IAChF,CAAC;;;EAIR,CACD,SACC,qHACD;AAIH,MAAa,uBAAuB,EACjC,OAAO;CACN,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SAAS,8CAA8C;CAC1D,MAAM,EACH,QAAQ,CACR,MAAM,oBAAoB,CAC1B,SACC,6GACD;CACH,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,6CAA6C;CACzD,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4CAA4C;CACxD,WAAW,EACR,OAAO;EACN,UAAU,EACP,MAAM,0BAA0B,CAChC,SACC,8DACD;EACH,UAAU,EACP,MAAM,0BAA0B,CAChC,SACC,6DACD;EACJ,CAAC,CACD,QAAQ,CACR,SAAS,mDAAmD;CAC/D,QAAQ,EACL,OAAO,EACN,QAAQ,mBAAmB,UAAU,EACtC,CAAC,CACD,QAAQ,CACR,UAAU,CACV,SAAS,sCAAsC;CAClD,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,8BAA8B;CACrE,SAAS,EACN,QAAQ,CACR,MAAM,mCAAmC,CACzC,UAAU,CACV,SAAS,iCAAiC;CAC7C,YAAY,EACT,KAAK,CACL,UAAU,CACV,SAAS,wCAAwC;CACpD,UAAU,EACP,MAAM,EAAE,QAAQ,CAAC,CACjB,UAAU,CACV,SAAS,gCAAgC;CAC5C,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,0BAA0B;CAClE,gBAAgB,EACb,QAAQ,CACR,UAAU,CACV,SACC,+JACD;CACH,QAAQ,EACL,SAAS,CACT,UAAU,CACV,SACC,2GACD;CACH,WAAW,EACR,KAAK,CAAC,QAAQ,KAAK,CAAC,CACpB,UAAU,CACV,SACC,+KACD;CACH,aAAa,EACV,OAAO,EACN,OAAO,6BACJ,UAAU,CACV,SACC,wEACD,EACJ,CAAC,CACD,QAAQ,CACR,UAAU,CACV,SACC,iHACD;CACJ,CAAC,CACD,QAAQ,CACR,SACC,iIACD;AAIH,MAAa,eAAe,EACzB,KAAK;CAAC;CAAQ;CAAY;CAAU;CAAM,CAAC,CAC3C,SACC,8FACD;;;;;;;;;;;;;;AAiBH,SAAS,uBAAuB,OAIC;AAC/B,KAAI,MAAM,UAAW,QAAO;AAC5B,KAAI,MAAM,UAAU,OAAW,QAAO;AACtC,KAAI,MAAM,YAAY,OAAW,QAAO;AACxC,QAAO;;;;;;;;;;AAWT,MAAa,2BAA2B,yBACrC,OAAO,EAAE,QAAQ,aAAa,UAAU,EAAE,CAAC,CAC3C,WAAW,WAAW;CACrB,GAAG;CACH,QAAQ,uBAAuB,MAAM;CACtC,EAAE;AAIL,MAAM,uCAAuC;CAC3C,OAAO,EACJ,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4CAA4C;CACxD,aAAa,EACV,QAAQ,CACR,MAAM,oBAAoB,CAC1B,SACC,yEACD;CACH,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4DAA4D;CACxE,QAAQ,EACL,OAAO,EAAE,QAAQ,EAAE,yBAAyB,CAC5C,QAAQ,QAAQ,OAAO,KAAK,IAAI,CAAC,UAAU,GAAG,EAC7C,SAAS,0CACV,CAAC,CACD,UAAU,CACV,SAAS,yDAAyD;CACtE;AAED,SAAS,4BAGP,aAAoB,YAAmB;AACvC,QAAO,EACJ,OAAO;EACN,MAAM;EACN,GAAG;EACH,YAAY,WAAW,SACrB,0DACD;EACF,CAAC,CACD,QAAQ,CACR,YAAY,wBAAwB;;AAGzC,MAAa,oCAAoC,EAC9C,mBAAmB,QAAQ;CAC1B,4BAA4B,EAAE,QAAQ,SAAS,EAAE,uBAAuB;CACxE,4BAA4B,EAAE,QAAQ,MAAM,EAAE,oBAAoB;CAClE,4BACE,EAAE,QAAQ,gBAAgB,EAC1B,6BACD;CACD,4BACE,EAAE,QAAQ,mBAAmB,EAC7B,gCACD;CACD,4BAA4B,EAAE,QAAQ,SAAS,EAAE,uBAAuB;CACxE,4BACE,EAAE,QAAQ,sBAAsB,EAChC,kCACD;CACD,4BACE,EAAE,QAAQ,cAAc,EACxB,2BACD;CACD,4BACE,EAAE,QAAQ,gBAAgB,EAC1B,6BACD;CACD,4BACE,EAAE,QAAQ,WAAW,EACrB,yBACD;CACD,4BACE,EAAE,QAAQ,WAAW,EACrB,yBACD;CACD,4BACE,EAAE,QAAQ,cAAc,EACxB,2BACD;CACD,4BACE,EAAE,QAAQ,aAAa,EACvB,2BACD;CACD,4BAA4B,EAAE,QAAQ,MAAM,EAAE,oBAAoB;CACnE,CAAC,CACD,SACC,wFACD;AAIH,MAAa,uBAAuB,EACjC,OAAO;CACN,MAAM,EACH,QAAQ,CACR,MAAM,oBAAoB,CAC1B,SACC,6GACD;CACH,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,6CAA6C;CACzD,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4CAA4C;CACxD,SAAS,EACN,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,6CAA6C;CACzD,oBAAoB,EACjB,SAAS,CACT,UAAU,CACV,SACC,sPACD;CACH,gBAAgB,EACb,QAAQ,CACR,UAAU,CACV,SACC,+JACD;CACH,WAAW,EACR,KAAK,CAAC,QAAQ,KAAK,CAAC,CACpB,UAAU,CACV,SACC,mIACD;CACH,aAAa,EACV,OAAO,EACN,OAAO,6BACJ,UAAU,CACV,SACC,+EACD,EACJ,CAAC,CACD,QAAQ,CACR,UAAU,CACV,SACC,yEACD;CACH,WAAW,EACR,OAAO;EACN,UAAU,EACP,MAAM,kCAAkC,CACxC,SACC,8DACD;EACH,UAAU,EACP,MAAM,kCAAkC,CACxC,SACC,6DACD;EACJ,CAAC,CACD,QAAQ,CACR,SAAS,mDAAmD;CAChE,CAAC,CACD,QAAQ,CACR,SAAS,kDAAkD;AAI9D,MAAa,wBAAwB,EAClC,OAAO;CACN,aAAa,EAAE,QAAQ,CAAC,SAAS,0CAA0C;CAC3E,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,SAAS,iCAAiC;CAC3E,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SAAS,+CAA+C;CAC3D,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,+BAA+B;CACxE,CAAC,CACD,QAAQ,CACR,SAAS,sCAAsC;;;;;;AAOlD,MAAM,8BAA8B;AAEpC,MAAM,4BAA4B,EAC/B,QAAQ,CACR,IACC,6BACA,uBAAuB,4BAA4B,QACpD;AAEH,MAAa,yBAAyB,EACnC,OAAO;CACN,OAAO,EACJ,MAAM,0BAA0B,CAChC,UAAU,CACV,SAAS,oDAAoD;CAChE,MAAM,EACH,MAAM,0BAA0B,CAChC,UAAU,CACV,SAAS,qDAAqD;CACjE,QAAQ,EACL,MAAM,0BAA0B,CAChC,UAAU,CACV,SACC,kFACD;CACJ,CAAC,CACD,QAAQ,CACR,SAAS,2CAA2C;AAEvD,MAAa,8BAA8B,EACxC,OAAO;CACN,SAAS,EACN,QAAQ,CACR,SAAS,0DAA0D;CACtE,OAAO,EACJ,OAAO,EAAE,QAAQ,EAAE,sBAAsB,CACzC,UAAU,CACV,SAAS,uCAAuC;CACnD,OAAO,uBACJ,UAAU,CACV,SAAS,2CAA2C;CACxD,CAAC,CACD,QAAQ,CACR,SACC,kFACD;;;;;;;;;;;;AAaH,MAAa,uBAAuB;CAClC,SAAS;CACT,OAAO;EACL,UAAU;GACR,aACE;GACF,UAAU;GACV,SAAS;GACV;EACD,cAAc;GACZ,aAAa;GACb,UAAU;GACX;EACD,aAAa;GACX,aAAa;GACb,UAAU;GACX;EACD,cAAc;GACZ,aACE;GACF,UAAU;GACV,SAAS;GACV;EACD,SAAS;GACP,aACE;GACF,UAAU;GACX;EACD,gBAAgB;GACd,aAAa;GACb,UAAU;GACX;EACD,iBAAiB;GACf,aAAa;GACb,UAAU;GACX;EACD,SAAS;GACP,aAAa;GACb,UAAU;GACX;EACD,kBAAkB;GAChB,aACE;GACF,UAAU;GACX;EACD,aAAa;GACX,aACE;GACF,UAAU;GACX;EACF;CACD,OAAO;EACL,MAAM,CACJ,yHACA,iFACD;EACD,QAAQ,CAAC,uDAAuD;EAChE,OAAO,CACL,6DACA,2DACD;EACF;CACF;AAID,MAAa,gCAAgC,EAC1C,OAAO;CACN,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SAAS,8CAA8C;CAC1D,SAAS,EACN,KAAK;EAAC;EAAO;EAAO;EAAM,CAAC,CAC3B,SAAS,mDAAmD;CAC/D,SAAS,EACN,OAAO,EAAE,QAAQ,EAAE,qBAAqB,CACxC,SAAS,4DAA4D;CACxE,aAAa,4BACV,UAAU,CACV,SACC,sFACD;CACJ,CAAC,CACD,QAAQ,CACR,aAAa,OAAO,QAAQ;AAC3B,KAAI,MAAM,YAAY,SAAS,CAAC,MAAM,YACpC,KAAI,SAAS;EACX,MAAM;EACN,MAAM,CAAC,cAAc;EACrB,SAAS;EACV,CAAC;EAEJ,CACD,SACC,qJACD"}
1
+ {"version":3,"file":"manifest.js","names":[],"sources":["../../src/schemas/manifest.ts"],"sourcesContent":["/**\n * Zod-authoring module for AppKit plugin manifest schemas.\n *\n * Single source of truth for the plugin manifest contract. JSON Schema\n * artifacts published at the docs URL are emitted from these schemas via\n * `tools/generate-json-schema.ts` and live only in `docs/static/schemas/`\n * (no package-internal copies).\n *\n * - Cross-field constraints (cycle/dangling-reference checks, `<PROFILE>`\n * placeholder, post-scaffold instruction non-empty) are refinements\n * co-located with the shape they constrain. Validation is driven through\n * the Standard Schema interface from `validate-manifest.ts`.\n * - `templateFieldEntrySchema` is a transform that emits `origin` from\n * `localOnly`/`value`/`resolve`. The input slot is still allowed so\n * re-parsing previously-synced template manifests does not fail, but the\n * transform always overwrites it — drift-by-construction for hand-edits.\n * - `discoveryDescriptorSchema` is a discriminated union over a `type`\n * literal. The `kind` variant references one of the well-known\n * `resourceKind` values for which AppKit owns the CLI command map (see\n * `RESOURCE_KIND_COMMANDS` below). The `cli` variant is the escape hatch\n * carrying the existing free-form fields (with the `<PROFILE>`\n * refinement). Hierarchical context for volumes (catalog/schema parent\n * walk) is encoded via the kind's `parents` array, not via dependsOn.\n * - Scaffolding rule items carry a `maxLength` (120 chars) so\n * `rules.never[]` / `rules.must[]` / `rules.should[]` stay short\n * directives by contract, and the canonical `TEMPLATE_SCAFFOLDING`\n * constant lives co-located with the scaffolding schemas (sync.ts\n * imports it).\n */\n\nimport { z } from \"zod\";\n\n// ── Resource type + per-type permission enums ────────────────────────────\n\nexport const resourceTypeSchema = z\n .enum([\n \"secret\",\n \"job\",\n \"sql_warehouse\",\n \"serving_endpoint\",\n \"volume\",\n \"vector_search_index\",\n \"uc_function\",\n \"uc_connection\",\n \"database\",\n \"postgres\",\n \"genie_space\",\n \"experiment\",\n \"app\",\n ])\n .describe(\"Type of Databricks resource\");\n\nexport const secretPermissionSchema = z\n .enum([\"READ\", \"WRITE\", \"MANAGE\"])\n .describe(\"Permission for secret resources (order: weakest to strongest)\");\n\nexport const jobPermissionSchema = z\n .enum([\"CAN_VIEW\", \"CAN_MANAGE_RUN\", \"CAN_MANAGE\"])\n .describe(\"Permission for job resources (order: weakest to strongest)\");\n\nexport const sqlWarehousePermissionSchema = z\n .enum([\"CAN_USE\", \"CAN_MANAGE\"])\n .describe(\n \"Permission for SQL warehouse resources (order: weakest to strongest)\",\n );\n\nexport const servingEndpointPermissionSchema = z\n .enum([\"CAN_VIEW\", \"CAN_QUERY\", \"CAN_MANAGE\"])\n .describe(\n \"Permission for serving endpoint resources (order: weakest to strongest)\",\n );\n\nexport const volumePermissionSchema = z\n .enum([\"READ_VOLUME\", \"WRITE_VOLUME\"])\n .describe(\"Permission for Unity Catalog volume resources\");\n\nexport const vectorSearchIndexPermissionSchema = z\n .enum([\"SELECT\"])\n .describe(\"Permission for vector search index resources\");\n\nexport const ucFunctionPermissionSchema = z\n .enum([\"EXECUTE\"])\n .describe(\"Permission for Unity Catalog function resources\");\n\nexport const ucConnectionPermissionSchema = z\n .enum([\"USE_CONNECTION\"])\n .describe(\"Permission for Unity Catalog connection resources\");\n\nexport const databasePermissionSchema = z\n .enum([\"CAN_CONNECT_AND_CREATE\"])\n .describe(\"Permission for database resources\");\n\nexport const postgresPermissionSchema = z\n .enum([\"CAN_CONNECT_AND_CREATE\"])\n .describe(\"Permission for Postgres resources\");\n\nexport const genieSpacePermissionSchema = z\n .enum([\"CAN_VIEW\", \"CAN_RUN\", \"CAN_EDIT\", \"CAN_MANAGE\"])\n .describe(\n \"Permission for Genie Space resources (order: weakest to strongest)\",\n );\n\nexport const experimentPermissionSchema = z\n .enum([\"CAN_READ\", \"CAN_EDIT\", \"CAN_MANAGE\"])\n .describe(\n \"Permission for MLflow experiment resources (order: weakest to strongest)\",\n );\n\nexport const appPermissionSchema = z\n .enum([\"CAN_USE\"])\n .describe(\"Permission for Databricks App resources\");\n\n// ── Discovery descriptor (discriminated union) ───────────────────────────\n\n/**\n * Well-known Databricks resource kinds for which AppKit owns the CLI\n * command map. Plugins reference one of these via the `kind` variant of the\n * discovery descriptor; everything else falls back to the free-form `cli`\n * variant.\n *\n * Kept narrow on purpose: each entry costs an addition to\n * `RESOURCE_KIND_COMMANDS` below, which is the single source of truth for\n * how that kind is enumerated.\n */\nexport const resourceKindSchema = z\n .enum([\n \"warehouse\",\n \"genie_space\",\n \"postgres_project\",\n \"postgres_branch\",\n \"postgres_database\",\n \"volume\",\n ])\n .describe(\n \"Well-known Databricks resource kind whose listing command is owned by AppKit (see RESOURCE_KIND_COMMANDS).\",\n );\n\nexport const kindDiscoveryDescriptorSchema = z\n .object({\n type: z\n .literal(\"kind\")\n .describe(\n \"Discriminator: 'kind' uses the AppKit-owned command map for the named resourceKind.\",\n ),\n resourceKind: resourceKindSchema.describe(\n \"Reference to a well-known Databricks resource kind. AppKit owns the CLI command, response shape, and unwrap rules.\",\n ),\n select: z\n .string()\n .optional()\n .describe(\n \"Field name in the parsed CLI response used as the selected value (e.g., 'id'). Defaults to the kind's natural identifier when omitted.\",\n ),\n display: z\n .string()\n .optional()\n .describe(\n \"Field name in the parsed CLI response shown to the user in selection UI. Defaults to `select` if omitted.\",\n ),\n dependsOn: z\n .string()\n .optional()\n .describe(\n \"Name of a sibling field within the same resource that must be resolved first. Used to express ordering dependencies between resource fields.\",\n ),\n shortcut: z\n .string()\n .optional()\n .describe(\n \"Single-value fast-path command that returns exactly one value, skipping interactive selection.\",\n ),\n })\n .strict()\n .describe(\n \"Discovery via a well-known resource kind. AppKit owns the CLI command and unwrap rules for the named kind.\",\n );\n\n/**\n * Shell metacharacters rejected on free-form CLI command strings. Catches the\n * common foot-guns (statement separators, pipes, redirects via shell, command\n * substitution, newlines). Not a security boundary on its own — executors must\n * always pass these via argv, never shell-exec the string. Angle brackets are\n * permitted because `<PROFILE>` (and future `<…>` placeholders) are part of\n * the command-template convention.\n */\nconst SHELL_METACHAR_RE = /[;|&`$\\n\\r]/;\n\nexport const cliDiscoveryDescriptorSchema = z\n .object({\n type: z\n .literal(\"cli\")\n .describe(\n \"Discriminator: 'cli' uses a free-form Databricks CLI command supplied by the plugin.\",\n ),\n cliCommand: z\n .string()\n .describe(\n \"Databricks CLI command that lists resources. Must include <PROFILE>. Shell metacharacters (;|&`$ and newlines) are rejected; for first-party Databricks resources prefer the `kind` variant which uses AppKit's typed command map.\",\n ),\n selectField: z\n .string()\n .describe(\n \"jq-style path to the field used as the selected value (e.g., '.id', '.name').\",\n ),\n displayField: z\n .string()\n .optional()\n .describe(\n \"jq-style path to the field shown to the user in selection UI. Defaults to selectField if omitted.\",\n ),\n dependsOn: z\n .string()\n .optional()\n .describe(\n \"Name of a sibling field within the same resource that must be resolved first. Used to express ordering dependencies between resource fields.\",\n ),\n shortcut: z\n .string()\n .optional()\n .describe(\n \"Single-value fast-path command that returns exactly one value, skipping interactive selection. Shell metacharacters are rejected.\",\n ),\n })\n .strict()\n .refine((descriptor) => descriptor.cliCommand.includes(\"<PROFILE>\"), {\n message: \"must include <PROFILE> placeholder\",\n path: [\"cliCommand\"],\n })\n .refine((descriptor) => !SHELL_METACHAR_RE.test(descriptor.cliCommand), {\n message:\n \"must not contain shell metacharacters (;|&`$ or newlines); use the `kind` variant for typed Databricks resources\",\n path: [\"cliCommand\"],\n })\n .refine(\n (descriptor) =>\n descriptor.shortcut === undefined ||\n !SHELL_METACHAR_RE.test(descriptor.shortcut),\n {\n message: \"must not contain shell metacharacters (;|&`$ or newlines)\",\n path: [\"shortcut\"],\n },\n )\n .describe(\n \"Discovery via a free-form Databricks CLI command. Escape hatch — prefer the `kind` variant when a typed resourceKind covers the resource. This shape is intentionally minimal and may tighten further in future versions.\",\n );\n\nexport const discoveryDescriptorSchema = z\n .discriminatedUnion(\"type\", [\n kindDiscoveryDescriptorSchema,\n cliDiscoveryDescriptorSchema,\n ])\n .describe(\n \"Describes how the CLI discovers values for a resource field. 'kind' references a well-known Databricks resource kind whose command is owned by AppKit; 'cli' is the escape hatch carrying a free-form Databricks CLI command.\",\n );\n\n// ── Resource kind → CLI command map ──────────────────────────────────────\n\n/**\n * Descriptor for how a well-known resource kind is listed via the\n * Databricks CLI.\n *\n * - `command` is the CLI invocation template. It carries two kinds of\n * placeholders:\n * - `<PROFILE>` — substituted with the user's CLI profile by the runner.\n * - `{<fieldName>}` — substituted with the resolved value of the named\n * sibling field (used for `dependsOn` chains).\n * - `unwrap`, when set, is the JSON path into the response wrapper (e.g.,\n * `\"warehouses\"` for `{ warehouses: [...] }`). Omitted when the response\n * is already a flat array.\n * - `parents`, when set, lists transient query inputs the runner must\n * collect (as free-text prompts) before invoking the command. Each\n * `parents[i]` value substitutes the matching `{name}` placeholder in\n * the command string. Unlike `dependsOn` (which references a sibling\n * field on the same resource), `parents` covers inputs that aren't\n * persisted as fields on the resource.\n */\nexport type ResourceKindCommand = {\n command: string;\n unwrap?: string;\n parents?: readonly string[];\n};\n\n/**\n * Single source of truth for AppKit-owned discovery commands.\n *\n * To add a new resource kind: extend `resourceKindSchema` and add an entry\n * here. Plugins reference the kind via `discovery: { type: \"kind\",\n * resourceKind: \"...\" }` and inherit the command + response shape.\n *\n * `unwrap` defaults are unset: the existing core plugin manifests use simple\n * jq paths (`.id`, `.name`, `.full_name`), implying the listed CLI commands\n * return flat arrays. Refine in a follow-up if a kind's CLI returns wrapped\n * data.\n *\n * Volume's catalog/schema parent context is supplied via the `parents`\n * array, which the runner collects from the user as free-text prompts\n * before invoking the listing command.\n */\nexport const RESOURCE_KIND_COMMANDS: Record<\n z.infer<typeof resourceKindSchema>,\n { command: string; unwrap?: string; parents?: readonly string[] }\n> = {\n warehouse: {\n command: \"databricks warehouses list --profile <PROFILE> --output json\",\n },\n genie_space: {\n command: \"databricks genie list-spaces --profile <PROFILE> --output json\",\n },\n postgres_project: {\n command:\n \"databricks postgres list-projects --profile <PROFILE> --output json\",\n },\n postgres_branch: {\n // {project} is a placeholder for the resolved value of the `project`\n // sibling field (declared via `dependsOn: \"project\"` on the kind variant).\n // The Databricks CLI requires the parent project resource name (format\n // `projects/{project_id}`) as a positional argument.\n command:\n \"databricks postgres list-branches {project} --profile <PROFILE> --output json\",\n },\n postgres_database: {\n // {branch} is a placeholder for the resolved value of the `branch`\n // sibling field (declared via `dependsOn: \"branch\"` on the kind variant).\n command:\n \"databricks postgres list-databases {branch} --profile <PROFILE> --output json\",\n },\n volume: {\n // `parents` declares free-text user prompts the runner must collect before\n // invoking the discovery command. Each `parents[i]` value substitutes the\n // matching `{name}` placeholder in the command string above. Unlike\n // `dependsOn` (which references a sibling field on the same resource),\n // `parents` covers transient query inputs that aren't persisted as fields.\n command:\n \"databricks volumes list {catalog} {schema} --profile <PROFILE> --output json\",\n parents: [\"catalog\", \"schema\"] as const,\n },\n};\n\n// ── Resource field entry (plugin manifest variant) ───────────────────────\n\nexport const resourceFieldEntrySchema = z\n .object({\n env: z\n .string()\n .regex(/^[A-Z][A-Z0-9_]*$/)\n .optional()\n .describe(\"Environment variable name for this field\"),\n description: z\n .string()\n .optional()\n .describe(\"Human-readable description for this field\"),\n bundleIgnore: z\n .boolean()\n .optional()\n .describe(\n \"When true, this field is excluded from Databricks bundle configuration (databricks.yml) generation.\",\n ),\n examples: z\n .array(z.string())\n .optional()\n .describe(\"Example values showing the expected format for this field\"),\n localOnly: z\n .boolean()\n .optional()\n .describe(\n \"When true, this field is only generated for local .env files. The Databricks Apps platform auto-injects it at deploy time.\",\n ),\n value: z\n .string()\n .optional()\n .describe(\n \"Static value for this field. Used when no prompted or resolved value exists.\",\n ),\n resolve: z\n .string()\n .regex(/^[a-z_]+:[a-zA-Z]+$/)\n .optional()\n .describe(\n \"Named resolver prefixed by resource type (e.g., 'postgres:host'). The CLI resolves this value during the init prompt flow.\",\n ),\n discovery: discoveryDescriptorSchema.optional(),\n })\n .strict()\n .describe(\n \"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).\",\n );\n\n// ── Resource requirement (per-type permission discriminator) ─────────────\n\n/**\n * Build a per-type variant. Each variant fixes `type` to a literal and constrains\n * `permission` to the matching enum, mirroring the existing JSON Schema's\n * `allOf + if/then` block. `fields` and the rest of the shape come from a\n * shared base.\n */\nconst resourceRequirementBaseShape = {\n alias: z\n .string()\n .min(1)\n .describe(\n \"Human-readable label for UI/display only. Deduplication uses resourceKey, not alias.\",\n ),\n resourceKey: z\n .string()\n .regex(/^[a-z][a-z0-9-]*$/)\n .describe(\n \"Stable key for machine use: deduplication, env naming, composite keys, app.yaml. Required for registry lookup.\",\n ),\n description: z\n .string()\n .min(1)\n .describe(\"Human-readable description of why this resource is needed\"),\n fields: z\n .record(z.string(), resourceFieldEntrySchema)\n .refine((obj) => Object.keys(obj).length >= 1, {\n message: \"fields must contain at least one entry\",\n })\n .optional()\n .describe(\n \"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).\",\n ),\n};\n\n/**\n * Adds the cycle/dangling-reference cross-field check to a resource variant.\n * Iterates the resource's `fields`, validates each `discovery.dependsOn` target\n * is a sibling field name, then runs DFS over the dependsOn graph to detect\n * cycles. Issue paths target either the offending field's `dependsOn` slot or\n * the resource itself for cycles.\n */\nfunction refineResourceDependsOn(\n resource: { fields?: Record<string, { discovery?: { dependsOn?: string } }> },\n ctx: z.core.$RefinementCtx,\n): void {\n if (!resource.fields) return;\n const fieldNames = new Set(Object.keys(resource.fields));\n\n // Pass 1: validate dependsOn references and build the dependency graph.\n const deps = new Map<string, string>();\n for (const [name, field] of Object.entries(resource.fields)) {\n const dep = field.discovery?.dependsOn;\n if (!dep) continue;\n if (!fieldNames.has(dep)) {\n ctx.addIssue({\n code: \"custom\",\n path: [\"fields\", name, \"discovery\", \"dependsOn\"],\n message: `references non-existent sibling field '${dep}'`,\n });\n }\n deps.set(name, dep);\n }\n\n // Pass 2: detect cycles via DFS. Emit one issue per cycle found.\n const visited = new Set<string>();\n const visiting = new Set<string>();\n\n function dfs(node: string, chain: string[]): string[] | null {\n if (visiting.has(node)) return [...chain, node];\n if (visited.has(node)) return null;\n visiting.add(node);\n const next = deps.get(node);\n if (next) {\n const cycle = dfs(next, [...chain, node]);\n if (cycle) return cycle;\n }\n visiting.delete(node);\n visited.add(node);\n return null;\n }\n\n for (const node of deps.keys()) {\n if (visited.has(node)) continue;\n const cycle = dfs(node, []);\n if (cycle) {\n ctx.addIssue({\n code: \"custom\",\n path: [],\n message: `discovery.dependsOn creates a cycle: ${cycle.join(\" → \")}`,\n });\n // One cycle error per resource is enough.\n break;\n }\n }\n}\n\nfunction makeResourceVariant<\n TType extends z.ZodLiteral<string>,\n TPerm extends z.ZodTypeAny,\n>(typeLiteral: TType, permission: TPerm) {\n return z\n .object({\n type: typeLiteral,\n ...resourceRequirementBaseShape,\n permission: permission.describe(\n \"Required permission level. Validated per resource type.\",\n ),\n })\n .strict()\n .superRefine(refineResourceDependsOn);\n}\n\nexport const resourceRequirementSchema = z\n .discriminatedUnion(\"type\", [\n makeResourceVariant(z.literal(\"secret\"), secretPermissionSchema),\n makeResourceVariant(z.literal(\"job\"), jobPermissionSchema),\n makeResourceVariant(\n z.literal(\"sql_warehouse\"),\n sqlWarehousePermissionSchema,\n ),\n makeResourceVariant(\n z.literal(\"serving_endpoint\"),\n servingEndpointPermissionSchema,\n ),\n makeResourceVariant(z.literal(\"volume\"), volumePermissionSchema),\n makeResourceVariant(\n z.literal(\"vector_search_index\"),\n vectorSearchIndexPermissionSchema,\n ),\n makeResourceVariant(z.literal(\"uc_function\"), ucFunctionPermissionSchema),\n makeResourceVariant(\n z.literal(\"uc_connection\"),\n ucConnectionPermissionSchema,\n ),\n makeResourceVariant(z.literal(\"database\"), databasePermissionSchema),\n makeResourceVariant(z.literal(\"postgres\"), postgresPermissionSchema),\n makeResourceVariant(z.literal(\"genie_space\"), genieSpacePermissionSchema),\n makeResourceVariant(z.literal(\"experiment\"), experimentPermissionSchema),\n makeResourceVariant(z.literal(\"app\"), appPermissionSchema),\n ])\n .describe(\n \"Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().\",\n );\n\n// ── Config schema (recursive) ────────────────────────────────────────────\n\nexport const configSchemaPropertySchema: z.ZodType = z.lazy(() =>\n z\n .object({\n type: z.enum([\n \"object\",\n \"array\",\n \"string\",\n \"number\",\n \"boolean\",\n \"integer\",\n ]),\n description: z.string().optional(),\n default: z.unknown().optional(),\n enum: z.array(z.unknown()).optional(),\n properties: z.record(z.string(), configSchemaPropertySchema).optional(),\n items: configSchemaPropertySchema.optional(),\n minimum: z.number().optional(),\n maximum: z.number().optional(),\n minLength: z.number().int().min(0).optional(),\n maxLength: z.number().int().min(0).optional(),\n required: z.array(z.string()).optional(),\n // `additionalProperties` is a standard JSON Schema keyword used by core\n // plugin manifests (e.g., serving, vector-search, genie) to constrain\n // dictionary-shaped properties. Allowed on nested property entries as\n // either a boolean or a sub-schema, mirroring JSON Schema semantics.\n additionalProperties: z\n .union([z.boolean(), configSchemaPropertySchema])\n .optional(),\n })\n .strict(),\n);\n\nexport const configSchemaSchema: z.ZodType = z.lazy(() =>\n z\n .object({\n type: z.enum([\"object\", \"array\", \"string\", \"number\", \"boolean\"]),\n properties: z.record(z.string(), configSchemaPropertySchema).optional(),\n items: configSchemaSchema.optional(),\n required: z.array(z.string()).optional(),\n additionalProperties: z.boolean().optional(),\n })\n .strict(),\n);\n\n// ── Plugin-level scaffolding rules ───────────────────────────────────────\n\n/**\n * Per-item upper bound on plugin-level scaffolding rule strings. Matches the\n * template-level `SCAFFOLDING_RULE_MAX_LENGTH` defined below — rules at both\n * levels are short directives, not prose. The literal value lives here (and\n * not by reference to the template-side constant) because this declaration\n * is read in source order and the template constant is declared later.\n */\nconst PLUGIN_SCAFFOLDING_RULE_MAX_LENGTH = 120;\n\nconst pluginScaffoldingRuleItemSchema = z\n .string()\n .min(1)\n .max(\n PLUGIN_SCAFFOLDING_RULE_MAX_LENGTH,\n `rule entries must be ≤ ${PLUGIN_SCAFFOLDING_RULE_MAX_LENGTH} chars`,\n );\n\nexport const pluginScaffoldingRulesSchema = z\n .object({\n must: z\n .array(pluginScaffoldingRuleItemSchema)\n .optional()\n .describe(\"Actions the scaffolding agent must always perform.\"),\n should: z\n .array(pluginScaffoldingRuleItemSchema)\n .optional()\n .describe(\"Recommended actions for the scaffolding agent.\"),\n never: z\n .array(pluginScaffoldingRuleItemSchema)\n .optional()\n .describe(\"Actions the scaffolding agent must never perform.\"),\n })\n .strict()\n .superRefine((rules, ctx) => {\n // (a) Reject duplicate entries within any single array.\n const buckets: Array<[\"must\" | \"should\" | \"never\", string[] | undefined]> =\n [\n [\"must\", rules.must],\n [\"should\", rules.should],\n [\"never\", rules.never],\n ];\n for (const [bucketName, items] of buckets) {\n if (!items) continue;\n const seen = new Map<string, number>();\n items.forEach((item, idx) => {\n const prev = seen.get(item);\n if (prev === undefined) {\n seen.set(item, idx);\n return;\n }\n ctx.addIssue({\n code: \"custom\",\n path: [bucketName, idx],\n message: `duplicate rule entry: \"${item}\" already declared at index ${prev}`,\n });\n });\n }\n // (b) Reject a string that appears in more than one of must/should/never.\n type Bucket = \"must\" | \"should\" | \"never\";\n const owner = new Map<string, Bucket>();\n for (const [bucketName, items] of buckets) {\n if (!items) continue;\n for (let i = 0; i < items.length; i++) {\n const item = items[i];\n const existing = owner.get(item);\n if (existing === undefined) {\n owner.set(item, bucketName);\n continue;\n }\n if (existing !== bucketName) {\n ctx.addIssue({\n code: \"custom\",\n path: [bucketName, i],\n message: `rule entry \"${item}\" appears in both '${existing}' and '${bucketName}'; rules must belong to exactly one bucket`,\n });\n }\n }\n }\n })\n .describe(\n \"Structured rules for scaffolding agents declared at the plugin level. Each rule is a short directive (≤120 chars).\",\n );\n\n// ── Plugin manifest (root) ───────────────────────────────────────────────\n\nexport const pluginManifestSchema = z\n .object({\n $schema: z\n .string()\n .optional()\n .describe(\"Reference to the JSON Schema for validation\"),\n name: z\n .string()\n .regex(/^[a-z][a-z0-9-]*$/)\n .describe(\n \"Plugin identifier. Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens.\",\n ),\n displayName: z\n .string()\n .min(1)\n .describe(\"Human-readable display name for UI and CLI\"),\n description: z\n .string()\n .min(1)\n .describe(\"Brief description of what the plugin does\"),\n resources: z\n .object({\n required: z\n .array(resourceRequirementSchema)\n .describe(\n \"Resources that must be available for the plugin to function\",\n ),\n optional: z\n .array(resourceRequirementSchema)\n .describe(\n \"Resources that enhance functionality but are not mandatory\",\n ),\n })\n .strict()\n .describe(\"Databricks resource requirements for this plugin\"),\n config: z\n .object({\n schema: configSchemaSchema.optional(),\n })\n .strict()\n .optional()\n .describe(\"Configuration schema for the plugin\"),\n author: z.string().optional().describe(\"Author name or organization\"),\n version: z\n .string()\n .regex(/^\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.]+)?$/)\n .optional()\n .describe(\"Plugin version (semver format)\"),\n repository: z\n .url()\n .optional()\n .describe(\"URL to the plugin's source repository\"),\n keywords: z\n .array(z.string())\n .optional()\n .describe(\"Keywords for plugin discovery\"),\n license: z.string().optional().describe(\"SPDX license identifier\"),\n onSetupMessage: z\n .string()\n .optional()\n .describe(\n \"Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning).\",\n ),\n hidden: z\n .boolean()\n .optional()\n .describe(\n \"When true, this plugin is excluded from the template plugins manifest (appkit.plugins.json) during sync.\",\n ),\n devOnly: z\n .boolean()\n .optional()\n .describe(\n \"When true, this plugin is only registered when NODE_ENV === 'development'. In any other environment createApp skips it entirely (not constructed, no routes, resources not validated). Use for dev-only tooling that must never run in a deployed app.\",\n ),\n stability: z\n .enum([\"beta\", \"ga\"])\n .optional()\n .describe(\n \"Plugin stability level. Beta plugins may have breaking API changes between minor releases but are on a path to GA. GA (general availability) plugins follow semver strictly.\",\n ),\n scaffolding: z\n .object({\n rules: pluginScaffoldingRulesSchema\n .optional()\n .describe(\n \"Structured rules for scaffolding agents declared at the plugin level.\",\n ),\n })\n .strict()\n .optional()\n .describe(\n \"Plugin-level scaffolding metadata consumed by scaffolding agents. Symmetric with template-level `scaffolding`.\",\n ),\n })\n .strict()\n .describe(\n \"Schema for Databricks AppKit plugin manifest files. Defines plugin metadata, resource requirements, and configuration options.\",\n );\n\n// ── Origin enum ──────────────────────────────────────────────────────────\n\nexport const originSchema = z\n .enum([\"user\", \"platform\", \"static\", \"cli\"])\n .describe(\n \"How the field value is determined. Computed during sync, not authored by plugin developers.\",\n );\n\n// ── Template field entry (origin computed by transform) ─────────────────\n\n/**\n * Derives the canonical origin of a resource field value from its shape.\n *\n * - `localOnly: true` → `\"platform\"` (auto-injected by the Databricks Apps\n * platform at deploy time; takes precedence over `value`/`resolve`).\n * - `value !== undefined` → `\"static\"` (hardcoded value).\n * - `resolve !== undefined` → `\"cli\"` (resolved by the CLI during init).\n * - else → `\"user\"` (user must provide the value at init time).\n *\n * Co-located with `templateFieldEntrySchema` because the transform is the\n * only consumer. Kept private so any other \"origin computation\" goes\n * through the schema rather than re-implementing the rules.\n */\nfunction computeOriginFromField(field: {\n localOnly?: boolean;\n value?: string;\n resolve?: string;\n}): z.infer<typeof originSchema> {\n if (field.localOnly) return \"platform\";\n if (field.value !== undefined) return \"static\";\n if (field.resolve !== undefined) return \"cli\";\n return \"user\";\n}\n\n/**\n * Template field entry: extends the plugin manifest field entry with an\n * optional `origin` input slot, then runs a `.transform()` that overwrites\n * `origin` with the computed value. Allowing `origin` on input means\n * re-parsing a previously-synced template manifest does not fail; emitting\n * `origin` always means hand-edits in synced JSON are silently corrected\n * on the next parse — drift-by-construction.\n */\nexport const templateFieldEntrySchema = resourceFieldEntrySchema\n .extend({ origin: originSchema.optional() })\n .transform((field) => ({\n ...field,\n origin: computeOriginFromField(field),\n }));\n\n// ── Template resource requirement (uses templateFieldEntrySchema) ────────\n\nconst templateResourceRequirementBaseShape = {\n alias: z\n .string()\n .min(1)\n .describe(\"Human-readable label for UI/display only.\"),\n resourceKey: z\n .string()\n .regex(/^[a-z][a-z0-9-]*$/)\n .describe(\n \"Stable key for machine use: deduplication, env naming, composite keys.\",\n ),\n description: z\n .string()\n .min(1)\n .describe(\"Human-readable description of why this resource is needed\"),\n fields: z\n .record(z.string(), templateFieldEntrySchema)\n .refine((obj) => Object.keys(obj).length >= 1, {\n message: \"fields must contain at least one entry\",\n })\n .optional()\n .describe(\"Map of field name to field entry with computed origin.\"),\n};\n\nfunction makeTemplateResourceVariant<\n TType extends z.ZodLiteral<string>,\n TPerm extends z.ZodTypeAny,\n>(typeLiteral: TType, permission: TPerm) {\n return z\n .object({\n type: typeLiteral,\n ...templateResourceRequirementBaseShape,\n permission: permission.describe(\n \"Required permission level. Validated per resource type.\",\n ),\n })\n .strict()\n .superRefine(refineResourceDependsOn);\n}\n\nexport const templateResourceRequirementSchema = z\n .discriminatedUnion(\"type\", [\n makeTemplateResourceVariant(z.literal(\"secret\"), secretPermissionSchema),\n makeTemplateResourceVariant(z.literal(\"job\"), jobPermissionSchema),\n makeTemplateResourceVariant(\n z.literal(\"sql_warehouse\"),\n sqlWarehousePermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"serving_endpoint\"),\n servingEndpointPermissionSchema,\n ),\n makeTemplateResourceVariant(z.literal(\"volume\"), volumePermissionSchema),\n makeTemplateResourceVariant(\n z.literal(\"vector_search_index\"),\n vectorSearchIndexPermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"uc_function\"),\n ucFunctionPermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"uc_connection\"),\n ucConnectionPermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"database\"),\n databasePermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"postgres\"),\n postgresPermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"genie_space\"),\n genieSpacePermissionSchema,\n ),\n makeTemplateResourceVariant(\n z.literal(\"experiment\"),\n experimentPermissionSchema,\n ),\n makeTemplateResourceVariant(z.literal(\"app\"), appPermissionSchema),\n ])\n .describe(\n \"Resource requirement with template-specific field entries (includes computed origin).\",\n );\n\n// ── Template plugin (extends plugin manifest) ────────────────────────────\n\nexport const templatePluginSchema = z\n .object({\n name: z\n .string()\n .regex(/^[a-z][a-z0-9-]*$/)\n .describe(\n \"Plugin identifier. Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens.\",\n ),\n displayName: z\n .string()\n .min(1)\n .describe(\"Human-readable display name for UI and CLI\"),\n description: z\n .string()\n .min(1)\n .describe(\"Brief description of what the plugin does\"),\n package: z\n .string()\n .min(1)\n .describe(\"NPM package name that provides this plugin\"),\n requiredByTemplate: z\n .boolean()\n .optional()\n .describe(\n \"When true, this plugin is required by the template and cannot be deselected during CLI init. The user will only be prompted to configure its resources. When absent or false, the plugin is optional and the user can choose whether to include it.\",\n ),\n onSetupMessage: z\n .string()\n .optional()\n .describe(\n \"Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning).\",\n ),\n stability: z\n .enum([\"beta\", \"ga\"])\n .optional()\n .describe(\n \"Plugin stability level. Beta is heading to GA; APIs may change between minor releases. GA (general availability) follows semver.\",\n ),\n scaffolding: z\n .object({\n rules: pluginScaffoldingRulesSchema\n .optional()\n .describe(\n \"Structured rules for scaffolding agents propagated from the plugin manifest.\",\n ),\n })\n .strict()\n .optional()\n .describe(\n \"Plugin-level scaffolding metadata propagated from the plugin manifest.\",\n ),\n resources: z\n .object({\n required: z\n .array(templateResourceRequirementSchema)\n .describe(\n \"Resources that must be available for the plugin to function\",\n ),\n optional: z\n .array(templateResourceRequirementSchema)\n .describe(\n \"Resources that enhance functionality but are not mandatory\",\n ),\n })\n .strict()\n .describe(\"Databricks resource requirements for this plugin\"),\n })\n .strict()\n .describe(\"Plugin manifest with package source information\");\n\n// ── Scaffolding descriptor ───────────────────────────────────────────────\n\nexport const scaffoldingFlagSchema = z\n .object({\n description: z.string().describe(\"Human-readable description of the flag.\"),\n required: z.boolean().optional().describe(\"Whether this flag is required.\"),\n pattern: z\n .string()\n .optional()\n .describe(\"Regex pattern for validating the flag value.\"),\n default: z.string().optional().describe(\"Default value for this flag.\"),\n })\n .strict()\n .describe(\"A flag for the scaffolding command.\");\n\n/**\n * Per-item upper bound on scaffolding rule strings. The intent is to enforce\n * \"short directive\" by contract — long paragraphs fail validation and force\n * authors to split prose into discrete actionable items.\n */\nconst SCAFFOLDING_RULE_MAX_LENGTH = 120;\n\nconst scaffoldingRuleItemSchema = z\n .string()\n .max(\n SCAFFOLDING_RULE_MAX_LENGTH,\n `rule item must be ≤ ${SCAFFOLDING_RULE_MAX_LENGTH} chars`,\n );\n\nexport const scaffoldingRulesSchema = z\n .object({\n never: z\n .array(scaffoldingRuleItemSchema)\n .optional()\n .describe(\"Actions the scaffolding agent must never perform.\"),\n must: z\n .array(scaffoldingRuleItemSchema)\n .optional()\n .describe(\"Actions the scaffolding agent must always perform.\"),\n should: z\n .array(scaffoldingRuleItemSchema)\n .optional()\n .describe(\n \"Recommended actions for the scaffolding agent (parity with plugin-level rules).\",\n ),\n })\n .strict()\n .describe(\"Structured rules for scaffolding agents.\");\n\nexport const scaffoldingDescriptorSchema = z\n .object({\n command: z\n .string()\n .describe(\"The scaffolding command (e.g., 'databricks apps init').\"),\n flags: z\n .record(z.string(), scaffoldingFlagSchema)\n .optional()\n .describe(\"Map of flag name to flag descriptor.\"),\n rules: scaffoldingRulesSchema\n .optional()\n .describe(\"Structured rules for scaffolding agents.\"),\n })\n .strict()\n .describe(\n \"Describes the scaffolding command, flags, and rules for project initialization.\",\n );\n\n/**\n * Canonical scaffolding descriptor for the `databricks apps init` command,\n * embedded in v2.0 template manifests to guide scaffolding agents.\n *\n * Co-located with `scaffoldingDescriptorSchema` so any change to the rule set\n * (or the schema's `maxLength` ceiling) shows up next to its consumer. The\n * `satisfies` annotation gives compile-time validation that the literal\n * matches the schema's input shape; if a `must`/`never` entry exceeds the\n * `maxLength` ceiling at runtime, `scaffoldingDescriptorSchema.parse` would\n * surface the breach in tests.\n */\nexport const TEMPLATE_SCAFFOLDING = {\n command: \"databricks apps init\",\n flags: {\n \"--name\": {\n description:\n \"Project name — sets {{.projectName}} in package.json, databricks.yml, and .env. Required for non-interactive scaffolding.\",\n required: true,\n pattern: \"^[a-z][a-z0-9-]*$\",\n },\n \"--template\": {\n description: \"Template path (local directory or GitHub URL)\",\n required: false,\n },\n \"--version\": {\n description: \"AppKit version to use; defaults to auto-detected\",\n required: false,\n },\n \"--features\": {\n description:\n \"Plugins to enable (comma-separated, no spaces; must match keys in this manifest's plugins map)\",\n required: false,\n pattern: \"^[a-zA-Z0-9_-]+(,[a-zA-Z0-9_-]+)*$\",\n },\n \"--set\": {\n description:\n \"Set resource values (format: plugin.resourceKey.field=value, repeatable)\",\n required: false,\n },\n \"--output-dir\": {\n description: \"Directory to write the project to\",\n required: false,\n },\n \"--description\": {\n description: \"App description\",\n required: false,\n },\n \"--run\": {\n description: \"Run the app after creation (none, dev, dev-remote)\",\n required: false,\n },\n \"--auto-approve\": {\n description:\n \"Pass as a bare flag (no value) to skip prompts for optional resources. Not recommended for agent-driven init — conflicts with the 'ask user when in doubt' rule.\",\n required: false,\n },\n \"--profile\": {\n description:\n \"Databricks CLI profile to use for authentication (global flag)\",\n required: false,\n },\n },\n rules: {\n must: [\n \"Treat `databricks apps init` output as starter code, not requirements; adapt or replace it to match the requested app\",\n \"Keep all secrets and credentials only in app.yaml, databricks.yml, and/or .env\",\n ],\n should: [\"ask user when in doubt of resource to use for plugin\"],\n never: [\n \"guess resources when multiple or no options are available\",\n \"embed secrets in files that will go to the client-bundle\",\n ],\n },\n} satisfies z.infer<typeof scaffoldingDescriptorSchema>;\n\n// ── Template plugins manifest (root) ─────────────────────────────────────\n\nexport const templatePluginsManifestSchema = z\n .object({\n $schema: z\n .string()\n .optional()\n .describe(\"Reference to the JSON Schema for validation\"),\n version: z\n .enum([\"1.0\", \"1.1\", \"2.0\"])\n .describe(\"Schema version for the template plugins manifest\"),\n plugins: z\n .record(z.string(), templatePluginSchema)\n .describe(\"Map of plugin name to plugin manifest with package source\"),\n scaffolding: scaffoldingDescriptorSchema\n .optional()\n .describe(\n \"Describes the scaffolding command and its configuration for project initialization.\",\n ),\n })\n .strict()\n .superRefine((value, ctx) => {\n if (value.version === \"2.0\" && !value.scaffolding) {\n ctx.addIssue({\n code: \"custom\",\n path: [\"scaffolding\"],\n message: \"scaffolding is required when version is '2.0'\",\n });\n }\n })\n .describe(\n \"Aggregated plugin manifest for AppKit templates. Read by Databricks CLI during init to discover available plugins and their resource requirements.\",\n );\n\n// ── Inferred types ───────────────────────────────────────────────────────\n\nexport type ResourceType = z.infer<typeof resourceTypeSchema>;\nexport type SecretPermission = z.infer<typeof secretPermissionSchema>;\nexport type JobPermission = z.infer<typeof jobPermissionSchema>;\nexport type SqlWarehousePermission = z.infer<\n typeof sqlWarehousePermissionSchema\n>;\nexport type ServingEndpointPermission = z.infer<\n typeof servingEndpointPermissionSchema\n>;\nexport type VolumePermission = z.infer<typeof volumePermissionSchema>;\nexport type VectorSearchIndexPermission = z.infer<\n typeof vectorSearchIndexPermissionSchema\n>;\nexport type UcFunctionPermission = z.infer<typeof ucFunctionPermissionSchema>;\nexport type UcConnectionPermission = z.infer<\n typeof ucConnectionPermissionSchema\n>;\nexport type DatabasePermission = z.infer<typeof databasePermissionSchema>;\nexport type PostgresPermission = z.infer<typeof postgresPermissionSchema>;\nexport type GenieSpacePermission = z.infer<typeof genieSpacePermissionSchema>;\nexport type ExperimentPermission = z.infer<typeof experimentPermissionSchema>;\nexport type AppPermission = z.infer<typeof appPermissionSchema>;\nexport type ResourceKind = z.infer<typeof resourceKindSchema>;\nexport type KindDiscoveryDescriptor = z.infer<\n typeof kindDiscoveryDescriptorSchema\n>;\nexport type CliDiscoveryDescriptor = z.infer<\n typeof cliDiscoveryDescriptorSchema\n>;\nexport type DiscoveryDescriptor = z.infer<typeof discoveryDescriptorSchema>;\nexport type ResourceFieldEntry = z.infer<typeof resourceFieldEntrySchema>;\nexport type ResourceRequirement = z.infer<typeof resourceRequirementSchema>;\nexport type ConfigSchemaProperty = z.infer<typeof configSchemaPropertySchema>;\nexport type ConfigSchema = z.infer<typeof configSchemaSchema>;\nexport type PluginScaffoldingRules = z.infer<\n typeof pluginScaffoldingRulesSchema\n>;\nexport type PluginManifest = z.infer<typeof pluginManifestSchema>;\nexport type Origin = z.infer<typeof originSchema>;\n// Template-side types use `z.input` so callers can construct a TemplatePlugin\n// from a parsed PluginManifest before the field-level origin transform runs.\n// `writeManifest` parses every field through `templateFieldEntrySchema` at\n// write-time, so the on-disk shape always has origin populated. The runtime\n// invariant: origin is *always* present after sync writes; the type slot\n// stays optional so the in-memory pipeline does not need to fabricate origin\n// before assignment.\nexport type TemplateFieldEntry = z.input<typeof templateFieldEntrySchema>;\nexport type TemplateResourceRequirement = z.input<\n typeof templateResourceRequirementSchema\n>;\nexport type TemplatePlugin = z.input<typeof templatePluginSchema>;\nexport type ScaffoldingFlag = z.infer<typeof scaffoldingFlagSchema>;\nexport type ScaffoldingRules = z.infer<typeof scaffoldingRulesSchema>;\nexport type ScaffoldingDescriptor = z.infer<typeof scaffoldingDescriptorSchema>;\nexport type TemplatePluginsManifest = z.input<\n typeof templatePluginsManifestSchema\n>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,MAAa,qBAAqB,EAC/B,KAAK;CACJ;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC,CACD,SAAS,8BAA8B;AAE1C,MAAa,yBAAyB,EACnC,KAAK;CAAC;CAAQ;CAAS;CAAS,CAAC,CACjC,SAAS,gEAAgE;AAE5E,MAAa,sBAAsB,EAChC,KAAK;CAAC;CAAY;CAAkB;CAAa,CAAC,CAClD,SAAS,6DAA6D;AAEzE,MAAa,+BAA+B,EACzC,KAAK,CAAC,WAAW,aAAa,CAAC,CAC/B,SACC,uEACD;AAEH,MAAa,kCAAkC,EAC5C,KAAK;CAAC;CAAY;CAAa;CAAa,CAAC,CAC7C,SACC,0EACD;AAEH,MAAa,yBAAyB,EACnC,KAAK,CAAC,eAAe,eAAe,CAAC,CACrC,SAAS,gDAAgD;AAE5D,MAAa,oCAAoC,EAC9C,KAAK,CAAC,SAAS,CAAC,CAChB,SAAS,+CAA+C;AAE3D,MAAa,6BAA6B,EACvC,KAAK,CAAC,UAAU,CAAC,CACjB,SAAS,kDAAkD;AAE9D,MAAa,+BAA+B,EACzC,KAAK,CAAC,iBAAiB,CAAC,CACxB,SAAS,oDAAoD;AAEhE,MAAa,2BAA2B,EACrC,KAAK,CAAC,yBAAyB,CAAC,CAChC,SAAS,oCAAoC;AAEhD,MAAa,2BAA2B,EACrC,KAAK,CAAC,yBAAyB,CAAC,CAChC,SAAS,oCAAoC;AAEhD,MAAa,6BAA6B,EACvC,KAAK;CAAC;CAAY;CAAW;CAAY;CAAa,CAAC,CACvD,SACC,qEACD;AAEH,MAAa,6BAA6B,EACvC,KAAK;CAAC;CAAY;CAAY;CAAa,CAAC,CAC5C,SACC,2EACD;AAEH,MAAa,sBAAsB,EAChC,KAAK,CAAC,UAAU,CAAC,CACjB,SAAS,0CAA0C;;;;;;;;;;;AActD,MAAa,qBAAqB,EAC/B,KAAK;CACJ;CACA;CACA;CACA;CACA;CACA;CACD,CAAC,CACD,SACC,6GACD;AAEH,MAAa,gCAAgC,EAC1C,OAAO;CACN,MAAM,EACH,QAAQ,OAAO,CACf,SACC,sFACD;CACH,cAAc,mBAAmB,SAC/B,qHACD;CACD,QAAQ,EACL,QAAQ,CACR,UAAU,CACV,SACC,yIACD;CACH,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SACC,4GACD;CACH,WAAW,EACR,QAAQ,CACR,UAAU,CACV,SACC,+IACD;CACH,UAAU,EACP,QAAQ,CACR,UAAU,CACV,SACC,iGACD;CACJ,CAAC,CACD,QAAQ,CACR,SACC,6GACD;;;;;;;;;AAUH,MAAM,oBAAoB;AAE1B,MAAa,+BAA+B,EACzC,OAAO;CACN,MAAM,EACH,QAAQ,MAAM,CACd,SACC,uFACD;CACH,YAAY,EACT,QAAQ,CACR,SACC,qOACD;CACH,aAAa,EACV,QAAQ,CACR,SACC,gFACD;CACH,cAAc,EACX,QAAQ,CACR,UAAU,CACV,SACC,oGACD;CACH,WAAW,EACR,QAAQ,CACR,UAAU,CACV,SACC,+IACD;CACH,UAAU,EACP,QAAQ,CACR,UAAU,CACV,SACC,oIACD;CACJ,CAAC,CACD,QAAQ,CACR,QAAQ,eAAe,WAAW,WAAW,SAAS,YAAY,EAAE;CACnE,SAAS;CACT,MAAM,CAAC,aAAa;CACrB,CAAC,CACD,QAAQ,eAAe,CAAC,kBAAkB,KAAK,WAAW,WAAW,EAAE;CACtE,SACE;CACF,MAAM,CAAC,aAAa;CACrB,CAAC,CACD,QACE,eACC,WAAW,aAAa,UACxB,CAAC,kBAAkB,KAAK,WAAW,SAAS,EAC9C;CACE,SAAS;CACT,MAAM,CAAC,WAAW;CACnB,CACF,CACA,SACC,4NACD;AAEH,MAAa,4BAA4B,EACtC,mBAAmB,QAAQ,CAC1B,+BACA,6BACD,CAAC,CACD,SACC,gOACD;AAuFH,MAAa,2BAA2B,EACrC,OAAO;CACN,KAAK,EACF,QAAQ,CACR,MAAM,oBAAoB,CAC1B,UAAU,CACV,SAAS,2CAA2C;CACvD,aAAa,EACV,QAAQ,CACR,UAAU,CACV,SAAS,4CAA4C;CACxD,cAAc,EACX,SAAS,CACT,UAAU,CACV,SACC,sGACD;CACH,UAAU,EACP,MAAM,EAAE,QAAQ,CAAC,CACjB,UAAU,CACV,SAAS,4DAA4D;CACxE,WAAW,EACR,SAAS,CACT,UAAU,CACV,SACC,6HACD;CACH,OAAO,EACJ,QAAQ,CACR,UAAU,CACV,SACC,+EACD;CACH,SAAS,EACN,QAAQ,CACR,MAAM,sBAAsB,CAC5B,UAAU,CACV,SACC,6HACD;CACH,WAAW,0BAA0B,UAAU;CAChD,CAAC,CACD,QAAQ,CACR,SACC,8PACD;;;;;;;AAUH,MAAM,+BAA+B;CACnC,OAAO,EACJ,QAAQ,CACR,IAAI,EAAE,CACN,SACC,uFACD;CACH,aAAa,EACV,QAAQ,CACR,MAAM,oBAAoB,CAC1B,SACC,iHACD;CACH,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4DAA4D;CACxE,QAAQ,EACL,OAAO,EAAE,QAAQ,EAAE,yBAAyB,CAC5C,QAAQ,QAAQ,OAAO,KAAK,IAAI,CAAC,UAAU,GAAG,EAC7C,SAAS,0CACV,CAAC,CACD,UAAU,CACV,SACC,8LACD;CACJ;;;;;;;;AASD,SAAS,wBACP,UACA,KACM;AACN,KAAI,CAAC,SAAS,OAAQ;CACtB,MAAM,aAAa,IAAI,IAAI,OAAO,KAAK,SAAS,OAAO,CAAC;CAGxD,MAAM,uBAAO,IAAI,KAAqB;AACtC,MAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,SAAS,OAAO,EAAE;EAC3D,MAAM,MAAM,MAAM,WAAW;AAC7B,MAAI,CAAC,IAAK;AACV,MAAI,CAAC,WAAW,IAAI,IAAI,CACtB,KAAI,SAAS;GACX,MAAM;GACN,MAAM;IAAC;IAAU;IAAM;IAAa;IAAY;GAChD,SAAS,0CAA0C,IAAI;GACxD,CAAC;AAEJ,OAAK,IAAI,MAAM,IAAI;;CAIrB,MAAM,0BAAU,IAAI,KAAa;CACjC,MAAM,2BAAW,IAAI,KAAa;CAElC,SAAS,IAAI,MAAc,OAAkC;AAC3D,MAAI,SAAS,IAAI,KAAK,CAAE,QAAO,CAAC,GAAG,OAAO,KAAK;AAC/C,MAAI,QAAQ,IAAI,KAAK,CAAE,QAAO;AAC9B,WAAS,IAAI,KAAK;EAClB,MAAM,OAAO,KAAK,IAAI,KAAK;AAC3B,MAAI,MAAM;GACR,MAAM,QAAQ,IAAI,MAAM,CAAC,GAAG,OAAO,KAAK,CAAC;AACzC,OAAI,MAAO,QAAO;;AAEpB,WAAS,OAAO,KAAK;AACrB,UAAQ,IAAI,KAAK;AACjB,SAAO;;AAGT,MAAK,MAAM,QAAQ,KAAK,MAAM,EAAE;AAC9B,MAAI,QAAQ,IAAI,KAAK,CAAE;EACvB,MAAM,QAAQ,IAAI,MAAM,EAAE,CAAC;AAC3B,MAAI,OAAO;AACT,OAAI,SAAS;IACX,MAAM;IACN,MAAM,EAAE;IACR,SAAS,wCAAwC,MAAM,KAAK,MAAM;IACnE,CAAC;AAEF;;;;AAKN,SAAS,oBAGP,aAAoB,YAAmB;AACvC,QAAO,EACJ,OAAO;EACN,MAAM;EACN,GAAG;EACH,YAAY,WAAW,SACrB,0DACD;EACF,CAAC,CACD,QAAQ,CACR,YAAY,wBAAwB;;AAGzC,MAAa,4BAA4B,EACtC,mBAAmB,QAAQ;CAC1B,oBAAoB,EAAE,QAAQ,SAAS,EAAE,uBAAuB;CAChE,oBAAoB,EAAE,QAAQ,MAAM,EAAE,oBAAoB;CAC1D,oBACE,EAAE,QAAQ,gBAAgB,EAC1B,6BACD;CACD,oBACE,EAAE,QAAQ,mBAAmB,EAC7B,gCACD;CACD,oBAAoB,EAAE,QAAQ,SAAS,EAAE,uBAAuB;CAChE,oBACE,EAAE,QAAQ,sBAAsB,EAChC,kCACD;CACD,oBAAoB,EAAE,QAAQ,cAAc,EAAE,2BAA2B;CACzE,oBACE,EAAE,QAAQ,gBAAgB,EAC1B,6BACD;CACD,oBAAoB,EAAE,QAAQ,WAAW,EAAE,yBAAyB;CACpE,oBAAoB,EAAE,QAAQ,WAAW,EAAE,yBAAyB;CACpE,oBAAoB,EAAE,QAAQ,cAAc,EAAE,2BAA2B;CACzE,oBAAoB,EAAE,QAAQ,aAAa,EAAE,2BAA2B;CACxE,oBAAoB,EAAE,QAAQ,MAAM,EAAE,oBAAoB;CAC3D,CAAC,CACD,SACC,sIACD;AAIH,MAAa,6BAAwC,EAAE,WACrD,EACG,OAAO;CACN,MAAM,EAAE,KAAK;EACX;EACA;EACA;EACA;EACA;EACA;EACD,CAAC;CACF,aAAa,EAAE,QAAQ,CAAC,UAAU;CAClC,SAAS,EAAE,SAAS,CAAC,UAAU;CAC/B,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,UAAU;CACrC,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,2BAA2B,CAAC,UAAU;CACvE,OAAO,2BAA2B,UAAU;CAC5C,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,UAAU;CAC7C,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,UAAU;CAC7C,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CAKxC,sBAAsB,EACnB,MAAM,CAAC,EAAE,SAAS,EAAE,2BAA2B,CAAC,CAChD,UAAU;CACd,CAAC,CACD,QAAQ,CACZ;AAED,MAAa,qBAAgC,EAAE,WAC7C,EACG,OAAO;CACN,MAAM,EAAE,KAAK;EAAC;EAAU;EAAS;EAAU;EAAU;EAAU,CAAC;CAChE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,2BAA2B,CAAC,UAAU;CACvE,OAAO,mBAAmB,UAAU;CACpC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CACxC,sBAAsB,EAAE,SAAS,CAAC,UAAU;CAC7C,CAAC,CACD,QAAQ,CACZ;;;;;;;;AAWD,MAAM,qCAAqC;AAE3C,MAAM,kCAAkC,EACrC,QAAQ,CACR,IAAI,EAAE,CACN,IACC,oCACA,0BAA0B,mCAAmC,QAC9D;AAEH,MAAa,+BAA+B,EACzC,OAAO;CACN,MAAM,EACH,MAAM,gCAAgC,CACtC,UAAU,CACV,SAAS,qDAAqD;CACjE,QAAQ,EACL,MAAM,gCAAgC,CACtC,UAAU,CACV,SAAS,iDAAiD;CAC7D,OAAO,EACJ,MAAM,gCAAgC,CACtC,UAAU,CACV,SAAS,oDAAoD;CACjE,CAAC,CACD,QAAQ,CACR,aAAa,OAAO,QAAQ;CAE3B,MAAM,UACJ;EACE,CAAC,QAAQ,MAAM,KAAK;EACpB,CAAC,UAAU,MAAM,OAAO;EACxB,CAAC,SAAS,MAAM,MAAM;EACvB;AACH,MAAK,MAAM,CAAC,YAAY,UAAU,SAAS;AACzC,MAAI,CAAC,MAAO;EACZ,MAAM,uBAAO,IAAI,KAAqB;AACtC,QAAM,SAAS,MAAM,QAAQ;GAC3B,MAAM,OAAO,KAAK,IAAI,KAAK;AAC3B,OAAI,SAAS,QAAW;AACtB,SAAK,IAAI,MAAM,IAAI;AACnB;;AAEF,OAAI,SAAS;IACX,MAAM;IACN,MAAM,CAAC,YAAY,IAAI;IACvB,SAAS,0BAA0B,KAAK,8BAA8B;IACvE,CAAC;IACF;;CAIJ,MAAM,wBAAQ,IAAI,KAAqB;AACvC,MAAK,MAAM,CAAC,YAAY,UAAU,SAAS;AACzC,MAAI,CAAC,MAAO;AACZ,OAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;GACrC,MAAM,OAAO,MAAM;GACnB,MAAM,WAAW,MAAM,IAAI,KAAK;AAChC,OAAI,aAAa,QAAW;AAC1B,UAAM,IAAI,MAAM,WAAW;AAC3B;;AAEF,OAAI,aAAa,WACf,KAAI,SAAS;IACX,MAAM;IACN,MAAM,CAAC,YAAY,EAAE;IACrB,SAAS,eAAe,KAAK,qBAAqB,SAAS,SAAS,WAAW;IAChF,CAAC;;;EAIR,CACD,SACC,qHACD;AAIH,MAAa,uBAAuB,EACjC,OAAO;CACN,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SAAS,8CAA8C;CAC1D,MAAM,EACH,QAAQ,CACR,MAAM,oBAAoB,CAC1B,SACC,6GACD;CACH,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,6CAA6C;CACzD,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4CAA4C;CACxD,WAAW,EACR,OAAO;EACN,UAAU,EACP,MAAM,0BAA0B,CAChC,SACC,8DACD;EACH,UAAU,EACP,MAAM,0BAA0B,CAChC,SACC,6DACD;EACJ,CAAC,CACD,QAAQ,CACR,SAAS,mDAAmD;CAC/D,QAAQ,EACL,OAAO,EACN,QAAQ,mBAAmB,UAAU,EACtC,CAAC,CACD,QAAQ,CACR,UAAU,CACV,SAAS,sCAAsC;CAClD,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,8BAA8B;CACrE,SAAS,EACN,QAAQ,CACR,MAAM,mCAAmC,CACzC,UAAU,CACV,SAAS,iCAAiC;CAC7C,YAAY,EACT,KAAK,CACL,UAAU,CACV,SAAS,wCAAwC;CACpD,UAAU,EACP,MAAM,EAAE,QAAQ,CAAC,CACjB,UAAU,CACV,SAAS,gCAAgC;CAC5C,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,0BAA0B;CAClE,gBAAgB,EACb,QAAQ,CACR,UAAU,CACV,SACC,+JACD;CACH,QAAQ,EACL,SAAS,CACT,UAAU,CACV,SACC,2GACD;CACH,SAAS,EACN,SAAS,CACT,UAAU,CACV,SACC,yPACD;CACH,WAAW,EACR,KAAK,CAAC,QAAQ,KAAK,CAAC,CACpB,UAAU,CACV,SACC,+KACD;CACH,aAAa,EACV,OAAO,EACN,OAAO,6BACJ,UAAU,CACV,SACC,wEACD,EACJ,CAAC,CACD,QAAQ,CACR,UAAU,CACV,SACC,iHACD;CACJ,CAAC,CACD,QAAQ,CACR,SACC,iIACD;AAIH,MAAa,eAAe,EACzB,KAAK;CAAC;CAAQ;CAAY;CAAU;CAAM,CAAC,CAC3C,SACC,8FACD;;;;;;;;;;;;;;AAiBH,SAAS,uBAAuB,OAIC;AAC/B,KAAI,MAAM,UAAW,QAAO;AAC5B,KAAI,MAAM,UAAU,OAAW,QAAO;AACtC,KAAI,MAAM,YAAY,OAAW,QAAO;AACxC,QAAO;;;;;;;;;;AAWT,MAAa,2BAA2B,yBACrC,OAAO,EAAE,QAAQ,aAAa,UAAU,EAAE,CAAC,CAC3C,WAAW,WAAW;CACrB,GAAG;CACH,QAAQ,uBAAuB,MAAM;CACtC,EAAE;AAIL,MAAM,uCAAuC;CAC3C,OAAO,EACJ,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4CAA4C;CACxD,aAAa,EACV,QAAQ,CACR,MAAM,oBAAoB,CAC1B,SACC,yEACD;CACH,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4DAA4D;CACxE,QAAQ,EACL,OAAO,EAAE,QAAQ,EAAE,yBAAyB,CAC5C,QAAQ,QAAQ,OAAO,KAAK,IAAI,CAAC,UAAU,GAAG,EAC7C,SAAS,0CACV,CAAC,CACD,UAAU,CACV,SAAS,yDAAyD;CACtE;AAED,SAAS,4BAGP,aAAoB,YAAmB;AACvC,QAAO,EACJ,OAAO;EACN,MAAM;EACN,GAAG;EACH,YAAY,WAAW,SACrB,0DACD;EACF,CAAC,CACD,QAAQ,CACR,YAAY,wBAAwB;;AAGzC,MAAa,oCAAoC,EAC9C,mBAAmB,QAAQ;CAC1B,4BAA4B,EAAE,QAAQ,SAAS,EAAE,uBAAuB;CACxE,4BAA4B,EAAE,QAAQ,MAAM,EAAE,oBAAoB;CAClE,4BACE,EAAE,QAAQ,gBAAgB,EAC1B,6BACD;CACD,4BACE,EAAE,QAAQ,mBAAmB,EAC7B,gCACD;CACD,4BAA4B,EAAE,QAAQ,SAAS,EAAE,uBAAuB;CACxE,4BACE,EAAE,QAAQ,sBAAsB,EAChC,kCACD;CACD,4BACE,EAAE,QAAQ,cAAc,EACxB,2BACD;CACD,4BACE,EAAE,QAAQ,gBAAgB,EAC1B,6BACD;CACD,4BACE,EAAE,QAAQ,WAAW,EACrB,yBACD;CACD,4BACE,EAAE,QAAQ,WAAW,EACrB,yBACD;CACD,4BACE,EAAE,QAAQ,cAAc,EACxB,2BACD;CACD,4BACE,EAAE,QAAQ,aAAa,EACvB,2BACD;CACD,4BAA4B,EAAE,QAAQ,MAAM,EAAE,oBAAoB;CACnE,CAAC,CACD,SACC,wFACD;AAIH,MAAa,uBAAuB,EACjC,OAAO;CACN,MAAM,EACH,QAAQ,CACR,MAAM,oBAAoB,CAC1B,SACC,6GACD;CACH,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,6CAA6C;CACzD,aAAa,EACV,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,4CAA4C;CACxD,SAAS,EACN,QAAQ,CACR,IAAI,EAAE,CACN,SAAS,6CAA6C;CACzD,oBAAoB,EACjB,SAAS,CACT,UAAU,CACV,SACC,sPACD;CACH,gBAAgB,EACb,QAAQ,CACR,UAAU,CACV,SACC,+JACD;CACH,WAAW,EACR,KAAK,CAAC,QAAQ,KAAK,CAAC,CACpB,UAAU,CACV,SACC,mIACD;CACH,aAAa,EACV,OAAO,EACN,OAAO,6BACJ,UAAU,CACV,SACC,+EACD,EACJ,CAAC,CACD,QAAQ,CACR,UAAU,CACV,SACC,yEACD;CACH,WAAW,EACR,OAAO;EACN,UAAU,EACP,MAAM,kCAAkC,CACxC,SACC,8DACD;EACH,UAAU,EACP,MAAM,kCAAkC,CACxC,SACC,6DACD;EACJ,CAAC,CACD,QAAQ,CACR,SAAS,mDAAmD;CAChE,CAAC,CACD,QAAQ,CACR,SAAS,kDAAkD;AAI9D,MAAa,wBAAwB,EAClC,OAAO;CACN,aAAa,EAAE,QAAQ,CAAC,SAAS,0CAA0C;CAC3E,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,SAAS,iCAAiC;CAC3E,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SAAS,+CAA+C;CAC3D,SAAS,EAAE,QAAQ,CAAC,UAAU,CAAC,SAAS,+BAA+B;CACxE,CAAC,CACD,QAAQ,CACR,SAAS,sCAAsC;;;;;;AAOlD,MAAM,8BAA8B;AAEpC,MAAM,4BAA4B,EAC/B,QAAQ,CACR,IACC,6BACA,uBAAuB,4BAA4B,QACpD;AAEH,MAAa,yBAAyB,EACnC,OAAO;CACN,OAAO,EACJ,MAAM,0BAA0B,CAChC,UAAU,CACV,SAAS,oDAAoD;CAChE,MAAM,EACH,MAAM,0BAA0B,CAChC,UAAU,CACV,SAAS,qDAAqD;CACjE,QAAQ,EACL,MAAM,0BAA0B,CAChC,UAAU,CACV,SACC,kFACD;CACJ,CAAC,CACD,QAAQ,CACR,SAAS,2CAA2C;AAEvD,MAAa,8BAA8B,EACxC,OAAO;CACN,SAAS,EACN,QAAQ,CACR,SAAS,0DAA0D;CACtE,OAAO,EACJ,OAAO,EAAE,QAAQ,EAAE,sBAAsB,CACzC,UAAU,CACV,SAAS,uCAAuC;CACnD,OAAO,uBACJ,UAAU,CACV,SAAS,2CAA2C;CACxD,CAAC,CACD,QAAQ,CACR,SACC,kFACD;;;;;;;;;;;;AAaH,MAAa,uBAAuB;CAClC,SAAS;CACT,OAAO;EACL,UAAU;GACR,aACE;GACF,UAAU;GACV,SAAS;GACV;EACD,cAAc;GACZ,aAAa;GACb,UAAU;GACX;EACD,aAAa;GACX,aAAa;GACb,UAAU;GACX;EACD,cAAc;GACZ,aACE;GACF,UAAU;GACV,SAAS;GACV;EACD,SAAS;GACP,aACE;GACF,UAAU;GACX;EACD,gBAAgB;GACd,aAAa;GACb,UAAU;GACX;EACD,iBAAiB;GACf,aAAa;GACb,UAAU;GACX;EACD,SAAS;GACP,aAAa;GACb,UAAU;GACX;EACD,kBAAkB;GAChB,aACE;GACF,UAAU;GACX;EACD,aAAa;GACX,aACE;GACF,UAAU;GACX;EACF;CACD,OAAO;EACL,MAAM,CACJ,yHACA,iFACD;EACD,QAAQ,CAAC,uDAAuD;EAChE,OAAO,CACL,6DACA,2DACD;EACF;CACF;AAID,MAAa,gCAAgC,EAC1C,OAAO;CACN,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SAAS,8CAA8C;CAC1D,SAAS,EACN,KAAK;EAAC;EAAO;EAAO;EAAM,CAAC,CAC3B,SAAS,mDAAmD;CAC/D,SAAS,EACN,OAAO,EAAE,QAAQ,EAAE,qBAAqB,CACxC,SAAS,4DAA4D;CACxE,aAAa,4BACV,UAAU,CACV,SACC,sFACD;CACJ,CAAC,CACD,QAAQ,CACR,aAAa,OAAO,QAAQ;AAC3B,KAAI,MAAM,YAAY,SAAS,CAAC,MAAM,YACpC,KAAI,SAAS;EACX,MAAM;EACN,MAAM,CAAC,cAAc;EACrB,SAAS;EACV,CAAC;EAEJ,CACD,SACC,qJACD"}
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","names":[],"sources":["../../../../shared/src/plugin.ts"],"mappings":";;;;;;KAgSY,iBAAA,GAAoB,MAAA;;KAGpB,eAAA,GAAkB,MAAA,SAAe,iBAAA;;KAGjC,mBAAA,GAAsB,MAAA,SAAe,MAAA"}
1
+ {"version":3,"file":"plugin.d.ts","names":[],"sources":["../../../../shared/src/plugin.ts"],"mappings":";;;;;;KAmSY,iBAAA,GAAoB,MAAA;;KAGpB,eAAA,GAAkB,MAAA,SAAe,iBAAA;;KAGjC,mBAAA,GAAsB,MAAA,SAAe,MAAA"}
@@ -149,3 +149,37 @@ Routes through the shared `connectors/serving/stream` helper, which delegates to
149
149
  #### Returns[​](#returns-3 "Direct link to Returns")
150
150
 
151
151
  `Promise`<`DatabricksAdapter`>
152
+
153
+ ***
154
+
155
+ ### fromSupervisorApi()[​](#fromsupervisorapi "Direct link to fromSupervisorApi()")
156
+
157
+ ```ts
158
+ static fromSupervisorApi(options: SupervisorApiAdapterOptions): Promise<AgentAdapter>;
159
+
160
+ ```
161
+
162
+ Discoverability shim for the Supervisor API adapter. Returns an [AgentAdapter](./docs/api/appkit/Interface.AgentAdapter.md) (a `SupervisorApiAdapter` at runtime), NOT a DatabricksAdapter — the two are separate classes (different wire formats, different lifecycle). The return type is the [AgentAdapter](./docs/api/appkit/Interface.AgentAdapter.md) interface so callers aren't bound to the concrete class. Surfaced here so application developers see a single `DatabricksAdapter.from*` autocomplete root.
163
+
164
+ Dynamic-imports `./supervisor-api` to avoid forming a load-time cycle: both files share `connectors/serving/client.ts`.
165
+
166
+ #### Parameters[​](#parameters-4 "Direct link to Parameters")
167
+
168
+ | Parameter | Type |
169
+ | --------- | ------------------------------------------------------------------------------------------------- |
170
+ | `options` | [`SupervisorApiAdapterOptions`](./docs/api/appkit/Interface.SupervisorApiAdapterOptions.md) |
171
+
172
+ #### Returns[​](#returns-4 "Direct link to Returns")
173
+
174
+ `Promise`<[`AgentAdapter`](./docs/api/appkit/Interface.AgentAdapter.md)>
175
+
176
+ #### Example[​](#example-1 "Direct link to Example")
177
+
178
+ ```ts
179
+ import { DatabricksAdapter } from "@databricks/appkit/beta";
180
+
181
+ const model = await DatabricksAdapter.fromSupervisorApi({
182
+ model: "databricks-claude-sonnet-4-5",
183
+ });
184
+
185
+ ```
@@ -0,0 +1,121 @@
1
+ # Class: SupervisorApiAdapter
2
+
3
+ Adapter that calls the Databricks AI Gateway Responses API (`/ai-gateway/mlflow/v1/responses`).
4
+
5
+ Streams SSE events in the OpenAI Responses API wire format and maps them to the AppKit `AgentEvent` protocol. Tool execution is handled server-side, so the adapter ignores the agents-plugin tool index.
6
+
7
+ Authentication is handled via the Databricks SDK credential chain — the same mechanism used by `DatabricksAdapter.fromModelServing`. The transport is injected via SupervisorApiAdapterCtorOptions.streamBody; the [fromSupervisorApi](./docs/api/appkit/Function.fromSupervisorApi.md) factory wires it through the SDK's `apiClient.request({ raw: true })`.
8
+
9
+ Set `DEBUG=appkit:agents:supervisor-api` to log the outbound request shape (model, instructions length, input shape, tool count) and to be notified when the recovery path engages (no incremental deltas, text pulled from `response.completed.output[]`). The no-delta warning includes a per-turn event-type histogram and the SA-reported status/error/ incomplete\_details, so it's already actionable without DEBUG.
10
+
11
+ Tools are not configured on the adapter. Declare them via `createAgent({ tools: () => ({ key: supervisorTools.genieSpace({...}) }) })` (or markdown frontmatter referencing an ambient `supervisorTools.*` entry); the agents plugin / standalone `runAgent` aggregates hosted-supervisor entries and routes them to the adapter via `AgentInput.extensions[SUPERVISOR_EXTENSION_KEY]`. Advanced callers invoking `adapter.run(...)` directly populate that key themselves.
12
+
13
+ ## Example[​](#example "Direct link to Example")
14
+
15
+ ```ts
16
+ import { createApp, createAgent } from "@databricks/appkit";
17
+ import {
18
+ agents,
19
+ DatabricksAdapter,
20
+ supervisorTools,
21
+ } from "@databricks/appkit/beta";
22
+
23
+ await createApp({
24
+ plugins: [
25
+ agents({
26
+ agents: {
27
+ assistant: createAgent({
28
+ instructions: "You are a helpful assistant.",
29
+ model: DatabricksAdapter.fromSupervisorApi({
30
+ model: "databricks-claude-sonnet-4",
31
+ }),
32
+ tools: () => ({
33
+ nyc: supervisorTools.genieSpace({
34
+ id: "01ABCDEF12345678",
35
+ description: "NYC taxi trip records and zones",
36
+ }),
37
+ }),
38
+ }),
39
+ },
40
+ }),
41
+ ],
42
+ });
43
+
44
+ ```
45
+
46
+ ## Implements[​](#implements "Direct link to Implements")
47
+
48
+ * [`AgentAdapter`](./docs/api/appkit/Interface.AgentAdapter.md)
49
+
50
+ ## Constructors[​](#constructors "Direct link to Constructors")
51
+
52
+ ### Constructor[​](#constructor "Direct link to Constructor")
53
+
54
+ ```ts
55
+ new SupervisorApiAdapter(options: SupervisorApiAdapterCtorOptions): SupervisorApiAdapter;
56
+
57
+ ```
58
+
59
+ #### Parameters[​](#parameters "Direct link to Parameters")
60
+
61
+ | Parameter | Type |
62
+ | --------- | --------------------------------- |
63
+ | `options` | `SupervisorApiAdapterCtorOptions` |
64
+
65
+ #### Returns[​](#returns "Direct link to Returns")
66
+
67
+ `SupervisorApiAdapter`
68
+
69
+ ## Properties[​](#properties "Direct link to Properties")
70
+
71
+ ### acceptsExtensions[​](#acceptsextensions "Direct link to acceptsExtensions")
72
+
73
+ ```ts
74
+ readonly acceptsExtensions: readonly ["databricks.supervisor"];
75
+
76
+ ```
77
+
78
+ Capability negotiation: the adapter reads its hosted-tool payload from [AgentInput.extensions](./docs/api/appkit/Interface.AgentInput.md#extensions) under [SUPERVISOR\_EXTENSION\_KEY](./docs/api/appkit/Variable.SUPERVISOR_EXTENSION_KEY.md). The agents plugin uses this list to warn at registration when the tool index produces extensions the adapter wouldn't consume.
79
+
80
+ #### Implementation of[​](#implementation-of "Direct link to Implementation of")
81
+
82
+ [`AgentAdapter`](./docs/api/appkit/Interface.AgentAdapter.md).[`acceptsExtensions`](./docs/api/appkit/Interface.AgentAdapter.md#acceptsextensions)
83
+
84
+ ***
85
+
86
+ ### consumesInputTools[​](#consumesinputtools "Direct link to consumesInputTools")
87
+
88
+ ```ts
89
+ readonly consumesInputTools: false = false;
90
+
91
+ ```
92
+
93
+ Capability negotiation: the adapter does not consume `input.tools`. Tool execution is owned by the Databricks AI Gateway server-side, so any function tools or local sub-agents declared on this agent would be silently dropped — the agents plugin warns at registration when that combination is detected.
94
+
95
+ #### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")
96
+
97
+ [`AgentAdapter`](./docs/api/appkit/Interface.AgentAdapter.md).[`consumesInputTools`](./docs/api/appkit/Interface.AgentAdapter.md#consumesinputtools)
98
+
99
+ ## Methods[​](#methods "Direct link to Methods")
100
+
101
+ ### run()[​](#run "Direct link to run()")
102
+
103
+ ```ts
104
+ run(input: AgentInput, context: AgentRunContext): AsyncGenerator<AgentEvent, void, unknown>;
105
+
106
+ ```
107
+
108
+ #### Parameters[​](#parameters-1 "Direct link to Parameters")
109
+
110
+ | Parameter | Type |
111
+ | --------- | ------------------------------------------------------------------------- |
112
+ | `input` | [`AgentInput`](./docs/api/appkit/Interface.AgentInput.md) |
113
+ | `context` | [`AgentRunContext`](./docs/api/appkit/Interface.AgentRunContext.md) |
114
+
115
+ #### Returns[​](#returns-1 "Direct link to Returns")
116
+
117
+ `AsyncGenerator`<[`AgentEvent`](./docs/api/appkit/TypeAlias.AgentEvent.md), `void`, `unknown`>
118
+
119
+ #### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")
120
+
121
+ [`AgentAdapter`](./docs/api/appkit/Interface.AgentAdapter.md).[`run`](./docs/api/appkit/Interface.AgentAdapter.md#run)
@@ -0,0 +1,63 @@
1
+ # Function: fromSupervisorApi()
2
+
3
+ ```ts
4
+ function fromSupervisorApi(options: SupervisorApiAdapterOptions): Promise<AgentAdapter>;
5
+
6
+ ```
7
+
8
+ Creates an [AgentAdapter](./docs/api/appkit/Interface.AgentAdapter.md) backed by the Databricks AI Gateway Responses API (`/ai-gateway/mlflow/v1/responses`).
9
+
10
+ Uses the SDK's default credential chain for auth (reads DATABRICKS\_HOST, DATABRICKS\_TOKEN, OAuth config, etc.). Tools are declared on the agent (via `createAgent({ tools })`), not on this factory.
11
+
12
+ Application code should prefer the [DatabricksAdapter.fromSupervisorApi](./docs/api/appkit/Class.DatabricksAdapter.md#fromsupervisorapi) static — it delegates here and keeps a single `DatabricksAdapter.from*` autocomplete root for all Databricks-backed adapters. This free function is the implementation behind the static and remains exported for callers that want to import it directly without pulling in [DatabricksAdapter](./docs/api/appkit/Class.DatabricksAdapter.md).
13
+
14
+ ## Parameters[​](#parameters "Direct link to Parameters")
15
+
16
+ | Parameter | Type |
17
+ | --------- | ------------------------------------------------------------------------------------------------- |
18
+ | `options` | [`SupervisorApiAdapterOptions`](./docs/api/appkit/Interface.SupervisorApiAdapterOptions.md) |
19
+
20
+ ## Returns[​](#returns "Direct link to Returns")
21
+
22
+ `Promise`<[`AgentAdapter`](./docs/api/appkit/Interface.AgentAdapter.md)>
23
+
24
+ ## Example[​](#example "Direct link to Example")
25
+
26
+ ```ts
27
+ import { createApp, createAgent } from "@databricks/appkit";
28
+ import {
29
+ agents,
30
+ DatabricksAdapter,
31
+ supervisorTools,
32
+ } from "@databricks/appkit/beta";
33
+
34
+ await createApp({
35
+ plugins: [
36
+ agents({
37
+ agents: {
38
+ assistant: createAgent({
39
+ instructions: "You are a helpful assistant.",
40
+ model: DatabricksAdapter.fromSupervisorApi({
41
+ model: "databricks-claude-sonnet-4",
42
+ }),
43
+ tools: () => ({
44
+ nyc: supervisorTools.genieSpace({
45
+ id: "01ABCDEF12345678",
46
+ description: "NYC taxi trip records and zones",
47
+ }),
48
+ }),
49
+ }),
50
+ },
51
+ }),
52
+ ],
53
+ });
54
+
55
+ ```
56
+
57
+ ## Remarks[​](#remarks "Direct link to Remarks")
58
+
59
+ ⚠ When passing your own `workspaceClient`, see the warning on [SupervisorApiAdapterOptions.workspaceClient](./docs/api/appkit/Interface.SupervisorApiAdapterOptions.md#workspaceclient) — the client is captured once and reused, so per-request OBO clients would leak identity across requests.
60
+
61
+ ## See[​](#see "Direct link to See")
62
+
63
+ [DatabricksAdapter.fromSupervisorApi](./docs/api/appkit/Class.DatabricksAdapter.md#fromsupervisorapi) — the recommended application-facing entry point.
@@ -0,0 +1,18 @@
1
+ # Function: isSupervisorTool()
2
+
3
+ ```ts
4
+ function isSupervisorTool(value: unknown): value is HostedSupervisorTool;
5
+
6
+ ```
7
+
8
+ Type guard for [HostedSupervisorTool](./docs/api/appkit/Interface.HostedSupervisorTool.md). Used by the agents plugin (`buildToolIndex`) and standalone `runAgent` (`classifyTool`) to route supervisor-hosted tools to the extensions payload rather than the adapter's `tools` array.
9
+
10
+ ## Parameters[​](#parameters "Direct link to Parameters")
11
+
12
+ | Parameter | Type |
13
+ | --------- | --------- |
14
+ | `value` | `unknown` |
15
+
16
+ ## Returns[​](#returns "Direct link to Returns")
17
+
18
+ `value is HostedSupervisorTool`
@@ -1,5 +1,29 @@
1
1
  # Interface: AgentAdapter
2
2
 
3
+ ## Properties[​](#properties "Direct link to Properties")
4
+
5
+ ### acceptsExtensions?[​](#acceptsextensions "Direct link to acceptsExtensions?")
6
+
7
+ ```ts
8
+ readonly optional acceptsExtensions: readonly string[];
9
+
10
+ ```
11
+
12
+ Extension keys this adapter consumes from [AgentInput.extensions](./docs/api/appkit/Interface.AgentInput.md#extensions). The agents plugin (and standalone `runAgent`) warns at registration if the tool index produces extensions whose keys aren't listed here.
13
+
14
+ Adapters that don't read extensions can omit this field.
15
+
16
+ ***
17
+
18
+ ### consumesInputTools?[​](#consumesinputtools "Direct link to consumesInputTools?")
19
+
20
+ ```ts
21
+ readonly optional consumesInputTools: boolean;
22
+
23
+ ```
24
+
25
+ Whether the adapter consumes tools from `input.tools`. Defaults to true. Adapters whose tool execution happens elsewhere (e.g. the Supervisor API, where SA owns the tool loop server-side) declare false; the agents plugin warns at registration if the agent declares function tools or local sub-agents alongside such an adapter, since those tools would never reach the model.
26
+
3
27
  ## Methods[​](#methods "Direct link to Methods")
4
28
 
5
29
  ### run()[​](#run "Direct link to run()")
@@ -2,6 +2,19 @@
2
2
 
3
3
  ## Properties[​](#properties "Direct link to Properties")
4
4
 
5
+ ### extensions?[​](#extensions "Direct link to extensions?")
6
+
7
+ ```ts
8
+ optional extensions: Readonly<Record<string, unknown>>;
9
+
10
+ ```
11
+
12
+ Adapter-specific opaque payloads, keyed by adapter namespace. The shared contract intentionally does not enumerate keys — see each adapter's docs for which keys it reads and the shape of each value.
13
+
14
+ The agents plugin and standalone `runAgent` populate this from the agent's tool index when entries declare an adapter-side spec (e.g. Supervisor API hosted tools). Adapters that don't read extensions should leave it untouched.
15
+
16
+ ***
17
+
5
18
  ### messages[​](#messages "Direct link to messages")
6
19
 
7
20
  ```ts
@@ -0,0 +1,21 @@
1
+ # Interface: HostedSupervisorTool
2
+
3
+ Tagged record returned by every [supervisorTools](./docs/api/appkit/Variable.supervisorTools.md) factory. The `__kind` discriminator lets the agents plugin (and standalone `runAgent`) classify these tools without a structural match against the wire format — keeps the SA wire shape free to evolve and avoids namespace collisions with MCP hosted tools (which use `type: "genie-space"` hyphenated, vs SA's `type: "genie_space"` underscored).
4
+
5
+ ## Properties[​](#properties "Direct link to Properties")
6
+
7
+ ### \_\_kind[​](#__kind "Direct link to __kind")
8
+
9
+ ```ts
10
+ readonly __kind: "hosted-supervisor";
11
+
12
+ ```
13
+
14
+ ***
15
+
16
+ ### spec[​](#spec "Direct link to spec")
17
+
18
+ ```ts
19
+ readonly spec: SupervisorTool;
20
+
21
+ ```