@openbkn/bkn-sdk 0.1.1-alpha.18 → 0.1.1-alpha.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,215 +1,202 @@
1
- OpenBKN License
2
1
 
3
- BKN SDK is part of the OpenBKN project and is licensed under the
4
- OpenBKN License — a modified version of the Apache License, Version 2.0,
5
- with the following additional conditions.
6
-
7
- Copyright (c) 2026 OpenBKN. All rights reserved.
8
-
9
- ================================================================
10
- PREAMBLE
11
- ================================================================
12
-
13
- This license applies only to the OpenBKN modules that expressly
14
- reference this file in their source headers (the "Licensed Modules"),
15
- including but not limited to BKN Safe and BKN SDK.
16
-
17
- The Licensed Modules are licensed under the terms of the Apache
18
- License, Version 2.0 (the "Apache License"), the full text of which is
19
- available at http://www.apache.org/licenses/LICENSE-2.0, as modified and
20
- supplemented by the Additional Conditions set out below.
21
-
22
- In the event of any conflict between the Additional Conditions and the
23
- Apache License, the Additional Conditions shall control with respect to
24
- the Licensed Modules.
25
-
26
- This license does not apply to:
27
- (a) components that originate from the upstream project
28
- kweaver-ai/kweaver-core, which remain licensed solely under the
29
- Apache License, Version 2.0, with their original copyright
30
- notices preserved; nor
31
- (b) OpenBKN components or individual files expressly designated as
32
- licensed under the plain Apache License, Version 2.0, in their
33
- own license notice or source header.
34
- See the NOTICE file for the per-component breakdown.
35
-
36
- ================================================================
37
- ADDITIONAL CONDITIONS
38
- ================================================================
39
-
40
- 1. Commercial Use.
41
-
42
- The Licensed Modules may be used for commercial purposes, including
43
- as a component within your own application or business, subject to
44
- the conditions below.
45
-
46
- a. Implementation Services.
47
-
48
- Any person or legal entity may provide paid or unpaid consulting,
49
- development, SDK or API integration, deployment, configuration,
50
- training, support, upgrade, or maintenance services for a single
51
- End Customer, provided that:
52
-
53
- i. the Licensed Modules are deployed in an environment dedicated
54
- to that End Customer and owned or ultimately controlled by
55
- that End Customer;
56
-
57
- ii. the End Customer's use remains within the rights granted under
58
- this license or is covered by a valid commercial subscription;
59
-
60
- iii. no license key, activation receipt, Commercial Entitlement, or
61
- environment is shared across End Customers beyond its
62
- authorized scope; and
63
-
64
- iv. the service provider does not operate a Restricted Hosted
65
- Service as defined below.
66
-
67
- Providing these Implementation Services does not by itself
68
- require the End Customer or the service provider to obtain a
69
- commercial subscription.
70
-
71
- b. Commercial Entitlements and No Circumvention.
72
-
73
- A separate commercial subscription is required to enable or use
74
- features, modules, distributions, services, or product-
75
- customization rights expressly designated by OpenBKN as
76
- Professional, Enterprise Standard, Industry Solution, or other
77
- commercial entitlements for the applicable released version
78
- (collectively, "Commercial Entitlements").
79
-
80
- You may not, directly or indirectly:
81
-
82
- i. enable or use a Commercial Entitlement without a valid
83
- commercial subscription covering the applicable End Customer,
84
- project, and environment;
85
-
86
- ii. bypass, disable, alter, or interfere with license checks,
87
- activation mechanisms, entitlement controls, or usage
88
- restrictions;
89
-
90
- iii. share, reuse, transfer, or misapply a license key, activation
91
- receipt, or Commercial Entitlement beyond its authorized
92
- scope;
93
-
94
- iv. conceal or misrepresent an End Customer, project, tenant,
95
- installation, or deployment model for the purpose of avoiding
96
- commercial licensing; or
97
-
98
- v. assist or enable another person or legal entity to do any of
99
- the foregoing.
100
-
101
- This Section does not prohibit independent development of
102
- extensions, connectors, Skills, ontologies, or applications
103
- through documented interfaces, provided that such development
104
- does not copy commercial-only code or circumvent the controls
105
- described above.
106
-
107
- c. Restricted Hosted Services.
108
-
109
- Without prior written authorization from OpenBKN, you may not use
110
- the Licensed Modules to:
111
-
112
- i. operate a shared or multi-tenant service for separate End
113
- Customers;
114
-
115
- ii. provide the substantial features or functionality of the
116
- Licensed Modules as a hosted platform controlled by the
117
- service provider;
118
-
119
- iii. offer a white-label, OEM, or other service substantially
120
- similar to the official hosted or managed services offered by
121
- OpenBKN; or
122
-
123
- iv. use one End Customer's subscription, Commercial Entitlement,
124
- or environment to provide services to another End Customer.
125
-
126
- Implementation Services performed in accordance with Section
127
- 1(a) are not Restricted Hosted Services.
128
-
129
- For purposes of these Additional Conditions, "End Customer"
130
- means the final organization that obtains and uses the Licensed
131
- Modules for its own business. An environment remains controlled
132
- by the End Customer when a service provider performs delegated
133
- maintenance, provided that the End Customer retains ultimate
134
- administrative and data control.
135
-
136
- 2. Logo and Copyright Notices.
137
-
138
- When using the front end or console of the Licensed Modules, you may
139
- not remove or modify the OpenBKN logo, trademarks, or copyright and
140
- licensing notices displayed therein, except to the extent expressly
141
- permitted by a valid commercial subscription that includes product-
142
- customization rights. This condition does not apply to uses of the
143
- Licensed Modules that do not involve their front end or console.
144
-
145
- 3. Contributions.
146
-
147
- Code that you contribute to the Licensed Modules may be used by
148
- OpenBKN for any purpose, including commercial purposes and
149
- OpenBKN's cloud or hosted business, and may be licensed by
150
- OpenBKN under any terms. By submitting a contribution, you
151
- represent that you have the right to grant, and you grant to
152
- OpenBKN, a perpetual, worldwide, non-exclusive, royalty-free,
153
- irrevocable license to use, reproduce, modify, distribute, and
154
- relicense your contribution for such purposes.
155
-
156
- 4. Adjustment of Terms.
157
-
158
- OpenBKN may adjust the terms of this license, making them either
159
- more or less restrictive, for future versions of the Licensed
160
- Modules. Any such adjustment applies only to versions released after
161
- the adjustment; it does not retroactively alter the terms applicable
162
- to versions already released.
163
-
164
- 5. Trademarks.
165
-
166
- This license does not grant you any right to use the trade names,
167
- trademarks, service marks, or product names of OpenBKN, except as
168
- required by Section 2 above or for the reasonable and customary use
169
- in describing the origin of the Licensed Modules.
170
-
171
- 6. Effect of Apache License.
172
-
173
- Except as expressly modified or supplemented by the Additional
174
- Conditions above, all other rights granted and conditions imposed by
175
- the Apache License, Version 2.0 (including its disclaimers of
176
- warranty and limitations of liability) continue to apply to the
177
- Licensed Modules. Nothing in the Additional Conditions shall be
178
- construed as restricting the rights of any party under the Apache
179
- License, Version 2.0 with respect to code that is not part of the
180
- Licensed Modules.
181
-
182
- 7. Termination.
183
-
184
- OpenBKN may terminate the copyright, patent, and other permissions
185
- granted by OpenBKN under this license for the Licensed Modules if
186
- you violate the Additional Conditions above. If a violation is
187
- capable of cure, OpenBKN will provide written notice and at least
188
- 30 days to cure the violation before termination takes effect.
189
- Intentional circumvention, license sharing, or continued operation
190
- of an unauthorized hosted or multi-tenant service may result in
191
- immediate termination without a cure period. To continue after
192
- termination, you must bring your use into compliance, obtain written
193
- authorization from OpenBKN, or cease using the Licensed Modules.
194
-
195
- Nothing in this Section terminates or restricts rights independently
196
- granted by upstream or other contributors under the Apache License,
197
- Version 2.0, or another applicable license.
198
-
199
- ================================================================
200
- COMMERCIAL LICENSING
201
- ================================================================
202
-
203
- For commercial licensing inquiries (including access to Commercial
204
- Entitlements, authorization to operate Restricted Hosted Services or
205
- multi-tenant environments, or other uses requiring a commercial
206
- license), contact: community@openbkn.ai
207
-
208
- ================================================================
209
- DISCLAIMER
210
- ================================================================
211
-
212
- THE LICENSED MODULES ARE PROVIDED ON AN "AS IS" BASIS, WITHOUT
213
- WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, TO THE
214
- FULLEST EXTENT PERMITTED BY APPLICABLE LAW, AS SET OUT IN THE APACHE
215
- LICENSE, VERSION 2.0.
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE CHANGED
@@ -4,15 +4,13 @@ Copyright 2026 OpenBKN
4
4
  BKN SDK is part of the OpenBKN project.
