@databricks/appkit-ui 0.2.0 → 0.4.0

package/NOTICE.md

@@ -55,12 +55,12 @@ This Software contains code from the following open source projects:
 | [class-variance-authority](https://www.npmjs.com/package/class-variance-authority) | 0.7.1 | Apache-2.0 | https://github.com/joe-bell/cva#readme |
 | [clsx](https://www.npmjs.com/package/clsx) | 2.1.1 | MIT | https://github.com/lukeed/clsx#readme |
 | [cmdk](https://www.npmjs.com/package/cmdk) | 1.1.1 | MIT | https://github.com/pacocoursey/cmdk#readme |
+| [commander](https://www.npmjs.com/package/commander) | 2.20.3, 5.1.0, 7.2.0, 8.3.0, 10.0.1, 12.1.0 | MIT | https://github.com/tj/commander.js#readme |
 | [date-fns](https://www.npmjs.com/package/date-fns) | 4.1.0 | MIT | https://github.com/date-fns/date-fns#readme |
 | [dotenv](https://www.npmjs.com/package/dotenv) | 16.6.1 | BSD-2-Clause | https://github.com/motdotla/dotenv#readme |
 | [echarts-for-react](https://www.npmjs.com/package/echarts-for-react) | 3.0.5 | MIT | https://github.com/hustcc/echarts-for-react |
 | [embla-carousel-react](https://www.npmjs.com/package/embla-carousel-react) | 8.6.0 | MIT | https://www.embla-carousel.com |
 | [express](https://www.npmjs.com/package/express) | 4.22.0 | MIT | http://expressjs.com/ |
-| [fast-glob](https://www.npmjs.com/package/fast-glob) | 3.3.3 | MIT | https://github.com/mrmlnc/fast-glob#readme |
 | [input-otp](https://www.npmjs.com/package/input-otp) | 1.4.2 | MIT | https://input-otp.rodz.dev/ |
 | [lucide-react](https://www.npmjs.com/package/lucide-react) | 0.554.0 | ISC | https://lucide.dev |
 | [next-themes](https://www.npmjs.com/package/next-themes) | 0.4.6 | MIT | https://github.com/pacocoursey/next-themes#readme |

package/bin/appkit.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import "../dist/cli/index.js";

package/dist/cli/commands/docs.js

@@ -0,0 +1,47 @@
+import fs from "node:fs";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import { Command } from "commander";
+
+//#region src/cli/commands/docs.ts
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+function findPackageRoot() {
+	let dir = __dirname;
+	while (dir !== path.parse(dir).root) {
+		if (fs.existsSync(path.join(dir, "package.json"))) return dir;
+		dir = path.dirname(dir);
+	}
+	throw new Error("Could not find package root");
+}
+function runDocs(docPath) {
+	const packageRoot = findPackageRoot();
+	if (!docPath) {
+		const llmsPath = path.join(packageRoot, "llms.txt");
+		if (!fs.existsSync(llmsPath)) {
+			console.error("Error: llms.txt not found in package");
+			process.exit(1);
+		}
+		const content = fs.readFileSync(llmsPath, "utf-8");
+		console.log(content);
+		return;
+	}
+	let normalizedPath = docPath;
+	normalizedPath = normalizedPath.replace(/^\.\//, "");
+	normalizedPath = normalizedPath.replace(/^\//, "");
+	normalizedPath = normalizedPath.replace(/^appkit\/docs\//, "");
+	normalizedPath = normalizedPath.replace(/^docs\//, "");
+	const fullPath = path.join(packageRoot, "docs", normalizedPath);
+	if (!fs.existsSync(fullPath)) {
+		console.error(`Error: Documentation file not found: ${docPath}`);
+		console.error(`Tried: ${fullPath}`);
+		process.exit(1);
+	}
+	const content = fs.readFileSync(fullPath, "utf-8");
+	console.log(content);
+}
+const docsCommand = new Command("docs").description("Display embedded documentation").argument("[path]", "Path to specific documentation file (e.g., /appkit/docs/api/appkit-ui/components/Sidebar.md)").action(runDocs);
+
+//#endregion
+export { docsCommand };
+//# sourceMappingURL=docs.js.map

package/dist/cli/commands/docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.js","names":[],"sources":["../../../src/cli/commands/docs.ts"],"sourcesContent":["import { Command } from \"commander\";\nimport fs from \"node:fs\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = path.dirname(__filename);\n\nfunction findPackageRoot(): string {\n  let dir = __dirname;\n  while (dir !== path.parse(dir).root) {\n    if (fs.existsSync(path.join(dir, \"package.json\"))) {\n      return dir;\n    }\n    dir = path.dirname(dir);\n  }\n  throw new Error(\"Could not find package root\");\n}\n\nfunction runDocs(docPath?: string) {\n  const packageRoot = findPackageRoot();\n\n  if (!docPath) {\n    // Display llms.txt by default\n    const llmsPath = path.join(packageRoot, \"llms.txt\");\n\n    if (!fs.existsSync(llmsPath)) {\n      console.error(\"Error: llms.txt not found in package\");\n      process.exit(1);\n    }\n\n    const content = fs.readFileSync(llmsPath, \"utf-8\");\n    console.log(content);\n    return;\n  }\n\n  // Handle path - remove leading ./ and / first, then strip prefixes\n  let normalizedPath = docPath;\n\n  // Strip leading ./ or /\n  normalizedPath = normalizedPath.replace(/^\\.\\//, \"\");\n  normalizedPath = normalizedPath.replace(/^\\//, \"\");\n\n  // Remove /appkit/docs/ or docs/ prefix since files are in packageRoot/docs/\n  normalizedPath = normalizedPath.replace(/^appkit\\/docs\\//, \"\");\n  normalizedPath = normalizedPath.replace(/^docs\\//, \"\");\n\n  const fullPath = path.join(packageRoot, \"docs\", normalizedPath);\n\n  if (!fs.existsSync(fullPath)) {\n    console.error(`Error: Documentation file not found: ${docPath}`);\n    console.error(`Tried: ${fullPath}`);\n    process.exit(1);\n  }\n\n  const content = fs.readFileSync(fullPath, \"utf-8\");\n  console.log(content);\n}\n\nexport const docsCommand = new Command(\"docs\")\n  .description(\"Display embedded documentation\")\n  .argument(\n    \"[path]\",\n    \"Path to specific documentation file (e.g., /appkit/docs/api/appkit-ui/components/Sidebar.md)\",\n  )\n  .action(runDocs);\n"],"mappings":";;;;;;AAKA,MAAM,aAAa,cAAc,OAAO,KAAK,IAAI;AACjD,MAAM,YAAY,KAAK,QAAQ,WAAW;AAE1C,SAAS,kBAA0B;CACjC,IAAI,MAAM;AACV,QAAO,QAAQ,KAAK,MAAM,IAAI,CAAC,MAAM;AACnC,MAAI,GAAG,WAAW,KAAK,KAAK,KAAK,eAAe,CAAC,CAC/C,QAAO;AAET,QAAM,KAAK,QAAQ,IAAI;;AAEzB,OAAM,IAAI,MAAM,8BAA8B;;AAGhD,SAAS,QAAQ,SAAkB;CACjC,MAAM,cAAc,iBAAiB;AAErC,KAAI,CAAC,SAAS;EAEZ,MAAM,WAAW,KAAK,KAAK,aAAa,WAAW;AAEnD,MAAI,CAAC,GAAG,WAAW,SAAS,EAAE;AAC5B,WAAQ,MAAM,uCAAuC;AACrD,WAAQ,KAAK,EAAE;;EAGjB,MAAM,UAAU,GAAG,aAAa,UAAU,QAAQ;AAClD,UAAQ,IAAI,QAAQ;AACpB;;CAIF,IAAI,iBAAiB;AAGrB,kBAAiB,eAAe,QAAQ,SAAS,GAAG;AACpD,kBAAiB,eAAe,QAAQ,OAAO,GAAG;AAGlD,kBAAiB,eAAe,QAAQ,mBAAmB,GAAG;AAC9D,kBAAiB,eAAe,QAAQ,WAAW,GAAG;CAEtD,MAAM,WAAW,KAAK,KAAK,aAAa,QAAQ,eAAe;AAE/D,KAAI,CAAC,GAAG,WAAW,SAAS,EAAE;AAC5B,UAAQ,MAAM,wCAAwC,UAAU;AAChE,UAAQ,MAAM,UAAU,WAAW;AACnC,UAAQ,KAAK,EAAE;;CAGjB,MAAM,UAAU,GAAG,aAAa,UAAU,QAAQ;AAClD,SAAQ,IAAI,QAAQ;;AAGtB,MAAa,cAAc,IAAI,QAAQ,OAAO,CAC3C,YAAY,iCAAiC,CAC7C,SACC,UACA,+FACD,CACA,OAAO,QAAQ"}

package/dist/cli/commands/generate-types.js

@@ -0,0 +1,38 @@
+import path from "node:path";
+import { Command } from "commander";
+
+//#region src/cli/commands/generate-types.ts
+/**
+* Generate types command implementation
+*/
+async function runGenerateTypes(rootDir, outFile, warehouseId, options) {
+	try {
+		const { generateFromEntryPoint } = await import("@databricks/appkit/type-generator");
+		const resolvedRootDir = rootDir || process.cwd();
+		const resolvedOutFile = outFile || path.join(process.cwd(), "client/src/appKitTypes.d.ts");
+		const queryFolder = path.join(resolvedRootDir, "config/queries");
+		const resolvedWarehouseId = warehouseId || process.env.DATABRICKS_WAREHOUSE_ID;
+		if (!resolvedWarehouseId) {
+			console.error("Error: DATABRICKS_WAREHOUSE_ID is not set. Please provide it as an argument or environment variable.");
+			process.exit(1);
+		}
+		await generateFromEntryPoint({
+			queryFolder,
+			outFile: resolvedOutFile,
+			warehouseId: resolvedWarehouseId,
+			noCache: options?.noCache || false
+		});
+	} catch (error) {
+		if (error instanceof Error && error.message.includes("Cannot find module")) {
+			console.error("Error: The 'generate-types' command is only available in @databricks/appkit.");
+			console.error("Please install @databricks/appkit to use this command.");
+			process.exit(1);
+		}
+		throw error;
+	}
+}
+const generateTypesCommand = new Command("generate-types").description("Generate TypeScript types from SQL queries").argument("[rootDir]", "Root directory of the project", process.cwd()).argument("[outFile]", "Output file path", path.join(process.cwd(), "client/src/appKitTypes.d.ts")).argument("[warehouseId]", "Databricks warehouse ID").option("--no-cache", "Disable caching for type generation").action(runGenerateTypes);
+
+//#endregion
+export { generateTypesCommand };
+//# sourceMappingURL=generate-types.js.map

package/dist/cli/commands/generate-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-types.js","names":[],"sources":["../../../src/cli/commands/generate-types.ts"],"sourcesContent":["import { Command } from \"commander\";\nimport path from \"node:path\";\n\n/**\n * Generate types command implementation\n */\nasync function runGenerateTypes(\n  rootDir?: string,\n  outFile?: string,\n  warehouseId?: string,\n  options?: { noCache?: boolean },\n) {\n  try {\n    // Try to import the type generator from @databricks/appkit\n    const { generateFromEntryPoint } = await import(\n      \"@databricks/appkit/type-generator\"\n    );\n\n    const resolvedRootDir = rootDir || process.cwd();\n    const resolvedOutFile =\n      outFile || path.join(process.cwd(), \"client/src/appKitTypes.d.ts\");\n\n    const queryFolder = path.join(resolvedRootDir, \"config/queries\");\n\n    const resolvedWarehouseId =\n      warehouseId || process.env.DATABRICKS_WAREHOUSE_ID;\n    if (!resolvedWarehouseId) {\n      console.error(\n        \"Error: DATABRICKS_WAREHOUSE_ID is not set. Please provide it as an argument or environment variable.\",\n      );\n      process.exit(1);\n    }\n\n    await generateFromEntryPoint({\n      queryFolder,\n      outFile: resolvedOutFile,\n      warehouseId: resolvedWarehouseId,\n      noCache: options?.noCache || false,\n    });\n  } catch (error) {\n    if (\n      error instanceof Error &&\n      error.message.includes(\"Cannot find module\")\n    ) {\n      console.error(\n        \"Error: The 'generate-types' command is only available in @databricks/appkit.\",\n      );\n      console.error(\"Please install @databricks/appkit to use this command.\");\n      process.exit(1);\n    }\n    throw error;\n  }\n}\n\nexport const generateTypesCommand = new Command(\"generate-types\")\n  .description(\"Generate TypeScript types from SQL queries\")\n  .argument(\"[rootDir]\", \"Root directory of the project\", process.cwd())\n  .argument(\n    \"[outFile]\",\n    \"Output file path\",\n    path.join(process.cwd(), \"client/src/appKitTypes.d.ts\"),\n  )\n  .argument(\"[warehouseId]\", \"Databricks warehouse ID\")\n  .option(\"--no-cache\", \"Disable caching for type generation\")\n  .action(runGenerateTypes);\n"],"mappings":";;;;;;;AAMA,eAAe,iBACb,SACA,SACA,aACA,SACA;AACA,KAAI;EAEF,MAAM,EAAE,2BAA2B,MAAM,OACvC;EAGF,MAAM,kBAAkB,WAAW,QAAQ,KAAK;EAChD,MAAM,kBACJ,WAAW,KAAK,KAAK,QAAQ,KAAK,EAAE,8BAA8B;EAEpE,MAAM,cAAc,KAAK,KAAK,iBAAiB,iBAAiB;EAEhE,MAAM,sBACJ,eAAe,QAAQ,IAAI;AAC7B,MAAI,CAAC,qBAAqB;AACxB,WAAQ,MACN,uGACD;AACD,WAAQ,KAAK,EAAE;;AAGjB,QAAM,uBAAuB;GAC3B;GACA,SAAS;GACT,aAAa;GACb,SAAS,SAAS,WAAW;GAC9B,CAAC;UACK,OAAO;AACd,MACE,iBAAiB,SACjB,MAAM,QAAQ,SAAS,qBAAqB,EAC5C;AACA,WAAQ,MACN,+EACD;AACD,WAAQ,MAAM,yDAAyD;AACvE,WAAQ,KAAK,EAAE;;AAEjB,QAAM;;;AAIV,MAAa,uBAAuB,IAAI,QAAQ,iBAAiB,CAC9D,YAAY,6CAA6C,CACzD,SAAS,aAAa,iCAAiC,QAAQ,KAAK,CAAC,CACrE,SACC,aACA,oBACA,KAAK,KAAK,QAAQ,KAAK,EAAE,8BAA8B,CACxD,CACA,SAAS,iBAAiB,0BAA0B,CACpD,OAAO,cAAc,sCAAsC,CAC3D,OAAO,iBAAiB"}

package/dist/cli/commands/lint.js

@@ -0,0 +1,104 @@
+import fs from "node:fs";
+import path from "node:path";
+import { Command } from "commander";
+import { Lang, parse } from "@ast-grep/napi";
+
+//#region src/cli/commands/lint.ts
+const rules = [
+	{
+		id: "no-double-type-assertion",
+		pattern: "$X as unknown as $Y",
+		message: "Avoid double type assertion (as unknown as). Use proper type guards or fix the source type."
+	},
+	{
+		id: "no-as-any",
+		pattern: "$X as any",
+		message: "Avoid \"as any\" type assertion. Use proper typing or unknown with type guards.",
+		includeTests: false
+	},
+	{
+		id: "no-array-index-key",
+		pattern: "key={$IDX}",
+		message: "Avoid using array index as React key. Use a stable unique identifier.",
+		filter: (code) => /key=\{(idx|index|i)\}/.test(code)
+	},
+	{
+		id: "no-parse-float-without-validation",
+		pattern: "parseFloat($X).toFixed($Y)",
+		message: "parseFloat can return NaN. Validate input or use toNumber() helper from shared/types.ts."
+	}
+];
+function isTestFile(filePath) {
+	return /\.(test|spec)\.(ts|tsx)$/.test(filePath) || filePath.includes("/tests/");
+}
+function findTsFiles(dir, files = []) {
+	const entries = fs.readdirSync(dir, { withFileTypes: true });
+	for (const entry of entries) {
+		const fullPath = path.join(dir, entry.name);
+		if (entry.isDirectory()) {
+			if ([
+				"node_modules",
+				"dist",
+				"build",
+				".git"
+			].includes(entry.name)) continue;
+			findTsFiles(fullPath, files);
+		} else if (entry.isFile() && /\.(ts|tsx)$/.test(entry.name)) files.push(fullPath);
+	}
+	return files;
+}
+function lintFile(filePath, rules) {
+	const violations = [];
+	const content = fs.readFileSync(filePath, "utf-8");
+	const lang = filePath.endsWith(".tsx") ? Lang.Tsx : Lang.TypeScript;
+	const testFile = isTestFile(filePath);
+	const root = parse(lang, content).root();
+	for (const rule of rules) {
+		if (testFile && rule.includeTests === false) continue;
+		const matches = root.findAll(rule.pattern);
+		for (const match of matches) {
+			const code = match.text();
+			if (rule.filter && !rule.filter(code)) continue;
+			const range = match.range();
+			violations.push({
+				file: filePath,
+				line: range.start.line + 1,
+				column: range.start.column + 1,
+				rule: rule.id,
+				message: rule.message,
+				code: code.length > 80 ? `${code.slice(0, 77)}...` : code
+			});
+		}
+	}
+	return violations;
+}
+/**
+* Lint command implementation
+*/
+function runLint() {
+	const rootDir = process.cwd();
+	const files = findTsFiles(rootDir);
+	console.log(`Scanning ${files.length} TypeScript files...\n`);
+	const allViolations = [];
+	for (const file of files) {
+		const violations = lintFile(file, rules);
+		allViolations.push(...violations);
+	}
+	if (allViolations.length === 0) {
+		console.log("No ast-grep lint violations found.");
+		process.exit(0);
+	}
+	console.log(`Found ${allViolations.length} violation(s):\n`);
+	for (const v of allViolations) {
+		const relPath = path.relative(rootDir, v.file);
+		console.log(`${relPath}:${v.line}:${v.column}`);
+		console.log(`  ${v.rule}: ${v.message}`);
+		console.log(`  > ${v.code}\n`);
+	}
+	process.exit(1);
+}
+const lintCommand = new Command("lint").description("Run AST-based linting on TypeScript files").action(runLint);
+
+//#endregion
+export { lintCommand };
+//# sourceMappingURL=lint.js.map

package/dist/cli/commands/lint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lint.js","names":[],"sources":["../../../src/cli/commands/lint.ts"],"sourcesContent":["import { Command } from \"commander\";\nimport { parse, Lang } from \"@ast-grep/napi\";\nimport fs from \"node:fs\";\nimport path from \"node:path\";\n\ninterface Rule {\n  id: string;\n  pattern: string;\n  message: string;\n  includeTests?: boolean;\n  filter?: (code: string) => boolean;\n}\n\nconst rules: Rule[] = [\n  {\n    id: \"no-double-type-assertion\",\n    pattern: \"$X as unknown as $Y\",\n    message:\n      \"Avoid double type assertion (as unknown as). Use proper type guards or fix the source type.\",\n  },\n  {\n    id: \"no-as-any\",\n    pattern: \"$X as any\",\n    message:\n      'Avoid \"as any\" type assertion. Use proper typing or unknown with type guards.',\n    includeTests: false, // acceptable in test mocks\n  },\n  {\n    id: \"no-array-index-key\",\n    pattern: \"key={$IDX}\",\n    message:\n      \"Avoid using array index as React key. Use a stable unique identifier.\",\n    filter: (code) => /key=\\{(idx|index|i)\\}/.test(code),\n  },\n  {\n    id: \"no-parse-float-without-validation\",\n    pattern: \"parseFloat($X).toFixed($Y)\",\n    message:\n      \"parseFloat can return NaN. Validate input or use toNumber() helper from shared/types.ts.\",\n  },\n];\n\nfunction isTestFile(filePath: string): boolean {\n  return (\n    /\\.(test|spec)\\.(ts|tsx)$/.test(filePath) || filePath.includes(\"/tests/\")\n  );\n}\n\nfunction findTsFiles(dir: string, files: string[] = []): string[] {\n  const entries = fs.readdirSync(dir, { withFileTypes: true });\n\n  for (const entry of entries) {\n    const fullPath = path.join(dir, entry.name);\n\n    if (entry.isDirectory()) {\n      if ([\"node_modules\", \"dist\", \"build\", \".git\"].includes(entry.name))\n        continue;\n      findTsFiles(fullPath, files);\n    } else if (entry.isFile() && /\\.(ts|tsx)$/.test(entry.name)) {\n      files.push(fullPath);\n    }\n  }\n\n  return files;\n}\n\ninterface Violation {\n  file: string;\n  line: number;\n  column: number;\n  rule: string;\n  message: string;\n  code: string;\n}\n\nfunction lintFile(filePath: string, rules: Rule[]): Violation[] {\n  const violations: Violation[] = [];\n  const content = fs.readFileSync(filePath, \"utf-8\");\n  const lang = filePath.endsWith(\".tsx\") ? Lang.Tsx : Lang.TypeScript;\n  const testFile = isTestFile(filePath);\n\n  const ast = parse(lang, content);\n  const root = ast.root();\n\n  for (const rule of rules) {\n    // skip rules that don't apply to test files\n    if (testFile && rule.includeTests === false) continue;\n\n    const matches = root.findAll(rule.pattern);\n\n    for (const match of matches) {\n      const code = match.text();\n\n      if (rule.filter && !rule.filter(code)) continue;\n\n      const range = match.range();\n      violations.push({\n        file: filePath,\n        line: range.start.line + 1,\n        column: range.start.column + 1,\n        rule: rule.id,\n        message: rule.message,\n        code: code.length > 80 ? `${code.slice(0, 77)}...` : code,\n      });\n    }\n  }\n\n  return violations;\n}\n\n/**\n * Lint command implementation\n */\nfunction runLint() {\n  const rootDir = process.cwd();\n  const files = findTsFiles(rootDir);\n\n  console.log(`Scanning ${files.length} TypeScript files...\\n`);\n\n  const allViolations: Violation[] = [];\n\n  for (const file of files) {\n    const violations = lintFile(file, rules);\n    allViolations.push(...violations);\n  }\n\n  if (allViolations.length === 0) {\n    console.log(\"No ast-grep lint violations found.\");\n    process.exit(0);\n  }\n\n  console.log(`Found ${allViolations.length} violation(s):\\n`);\n\n  for (const v of allViolations) {\n    const relPath = path.relative(rootDir, v.file);\n    console.log(`${relPath}:${v.line}:${v.column}`);\n    console.log(`  ${v.rule}: ${v.message}`);\n    console.log(`  > ${v.code}\\n`);\n  }\n\n  process.exit(1);\n}\n\nexport const lintCommand = new Command(\"lint\")\n  .description(\"Run AST-based linting on TypeScript files\")\n  .action(runLint);\n"],"mappings":";;;;;;AAaA,MAAM,QAAgB;CACpB;EACE,IAAI;EACJ,SAAS;EACT,SACE;EACH;CACD;EACE,IAAI;EACJ,SAAS;EACT,SACE;EACF,cAAc;EACf;CACD;EACE,IAAI;EACJ,SAAS;EACT,SACE;EACF,SAAS,SAAS,wBAAwB,KAAK,KAAK;EACrD;CACD;EACE,IAAI;EACJ,SAAS;EACT,SACE;EACH;CACF;AAED,SAAS,WAAW,UAA2B;AAC7C,QACE,2BAA2B,KAAK,SAAS,IAAI,SAAS,SAAS,UAAU;;AAI7E,SAAS,YAAY,KAAa,QAAkB,EAAE,EAAY;CAChE,MAAM,UAAU,GAAG,YAAY,KAAK,EAAE,eAAe,MAAM,CAAC;AAE5D,MAAK,MAAM,SAAS,SAAS;EAC3B,MAAM,WAAW,KAAK,KAAK,KAAK,MAAM,KAAK;AAE3C,MAAI,MAAM,aAAa,EAAE;AACvB,OAAI;IAAC;IAAgB;IAAQ;IAAS;IAAO,CAAC,SAAS,MAAM,KAAK,CAChE;AACF,eAAY,UAAU,MAAM;aACnB,MAAM,QAAQ,IAAI,cAAc,KAAK,MAAM,KAAK,CACzD,OAAM,KAAK,SAAS;;AAIxB,QAAO;;AAYT,SAAS,SAAS,UAAkB,OAA4B;CAC9D,MAAM,aAA0B,EAAE;CAClC,MAAM,UAAU,GAAG,aAAa,UAAU,QAAQ;CAClD,MAAM,OAAO,SAAS,SAAS,OAAO,GAAG,KAAK,MAAM,KAAK;CACzD,MAAM,WAAW,WAAW,SAAS;CAGrC,MAAM,OADM,MAAM,MAAM,QAAQ,CACf,MAAM;AAEvB,MAAK,MAAM,QAAQ,OAAO;AAExB,MAAI,YAAY,KAAK,iBAAiB,MAAO;EAE7C,MAAM,UAAU,KAAK,QAAQ,KAAK,QAAQ;AAE1C,OAAK,MAAM,SAAS,SAAS;GAC3B,MAAM,OAAO,MAAM,MAAM;AAEzB,OAAI,KAAK,UAAU,CAAC,KAAK,OAAO,KAAK,CAAE;GAEvC,MAAM,QAAQ,MAAM,OAAO;AAC3B,cAAW,KAAK;IACd,MAAM;IACN,MAAM,MAAM,MAAM,OAAO;IACzB,QAAQ,MAAM,MAAM,SAAS;IAC7B,MAAM,KAAK;IACX,SAAS,KAAK;IACd,MAAM,KAAK,SAAS,KAAK,GAAG,KAAK,MAAM,GAAG,GAAG,CAAC,OAAO;IACtD,CAAC;;;AAIN,QAAO;;;;;AAMT,SAAS,UAAU;CACjB,MAAM,UAAU,QAAQ,KAAK;CAC7B,MAAM,QAAQ,YAAY,QAAQ;AAElC,SAAQ,IAAI,YAAY,MAAM,OAAO,wBAAwB;CAE7D,MAAM,gBAA6B,EAAE;AAErC,MAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,aAAa,SAAS,MAAM,MAAM;AACxC,gBAAc,KAAK,GAAG,WAAW;;AAGnC,KAAI,cAAc,WAAW,GAAG;AAC9B,UAAQ,IAAI,qCAAqC;AACjD,UAAQ,KAAK,EAAE;;AAGjB,SAAQ,IAAI,SAAS,cAAc,OAAO,kBAAkB;AAE5D,MAAK,MAAM,KAAK,eAAe;EAC7B,MAAM,UAAU,KAAK,SAAS,SAAS,EAAE,KAAK;AAC9C,UAAQ,IAAI,GAAG,QAAQ,GAAG,EAAE,KAAK,GAAG,EAAE,SAAS;AAC/C,UAAQ,IAAI,KAAK,EAAE,KAAK,IAAI,EAAE,UAAU;AACxC,UAAQ,IAAI,OAAO,EAAE,KAAK,IAAI;;AAGhC,SAAQ,KAAK,EAAE;;AAGjB,MAAa,cAAc,IAAI,QAAQ,OAAO,CAC3C,YAAY,4CAA4C,CACxD,OAAO,QAAQ"}

package/dist/cli/commands/setup.js

@@ -0,0 +1,121 @@
+import fs from "node:fs";
+import path from "node:path";
+import { Command } from "commander";
+
+//#region src/cli/commands/setup.ts
+const PACKAGES = [{
+	name: "@databricks/appkit",
+	description: "Backend SDK"
+}, {
+	name: "@databricks/appkit-ui",
+	description: "UI Integration, Charts, Tables, SSE, and more."
+}];
+const SECTION_START = "<!-- appkit-instructions-start -->";
+const SECTION_END = "<!-- appkit-instructions-end -->";
+/**
+* Find which AppKit packages are installed by checking for package.json
+*/
+function findInstalledPackages() {
+	const cwd = process.cwd();
+	const installed = [];
+	for (const pkg of PACKAGES) {
+		const packagePath = path.join(cwd, "node_modules", pkg.name, "package.json");
+		if (fs.existsSync(packagePath)) installed.push(pkg);
+	}
+	return installed;
+}
+/**
+* Generate the AppKit section content
+*/
+function generateSection(packages) {
+	return `${SECTION_START}
+## Databricks AppKit
+
+This project uses Databricks AppKit packages. For AI assistant guidance on using these packages, refer to:
+
+${packages.map((pkg) => {
+		const docPath = `./node_modules/${pkg.name}/CLAUDE.md`;
+		return `- **${pkg.name}** (${pkg.description}): [${docPath}](${docPath})`;
+	}).join("\n")}
+${SECTION_END}`;
+}
+/**
+* Generate standalone CLAUDE.md content (when no existing file)
+*/
+function generateStandalone(packages) {
+	return `# AI Assistant Instructions
+
+${SECTION_START}
+## Databricks AppKit
+
+This project uses Databricks AppKit packages. For AI assistant guidance on using these packages, refer to:
+
+${packages.map((pkg) => {
+		const docPath = `./node_modules/${pkg.name}/CLAUDE.md`;
+		return `- **${pkg.name}** (${pkg.description}): [${docPath}](${docPath})`;
+	}).join("\n")}
+${SECTION_END}
+`;
+}
+/**
+* Update existing content with AppKit section
+*/
+function updateContent(existingContent, packages) {
+	const newSection = generateSection(packages);
+	const startIndex = existingContent.indexOf(SECTION_START);
+	const endIndex = existingContent.indexOf(SECTION_END);
+	if (startIndex !== -1 && endIndex !== -1) {
+		const before = existingContent.substring(0, startIndex);
+		const after = existingContent.substring(endIndex + 32);
+		return before + newSection + after;
+	}
+	return `${existingContent.trimEnd()}\n\n${newSection}\n`;
+}
+/**
+* Setup command implementation
+*/
+function runSetup(options) {
+	const shouldWrite = options.write;
+	const installed = findInstalledPackages();
+	if (installed.length === 0) {
+		console.log("No @databricks/appkit packages found in node_modules.");
+		console.log("\nMake sure you've installed at least one of:");
+		PACKAGES.forEach((pkg) => {
+			console.log(`  - ${pkg.name}`);
+		});
+		process.exit(1);
+	}
+	console.log("Detected packages:");
+	installed.forEach((pkg) => {
+		console.log(`  ✓ ${pkg.name}`);
+	});
+	const claudePath = path.join(process.cwd(), "CLAUDE.md");
+	const existingContent = fs.existsSync(claudePath) ? fs.readFileSync(claudePath, "utf-8") : null;
+	let finalContent;
+	let action;
+	if (existingContent) {
+		finalContent = updateContent(existingContent, installed);
+		action = existingContent.includes(SECTION_START) ? "Updated" : "Added to";
+	} else {
+		finalContent = generateStandalone(installed);
+		action = "Created";
+	}
+	if (shouldWrite) {
+		fs.writeFileSync(claudePath, finalContent);
+		console.log(`\n✓ ${action} CLAUDE.md`);
+		console.log(`  Path: ${claudePath}`);
+	} else {
+		console.log("\nTo create/update CLAUDE.md, run:");
+		console.log("  npx appkit setup --write\n");
+		if (existingContent) console.log(`This will ${existingContent.includes(SECTION_START) ? "update the existing" : "add a new"} AppKit section.\n`);
+		console.log("Preview of AppKit section:\n");
+		console.log("─".repeat(50));
+		console.log(generateSection(installed));
+		console.log("─".repeat(50));
+	}
+}
+const setupCommand = new Command("setup").description("Setup CLAUDE.md with AppKit package references").option("-w, --write", "Create or update CLAUDE.md file in current directory").action(runSetup);
+
+//#endregion
+export { setupCommand };
+//# sourceMappingURL=setup.js.map

package/dist/cli/commands/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.js","names":[],"sources":["../../../src/cli/commands/setup.ts"],"sourcesContent":["import { Command } from \"commander\";\nimport fs from \"node:fs\";\nimport path from \"node:path\";\n\nconst PACKAGES = [\n  { name: \"@databricks/appkit\", description: \"Backend SDK\" },\n  {\n    name: \"@databricks/appkit-ui\",\n    description: \"UI Integration, Charts, Tables, SSE, and more.\",\n  },\n];\n\nconst SECTION_START = \"<!-- appkit-instructions-start -->\";\nconst SECTION_END = \"<!-- appkit-instructions-end -->\";\n\n/**\n * Find which AppKit packages are installed by checking for package.json\n */\nfunction findInstalledPackages() {\n  const cwd = process.cwd();\n  const installed = [];\n\n  for (const pkg of PACKAGES) {\n    const packagePath = path.join(\n      cwd,\n      \"node_modules\",\n      pkg.name,\n      \"package.json\",\n    );\n    if (fs.existsSync(packagePath)) {\n      installed.push(pkg);\n    }\n  }\n\n  return installed;\n}\n\n/**\n * Generate the AppKit section content\n */\nfunction generateSection(packages: typeof PACKAGES) {\n  const links = packages\n    .map((pkg) => {\n      const docPath = `./node_modules/${pkg.name}/CLAUDE.md`;\n      return `- **${pkg.name}** (${pkg.description}): [${docPath}](${docPath})`;\n    })\n    .join(\"\\n\");\n\n  return `${SECTION_START}\n## Databricks AppKit\n\nThis project uses Databricks AppKit packages. For AI assistant guidance on using these packages, refer to:\n\n${links}\n${SECTION_END}`;\n}\n\n/**\n * Generate standalone CLAUDE.md content (when no existing file)\n */\nfunction generateStandalone(packages: typeof PACKAGES) {\n  const links = packages\n    .map((pkg) => {\n      const docPath = `./node_modules/${pkg.name}/CLAUDE.md`;\n      return `- **${pkg.name}** (${pkg.description}): [${docPath}](${docPath})`;\n    })\n    .join(\"\\n\");\n\n  return `# AI Assistant Instructions\n\n${SECTION_START}\n## Databricks AppKit\n\nThis project uses Databricks AppKit packages. For AI assistant guidance on using these packages, refer to:\n\n${links}\n${SECTION_END}\n`;\n}\n\n/**\n * Update existing content with AppKit section\n */\nfunction updateContent(existingContent: string, packages: typeof PACKAGES) {\n  const newSection = generateSection(packages);\n\n  // Check if AppKit section already exists\n  const startIndex = existingContent.indexOf(SECTION_START);\n  const endIndex = existingContent.indexOf(SECTION_END);\n\n  if (startIndex !== -1 && endIndex !== -1) {\n    // Replace existing section\n    const before = existingContent.substring(0, startIndex);\n    const after = existingContent.substring(endIndex + SECTION_END.length);\n    return before + newSection + after;\n  }\n\n  // Append section to end\n  return `${existingContent.trimEnd()}\\n\\n${newSection}\\n`;\n}\n\n/**\n * Setup command implementation\n */\nfunction runSetup(options: { write?: boolean }) {\n  const shouldWrite = options.write;\n\n  // Find installed packages\n  const installed = findInstalledPackages();\n\n  if (installed.length === 0) {\n    console.log(\"No @databricks/appkit packages found in node_modules.\");\n    console.log(\"\\nMake sure you've installed at least one of:\");\n    PACKAGES.forEach((pkg) => {\n      console.log(`  - ${pkg.name}`);\n    });\n    process.exit(1);\n  }\n\n  console.log(\"Detected packages:\");\n  installed.forEach((pkg) => {\n    console.log(`  ✓ ${pkg.name}`);\n  });\n\n  const claudePath = path.join(process.cwd(), \"CLAUDE.md\");\n  const existingContent = fs.existsSync(claudePath)\n    ? fs.readFileSync(claudePath, \"utf-8\")\n    : null;\n\n  let finalContent: string;\n  let action: string;\n\n  if (existingContent) {\n    finalContent = updateContent(existingContent, installed);\n    action = existingContent.includes(SECTION_START) ? \"Updated\" : \"Added to\";\n  } else {\n    finalContent = generateStandalone(installed);\n    action = \"Created\";\n  }\n\n  if (shouldWrite) {\n    fs.writeFileSync(claudePath, finalContent);\n    console.log(`\\n✓ ${action} CLAUDE.md`);\n    console.log(`  Path: ${claudePath}`);\n  } else {\n    console.log(\"\\nTo create/update CLAUDE.md, run:\");\n    console.log(\"  npx appkit setup --write\\n\");\n\n    if (existingContent) {\n      console.log(\n        `This will ${\n          existingContent.includes(SECTION_START)\n            ? \"update the existing\"\n            : \"add a new\"\n        } AppKit section.\\n`,\n      );\n    }\n\n    console.log(\"Preview of AppKit section:\\n\");\n    console.log(\"─\".repeat(50));\n    console.log(generateSection(installed));\n    console.log(\"─\".repeat(50));\n  }\n}\n\nexport const setupCommand = new Command(\"setup\")\n  .description(\"Setup CLAUDE.md with AppKit package references\")\n  .option(\"-w, --write\", \"Create or update CLAUDE.md file in current directory\")\n  .action(runSetup);\n"],"mappings":";;;;;AAIA,MAAM,WAAW,CACf;CAAE,MAAM;CAAsB,aAAa;CAAe,EAC1D;CACE,MAAM;CACN,aAAa;CACd,CACF;AAED,MAAM,gBAAgB;AACtB,MAAM,cAAc;;;;AAKpB,SAAS,wBAAwB;CAC/B,MAAM,MAAM,QAAQ,KAAK;CACzB,MAAM,YAAY,EAAE;AAEpB,MAAK,MAAM,OAAO,UAAU;EAC1B,MAAM,cAAc,KAAK,KACvB,KACA,gBACA,IAAI,MACJ,eACD;AACD,MAAI,GAAG,WAAW,YAAY,CAC5B,WAAU,KAAK,IAAI;;AAIvB,QAAO;;;;;AAMT,SAAS,gBAAgB,UAA2B;AAQlD,QAAO,GAAG,cAAc;;;;;EAPV,SACX,KAAK,QAAQ;EACZ,MAAM,UAAU,kBAAkB,IAAI,KAAK;AAC3C,SAAO,OAAO,IAAI,KAAK,MAAM,IAAI,YAAY,MAAM,QAAQ,IAAI,QAAQ;GACvE,CACD,KAAK,KAAK,CAOP;EACN;;;;;AAMF,SAAS,mBAAmB,UAA2B;AAQrD,QAAO;;EAEP,cAAc;;;;;EATA,SACX,KAAK,QAAQ;EACZ,MAAM,UAAU,kBAAkB,IAAI,KAAK;AAC3C,SAAO,OAAO,IAAI,KAAK,MAAM,IAAI,YAAY,MAAM,QAAQ,IAAI,QAAQ;GACvE,CACD,KAAK,KAAK,CASP;EACN,YAAY;;;;;;AAOd,SAAS,cAAc,iBAAyB,UAA2B;CACzE,MAAM,aAAa,gBAAgB,SAAS;CAG5C,MAAM,aAAa,gBAAgB,QAAQ,cAAc;CACzD,MAAM,WAAW,gBAAgB,QAAQ,YAAY;AAErD,KAAI,eAAe,MAAM,aAAa,IAAI;EAExC,MAAM,SAAS,gBAAgB,UAAU,GAAG,WAAW;EACvD,MAAM,QAAQ,gBAAgB,UAAU,WAAW,GAAmB;AACtE,SAAO,SAAS,aAAa;;AAI/B,QAAO,GAAG,gBAAgB,SAAS,CAAC,MAAM,WAAW;;;;;AAMvD,SAAS,SAAS,SAA8B;CAC9C,MAAM,cAAc,QAAQ;CAG5B,MAAM,YAAY,uBAAuB;AAEzC,KAAI,UAAU,WAAW,GAAG;AAC1B,UAAQ,IAAI,wDAAwD;AACpE,UAAQ,IAAI,gDAAgD;AAC5D,WAAS,SAAS,QAAQ;AACxB,WAAQ,IAAI,OAAO,IAAI,OAAO;IAC9B;AACF,UAAQ,KAAK,EAAE;;AAGjB,SAAQ,IAAI,qBAAqB;AACjC,WAAU,SAAS,QAAQ;AACzB,UAAQ,IAAI,OAAO,IAAI,OAAO;GAC9B;CAEF,MAAM,aAAa,KAAK,KAAK,QAAQ,KAAK,EAAE,YAAY;CACxD,MAAM,kBAAkB,GAAG,WAAW,WAAW,GAC7C,GAAG,aAAa,YAAY,QAAQ,GACpC;CAEJ,IAAI;CACJ,IAAI;AAEJ,KAAI,iBAAiB;AACnB,iBAAe,cAAc,iBAAiB,UAAU;AACxD,WAAS,gBAAgB,SAAS,cAAc,GAAG,YAAY;QAC1D;AACL,iBAAe,mBAAmB,UAAU;AAC5C,WAAS;;AAGX,KAAI,aAAa;AACf,KAAG,cAAc,YAAY,aAAa;AAC1C,UAAQ,IAAI,OAAO,OAAO,YAAY;AACtC,UAAQ,IAAI,WAAW,aAAa;QAC/B;AACL,UAAQ,IAAI,qCAAqC;AACjD,UAAQ,IAAI,+BAA+B;AAE3C,MAAI,gBACF,SAAQ,IACN,aACE,gBAAgB,SAAS,cAAc,GACnC,wBACA,YACL,oBACF;AAGH,UAAQ,IAAI,+BAA+B;AAC3C,UAAQ,IAAI,IAAI,OAAO,GAAG,CAAC;AAC3B,UAAQ,IAAI,gBAAgB,UAAU,CAAC;AACvC,UAAQ,IAAI,IAAI,OAAO,GAAG,CAAC;;;AAI/B,MAAa,eAAe,IAAI,QAAQ,QAAQ,CAC7C,YAAY,iDAAiD,CAC7D,OAAO,eAAe,uDAAuD,CAC7E,OAAO,SAAS"}

package/dist/cli/index.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/cli/index.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+import { setupCommand } from "./commands/setup.js";
+import { generateTypesCommand } from "./commands/generate-types.js";
+import { lintCommand } from "./commands/lint.js";
+import { docsCommand } from "./commands/docs.js";
+import { readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import { dirname, join } from "node:path";
+import { Command } from "commander";
+
+//#region src/cli/index.ts
+const pkgPath = join(dirname(fileURLToPath(import.meta.url)), "../../package.json");
+const pkg = JSON.parse(readFileSync(pkgPath, "utf-8"));
+const cmd = new Command();
+cmd.name("appkit").description("CLI tools for Databricks AppKit").version(pkg.version);
+cmd.addCommand(setupCommand);
+cmd.addCommand(generateTypesCommand);
+cmd.addCommand(lintCommand);
+cmd.addCommand(docsCommand);
+cmd.parse();
+
+//#endregion
+export {  };
+//# sourceMappingURL=index.js.map

package/dist/cli/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/cli/index.ts"],"sourcesContent":["#!/usr/bin/env node\n\nimport { readFileSync } from \"node:fs\";\nimport { fileURLToPath } from \"node:url\";\nimport { dirname, join } from \"node:path\";\nimport { Command } from \"commander\";\nimport { setupCommand } from \"./commands/setup.js\";\nimport { generateTypesCommand } from \"./commands/generate-types.js\";\nimport { lintCommand } from \"./commands/lint.js\";\nimport { docsCommand } from \"./commands/docs.js\";\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\nconst pkgPath = join(__dirname, \"../../package.json\");\nconst pkg = JSON.parse(readFileSync(pkgPath, \"utf-8\"));\n\nconst cmd = new Command();\n\ncmd\n  .name(\"appkit\")\n  .description(\"CLI tools for Databricks AppKit\")\n  .version(pkg.version);\n\ncmd.addCommand(setupCommand);\ncmd.addCommand(generateTypesCommand);\ncmd.addCommand(lintCommand);\ncmd.addCommand(docsCommand);\n\ncmd.parse();\n"],"mappings":";;;;;;;;;;;AAYA,MAAM,UAAU,KADE,QAAQ,cAAc,OAAO,KAAK,IAAI,CAAC,EACzB,qBAAqB;AACrD,MAAM,MAAM,KAAK,MAAM,aAAa,SAAS,QAAQ,CAAC;AAEtD,MAAM,MAAM,IAAI,SAAS;AAEzB,IACG,KAAK,SAAS,CACd,YAAY,kCAAkC,CAC9C,QAAQ,IAAI,QAAQ;AAEvB,IAAI,WAAW,aAAa;AAC5B,IAAI,WAAW,qBAAqB;AACpC,IAAI,WAAW,YAAY;AAC3B,IAAI,WAAW,YAAY;AAE3B,IAAI,OAAO"}

package/dist/js/arrow/arrow-client.d.ts

@@ -11,11 +11,47 @@ declare class ArrowClient {
    * @returns Promise resolving to an Arrow Table
    */
   static processArrowBuffer(buffer: Uint8Array): Promise<Table$1>;
+  /**
+   * Fetches Arrow data from a URL and processes it into a Table.
+   * Convenience method that combines fetchArrow and processArrowBuffer.
+   *
+   * @param url - URL to fetch Arrow data from
+   * @param headers - Optional HTTP headers to include in the request
+   * @returns Promise resolving to an Arrow Table
+   * @example
+   * ```typescript
+   * const table = await ArrowClient.fetchAndProcessArrow('/api/data/arrow');
+   * console.log(`Loaded ${table.numRows} rows`);
+   * ```
+   */
   static fetchAndProcessArrow(url: string, headers?: Record<string, string>): Promise<Table$1>;
+  /**
+   * Extracts field metadata (name and type) from an Arrow Table.
+   *
+   * @param table - Arrow Table to extract fields from
+   * @returns Array of field metadata objects
+   * @example
+   * ```typescript
+   * const fields = ArrowClient.extractArrowFields(table);
+   * // [{ name: "date", type: Date32 }, { name: "value", type: Float64 }]
+   * ```
+   */
   static extractArrowFields(table: Table$1): {
     name: string;
     type: any;
   }[];
+  /**
+   * Extracts all columns from an Arrow Table as JavaScript arrays.
+   * Each column is converted to a native JavaScript array.
+   *
+   * @param table - Arrow Table to extract columns from
+   * @returns Object mapping column names to arrays
+   * @example
+   * ```typescript
+   * const columns = ArrowClient.extractArrowColumns(table);
+   * // { date: ["2024-01-01", "2024-01-02"], value: [100, 200] }
+   * ```
+   */
   static extractArrowColumns(table: Table$1): Record<string, any>;
   /**
    * Extracts chart data from Arrow table.
@@ -51,6 +87,18 @@ declare class ArrowClient {
   static detectFieldsFromArrow(table: Table$1, orientation?: "vertical" | "horizontal"): DetectedFields & {
     chartType: "timeseries" | "categorical";
   };
+  /**
+   * Fetches raw Arrow IPC data from a URL.
+   *
+   * @param url - URL to fetch Arrow data from
+   * @param headers - Optional HTTP headers to include in the request
+   * @returns Promise resolving to the raw Arrow buffer as Uint8Array
+   * @example
+   * ```typescript
+   * const buffer = await ArrowClient.fetchArrow('/api/data/arrow');
+   * const table = await ArrowClient.processArrowBuffer(buffer);
+   * ```
+   */
   static fetchArrow(url: string, headers?: Record<string, string>): Promise<Uint8Array>;
 }
 interface DetectedFields {

package/dist/js/arrow/arrow-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"arrow-client.d.ts","names":[],"sources":["../../../src/js/arrow/arrow-client.ts"],"sourcesContent":[],"mappings":";;;;AAmBa,cAAA,WAAA,CAAW;EAAA;;;;;;;SAwCW,kBAAA,CAAA,MAAA,EAhCO,UAgCP,CAAA,EAhCoB,OAgCpB,CAhC4B,OAgC5B,CAAA;SASC,oBAAA,CAAA,GAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAxBtB,MAwBsB,CAAA,MAAA,EAAA,MAAA,CAAA,CAAA,EAvB/B,OAuB+B,CAvBvB,OAuBuB,CAAA;SAAQ,kBAAA,CAAA,KAAA,EATT,OASS,CAAA,EAAA;IAuBX,IAAA,EAAA,MAAA;IA6MrB,IAAA,EAAA,GAAA;KAtJD;SAEN,mBAAA,CAAA,KAAA,EAhF+B,OAgF/B,CAAA,EAhFuC,MAgFvC,CAAA,MAAA,EAAA,GAAA,CAAA;;;;;AAsIL;;;;;iCA/LiC;;cA6MrB;;;;;;;;;;;;;;;;;;;;sCAtJD,mDAEN;;;2CA8GS,yBACT,QAAQ;;UAuBI,cAAA"}
+{"version":3,"file":"arrow-client.d.ts","names":[],"sources":["../../../src/js/arrow/arrow-client.ts"],"sourcesContent":[],"mappings":";;;;AAmBa,cAAA,WAAA,CAAW;EAAA;;;;;;;SAgEW,kBAAA,CAAA,MAAA,EAxDO,UAwDP,CAAA,EAxDoB,OAwDpB,CAxD4B,OAwD5B,CAAA;;;;;;;;;;;AAuPnC;;;qDAjRc,yBACT,QAAQ;;;;;;;;;;;;mCAyBsB;;;;;;;;;;;;;;;;oCAqBC,UAAQ;;;;;;;;;;iCAuBX;;cAyNrB;;;;;;;;;;;;;;;;;;;;sCAlKD,mDAEN;;;;;;;;;;;;;;;2CA0HS,yBACT,QAAQ;;UAuBI,cAAA"}

package/dist/js/arrow/arrow-client.js

@@ -19,6 +19,19 @@ var ArrowClient = class ArrowClient {
 			throw new Error(`Failed to process Arrow buffer: ${error instanceof Error ? error.message : "Unknown error"}`);
 		}
 	}
+	/**
+	* Fetches Arrow data from a URL and processes it into a Table.
+	* Convenience method that combines fetchArrow and processArrowBuffer.
+	*
+	* @param url - URL to fetch Arrow data from
+	* @param headers - Optional HTTP headers to include in the request
+	* @returns Promise resolving to an Arrow Table
+	* @example
+	* ```typescript
+	* const table = await ArrowClient.fetchAndProcessArrow('/api/data/arrow');
+	* console.log(`Loaded ${table.numRows} rows`);
+	* ```
+	*/
 	static async fetchAndProcessArrow(url, headers) {
 		try {
 			const buffer = await ArrowClient.fetchArrow(url, headers);
@@ -27,6 +40,17 @@ var ArrowClient = class ArrowClient {
 			throw new Error(`Failed to fetch Arrow data: ${error instanceof Error ? error.message : "Unknown error"}`);
 		}
 	}
+	/**
+	* Extracts field metadata (name and type) from an Arrow Table.
+	*
+	* @param table - Arrow Table to extract fields from
+	* @returns Array of field metadata objects
+	* @example
+	* ```typescript
+	* const fields = ArrowClient.extractArrowFields(table);
+	* // [{ name: "date", type: Date32 }, { name: "value", type: Float64 }]
+	* ```
+	*/
 	static extractArrowFields(table) {
 		return table.schema.fields.map((field) => {
 			return {
@@ -35,6 +59,18 @@ var ArrowClient = class ArrowClient {
 			};
 		});
 	}
+	/**
+	* Extracts all columns from an Arrow Table as JavaScript arrays.
+	* Each column is converted to a native JavaScript array.
+	*
+	* @param table - Arrow Table to extract columns from
+	* @returns Object mapping column names to arrays
+	* @example
+	* ```typescript
+	* const columns = ArrowClient.extractArrowColumns(table);
+	* // { date: ["2024-01-01", "2024-01-02"], value: [100, 200] }
+	* ```
+	*/
 	static extractArrowColumns(table) {
 		const cols = {};
 		for (const field of table.schema.fields) {
@@ -116,10 +152,10 @@ var ArrowClient = class ArrowClient {
 		const isTimeSeries = primaryDateFields.length > 0 && orientation !== "horizontal";
 		const isCategorical = nameFields.length > 0 && (primaryDateFields.length === 0 || orientation === "horizontal");
 		if (orientation === "horizontal" || isCategorical) {
-			const xField$1 = nameFields[0] || primaryDateFields[0] || metadataDateFields[0] || fieldNames[0];
+			const xField = nameFields[0] || primaryDateFields[0] || metadataDateFields[0] || fieldNames[0];
 			return {
-				xField: xField$1,
-				yFields: numericFields.length > 0 ? numericFields : fieldNames.filter((k) => k !== xField$1),
+				xField,
+				yFields: numericFields.length > 0 ? numericFields : fieldNames.filter((k) => k !== xField),
 				chartType: "categorical"
 			};
 		}
@@ -130,6 +166,18 @@ var ArrowClient = class ArrowClient {
 			chartType: isTimeSeries ? "timeseries" : "categorical"
 		};
 	}
+	/**
+	* Fetches raw Arrow IPC data from a URL.
+	*
+	* @param url - URL to fetch Arrow data from
+	* @param headers - Optional HTTP headers to include in the request
+	* @returns Promise resolving to the raw Arrow buffer as Uint8Array
+	* @example
+	* ```typescript
+	* const buffer = await ArrowClient.fetchArrow('/api/data/arrow');
+	* const table = await ArrowClient.processArrowBuffer(buffer);
+	* ```
+	*/
 	static async fetchArrow(url, headers) {
 		try {
 			const response = await fetch(url, { headers: {