@kweaver-ai/kweaver-sdk 0.4.13 → 0.4.14

package/README.md

@@ -31,6 +31,18 @@ export KWEAVER_BASE_URL=https://your-kweaver-instance.com
 export KWEAVER_TOKEN=your-token
 ```
 
+### Business domain (platform)
+
+Set or verify **before** calling list/query APIs that scope by tenant. DIP deployments often need a UUID, not only `bd_public`.
+
+```bash
+kweaver config show
+kweaver config list-bd
+kweaver config set-bd <uuid>
+```
+
+After `kweaver auth login`, the CLI may auto-select a domain when none is saved yet. Override with `KWEAVER_BUSINESS_DOMAIN` or `-bd` / `--biz-domain` on commands. See [`../../skills/kweaver-core/references/config.md`](../../skills/kweaver-core/references/config.md).
+
 ### Simple API (recommended)
 
 ```typescript
@@ -130,8 +142,8 @@ kweaver auth login <url> [--alias name] [-u user] [-p pass] [--playwright] [--in
 kweaver auth login <url> --client-id ID --client-secret S --refresh-token T   (headless login)
 kweaver auth export [url|alias] [--json]   (export command to run on a headless host)
 kweaver auth status/list/use/delete/logout
+kweaver config show / list-bd / set-bd <value>   # platform business domain — after login
 kweaver token
-kweaver config show / set-bd <value>
 kweaver ds list/get/delete/tables/connect
 kweaver ds import-csv <ds_id> --files <glob> [--table-prefix <p>] [--batch-size 500]
 kweaver dataview list/find/get/query/delete

package/README.zh.md

@@ -31,6 +31,18 @@ export KWEAVER_BASE_URL=https://your-kweaver-instance.com
 export KWEAVER_TOKEN=your-token
 ```
 
+### 业务域（平台配置）
+
+在调用依赖租户范围的接口前，应先确认业务域；DIP 环境通常使用 **UUID**，不能长期只依赖默认 `bd_public`。
+
+```bash
+kweaver config show
+kweaver config list-bd
+kweaver config set-bd <uuid>
+```
+
+`kweaver auth login` 成功后，若尚未配置，CLI 可能自动选择业务域。也可用环境变量 `KWEAVER_BUSINESS_DOMAIN` 或各命令的 `-bd` / `--biz-domain` 覆盖。详见 [`../../skills/kweaver-core/references/config.md`](../../skills/kweaver-core/references/config.md)。
+
 ### 简洁 API（推荐）
 
 ```typescript
@@ -119,6 +131,7 @@ kweaver auth login <url> [--alias name] [-u user] [-p pass] [--playwright] [--in
 kweaver auth login <url> --client-id ID --client-secret S --refresh-token T   (无浏览器登录)
 kweaver auth export [url|alias] [--json]   (导出在无浏览器机器上运行的命令)
 kweaver auth status/list/use/delete/logout
+kweaver config show / list-bd / set-bd <value>   # 平台业务域，登录后优先
 kweaver token
 kweaver ds list/get/delete/tables/connect
 kweaver dataview list/find/get/query/delete

package/dist/api/business-domains.d.ts

@@ -0,0 +1,20 @@
+/** One business domain entry from GET /api/business-system/v1/business-domain */
+export interface BusinessDomain {
+    id: string;
+    name?: string;
+    description?: string;
+    creator?: string;
+    products?: string[];
+    create_time?: string;
+}
+export interface ListBusinessDomainsOptions {
+    baseUrl: string;
+    accessToken: string;
+    /** When true, skip TLS verification (matches `--insecure` login). */
+    tlsInsecure?: boolean;
+}
+/**
+ * List business domains for the authenticated user. Does not send x-business-domain
+ * (the endpoint returns all domains the user can access).
+ */
+export declare function listBusinessDomains(options: ListBusinessDomainsOptions): Promise<BusinessDomain[]>;

package/dist/api/business-domains.js

@@ -0,0 +1,54 @@
+import { HttpError } from "../utils/http.js";
+async function withTlsInsecure(tlsInsecure, fn) {
+    if (!tlsInsecure) {
+        return fn();
+    }
+    const prev = process.env.NODE_TLS_REJECT_UNAUTHORIZED;
+    process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
+    try {
+        return await fn();
+    }
+    finally {
+        if (prev === undefined) {
+            delete process.env.NODE_TLS_REJECT_UNAUTHORIZED;
+        }
+        else {
+            process.env.NODE_TLS_REJECT_UNAUTHORIZED = prev;
+        }
+    }
+}
+/**
+ * List business domains for the authenticated user. Does not send x-business-domain
+ * (the endpoint returns all domains the user can access).
+ */
+export async function listBusinessDomains(options) {
+    const { baseUrl, accessToken, tlsInsecure } = options;
+    const base = baseUrl.replace(/\/+$/, "");
+    const url = `${base}/api/business-system/v1/business-domain`;
+    return withTlsInsecure(tlsInsecure, async () => {
+        const response = await fetch(url, {
+            method: "GET",
+            headers: {
+                accept: "application/json, text/plain, */*",
+                authorization: `Bearer ${accessToken}`,
+                token: accessToken,
+            },
+        });
+        const body = await response.text();
+        if (!response.ok) {
+            throw new HttpError(response.status, response.statusText, body);
+        }
+        const data = JSON.parse(body);
+        if (!Array.isArray(data)) {
+            throw new Error("Business domain list response was not a JSON array.");
+        }
+        return data.map((item) => {
+            const row = item;
+            const id = row.id;
+            if (typeof id !== "string" || id.length === 0) {
+                throw new Error("Business domain entry missing string id.");
+            }
+            return item;
+        });
+    });
+}

package/dist/auth/oauth.d.ts

@@ -60,6 +60,15 @@ export declare function refreshTokenLogin(baseUrl: string, options: {
  * Persists the new token to ~/.kweaver/ and returns it.
  */
 export declare function refreshAccessToken(token: TokenConfig): Promise<TokenConfig>;
+/**
+ * Resolve a usable access token for the current platform.
+ *
+ * **Default behavior** (saved `~/.kweaver/` session from OAuth2 code login): when the access
+ * token is expired or near expiry, automatically exchanges the saved **refresh_token** for a new
+ * access token (OAuth2 `refresh_token` grant) and persists it. No extra flags are required.
+ *
+ * Static env `KWEAVER_TOKEN` bypasses refresh (see implementation).
+ */
 export declare function ensureValidToken(opts?: {
     forceRefresh?: boolean;
 }): Promise<TokenConfig>;

package/dist/auth/oauth.js

@@ -592,6 +592,15 @@ export async function refreshAccessToken(token) {
     saveTokenConfig(newToken);
     return newToken;
 }
+/**
+ * Resolve a usable access token for the current platform.
+ *
+ * **Default behavior** (saved `~/.kweaver/` session from OAuth2 code login): when the access
+ * token is expired or near expiry, automatically exchanges the saved **refresh_token** for a new
+ * access token (OAuth2 `refresh_token` grant) and persists it. No extra flags are required.
+ *
+ * Static env `KWEAVER_TOKEN` bypasses refresh (see implementation).
+ */
 export async function ensureValidToken(opts) {
     const envToken = process.env.KWEAVER_TOKEN;
     const envBaseUrl = process.env.KWEAVER_BASE_URL;

package/dist/cli.js

@@ -77,6 +77,7 @@ Usage:
   kweaver bkn action-log list|get|cancel <kn-id> ...
 
   kweaver config set-bd <value>
+  kweaver config list-bd
   kweaver config show
 
   kweaver vega health|stats|inspect

package/dist/commands/auth.js

@@ -1,4 +1,4 @@
-import { clearPlatformSession, deletePlatform, getConfigDir, getCurrentPlatform, getPlatformAlias, hasPlatform, listPlatforms, loadClientConfig, loadTokenConfig, resolvePlatformIdentifier, setCurrentPlatform, setPlatformAlias, } from "../config/store.js";
+import { autoSelectBusinessDomain, clearPlatformSession, deletePlatform, getConfigDir, getCurrentPlatform, getPlatformAlias, hasPlatform, listPlatforms, loadClientConfig, loadTokenConfig, resolvePlatformIdentifier, setCurrentPlatform, setPlatformAlias, } from "../config/store.js";
 import { buildCopyCommand, formatHttpError, normalizeBaseUrl, oauth2Login, playwrightLogin, refreshTokenLogin, } from "../auth/oauth.js";
 export async function runAuthCommand(args) {
     const target = args[0];
@@ -115,6 +115,10 @@ Login options:
             if (token.expiresAt) {
                 console.log(`Token expires at: ${token.expiresAt}`);
             }
+            const selectedBd = await autoSelectBusinessDomain(normalizedTarget, token.accessToken, {
+                tlsInsecure: token.tlsInsecure,
+            });
+            console.log(`Business domain: ${selectedBd}`);
             return 0;
         }
         catch (error) {

package/dist/commands/config.js

@@ -1,13 +1,17 @@
-import { getCurrentPlatform, resolveBusinessDomain, savePlatformBusinessDomain, loadPlatformBusinessDomain, } from "../config/store.js";
+import { listBusinessDomains } from "../api/business-domains.js";
+import { withTokenRetry } from "../auth/oauth.js";
+import { getCurrentPlatform, loadPlatformBusinessDomain, resolveBusinessDomain, savePlatformBusinessDomain, } from "../config/store.js";
 const HELP = `kweaver config
 
 Subcommands:
   set-bd <value>    Set the default business domain for the current platform
+  list-bd           List business domains as JSON (requires login)
   show              Show current config (platform, business domain)
   --help            Show this message
 
 Examples:
   kweaver config set-bd 54308785-4438-43df-9490-a7fd11df5765
+  kweaver config list-bd
   kweaver config show`;
 export async function runConfigCommand(args) {
     const [sub, ...rest] = args;
@@ -46,6 +50,35 @@ export async function runConfigCommand(args) {
         console.log(`Business domain set to: ${value}`);
         return 0;
     }
+    if (sub === "list-bd") {
+        const platform = getCurrentPlatform();
+        if (!platform) {
+            console.error("No active platform. Run `kweaver auth login <url>` first.");
+            return 1;
+        }
+        try {
+            const rows = await withTokenRetry((token) => listBusinessDomains({
+                baseUrl: platform,
+                accessToken: token.accessToken,
+                tlsInsecure: token.tlsInsecure,
+            }));
+            const currentId = resolveBusinessDomain(platform);
+            const payload = {
+                currentId,
+                domains: rows.map((r) => ({
+                    ...r,
+                    current: r.id === currentId,
+                })),
+            };
+            console.log(JSON.stringify(payload, null, 2));
+            return 0;
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            console.error(`Failed to list business domains: ${message}`);
+            return 1;
+        }
+    }
     console.error(`Unknown config subcommand: ${sub}`);
     console.log(HELP);
     return 1;

package/dist/config/store.d.ts

@@ -78,3 +78,11 @@ export declare function savePlatformBusinessDomain(baseUrl: string, businessDoma
  * If baseUrl is omitted, uses the current platform.
  */
 export declare function resolveBusinessDomain(baseUrl?: string): string;
+/**
+ * Pick and persist a default business domain after login when none is configured.
+ * Skips API calls when KWEAVER_BUSINESS_DOMAIN is set or config already has businessDomain.
+ * Preference: bd_public if present in the list, else first item; empty list or failure → bd_public (not saved).
+ */
+export declare function autoSelectBusinessDomain(baseUrl: string, accessToken: string, options?: {
+    tlsInsecure?: boolean;
+}): Promise<string>;

package/dist/config/store.js

@@ -1,6 +1,7 @@
 import { chmodSync, existsSync, mkdirSync, readFileSync, readdirSync, rmSync, statSync, writeFileSync, } from "node:fs";
 import { homedir } from "node:os";
 import { join } from "node:path";
+import { listBusinessDomains } from "../api/business-domains.js";
 const MCP_PATH = "/api/agent-retrieval/v1/mcp";
 function buildMcpUrl(baseUrl) {
     return baseUrl.replace(/\/+$/, "") + MCP_PATH;
@@ -394,3 +395,41 @@ export function resolveBusinessDomain(baseUrl) {
     }
     return "bd_public";
 }
+/**
+ * Pick and persist a default business domain after login when none is configured.
+ * Skips API calls when KWEAVER_BUSINESS_DOMAIN is set or config already has businessDomain.
+ * Preference: bd_public if present in the list, else first item; empty list or failure → bd_public (not saved).
+ */
+export async function autoSelectBusinessDomain(baseUrl, accessToken, options) {
+    if (process.env.KWEAVER_BUSINESS_DOMAIN) {
+        return process.env.KWEAVER_BUSINESS_DOMAIN;
+    }
+    const configured = loadPlatformBusinessDomain(baseUrl);
+    if (configured) {
+        return configured;
+    }
+    try {
+        const list = await listBusinessDomains({
+            baseUrl,
+            accessToken,
+            tlsInsecure: options?.tlsInsecure,
+        });
+        let selected;
+        if (list.some((d) => d.id === "bd_public")) {
+            selected = "bd_public";
+        }
+        else if (list.length > 0 && list[0].id) {
+            selected = list[0].id;
+        }
+        else {
+            return "bd_public";
+        }
+        savePlatformBusinessDomain(baseUrl, selected);
+        return selected;
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        console.warn(`Could not fetch business domains: ${message}. Using bd_public.`);
+        return "bd_public";
+    }
+}

package/dist/index.d.ts

@@ -52,6 +52,8 @@ export { ContextLoaderResource } from "./resources/context-loader.js";
 export type { ViewField, DataView, CreateDataViewOptions, GetDataViewOptions, ListDataViewsOptions, DeleteDataViewOptions, FindDataViewOptions, QueryDataViewOptions, DataViewQueryResult, } from "./api/dataviews.js";
 export { parseDataView, createDataView, getDataView, listDataViews, deleteDataView, findDataView, queryDataView, } from "./api/dataviews.js";
 export { DataViewsResource } from "./resources/dataviews.js";
+export type { BusinessDomain, ListBusinessDomainsOptions } from "./api/business-domains.js";
+export { listBusinessDomains } from "./api/business-domains.js";
 export { HttpError, NetworkRequestError, fetchTextOrThrow } from "./utils/http.js";
 export type { TokenConfig, ContextLoaderEntry, ContextLoaderConfig, } from "./config/store.js";
-export { getConfigDir, getCurrentPlatform } from "./config/store.js";
+export { autoSelectBusinessDomain, getConfigDir, getCurrentPlatform } from "./config/store.js";

package/dist/index.js

@@ -41,6 +41,7 @@ export { ConversationsResource } from "./resources/conversations.js";
 export { ContextLoaderResource } from "./resources/context-loader.js";
 export { parseDataView, createDataView, getDataView, listDataViews, deleteDataView, findDataView, queryDataView, } from "./api/dataviews.js";
 export { DataViewsResource } from "./resources/dataviews.js";
+export { listBusinessDomains } from "./api/business-domains.js";
 // ── HTTP utilities ────────────────────────────────────────────────────────────
 export { HttpError, NetworkRequestError, fetchTextOrThrow } from "./utils/http.js";
-export { getConfigDir, getCurrentPlatform } from "./config/store.js";
+export { autoSelectBusinessDomain, getConfigDir, getCurrentPlatform } from "./config/store.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kweaver-ai/kweaver-sdk",
-  "version": "0.4.13",
+  "version": "0.4.14",
   "description": "KWeaver TypeScript SDK — CLI tool and programmatic API for knowledge networks and Decision Agents.",
   "type": "module",
   "main": "./dist/index.js",