@databricks/appkit 0.0.2

package/dist/type-generator/vite-plugin.js

@@ -0,0 +1,49 @@
+import path from "node:path";
+import { execSync } from "node:child_process";
+
+//#region src/type-generator/vite-plugin.ts
+/**
+* Vite plugin to generate types for AppKit queries.
+* Calls `npx appkit-generate-types` under the hood.
+* @param options - Options to override default values.
+* @returns Vite plugin to generate types for AppKit queries.
+*/
+function appKitTypesPlugin(options) {
+	let root;
+	let appRoot;
+	let outFile;
+	let watchFolders;
+	function generate() {
+		try {
+			execSync(`npx appkit-generate-types ${[appRoot, outFile].join(" ")}`, {
+				cwd: appRoot,
+				stdio: "inherit"
+			});
+		} catch (error) {
+			if (process.env.NODE_ENV === "production") throw error;
+			console.error("[AppKit] Error generating types:", error);
+		}
+	}
+	return {
+		name: "appkit-types",
+		configResolved(config) {
+			root = config.root;
+			appRoot = path.resolve(root, "..");
+			outFile = path.resolve(root, options?.outFile ?? "src/appKitTypes.d.ts");
+			watchFolders = (options?.watchFolders ?? ["../config/queries"]).map((folder) => path.resolve(root, folder));
+		},
+		buildStart() {
+			generate();
+		},
+		configureServer(server) {
+			server.watcher.add(watchFolders);
+			server.watcher.on("change", (changedFile) => {
+				if (watchFolders.some((folder) => changedFile.startsWith(folder)) && changedFile.endsWith(".sql")) generate();
+			});
+		}
+	};
+}
+
+//#endregion
+export { appKitTypesPlugin };
+//# sourceMappingURL=vite-plugin.js.map

package/dist/type-generator/vite-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite-plugin.js","names":["root: string","appRoot: string","outFile: string","watchFolders: string[]"],"sources":["../../src/type-generator/vite-plugin.ts"],"sourcesContent":["import { execSync } from \"node:child_process\";\nimport path from \"node:path\";\nimport type { Plugin } from \"vite\";\n\n/**\n * Options for the AppKit types plugin.\n */\ninterface AppKitTypesPluginOptions {\n  /* Path to the output d.ts file (relative to client folder). */\n  outFile?: string;\n  /** Folders to watch for changes. */\n  watchFolders?: string[];\n}\n\n/**\n * Vite plugin to generate types for AppKit queries.\n * Calls `npx appkit-generate-types` under the hood.\n * @param options - Options to override default values.\n * @returns Vite plugin to generate types for AppKit queries.\n */\nexport function appKitTypesPlugin(options?: AppKitTypesPluginOptions): Plugin {\n  let root: string;\n  let appRoot: string;\n  let outFile: string;\n  let watchFolders: string[];\n\n  function generate() {\n    try {\n      const args = [appRoot, outFile].join(\" \");\n      execSync(`npx appkit-generate-types ${args}`, {\n        cwd: appRoot,\n        stdio: \"inherit\",\n      });\n    } catch (error) {\n      // throw in production to fail the build\n      if (process.env.NODE_ENV === \"production\") {\n        throw error;\n      }\n      console.error(\"[AppKit] Error generating types:\", error);\n    }\n  }\n\n  return {\n    name: \"appkit-types\",\n    configResolved(config) {\n      root = config.root;\n      appRoot = path.resolve(root, \"..\");\n\n      outFile = path.resolve(root, options?.outFile ?? \"src/appKitTypes.d.ts\");\n\n      watchFolders = (options?.watchFolders ?? [\"../config/queries\"]).map(\n        (folder) => path.resolve(root, folder),\n      );\n    },\n    buildStart() {\n      generate();\n    },\n\n    configureServer(server) {\n      server.watcher.add(watchFolders);\n\n      server.watcher.on(\"change\", (changedFile) => {\n        const isWatchedFile = watchFolders.some((folder) =>\n          changedFile.startsWith(folder),\n        );\n\n        if (isWatchedFile && changedFile.endsWith(\".sql\")) {\n          generate();\n        }\n      });\n    },\n  };\n}\n"],"mappings":";;;;;;;;;;AAoBA,SAAgB,kBAAkB,SAA4C;CAC5E,IAAIA;CACJ,IAAIC;CACJ,IAAIC;CACJ,IAAIC;CAEJ,SAAS,WAAW;AAClB,MAAI;AAEF,YAAS,6BADI,CAAC,SAAS,QAAQ,CAAC,KAAK,IAAI,IACK;IAC5C,KAAK;IACL,OAAO;IACR,CAAC;WACK,OAAO;AAEd,OAAI,QAAQ,IAAI,aAAa,aAC3B,OAAM;AAER,WAAQ,MAAM,oCAAoC,MAAM;;;AAI5D,QAAO;EACL,MAAM;EACN,eAAe,QAAQ;AACrB,UAAO,OAAO;AACd,aAAU,KAAK,QAAQ,MAAM,KAAK;AAElC,aAAU,KAAK,QAAQ,MAAM,SAAS,WAAW,uBAAuB;AAExE,mBAAgB,SAAS,gBAAgB,CAAC,oBAAoB,EAAE,KAC7D,WAAW,KAAK,QAAQ,MAAM,OAAO,CACvC;;EAEH,aAAa;AACX,aAAU;;EAGZ,gBAAgB,QAAQ;AACtB,UAAO,QAAQ,IAAI,aAAa;AAEhC,UAAO,QAAQ,GAAG,WAAW,gBAAgB;AAK3C,QAJsB,aAAa,MAAM,WACvC,YAAY,WAAW,OAAO,CAC/B,IAEoB,YAAY,SAAS,OAAO,CAC/C,WAAU;KAEZ;;EAEL"}

