@openbkn/bkn-sdk 0.1.1-alpha.13 → 0.1.1-alpha.15

package/LICENSE

@@ -1,201 +1,132 @@
-                                 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.
+OpenBKN License
+
+BKN SDK is part of the OpenBKN project and is licensed under the
+OpenBKN License — a modified version of the Apache License, Version 2.0,
+with the following additional conditions.
+
+Copyright (c) 2026 OpenBKN. All rights reserved.
+
+================================================================
+PREAMBLE
+================================================================
+
+This license applies only to the OpenBKN modules that expressly
+reference this file in their source headers (the "Licensed Modules"),
+including but not limited to BKN Safe and BKN SDK.
+
+The Licensed Modules are licensed under the terms of the Apache
+License, Version 2.0 (the "Apache License"), the full text of which is
+available at http://www.apache.org/licenses/LICENSE-2.0, as modified and
+supplemented by the Additional Conditions set out below.
+
+In the event of any conflict between the Additional Conditions and the
+Apache License, the Additional Conditions shall control with respect to
+the Licensed Modules.
+
+This license does not apply to:
+  (a) components that originate from the upstream project
+      kweaver-ai/kweaver-core, which remain licensed solely under the
+      Apache License, Version 2.0, with their original copyright
+      notices preserved; nor
+  (b) OpenBKN components expressly licensed under the plain Apache
+      License, Version 2.0 (e.g., BKN SDK / CLI and BKN Skill).
+See the NOTICE file for the per-component breakdown.
+
+================================================================
+ADDITIONAL CONDITIONS
+================================================================
+
+1. Commercial Use.
+
+   The Licensed Modules may be used for commercial purposes, including
+   as a component within your own application or business. However, a
+   separate commercial license must be obtained from OpenBKN if any
+   of the following conditions applies:
+
+   a. Service Restriction. You may not, without prior written
+      authorization from OpenBKN, use the source code of the Licensed
+      Modules to provide to third parties a hosted service, a managed
+      or operated service, or any service that is the same as or
+      substantially similar to the official services offered by
+      OpenBKN. For the purposes of this license, "providing a
+      service to third parties" means making the substantial features
+      or functionality of the Licensed Modules available to parties
+      other than your own organization, whether for a fee or free of
+      charge, including by means of hosting, operation, deployment, or
+      integration carried out on their behalf as a commercial activity.
+
+   b. Multi-Tenant Restriction. Where applicable, you may not use the
+      Licensed Modules to operate a multi-tenant service environment in
+      which separate third-party tenants are provided with isolated
+      access to the Licensed Modules' features or functionality.
+
+2. Logo and Copyright Notices.
+
+   When using the front end or console of the Licensed Modules, you may
+   not remove or modify the OpenBKN logo, trademarks, or copyright and
+   licensing notices displayed therein. This condition does not apply
+   to uses of the Licensed Modules that do not involve their front end
+   or console.
+
+3. Contributions.
+
+   Code that you contribute to the Licensed Modules may be used by
+   OpenBKN for any purpose, including commercial purposes and
+   OpenBKN's cloud or hosted business, and may be licensed by
+   OpenBKN under any terms. By submitting a contribution, you
+   represent that you have the right to grant, and you grant to
+   OpenBKN, a perpetual, worldwide, non-exclusive, royalty-free,
+   irrevocable license to use, reproduce, modify, distribute, and
+   relicense your contribution for such purposes.
+
+4. Adjustment of Terms.
+
+   OpenBKN may adjust the terms of this license, making them either
+   more or less restrictive, for future versions of the Licensed
+   Modules. Any such adjustment applies only to versions released after
+   the adjustment; it does not retroactively alter the terms applicable
+   to versions already released.
+
+5. Trademarks.
+
+   This license does not grant you any right to use the trade names,
+   trademarks, service marks, or product names of OpenBKN, except as
+   required by Section 2 above or for the reasonable and customary use
+   in describing the origin of the Licensed Modules.
+
+6. Effect of Apache License.
+
+   Except as expressly modified or supplemented by the Additional
+   Conditions above, all other rights granted and conditions imposed by
+   the Apache License, Version 2.0 (including its disclaimers of
+   warranty and limitations of liability) continue to apply to the
+   Licensed Modules. Nothing in the Additional Conditions shall be
+   construed as restricting the rights of any party under the Apache
+   License, Version 2.0 with respect to code that is not part of the
+   Licensed Modules.
+
+7. Termination.
+
+   Any use of the Licensed Modules in violation of the Additional
+   Conditions above automatically terminates the additional rights
+   granted to you under this license for the Licensed Modules. To
+   continue, you must either bring your use into compliance, obtain a
+   commercial license from OpenBKN, or cease using the Licensed
+   Modules.
+
+================================================================
+COMMERCIAL LICENSING
+================================================================
+
+For commercial licensing inquiries (including authorization to provide
+services, operate multi-tenant environments, or other uses requiring a
+commercial license), contact: <CONTACT EMAIL / URL>
+
+================================================================
+DISCLAIMER
+================================================================
+
+THE LICENSED MODULES ARE PROVIDED ON AN "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, TO THE
+FULLEST EXTENT PERMITTED BY APPLICABLE LAW, AS SET OUT IN THE APACHE
+LICENSE, VERSION 2.0.