5
5
 
6
6
  ================================================================
7
- 1. BKN SDK (OpenBKN License)
7
+ 1. BKN SDK (Apache License 2.0)
8
8
  ================================================================
9
- BKN SDK is independently developed by OpenBKN, does not contain
10
- upstream kweaver-ai/kweaver-core code, is copyright OpenBKN, and is
11
- licensed under the OpenBKN License — a modified version of the Apache
12
- License, Version 2.0, with Additional Conditions.
9
+ BKN SDK is independently developed by OpenBKN, is copyright OpenBKN,
10
+ and is licensed under the Apache License, Version 2.0.
13
11
 
14
- Full license text: LICENSE
15
- Apache License, Version 2.0 (incorporated): http://www.apache.org/licenses/LICENSE-2.0
12
+ Full license text: LICENSE
13
+ Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
16
14
 
17
15
  ================================================================
18
16
  2. Third-party dependencies
@@ -20,12 +18,4 @@ License, Version 2.0, with Additional Conditions.
20
18
  This product depends on and may bundle third-party software, each of
21
19
  which remains under its own license as declared in its package
22
20
  metadata (see package.json and the dependency manifests). Those
23
- licenses are not altered by the OpenBKN License.
24
-
25
- ================================================================
26
- 3. Historical versions
27
- ================================================================
28
- Versions of this repository previously distributed under the Apache
29
- License, Version 2.0 remain available under that license; their grant
30
- is not affected by the present licensing arrangement. The present
31
- arrangement applies only to versions released after this notice.
21
+ licenses are not altered by this project's license.
package/README.md CHANGED
@@ -77,17 +77,15 @@ Importing the package has no side effects; `createClient` resolves config explic
77
77
  ```bash
78
78
  npm install
79
79
  npm run lint # biome + tsc --noEmit
80
- npm test # vitest (unit; equivalence suite gated by BKN_EQUIV_LIVE)
80
+ npm test # vitest (unit)
81
81
  npm run build # tsup → dist/ (library + `openbkn` bin)
82
82
  ```
