@databricks/appkit-ui 0.8.0 → 0.10.0

package/CLAUDE.md

@@ -38,7 +38,7 @@ The CLI will display the documentation content directly in the terminal.
 - [Class: TunnelError](./docs/docs/api./docs/Class.TunnelError.md): Error thrown when remote tunnel operations fail.
 - [Class: ValidationError](./docs/docs/api./docs/Class.ValidationError.md): Error thrown when input validation fails.
 - [Enumeration: RequestedClaimsPermissionSet](./docs/docs/api./docs/Enumeration.RequestedClaimsPermissionSet.md): Permission set for Unity Catalog table access
-- [Enumeration: ResourceType](./docs/docs/api./docs/Enumeration.ResourceType.md): Supported resource types that plugins can depend on.
+- [Enumeration: ResourceType](./docs/docs/api./docs/Enumeration.ResourceType.md): Resource types from schema $defs.resourceType.enum
 - [Function: appKitTypesPlugin()](./docs/docs/api./docs/Function.appKitTypesPlugin.md): Vite plugin to generate types for AppKit queries.
 - [Function: createApp()](./docs/docs/api./docs/Function.createApp.md): Bootstraps AppKit with the provided configuration.
 - [Function: createLakebasePool()](./docs/docs/api./docs/Function.createLakebasePool.md): Create a Lakebase pool with appkit's logger integration.
@@ -48,6 +48,7 @@ The CLI will display the documentation content directly in the terminal.
 - [Function: getLakebasePgConfig()](./docs/docs/api./docs/Function.getLakebasePgConfig.md): Get Lakebase connection configuration for PostgreSQL clients.
 - [Function: getPluginManifest()](./docs/docs/api./docs/Function.getPluginManifest.md): Loads and validates the manifest from a plugin constructor.
 - [Function: getResourceRequirements()](./docs/docs/api./docs/Function.getResourceRequirements.md): Gets the resource requirements from a plugin's manifest.
+- [Function: getUsernameWithApiLookup()](./docs/docs/api./docs/Function.getUsernameWithApiLookup.md): Resolves the PostgreSQL username for a Lakebase connection.
 - [Function: getWorkspaceClient()](./docs/docs/api./docs/Function.getWorkspaceClient.md): Get workspace client from config or SDK default auth chain
 - [Function: isSQLTypeMarker()](./docs/docs/api./docs/Function.isSQLTypeMarker.md): Type guard to check if a value is a SQL type marker
 - [Interface: BasePluginConfig](./docs/docs/api./docs/Interface.BasePluginConfig.md): Base configuration interface for AppKit plugins
@@ -68,6 +69,7 @@ The CLI will display the documentation content directly in the terminal.
 - [Type Alias: ConfigSchema](./docs/docs/api./docs/TypeAlias.ConfigSchema.md): Configuration schema definition for plugin config.
 - [Type Alias: IAppRouter](./docs/docs/api./docs/TypeAlias.IAppRouter.md): Express router type for plugin route registration
 - [Type Alias: ResourcePermission](./docs/docs/api./docs/TypeAlias.ResourcePermission.md): Union of all possible permission levels across all resource types.
+- [Type Alias: ToPlugin()<T, U, N>](./docs/docs/api./docs/TypeAlias.ToPlugin.md): Type Parameters
 - [Variable: sql](./docs/docs/api./docs/Variable.sql.md): SQL helper namespace
 - [@databricks/appkit-ui](./docs/docs/api/appkit-ui.md): The library provides a set of UI primitives for building Databricks apps in React.
 - [AreaChart](./docs/docs/api/appkit-ui/data/AreaChart.md): Area Chart component for trend visualization with filled areas.

package/NOTICE.md

