@openbkn/bkn-sdk 0.1.0 → 0.1.1-alpha.1

package/dist/cli.js

@@ -13,6 +13,7 @@ import {
   formatError,
   listPlatforms,
   logout,
+  parseEmbeddingFields,
   parsePkMap,
   rawCall,
   readPlatformConfig,
@@ -27,7 +28,7 @@ import {
   usersOf,
   whoami,
   writePlatformConfig
-} from "./chunk-4NXAIG4G.js";
+} from "./chunk-ADZ23DPF.js";
 
 // src/cli.ts
 import { Command as Command16 } from "commander";
@@ -35,7 +36,7 @@ import { Command as Command16 } from "commander";
 // package.json
 var package_default = {
   name: "@openbkn/bkn-sdk",
-  version: "0.1.0",
+  version: "0.1.1-alpha.1",
   description: "Unified TypeScript SDK + CLI for the BKN (Business Knowledge Network) platform.",
   type: "module",
   license: "Apache-2.0",
@@ -76,7 +77,6 @@ var package_default = {
   dependencies: {
     "@clack/prompts": "^0.9.1",
     chalk: "^5.4.1",
-    "cli-table3": "^0.6.5",
     commander: "^13.1.0",
     "csv-parse": "^6.2.1",
     "js-yaml": "^4.2.0",
@@ -149,7 +149,6 @@ function installGroupedHelp(root) {
 }
 
 // src/utils/output.ts
-import Table from "cli-table3";
 function printJson(value, opts = {}) {
   if (opts.json || opts.compact) {
     process.stdout.write(`${JSON.stringify(value, null, opts.compact ? 0 : 2)}
@@ -158,9 +157,14 @@ function printJson(value, opts = {}) {
   }
   const rows = toRows(value);
   if (rows) {
-    const columns = columnsOf(rows);
+    const columns = opts.full ? columnsOf(rows).filter((c) => rows.some((r) => stringifyCell(r[c]) !== "")) : selectColumns(rows);
     if (columns.length > 0) {
       printTable(rows, columns);
+      const hidden = columnsOf(rows).length - columns.length;
+      if (hidden > 0 && !opts.full) {
+        process.stdout.write(`\u2026 ${hidden} more column(s); use --full or --json for everything
+`);
+      }
       return;
     }
   }
@@ -186,22 +190,68 @@ function columnsOf(rows) {
   }
   return seen;
 }
+var MAX_COLS = 8;
+var NOISE_COLS = /* @__PURE__ */ new Set([
+  "creator",
+  "updater",
+  "create_by",
+  "update_by",
+  "create_user",
+  "update_user",
+  "operations",
+  "status_message",
+  "last_check_time",
+  "last_discover_status",
+  "health_check_result",
+  "health_check_enabled"
+]);
+var isNoiseCol = (c) => NOISE_COLS.has(c) || /_time$/.test(c);
+var isKeyCol = (c) => /^(id|name|key|title|label)$/i.test(c) || /_(id|name|key)$/i.test(c) || /^(status|state|type|category|mode|enabled|version|branch)$/i.test(c);
+function selectColumns(rows) {
+  const isObj = (v) => v !== null && typeof v === "object" && !Array.isArray(v);
+  const kept = columnsOf(rows).filter((c) => {
+    if (isNoiseCol(c)) return false;
+    const vals = rows.map((r) => r[c]);
+    if (!vals.some((v) => stringifyCell(v) !== "")) return false;
+    if (vals.every((v) => v === null || v === void 0 || isObj(v))) return false;
+    return true;
+  });
+  const isLongText = (c) => rows.every((r) => {
+    const s = stringifyCell(r[c]);
+    return s === "" || s.length >= CELL_MAX - 1;
+  });
+  const rank = (c) => isKeyCol(c) ? 0 : isLongText(c) ? 2 : 1;
+  const ordered = kept.map((c, i) => ({ c, i, r: rank(c) })).sort((a, b) => a.r - b.r || a.i - b.i).map((x) => x.c);
+  return ordered.slice(0, MAX_COLS);
+}
 function printTable(rows, columns, opts = {}) {
   if (opts.json || opts.compact) {
     printJson(rows, opts);
     return;
   }
-  const table = new Table({ head: columns });
-  for (const row of rows) {
-    table.push(columns.map((c) => stringifyCell(row[c])));
-  }
-  process.stdout.write(`${table.toString()}
+  const cells = rows.map((row) => columns.map((c) => stringifyCell(row[c])));
+  const widths = columns.map(
+    (col, i) => Math.max(displayWidth(col), ...cells.map((r) => displayWidth(r[i] ?? "")))
+  );
+  const fmt = (parts) => parts.map((p, i) => i === parts.length - 1 ? p : pad(p, widths[i] ?? 0)).join("  ").trimEnd();
+  const lines = [fmt(columns), ...cells.map(fmt)];
+  process.stdout.write(`${lines.join("\n")}
 `);
 }
 var CELL_MAX = 48;
+function displayWidth(s) {
+  let w = 0;
+  for (const ch of s) w += /[ᄀ-ᅟ⺀-꓏가-힣豈-﫿︰-﹏＀-｠￠-￦]/.test(ch) ? 2 : 1;
+  return w;
+}
+function pad(s, width) {
+  const gap = width - displayWidth(s);
+  return gap > 0 ? s + " ".repeat(gap) : s;
+}
 function stringifyCell(v) {
   if (v === null || v === void 0) return "";
-  const s = (typeof v === "object" ? JSON.stringify(v) : String(v)).replace(/\s+/g, " ").trim();
+  const raw = Array.isArray(v) && v.every((x) => x === null || typeof x !== "object") ? v.join(",") : typeof v === "object" ? JSON.stringify(v) : String(v);
+  const s = raw.replace(/\s+/g, " ").trim();
   return s.length > CELL_MAX ? `${s.slice(0, CELL_MAX - 1)}\u2026` : s;
 }
 
@@ -219,7 +269,7 @@ function clientFrom(cmd) {
 }
 function outputOptions(cmd) {
   const o = cmd.optsWithGlobals();
-  return { json: Boolean(o.json), compact: Boolean(o.compact) };
+  return { json: Boolean(o.json), compact: Boolean(o.compact), full: Boolean(o.full) };
 }
 function csv(value) {
   if (!value) return void 0;
@@ -1379,8 +1429,18 @@ function bknCommand() {
   job.command("delete <kn-id> <job-ids>").description("Delete job(s) (comma-joined ids)").action(async (knId, ids, _o, cmd) => {
     printJson(await clientFrom(cmd).kn.jobDelete(knId, ids), outputOptions(cmd));
   });
-  bkn.command("push <directory>").description("Pack a BKN directory into a tar and import it as a knowledge network").option("--branch <name>", "target branch", "main").action(async (dir, opts, cmd) => {
-    printJson(await clientFrom(cmd).kn.push(dir, { branch: opts.branch }), outputOptions(cmd));
+  bkn.command("push <directory>").description("Pack a BKN directory into a tar and import it as a knowledge network").option("--branch <name>", "target branch", "main").option("--build", "submit a Vega build task for each object type declaring a vector index").option(
+    "--embedding-model <id>",
+    "embedding model id for declared vector indexes (with --build)"
+  ).action(async (dir, opts, cmd) => {
+    printJson(
+      await clientFrom(cmd).kn.push(dir, {
+        branch: opts.branch,
+        build: Boolean(opts.build),
+        embeddingModel: opts.embeddingModel
+      }),
+      outputOptions(cmd)
+    );
   });
   bkn.command("pull <kn-id> [directory]").description("Download a knowledge network as a BKN tar and extract it locally").option("--branch <name>", "source branch", "main").action(async (knId, dir, opts, cmd) => {
     printJson(
@@ -1397,7 +1457,10 @@ function bknCommand() {
   bkn.command("resources").description("List BKN-backend resources").action(async (_opts, cmd) => {
     printJson(await clientFrom(cmd).kn.bknResources(), outputOptions(cmd));
   });
-  bkn.command("create-from-catalog <catalog-id>").description("Build a knowledge network from a Vega catalog's tables").requiredOption("--name <name>", "knowledge network name").option("--tables <list>", "comma-separated table names (default: all)").option("--pk-map <map>", "explicit primary keys: '<table>:<col>[,<table>:<col>...]'").option("--build", "submit a Vega build task per resource after creation").option("--no-rollback", "keep a partially-created KN on failure").action(async (catalogId, opts, cmd) => {
+  bkn.command("create-from-catalog <catalog-id>").description("Build a knowledge network from a Vega catalog's tables").requiredOption("--name <name>", "knowledge network name").option("--tables <list>", "comma-separated table names (default: all)").option("--pk-map <map>", "explicit primary keys: '<table>:<col>[,<table>:<col>...]'").option("--build", "submit a Vega build task per resource after creation").option(
+    "--embedding-fields <map>",
+    "columns to vectorize per table (with --build): '<table>:<col>[+<col>...][,...]'"
+  ).option("--embedding-model <id>", "embedding model id for the vector index (with --build)").option("--no-rollback", "keep a partially-created KN on failure").action(async (catalogId, opts, cmd) => {
     printJson(
       await clientFrom(cmd).kn.createFromCatalog({
         catalogId,
@@ -1405,6 +1468,8 @@ function bknCommand() {
         tables: csv(opts.tables),
         pkMap: opts.pkMap ? parsePkMap(opts.pkMap) : void 0,
         build: Boolean(opts.build),
+        embeddingFields: opts.embeddingFields ? parseEmbeddingFields(opts.embeddingFields) : void 0,
+        embeddingModel: opts.embeddingModel,
         noRollback: opts.rollback === false,
         onProgress: (m) => console.error(m)
       }),
@@ -1416,7 +1481,10 @@ function bknCommand() {
     printJson(result, outputOptions(cmd));
     if (!result.valid) process.exitCode = 1;
   });
-  bkn.command("create-from-csv <catalog-id>").description("Import CSV files into a Vega catalog, then build a KN from them").requiredOption("--files <glob>", "CSV paths (comma-separated or glob)").requiredOption("--name <name>", "knowledge network name").option("--table-prefix <s>", "prefix for derived table names", "").option("--batch-size <n>", "rows per insert batch", int3, 500).option("--tables <list>", "subset of imported tables to include in the KN").option("--pk-map <map>", "explicit primary keys: '<table>:<col>[,...]'").option("--build", "submit a Vega build task per resource after creation").option("--no-rollback", "keep a partially-created KN on failure").action(async (catalogId, opts, cmd) => {
+  bkn.command("create-from-csv <catalog-id>").description("Import CSV files into a Vega catalog, then build a KN from them").requiredOption("--files <glob>", "CSV paths (comma-separated or glob)").requiredOption("--name <name>", "knowledge network name").option("--table-prefix <s>", "prefix for derived table names", "").option("--batch-size <n>", "rows per insert batch", int3, 500).option("--tables <list>", "subset of imported tables to include in the KN").option("--pk-map <map>", "explicit primary keys: '<table>:<col>[,...]'").option("--build", "submit a Vega build task per resource after creation").option(
+    "--embedding-fields <map>",
+    "columns to vectorize per table (with --build): '<table>:<col>[+<col>...][,...]'"
+  ).option("--embedding-model <id>", "embedding model id for the vector index (with --build)").option("--no-rollback", "keep a partially-created KN on failure").action(async (catalogId, opts, cmd) => {
     printJson(
       await clientFrom(cmd).kn.createFromCsv({
         catalogId,
@@ -1427,6 +1495,8 @@ function bknCommand() {
         tables: csv(opts.tables),
         pkMap: opts.pkMap ? parsePkMap(opts.pkMap) : void 0,
         build: Boolean(opts.build),
+        embeddingFields: opts.embeddingFields ? parseEmbeddingFields(opts.embeddingFields) : void 0,
+        embeddingModel: opts.embeddingModel,
         noRollback: opts.rollback === false,
         onProgress: (m) => console.error(m)
       }),
@@ -1851,18 +1921,18 @@ import { Command as Command11 } from "commander";
 var int8 = (v) => Number.parseInt(v, 10);
 function resourceCommand() {
   const cmd = new Command11("resource").alias("res").description("Resources \u2014 list, find, get, query, delete");
-  cmd.command("list").description("List resources under a datasource/catalog").option("--datasource-id <id>", "filter by datasource/catalog id").option("--type <category>", "resource category (table | logicview)").option("--limit <n>", "page size", int8, DEFAULT_LIST_LIMIT).action(async (opts, cmd2) => {
+  cmd.command("list").description("List resources under a catalog").option("--catalog-id <id>", "filter by catalog id").option("--datasource-id <id>", "alias of --catalog-id").option("--category <c>", "resource category (table | logicview | dataset)").option("--type <c>", "alias of --category").option("--limit <n>", "page size", int8, DEFAULT_LIST_LIMIT).action(async (opts, cmd2) => {
     const data = await clientFrom(cmd2).resource.list({
-      datasourceId: opts.datasourceId,
-      category: opts.type,
+      datasourceId: opts.catalogId ?? opts.datasourceId,
+      category: opts.category ?? opts.type,
       limit: opts.limit
     });
     printJson(data, outputOptions(cmd2));
   });
-  cmd.command("find").description("Search resources by name (fuzzy; --exact for strict)").requiredOption("--name <name>", "resource name to search").option("--exact", "exact name match").option("--datasource-id <id>", "limit to a datasource/catalog").action(async (opts, cmd2) => {
+  cmd.command("find").description("Search resources by name (fuzzy; --exact for strict)").requiredOption("--name <name>", "resource name to search").option("--exact", "exact name match").option("--catalog-id <id>", "limit to a catalog").option("--datasource-id <id>", "alias of --catalog-id").action(async (opts, cmd2) => {
     const data = await clientFrom(cmd2).resource.find(opts.name, {
       exact: opts.exact,
-      datasourceId: opts.datasourceId
+      datasourceId: opts.catalogId ?? opts.datasourceId
     });
     printJson(data, outputOptions(cmd2));
   });
@@ -2234,6 +2304,34 @@ function vegaCommand() {
   catalog.command("health <ids...>").description("Health-status for one or more catalogs").action(async (ids, _opts, cmd) => {
     printJson(await clientFrom(cmd).vega.catalogHealth(ids), outputOptions(cmd));
   });
+  catalog.command("create").description("Create a catalog (data source)").requiredOption("--name <s>", "catalog name").requiredOption("--connector-type <s>", "connector type (e.g. mysql)").requiredOption("--connector-config <json>", "connector config JSON").option("--tags <t1,t2>", "comma-separated tags").option("--description <s>", "description").option("--enabled", "create enabled (default: disabled)").action(async (opts, cmd) => {
+    let connectorConfig;
+    try {
+      connectorConfig = JSON.parse(opts.connectorConfig);
+    } catch {
+      throw new Error("--connector-config must be valid JSON");
+    }
+    printJson(
+      await clientFrom(cmd).vega.createCatalog({
+        name: opts.name,
+        connectorType: opts.connectorType,
+        connectorConfig,
+        tags: opts.tags ? String(opts.tags).split(",").map((t) => t.trim()).filter(Boolean) : void 0,
+        description: opts.description,
+        enabled: opts.enabled ? true : void 0
+      }),
+      outputOptions(cmd)
+    );
+  });
+  catalog.command("enable <id>").description("Enable a catalog (required before discovery)").action(async (id, _opts, cmd) => {
+    printJson(await clientFrom(cmd).vega.enableCatalog(id), outputOptions(cmd));
+  });
+  catalog.command("discover <id>").description("Trigger catalog resource discovery").option("--wait", "wait for discovery to complete").action(async (id, opts, cmd) => {
+    printJson(
+      await clientFrom(cmd).vega.discoverCatalog(id, Boolean(opts.wait)),
+      outputOptions(cmd)
+    );
+  });
   const connector = vega.command("connector-type").description("Connector types");
   connector.command("list").description("List connector types").action(async (_opts, cmd) => {
     printJson(await clientFrom(cmd).vega.connectorTypes(), outputOptions(cmd));
@@ -2242,11 +2340,11 @@ function vegaCommand() {
     printJson(await clientFrom(cmd).vega.connectorType(type), outputOptions(cmd));
   });
   const resource = vega.command("resource").description("Vega-backend resources");
-  resource.command("list").description("List resources").option("--datasource-id <id>", "filter by catalog/datasource id").option("--type <category>", "resource category").option("--limit <n>", "page size", (v) => Number.parseInt(v, 10), DEFAULT_LIST_LIMIT).action(async (opts, cmd) => {
+  resource.command("list").description("List resources").option("--datasource-id <id>", "filter by catalog/datasource id").option("--catalog-id <id>", "alias of --datasource-id").option("--type <category>", "resource category").option("--category <category>", "alias of --type").option("--limit <n>", "page size", (v) => Number.parseInt(v, 10), DEFAULT_LIST_LIMIT).action(async (opts, cmd) => {
     printJson(
       await clientFrom(cmd).resource.list({
-        datasourceId: opts.datasourceId,
-        category: opts.type,
+        datasourceId: opts.datasourceId ?? opts.catalogId,
+        category: opts.type ?? opts.category,
         limit: opts.limit
       }),
       outputOptions(cmd)
@@ -2289,7 +2387,7 @@ function vegaCommand() {
 
 // src/cli.ts
 var program = new Command16();
-program.name("openbkn").description("Operate the BKN platform from the CLI").version(package_default.version, "-V, --version", "output the version number").option("--base-url <url>", "platform base URL (env: BKN_BASE_URL)").option("--token <value>", "access token (env: BKN_TOKEN)").option("--user <id|name>", "use specific user credentials (env: BKN_USER)").option("--json", "machine-readable JSON output").option("--compact", "single-line JSON output").option("--biz-domain <s>", "business domain (alias: -bd)").option("-k, --insecure", "skip TLS verification (dev / self-signed only)").showHelpAfterError();
+program.name("openbkn").description("Operate the BKN platform from the CLI").version(package_default.version, "-V, --version", "output the version number").option("--base-url <url>", "platform base URL (env: BKN_BASE_URL)").option("--token <value>", "access token (env: BKN_TOKEN)").option("--user <id|name>", "use specific user credentials (env: BKN_USER)").option("--json", "machine-readable JSON output").option("--compact", "single-line JSON output").option("--full", "human view: show all columns (default trims to the key ones)").option("--biz-domain <s>", "business domain (alias: -bd)").option("-k, --insecure", "skip TLS verification (dev / self-signed only)").showHelpAfterError();
 program.addCommand(authCommand());
 program.addCommand(callCommand());
 program.addCommand(configCommand());