@kweaver-ai/kweaver-sdk 0.4.1 → 0.4.2

package/dist/commands/bkn.js

@@ -1,11 +1,15 @@
 import { createInterface } from "node:readline";
-import { readFileSync } from "node:fs";
+import { spawnSync } from "node:child_process";
+import { mkdirSync, readFileSync, readdirSync, statSync } from "node:fs";
+import { resolve } from "node:path";
+import { loadNetwork, allObjects, allRelations, allActions, generateChecksum } from "@kweaver-ai/bkn";
 import { ensureValidToken, formatHttpError } from "../auth/oauth.js";
 import { listKnowledgeNetworks, getKnowledgeNetwork, createKnowledgeNetwork, updateKnowledgeNetwork, deleteKnowledgeNetwork, listObjectTypes, listRelationTypes, listActionTypes, getObjectType, createObjectTypes, updateObjectType, deleteObjectTypes, getRelationType, createRelationTypes, updateRelationType, deleteRelationTypes, buildKnowledgeNetwork, getBuildStatus, } from "../api/knowledge-networks.js";
 import { objectTypeQuery, objectTypeProperties, subgraph, actionTypeQuery, actionTypeExecute, actionExecutionGet, actionLogsList, actionLogGet, actionLogCancel, } from "../api/ontology-query.js";
 import { semanticSearch } from "../api/semantic-search.js";
 import { listTablesWithColumns } from "../api/datasources.js";
 import { createDataView } from "../api/dataviews.js";
+import { downloadBkn, uploadBkn } from "../api/bkn-backend.js";
 import { formatCallOutput } from "./call.js";
 export function formatSimpleKnList(text, pretty, includeDetail = false) {
     const parsed = JSON.parse(text);
@@ -338,6 +342,92 @@ export function parseKnDeleteArgs(args) {
     }
     return { knId, businessDomain, yes };
 }