@@ -7,6 +7,7 @@ This Software contains code from the following open source projects:
 | Name             | Installed version | License | Code                                                 |
 | :--------------- | :---------------- | :----------- | :--------------------------------------------------- |
 | [@ast-grep/napi](https://www.npmjs.com/package/@ast-grep/napi) | 0.37.0 | MIT | https://ast-grep.github.io |
+| [@clack/prompts](https://www.npmjs.com/package/@clack/prompts) | 1.0.1 | MIT | https://github.com/bombshell-dev/clack/tree/main/packages/prompts#readme |
 | [@hookform/resolvers](https://www.npmjs.com/package/@hookform/resolvers) | 5.2.2 | MIT | https://react-hook-form.com |
 | [@opentelemetry/api](https://www.npmjs.com/package/@opentelemetry/api) | 1.9.0 | Apache-2.0 | https://github.com/open-telemetry/opentelemetry-js/tree/main/api |
 | [@opentelemetry/api-logs](https://www.npmjs.com/package/@opentelemetry/api-logs) | 0.208.0 | Apache-2.0 | https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/api-logs |

package/dist/cli/commands/plugin/add-resource/add-resource.js

@@ -0,0 +1,61 @@
+import { humanizeResourceType } from "../create/resource-defaults.js";
+import { promptOneResource } from "../create/prompt-resource.js";
+import { validateManifest } from "../validate/validate-manifest.js";
+import fs from "node:fs";
+import path from "node:path";
+import { Command } from "commander";
+import process from "node:process";
+import { cancel, intro, outro } from "@clack/prompts";
+
+//#region src/cli/commands/plugin/add-resource/add-resource.ts
+async function runPluginAddResource(options) {
+	intro("Add resource to plugin manifest");
+	const cwd = process.cwd();
+	const pluginDir = path.resolve(cwd, options.path ?? ".");
+	const manifestPath = path.join(pluginDir, "manifest.json");
+	if (!fs.existsSync(manifestPath)) {
+		console.error(`manifest.json not found at ${manifestPath}`);
+		process.exit(1);
+	}
+	let manifest;
+	try {
+		const raw = fs.readFileSync(manifestPath, "utf-8");
+		const parsed = JSON.parse(raw);
+		const result = validateManifest(parsed);
+		if (!result.valid || !result.manifest) {
+			console.error("Invalid manifest. Run `appkit plugin validate` for details.");
+			process.exit(1);
+		}
+		manifest = parsed;
+	} catch (err) {
+		console.error("Failed to read or parse manifest.json:", err instanceof Error ? err.message : err);
+		process.exit(1);
+	}
+	const spec = await promptOneResource();
+	if (!spec) {
+		cancel("Cancelled.");
+		process.exit(0);
+	}
+	const alias = humanizeResourceType(spec.type);
+	const entry = {
+		type: spec.type,
+		alias,
+		resourceKey: spec.resourceKey,
+		description: spec.description || `Required for ${alias} functionality.`,
+		permission: spec.permission,
+		fields: spec.fields
+	};
+	if (spec.required) manifest.resources.required.push(entry);
+	else manifest.resources.optional.push(entry);
+	fs.writeFileSync(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);
+	outro("Resource added.");
+	console.log(`\nAdded ${alias} as ${spec.required ? "required" : "optional"} to ${path.relative(cwd, manifestPath)}`);
+}
+const pluginAddResourceCommand = new Command("add-resource").description("Add a resource requirement to an existing plugin manifest (interactive). Overwrites manifest.json in place.").option("-p, --path <dir>", "Plugin directory containing manifest.json (default: .)").action((opts) => runPluginAddResource(opts).catch((err) => {
+	console.error(err);
+	process.exit(1);
+}));
+
+//#endregion
+export { pluginAddResourceCommand };
+//# sourceMappingURL=add-resource.js.map

package/dist/cli/commands/plugin/add-resource/add-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-resource.js","names":[],"sources":["../../../../../src/cli/commands/plugin/add-resource/add-resource.ts"],"sourcesContent":["import fs from \"node:fs\";\nimport path from \"node:path\";\nimport process from \"node:process\";\nimport { cancel, intro, outro } from \"@clack/prompts\";\nimport { Command } from \"commander\";\nimport { promptOneResource } from \"../create/prompt-resource\";\nimport { humanizeResourceType } from \"../create/resource-defaults\";\nimport type { PluginManifest } from \"../manifest-types\";\nimport { validateManifest } from \"../validate/validate-manifest\";\n\n/** Extended manifest type that preserves extra JSON fields (e.g. $schema, author, version) for round-trip writes. */\ninterface ManifestWithExtras extends PluginManifest {\n  [key: string]: unknown;\n}\n\nasync function runPluginAddResource(options: { path?: string }): Promise<void> {\n  intro(\"Add resource to plugin manifest\");\n\n  const cwd = process.cwd();\n  const pluginDir = path.resolve(cwd, options.path ?? \".\");\n  const manifestPath = path.join(pluginDir, \"manifest.json\");\n\n  if (!fs.existsSync(manifestPath)) {\n    console.error(`manifest.json not found at ${manifestPath}`);\n    process.exit(1);\n  }\n\n  let manifest: ManifestWithExtras;\n  try {\n    const raw = fs.readFileSync(manifestPath, \"utf-8\");\n    const parsed = JSON.parse(raw) as unknown;\n    const result = validateManifest(parsed);\n    if (!result.valid || !result.manifest) {\n      console.error(\n        \"Invalid manifest. Run `appkit plugin validate` for details.\",\n      );\n      process.exit(1);\n    }\n    manifest = parsed as ManifestWithExtras;\n  } catch (err) {\n    console.error(\n      \"Failed to read or parse manifest.json:\",\n      err instanceof Error ? err.message : err,\n    );\n    process.exit(1);\n  }\n\n  const spec = await promptOneResource();\n  if (!spec) {\n    cancel(\"Cancelled.\");\n    process.exit(0);\n  }\n\n  const alias = humanizeResourceType(spec.type);\n  const entry = {\n    type: spec.type,\n    alias,\n    resourceKey: spec.resourceKey,\n    description: spec.description || `Required for ${alias} functionality.`,\n    permission: spec.permission,\n    fields: spec.fields,\n  };\n\n  if (spec.required) {\n    manifest.resources.required.push(entry);\n  } else {\n    manifest.resources.optional.push(entry);\n  }\n\n  fs.writeFileSync(manifestPath, `${JSON.stringify(manifest, null, 2)}\\n`);\n\n  outro(\"Resource added.\");\n  console.log(\n    `\\nAdded ${alias} as ${spec.required ? \"required\" : \"optional\"} to ${path.relative(cwd, manifestPath)}`,\n  );\n}\n\nexport const pluginAddResourceCommand = new Command(\"add-resource\")\n  .description(\n    \"Add a resource requirement to an existing plugin manifest (interactive). Overwrites manifest.json in place.\",\n  )\n  .option(\n    \"-p, --path <dir>\",\n    \"Plugin directory containing manifest.json (default: .)\",\n  )\n  .action((opts) =>\n    runPluginAddResource(opts).catch((err) => {\n      console.error(err);\n      process.exit(1);\n    }),\n  );\n"],"mappings":";;;;;;;;;;AAeA,eAAe,qBAAqB,SAA2C;AAC7E,OAAM,kCAAkC;CAExC,MAAM,MAAM,QAAQ,KAAK;CACzB,MAAM,YAAY,KAAK,QAAQ,KAAK,QAAQ,QAAQ,IAAI;CACxD,MAAM,eAAe,KAAK,KAAK,WAAW,gBAAgB;AAE1D,KAAI,CAAC,GAAG,WAAW,aAAa,EAAE;AAChC,UAAQ,MAAM,8BAA8B,eAAe;AAC3D,UAAQ,KAAK,EAAE;;CAGjB,IAAI;AACJ,KAAI;EACF,MAAM,MAAM,GAAG,aAAa,cAAc,QAAQ;EAClD,MAAM,SAAS,KAAK,MAAM,IAAI;EAC9B,MAAM,SAAS,iBAAiB,OAAO;AACvC,MAAI,CAAC,OAAO,SAAS,CAAC,OAAO,UAAU;AACrC,WAAQ,MACN,8DACD;AACD,WAAQ,KAAK,EAAE;;AAEjB,aAAW;UACJ,KAAK;AACZ,UAAQ,MACN,0CACA,eAAe,QAAQ,IAAI,UAAU,IACtC;AACD,UAAQ,KAAK,EAAE;;CAGjB,MAAM,OAAO,MAAM,mBAAmB;AACtC,KAAI,CAAC,MAAM;AACT,SAAO,aAAa;AACpB,UAAQ,KAAK,EAAE;;CAGjB,MAAM,QAAQ,qBAAqB,KAAK,KAAK;CAC7C,MAAM,QAAQ;EACZ,MAAM,KAAK;EACX;EACA,aAAa,KAAK;EAClB,aAAa,KAAK,eAAe,gBAAgB,MAAM;EACvD,YAAY,KAAK;EACjB,QAAQ,KAAK;EACd;AAED,KAAI,KAAK,SACP,UAAS,UAAU,SAAS,KAAK,MAAM;KAEvC,UAAS,UAAU,SAAS,KAAK,MAAM;AAGzC,IAAG,cAAc,cAAc,GAAG,KAAK,UAAU,UAAU,MAAM,EAAE,CAAC,IAAI;AAExE,OAAM,kBAAkB;AACxB,SAAQ,IACN,WAAW,MAAM,MAAM,KAAK,WAAW,aAAa,WAAW,MAAM,KAAK,SAAS,KAAK,aAAa,GACtG;;AAGH,MAAa,2BAA2B,IAAI,QAAQ,eAAe,CAChE,YACC,8GACD,CACA,OACC,oBACA,yDACD,CACA,QAAQ,SACP,qBAAqB,KAAK,CAAC,OAAO,QAAQ;AACxC,SAAQ,MAAM,IAAI;AAClB,SAAQ,KAAK,EAAE;EACf,CACH"}

package/dist/cli/commands/plugin/create/create.js

@@ -0,0 +1,162 @@
+import { RESOURCE_TYPE_OPTIONS } from "./resource-defaults.js";
+import { promptOneResource } from "./prompt-resource.js";
+import { resolveTargetDir, scaffoldPlugin } from "./scaffold.js";
+import fs from "node:fs";
+import path from "node:path";
+import { Command } from "commander";
+import process from "node:process";
+import { cancel, confirm, intro, isCancel, multiselect, outro, select, spinner, text } from "@clack/prompts";
+
+//#region src/cli/commands/plugin/create/create.ts
+const NAME_PATTERN = /^[a-z][a-z0-9-]*$/;
+const DEFAULT_VERSION = "0.1.0";
+async function runPluginCreate() {
+	intro("Create a new AppKit plugin");
+	try {
+		const placement = await select({
+			message: "Where should the plugin live?",
+			options: [{
+				value: "in-repo",
+				label: "In this repository (e.g. plugins/my-plugin)",
+				hint: "folder path"
+			}, {
+				value: "isolated",
+				label: "New isolated package",
+				hint: "full package with package.json"
+			}]
+		});
+		if (isCancel(placement)) {
+			cancel("Cancelled.");
+			process.exit(0);
+		}
+		const targetPath = await text({
+			message: placement === "in-repo" ? "Folder path for the plugin (e.g. plugins/my-feature)" : "Directory name for the new package (e.g. appkit-plugin-my-feature)",
+			placeholder: placement === "in-repo" ? "plugins/my-plugin" : "appkit-plugin-my-feature",
+			validate(value) {
+				if (!value?.trim()) return "Path is required.";
+				if (placement === "in-repo" && (path.isAbsolute(value) || value.trim().startsWith(".."))) return "Use a relative path under the current directory (e.g. plugins/my-plugin).";
+			}
+		});
+		if (isCancel(targetPath)) {
+			cancel("Cancelled.");
+			process.exit(0);
+		}
+		const name = await text({
+			message: "Plugin name (id)",
+			placeholder: "my-plugin",
+			validate(value) {
+				if (!value?.trim()) return "Name is required.";
+				if (!NAME_PATTERN.test(value)) return "Must be lowercase, start with a letter, and use only letters, numbers, and hyphens.";
+			}
+		});
+		if (isCancel(name)) {
+			cancel("Cancelled.");
+			process.exit(0);
+		}
+		const displayName = await text({
+			message: "Display name",
+			placeholder: "My Plugin",
+			initialValue: name.split("-").map((s) => s.charAt(0).toUpperCase() + s.slice(1)).join(" "),
+			validate(value) {
+				if (!value?.trim()) return "Display name is required.";
+			}
+		});
+		if (isCancel(displayName)) {
+			cancel("Cancelled.");
+			process.exit(0);
+		}
+		const description = await text({
+			message: "Short description",
+			placeholder: "What does this plugin do?",
+			validate(value) {
+				if (!value?.trim()) return "Description is required.";
+			}
+		});
+		if (isCancel(description)) {
+			cancel("Cancelled.");
+			process.exit(0);
+		}
+		const resourceTypes = await multiselect({
+			message: "Which Databricks resources does this plugin need?",
+			options: RESOURCE_TYPE_OPTIONS.map((o) => ({
+				value: o.value,
+				label: o.label
+			})),
+			required: false
+		});
+		if (isCancel(resourceTypes)) {
+			cancel("Cancelled.");
+			process.exit(0);
+		}
+		const resources = [];
+		for (const type of resourceTypes) {
+			const spec = await promptOneResource({ type });
+			if (!spec) {
+				cancel("Cancelled.");
+				process.exit(0);
+			}
+			resources.push({
+				type: spec.type,
+				required: spec.required,
+				description: spec.description,
+				resourceKey: spec.resourceKey,
+				permission: spec.permission,
+				fields: spec.fields
+			});
+		}
+		const answers = {
+			placement,
+			targetPath: targetPath.trim(),
+			name: name.trim(),
+			displayName: displayName.trim(),
+			description: description.trim(),
+			resources,
+			version: DEFAULT_VERSION
+		};
+		const targetDir = resolveTargetDir(process.cwd(), answers);
+		if (fs.existsSync(targetDir) && fs.readdirSync(targetDir).length > 0) {
+			const overwrite = await confirm({
+				message: `Directory ${answers.targetPath} already exists and is not empty. Overwrite?`,
+				initialValue: false
+			});
+			if (isCancel(overwrite) || !overwrite) {
+				cancel("Cancelled.");
+				process.exit(0);
+			}
+		}
+		const s = spinner();
+		s.start("Writing files…");
+		try {
+			scaffoldPlugin(targetDir, answers, { isolated: placement === "isolated" });
+			s.stop("Files written.");
+		} catch (err) {
+			s.stop("Failed.");
+			throw err;
+		}
+		const relativePath = path.relative(process.cwd(), targetDir);
+		const importPath = relativePath.startsWith(".") ? relativePath : `./${relativePath}`;
+		const exportName = answers.name.split("-").map((s, i) => i === 0 ? s : s.charAt(0).toUpperCase() + s.slice(1)).join("");
+		outro("Plugin created successfully.");
+		console.log("\nNext steps:\n");
+		if (placement === "in-repo") {
+			console.log(`  1. Import and register in your server:`);
+			console.log(`     import { ${exportName} } from "${importPath}";`);
+			console.log(`     createApp({ plugins: [ ..., ${exportName}() ] });`);
+			console.log(`  2. Run \`npx appkit plugin sync --write\` to update appkit.plugins.json.\n`);
+		} else {
+			console.log(`  1. cd into the new package and install dependencies:`);
+			console.log(`     cd ${answers.targetPath} && pnpm install`);
+			console.log(`  2. Build: pnpm build`);
+			console.log(`  3. In your app: pnpm add ./${answers.targetPath} @databricks/appkit`);
+			console.log(`  4. Import and register: import { ${exportName} } from "<package-name>";\n`);
+		}
+	} catch (err) {
+		console.error(err);
+		process.exit(1);
+	}
+}
+const pluginCreateCommand = new Command("create").description("Scaffold a new AppKit plugin (interactive)").action(runPluginCreate);
+
+//#endregion
+export { pluginCreateCommand };
+//# sourceMappingURL=create.js.map

package/dist/cli/commands/plugin/create/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","names":[],"sources":["../../../../../src/cli/commands/plugin/create/create.ts"],"sourcesContent":["import fs from \"node:fs\";\nimport path from \"node:path\";\nimport process from \"node:process\";\nimport {\n  cancel,\n  confirm,\n  intro,\n  isCancel,\n  multiselect,\n  outro,\n  select,\n  spinner,\n  text,\n} from \"@clack/prompts\";\nimport { Command } from \"commander\";\nimport { promptOneResource } from \"./prompt-resource\";\nimport { RESOURCE_TYPE_OPTIONS } from \"./resource-defaults\";\nimport { resolveTargetDir, scaffoldPlugin } from \"./scaffold\";\nimport type { CreateAnswers, Placement } from \"./types\";\n\nconst NAME_PATTERN = /^[a-z][a-z0-9-]*$/;\nconst DEFAULT_VERSION = \"0.1.0\";\n\nasync function runPluginCreate(): Promise<void> {\n  intro(\"Create a new AppKit plugin\");\n\n  try {\n    const placement = await select<Placement>({\n      message: \"Where should the plugin live?\",\n      options: [\n        {\n          value: \"in-repo\",\n          label: \"In this repository (e.g. plugins/my-plugin)\",\n          hint: \"folder path\",\n        },\n        {\n          value: \"isolated\",\n          label: \"New isolated package\",\n          hint: \"full package with package.json\",\n        },\n      ],\n    });\n    if (isCancel(placement)) {\n      cancel(\"Cancelled.\");\n      process.exit(0);\n    }\n\n    const placementPrompt =\n      placement === \"in-repo\"\n        ? \"Folder path for the plugin (e.g. plugins/my-feature)\"\n        : \"Directory name for the new package (e.g. appkit-plugin-my-feature)\";\n    const targetPath = await text({\n      message: placementPrompt,\n      placeholder:\n        placement === \"in-repo\"\n          ? \"plugins/my-plugin\"\n          : \"appkit-plugin-my-feature\",\n      validate(value) {\n        if (!value?.trim()) return \"Path is required.\";\n        if (\n          placement === \"in-repo\" &&\n          (path.isAbsolute(value) || value.trim().startsWith(\"..\"))\n        ) {\n          return \"Use a relative path under the current directory (e.g. plugins/my-plugin).\";\n        }\n        return undefined;\n      },\n    });\n    if (isCancel(targetPath)) {\n      cancel(\"Cancelled.\");\n      process.exit(0);\n    }\n\n    const name = await text({\n      message: \"Plugin name (id)\",\n      placeholder: \"my-plugin\",\n      validate(value) {\n        if (!value?.trim()) return \"Name is required.\";\n        if (!NAME_PATTERN.test(value as string)) {\n          return \"Must be lowercase, start with a letter, and use only letters, numbers, and hyphens.\";\n        }\n        return undefined;\n      },\n    });\n    if (isCancel(name)) {\n      cancel(\"Cancelled.\");\n      process.exit(0);\n    }\n\n    const displayName = await text({\n      message: \"Display name\",\n      placeholder: \"My Plugin\",\n      initialValue: name\n        .split(\"-\")\n        .map((s) => s.charAt(0).toUpperCase() + s.slice(1))\n        .join(\" \"),\n      validate(value) {\n        if (!value?.trim()) return \"Display name is required.\";\n        return undefined;\n      },\n    });\n    if (isCancel(displayName)) {\n      cancel(\"Cancelled.\");\n      process.exit(0);\n    }\n\n    const description = await text({\n      message: \"Short description\",\n      placeholder: \"What does this plugin do?\",\n      validate(value) {\n        if (!value?.trim()) return \"Description is required.\";\n        return undefined;\n      },\n    });\n    if (isCancel(description)) {\n      cancel(\"Cancelled.\");\n      process.exit(0);\n    }\n\n    const resourceTypes = await multiselect({\n      message: \"Which Databricks resources does this plugin need?\",\n      options: RESOURCE_TYPE_OPTIONS.map((o) => ({\n        value: o.value,\n        label: o.label,\n      })),\n      required: false,\n    });\n    if (isCancel(resourceTypes)) {\n      cancel(\"Cancelled.\");\n      process.exit(0);\n    }\n\n    const resources: CreateAnswers[\"resources\"] = [];\n    for (const type of resourceTypes as string[]) {\n      const spec = await promptOneResource({ type });\n      if (!spec) {\n        cancel(\"Cancelled.\");\n        process.exit(0);\n      }\n      resources.push({\n        type: spec.type,\n        required: spec.required,\n        description: spec.description,\n        resourceKey: spec.resourceKey,\n        permission: spec.permission,\n        fields: spec.fields,\n      });\n    }\n\n    const answers: CreateAnswers = {\n      placement,\n      targetPath: (targetPath as string).trim(),\n      name: (name as string).trim(),\n      displayName: (displayName as string).trim(),\n      description: (description as string).trim(),\n      resources,\n      version: DEFAULT_VERSION,\n    };\n\n    const targetDir = resolveTargetDir(process.cwd(), answers);\n    const dirExists = fs.existsSync(targetDir);\n    const hasContent = dirExists && fs.readdirSync(targetDir).length > 0;\n    if (hasContent) {\n      const overwrite = await confirm({\n        message: `Directory ${answers.targetPath} already exists and is not empty. Overwrite?`,\n        initialValue: false,\n      });\n      if (isCancel(overwrite) || !overwrite) {\n        cancel(\"Cancelled.\");\n        process.exit(0);\n      }\n    }\n\n    const s = spinner();\n    s.start(\"Writing files…\");\n    try {\n      scaffoldPlugin(targetDir, answers, {\n        isolated: placement === \"isolated\",\n      });\n      s.stop(\"Files written.\");\n    } catch (err) {\n      s.stop(\"Failed.\");\n      throw err;\n    }\n\n    const relativePath = path.relative(process.cwd(), targetDir);\n    const importPath = relativePath.startsWith(\".\")\n      ? relativePath\n      : `./${relativePath}`;\n    const exportName = answers.name\n      .split(\"-\")\n      .map((s, i) => (i === 0 ? s : s.charAt(0).toUpperCase() + s.slice(1)))\n      .join(\"\");\n\n    outro(\"Plugin created successfully.\");\n\n    console.log(\"\\nNext steps:\\n\");\n    if (placement === \"in-repo\") {\n      console.log(`  1. Import and register in your server:`);\n      console.log(`     import { ${exportName} } from \"${importPath}\";`);\n      console.log(`     createApp({ plugins: [ ..., ${exportName}() ] });`);\n      console.log(\n        `  2. Run \\`npx appkit plugin sync --write\\` to update appkit.plugins.json.\\n`,\n      );\n    } else {\n      console.log(`  1. cd into the new package and install dependencies:`);\n      console.log(`     cd ${answers.targetPath} && pnpm install`);\n      console.log(`  2. Build: pnpm build`);\n      console.log(\n        `  3. In your app: pnpm add ./${answers.targetPath} @databricks/appkit`,\n      );\n      console.log(\n        `  4. Import and register: import { ${exportName} } from \"<package-name>\";\\n`,\n      );\n    }\n  } catch (err) {\n    console.error(err);\n    process.exit(1);\n  }\n}\n\nexport const pluginCreateCommand = new Command(\"create\")\n  .description(\"Scaffold a new AppKit plugin (interactive)\")\n  .action(runPluginCreate);\n"],"mappings":";;;;;;;;;;AAoBA,MAAM,eAAe;AACrB,MAAM,kBAAkB;AAExB,eAAe,kBAAiC;AAC9C,OAAM,6BAA6B;AAEnC,KAAI;EACF,MAAM,YAAY,MAAM,OAAkB;GACxC,SAAS;GACT,SAAS,CACP;IACE,OAAO;IACP,OAAO;IACP,MAAM;IACP,EACD;IACE,OAAO;IACP,OAAO;IACP,MAAM;IACP,CACF;GACF,CAAC;AACF,MAAI,SAAS,UAAU,EAAE;AACvB,UAAO,aAAa;AACpB,WAAQ,KAAK,EAAE;;EAOjB,MAAM,aAAa,MAAM,KAAK;GAC5B,SAJA,cAAc,YACV,yDACA;GAGJ,aACE,cAAc,YACV,sBACA;GACN,SAAS,OAAO;AACd,QAAI,CAAC,OAAO,MAAM,CAAE,QAAO;AAC3B,QACE,cAAc,cACb,KAAK,WAAW,MAAM,IAAI,MAAM,MAAM,CAAC,WAAW,KAAK,EAExD,QAAO;;GAIZ,CAAC;AACF,MAAI,SAAS,WAAW,EAAE;AACxB,UAAO,aAAa;AACpB,WAAQ,KAAK,EAAE;;EAGjB,MAAM,OAAO,MAAM,KAAK;GACtB,SAAS;GACT,aAAa;GACb,SAAS,OAAO;AACd,QAAI,CAAC,OAAO,MAAM,CAAE,QAAO;AAC3B,QAAI,CAAC,aAAa,KAAK,MAAgB,CACrC,QAAO;;GAIZ,CAAC;AACF,MAAI,SAAS,KAAK,EAAE;AAClB,UAAO,aAAa;AACpB,WAAQ,KAAK,EAAE;;EAGjB,MAAM,cAAc,MAAM,KAAK;GAC7B,SAAS;GACT,aAAa;GACb,cAAc,KACX,MAAM,IAAI,CACV,KAAK,MAAM,EAAE,OAAO,EAAE,CAAC,aAAa,GAAG,EAAE,MAAM,EAAE,CAAC,CAClD,KAAK,IAAI;GACZ,SAAS,OAAO;AACd,QAAI,CAAC,OAAO,MAAM,CAAE,QAAO;;GAG9B,CAAC;AACF,MAAI,SAAS,YAAY,EAAE;AACzB,UAAO,aAAa;AACpB,WAAQ,KAAK,EAAE;;EAGjB,MAAM,cAAc,MAAM,KAAK;GAC7B,SAAS;GACT,aAAa;GACb,SAAS,OAAO;AACd,QAAI,CAAC,OAAO,MAAM,CAAE,QAAO;;GAG9B,CAAC;AACF,MAAI,SAAS,YAAY,EAAE;AACzB,UAAO,aAAa;AACpB,WAAQ,KAAK,EAAE;;EAGjB,MAAM,gBAAgB,MAAM,YAAY;GACtC,SAAS;GACT,SAAS,sBAAsB,KAAK,OAAO;IACzC,OAAO,EAAE;IACT,OAAO,EAAE;IACV,EAAE;GACH,UAAU;GACX,CAAC;AACF,MAAI,SAAS,cAAc,EAAE;AAC3B,UAAO,aAAa;AACpB,WAAQ,KAAK,EAAE;;EAGjB,MAAM,YAAwC,EAAE;AAChD,OAAK,MAAM,QAAQ,eAA2B;GAC5C,MAAM,OAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC;AAC9C,OAAI,CAAC,MAAM;AACT,WAAO,aAAa;AACpB,YAAQ,KAAK,EAAE;;AAEjB,aAAU,KAAK;IACb,MAAM,KAAK;IACX,UAAU,KAAK;IACf,aAAa,KAAK;IAClB,aAAa,KAAK;IAClB,YAAY,KAAK;IACjB,QAAQ,KAAK;IACd,CAAC;;EAGJ,MAAM,UAAyB;GAC7B;GACA,YAAa,WAAsB,MAAM;GACzC,MAAO,KAAgB,MAAM;GAC7B,aAAc,YAAuB,MAAM;GAC3C,aAAc,YAAuB,MAAM;GAC3C;GACA,SAAS;GACV;EAED,MAAM,YAAY,iBAAiB,QAAQ,KAAK,EAAE,QAAQ;AAG1D,MAFkB,GAAG,WAAW,UAAU,IACV,GAAG,YAAY,UAAU,CAAC,SAAS,GACnD;GACd,MAAM,YAAY,MAAM,QAAQ;IAC9B,SAAS,aAAa,QAAQ,WAAW;IACzC,cAAc;IACf,CAAC;AACF,OAAI,SAAS,UAAU,IAAI,CAAC,WAAW;AACrC,WAAO,aAAa;AACpB,YAAQ,KAAK,EAAE;;;EAInB,MAAM,IAAI,SAAS;AACnB,IAAE,MAAM,iBAAiB;AACzB,MAAI;AACF,kBAAe,WAAW,SAAS,EACjC,UAAU,cAAc,YACzB,CAAC;AACF,KAAE,KAAK,iBAAiB;WACjB,KAAK;AACZ,KAAE,KAAK,UAAU;AACjB,SAAM;;EAGR,MAAM,eAAe,KAAK,SAAS,QAAQ,KAAK,EAAE,UAAU;EAC5D,MAAM,aAAa,aAAa,WAAW,IAAI,GAC3C,eACA,KAAK;EACT,MAAM,aAAa,QAAQ,KACxB,MAAM,IAAI,CACV,KAAK,GAAG,MAAO,MAAM,IAAI,IAAI,EAAE,OAAO,EAAE,CAAC,aAAa,GAAG,EAAE,MAAM,EAAE,CAAE,CACrE,KAAK,GAAG;AAEX,QAAM,+BAA+B;AAErC,UAAQ,IAAI,kBAAkB;AAC9B,MAAI,cAAc,WAAW;AAC3B,WAAQ,IAAI,2CAA2C;AACvD,WAAQ,IAAI,iBAAiB,WAAW,WAAW,WAAW,IAAI;AAClE,WAAQ,IAAI,oCAAoC,WAAW,UAAU;AACrE,WAAQ,IACN,+EACD;SACI;AACL,WAAQ,IAAI,yDAAyD;AACrE,WAAQ,IAAI,WAAW,QAAQ,WAAW,kBAAkB;AAC5D,WAAQ,IAAI,yBAAyB;AACrC,WAAQ,IACN,gCAAgC,QAAQ,WAAW,qBACpD;AACD,WAAQ,IACN,sCAAsC,WAAW,6BAClD;;UAEI,KAAK;AACZ,UAAQ,MAAM,IAAI;AAClB,UAAQ,KAAK,EAAE;;;AAInB,MAAa,sBAAsB,IAAI,QAAQ,SAAS,CACrD,YAAY,6CAA6C,CACzD,OAAO,gBAAgB"}

package/dist/cli/commands/plugin/create/prompt-resource.js

@@ -0,0 +1,95 @@
+import { PERMISSIONS_BY_TYPE, RESOURCE_TYPE_OPTIONS, getDefaultFieldsForType, humanizeResourceType, resourceKeyFromType } from "./resource-defaults.js";
+import { isCancel, select, text } from "@clack/prompts";
+
+//#region src/cli/commands/plugin/create/prompt-resource.ts
+/**
+* Prompt for a single resource: type (optional), required, description, resourceKey, permission, and field env vars.
+* When type is provided (e.g. from create's multiselect), type prompt is skipped.
+*/
+async function promptOneResource(opts) {
+	let type = opts?.type;
+	if (!type) {
+		const resourceType = await select({
+			message: "Resource type",
+			options: RESOURCE_TYPE_OPTIONS.map((o) => ({
+				value: o.value,
+				label: o.label
+			}))
+		});
+		if (isCancel(resourceType)) return null;
+		type = resourceType;
+	}
+	const required = await select({
+		message: `${humanizeResourceType(type)} – required or optional?`,
+		options: [{
+			value: true,
+			label: "Required",
+			hint: "plugin needs it to function"
+		}, {
+			value: false,
+			label: "Optional",
+			hint: "enhances functionality"
+		}]
+	});
+	if (isCancel(required)) return null;
+	const description = await text({
+		message: `Short description for ${humanizeResourceType(type)}`,
+		placeholder: required ? "Required for …" : "Optional for …"
+	});
+	if (isCancel(description)) return null;
+	const defaultKey = resourceKeyFromType(type);
+	const resourceKey = await text({
+		message: "Resource key (unique identifier within the manifest)",
+		initialValue: defaultKey,
+		placeholder: defaultKey,
+		validate: (val = "") => {
+			if (!val.trim()) return "Resource key is required";
+			if (!/^[a-z][a-z0-9-]*$/.test(val)) return "Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens";
+		}
+	});
+	if (isCancel(resourceKey)) return null;
+	const typePermissions = PERMISSIONS_BY_TYPE[type] ?? ["CAN_VIEW"];
+	let permission;
+	if (typePermissions.length === 1) permission = typePermissions[0];
+	else {
+		const selected = await select({
+			message: "Permission level",
+			options: typePermissions.map((p) => ({
+				value: p,
+				label: p
+			}))
+		});
+		if (isCancel(selected)) return null;
+		permission = selected;
+	}
+	const defaultFields = getDefaultFieldsForType(type);
+	const fields = {};
+	for (const [fieldKey, defaults] of Object.entries(defaultFields)) {
+		const envName = await text({
+			message: `Env var for "${fieldKey}"${defaults.description ? ` (${defaults.description})` : ""}`,
+			initialValue: defaults.env,
+			placeholder: defaults.env,
+			validate: (val = "") => {
+				if (!val.trim()) return "Env var name is required";
+				if (!/^[A-Z][A-Z0-9_]*$/.test(val)) return "Must be uppercase, start with a letter (e.g. DATABRICKS_WAREHOUSE_ID)";
+			}
+		});
+		if (isCancel(envName)) return null;
+		fields[fieldKey] = {
+			env: envName.trim(),
+			...defaults.description ? { description: defaults.description } : {}
+		};
+	}
+	return {
+		type,
+		required,
+		description: description?.trim() || "",
+		resourceKey: resourceKey.trim(),
+		permission,
+		fields
+	};
+}
+
+//#endregion
+export { promptOneResource };
+//# sourceMappingURL=prompt-resource.js.map

package/dist/cli/commands/plugin/create/prompt-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt-resource.js","names":[],"sources":["../../../../../src/cli/commands/plugin/create/prompt-resource.ts"],"sourcesContent":["import { isCancel, select, text } from \"@clack/prompts\";\nimport {\n  getDefaultFieldsForType,\n  humanizeResourceType,\n  PERMISSIONS_BY_TYPE,\n  RESOURCE_TYPE_OPTIONS,\n  resourceKeyFromType,\n} from \"./resource-defaults\";\n\n/** Full resource spec collected from prompts (shared by create and add-resource). */\nexport interface ResourceSpec {\n  type: string;\n  required: boolean;\n  description: string;\n  resourceKey: string;\n  permission: string;\n  fields: Record<string, { env: string; description?: string }>;\n}\n\n/**\n * Prompt for a single resource: type (optional), required, description, resourceKey, permission, and field env vars.\n * When type is provided (e.g. from create's multiselect), type prompt is skipped.\n */\nexport async function promptOneResource(opts?: {\n  type?: string;\n}): Promise<ResourceSpec | null> {\n  let type = opts?.type;\n\n  if (!type) {\n    const resourceType = await select({\n      message: \"Resource type\",\n      options: RESOURCE_TYPE_OPTIONS.map((o) => ({\n        value: o.value,\n        label: o.label,\n      })),\n    });\n    if (isCancel(resourceType)) return null;\n    type = resourceType as string;\n  }\n\n  const required = await select<boolean>({\n    message: `${humanizeResourceType(type)} – required or optional?`,\n    options: [\n      { value: true, label: \"Required\", hint: \"plugin needs it to function\" },\n      { value: false, label: \"Optional\", hint: \"enhances functionality\" },\n    ],\n  });\n  if (isCancel(required)) return null;\n\n  const description = await text({\n    message: `Short description for ${humanizeResourceType(type)}`,\n    placeholder: required ? \"Required for …\" : \"Optional for …\",\n  });\n  if (isCancel(description)) return null;\n\n  const defaultKey = resourceKeyFromType(type);\n  const resourceKey = await text({\n    message: \"Resource key (unique identifier within the manifest)\",\n    initialValue: defaultKey,\n    placeholder: defaultKey,\n    validate: (val = \"\") => {\n      if (!val.trim()) return \"Resource key is required\";\n      if (!/^[a-z][a-z0-9-]*$/.test(val))\n        return \"Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens\";\n    },\n  });\n  if (isCancel(resourceKey)) return null;\n\n  const typePermissions = PERMISSIONS_BY_TYPE[type] ?? [\"CAN_VIEW\"];\n  let permission: string;\n  if (typePermissions.length === 1) {\n    permission = typePermissions[0];\n  } else {\n    const selected = await select({\n      message: \"Permission level\",\n      options: typePermissions.map((p) => ({ value: p, label: p })),\n    });\n    if (isCancel(selected)) return null;\n    permission = selected as string;\n  }\n\n  const defaultFields = getDefaultFieldsForType(type);\n  const fields: Record<string, { env: string; description?: string }> = {};\n\n  for (const [fieldKey, defaults] of Object.entries(defaultFields)) {\n    const envName = await text({\n      message: `Env var for \"${fieldKey}\"${defaults.description ? ` (${defaults.description})` : \"\"}`,\n      initialValue: defaults.env,\n      placeholder: defaults.env,\n      validate: (val = \"\") => {\n        if (!val.trim()) return \"Env var name is required\";\n        if (!/^[A-Z][A-Z0-9_]*$/.test(val))\n          return \"Must be uppercase, start with a letter (e.g. DATABRICKS_WAREHOUSE_ID)\";\n      },\n    });\n    if (isCancel(envName)) return null;\n    fields[fieldKey] = {\n      env: (envName as string).trim(),\n      ...(defaults.description ? { description: defaults.description } : {}),\n    };\n  }\n\n  return {\n    type,\n    required: required as boolean,\n    description: (description as string)?.trim() || \"\",\n    resourceKey: (resourceKey as string).trim(),\n    permission,\n    fields,\n  };\n}\n"],"mappings":";;;;;;;;AAuBA,eAAsB,kBAAkB,MAEP;CAC/B,IAAI,OAAO,MAAM;AAEjB,KAAI,CAAC,MAAM;EACT,MAAM,eAAe,MAAM,OAAO;GAChC,SAAS;GACT,SAAS,sBAAsB,KAAK,OAAO;IACzC,OAAO,EAAE;IACT,OAAO,EAAE;IACV,EAAE;GACJ,CAAC;AACF,MAAI,SAAS,aAAa,CAAE,QAAO;AACnC,SAAO;;CAGT,MAAM,WAAW,MAAM,OAAgB;EACrC,SAAS,GAAG,qBAAqB,KAAK,CAAC;EACvC,SAAS,CACP;GAAE,OAAO;GAAM,OAAO;GAAY,MAAM;GAA+B,EACvE;GAAE,OAAO;GAAO,OAAO;GAAY,MAAM;GAA0B,CACpE;EACF,CAAC;AACF,KAAI,SAAS,SAAS,CAAE,QAAO;CAE/B,MAAM,cAAc,MAAM,KAAK;EAC7B,SAAS,yBAAyB,qBAAqB,KAAK;EAC5D,aAAa,WAAW,mBAAmB;EAC5C,CAAC;AACF,KAAI,SAAS,YAAY,CAAE,QAAO;CAElC,MAAM,aAAa,oBAAoB,KAAK;CAC5C,MAAM,cAAc,MAAM,KAAK;EAC7B,SAAS;EACT,cAAc;EACd,aAAa;EACb,WAAW,MAAM,OAAO;AACtB,OAAI,CAAC,IAAI,MAAM,CAAE,QAAO;AACxB,OAAI,CAAC,oBAAoB,KAAK,IAAI,CAChC,QAAO;;EAEZ,CAAC;AACF,KAAI,SAAS,YAAY,CAAE,QAAO;CAElC,MAAM,kBAAkB,oBAAoB,SAAS,CAAC,WAAW;CACjE,IAAI;AACJ,KAAI,gBAAgB,WAAW,EAC7B,cAAa,gBAAgB;MACxB;EACL,MAAM,WAAW,MAAM,OAAO;GAC5B,SAAS;GACT,SAAS,gBAAgB,KAAK,OAAO;IAAE,OAAO;IAAG,OAAO;IAAG,EAAE;GAC9D,CAAC;AACF,MAAI,SAAS,SAAS,CAAE,QAAO;AAC/B,eAAa;;CAGf,MAAM,gBAAgB,wBAAwB,KAAK;CACnD,MAAM,SAAgE,EAAE;AAExE,MAAK,MAAM,CAAC,UAAU,aAAa,OAAO,QAAQ,cAAc,EAAE;EAChE,MAAM,UAAU,MAAM,KAAK;GACzB,SAAS,gBAAgB,SAAS,GAAG,SAAS,cAAc,KAAK,SAAS,YAAY,KAAK;GAC3F,cAAc,SAAS;GACvB,aAAa,SAAS;GACtB,WAAW,MAAM,OAAO;AACtB,QAAI,CAAC,IAAI,MAAM,CAAE,QAAO;AACxB,QAAI,CAAC,oBAAoB,KAAK,IAAI,CAChC,QAAO;;GAEZ,CAAC;AACF,MAAI,SAAS,QAAQ,CAAE,QAAO;AAC9B,SAAO,YAAY;GACjB,KAAM,QAAmB,MAAM;GAC/B,GAAI,SAAS,cAAc,EAAE,aAAa,SAAS,aAAa,GAAG,EAAE;GACtE;;AAGH,QAAO;EACL;EACU;EACV,aAAc,aAAwB,MAAM,IAAI;EAChD,aAAc,YAAuB,MAAM;EAC3C;EACA;EACD"}

