@zucker-framework/provider 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 +410 -0
- package/dist/index.d.ts +410 -0
- package/dist/index.js +811 -0
- package/dist/index.mjs +765 -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,410 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A named provider instance with optional metadata.
|
|
3
|
+
* @template T - The type of the provided instance
|
|
4
|
+
*/
|
|
5
|
+
interface Provider<T> {
|
|
6
|
+
/** Unique identifier for this provider */
|
|
7
|
+
id: string;
|
|
8
|
+
/** The provider instance */
|
|
9
|
+
instance: T;
|
|
10
|
+
/** Optional metadata associated with this provider */
|
|
11
|
+
metadata?: Record<string, unknown>;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Disposable handle returned by register — call dispose() to unregister.
|
|
15
|
+
* Mirrors Java Reactor Disposable pattern used in jetlinks Provider.
|
|
16
|
+
*/
|
|
17
|
+
interface Disposable {
|
|
18
|
+
dispose(): void;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Registry for managing named provider instances.
|
|
22
|
+
* Supports registration, lookup, default provider, and register-if-absent patterns.
|
|
23
|
+
* @template T - The type of the provided instances
|
|
24
|
+
*/
|
|
25
|
+
interface ProviderRegistry<T> {
|
|
26
|
+
/** Register a provider; returns a Disposable to unregister it later. */
|
|
27
|
+
register(provider: Provider<T>): Disposable;
|
|
28
|
+
unregister(id: string): void;
|
|
29
|
+
get(id: string): Provider<T> | undefined;
|
|
30
|
+
/** Get provider by id; throws if not found. Mirrors Java Provider.getNow(). */
|
|
31
|
+
getNow(id: string): Provider<T>;
|
|
32
|
+
getAll(): Provider<T>[];
|
|
33
|
+
getDefault(): Provider<T> | undefined;
|
|
34
|
+
setDefault(id: string): void;
|
|
35
|
+
/**
|
|
36
|
+
* Register if absent — returns the existing provider if one is already
|
|
37
|
+
* registered under the same id, otherwise registers and returns undefined.
|
|
38
|
+
* Mirrors Java Provider.registerIfAbsent().
|
|
39
|
+
*/
|
|
40
|
+
registerIfAbsent(provider: Provider<T>): Provider<T> | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* Register if absent with a builder function.
|
|
43
|
+
* Mirrors Java Provider.registerIfAbsent(id, Function).
|
|
44
|
+
*/
|
|
45
|
+
registerIfAbsentWith(id: string, builder: (id: string) => Provider<T>): Provider<T> | undefined;
|
|
46
|
+
}
|
|
47
|
+
declare class DefaultProviderRegistry<T> implements ProviderRegistry<T> {
|
|
48
|
+
private readonly logger;
|
|
49
|
+
private providers;
|
|
50
|
+
private defaultId;
|
|
51
|
+
private hooks;
|
|
52
|
+
register(provider: Provider<T>): Disposable;
|
|
53
|
+
unregister(id: string): void;
|
|
54
|
+
get(id: string): Provider<T> | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Get provider by id; throws if not found.
|
|
57
|
+
* Mirrors Java SimpleProvider.getNow() which throws BusinessException.
|
|
58
|
+
*/
|
|
59
|
+
getNow(id: string): Provider<T>;
|
|
60
|
+
getAll(): Provider<T>[];
|
|
61
|
+
getDefault(): Provider<T> | undefined;
|
|
62
|
+
setDefault(id: string): void;
|
|
63
|
+
/**
|
|
64
|
+
* Register if absent — if a provider with the same id already exists,
|
|
65
|
+
* returns the old provider and skips registration. Otherwise registers
|
|
66
|
+
* the new provider and returns undefined.
|
|
67
|
+
* Mirrors Java SimpleProvider.registerIfAbsent(id, T).
|
|
68
|
+
*/
|
|
69
|
+
registerIfAbsent(provider: Provider<T>): Provider<T> | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* Register if absent using a builder function.
|
|
72
|
+
* Mirrors Java SimpleProvider.registerIfAbsent(id, Function<String, T>).
|
|
73
|
+
*/
|
|
74
|
+
registerIfAbsentWith(id: string, builder: (id: string) => Provider<T>): Provider<T> | undefined;
|
|
75
|
+
addHook(hook: RegistryHook<T>): Disposable;
|
|
76
|
+
removeHook(hook: RegistryHook<T>): void;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Lifecycle hook for ProviderRegistry events.
|
|
80
|
+
* Allows reacting to provider registration and unregistration.
|
|
81
|
+
* @template T - The type of the provided instances
|
|
82
|
+
*/
|
|
83
|
+
interface RegistryHook<T> {
|
|
84
|
+
/** Called when a new provider is registered */
|
|
85
|
+
onRegister?(provider: Provider<T>): void;
|
|
86
|
+
/** Called when a provider is unregistered */
|
|
87
|
+
onUnregister?(provider: Provider<T>): void;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* Base interface for a named strategy.
|
|
92
|
+
*/
|
|
93
|
+
interface Strategy {
|
|
94
|
+
/** Unique identifier for this strategy */
|
|
95
|
+
id: string;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Manager for registering and resolving named strategies.
|
|
99
|
+
* @template S - The strategy type
|
|
100
|
+
*/
|
|
101
|
+
interface StrategyManager<S extends Strategy> {
|
|
102
|
+
register(strategy: S): void;
|
|
103
|
+
unregister(id: string): void;
|
|
104
|
+
get(id: string): S | undefined;
|
|
105
|
+
/** Get a strategy by id; throws if not found. */
|
|
106
|
+
getNow(id: string): S;
|
|
107
|
+
getAll(): S[];
|
|
108
|
+
/** Check if a strategy is registered. */
|
|
109
|
+
has(id: string): boolean;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* Default strategy manager — mirrors Java StaticStrategyManager with
|
|
113
|
+
* doWith helpers and onStrategyNotFound hook.
|
|
114
|
+
*/
|
|
115
|
+
declare class DefaultStrategyManager<S extends Strategy> implements StrategyManager<S> {
|
|
116
|
+
private readonly logger;
|
|
117
|
+
private strategies;
|
|
118
|
+
register(strategy: S): void;
|
|
119
|
+
unregister(id: string): void;
|
|
120
|
+
get(id: string): S | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* Get strategy by id; throws if not found.
|
|
123
|
+
* Mirrors Java StaticStrategyManager's implicit throw behaviour via
|
|
124
|
+
* switchIfEmpty + onStrategyNotFound.
|
|
125
|
+
*/
|
|
126
|
+
getNow(id: string): S;
|
|
127
|
+
getAll(): S[];
|
|
128
|
+
/**
|
|
129
|
+
* Check if a strategy is registered.
|
|
130
|
+
*/
|
|
131
|
+
has(id: string): boolean;
|
|
132
|
+
/**
|
|
133
|
+
* Execute an async function with a resolved strategy.
|
|
134
|
+
* Mirrors Java StaticStrategyManager.doWithMono().
|
|
135
|
+
*/
|
|
136
|
+
doWith<T>(strategyId: string, executor: (strategy: S) => Promise<T>): Promise<T | undefined>;
|
|
137
|
+
/**
|
|
138
|
+
* Execute an async function that returns an array with a resolved strategy.
|
|
139
|
+
* Mirrors Java StaticStrategyManager.doWithFlux().
|
|
140
|
+
*/
|
|
141
|
+
doWithMany<T>(strategyId: string, executor: (strategy: S) => Promise<T[]>): Promise<T[]>;
|
|
142
|
+
/**
|
|
143
|
+
* Called when a strategy is not found. By default throws an error.
|
|
144
|
+
* Subclasses can override to return a fallback or silently return undefined.
|
|
145
|
+
* Mirrors Java StaticStrategyManager.onStrategyNotFound().
|
|
146
|
+
*/
|
|
147
|
+
protected onStrategyNotFound(strategyId: string): never;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Lifecycle hook interface for reacting to registration/unregistration events.
|
|
152
|
+
* @template T - The type of the managed item
|
|
153
|
+
*/
|
|
154
|
+
interface LifecycleHook<T> {
|
|
155
|
+
/** Called when an item is registered */
|
|
156
|
+
onRegister?(item: T): void | Promise<void>;
|
|
157
|
+
/** Called when an item is unregistered */
|
|
158
|
+
onUnregister?(item: T): void | Promise<void>;
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* Manager for lifecycle hooks — fires register/unregister events to all registered hooks.
|
|
162
|
+
* @template T - The type of the managed item
|
|
163
|
+
*/
|
|
164
|
+
declare class HookManager<T> {
|
|
165
|
+
private hooks;
|
|
166
|
+
/**
|
|
167
|
+
* Add a lifecycle hook.
|
|
168
|
+
* @param hook - The hook to add
|
|
169
|
+
*/
|
|
170
|
+
addHook(hook: LifecycleHook<T>): void;
|
|
171
|
+
/**
|
|
172
|
+
* Remove a previously added lifecycle hook.
|
|
173
|
+
* @param hook - The hook to remove
|
|
174
|
+
*/
|
|
175
|
+
removeHook(hook: LifecycleHook<T>): void;
|
|
176
|
+
/**
|
|
177
|
+
* Fire the onRegister event on all hooks.
|
|
178
|
+
* @param item - The item being registered
|
|
179
|
+
*/
|
|
180
|
+
fireRegister(item: T): Promise<void>;
|
|
181
|
+
/**
|
|
182
|
+
* Fire the onUnregister event on all hooks.
|
|
183
|
+
* @param item - The item being unregistered
|
|
184
|
+
*/
|
|
185
|
+
fireUnregister(item: T): Promise<void>;
|
|
186
|
+
/**
|
|
187
|
+
* Get a copy of all registered hooks.
|
|
188
|
+
* @returns An array of registered lifecycle hooks
|
|
189
|
+
*/
|
|
190
|
+
getHooks(): LifecycleHook<T>[];
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* 组合 Provider — 按优先级聚合多个同类 Provider,
|
|
195
|
+
* 参考 jetlinks CompositeNotifyConfigManager 的 switchIfEmpty 语义。
|
|
196
|
+
*/
|
|
197
|
+
declare class CompositeProvider<T> {
|
|
198
|
+
private readonly logger;
|
|
199
|
+
private readonly providers;
|
|
200
|
+
constructor(providers?: T[]);
|
|
201
|
+
/**
|
|
202
|
+
* 添加一个 provider(追加到末尾,优先级最低)
|
|
203
|
+
*/
|
|
204
|
+
add(provider: T): void;
|
|
205
|
+
/**
|
|
206
|
+
* 在指定位置插入 provider(索引越小优先级越高)
|
|
207
|
+
*/
|
|
208
|
+
addFirst(provider: T): void;
|
|
209
|
+
/**
|
|
210
|
+
* 按优先级依次尝试所有 provider,返回首个非空结果(switchIfEmpty 语义)
|
|
211
|
+
*/
|
|
212
|
+
get<R>(fn: (provider: T) => R | undefined | null | Promise<R | undefined | null>): Promise<R | undefined>;
|
|
213
|
+
/**
|
|
214
|
+
* 合并所有 provider 的结果并去重
|
|
215
|
+
* @param fn 从每个 provider 获取数组结果
|
|
216
|
+
* @param keyFn 可选的去重 key 提取函数
|
|
217
|
+
*/
|
|
218
|
+
getAll<R>(fn: (provider: T) => R[] | Promise<R[]>, keyFn?: (item: R) => string): Promise<R[]>;
|
|
219
|
+
/**
|
|
220
|
+
* 按优先级执行直到成功(switchIfEmpty 语义)
|
|
221
|
+
* 如果某个 provider 抛错则跳过,尝试下一个
|
|
222
|
+
*/
|
|
223
|
+
execute<R>(fn: (provider: T) => Promise<R>): Promise<R>;
|
|
224
|
+
/**
|
|
225
|
+
* 移除指定 provider
|
|
226
|
+
* @returns true if the provider was found and removed
|
|
227
|
+
*/
|
|
228
|
+
remove(provider: T): boolean;
|
|
229
|
+
getProviders(): readonly T[];
|
|
230
|
+
get size(): number;
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* 支持 fallback 的 ProviderRegistry — 在找不到指定 provider 时,
|
|
235
|
+
* 按备选 ID 列表依次查找,或返回默认 provider。
|
|
236
|
+
*/
|
|
237
|
+
declare class FallbackProviderRegistry<T> implements ProviderRegistry<T> {
|
|
238
|
+
private readonly logger;
|
|
239
|
+
private readonly delegate;
|
|
240
|
+
register(provider: Provider<T>): Disposable;
|
|
241
|
+
unregister(id: string): void;
|
|
242
|
+
get(id: string): Provider<T> | undefined;
|
|
243
|
+
getNow(id: string): Provider<T>;
|
|
244
|
+
registerIfAbsent(provider: Provider<T>): Provider<T> | undefined;
|
|
245
|
+
registerIfAbsentWith(id: string, builder: (id: string) => Provider<T>): Provider<T> | undefined;
|
|
246
|
+
getAll(): Provider<T>[];
|
|
247
|
+
getDefault(): Provider<T> | undefined;
|
|
248
|
+
setDefault(id: string): void;
|
|
249
|
+
/**
|
|
250
|
+
* 按序查找 provider:先找主 ID,找不到则依次尝试 fallback ID 列表
|
|
251
|
+
*/
|
|
252
|
+
getWithFallback(id: string, ...fallbackIds: string[]): Provider<T> | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* 找不到指定 ID 的 provider 时返回默认 provider
|
|
255
|
+
*/
|
|
256
|
+
getOrDefault(id: string): Provider<T> | undefined;
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
declare const PROVIDER_REGISTRY: unique symbol;
|
|
260
|
+
declare const STRATEGY_MANAGER: unique symbol;
|
|
261
|
+
declare class ZuckerProviderModule {
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* 资源提供者 SPI
|
|
266
|
+
*/
|
|
267
|
+
interface ResourceProvider {
|
|
268
|
+
/** 获取资源类型标识 */
|
|
269
|
+
getType(): string;
|
|
270
|
+
/** 根据 ID 获取资源实例 */
|
|
271
|
+
getResource(id: string): Promise<unknown>;
|
|
272
|
+
/** 列出所有可用资源 ID */
|
|
273
|
+
listResources?(): Promise<string[]>;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* 资源管理器 — 按 type + id 获取资源
|
|
277
|
+
*/
|
|
278
|
+
declare class ResourceManager {
|
|
279
|
+
private readonly logger;
|
|
280
|
+
private providers;
|
|
281
|
+
/** 注册资源提供者 */
|
|
282
|
+
registerProvider(provider: ResourceProvider): void;
|
|
283
|
+
/** 注销资源提供者 */
|
|
284
|
+
unregisterProvider(type: string): void;
|
|
285
|
+
/**
|
|
286
|
+
* 根据类型和 ID 获取资源(不存在时返回 undefined)
|
|
287
|
+
* @param type 资源类型
|
|
288
|
+
* @param id 资源 ID
|
|
289
|
+
* @returns 资源实例或 undefined
|
|
290
|
+
*/
|
|
291
|
+
getResource<T = unknown>(type: string, id: string): Promise<T | undefined>;
|
|
292
|
+
/**
|
|
293
|
+
* 根据类型和 ID 获取资源(不存在时抛出 NotFoundException)
|
|
294
|
+
* @param type 资源类型
|
|
295
|
+
* @param id 资源 ID
|
|
296
|
+
* @returns 资源实例
|
|
297
|
+
* @throws NotFoundException 资源不存在时
|
|
298
|
+
*/
|
|
299
|
+
getResourceOrThrow<T = unknown>(type: string, id: string): Promise<T>;
|
|
300
|
+
/** 获取指定类型的资源提供者 */
|
|
301
|
+
getProvider(type: string): ResourceProvider | undefined;
|
|
302
|
+
/** 获取所有已注册的资源类型 */
|
|
303
|
+
getTypes(): string[];
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* 从项目目录的 JSON 文件加载资源
|
|
308
|
+
*/
|
|
309
|
+
declare class ClasspathResourceProvider implements ResourceProvider {
|
|
310
|
+
private readonly type;
|
|
311
|
+
private readonly basePath;
|
|
312
|
+
constructor(type: string, basePath: string);
|
|
313
|
+
getType(): string;
|
|
314
|
+
getResource(id: string): Promise<any>;
|
|
315
|
+
listResources(): Promise<string[]>;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* 从文件系统加载资源(支持任意文件类型)
|
|
320
|
+
*/
|
|
321
|
+
declare class FileResourceProvider implements ResourceProvider {
|
|
322
|
+
private readonly type;
|
|
323
|
+
private readonly basePath;
|
|
324
|
+
private readonly extension;
|
|
325
|
+
constructor(type: string, basePath: string, extension?: string);
|
|
326
|
+
getType(): string;
|
|
327
|
+
getResource(id: string): Promise<Buffer | undefined>;
|
|
328
|
+
listResources(): Promise<string[]>;
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* Provider 健康检查扩展
|
|
333
|
+
*
|
|
334
|
+
* 对标 Claude Code Plugin 系统的 manifest validation + health checks:
|
|
335
|
+
* 对已注册的 Provider 进行周期性健康检查和条件激活。
|
|
336
|
+
*/
|
|
337
|
+
interface HealthCheckable {
|
|
338
|
+
/** 执行健康检查,返回 true 表示健康 */
|
|
339
|
+
healthCheck(): Promise<boolean>;
|
|
340
|
+
}
|
|
341
|
+
interface ConditionalProvider {
|
|
342
|
+
/** 判断该 Provider 是否应该被激活 */
|
|
343
|
+
shouldActivate(): boolean | Promise<boolean>;
|
|
344
|
+
}
|
|
345
|
+
type HealthStatus = 'healthy' | 'unhealthy' | 'unknown';
|
|
346
|
+
interface ProviderHealthInfo {
|
|
347
|
+
id: string;
|
|
348
|
+
status: HealthStatus;
|
|
349
|
+
lastChecked: number;
|
|
350
|
+
consecutiveFailures: number;
|
|
351
|
+
metadata?: Record<string, unknown>;
|
|
352
|
+
}
|
|
353
|
+
/**
|
|
354
|
+
* Provider 健康检查管理器
|
|
355
|
+
*
|
|
356
|
+
* 用法:
|
|
357
|
+
* ```ts
|
|
358
|
+
* const healthManager = new ProviderHealthManager(registry);
|
|
359
|
+
*
|
|
360
|
+
* // 对所有支持健康检查的 Provider 执行检查
|
|
361
|
+
* const results = await healthManager.checkAll();
|
|
362
|
+
*
|
|
363
|
+
* // 启动定期检查
|
|
364
|
+
* healthManager.startPeriodicChecks({ intervalMs: 30_000 });
|
|
365
|
+
*
|
|
366
|
+
* // 停止检查
|
|
367
|
+
* healthManager.stop();
|
|
368
|
+
* ```
|
|
369
|
+
*/
|
|
370
|
+
declare class ProviderHealthManager<T> {
|
|
371
|
+
private readonly registry;
|
|
372
|
+
private readonly logger;
|
|
373
|
+
private readonly healthState;
|
|
374
|
+
private intervalHandle?;
|
|
375
|
+
constructor(registry: ProviderRegistry<T>);
|
|
376
|
+
/**
|
|
377
|
+
* 对所有已注册的 Provider 执行健康检查
|
|
378
|
+
*/
|
|
379
|
+
checkAll(): Promise<ProviderHealthInfo[]>;
|
|
380
|
+
/**
|
|
381
|
+
* 对单个 Provider 执行健康检查
|
|
382
|
+
*/
|
|
383
|
+
check(provider: Provider<T>): Promise<ProviderHealthInfo>;
|
|
384
|
+
/**
|
|
385
|
+
* 获取所有 Provider 的健康状态
|
|
386
|
+
*/
|
|
387
|
+
getHealthStatus(): ProviderHealthInfo[];
|
|
388
|
+
/**
|
|
389
|
+
* 获取只包含健康 Provider 的列表
|
|
390
|
+
*/
|
|
391
|
+
getHealthyProviders(): Provider<T>[];
|
|
392
|
+
/**
|
|
393
|
+
* 启动定期健康检查
|
|
394
|
+
*/
|
|
395
|
+
startPeriodicChecks(options: {
|
|
396
|
+
intervalMs: number;
|
|
397
|
+
}): void;
|
|
398
|
+
/**
|
|
399
|
+
* 停止定期健康检查
|
|
400
|
+
*/
|
|
401
|
+
stop(): void;
|
|
402
|
+
/**
|
|
403
|
+
* 检查 Provider 是否应该被激活(条件激活)
|
|
404
|
+
*/
|
|
405
|
+
shouldActivate(provider: Provider<T>): Promise<boolean>;
|
|
406
|
+
private isHealthCheckable;
|
|
407
|
+
private isConditional;
|
|
408
|
+
}
|
|
409
|
+
|
|
410
|
+
export { ClasspathResourceProvider, CompositeProvider, type ConditionalProvider, DefaultProviderRegistry, DefaultStrategyManager, type Disposable, FallbackProviderRegistry, FileResourceProvider, type HealthCheckable, type HealthStatus, HookManager, type LifecycleHook, PROVIDER_REGISTRY, type Provider, type ProviderHealthInfo, ProviderHealthManager, type ProviderRegistry, type RegistryHook, ResourceManager, type ResourceProvider, STRATEGY_MANAGER, type Strategy, type StrategyManager, ZuckerProviderModule };
|