package/dist/utils/databricks-client-middleware.d.ts

@@ -0,0 +1,17 @@
+import { WorkspaceClient } from "@databricks/sdk-experimental";
+import express from "express";
+
+//#region src/utils/databricks-client-middleware.d.ts
+type RequestContext = {
+  userDatabricksClient?: WorkspaceClient;
+  serviceDatabricksClient: WorkspaceClient;
+  userId: string;
+  userName?: string;
+  serviceUserId: string;
+  warehouseId: Promise<string>;
+  workspaceId: Promise<string>;
+};
+declare function getRequestContext(): RequestContext;
+//#endregion
+export { getRequestContext };
+//# sourceMappingURL=databricks-client-middleware.d.ts.map

package/dist/utils/databricks-client-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"databricks-client-middleware.d.ts","names":[],"sources":["../../src/utils/databricks-client-middleware.ts"],"sourcesContent":[],"mappings":";;;;KAYY,cAAA;yBACa;EADb,uBAAc,EAEC,eAFD;EAAA,MAAA,EAAA,MAAA;UACD,CAAA,EAAA,MAAA;eACE,EAAA,MAAA;aAIZ,EAAA,OAAA,CAAA,MAAA,CAAA;aACA,EAAA,OAAA,CAAA,MAAA,CAAA;CAAO;iBA4EN,iBAAA,CAAA,GAAqB"}

package/dist/utils/databricks-client-middleware.js

@@ -0,0 +1,117 @@
+import { __esmMin } from "../_virtual/rolldown_runtime.js";
+import { name, version } from "../appkit/package.js";
+import { WorkspaceClient } from "@databricks/sdk-experimental";
+import { AsyncLocalStorage } from "node:async_hooks";
+
+//#region src/utils/databricks-client-middleware.ts
+function getClientOptions() {
+	const isDev = process.env.NODE_ENV === "development";
+	return {
+		product: name,
+		productVersion: version.split(".").slice(0, 3).join("."),
+		...isDev && { userAgentExtra: { mode: "dev" } }
+	};
+}
+async function databricksClientMiddleware() {
+	const serviceDatabricksClient = new WorkspaceClient({}, getClientOptions());
+	const warehouseId = getWarehouseId(serviceDatabricksClient);
+	const workspaceId = getWorkspaceId(serviceDatabricksClient);
+	const serviceUserId = (await serviceDatabricksClient.currentUser.me()).id;
+	if (!serviceUserId) throw new Error("Service user ID not found");
+	return async (req, res, next) => {
+		const userToken = req.headers["x-forwarded-access-token"];
+		let userDatabricksClient;
+		const host = process.env.DATABRICKS_HOST;
+		if (userToken && host) userDatabricksClient = new WorkspaceClient({
+			token: userToken,
+			host,
+			authType: "pat"
+		}, getClientOptions());
+		else if (process.env.NODE_ENV === "development") userDatabricksClient = serviceDatabricksClient;
+		let userName = req.headers["x-forwarded-user"];
+		if (!userName && process.env.NODE_ENV !== "development") {
+			res.status(401).json({ error: "Unauthorized" });
+			return;
+		} else userName = serviceUserId;
+		return asyncLocalStorage.run({
+			userDatabricksClient,
+			serviceDatabricksClient,
+			warehouseId,
+			workspaceId,
+			userId: userName,
+			serviceUserId
+		}, async () => {
+			return next();
+		});
+	};
+}
+function getRequestContext() {
+	const store = asyncLocalStorage.getStore();
+	if (!store) throw new Error("Request context not found");
+	return store;
+}
+/**
+* Get the appropriate WorkspaceClient based on whether the request
+* should be executed as the user or as the service principal.
+*
+* @param asUser - If true, returns user's WorkspaceClient (requires token passthrough)
+* @throws Error if asUser is true but user token passthrough is not enabled
+*/
+function getWorkspaceClient(asUser) {
+	const context = getRequestContext();
+	if (asUser) {
+		if (!context.userDatabricksClient) throw new Error(`User token passthrough is not enabled for this workspace.`);
+		return context.userDatabricksClient;
+	}
+	return context.serviceDatabricksClient;
+}
+async function getWorkspaceId(workspaceClient) {
+	if (process.env.DATABRICKS_WORKSPACE_ID) return process.env.DATABRICKS_WORKSPACE_ID;
+	const response = await workspaceClient.apiClient.request({
+		path: "/api/2.0/preview/scim/v2/Me",
+		method: "GET",
+		headers: new Headers(),
+		raw: false,
+		query: {},
+		responseHeaders: ["x-databricks-org-id"]
+	});
+	if (!response["x-databricks-org-id"]) throw new Error("Workspace ID not found");
+	return response["x-databricks-org-id"];
+}
+async function getWarehouseId(workspaceClient) {
+	if (process.env.DATABRICKS_WAREHOUSE_ID) return process.env.DATABRICKS_WAREHOUSE_ID;
+	if (process.env.NODE_ENV === "development") {
+		const response = await workspaceClient.apiClient.request({
+			path: "/api/2.0/sql/warehouses",
+			method: "GET",
+			headers: new Headers(),
+			raw: false,
+			query: { skip_cannot_use: "true" }
+		});
+		const priorities = {
+			RUNNING: 0,
+			STOPPED: 1,
+			STARTING: 2,
+			STOPPING: 3,
+			DELETED: 99,
+			DELETING: 99
+		};
+		const warehouses = (response.warehouses || []).sort((a, b) => {
+			return priorities[a.state] - priorities[b.state];
+		});
+		if (response.warehouses.length === 0) throw new Error("Warehouse ID not found. Please configure the DATABRICKS_WAREHOUSE_ID environment variable.");
+		const firstWarehouse = warehouses[0];
+		if (firstWarehouse.state === "DELETED" || firstWarehouse.state === "DELETING" || !firstWarehouse.id) throw new Error("Warehouse ID not found. Please configure the DATABRICKS_WAREHOUSE_ID environment variable.");
+		return firstWarehouse.id;
+	}
+	throw new Error("Warehouse ID not found. Please configure the DATABRICKS_WAREHOUSE_ID environment variable.");
+}
+var asyncLocalStorage;
+var init_databricks_client_middleware = __esmMin((() => {
+	asyncLocalStorage = new AsyncLocalStorage();
+}));
+
+//#endregion
+init_databricks_client_middleware();
+export { databricksClientMiddleware, getRequestContext, getWorkspaceClient, init_databricks_client_middleware };
+//# sourceMappingURL=databricks-client-middleware.js.map