package/README.md

@@ -2,15 +2,14 @@
 
 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
+by the same domain logic. A single unified CLI for the BKN platform, with the
+operator surface nested under `openbkn admin`. Backend-only; no web UI.
+
+> Status: every command/subcommand is implemented and self-consistent, with a
+> full-depth grouped `--help` for every node. 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
@@ -46,7 +45,7 @@ openbkn model llm list
 openbkn agent list
 openbkn agent sessions <agent-key>
 
-# Operator (kweaver-admin, nested)
+# Operator (nested)
 openbkn admin org list
 openbkn admin role list
 
@@ -82,13 +81,13 @@ npm test         # vitest (unit; equivalence suite gated by BKN_EQUIV_LIVE)
 npm run build    # tsup → dist/ (library + `openbkn` bin)
 ```
 
-## Equivalence with the legacy CLIs
+## Help system
 
-`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`.
+Every command, subcommand, and sub-subcommand ships a grouped `--help` that
+lists its flags and arguments, so the tree is discoverable end to end. Golden
+`--help` baselines and a full-depth self-consistency test live in
+`test/equivalence/` (every node exists and its `--help` covers its flags +
+arguments). Run live with `BKN_EQUIV_LIVE=1`.
 
 ## Agent skill
 
@@ -99,21 +98,32 @@ command-group map, examples, and cautions) plus per-domain cheat sheets under
 `references/` (auth, bkn, agent, model, vega, resource, dataflow, context,
 skill, toolbox, trace, admin, call) and two how-tos (build-a-KN, troubleshooting).
 
-The skill is **not** part of the npm package — it's registered separately:
+A second skill, `skills/create-bkn/`, guides an AI through **authoring** a BKN
+definition tree (`network.bkn` + typed `object_types/` / `relation_types/` /
+`action_types/` / `concept_groups/` files, per the v2.0.1 spec) — with the
+format spec, templates, and a worked example under `references/`. It pairs with
+the `openbkn` skill, which then runs `openbkn bkn validate` / `push` on the
+tree it produced.
+
+Neither skill is part of the npm package — they're registered separately:
 
 ```bash
-# Install the skill (globally), then ask in natural language:
-npx skills add openbkn-ai/bkn-sdk@openbkn -g -y
+# Install a skill (globally), then ask in natural language:
+npx skills add openbkn-ai/bkn-sdk@openbkn -g -y      # operate the platform
+npx skills add openbkn-ai/bkn-sdk@create-bkn -g -y   # author .bkn files
 
 #   "列出所有知识网络"  /  "list all knowledge networks"
 #   "从 Vega catalog vcat-1 建一个名为 customers 的知识网络并构建索引"
