@stone-js/service-container 0.0.44 → 0.1.1
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 +21 -201
- package/README.md +22 -12
- package/dist/index.d.ts +160 -1
- package/dist/index.js +14 -6
- package/package.json +21 -20
package/LICENSE
CHANGED
|
@@ -1,201 +1,21 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
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 [2024] [Stone.js]
|
|
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.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Stone.js
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,17 +1,23 @@
|
|
|
1
|
-
# Stone.js
|
|
1
|
+
# Stone.js - Service Container
|
|
2
2
|
|
|
3
|
-
[](https://opensource.org/licenses/
|
|
3
|
+
[](https://opensource.org/licenses/MIT)
|
|
4
4
|
[](https://www.npmjs.com/package/@stone-js/service-container)
|
|
5
5
|
[](https://www.npmjs.com/package/@stone-js/service-container)
|
|
6
6
|

|
|
7
|
-
[](https://github.com/stone-foundation/stone-js-service-container/actions/workflows/main.yml)
|
|
8
|
+
[](https://github.com/stone-foundation/stone-js-service-container/actions/workflows/release.yml)
|
|
9
|
+
[](https://sonarcloud.io/summary/new_code?id=stone-foundation_stone-js-service-container)
|
|
10
|
+
[](https://sonarcloud.io/summary/new_code?id=stone-foundation_stone-js-service-container)
|
|
11
|
+
[](./SECURITY.md)
|
|
12
|
+
[](https://github.com/stone-foundation/stone-js-service-container/security/code-scanning)
|
|
13
|
+
[](https://github.com/stone-foundation/stone-js-service-container/network/updates)
|
|
8
14
|
[](https://conventionalcommits.org)
|
|
9
15
|
|
|
10
|
-
IoC Service Container with
|
|
16
|
+
IoC Service Container with proxy resolver and destructuring injection provides a very simple, centralized container that stores and resolves libraries, objects, and values to better organize code, manage dependencies, and enhance testability.
|
|
11
17
|
|
|
12
18
|
---
|
|
13
19
|
|
|
14
|
-
##
|
|
20
|
+
## Overview
|
|
15
21
|
|
|
16
22
|
The **Service Container** is an advanced JavaScript/TypeScript library that helps you manage dependencies effectively in your applications. It utilizes the Inversion of Control (IoC) pattern to simplify dependency injection, allowing you to create highly decoupled and maintainable codebases.
|
|
17
23
|
|
|
@@ -90,16 +96,14 @@ class A {
|
|
|
90
96
|
Now, create a class `B` that depends on `Logger` and `A` to log the message:
|
|
91
97
|
|
|
92
98
|
```typescript
|
|
93
|
-
import { Binding } from '@stone-js/service-container';
|
|
94
|
-
|
|
95
99
|
// Your class B
|
|
96
100
|
class B {
|
|
97
101
|
private readonly a: A;
|
|
98
102
|
private readonly logger: Logger;
|
|
99
103
|
|
|
100
|
-
constructor({ a, logger }:
|
|
101
|
-
this.a = a
|
|
102
|
-
this.logger = logger
|
|
104
|
+
constructor({ a, logger }: { a: A, logger: Logger }) { // Dependency injection by destructuring
|
|
105
|
+
this.a = a
|
|
106
|
+
this.logger = logger
|
|
103
107
|
}
|
|
104
108
|
|
|
105
109
|
logMessage() {
|
|
@@ -331,13 +335,19 @@ With this library, managing dependencies in your application becomes much simple
|
|
|
331
335
|
|
|
332
336
|
The Stone Service Container simplifies dependency management in your applications, making them more modular, testable, and maintainable. It provides tools for binding instances, singletons, and factories, as well as auto and conditional binding. By leveraging Inversion of Control and dependency injection, the service container ensures efficient, flexible, and scalable management of dependencies, fitting projects of any size.
|
|
333
337
|
|
|
338
|
+
## Learn More
|
|
339
|
+
|
|
340
|
+
This package is part of the Stone.js ecosystem, a modern JavaScript framework built around the Continuum Architecture.
|
|
341
|
+
|
|
342
|
+
Explore the full documentation: https://stonejs.dev
|
|
343
|
+
|
|
334
344
|
## API documentation
|
|
335
345
|
|
|
336
|
-
- [API](https://github.com/
|
|
346
|
+
- [API](https://github.com/stone-foundation/stone-js-service-container/blob/main/docs/modules.md)
|
|
337
347
|
|
|
338
348
|
## Contributing
|
|
339
349
|
|
|
340
|
-
See [Contributing Guide](https://github.com/
|
|
350
|
+
See [Contributing Guide](https://github.com/stone-foundation/stone-js-service-container/blob/main/CONTRIBUTING.md).
|
|
341
351
|
|
|
342
352
|
## Credits
|
|
343
353
|
- [Laravel Service Container](https://github.com/illuminate/container)
|
package/dist/index.d.ts
CHANGED
|
@@ -119,6 +119,12 @@ declare class Container extends Proxiable {
|
|
|
119
119
|
* @returns A new Container instance.
|
|
120
120
|
*/
|
|
121
121
|
static create(): Container;
|
|
122
|
+
/**
|
|
123
|
+
* Create a ProxyHandler for the container.
|
|
124
|
+
*
|
|
125
|
+
* @returns A new ProxyHandler instance.
|
|
126
|
+
*/
|
|
127
|
+
private static Proxyhandler;
|
|
122
128
|
/**
|
|
123
129
|
* Create a container.
|
|
124
130
|
*
|
|
@@ -266,4 +272,157 @@ declare class Container extends Proxiable {
|
|
|
266
272
|
autoBinding<V extends BindingValue>(name: BindingKey, item?: V, singleton?: boolean, alias?: string | string[]): this;
|
|
267
273
|
}
|
|
268
274
|
|
|
269
|
-
|
|
275
|
+
/**
|
|
276
|
+
* Class representing a ContainerError.
|
|
277
|
+
*
|
|
278
|
+
* @author Mr. Stone <evensstone@gmail.com>
|
|
279
|
+
*/
|
|
280
|
+
declare class ContainerError extends Error {
|
|
281
|
+
/**
|
|
282
|
+
* Error type indicating an alias conflict.
|
|
283
|
+
*/
|
|
284
|
+
static readonly ALIAS_TYPE = "alias";
|
|
285
|
+
/**
|
|
286
|
+
* Error type indicating that the resolver is not a function.
|
|
287
|
+
*/
|
|
288
|
+
static readonly RESOLVER_TYPE = "resolver";
|
|
289
|
+
/**
|
|
290
|
+
* Error type indicating a resolution failure.
|
|
291
|
+
*/
|
|
292
|
+
static readonly RESOLUTION_TYPE = "resolution";
|
|
293
|
+
/**
|
|
294
|
+
* Error type indicating an attempt to alias an unbound value.
|
|
295
|
+
*/
|
|
296
|
+
static readonly ALIAS_UNBOUND_TYPE = "alias_unbound";
|
|
297
|
+
/**
|
|
298
|
+
* Error type indicating that a value is not a service.
|
|
299
|
+
*/
|
|
300
|
+
static readonly NOT_A_SERVICE_TYPE = "not_a_service";
|
|
301
|
+
/**
|
|
302
|
+
* Error type indicating an error thrown by the resolver function.
|
|
303
|
+
*/
|
|
304
|
+
static readonly CANNOT_RESOLVE_TYPE = "cannot_resolve";
|
|
305
|
+
/**
|
|
306
|
+
* Error type indicating a circular dependency.
|
|
307
|
+
*/
|
|
308
|
+
static readonly CIRCULAR_DEPENDENCY_TYPE = "circular_dependency";
|
|
309
|
+
/**
|
|
310
|
+
* The type of the error.
|
|
311
|
+
*/
|
|
312
|
+
private readonly type;
|
|
313
|
+
/**
|
|
314
|
+
* Create a ContainerError.
|
|
315
|
+
*
|
|
316
|
+
* @param type - The type of the error.
|
|
317
|
+
* @param message - The error message or key related to the error.
|
|
318
|
+
*/
|
|
319
|
+
constructor(type: string, message: BindingKey);
|
|
320
|
+
/**
|
|
321
|
+
* Retrieve the error message based on the type and provided message.
|
|
322
|
+
*
|
|
323
|
+
* @param type - The type of the error.
|
|
324
|
+
* @param message - The error message or key related to the error.
|
|
325
|
+
* @returns The formatted error message.
|
|
326
|
+
*/
|
|
327
|
+
private getMessage;
|
|
328
|
+
/**
|
|
329
|
+
* Retrieve the resolution message based on the key.
|
|
330
|
+
*
|
|
331
|
+
* @param key - The key for which the resolution failed.
|
|
332
|
+
* @returns The formatted resolution error message.
|
|
333
|
+
*/
|
|
334
|
+
private getResolutionMessage;
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* Class representing a ResolverBinding.
|
|
339
|
+
*
|
|
340
|
+
* This class extends the Binding class, using a resolver function to lazily resolve the value when needed.
|
|
341
|
+
*
|
|
342
|
+
* @template V - The type of value that this binding holds.
|
|
343
|
+
* @author Mr. Stone <evensstone@gmail.com>
|
|
344
|
+
*/
|
|
345
|
+
declare abstract class ResolverBinding<V extends BindingValue> extends Binding<V> {
|
|
346
|
+
/**
|
|
347
|
+
* The resolver function used to provide the binding value.
|
|
348
|
+
*
|
|
349
|
+
* This function will be called when the value is needed, allowing for lazy instantiation
|
|
350
|
+
* and dependency resolution. It should return an instance of type `V`.
|
|
351
|
+
*/
|
|
352
|
+
protected readonly resolver: Resolver<V>;
|
|
353
|
+
/**
|
|
354
|
+
* Create a new instance of ResolverBinding.
|
|
355
|
+
*
|
|
356
|
+
* @param resolver - The resolver function to provide the binding value.
|
|
357
|
+
* @throws ContainerError if the resolver is not a function.
|
|
358
|
+
*/
|
|
359
|
+
constructor(resolver: Resolver<V>);
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
/**
|
|
363
|
+
* Class representing a Factory.
|
|
364
|
+
*
|
|
365
|
+
* The Factory class extends the ResolverBinding class, providing a mechanism to resolve a new instance each time the binding is resolved.
|
|
366
|
+
* This ensures that a fresh instance is created with each call to the `resolve` method.
|
|
367
|
+
*
|
|
368
|
+
* @template V - The type of value that this binding holds.
|
|
369
|
+
* @author Mr. Stone <evensstone@gmail.com>
|
|
370
|
+
*/
|
|
371
|
+
declare class Factory<V extends BindingValue> extends ResolverBinding<V> {
|
|
372
|
+
/**
|
|
373
|
+
* Resolve and return the value of the binding.
|
|
374
|
+
*
|
|
375
|
+
* Each time this method is called, a new value is resolved using the resolver function.
|
|
376
|
+
* This is intended for cases where a fresh instance is required for each resolution, such as factories or transient dependencies.
|
|
377
|
+
*
|
|
378
|
+
* @param container - The container to resolve dependencies from.
|
|
379
|
+
* @returns The resolved value of the binding.
|
|
380
|
+
* @throws ContainerError if the value cannot be resolved.
|
|
381
|
+
*/
|
|
382
|
+
resolve(container: Container): V;
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* Class representing an Instance.
|
|
387
|
+
*
|
|
388
|
+
* This class extends the Binding class and directly holds an instance value.
|
|
389
|
+
* It provides a straightforward resolution mechanism that simply returns the stored value.
|
|
390
|
+
*
|
|
391
|
+
* @template V - The type of value that this binding holds.
|
|
392
|
+
* @author Mr. Stone <evensstone@gmail.com>
|
|
393
|
+
*/
|
|
394
|
+
declare class Instance<V extends BindingValue> extends Binding<V> {
|
|
395
|
+
/**
|
|
396
|
+
* Resolve and return the value of the binding.
|
|
397
|
+
*
|
|
398
|
+
* @param _container - Container to resolve dependencies (not used in this implementation).
|
|
399
|
+
* @returns The resolved value of the binding.
|
|
400
|
+
*/
|
|
401
|
+
resolve(_container: Container): V | undefined;
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
/**
|
|
405
|
+
* Class representing a Singleton.
|
|
406
|
+
*
|
|
407
|
+
* The Singleton class extends the ResolverBinding class, ensuring that the value is only resolved once.
|
|
408
|
+
* Subsequent calls to the `resolve` method will return the previously resolved value, making it behave as a singleton.
|
|
409
|
+
*
|
|
410
|
+
* @template V - The type of value that this binding holds.
|
|
411
|
+
* @author Mr. Stone <evensstone@gmail.com>
|
|
412
|
+
*/
|
|
413
|
+
declare class Singleton<V extends BindingValue> extends ResolverBinding<V> {
|
|
414
|
+
/**
|
|
415
|
+
* Resolve and return the value of the binding.
|
|
416
|
+
*
|
|
417
|
+
* If the value has already been resolved, return the cached value. Otherwise, use the resolver function
|
|
418
|
+
* to resolve the value, store it, and return it.
|
|
419
|
+
*
|
|
420
|
+
* @param container - The container to resolve dependencies from.
|
|
421
|
+
* @returns The resolved value of the binding.
|
|
422
|
+
* @throws ContainerError if the value cannot be resolved.
|
|
423
|
+
*/
|
|
424
|
+
resolve(container: Container): V | undefined;
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
export { Binding, Container, ContainerError, Factory, Instance, Proxiable, ResolverBinding, Singleton };
|
|
428
|
+
export type { BindingKey, BindingValue, Resolver };
|
package/dist/index.js
CHANGED
|
@@ -293,12 +293,12 @@ class Container extends Proxiable {
|
|
|
293
293
|
return new this();
|
|
294
294
|
}
|
|
295
295
|
/**
|
|
296
|
-
* Create a container.
|
|
296
|
+
* Create a ProxyHandler for the container.
|
|
297
297
|
*
|
|
298
|
-
*
|
|
298
|
+
* @returns A new ProxyHandler instance.
|
|
299
299
|
*/
|
|
300
|
-
|
|
301
|
-
|
|
300
|
+
static Proxyhandler() {
|
|
301
|
+
return {
|
|
302
302
|
get: (target, prop, receiver) => {
|
|
303
303
|
if (Reflect.has(target, prop)) {
|
|
304
304
|
return Reflect.get(target, prop, receiver);
|
|
@@ -307,7 +307,15 @@ class Container extends Proxiable {
|
|
|
307
307
|
return target.make(prop);
|
|
308
308
|
}
|
|
309
309
|
}
|
|
310
|
-
}
|
|
310
|
+
};
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* Create a container.
|
|
314
|
+
*
|
|
315
|
+
* Initializes the container with empty alias and binding maps.
|
|
316
|
+
*/
|
|
317
|
+
constructor() {
|
|
318
|
+
super(Container.Proxyhandler());
|
|
311
319
|
this.aliases = new Map();
|
|
312
320
|
this.bindings = new Map();
|
|
313
321
|
}
|
|
@@ -456,7 +464,7 @@ class Container extends Proxiable {
|
|
|
456
464
|
try {
|
|
457
465
|
const binding = this.bindings.get(key);
|
|
458
466
|
if (binding !== undefined) {
|
|
459
|
-
return binding.resolve(this);
|
|
467
|
+
return binding.resolve(new Proxy(this, Container.Proxyhandler()));
|
|
460
468
|
}
|
|
461
469
|
}
|
|
462
470
|
finally {
|
package/package.json
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stone-js/service-container",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Javascript/Typescript IoC Service Container with proxy resolver and destructuring injection",
|
|
5
5
|
"author": "Mr. Stone <evensstone@gmail.com>",
|
|
6
|
-
"license": "
|
|
6
|
+
"license": "MIT",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+ssh://git@github.com/
|
|
9
|
+
"url": "git+ssh://git@github.com/stone-foundation/stone-js-service-container.git"
|
|
10
10
|
},
|
|
11
|
-
"homepage": "https://
|
|
11
|
+
"homepage": "https://stonejs.dev",
|
|
12
12
|
"bugs": {
|
|
13
|
-
"url": "https://github.com/
|
|
13
|
+
"url": "https://github.com/stone-foundation/stone-js-service-container/issues"
|
|
14
14
|
},
|
|
15
15
|
"keywords": [
|
|
16
16
|
"DI",
|
|
@@ -53,30 +53,31 @@
|
|
|
53
53
|
"prepare": "husky"
|
|
54
54
|
},
|
|
55
55
|
"devDependencies": {
|
|
56
|
-
"@commitlint/cli": "^19.
|
|
57
|
-
"@commitlint/config-conventional": "^19.
|
|
58
|
-
"@rollup/plugin-commonjs": "^
|
|
56
|
+
"@commitlint/cli": "^19.8.1",
|
|
57
|
+
"@commitlint/config-conventional": "^19.8.1",
|
|
58
|
+
"@rollup/plugin-commonjs": "^28.0.3",
|
|
59
59
|
"@rollup/plugin-multi-entry": "^6.0.1",
|
|
60
|
-
"@rollup/plugin-node-resolve": "^
|
|
60
|
+
"@rollup/plugin-node-resolve": "^16.0.1",
|
|
61
61
|
"@rollup/plugin-typescript": "^12.1.1",
|
|
62
|
-
"@types/node": "^
|
|
63
|
-
"@vitest/coverage-v8": "^2.
|
|
64
|
-
"husky": "^9.1.
|
|
65
|
-
"rimraf": "^
|
|
66
|
-
"rollup": "^4.
|
|
67
|
-
"rollup-plugin-delete": "^
|
|
68
|
-
"rollup-plugin-dts": "^6.
|
|
69
|
-
"rollup-plugin-node-externals": "^
|
|
62
|
+
"@types/node": "^24.0.0",
|
|
63
|
+
"@vitest/coverage-v8": "^3.2.3",
|
|
64
|
+
"husky": "^9.1.7",
|
|
65
|
+
"rimraf": "^6.0.1",
|
|
66
|
+
"rollup": "^4.43.0",
|
|
67
|
+
"rollup-plugin-delete": "^3.0.1",
|
|
68
|
+
"rollup-plugin-dts": "^6.2.1",
|
|
69
|
+
"rollup-plugin-node-externals": "^8.0.0",
|
|
70
70
|
"ts-standard": "^12.0.2",
|
|
71
71
|
"tslib": "^2.8.1",
|
|
72
|
-
"typedoc": "^0.
|
|
73
|
-
"typedoc-plugin-markdown": "^4.
|
|
72
|
+
"typedoc": "^0.28.5",
|
|
73
|
+
"typedoc-plugin-markdown": "^4.6.4",
|
|
74
74
|
"typescript": "^5.6.3",
|
|
75
|
-
"vitest": "^2.
|
|
75
|
+
"vitest": "^3.2.3"
|
|
76
76
|
},
|
|
77
77
|
"ts-standard": {
|
|
78
78
|
"globals": [
|
|
79
79
|
"it",
|
|
80
|
+
"test",
|
|
80
81
|
"expect",
|
|
81
82
|
"describe",
|
|
82
83
|
"beforeEach"
|