package/dist/utils/databricks-client-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"databricks-client-middleware.js","names":["productName","productVersion","userDatabricksClient: WorkspaceClient | undefined","priorities: Record<sql.State, number>"],"sources":["../../src/utils/databricks-client-middleware.ts"],"sourcesContent":["import { AsyncLocalStorage } from \"node:async_hooks\";\nimport {\n  type ClientOptions,\n  type sql,\n  WorkspaceClient,\n} from \"@databricks/sdk-experimental\";\nimport type express from \"express\";\nimport {\n  name as productName,\n  version as productVersion,\n} from \"../../package.json\";\n\nexport type RequestContext = {\n  userDatabricksClient?: WorkspaceClient;\n  serviceDatabricksClient: WorkspaceClient;\n  userId: string;\n  userName?: string;\n  serviceUserId: string;\n  warehouseId: Promise<string>;\n  workspaceId: Promise<string>;\n};\n\nconst asyncLocalStorage = new AsyncLocalStorage<RequestContext>();\n\nfunction getClientOptions(): ClientOptions {\n  const isDev = process.env.NODE_ENV === \"development\";\n  const normalizedVersion = productVersion\n    .split(\".\")\n    .slice(0, 3)\n    .join(\".\") as ClientOptions[\"productVersion\"];\n\n  return {\n    product: productName,\n    productVersion: normalizedVersion,\n    ...(isDev && { userAgentExtra: { mode: \"dev\" } }),\n  };\n}\n\nexport async function databricksClientMiddleware(): Promise<express.RequestHandler> {\n  const serviceDatabricksClient = new WorkspaceClient({}, getClientOptions());\n  const warehouseId = getWarehouseId(serviceDatabricksClient);\n  const workspaceId = getWorkspaceId(serviceDatabricksClient);\n  const serviceUserId = (await serviceDatabricksClient.currentUser.me()).id;\n\n  if (!serviceUserId) {\n    throw new Error(\"Service user ID not found\");\n  }\n\n  return async (\n    req: express.Request,\n    res: express.Response,\n    next: express.NextFunction,\n  ) => {\n    const userToken = req.headers[\"x-forwarded-access-token\"] as string;\n    let userDatabricksClient: WorkspaceClient | undefined;\n    const host = process.env.DATABRICKS_HOST;\n    if (userToken && host) {\n      userDatabricksClient = new WorkspaceClient(\n        {\n          token: userToken,\n          host,\n          authType: \"pat\",\n        },\n        getClientOptions(),\n      );\n    } else if (process.env.NODE_ENV === \"development\") {\n      // in local development service and no user token are the same\n      // TODO: use `databricks apps run-local` to fix this\n      userDatabricksClient = serviceDatabricksClient;\n    }\n\n    let userName = req.headers[\"x-forwarded-user\"] as string;\n    if (!userName && process.env.NODE_ENV !== \"development\") {\n      res.status(401).json({ error: \"Unauthorized\" });\n      return;\n    } else {\n      userName = serviceUserId;\n    }\n\n    return asyncLocalStorage.run(\n      {\n        userDatabricksClient,\n        serviceDatabricksClient,\n        warehouseId,\n        workspaceId,\n        userId: userName,\n        serviceUserId,\n      },\n      async () => {\n        return next();\n      },\n    );\n  };\n}\n\nexport function getRequestContext(): RequestContext {\n  const store = asyncLocalStorage.getStore();\n  if (!store) {\n    throw new Error(\"Request context not found\");\n  }\n  return store;\n}\n\n/**\n * Get the appropriate WorkspaceClient based on whether the request\n * should be executed as the user or as the service principal.\n *\n * @param asUser - If true, returns user's WorkspaceClient (requires token passthrough)\n * @throws Error if asUser is true but user token passthrough is not enabled\n */\nexport function getWorkspaceClient(asUser: boolean): WorkspaceClient {\n  const context = getRequestContext();\n\n  if (asUser) {\n    if (!context.userDatabricksClient) {\n      throw new Error(\n        `User token passthrough is not enabled for this workspace.`,\n      );\n    }\n    return context.userDatabricksClient;\n  }\n\n  return context.serviceDatabricksClient;\n}\n\nasync function getWorkspaceId(\n  workspaceClient: WorkspaceClient,\n): Promise<string> {\n  if (process.env.DATABRICKS_WORKSPACE_ID) {\n    return process.env.DATABRICKS_WORKSPACE_ID;\n  }\n\n  const response = (await workspaceClient.apiClient.request({\n    path: \"/api/2.0/preview/scim/v2/Me\",\n    method: \"GET\",\n    headers: new Headers(),\n    raw: false,\n    query: {},\n    responseHeaders: [\"x-databricks-org-id\"],\n  })) as { \"x-databricks-org-id\": string };\n\n  if (!response[\"x-databricks-org-id\"]) {\n    throw new Error(\"Workspace ID not found\");\n  }\n\n  return response[\"x-databricks-org-id\"];\n}\n\nasync function getWarehouseId(\n  workspaceClient: WorkspaceClient,\n): Promise<string> {\n  if (process.env.DATABRICKS_WAREHOUSE_ID) {\n    return process.env.DATABRICKS_WAREHOUSE_ID;\n  }\n\n  if (process.env.NODE_ENV === \"development\") {\n    const response = (await workspaceClient.apiClient.request({\n      path: \"/api/2.0/sql/warehouses\",\n      method: \"GET\",\n      headers: new Headers(),\n      raw: false,\n      query: {\n        skip_cannot_use: \"true\",\n      },\n    })) as { warehouses: sql.EndpointInfo[] };\n\n    const priorities: Record<sql.State, number> = {\n      RUNNING: 0,\n      STOPPED: 1,\n      STARTING: 2,\n      STOPPING: 3,\n      DELETED: 99,\n      DELETING: 99,\n    };\n\n    const warehouses = (response.warehouses || []).sort((a, b) => {\n      return (\n        priorities[a.state as sql.State] - priorities[b.state as sql.State]\n      );\n    });\n\n    if (response.warehouses.length === 0) {\n      throw new Error(\n        \"Warehouse ID not found. Please configure the DATABRICKS_WAREHOUSE_ID environment variable.\",\n      );\n    }\n\n    const firstWarehouse = warehouses[0];\n    if (\n      firstWarehouse.state === \"DELETED\" ||\n      firstWarehouse.state === \"DELETING\" ||\n      !firstWarehouse.id\n    ) {\n      throw new Error(\n        \"Warehouse ID not found. Please configure the DATABRICKS_WAREHOUSE_ID environment variable.\",\n      );\n    }\n\n    return firstWarehouse.id;\n  }\n\n  throw new Error(\n    \"Warehouse ID not found. Please configure the DATABRICKS_WAREHOUSE_ID environment variable.\",\n  );\n}\n\nexport type Request = express.Request;\nexport type Response = express.Response;\n"],"mappings":";;;;;;AAwBA,SAAS,mBAAkC;CACzC,MAAM,QAAQ,QAAQ,IAAI,aAAa;AAMvC,QAAO;EACL,SAASA;EACT,gBAPwBC,QACvB,MAAM,IAAI,CACV,MAAM,GAAG,EAAE,CACX,KAAK,IAAI;EAKV,GAAI,SAAS,EAAE,gBAAgB,EAAE,MAAM,OAAO,EAAE;EACjD;;AAGH,eAAsB,6BAA8D;CAClF,MAAM,0BAA0B,IAAI,gBAAgB,EAAE,EAAE,kBAAkB,CAAC;CAC3E,MAAM,cAAc,eAAe,wBAAwB;CAC3D,MAAM,cAAc,eAAe,wBAAwB;CAC3D,MAAM,iBAAiB,MAAM,wBAAwB,YAAY,IAAI,EAAE;AAEvE,KAAI,CAAC,cACH,OAAM,IAAI,MAAM,4BAA4B;AAG9C,QAAO,OACL,KACA,KACA,SACG;EACH,MAAM,YAAY,IAAI,QAAQ;EAC9B,IAAIC;EACJ,MAAM,OAAO,QAAQ,IAAI;AACzB,MAAI,aAAa,KACf,wBAAuB,IAAI,gBACzB;GACE,OAAO;GACP;GACA,UAAU;GACX,EACD,kBAAkB,CACnB;WACQ,QAAQ,IAAI,aAAa,cAGlC,wBAAuB;EAGzB,IAAI,WAAW,IAAI,QAAQ;AAC3B,MAAI,CAAC,YAAY,QAAQ,IAAI,aAAa,eAAe;AACvD,OAAI,OAAO,IAAI,CAAC,KAAK,EAAE,OAAO,gBAAgB,CAAC;AAC/C;QAEA,YAAW;AAGb,SAAO,kBAAkB,IACvB;GACE;GACA;GACA;GACA;GACA,QAAQ;GACR;GACD,EACD,YAAY;AACV,UAAO,MAAM;IAEhB;;;AAIL,SAAgB,oBAAoC;CAClD,MAAM,QAAQ,kBAAkB,UAAU;AAC1C,KAAI,CAAC,MACH,OAAM,IAAI,MAAM,4BAA4B;AAE9C,QAAO;;;;;;;;;AAUT,SAAgB,mBAAmB,QAAkC;CACnE,MAAM,UAAU,mBAAmB;AAEnC,KAAI,QAAQ;AACV,MAAI,CAAC,QAAQ,qBACX,OAAM,IAAI,MACR,4DACD;AAEH,SAAO,QAAQ;;AAGjB,QAAO,QAAQ;;AAGjB,eAAe,eACb,iBACiB;AACjB,KAAI,QAAQ,IAAI,wBACd,QAAO,QAAQ,IAAI;CAGrB,MAAM,WAAY,MAAM,gBAAgB,UAAU,QAAQ;EACxD,MAAM;EACN,QAAQ;EACR,SAAS,IAAI,SAAS;EACtB,KAAK;EACL,OAAO,EAAE;EACT,iBAAiB,CAAC,sBAAsB;EACzC,CAAC;AAEF,KAAI,CAAC,SAAS,uBACZ,OAAM,IAAI,MAAM,yBAAyB;AAG3C,QAAO,SAAS;;AAGlB,eAAe,eACb,iBACiB;AACjB,KAAI,QAAQ,IAAI,wBACd,QAAO,QAAQ,IAAI;AAGrB,KAAI,QAAQ,IAAI,aAAa,eAAe;EAC1C,MAAM,WAAY,MAAM,gBAAgB,UAAU,QAAQ;GACxD,MAAM;GACN,QAAQ;GACR,SAAS,IAAI,SAAS;GACtB,KAAK;GACL,OAAO,EACL,iBAAiB,QAClB;GACF,CAAC;EAEF,MAAMC,aAAwC;GAC5C,SAAS;GACT,SAAS;GACT,UAAU;GACV,UAAU;GACV,SAAS;GACT,UAAU;GACX;EAED,MAAM,cAAc,SAAS,cAAc,EAAE,EAAE,MAAM,GAAG,MAAM;AAC5D,UACE,WAAW,EAAE,SAAsB,WAAW,EAAE;IAElD;AAEF,MAAI,SAAS,WAAW,WAAW,EACjC,OAAM,IAAI,MACR,6FACD;EAGH,MAAM,iBAAiB,WAAW;AAClC,MACE,eAAe,UAAU,aACzB,eAAe,UAAU,cACzB,CAAC,eAAe,GAEhB,OAAM,IAAI,MACR,6FACD;AAGH,SAAO,eAAe;;AAGxB,OAAM,IAAI,MACR,6FACD;;;;CArLG,oBAAoB,IAAI,mBAAmC"}

