@openbkn/bkn-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,104 @@
+# @openbkn/bkn-sdk
+
+Unified TypeScript SDK + CLI for the **BKN** (Business Knowledge Network) platform.
+One toolkit, two surfaces: the importable SDK and the `openbkn` CLI — both backed
+by the same domain logic. A slim rewrite of the legacy `kweaver-sdk` +
+`kweaver-admin`, merged into one package (the operator CLI lives under
+`openbkn admin`). Backend-only; no web UI.
+
+> Status: every legacy command/subcommand is implemented and full-depth
+> `--help`-equivalent with `kweaver` / `kweaver-admin` (196/196 parity test).
+> Reads + writes across all domains are validated against a live platform; a few
+> paths are environment-gated on the test cluster (EACP `change-password`/`audit`
+> upstream, physical-catalog `create-from-*`, populated trace index) — see
+> `docs/exec-plans/tech-debt-tracker.md`.
+
+## Install
+
+```bash
+npm install -g @openbkn/bkn-sdk   # CLI: `openbkn`
+# or as a library
+npm install @openbkn/bkn-sdk
+```
+
+Requires Node ≥ 22.
+
+## CLI
+
+```bash
+# Log in — attach a token, or OAuth (headless password / browser PKCE)
+openbkn auth login https://your-platform --token "$TOKEN"
+openbkn auth login https://your-platform -u <user> -p <password>   # headless OAuth
+
+# Knowledge networks
+openbkn bkn list
+openbkn bkn get <kn-id> --stats
+openbkn bkn search <kn-id> "customer churn"
+openbkn bkn object-type list <kn-id>
+
+# Data platform
+openbkn resource list --type table
+openbkn vega catalog list
+openbkn dataflow list
+openbkn model llm list
+
+# Agents
+openbkn agent list
+openbkn agent sessions <agent-key>
+
+# Operator (kweaver-admin, nested)
+openbkn admin org list
+openbkn admin role list
+
+# Raw passthrough to any endpoint
+openbkn call /api/ontology-manager/v1/knowledge-networks
+
+# Global flags: --base-url, --token, --user, --json/--compact, -bd/--biz-domain, -k/--insecure
+openbkn --help        # grouped command map
+```
+
+Tokens are stored per platform/user under `~/.bkn/` (override: `BKN_CONFIG_DIR`).
+
+## SDK
+
+```ts
+import { createClient } from "@openbkn/bkn-sdk";
+
+const bkn = createClient({ baseUrl: "https://your-platform", token: process.env.BKN_TOKEN });
+
+const networks = await bkn.kn.list({ limit: 10 });
+const task = await bkn.vega.build({ resource_id: "r-1", mode: "batch" }, { wait: true });
+const raw = await bkn.call("/api/...", { method: "GET" });
+```
+
+Importing the package has no side effects; `createClient` resolves config explicitly.
+
+## Develop
+
+```bash
+npm install
+npm run lint     # biome + tsc --noEmit
+npm test         # vitest (unit; equivalence suite gated by BKN_EQUIV_LIVE)
+npm run build    # tsup → dist/ (library + `openbkn` bin)
+```
+
+## Equivalence with the legacy CLIs
+
+`openbkn` mirrors the installed `kweaver` / `kweaver-admin` command trees
+(`kweaver <x>` → `openbkn <x>`, `kweaver-admin <x>` → `openbkn admin <x>`).
+Golden `--help` baselines and a full-depth parity test live in
+`test/equivalence/` — **196/196** commands match (every node exists and its
+`--help` covers the legacy flags + arguments). Run live with `BKN_EQUIV_LIVE=1`.
+
+## Agent skill
+
+An agent skill (`skills/openbkn-core/SKILL.md`) lets AI tools drive the CLI in
+natural language. Install it with the skills CLI:
+
+```bash
+npx skills add openbkn-ai/bkn-sdk@openbkn-core
+```
+
+## License
+
+Apache-2.0

package/README.zh.md

@@ -0,0 +1,88 @@
+# @openbkn/bkn-sdk
+
+BKN（Business Knowledge Network）平台的统一 TypeScript SDK + CLI。一套工具、两个入口：
+可 import 的 SDK 与 `openbkn` 命令行——共享同一套领域逻辑。这是对旧版
+`kweaver-sdk` + `kweaver-admin` 的精简重写，合并为一个包（运维 CLI 收进
+`openbkn admin` 子命令）。纯后端，无 Web UI。
+
+> 状态：预发布。各域的读命令已实现并在真实平台上验证；部分写操作与 Trace-AI
+> 引擎仍在进行中（见 `docs/exec-plans/tech-debt-tracker.md`）。
+
+## 安装
+
+```bash
+npm install -g @openbkn/bkn-sdk   # CLI：openbkn
+# 或作为库
+npm install @openbkn/bkn-sdk
+```
+
+需要 Node ≥ 22。
+
+## CLI
+
+```bash
+# 登录（附着 token；OAuth 流程待实现）
+openbkn auth login https://你的平台 --token "$TOKEN"
+
+# 知识网络
+openbkn bkn list
+openbkn bkn get <kn-id> --stats
+openbkn bkn search <kn-id> "客户流失"
+openbkn bkn object-type list <kn-id>
+
+# 数据平台
+openbkn resource list --type table
+openbkn vega catalog list
+openbkn dataflow list
+openbkn model llm list
+
+# 智能体
+openbkn agent list
+openbkn agent sessions <agent-key>
+
+# 运维（kweaver-admin，嵌套）
+openbkn admin org list
+openbkn admin role list
+
+# 任意端点的原始透传
+openbkn call /api/ontology-manager/v1/knowledge-networks
+
+# 全局参数：--base-url --token --user --json/--compact -bd/--biz-domain -k/--insecure
+openbkn --help        # 分组命令树
+```
+
+Token 按平台/用户存于 `~/.bkn/`（可用 `BKN_CONFIG_DIR` 覆盖）。
+
+## SDK
+
+```ts
+import { createClient } from "@openbkn/bkn-sdk";
+
+const bkn = createClient({ baseUrl: "https://你的平台", token: process.env.BKN_TOKEN });
+
+const networks = await bkn.kn.list({ limit: 10 });
+const task = await bkn.vega.build({ resource_id: "r-1", mode: "batch" }, { wait: true });
+const raw = await bkn.call("/api/...", { method: "GET" });
+```
+
+import 本包无副作用；`createClient` 显式解析配置。
+
+## 开发
+
+```bash
+npm install
+npm run lint     # biome + tsc --noEmit
+npm test         # vitest（单测；等价套件由 BKN_EQUIV_LIVE 控制）
+npm run build    # tsup → dist/（库 + openbkn bin）
+```
+
+## 与旧 CLI 的一致性
+
+`openbkn` 对齐已安装的 `kweaver` / `kweaver-admin` 命令树
+（`kweaver <x>` → `openbkn <x>`，`kweaver-admin <x>` → `openbkn admin <x>`）。
+全深度 `--help` 黄金基线与一致性测试见 `test/equivalence/`
+（用 `BKN_EQUIV_LIVE=1` 真机跑）。
+
+## 许可证
+
+Apache-2.0