@zucker-framework/script 1.0.0
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 +201 -0
- package/NOTICE +22 -0
- package/THIRD_PARTY_NOTICES +4 -0
- package/dist/index.d.mts +213 -0
- package/dist/index.d.ts +213 -0
- package/dist/index.js +588 -0
- package/dist/index.mjs +549 -0
- package/package.json +39 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
Zucker Framework
|
|
2
|
+
Copyright 2026 Lind and Zucker Framework contributors
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0. See LICENSE.
|
|
5
|
+
|
|
6
|
+
The framework includes TypeScript adaptations and enhancements of concepts and
|
|
7
|
+
implementations from hsweb-framework and jetlinks-community, both distributed
|
|
8
|
+
under the Apache License, Version 2.0. Individual packages use different subsets
|
|
9
|
+
of the framework. The TypeScript adaptations and Node.js integrations were
|
|
10
|
+
modified for Zucker Framework; they are not the original upstream distribution.
|
|
11
|
+
|
|
12
|
+
hsweb-framework
|
|
13
|
+
https://github.com/hs-web/hsweb-framework
|
|
14
|
+
Copyright 2020 http://hsweb.me
|
|
15
|
+
|
|
16
|
+
jetlinks-community
|
|
17
|
+
https://github.com/jetlinks/jetlinks-community
|
|
18
|
+
|
|
19
|
+
See THIRD_PARTY_NOTICES for license texts and attribution for bundled dependencies
|
|
20
|
+
and reference implementations relevant to this package. External dependencies
|
|
21
|
+
remain subject to their own licenses. This NOTICE is informational and does not
|
|
22
|
+
modify any license or grant rights to upstream trademarks.
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
interface SandboxOptions {
|
|
2
|
+
timeout: number;
|
|
3
|
+
allowedModules: string[];
|
|
4
|
+
name?: string;
|
|
5
|
+
}
|
|
6
|
+
interface Sandbox {
|
|
7
|
+
execute(code: string, context?: Record<string, unknown>): unknown;
|
|
8
|
+
}
|
|
9
|
+
declare function createSandbox(options: SandboxOptions): Sandbox;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* 脚本执行上下文 — 对齐 jetlinks ExecutionContext 设计
|
|
13
|
+
* 支持多层属性查找(layered context resolution)和上下文组合
|
|
14
|
+
*/
|
|
15
|
+
interface ExecutionContext {
|
|
16
|
+
getAttribute(name: string): unknown;
|
|
17
|
+
setAttribute(name: string, value: unknown): void;
|
|
18
|
+
removeAttribute(name: string): unknown;
|
|
19
|
+
hasAttribute(name: string): boolean;
|
|
20
|
+
merge(other: ExecutionContext): ExecutionContext;
|
|
21
|
+
toRecord(): Record<string, unknown>;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* 默认执行上下文:支持多层 Map 查找,先找到的优先
|
|
25
|
+
* 最后一层为可写层(自动创建)
|
|
26
|
+
*/
|
|
27
|
+
declare class DefaultExecutionContext implements ExecutionContext {
|
|
28
|
+
private readonly layers;
|
|
29
|
+
private selfLayer;
|
|
30
|
+
constructor(...contexts: Array<Record<string, unknown>>);
|
|
31
|
+
getAttribute(name: string): unknown;
|
|
32
|
+
setAttribute(name: string, value: unknown): void;
|
|
33
|
+
removeAttribute(name: string): unknown;
|
|
34
|
+
hasAttribute(name: string): boolean;
|
|
35
|
+
merge(other: ExecutionContext): ExecutionContext;
|
|
36
|
+
toRecord(): Record<string, unknown>;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* 组合执行上下文:合并多个 ExecutionContext,按顺序查找
|
|
40
|
+
* 对齐 jetlinks CompositeExecutionContext
|
|
41
|
+
*/
|
|
42
|
+
declare class CompositeExecutionContext implements ExecutionContext {
|
|
43
|
+
private contexts;
|
|
44
|
+
constructor(...contexts: ExecutionContext[]);
|
|
45
|
+
getAttribute(name: string): unknown;
|
|
46
|
+
setAttribute(name: string, value: unknown): void;
|
|
47
|
+
removeAttribute(name: string): unknown;
|
|
48
|
+
hasAttribute(name: string): boolean;
|
|
49
|
+
merge(other: ExecutionContext): ExecutionContext;
|
|
50
|
+
toRecord(): Record<string, unknown>;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* 工厂方法
|
|
54
|
+
*/
|
|
55
|
+
declare function createExecutionContext(...contexts: Array<Record<string, unknown>>): ExecutionContext;
|
|
56
|
+
declare function composeContexts(...contexts: ExecutionContext[]): ExecutionContext;
|
|
57
|
+
|
|
58
|
+
interface Script {
|
|
59
|
+
id: string;
|
|
60
|
+
name: string;
|
|
61
|
+
content: string;
|
|
62
|
+
language: string;
|
|
63
|
+
/** 脚本的来源对象(可选,用于追踪) */
|
|
64
|
+
source?: unknown;
|
|
65
|
+
}
|
|
66
|
+
interface CompiledScript {
|
|
67
|
+
call(...args: unknown[]): Promise<unknown>;
|
|
68
|
+
callWithContext(context: Record<string, unknown>, ...args: unknown[]): Promise<unknown>;
|
|
69
|
+
/** 使用 ExecutionContext 执行(对齐 jetlinks CompiledScript.call(ExecutionContext)) */
|
|
70
|
+
callWithExecutionContext(context: ExecutionContext): Promise<unknown>;
|
|
71
|
+
}
|
|
72
|
+
interface ScriptFactory {
|
|
73
|
+
compile(script: Script): Promise<CompiledScript>;
|
|
74
|
+
compileExpose(script: Script, expose: Record<string, unknown>): Promise<CompiledScript>;
|
|
75
|
+
bind(script: Script, context: Record<string, unknown>): Promise<CompiledScript>;
|
|
76
|
+
/** 编译脚本并将其方法绑定到指定接口 */
|
|
77
|
+
createProxy<T extends Record<string, (...args: unknown[]) => unknown>>(script: Script, interfaceKeys: string[]): Promise<T>;
|
|
78
|
+
/** 添加允许在沙箱中使用的模块 */
|
|
79
|
+
allowModule(moduleName: string): void;
|
|
80
|
+
/** 移除允许的模块 */
|
|
81
|
+
denyModule(moduleName: string): void;
|
|
82
|
+
/**
|
|
83
|
+
* 将脚本返回值转换为纯 JS 类型。
|
|
84
|
+
* 对齐 jetlinks ScriptFactory.convertToJavaType() — 确保 Map/Set 等
|
|
85
|
+
* 非可序列化类型被转换为 POJO。
|
|
86
|
+
*/
|
|
87
|
+
convertToJavaType(data: unknown): unknown;
|
|
88
|
+
}
|
|
89
|
+
declare class JavaScriptScriptFactory implements ScriptFactory {
|
|
90
|
+
private readonly logger;
|
|
91
|
+
private defaultOptions;
|
|
92
|
+
private readonly accessControl;
|
|
93
|
+
setDefaultOptions(options: Partial<SandboxOptions>): void;
|
|
94
|
+
/** 添加允许的模块 — 对齐 jetlinks allows() */
|
|
95
|
+
allowModule(moduleName: string): void;
|
|
96
|
+
/** 移除允许的模块 — 对齐 jetlinks denies() */
|
|
97
|
+
denyModule(moduleName: string): void;
|
|
98
|
+
/** 添加允许的模式(正则) — 对齐 jetlinks allowsPattern() */
|
|
99
|
+
allowPattern(pattern: string): void;
|
|
100
|
+
/** 添加拒绝的模式(正则) — 对齐 jetlinks deniesPattern() */
|
|
101
|
+
denyPattern(pattern: string): void;
|
|
102
|
+
/** 检查模块是否被拒绝 — 对齐 jetlinks isDenied() */
|
|
103
|
+
isDenied(moduleName: string): boolean;
|
|
104
|
+
/**
|
|
105
|
+
* 将脚本返回值转换为纯 JS 类型 — 对齐 jetlinks AbstractScriptFactory.convertToJavaType()。
|
|
106
|
+
* 确保 Map、Set 等非 JSON 安全类型被转为 POJO/Array。
|
|
107
|
+
*/
|
|
108
|
+
convertToJavaType(data: unknown): unknown;
|
|
109
|
+
compile(script: Script): Promise<CompiledScript>;
|
|
110
|
+
compileExpose(script: Script, expose: Record<string, unknown>): Promise<CompiledScript>;
|
|
111
|
+
bind(script: Script, context: Record<string, unknown>): Promise<CompiledScript>;
|
|
112
|
+
createProxy<T extends Record<string, (...args: unknown[]) => unknown>>(script: Script, interfaceKeys: string[]): Promise<T>;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* 暴露脚本接口 — 对齐 jetlinks ExposedScript<T>。
|
|
117
|
+
*
|
|
118
|
+
* 提供支持暴露实例方法的脚本执行。脚本可以直接调用
|
|
119
|
+
* 暴露实例的方法,而不需要通过变量传参。
|
|
120
|
+
*/
|
|
121
|
+
interface ExposedScript<T> {
|
|
122
|
+
/**
|
|
123
|
+
* 使用指定的暴露实例和上下文来执行脚本。
|
|
124
|
+
* 对齐 jetlinks ExposedScript.call(T expose, ExecutionContext context)。
|
|
125
|
+
*/
|
|
126
|
+
call(expose: T, context?: ExecutionContext): Promise<unknown>;
|
|
127
|
+
/**
|
|
128
|
+
* 使用指定的暴露实例和简单 Map 上下文来执行脚本。
|
|
129
|
+
* 对齐 jetlinks ExposedScript.call(T expose, Map context)。
|
|
130
|
+
*/
|
|
131
|
+
callWithMap(expose: T, context?: Record<string, unknown>): Promise<unknown>;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* 暴露给脚本沙箱的方法注册表
|
|
135
|
+
* 允许将 TypeScript 方法注册为沙箱中可调用的函数
|
|
136
|
+
*/
|
|
137
|
+
declare class ExposedScriptRegistry {
|
|
138
|
+
private methods;
|
|
139
|
+
register(name: string, fn: (...args: unknown[]) => unknown): void;
|
|
140
|
+
unregister(name: string): void;
|
|
141
|
+
getExposedMethods(): Record<string, (...args: unknown[]) => unknown>;
|
|
142
|
+
has(name: string): boolean;
|
|
143
|
+
getNames(): string[];
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* 将编译后的脚本方法绑定到 TypeScript 接口。
|
|
148
|
+
* 参考 jetlinks ExposedScript 的设计:脚本暴露特定方法,
|
|
149
|
+
* 通过 Proxy 对象使调用方可以按接口类型安全地调用脚本函数。
|
|
150
|
+
*
|
|
151
|
+
* @param script 编译后的脚本(脚本中应 return 一个包含方法的对象)
|
|
152
|
+
* @param interfaceKeys 需要绑定的方法名列表
|
|
153
|
+
* @returns 实现了指定接口方法的代理对象
|
|
154
|
+
*
|
|
155
|
+
* @example
|
|
156
|
+
* ```ts
|
|
157
|
+
* interface Calculator {
|
|
158
|
+
* add(a: number, b: number): Promise<number>;
|
|
159
|
+
* multiply(a: number, b: number): Promise<number>;
|
|
160
|
+
* }
|
|
161
|
+
*
|
|
162
|
+
* const script = await factory.compile({
|
|
163
|
+
* id: '1', name: 'calc', language: 'javascript',
|
|
164
|
+
* content: 'return { add: (a, b) => a + b, multiply: (a, b) => a * b }',
|
|
165
|
+
* });
|
|
166
|
+
*
|
|
167
|
+
* const calc = bindInterface<Calculator>(script, ['add', 'multiply']);
|
|
168
|
+
* await calc.add(1, 2); // 3
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
declare function bindInterface<T extends Record<string, (...args: unknown[]) => unknown>>(script: CompiledScript, interfaceKeys: string[]): T;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* 脚本内置工具类 — 对齐 jetlinks AbstractScriptFactory.Utils
|
|
175
|
+
* 在沙箱中以 `utils` 变量暴露给脚本使用
|
|
176
|
+
*/
|
|
177
|
+
declare class ScriptUtils {
|
|
178
|
+
/** 当前时间戳(毫秒) */
|
|
179
|
+
now(): number;
|
|
180
|
+
/** 格式化当前时间 */
|
|
181
|
+
nowFormatted(format?: string): string;
|
|
182
|
+
/** 创建新的 Map(对象) */
|
|
183
|
+
newMap(): Record<string, unknown>;
|
|
184
|
+
/** 创建新的数组 */
|
|
185
|
+
newList(): unknown[];
|
|
186
|
+
/** 序列化为 JSON 字符串 */
|
|
187
|
+
toJsonString(obj: unknown): string;
|
|
188
|
+
/** 解析 JSON 字符串 */
|
|
189
|
+
parseJson(json: string): unknown;
|
|
190
|
+
/** 转换为 Java/原生类型(identity in JS) */
|
|
191
|
+
toJavaType(obj: unknown): unknown;
|
|
192
|
+
/** 求最大值(支持数组、嵌套集合) */
|
|
193
|
+
max(...params: unknown[]): unknown;
|
|
194
|
+
/** 求最小值(支持数组、嵌套集合) */
|
|
195
|
+
min(...params: unknown[]): unknown;
|
|
196
|
+
/** SHA1 摘要(hex) */
|
|
197
|
+
sha1Hex(str: string): string | null;
|
|
198
|
+
/** MD5 摘要(hex) */
|
|
199
|
+
md5Hex(str: string): string | null;
|
|
200
|
+
/** 创建指定大小的 Buffer */
|
|
201
|
+
newByteArray(size: number): Buffer;
|
|
202
|
+
/** 创建指定大小的 Int32 数组 — 对齐 jetlinks Utils.newIntArray() */
|
|
203
|
+
newIntArray(size: number): Int32Array;
|
|
204
|
+
/** 创建指定大小的 BigInt64 数组 — 对齐 jetlinks Utils.newLongArray() */
|
|
205
|
+
newLongArray(size: number): BigInt64Array;
|
|
206
|
+
}
|
|
207
|
+
/** 全局单例 */
|
|
208
|
+
declare const scriptUtils: ScriptUtils;
|
|
209
|
+
|
|
210
|
+
declare class ZuckerScriptModule {
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
export { type CompiledScript, CompositeExecutionContext, DefaultExecutionContext, type ExecutionContext, type ExposedScript, ExposedScriptRegistry, JavaScriptScriptFactory, type Sandbox, type SandboxOptions, type Script, type ScriptFactory, ScriptUtils, ZuckerScriptModule, bindInterface, composeContexts, createExecutionContext, createSandbox, scriptUtils };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
interface SandboxOptions {
|
|
2
|
+
timeout: number;
|
|
3
|
+
allowedModules: string[];
|
|
4
|
+
name?: string;
|
|
5
|
+
}
|
|
6
|
+
interface Sandbox {
|
|
7
|
+
execute(code: string, context?: Record<string, unknown>): unknown;
|
|
8
|
+
}
|
|
9
|
+
declare function createSandbox(options: SandboxOptions): Sandbox;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* 脚本执行上下文 — 对齐 jetlinks ExecutionContext 设计
|
|
13
|
+
* 支持多层属性查找(layered context resolution)和上下文组合
|
|
14
|
+
*/
|
|
15
|
+
interface ExecutionContext {
|
|
16
|
+
getAttribute(name: string): unknown;
|
|
17
|
+
setAttribute(name: string, value: unknown): void;
|
|
18
|
+
removeAttribute(name: string): unknown;
|
|
19
|
+
hasAttribute(name: string): boolean;
|
|
20
|
+
merge(other: ExecutionContext): ExecutionContext;
|
|
21
|
+
toRecord(): Record<string, unknown>;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* 默认执行上下文:支持多层 Map 查找,先找到的优先
|
|
25
|
+
* 最后一层为可写层(自动创建)
|
|
26
|
+
*/
|
|
27
|
+
declare class DefaultExecutionContext implements ExecutionContext {
|
|
28
|
+
private readonly layers;
|
|
29
|
+
private selfLayer;
|
|
30
|
+
constructor(...contexts: Array<Record<string, unknown>>);
|
|
31
|
+
getAttribute(name: string): unknown;
|
|
32
|
+
setAttribute(name: string, value: unknown): void;
|
|
33
|
+
removeAttribute(name: string): unknown;
|
|
34
|
+
hasAttribute(name: string): boolean;
|
|
35
|
+
merge(other: ExecutionContext): ExecutionContext;
|
|
36
|
+
toRecord(): Record<string, unknown>;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* 组合执行上下文:合并多个 ExecutionContext,按顺序查找
|
|
40
|
+
* 对齐 jetlinks CompositeExecutionContext
|
|
41
|
+
*/
|
|
42
|
+
declare class CompositeExecutionContext implements ExecutionContext {
|
|
43
|
+
private contexts;
|
|
44
|
+
constructor(...contexts: ExecutionContext[]);
|
|
45
|
+
getAttribute(name: string): unknown;
|
|
46
|
+
setAttribute(name: string, value: unknown): void;
|
|
47
|
+
removeAttribute(name: string): unknown;
|
|
48
|
+
hasAttribute(name: string): boolean;
|
|
49
|
+
merge(other: ExecutionContext): ExecutionContext;
|
|
50
|
+
toRecord(): Record<string, unknown>;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* 工厂方法
|
|
54
|
+
*/
|
|
55
|
+
declare function createExecutionContext(...contexts: Array<Record<string, unknown>>): ExecutionContext;
|
|
56
|
+
declare function composeContexts(...contexts: ExecutionContext[]): ExecutionContext;
|
|
57
|
+
|
|
58
|
+
interface Script {
|
|
59
|
+
id: string;
|
|
60
|
+
name: string;
|
|
61
|
+
content: string;
|
|
62
|
+
language: string;
|
|
63
|
+
/** 脚本的来源对象(可选,用于追踪) */
|
|
64
|
+
source?: unknown;
|
|
65
|
+
}
|
|
66
|
+
interface CompiledScript {
|
|
67
|
+
call(...args: unknown[]): Promise<unknown>;
|
|
68
|
+
callWithContext(context: Record<string, unknown>, ...args: unknown[]): Promise<unknown>;
|
|
69
|
+
/** 使用 ExecutionContext 执行(对齐 jetlinks CompiledScript.call(ExecutionContext)) */
|
|
70
|
+
callWithExecutionContext(context: ExecutionContext): Promise<unknown>;
|
|
71
|
+
}
|
|
72
|
+
interface ScriptFactory {
|
|
73
|
+
compile(script: Script): Promise<CompiledScript>;
|
|
74
|
+
compileExpose(script: Script, expose: Record<string, unknown>): Promise<CompiledScript>;
|
|
75
|
+
bind(script: Script, context: Record<string, unknown>): Promise<CompiledScript>;
|
|
76
|
+
/** 编译脚本并将其方法绑定到指定接口 */
|
|
77
|
+
createProxy<T extends Record<string, (...args: unknown[]) => unknown>>(script: Script, interfaceKeys: string[]): Promise<T>;
|
|
78
|
+
/** 添加允许在沙箱中使用的模块 */
|
|
79
|
+
allowModule(moduleName: string): void;
|
|
80
|
+
/** 移除允许的模块 */
|
|
81
|
+
denyModule(moduleName: string): void;
|
|
82
|
+
/**
|
|
83
|
+
* 将脚本返回值转换为纯 JS 类型。
|
|
84
|
+
* 对齐 jetlinks ScriptFactory.convertToJavaType() — 确保 Map/Set 等
|
|
85
|
+
* 非可序列化类型被转换为 POJO。
|
|
86
|
+
*/
|
|
87
|
+
convertToJavaType(data: unknown): unknown;
|
|
88
|
+
}
|
|
89
|
+
declare class JavaScriptScriptFactory implements ScriptFactory {
|
|
90
|
+
private readonly logger;
|
|
91
|
+
private defaultOptions;
|
|
92
|
+
private readonly accessControl;
|
|
93
|
+
setDefaultOptions(options: Partial<SandboxOptions>): void;
|
|
94
|
+
/** 添加允许的模块 — 对齐 jetlinks allows() */
|
|
95
|
+
allowModule(moduleName: string): void;
|
|
96
|
+
/** 移除允许的模块 — 对齐 jetlinks denies() */
|
|
97
|
+
denyModule(moduleName: string): void;
|
|
98
|
+
/** 添加允许的模式(正则) — 对齐 jetlinks allowsPattern() */
|
|
99
|
+
allowPattern(pattern: string): void;
|
|
100
|
+
/** 添加拒绝的模式(正则) — 对齐 jetlinks deniesPattern() */
|
|
101
|
+
denyPattern(pattern: string): void;
|
|
102
|
+
/** 检查模块是否被拒绝 — 对齐 jetlinks isDenied() */
|
|
103
|
+
isDenied(moduleName: string): boolean;
|
|
104
|
+
/**
|
|
105
|
+
* 将脚本返回值转换为纯 JS 类型 — 对齐 jetlinks AbstractScriptFactory.convertToJavaType()。
|
|
106
|
+
* 确保 Map、Set 等非 JSON 安全类型被转为 POJO/Array。
|
|
107
|
+
*/
|
|
108
|
+
convertToJavaType(data: unknown): unknown;
|
|
109
|
+
compile(script: Script): Promise<CompiledScript>;
|
|
110
|
+
compileExpose(script: Script, expose: Record<string, unknown>): Promise<CompiledScript>;
|
|
111
|
+
bind(script: Script, context: Record<string, unknown>): Promise<CompiledScript>;
|
|
112
|
+
createProxy<T extends Record<string, (...args: unknown[]) => unknown>>(script: Script, interfaceKeys: string[]): Promise<T>;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* 暴露脚本接口 — 对齐 jetlinks ExposedScript<T>。
|
|
117
|
+
*
|
|
118
|
+
* 提供支持暴露实例方法的脚本执行。脚本可以直接调用
|
|
119
|
+
* 暴露实例的方法,而不需要通过变量传参。
|
|
120
|
+
*/
|
|
121
|
+
interface ExposedScript<T> {
|
|
122
|
+
/**
|
|
123
|
+
* 使用指定的暴露实例和上下文来执行脚本。
|
|
124
|
+
* 对齐 jetlinks ExposedScript.call(T expose, ExecutionContext context)。
|
|
125
|
+
*/
|
|
126
|
+
call(expose: T, context?: ExecutionContext): Promise<unknown>;
|
|
127
|
+
/**
|
|
128
|
+
* 使用指定的暴露实例和简单 Map 上下文来执行脚本。
|
|
129
|
+
* 对齐 jetlinks ExposedScript.call(T expose, Map context)。
|
|
130
|
+
*/
|
|
131
|
+
callWithMap(expose: T, context?: Record<string, unknown>): Promise<unknown>;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* 暴露给脚本沙箱的方法注册表
|
|
135
|
+
* 允许将 TypeScript 方法注册为沙箱中可调用的函数
|
|
136
|
+
*/
|
|
137
|
+
declare class ExposedScriptRegistry {
|
|
138
|
+
private methods;
|
|
139
|
+
register(name: string, fn: (...args: unknown[]) => unknown): void;
|
|
140
|
+
unregister(name: string): void;
|
|
141
|
+
getExposedMethods(): Record<string, (...args: unknown[]) => unknown>;
|
|
142
|
+
has(name: string): boolean;
|
|
143
|
+
getNames(): string[];
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* 将编译后的脚本方法绑定到 TypeScript 接口。
|
|
148
|
+
* 参考 jetlinks ExposedScript 的设计:脚本暴露特定方法,
|
|
149
|
+
* 通过 Proxy 对象使调用方可以按接口类型安全地调用脚本函数。
|
|
150
|
+
*
|
|
151
|
+
* @param script 编译后的脚本(脚本中应 return 一个包含方法的对象)
|
|
152
|
+
* @param interfaceKeys 需要绑定的方法名列表
|
|
153
|
+
* @returns 实现了指定接口方法的代理对象
|
|
154
|
+
*
|
|
155
|
+
* @example
|
|
156
|
+
* ```ts
|
|
157
|
+
* interface Calculator {
|
|
158
|
+
* add(a: number, b: number): Promise<number>;
|
|
159
|
+
* multiply(a: number, b: number): Promise<number>;
|
|
160
|
+
* }
|
|
161
|
+
*
|
|
162
|
+
* const script = await factory.compile({
|
|
163
|
+
* id: '1', name: 'calc', language: 'javascript',
|
|
164
|
+
* content: 'return { add: (a, b) => a + b, multiply: (a, b) => a * b }',
|
|
165
|
+
* });
|
|
166
|
+
*
|
|
167
|
+
* const calc = bindInterface<Calculator>(script, ['add', 'multiply']);
|
|
168
|
+
* await calc.add(1, 2); // 3
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
declare function bindInterface<T extends Record<string, (...args: unknown[]) => unknown>>(script: CompiledScript, interfaceKeys: string[]): T;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* 脚本内置工具类 — 对齐 jetlinks AbstractScriptFactory.Utils
|
|
175
|
+
* 在沙箱中以 `utils` 变量暴露给脚本使用
|
|
176
|
+
*/
|
|
177
|
+
declare class ScriptUtils {
|
|
178
|
+
/** 当前时间戳(毫秒) */
|
|
179
|
+
now(): number;
|
|
180
|
+
/** 格式化当前时间 */
|
|
181
|
+
nowFormatted(format?: string): string;
|
|
182
|
+
/** 创建新的 Map(对象) */
|
|
183
|
+
newMap(): Record<string, unknown>;
|
|
184
|
+
/** 创建新的数组 */
|
|
185
|
+
newList(): unknown[];
|
|
186
|
+
/** 序列化为 JSON 字符串 */
|
|
187
|
+
toJsonString(obj: unknown): string;
|
|
188
|
+
/** 解析 JSON 字符串 */
|
|
189
|
+
parseJson(json: string): unknown;
|
|
190
|
+
/** 转换为 Java/原生类型(identity in JS) */
|
|
191
|
+
toJavaType(obj: unknown): unknown;
|
|
192
|
+
/** 求最大值(支持数组、嵌套集合) */
|
|
193
|
+
max(...params: unknown[]): unknown;
|
|
194
|
+
/** 求最小值(支持数组、嵌套集合) */
|
|
195
|
+
min(...params: unknown[]): unknown;
|
|
196
|
+
/** SHA1 摘要(hex) */
|
|
197
|
+
sha1Hex(str: string): string | null;
|
|
198
|
+
/** MD5 摘要(hex) */
|
|
199
|
+
md5Hex(str: string): string | null;
|
|
200
|
+
/** 创建指定大小的 Buffer */
|
|
201
|
+
newByteArray(size: number): Buffer;
|
|
202
|
+
/** 创建指定大小的 Int32 数组 — 对齐 jetlinks Utils.newIntArray() */
|
|
203
|
+
newIntArray(size: number): Int32Array;
|
|
204
|
+
/** 创建指定大小的 BigInt64 数组 — 对齐 jetlinks Utils.newLongArray() */
|
|
205
|
+
newLongArray(size: number): BigInt64Array;
|
|
206
|
+
}
|
|
207
|
+
/** 全局单例 */
|
|
208
|
+
declare const scriptUtils: ScriptUtils;
|
|
209
|
+
|
|
210
|
+
declare class ZuckerScriptModule {
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
export { type CompiledScript, CompositeExecutionContext, DefaultExecutionContext, type ExecutionContext, type ExposedScript, ExposedScriptRegistry, JavaScriptScriptFactory, type Sandbox, type SandboxOptions, type Script, type ScriptFactory, ScriptUtils, ZuckerScriptModule, bindInterface, composeContexts, createExecutionContext, createSandbox, scriptUtils };
|