package/dist/utils/env-validator.js

@@ -0,0 +1,14 @@
+import { __esmMin } from "../_virtual/rolldown_runtime.js";
+
+//#region src/utils/env-validator.ts
+function validateEnv(envVars) {
+	const missingVars = [];
+	for (const envVar of envVars) if (!process.env[envVar]) missingVars.push(envVar);
+	if (missingVars.length > 0) throw new Error(`Missing required environment variables: ${missingVars.join(", ")}`);
+}
+var init_env_validator = __esmMin((() => {}));
+
+//#endregion
+init_env_validator();
+export { init_env_validator, validateEnv };
+//# sourceMappingURL=env-validator.js.map

package/dist/utils/env-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-validator.js","names":[],"sources":["../../src/utils/env-validator.ts"],"sourcesContent":["export function validateEnv(envVars: string[]) {\n  const missingVars = [];\n\n  for (const envVar of envVars) {\n    if (!process.env[envVar]) {\n      missingVars.push(envVar);\n    }\n  }\n\n  if (missingVars.length > 0) {\n    throw new Error(\n      `Missing required environment variables: ${missingVars.join(\", \")}`,\n    );\n  }\n}\n"],"mappings":";;;AAAA,SAAgB,YAAY,SAAmB;CAC7C,MAAM,cAAc,EAAE;AAEtB,MAAK,MAAM,UAAU,QACnB,KAAI,CAAC,QAAQ,IAAI,QACf,aAAY,KAAK,OAAO;AAI5B,KAAI,YAAY,SAAS,EACvB,OAAM,IAAI,MACR,2CAA2C,YAAY,KAAK,KAAK,GAClE"}