package/dist/cli/commands/plugin/create/resource-defaults.js

@@ -0,0 +1,105 @@
+import { getResourceTypeOptions, getResourceTypePermissions } from "../schema-resources.js";
+
+//#region src/cli/commands/plugin/create/resource-defaults.ts
+/**
+* Resource type and permission defaults for plugin scaffolding.
+* Values are derived from plugin-manifest.schema.json via schema-resources.
+*/
+const MANIFEST_SCHEMA_ID = "https://databricks.github.io/appkit/schemas/plugin-manifest.schema.json";
+/** Resource types from schema resourceType enum (value, human label). */
+const RESOURCE_TYPE_OPTIONS = getResourceTypeOptions();
+/** All valid permissions per resource type, from schema allOf/if-then rules. */
+const PERMISSIONS_BY_TYPE = getResourceTypePermissions();
+/** Default (first) permission per resource type for scaffolding. */
+const DEFAULT_PERMISSION_BY_TYPE = Object.fromEntries(Object.entries(PERMISSIONS_BY_TYPE).map(([type, perms]) => [type, perms[0]]));
+/** Default fields per resource type: field key -> { env, description }. */
+const DEFAULT_FIELDS_BY_TYPE = {
+	sql_warehouse: { id: {
+		env: "DATABRICKS_WAREHOUSE_ID",
+		description: "SQL Warehouse ID"
+	} },
+	secret: {
+		scope: {
+			env: "SECRET_SCOPE",
+			description: "Secret scope name"
+		},
+		key: {
+			env: "SECRET_KEY",
+			description: "Secret key"
+		}
+	},
+	job: { id: {
+		env: "DATABRICKS_JOB_ID",
+		description: "Job ID"
+	} },
+	serving_endpoint: { id: {
+		env: "DATABRICKS_SERVING_ENDPOINT_ID",
+		description: "Serving endpoint ID"
+	} },
+	volume: { name: {
+		env: "VOLUME_NAME",
+		description: "Volume name"
+	} },
+	vector_search_index: {
+		endpoint_name: {
+			env: "VECTOR_SEARCH_ENDPOINT_NAME",
+			description: "Vector search endpoint name"
+		},
+		index_name: {
+			env: "VECTOR_SEARCH_INDEX_NAME",
+			description: "Vector search index name"
+		}
+	},
+	uc_function: { name: {
+		env: "UC_FUNCTION_NAME",
+		description: "Unity Catalog function name"
+	} },
+	uc_connection: { name: {
+		env: "UC_CONNECTION_NAME",
+		description: "Unity Catalog connection name"
+	} },
+	database: {
+		instance_name: {
+			env: "DATABRICKS_INSTANCE_NAME",
+			description: "Databricks instance name"
+		},
+		database_name: {
+			env: "DATABASE_NAME",
+			description: "Database name"
+		}
+	},
+	genie_space: { id: {
+		env: "GENIE_SPACE_ID",
+		description: "Genie Space ID"
+	} },
+	experiment: { id: {
+		env: "MLFLOW_EXPERIMENT_ID",
+		description: "MLflow experiment ID"
+	} },
+	app: { id: {
+		env: "DATABRICKS_APP_ID",
+		description: "Databricks App ID"
+	} }
+};
+/** Humanized alias from resource type (e.g. sql_warehouse -> "SQL Warehouse"). */
+function humanizeResourceType(type) {
+	const option = RESOURCE_TYPE_OPTIONS.find((o) => o.value === type);
+	return option ? option.label : type.replace(/_/g, " ");
+}
+/** Kebab-case resource key from type (e.g. sql_warehouse -> "sql-warehouse"). */
+function resourceKeyFromType(type) {
+	return type.replace(/_/g, "-");
+}
+/** Get default fields for a resource type; fallback to single id field. */
+function getDefaultFieldsForType(type) {
+	const known = DEFAULT_FIELDS_BY_TYPE[type];
+	if (known) return known;
+	return { id: {
+		env: `DATABRICKS_${resourceKeyFromType(type).toUpperCase().replace(/-/g, "_")}_ID`,
+		description: `${humanizeResourceType(type)} ID`
+	} };
+}
+
+//#endregion
+export { MANIFEST_SCHEMA_ID, PERMISSIONS_BY_TYPE, RESOURCE_TYPE_OPTIONS, getDefaultFieldsForType, humanizeResourceType, resourceKeyFromType };
+//# sourceMappingURL=resource-defaults.js.map