-#   "诊断会话 conv-123 的 trace，带 LLM 判定"
+#   "帮我建一个描述订单域的 BKN 知识网络文件"  /  "author a BKN network for the orders domain"
 ```
 
-The skill assumes the `openbkn` CLI is installed (`npm i -g @openbkn/bkn-sdk`)
-and you are logged in (`openbkn auth login`). It always defers to live
-`openbkn <group> <sub> --help` for exact flags.
+The `openbkn` skill assumes the `openbkn` CLI is installed (`npm i -g
+@openbkn/bkn-sdk`) and you are logged in (`openbkn auth login`). It always defers
+to live `openbkn <group> <sub> --help` for exact flags.
 
 ## License
 
-Apache-2.0
+BKN SDK is part of the OpenBKN project and is licensed under the **OpenBKN
+License** — a modified version of the Apache License, Version 2.0, with
+additional conditions. See [LICENSE](LICENSE) and [NOTICE](NOTICE). Versions
+previously distributed under Apache-2.0 remain available under that license.

package/README.zh.md

@@ -1,9 +1,8 @@
 # @openbkn/bkn-sdk
 
 BKN（Business Knowledge Network）平台的统一 TypeScript SDK + CLI。一套工具、两个入口：
-可 import 的 SDK 与 `openbkn` 命令行——共享同一套领域逻辑。这是对旧版
-`kweaver-sdk` + `kweaver-admin` 的精简重写，合并为一个包（运维 CLI 收进
-`openbkn admin` 子命令）。纯后端，无 Web UI。
+可 import 的 SDK 与 `openbkn` 命令行——共享同一套领域逻辑。面向 BKN 平台的
+统一命令行工具，运维面收进 `openbkn admin` 子命令。纯后端，无 Web UI。
 
 > 状态：预发布。各域的读命令已实现并在真实平台上验证；部分写操作与 Trace-AI
 > 引擎仍在进行中（见 `docs/exec-plans/tech-debt-tracker.md`）。
@@ -40,7 +39,7 @@ openbkn model llm list
 openbkn agent list
 openbkn agent sessions <agent-key>
 
-# 运维（kweaver-admin，嵌套）
+# 运维（嵌套）
 openbkn admin org list
 openbkn admin role list
 
@@ -76,13 +75,15 @@ 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` 真机跑）。
+每个命令、子命令、孙命令都带分组 `--help`，列出各自的参数与位置参数，
+整棵命令树可端到端发现。全深度 `--help` 黄金基线与自洽性测试见
+`test/equivalence/`（每个节点都存在，其 `--help` 覆盖自身的参数与位置参数；
+用 `BKN_EQUIV_LIVE=1` 真机跑）。
 
 ## 许可证
 
-Apache-2.0
+BKN SDK 是 OpenBKN 项目的一部分，采用 **OpenBKN License** —— Apache License 2.0
+的修改版，附加若干条件。见 [LICENSE](LICENSE) 与 [NOTICE](NOTICE)。此前以
+Apache-2.0 分发的版本仍按 Apache-2.0 授权。

package/dist/{chunk-RSX5YMFM.js → chunk-KF3J46WL.js}

@@ -3745,6 +3745,23 @@ function deleteModels(ctx, kind, modelIds) {
 function testModel(ctx, kind, body) {
   return request(ctx, `${MANAGER}/${kind}/test`, { method: "POST", body });
 }
+function setDefaultLlm(ctx, modelId, isDefault = true) {
+  return request(ctx, `${MANAGER}/llm/default/edit`, {
+    method: "POST",
+    body: { model_id: modelId, default: isDefault }
+  });
+}
+function setDefaultSmallModel(ctx, modelId, isDefault = true) {
+  return request(ctx, `${MANAGER}/small-model/set-default`, {
+    method: "POST",
+    body: { model_id: modelId, default: isDefault }
+  });
+}
+function getDefaultSmallModel(ctx, modelType = "embedding") {
+  return request(ctx, `${MANAGER}/small-model/get_default`, {
+    query: { model_type: modelType }
+  });
+}
 function rerank(ctx, model, query, documents) {
   return request(ctx, `${API}/small-model/reranker`, {
     method: "POST",
@@ -3763,7 +3780,9 @@ function models(ctx) {
       add: (body) => addModel(ctx, "llm", body),
       edit: (body) => editModel(ctx, "llm", body),
       delete: (modelIds) => deleteModels(ctx, "llm", modelIds),
-      test: (body) => testModel(ctx, "llm", body)
+      test: (body) => testModel(ctx, "llm", body),
+      /** Set (or clear) the system default LLM. */
+      setDefault: (modelId, isDefault = true) => setDefaultLlm(ctx, modelId, isDefault)
     },
     small: {
       list: (opts) => listSmallModels(ctx, opts),
@@ -3773,7 +3792,11 @@ function models(ctx) {
       add: (body) => addModel(ctx, "small-model", body),
       edit: (body) => editModel(ctx, "small-model", body),
       delete: (modelIds) => deleteModels(ctx, "small-model", modelIds),
-      test: (body) => testModel(ctx, "small-model", body)
+      test: (body) => testModel(ctx, "small-model", body),
+      /** Set (or clear) the system default small model (type inferred from the model). */
+      setDefault: (modelId, isDefault = true) => setDefaultSmallModel(ctx, modelId, isDefault),
+      /** Get the system default small model for a type (default "embedding"). */
+      getDefault: (modelType) => getDefaultSmallModel(ctx, modelType)
     }
   };
 }
@@ -5308,4 +5331,4 @@ export {
   exportCreds,
   auth_exports
 };
-//# sourceMappingURL=chunk-RSX5YMFM.js.map
+//# sourceMappingURL=chunk-KF3J46WL.js.map