package/dist/utils/index.js

@@ -0,0 +1,26 @@
+import { __esmMin, __export } from "../_virtual/rolldown_runtime.js";
+import { databricksClientMiddleware, getRequestContext, getWorkspaceClient, init_databricks_client_middleware } from "./databricks-client-middleware.js";
+import { init_env_validator, validateEnv } from "./env-validator.js";
+import { deepMerge, init_merge } from "./merge.js";
+import { init_vite_config_merge, mergeConfigDedup } from "./vite-config-merge.js";
+
+//#region src/utils/index.ts
+var utils_exports = /* @__PURE__ */ __export({
+	databricksClientMiddleware: () => databricksClientMiddleware,
+	deepMerge: () => deepMerge,
+	getRequestContext: () => getRequestContext,
+	getWorkspaceClient: () => getWorkspaceClient,
+	mergeConfigDedup: () => mergeConfigDedup,
+	validateEnv: () => validateEnv
+});
+var init_utils = __esmMin((() => {
+	init_databricks_client_middleware();
+	init_env_validator();
+	init_merge();
+	init_vite_config_merge();
+}));
+
+//#endregion
+init_utils();
+export { init_utils, utils_exports };
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/utils/index.ts"],"sourcesContent":["export * from \"./databricks-client-middleware\";\nexport * from \"./env-validator\";\nexport * from \"./merge\";\nexport * from \"./vite-config-merge\";\n"],"mappings":""}