+export function parseKnPushArgs(args) {
+    let directory = "";
+    let branch = "main";
+    let businessDomain = "bd_public";
+    let pretty = true;
+    for (let i = 0; i < args.length; i += 1) {
+        const arg = args[i];
+        if (arg === "--help" || arg === "-h") {
+            throw new Error("help");
+        }
+        if (arg === "--branch") {
+            branch = args[i + 1] ?? "main";
+            if (!branch || branch.startsWith("-")) {
+                throw new Error("Missing value for --branch");
+            }
+            i += 1;
+            continue;
+        }
+        if (arg === "-bd" || arg === "--biz-domain") {
+            businessDomain = args[i + 1] ?? "bd_public";
+            if (!businessDomain || businessDomain.startsWith("-")) {
+                throw new Error("Missing value for biz-domain flag");
+            }
+            i += 1;
+            continue;
+        }
+        if (arg === "--pretty") {
+            pretty = true;
+            continue;
+        }
+        if (!arg.startsWith("-") && !directory) {
+            directory = arg;
+            continue;
+        }
+        throw new Error(`Unsupported bkn push argument: ${arg}`);
+    }
+    if (!directory) {
+        throw new Error("Missing directory. Usage: kweaver bkn push <directory> [--branch main] [-bd value]");
+    }
+    return { directory, branch, businessDomain, pretty };
+}
+export function parseKnPullArgs(args) {
+    let knId = "";
+    let directory = "";
+    let branch = "main";
+    let businessDomain = "bd_public";
+    for (let i = 0; i < args.length; i += 1) {
+        const arg = args[i];
+        if (arg === "--help" || arg === "-h") {
+            throw new Error("help");
+        }
+        if (arg === "--branch") {
+            branch = args[i + 1] ?? "main";
+            if (!branch || branch.startsWith("-")) {
+                throw new Error("Missing value for --branch");
+            }
+            i += 1;
+            continue;
+        }
+        if (arg === "-bd" || arg === "--biz-domain") {
+            businessDomain = args[i + 1] ?? "bd_public";
+            if (!businessDomain || businessDomain.startsWith("-")) {
+                throw new Error("Missing value for biz-domain flag");
+            }
+            i += 1;
+            continue;
+        }
+        if (!arg.startsWith("-")) {
+            if (!knId) {
+                knId = arg;
+            }
+            else if (!directory) {
+                directory = arg;
+            }
+            else {
+                throw new Error(`Unexpected positional argument: ${arg}`);
+            }
+            continue;
+        }
+        throw new Error(`Unsupported bkn pull argument: ${arg}`);
+    }
+    if (!knId) {
+        throw new Error("Missing kn-id. Usage: kweaver bkn pull <kn-id> [<directory>] [--branch main] [-bd value]");
+    }
+    return { knId, directory: directory || knId, branch, businessDomain };
+}
 function parseJsonObject(text, errorMessage) {
     let parsed;
     try {
@@ -443,6 +533,8 @@ Subcommands:
   update <kn-id> [options]  Update a knowledge network
   delete <kn-id>       Delete a knowledge network
   build <kn-id> [--wait|--no-wait] [--timeout n]   Trigger full build
+  push <directory> [--branch main]   Upload BKN directory as tar
+  pull <kn-id> [<directory>] [--branch main]   Download BKN tar and extract
   export <kn-id>       Export knowledge network (alias for get --export)
   stats <kn-id>        Get statistics (alias for get --stats)
   search <kn-id> <query> [options]   Semantic search within a knowledge network
@@ -452,7 +544,7 @@ Subcommands:
   object-type update <kn-id> <ot-id> [options]   Update object type
   object-type delete <kn-id> <ot-ids> [-y]   Delete object type(s)
   object-type query <kn-id> <ot-id> ['<json>']   Query object instances (ontology-query; supports --limit/--search-after)
-  object-type properties <kn-id> <ot-id> '<json>'   Query object properties
+  object-type properties <kn-id> <ot-id> '<json>'   Query instance properties (json: {"_instance_identities":[{pk:val}],"properties":[...]})
   relation-type list <kn-id>   List relation types (schema)
   relation-type get <kn-id> <rt-id>   Get relation type details
   relation-type create <kn-id> [options]   Create relation type (--name --source --target [--mapping src:tgt])
@@ -495,6 +587,12 @@ export async function runKnCommand(args) {
     if (subcommand === "build") {
         return runKnBuildCommand(rest);
     }
+    if (subcommand === "push") {
+        return runKnPushCommand(rest);
+    }
+    if (subcommand === "pull") {
+        return runKnPullCommand(rest);
+    }
     if (subcommand === "export") {
         return runKnGetCommand([...(rest[0] ? [rest[0]] : []), "--export", ...rest.slice(1)]);
     }
@@ -791,7 +889,9 @@ kweaver bkn object-type properties <kn-id> <ot-id> '<json>' [--pretty] [-bd valu
 list: List object types (schema) from ontology-manager.
 get: Get single object type details.
 create/update/delete: Schema CRUD (create requires dataview-id).
-query/properties: Query via ontology-query API. For query, --limit and --search-after are merged into the JSON body.`);
+query/properties: Query via ontology-query API. For query, --limit and --search-after are merged into the JSON body.
+
+properties JSON format: {"_instance_identities":[{"<primary-key>":"<value>"}],"properties":["prop1","prop2"]}`);
         return 0;
     }
     try {
@@ -896,7 +996,8 @@ query/properties: Query via ontology-query API. For query, --limit and --search-
             const parsed = parseOntologyQueryFlags(rest);
             const [knId, otId, body] = parsed.filteredArgs;
             if (!knId || !otId || !body) {
-                console.error("Usage: kweaver bkn object-type properties <kn-id> <ot-id> '<json>' [options]");
+                console.error(`Usage: kweaver bkn object-type properties <kn-id> <ot-id> '<json>' [options]
+JSON: {"_instance_identities":[{"<primary-key>":"<value>"}],"properties":["prop1","prop2"]}`);
                 return 1;
             }
             const token = await ensureValidToken();
@@ -1189,6 +1290,17 @@ Query subgraph via ontology-query API. JSON body format see references/json-form
         return 1;
     }
     try {
+        // Auto-detect query_type=relation_path when body contains source_object_type_id
+        let queryType;
+        try {
+            const parsedBody = JSON.parse(body);
+            if (parsedBody.source_object_type_id) {
+                queryType = "relation_path";
+            }
+        }
+        catch {
+            // Not valid JSON — let the API return the error
+        }
         const token = await ensureValidToken();
         const result = await subgraph({
             baseUrl: token.baseUrl,
@@ -1196,6 +1308,7 @@ Query subgraph via ontology-query API. JSON body format see references/json-form
             knId,
             body,
             businessDomain,
+            queryType,
         });
         console.log(formatCallOutput(result, pretty));
         return 0;
@@ -2048,6 +2161,148 @@ async function runKnBuildCommand(args) {
         return 1;
     }
 }
+// ── push / pull (BKN tar import/export) ──────────────────────────────────────
+export function packDirectoryToTar(dirPath) {
+    const absPath = resolve(dirPath);
+    const entries = readdirSync(absPath);
+    const args = ["cf", "-", "-C", absPath, ...entries];
+    const result = spawnSync("tar", args, {
+        encoding: "buffer",
+        env: { ...process.env, COPYFILE_DISABLE: "1" },
+    });
+    if (result.error)
+        throw result.error;
+    if (result.status !== 0) {
+        throw new Error(`tar pack failed: ${result.stderr?.toString() ?? result.status}`);
+    }
+    return result.stdout;
+}
+export function extractTarToDirectory(tarBuffer, dirPath) {
+    const absPath = resolve(dirPath);
+    mkdirSync(absPath, { recursive: true });
+    const result = spawnSync("tar", ["xf", "-", "-C", absPath], {
+        input: tarBuffer,
+    });
+    if (result.error) {
+        throw result.error;
+    }
+    if (result.status !== 0) {
+        throw new Error(`tar extract failed: ${result.stderr?.toString() ?? result.status}`);
+    }
+}
+const KN_PUSH_HELP = `kweaver bkn push <directory> [options]
+
+Pack a BKN directory into a tar and upload to import as a knowledge network.
+
+Options:
+  --branch <s>       Branch name (default: main)
+  -bd, --biz-domain  Business domain (default: bd_public)
+  --pretty           Pretty-print JSON output`;
+const KN_PULL_HELP = `kweaver bkn pull <kn-id> [<directory>] [options]
+
+Download a BKN tar from a knowledge network and extract to a local directory.
+
+Options:
+  <directory>        Output directory (default: <kn-id>)
+  --branch <s>       Branch name (default: main)
+  -bd, --biz-domain  Business domain (default: bd_public)`;
+async function runKnPushCommand(args) {
+    let options;
+    try {
+        options = parseKnPushArgs(args);
+    }
+    catch (error) {
+        if (error instanceof Error && error.message === "help") {
+            console.log(KN_PUSH_HELP);
+            return 0;
+        }
+        console.error(formatHttpError(error));
+        return 1;
+    }
+    const absDir = resolve(options.directory);
+    try {
+        const stat = statSync(absDir);
+        if (!stat.isDirectory()) {
+            console.error(`Not a directory: ${options.directory}`);
+            return 1;
+        }
+    }
+    catch (err) {
+        if (err && typeof err === "object" && "code" in err && err.code === "ENOENT") {
+            console.error(`Directory not found: ${options.directory}`);
+            return 1;
+        }
+        throw err;
+    }
+    try {
+        const network = await loadNetwork(absDir);
+        const objs = allObjects(network);
+        const rels = allRelations(network);
+        const acts = allActions(network);
+        console.error(`Validated: ${objs.length} object types, ${rels.length} relation types, ${acts.length} action types`);
+    }
+    catch (error) {
+        console.error(`BKN validation failed: ${error instanceof Error ? error.message : String(error)}`);
+        return 1;
+    }
+    try {
+        await generateChecksum(absDir);
+        console.error("Checksum generated");
+    }
+    catch (error) {
+        console.error(`Checksum generation failed: ${error instanceof Error ? error.message : String(error)}`);
+        return 1;
+    }
+    try {
+        const tarBuffer = packDirectoryToTar(absDir);
+        const token = await ensureValidToken();
+        const body = await uploadBkn({
+            baseUrl: token.baseUrl,
+            accessToken: token.accessToken,
+            tarBuffer,
+            businessDomain: options.businessDomain,
+            branch: options.branch,
+        });
+        console.log(formatCallOutput(body, options.pretty));
+        return 0;
+    }
+    catch (error) {
+        console.error(formatHttpError(error));
+        return 1;
+    }
+}
+async function runKnPullCommand(args) {
+    let options;
+    try {
+        options = parseKnPullArgs(args);
+    }
+    catch (error) {
+        if (error instanceof Error && error.message === "help") {
+            console.log(KN_PULL_HELP);
+            return 0;
+        }
+        console.error(formatHttpError(error));
+        return 1;
+    }
+    try {
+        const token = await ensureValidToken();
+        const tarBuffer = await downloadBkn({
+            baseUrl: token.baseUrl,
+            accessToken: token.accessToken,
+            knId: options.knId,
+            businessDomain: options.businessDomain,
+            branch: options.branch,
+        });
+        const absDir = resolve(options.directory);
+        extractTarToDirectory(tarBuffer, absDir);
+        console.log(`Extracted to ${absDir}`);
+        return 0;
+    }
+    catch (error) {
+        console.error(formatHttpError(error));
+        return 1;
+    }
+}
 // ── search ──────────────────────────────────────────────────────────────────
 const KN_SEARCH_HELP = `kweaver bkn search <kn-id> <query> [--max-concepts <n>] [--mode <mode>] [--pretty] [-bd value]
 

package/dist/commands/call.js

@@ -42,7 +42,7 @@ export function parseCallArgs(args) {
             pretty = true;
             continue;
         }
-        if (arg === "--verbose") {
+        if (arg === "-v" || arg === "--verbose") {
             verbose = true;
             continue;
         }
@@ -113,6 +113,21 @@ export function formatVerboseRequest(invocation) {
     return lines;
 }
 export async function runCallCommand(args) {
+    if (args.length === 0 || args[0] === "--help" || args[0] === "-h") {
+        console.log(`kweaver call <url> [-X METHOD] [-H "Name: value"] [-d BODY] [--pretty] [--verbose] [-bd value]
+
+Call an API with curl-style flags and auto-injected token headers.
+
+Options:
+  <url>              API path (e.g. /api/ontology-manager/v1/knowledge-networks)
+  -X, --request      HTTP method (default: GET)
+  -H, --header       Extra header (repeatable)
+  -d, --data         JSON request body
+  -bd, --biz-domain  Override x-business-domain (default: bd_public)
+  -v, --verbose      Print request info to stderr
+  --pretty           Pretty-print JSON output (default)`);
+        return 0;
+    }
     let invocation;
     try {
         invocation = parseCallArgs(args);
@@ -123,6 +138,10 @@ export async function runCallCommand(args) {
     }
     try {
         const token = await ensureValidToken();
+        // Prepend baseUrl when the URL is a relative path (no scheme)
+        if (invocation.url.startsWith("/")) {
+            invocation.url = token.baseUrl.replace(/\/+$/, "") + invocation.url;
+        }
         injectAuthHeaders(invocation.headers, token.accessToken, invocation.businessDomain);
         if (invocation.verbose) {
             for (const line of formatVerboseRequest(invocation)) {

package/dist/commands/vega.d.ts

@@ -0,0 +1 @@
+export declare function runVegaCommand(args: string[]): Promise<number>;