83
83
 
84
84
  ## Help system
85
85
 
86
86
  Every command, subcommand, and sub-subcommand ships a grouped `--help` that
87
- lists its flags and arguments, so the tree is discoverable end to end. Golden
88
- `--help` baselines and a full-depth self-consistency test live in
89
- `test/equivalence/` (every node exists and its `--help` covers its flags +
90
- arguments). Run live with `BKN_EQUIV_LIVE=1`.
87
+ lists its flags and arguments, so the tree is discoverable end to end.
88
+ `openbkn help all` dumps the full per-action signature list.
91
89
 
92
90
  ## Agent skill
93
91
 
@@ -123,8 +121,5 @@ to live `openbkn <group> <sub> --help` for exact flags.
123
121
 
124
122
  ## License
125
123
 
126
- BKN SDK is part of the OpenBKN project and is licensed under the **OpenBKN
127
- License** — a modified version of the Apache License, Version 2.0, with
128
- additional conditions. See the complete [OpenBKN License](LICENSE) and
129
- [NOTICE](NOTICE). Versions previously distributed under Apache-2.0 remain
130
- available under that license.
124
+ BKN SDK is part of the OpenBKN project and is licensed under the
125
+ **Apache License, Version 2.0**. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
package/README.zh.md CHANGED
@@ -71,19 +71,16 @@ import 本包无副作用;`createClient` 显式解析配置。
71
71
  ```bash
72
72
  npm install
73
73
  npm run lint # biome + tsc --noEmit
74
- npm test # vitest(单测;等价套件由 BKN_EQUIV_LIVE 控制)
74
+ npm test # vitest(单测)
75
75
  npm run build # tsup → dist/(库 + openbkn bin)
76
76
  ```
77
77
 
78
78
  ## 帮助系统
79
79
 
80
80
  每个命令、子命令、孙命令都带分组 `--help`,列出各自的参数与位置参数,
81
- 整棵命令树可端到端发现。全深度 `--help` 黄金基线与自洽性测试见
82
- `test/equivalence/`(每个节点都存在,其 `--help` 覆盖自身的参数与位置参数;
83
- 用 `BKN_EQUIV_LIVE=1` 真机跑)。
81
+ 整棵命令树可端到端发现。`openbkn help all` 输出全深度的逐动作签名清单。
84
82
 
85
83
  ## 许可证
86
84
 
87
- BKN SDK 是 OpenBKN 项目的一部分,采用 **OpenBKN License** —— Apache License 2.0
88
- 的修改版,附加若干条件。见完整 [OpenBKN License](LICENSE) 与
89
- [NOTICE](NOTICE)。此前以 Apache-2.0 分发的版本仍按 Apache-2.0 授权。
85
+ BKN SDK 是 OpenBKN 项目的一部分,采用 **Apache License, Version 2.0**。
86
+ [LICENSE](LICENSE) 与 [NOTICE](NOTICE)。