package/dist/utils/merge.js

@@ -0,0 +1,25 @@
+import { __esmMin } from "../_virtual/rolldown_runtime.js";
+
+//#region src/utils/merge.ts
+function deepMerge(target, ...sources) {
+	if (!sources.length) return target;
+	const source = sources.shift();
+	if (!source) return deepMerge(target, ...sources);
+	const result = { ...target };
+	for (const key in source) {
+		const sourceValue = source[key];
+		const targetValue = result[key];
+		if (sourceValue !== void 0) if (isObject(sourceValue) && isObject(targetValue)) result[key] = deepMerge(targetValue, sourceValue);
+		else result[key] = sourceValue;
+	}
+	return sources.length ? deepMerge(result, ...sources) : result;
+}
+function isObject(item) {
+	return typeof item === "object" && item !== null && !Array.isArray(item);
+}
+var init_merge = __esmMin((() => {}));
+
+//#endregion
+init_merge();
+export { deepMerge, init_merge };
+//# sourceMappingURL=merge.js.map

package/dist/utils/merge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.js","names":[],"sources":["../../src/utils/merge.ts"],"sourcesContent":["export function deepMerge<T extends Record<string, unknown>>(\n  target: T,\n  ...sources: Array<Partial<T> | undefined>\n): T {\n  if (!sources.length) return target;\n\n  const source = sources.shift();\n  if (!source) return deepMerge(target, ...sources);\n\n  const result = { ...target };\n\n  for (const key in source) {\n    const sourceValue = source[key];\n    const targetValue = result[key];\n\n    if (sourceValue !== undefined) {\n      if (isObject(sourceValue) && isObject(targetValue)) {\n        result[key] = deepMerge(\n          targetValue as Record<string, unknown>,\n          sourceValue as Record<string, unknown>,\n        ) as T[Extract<keyof T, string>];\n      } else {\n        result[key] = sourceValue as T[Extract<keyof T, string>];\n      }\n    }\n  }\n\n  return sources.length ? deepMerge(result, ...sources) : result;\n}\n\nfunction isObject(item: unknown): item is Record<string, unknown> {\n  return typeof item === \"object\" && item !== null && !Array.isArray(item);\n}\n"],"mappings":";;;AAAA,SAAgB,UACd,QACA,GAAG,SACA;AACH,KAAI,CAAC,QAAQ,OAAQ,QAAO;CAE5B,MAAM,SAAS,QAAQ,OAAO;AAC9B,KAAI,CAAC,OAAQ,QAAO,UAAU,QAAQ,GAAG,QAAQ;CAEjD,MAAM,SAAS,EAAE,GAAG,QAAQ;AAE5B,MAAK,MAAM,OAAO,QAAQ;EACxB,MAAM,cAAc,OAAO;EAC3B,MAAM,cAAc,OAAO;AAE3B,MAAI,gBAAgB,OAClB,KAAI,SAAS,YAAY,IAAI,SAAS,YAAY,CAChD,QAAO,OAAO,UACZ,aACA,YACD;MAED,QAAO,OAAO;;AAKpB,QAAO,QAAQ,SAAS,UAAU,QAAQ,GAAG,QAAQ,GAAG;;AAG1D,SAAS,SAAS,MAAgD;AAChE,QAAO,OAAO,SAAS,YAAY,SAAS,QAAQ,CAAC,MAAM,QAAQ,KAAK"}

package/dist/utils/vite-config-merge.js

@@ -0,0 +1,22 @@
+import { __esmMin } from "../_virtual/rolldown_runtime.js";
+
+//#region src/utils/vite-config-merge.ts
+function mergeConfigDedup(base, override, mergeFn) {
+	const merged = mergeFn(base, override);
+	if (base.plugins && override.plugins) {
+		const seen = /* @__PURE__ */ new Set();
+		merged.plugins = [...base.plugins, ...override.plugins].filter((p) => {
+			const name = p.name;
+			if (seen.has(name)) return false;
+			seen.add(name);
+			return true;
+		});
+	}
+	return merged;
+}
+var init_vite_config_merge = __esmMin((() => {}));
+
+//#endregion
+init_vite_config_merge();
+export { init_vite_config_merge, mergeConfigDedup };
+//# sourceMappingURL=vite-config-merge.js.map