package/dist/cli/commands/plugin/create/resource-defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-defaults.js","names":[],"sources":["../../../../../src/cli/commands/plugin/create/resource-defaults.ts"],"sourcesContent":["/**\n * Resource type and permission defaults for plugin scaffolding.\n * Values are derived from plugin-manifest.schema.json via schema-resources.\n */\n\nimport {\n  getResourceTypeOptions,\n  getResourceTypePermissions,\n  type ResourceTypeOption,\n} from \"../schema-resources\";\n\nexport const MANIFEST_SCHEMA_ID =\n  \"https://databricks.github.io/appkit/schemas/plugin-manifest.schema.json\";\n\nexport type { ResourceTypeOption };\n\n/** Resource types from schema resourceType enum (value, human label). */\nexport const RESOURCE_TYPE_OPTIONS: ResourceTypeOption[] =\n  getResourceTypeOptions();\n\n/** All valid permissions per resource type, from schema allOf/if-then rules. */\nexport const PERMISSIONS_BY_TYPE: Record<string, string[]> =\n  getResourceTypePermissions();\n\n/** Default (first) permission per resource type for scaffolding. */\nexport const DEFAULT_PERMISSION_BY_TYPE: Record<string, string> =\n  Object.fromEntries(\n    Object.entries(PERMISSIONS_BY_TYPE).map(([type, perms]) => [\n      type,\n      perms[0],\n    ]),\n  );\n\n/** Default fields per resource type: field key -> { env, description }. */\nexport const DEFAULT_FIELDS_BY_TYPE: Record<\n  string,\n  Record<string, { env: string; description?: string }>\n> = {\n  sql_warehouse: {\n    id: { env: \"DATABRICKS_WAREHOUSE_ID\", description: \"SQL Warehouse ID\" },\n  },\n  secret: {\n    scope: { env: \"SECRET_SCOPE\", description: \"Secret scope name\" },\n    key: { env: \"SECRET_KEY\", description: \"Secret key\" },\n  },\n  job: {\n    id: { env: \"DATABRICKS_JOB_ID\", description: \"Job ID\" },\n  },\n  serving_endpoint: {\n    id: {\n      env: \"DATABRICKS_SERVING_ENDPOINT_ID\",\n      description: \"Serving endpoint ID\",\n    },\n  },\n  volume: {\n    name: { env: \"VOLUME_NAME\", description: \"Volume name\" },\n  },\n  vector_search_index: {\n    endpoint_name: {\n      env: \"VECTOR_SEARCH_ENDPOINT_NAME\",\n      description: \"Vector search endpoint name\",\n    },\n    index_name: {\n      env: \"VECTOR_SEARCH_INDEX_NAME\",\n      description: \"Vector search index name\",\n    },\n  },\n  uc_function: {\n    name: {\n      env: \"UC_FUNCTION_NAME\",\n      description: \"Unity Catalog function name\",\n    },\n  },\n  uc_connection: {\n    name: {\n      env: \"UC_CONNECTION_NAME\",\n      description: \"Unity Catalog connection name\",\n    },\n  },\n  database: {\n    instance_name: {\n      env: \"DATABRICKS_INSTANCE_NAME\",\n      description: \"Databricks instance name\",\n    },\n    database_name: {\n      env: \"DATABASE_NAME\",\n      description: \"Database name\",\n    },\n  },\n  genie_space: {\n    id: { env: \"GENIE_SPACE_ID\", description: \"Genie Space ID\" },\n  },\n  experiment: {\n    id: { env: \"MLFLOW_EXPERIMENT_ID\", description: \"MLflow experiment ID\" },\n  },\n  app: {\n    id: { env: \"DATABRICKS_APP_ID\", description: \"Databricks App ID\" },\n  },\n};\n\n/** Humanized alias from resource type (e.g. sql_warehouse -> \"SQL Warehouse\"). */\nexport function humanizeResourceType(type: string): string {\n  const option = RESOURCE_TYPE_OPTIONS.find((o) => o.value === type);\n  return option ? option.label : type.replace(/_/g, \" \");\n}\n\n/** Kebab-case resource key from type (e.g. sql_warehouse -> \"sql-warehouse\"). */\nexport function resourceKeyFromType(type: string): string {\n  return type.replace(/_/g, \"-\");\n}\n\n/** Get default fields for a resource type; fallback to single id field. */\nexport function getDefaultFieldsForType(\n  type: string,\n): Record<string, { env: string; description?: string }> {\n  const known = DEFAULT_FIELDS_BY_TYPE[type];\n  if (known) return known;\n  const key = resourceKeyFromType(type);\n  const envName = `DATABRICKS_${key.toUpperCase().replace(/-/g, \"_\")}_ID`;\n  return {\n    id: { env: envName, description: `${humanizeResourceType(type)} ID` },\n  };\n}\n"],"mappings":";;;;;;;AAWA,MAAa,qBACX;;AAKF,MAAa,wBACX,wBAAwB;;AAG1B,MAAa,sBACX,4BAA4B;;AAG9B,MAAa,6BACX,OAAO,YACL,OAAO,QAAQ,oBAAoB,CAAC,KAAK,CAAC,MAAM,WAAW,CACzD,MACA,MAAM,GACP,CAAC,CACH;;AAGH,MAAa,yBAGT;CACF,eAAe,EACb,IAAI;EAAE,KAAK;EAA2B,aAAa;EAAoB,EACxE;CACD,QAAQ;EACN,OAAO;GAAE,KAAK;GAAgB,aAAa;GAAqB;EAChE,KAAK;GAAE,KAAK;GAAc,aAAa;GAAc;EACtD;CACD,KAAK,EACH,IAAI;EAAE,KAAK;EAAqB,aAAa;EAAU,EACxD;CACD,kBAAkB,EAChB,IAAI;EACF,KAAK;EACL,aAAa;EACd,EACF;CACD,QAAQ,EACN,MAAM;EAAE,KAAK;EAAe,aAAa;EAAe,EACzD;CACD,qBAAqB;EACnB,eAAe;GACb,KAAK;GACL,aAAa;GACd;EACD,YAAY;GACV,KAAK;GACL,aAAa;GACd;EACF;CACD,aAAa,EACX,MAAM;EACJ,KAAK;EACL,aAAa;EACd,EACF;CACD,eAAe,EACb,MAAM;EACJ,KAAK;EACL,aAAa;EACd,EACF;CACD,UAAU;EACR,eAAe;GACb,KAAK;GACL,aAAa;GACd;EACD,eAAe;GACb,KAAK;GACL,aAAa;GACd;EACF;CACD,aAAa,EACX,IAAI;EAAE,KAAK;EAAkB,aAAa;EAAkB,EAC7D;CACD,YAAY,EACV,IAAI;EAAE,KAAK;EAAwB,aAAa;EAAwB,EACzE;CACD,KAAK,EACH,IAAI;EAAE,KAAK;EAAqB,aAAa;EAAqB,EACnE;CACF;;AAGD,SAAgB,qBAAqB,MAAsB;CACzD,MAAM,SAAS,sBAAsB,MAAM,MAAM,EAAE,UAAU,KAAK;AAClE,QAAO,SAAS,OAAO,QAAQ,KAAK,QAAQ,MAAM,IAAI;;;AAIxD,SAAgB,oBAAoB,MAAsB;AACxD,QAAO,KAAK,QAAQ,MAAM,IAAI;;;AAIhC,SAAgB,wBACd,MACuD;CACvD,MAAM,QAAQ,uBAAuB;AACrC,KAAI,MAAO,QAAO;AAGlB,QAAO,EACL,IAAI;EAAE,KAFQ,cADJ,oBAAoB,KAAK,CACH,aAAa,CAAC,QAAQ,MAAM,IAAI,CAAC;EAE7C,aAAa,GAAG,qBAAqB,KAAK,CAAC;EAAM,EACtE"}