package/dist/utils/vite-config-merge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite-config-merge.js","names":[],"sources":["../../src/utils/vite-config-merge.ts"],"sourcesContent":["import type { Plugin } from \"vite\";\n\nexport function mergeConfigDedup(\n  base: any,\n  override: any,\n  mergeFn: (a: any, b: any) => any,\n) {\n  const merged = mergeFn(base, override);\n  if (base.plugins && override.plugins) {\n    const seen = new Set<string>();\n    merged.plugins = [...base.plugins, ...override.plugins].filter(\n      (p: Plugin) => {\n        const name = p.name;\n        if (seen.has(name)) return false;\n        seen.add(name);\n        return true;\n      },\n    );\n  }\n  return merged;\n}\n"],"mappings":";;;AAEA,SAAgB,iBACd,MACA,UACA,SACA;CACA,MAAM,SAAS,QAAQ,MAAM,SAAS;AACtC,KAAI,KAAK,WAAW,SAAS,SAAS;EACpC,MAAM,uBAAO,IAAI,KAAa;AAC9B,SAAO,UAAU,CAAC,GAAG,KAAK,SAAS,GAAG,SAAS,QAAQ,CAAC,QACrD,MAAc;GACb,MAAM,OAAO,EAAE;AACf,OAAI,KAAK,IAAI,KAAK,CAAE,QAAO;AAC3B,QAAK,IAAI,KAAK;AACd,UAAO;IAEV;;AAEH,QAAO"}

package/llms.txt

@@ -0,0 +1,193 @@
+# llms.txt — Guidance for AI systems using the Databricks AppKit (@databricks/appkit)
+
+Project: Databricks AppKit
+Author: Databricks
+Version: 1.0.0
+
+# =====================
+# General Description
+# =====================
+AppKit is a modular TypeScript SDK for building apps with workflows and plugins.
+It provides a single entrypoint (createApp) where you configure and register plugins.
+Each plugin is then available under AppKit[pluginName].
+
+Main concepts:
+- createApp(config): initializes the SDK with plugins
+- Plugins: extend AppKit with functionality (server, analytics, ai, etc.)
+- AppKit[pluginName]: exposes plugin API after initialization
+- New plugins can be created by extending the Plugin class.
+
+# =====================
+# Primary Usage Pattern
+# =====================
+Always use async/await.
+Always initialize AppKit before using plugins.
+Server and plugins already initialized, no custom endpoints.
+
+Example:
+
+```ts
+import { createApp, server, analytics } from "@databricks/appkit";
+
+await createApp({
+  plugins: [
+    server({ port: 8000 }),
+    analytics(),
+  ],
+});
+```
+
+# ==============================================
+# Basic Usage Pattern starting the server
+# ==============================================
+
+Example:
+
+```ts
+import { createApp, server, analytics } from "@databricks/appkit";
+
+const AppKit = await createApp({
+  plugins: [
+    server({ port: 8000, autoStart: false }),
+    analytics(),
+  ],
+});
+
+const app = await AppKit.server.start();
+app.get("/ping", (req, res) => res.send("pong"));
+```
+
+# =====================
+# Plugin APIs
+# =====================
+
+Each plugin exposes a set of endpoints by default.
+
+## Server Plugin
+- AppKit.server.start(): Promise<Express.Application>
+- Purpose: Start an Express server with configured port, only use if { autoStart: false } is provided in the config of the server plugin
+- Usage: Add routes via the returned app
+- Config - When setting the plugin, the following options can be provided:
+  server({
+    port?: number;
+    staticPath?: string; // This provides the path where the frontend assets are.
+    autoStart?: boolean;
+  })
+
+## Analytics Plugin
+- AppKit.analytics.query.executeQuery({ query, parameters }: { query: string; parameters?: Record<string, any> }, options?: ExecuteOptions): Promise<ExecuteStatementOutput>;
+- Purpose: Provide SQL by key interface.
+- Usage: Only for structured query + insert examples. SQL never goes into the call to the function. Any SQL that needs to be written,
+  will be written into config/queries/<query_key>.sql. All queries should be parameterized (use placeholders).
+- Default endpoints:
+  - POST /api/analytics/:query_key -> `query_key` will be the key to the file that contains the query. Expects a body with the shape { parameters?: Record<string, any>; }. parameters will be bound into the query.
+
+# =====================
+# Custom Plugins
+# =====================
+
+Databricks AppKit Might not cover all the cases needed, so for those cases a plugin can be created.
+Here is an example:
+
+```ts
+import { Plugin, toPlugin } from '@databricks/appkit';
+
+class OpenWeatherPlugin extends Plugin {
+  name: string = "open-weather";
+  private apiKey: string;
+  private url: string;
+
+  constructor(config: any, auth: IAuthManager, telemetry: ITelemetryManager) {
+    super(config, auth, telemetry);
+
+    this.apiKey = process.env.OPEN_WEATHER_API_KEY!;
+    this.url = process.env.OPEN_WEATHER_URL || "https://api.openweathermap.org/data/3.0/onecall";
+
+    // ...
+  }
+
+  async getWeather(lat: number, lon: number): Promise<any | null> {
+    const url = `${this.url}?lat=${lat}&lon=${lon}&appid=${this.apiKey}`;
+
+    try {
+      const response = await fetch(url);
+      if (!response.ok) {
+        console.error("Error fetching weather data:", response.statusText);
+        return null;
+      }
+
+      const data = await response.json();
+      return data;
+    } catch (error) {
+      console.error("Fetch error:", error);
+      return null;
+    }
+  }
+
+  /**
+   * Optionally the plugin can inject its own routes to the router
+   */
+  injectRoutes(router: express.Router) {
+    /**
+     * Each route is scoped to the plugin name. So in this case the route will be end up being
+     * /api/open-weather/weather
+     * 
+     * and an example request would be:
+     * GET /api/open-weather/weather?lat=40.7128&lon=-74.0060
+     */
+    router.get("/weather", async (req: any, res: any) => {
+      const { lat, lon } = req.query;
+      const data = await this.getWeather(lat, lon);
+      res.send(data);
+    });
+  }
+}
+
+export const openWeather = toPlugin<typeof OpenWeatherPlugin, OpenWeatherConfig, "openWeather">(OpenWeatherPlugin, "openWeather");
+```
+
+Then it would be used as the rest of the plugins
+
+```ts
+import { createApp, server, analytics } from "@databricks/appkit";
+import { openWeather } from './open-weather';
+
+const AppKit = await createApp({
+  plugins: [
+    server({ port: 8000 }),
+    analytics(),
+    openWeather(),
+  ],
+});
+
+const app = await AppKit.server.start();
+/**
+ * A route could also be added here
+ */
+app.get("/api/open-weather/weather", async (req, res) => {
+  const data = await AppKit.openWeather.getWeather(40.7128, -74.0060);
+  res.send(data);
+});
+```
+
+
+# =====================
+# Style Guidelines for AI
+# =====================
+- Always prefer async/await (never .then chaining in examples).
+- Always show explicit plugin config (no hidden defaults).
+- Use ESModules (import/export), not require().
+- Use TypeScript typings in advanced examples if helpful.
+
+# =====================
+# Anti-Patterns (avoid in examples)
+# =====================
+- ❌ Do not access AppKit internals (only use AppKit[pluginName]).
+- ❌ Do not assume SQL queries hit a real DB (they return demo data unless configured).
+- ❌ Do not show usage without createApp first.
+
+# =====================
+# Attribution
+# =====================
+If AI-generated code uses this SDK, attribute:
+"Powered by Databricks AppKit (https://github.com/...)".

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@databricks/appkit",
+  "type": "module",
+  "version": "0.0.2",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "packageManager": "pnpm@10.21.0",
+  "files": [
+    "dist",
+    "bin",
+    "scripts",
+    "CLAUDE.md",
+    "llms.txt",
+    "README.md",
+    "DCO",
+    "NOTICE.md"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "appkit-generate-types": "./bin/generate-types.ts",
+    "appkit-setup": "./bin/setup-claude.js"
+  },
+  "scripts": {
+    "build:package": "tsdown --config tsdown.config.ts",
+    "build:watch": "tsdown --config tsdown.config.ts --watch",
+    "clean:full": "rm -rf dist node_modules tmp",
+    "clean": "rm -rf dist tmp",
+    "dist": "tsx ../../tools/dist.ts",
+    "tarball": "tsx ../../tools/dist.ts && npm pack ./tmp --pack-destination ./tmp",
+    "typecheck": "tsc --noEmit",
+    "postinstall": "node scripts/postinstall.js"
+  },
+  "dependencies": {
+    "@databricks/sdk-experimental": "^0.15.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/api-logs": "^0.208.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.67.0",
+    "@opentelemetry/exporter-logs-otlp-proto": "^0.208.0",
+    "@opentelemetry/exporter-metrics-otlp-proto": "^0.208.0",
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.208.0",
+    "@opentelemetry/instrumentation": "^0.208.0",
+    "@opentelemetry/instrumentation-express": "^0.57.0",
+    "@opentelemetry/instrumentation-http": "^0.208.0",
+    "@opentelemetry/resources": "^2.2.0",
+    "@opentelemetry/sdk-logs": "^0.208.0",
+    "@opentelemetry/sdk-metrics": "^2.2.0",
+    "@opentelemetry/sdk-node": "^0.208.0",
+    "@opentelemetry/semantic-conventions": "^1.38.0",
+    "dotenv": "^16.6.1",
+    "express": "^4.22.0",
+    "pg": "^8.16.3",
+    "vite": "npm:rolldown-vite@7.1.14",
+    "ws": "^8.18.3",
+    "zod-to-ts": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.25",
+    "@types/pg": "^8.15.6",
+    "@types/ws": "^8.18.1",
+    "@vitejs/plugin-react": "^5.1.1"
+  },
+  "overrides": {
+    "vite": "npm:rolldown-vite@7.1.14"
+  },
+  "module": "./dist/index.js",
+  "publishConfig": {}
+}

package/scripts/postinstall.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+console.log("");
+console.log("[@databricks/appkit] To setup AI assistant instructions, run:");
+console.log("");
+console.log("  npx appkit-setup --write");
+console.log("");