katagami 3.0.3 → 4.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/README.md +9 -7
- package/dist/chunk-R66WOZUM.js +71 -0
- package/dist/container/index.d.cts +142 -35
- package/dist/container/index.d.ts +142 -35
- package/dist/container/policy.d.cts +36 -0
- package/dist/container/policy.d.ts +36 -0
- package/dist/disposable/index.cjs +27 -5
- package/dist/disposable/index.d.cts +17 -7
- package/dist/disposable/index.d.ts +17 -7
- package/dist/disposable/index.js +2 -41
- package/dist/entrypoint/index.d.cts +20 -0
- package/dist/entrypoint/index.d.ts +20 -0
- package/dist/index.cjs +551 -149
- package/dist/index.d.cts +8 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.js +495 -150
- package/dist/internal.d.cts +65 -0
- package/dist/internal.d.ts +65 -0
- package/dist/metadata/index.d.cts +67 -0
- package/dist/metadata/index.d.ts +67 -0
- package/dist/resolver/index.d.cts +5 -0
- package/dist/resolver/index.d.ts +5 -0
- package/dist/scope/index.d.cts +49 -24
- package/dist/scope/index.d.ts +49 -24
- package/dist/scope/operations.d.cts +22 -0
- package/dist/scope/operations.d.ts +22 -0
- package/docs/README.de.md +3 -2
- package/docs/README.es.md +3 -2
- package/docs/README.fr.md +3 -2
- package/docs/README.ja.md +7 -6
- package/docs/README.ko.md +3 -2
- package/docs/README.zh-CN.md +3 -2
- package/docs/README.zh-TW.md +3 -2
- package/docs/ai-coding-agents.md +3 -3
- package/docs/articles/ai-coding-agents.md +1 -1
- package/docs/articles/request-scope.md +2 -1
- package/docs/choosing-di.md +7 -6
- package/docs/guide.md +35 -4
- package/docs/registration-policies.ja.md +261 -0
- package/docs/registration-policies.md +435 -0
- package/docs/type-safety.md +13 -4
- package/llms.txt +1 -0
- package/package.json +1 -1
- package/dist/chunk-J2NYR3SH.js +0 -6
package/README.md
CHANGED
|
@@ -58,14 +58,14 @@ These checks assume narrow tokens and preserved registration types; see the
|
|
|
58
58
|
### Library comparison
|
|
59
59
|
|
|
60
60
|
**27 features across eight libraries.** Reviewed **2026-09-11**, against the npm `latest`
|
|
61
|
-
versions shown below and official documentation. [Versions, sources and detailed notes](./docs/choosing-di.md#comparison-sources).
|
|
61
|
+
versions shown below and official documentation; Katagami's column describes this release, 4.0.0. [Versions, sources and detailed notes](./docs/choosing-di.md#comparison-sources).
|
|
62
62
|
|
|
63
63
|
**✅ Built-in support · ⚠️ Conditions, a different model or application composition · ➖ No built-in support for this specific capability.**
|
|
64
64
|
Short labels identify the actual API or limitation.
|
|
65
65
|
|
|
66
66
|
#### Type safety and setup
|
|
67
67
|
|
|
68
|
-
| Feature | **Katagami**<br>**
|
|
68
|
+
| Feature | **Katagami**<br>**4.0.0** | InversifyJS<br>8.2.3 | tsyringe<br>4.10.0 | TypeDI<br>0.10.0 | Awilix<br>13.0.5 | NestJS<br>12.0.1 | Effect<br>3.22.2 | typed-inject<br>5.0.0 |
|
|
69
69
|
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
70
70
|
| **Runtime requirements** | **✅ Standard TypeScript** | ⚠️ Reflect metadata for class DI | ⚠️ Reflect metadata for class DI | ⚠️ Reflect metadata setup | ✅ No DI metadata | ⚠️ Nest modules / metadata | ✅ Effect / Layer APIs | ✅ Standard TypeScript |
|
|
71
71
|
| **Injection style** | **Explicit factories / constructors** | Constructor / property / factory | Constructor / factory | Constructor / property / factory | Proxy / classic / factory | Constructor / property / factory | Functional services / layers | Constructor / factory + `inject` |
|
|
@@ -79,7 +79,7 @@ Short labels identify the actual API or limitation.
|
|
|
79
79
|
|
|
80
80
|
#### Lifetimes, async services and cleanup
|
|
81
81
|
|
|
82
|
-
| Feature | **Katagami**<br>**
|
|
82
|
+
| Feature | **Katagami**<br>**4.0.0** | InversifyJS<br>8.2.3 | tsyringe<br>4.10.0 | TypeDI<br>0.10.0 | Awilix<br>13.0.5 | NestJS<br>12.0.1 | Effect<br>3.22.2 | typed-inject<br>5.0.0 |
|
|
83
83
|
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
84
84
|
| **Lifetimes** | **✅ Singleton / Transient / Scoped** | ✅ Singleton / Transient / Request | ✅ Singleton / Transient / Resolution / Container | ✅ Shared / Transient | ✅ Singleton / Transient / Scoped | ✅ Singleton / Transient / Request | ⚠️ Memoized / fresh layers + scopes | ✅ Singleton / Transient |
|
|
85
85
|
| **Request / scoped lifetime³** | **✅ Explicit per-request scope** | ⚠️ One resolution graph | ✅ Container / resolution scoped | ⚠️ Named containers | ✅ Explicit per-request scope | ✅ HTTP request scope | ⚠️ Resource scopes | ⚠️ Child injectors; no Scoped provider |
|
|
@@ -92,7 +92,7 @@ Short labels identify the actual API or limitation.
|
|
|
92
92
|
|
|
93
93
|
#### Composition and advanced features
|
|
94
94
|
|
|
95
|
-
| Feature | **Katagami**<br>**
|
|
95
|
+
| Feature | **Katagami**<br>**4.0.0** | InversifyJS<br>8.2.3 | tsyringe<br>4.10.0 | TypeDI<br>0.10.0 | Awilix<br>13.0.5 | NestJS<br>12.0.1 | Effect<br>3.22.2 | typed-inject<br>5.0.0 |
|
|
96
96
|
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
97
97
|
| **Optional resolution** | **✅ `tryResolve` / `tryResolveAll`** | ✅ Optional get / inject | ✅ Optional injection | ⚠️ `has` then `get` | ✅ `allowUnregistered` | ✅ Optional injection | ✅ `serviceOption` | ⚠️ Compose optional values |
|
|
98
98
|
| **Multi-binding** | **✅ `resolveAll`** | ✅ `getAll` / `getAllAsync` | ✅ `injectAll` / `resolveAll` | ✅ `getMany` | ⚠️ Collection-valued service | ⚠️ Array provider | ⚠️ Collection-valued service | ⚠️ Collection-valued service |
|
|
@@ -101,7 +101,7 @@ Short labels identify the actual API or limitation.
|
|
|
101
101
|
| **Auto-loading / discovery⁶** | **➖ Explicit `use()`** | ⚠️ Class autobinding | ➖ Explicit registrations | ➖ Explicit imports | ✅ `loadModules` (Node) | ⚠️ `DiscoveryService` | ➖ Explicit layers | ➖ Explicit providers |
|
|
102
102
|
| **Module system / composition** | **✅ `use()`** | ✅ Container modules | ✅ `@registry` | ⚠️ Group registrations | ✅ `loadModules` / `register` | ✅ Modules / dynamic modules | ✅ Layer composition | ⚠️ Compose provider chains |
|
|
103
103
|
| **Circular dependency detection⁷** | **✅ Runtime cycle path** | ✅ Runtime detection | ⚠️ Constructor error / `delay` | ⚠️ Deferred type references | ✅ Runtime cycle path | ⚠️ Cycle errors / `forwardRef` | ⚠️ Typed Layer requirements | ⚠️ Registration order constrains dependencies |
|
|
104
|
-
| **Middleware / interceptors⁶** | **⚠️
|
|
104
|
+
| **Middleware / interceptors⁶** | **⚠️ `beforeResolve` checks / higher-order factories** | ✅ Activation / deactivation hooks | ✅ Before / after resolution | ⚠️ Factory wrappers | ⚠️ Factory wrappers | ⚠️ Request interceptors, not DI hooks | ⚠️ Effect composition | ⚠️ Provider decoration |
|
|
105
105
|
| **Snapshot / restore⁶** | **➖** | ✅ `snapshot` / `restore` | ➖ | ➖ | ➖ | ➖ | ➖ | ➖ |
|
|
106
106
|
| **Test substitution / isolation** | **✅ Fresh scopes / containers + `use()`** | ✅ Rebind / snapshots | ✅ Child container overrides | ✅ Named containers / reset | ✅ Child scopes / overrides | ✅ `overrideProvider` | ✅ Substitute test layers | ✅ Child injector overrides |
|
|
107
107
|
|
|
@@ -132,8 +132,8 @@ compile-time checks, as shown above.
|
|
|
132
132
|
Awilix disposers are for cached values, and Nest hooks exclude request-scoped classes.
|
|
133
133
|
6. **Composition versus dedicated APIs:** A service proxy, deferred token and lazy module are
|
|
134
134
|
different features. Autobinding/discovery is not filesystem loading. Katagami's `use()` copies
|
|
135
|
-
registrations; containers are mutable. Factory wrappers are not interceptor APIs,
|
|
136
|
-
containers are not snapshots. [Composition details](./docs/choosing-di.md#composition-and-tooling).
|
|
135
|
+
registrations; containers are mutable. Factory wrappers are not interceptor APIs, `beforeResolve`
|
|
136
|
+
can reject a resolution but not replace its result, and fresh containers are not snapshots. [Composition details](./docs/choosing-di.md#composition-and-tooling).
|
|
137
137
|
7. **Cycles:** Runtime cycle detection, deferred references and static dependency requirements are
|
|
138
138
|
different mechanisms. A ⚠️ entry does not promise a general cycle detector; runtime checks do
|
|
139
139
|
not imply detection of every asynchronous deadlock.
|
|
@@ -190,6 +190,7 @@ describes how to test them.
|
|
|
190
190
|
| Class, string, number and symbol tokens | Choose the token style that fits your application |
|
|
191
191
|
| Optional and multiple resolution | Use `tryResolve`, `resolveAll` and `tryResolveAll` |
|
|
192
192
|
| Resource cleanup and lazy resolution | Opt in through `katagami/disposable` and `katagami/lazy` |
|
|
193
|
+
| Registration policies and operations | Share one `policy` across modules, require registration metadata and check what resolutions and operations return |
|
|
193
194
|
| ESM, CommonJS and zero runtime dependencies | Use standard tooling without decorator metadata setup |
|
|
194
195
|
|
|
195
196
|
Use Katagami when dependency wiring, test substitution or request lifetimes need structure.
|
|
@@ -199,6 +200,7 @@ See [choosing a DI approach](./docs/choosing-di.md) for trade-offs and links to
|
|
|
199
200
|
## Documentation
|
|
200
201
|
|
|
201
202
|
- [Usage guide and API](./docs/guide.md): lifetimes, composition, classes, async factories, cleanup and lazy resolution.
|
|
203
|
+
- [Registration policies and operations](./docs/registration-policies.md): a shared `policy`, required metadata, return checks and operations scopes.
|
|
202
204
|
- [Type guarantees](./docs/type-safety.md): accumulated tokens, interface maps and structural class typing.
|
|
203
205
|
- [AI coding guide](./docs/ai-coding-agents.md): workflow, diagnostics and a prompt to use in your project.
|
|
204
206
|
- [Request-scope starter](./examples/request-scope/README.md): concurrent requests, fake repositories and cleanup.
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
// src/internal.ts
|
|
2
|
+
var INTERNALS = /* @__PURE__ */ Symbol.for("katagami.internals.v4");
|
|
3
|
+
var CREATIONS = /* @__PURE__ */ Symbol.for("katagami.creations.v4");
|
|
4
|
+
var shared = globalThis;
|
|
5
|
+
if (!shared[CREATIONS]) {
|
|
6
|
+
Object.defineProperty(shared, CREATIONS, { value: /* @__PURE__ */ new WeakMap() });
|
|
7
|
+
}
|
|
8
|
+
var creations = shared[CREATIONS];
|
|
9
|
+
function settle(creation) {
|
|
10
|
+
return creation.then(
|
|
11
|
+
(value) => ({ failed: false, value }),
|
|
12
|
+
(error) => ({ error, failed: true })
|
|
13
|
+
);
|
|
14
|
+
}
|
|
15
|
+
var CONSTRUCTING = /* @__PURE__ */ Symbol.for("katagami.constructing.v4");
|
|
16
|
+
var running = globalThis;
|
|
17
|
+
if (!running[CONSTRUCTING]) {
|
|
18
|
+
Object.defineProperty(running, CONSTRUCTING, { value: [] });
|
|
19
|
+
}
|
|
20
|
+
var constructing = running[CONSTRUCTING];
|
|
21
|
+
|
|
22
|
+
// src/disposable/index.ts
|
|
23
|
+
function disposable(container) {
|
|
24
|
+
const asyncDispose = async () => {
|
|
25
|
+
const internals = container[INTERNALS];
|
|
26
|
+
if (internals.isDisposed()) {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
internals.markDisposed();
|
|
30
|
+
const instances = [...internals.ownCache.values()].reverse();
|
|
31
|
+
const errors = [];
|
|
32
|
+
for (const instance of instances) {
|
|
33
|
+
let resolved = instance;
|
|
34
|
+
if (instance instanceof Promise) {
|
|
35
|
+
const creation = await (creations.get(instance) ?? settle(instance));
|
|
36
|
+
if (creation.failed) {
|
|
37
|
+
continue;
|
|
38
|
+
}
|
|
39
|
+
resolved = creation.value;
|
|
40
|
+
}
|
|
41
|
+
try {
|
|
42
|
+
if (resolved != null && typeof resolved === "object") {
|
|
43
|
+
if (Symbol.asyncDispose in resolved) {
|
|
44
|
+
await resolved[Symbol.asyncDispose]();
|
|
45
|
+
} else if (Symbol.dispose in resolved) {
|
|
46
|
+
resolved[Symbol.dispose]();
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
} catch (error) {
|
|
50
|
+
errors.push(error);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
internals.ownCache.clear();
|
|
54
|
+
if (errors.length > 0) {
|
|
55
|
+
throw new AggregateError(errors, "One or more errors occurred during disposal.");
|
|
56
|
+
}
|
|
57
|
+
};
|
|
58
|
+
Object.defineProperty(container, Symbol.asyncDispose, {
|
|
59
|
+
configurable: true,
|
|
60
|
+
value: asyncDispose
|
|
61
|
+
});
|
|
62
|
+
return container;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export {
|
|
66
|
+
INTERNALS,
|
|
67
|
+
creations,
|
|
68
|
+
settle,
|
|
69
|
+
constructing,
|
|
70
|
+
disposable
|
|
71
|
+
};
|
|
@@ -1,5 +1,84 @@
|
|
|
1
|
-
import { type
|
|
1
|
+
import { type Callable, type EntrypointFactory } from '../entrypoint/index.cjs';
|
|
2
|
+
import { type ContainerInternals, INTERNALS, type REGISTRATION_STATE } from '../internal.cjs';
|
|
3
|
+
import { type AnyMetadataEntry, type AnyMetadataKey, type MetadataKeyOf, type MetadataReader, type RegistrationArguments } from '../metadata/index.cjs';
|
|
2
4
|
import type { AbstractConstructor, Resolver } from '../resolver/index.cjs';
|
|
5
|
+
import { type ContainerPolicy, type RequiredMetadata } from './policy.cjs';
|
|
6
|
+
export type RegisteredTokens<C> = C extends {
|
|
7
|
+
readonly [REGISTRATION_STATE]: infer S;
|
|
8
|
+
} ? S extends {
|
|
9
|
+
readonly untracked: true;
|
|
10
|
+
} ? never : S extends {
|
|
11
|
+
readonly token: infer K;
|
|
12
|
+
} ? K : never : never;
|
|
13
|
+
export interface RegistrationState {
|
|
14
|
+
readonly token: unknown;
|
|
15
|
+
readonly metadata: AnyMetadataKey;
|
|
16
|
+
readonly callable: Callable | never;
|
|
17
|
+
}
|
|
18
|
+
type State<K, E extends readonly AnyMetadataEntry[], F = never> = {
|
|
19
|
+
readonly token: K;
|
|
20
|
+
readonly metadata: MetadataKeyOf<E[number]>;
|
|
21
|
+
readonly callable: F;
|
|
22
|
+
};
|
|
23
|
+
type Replace<S, K, N> = (unknown extends S ? UntrackedState : Exclude<S, {
|
|
24
|
+
readonly token: K;
|
|
25
|
+
}>) | N;
|
|
26
|
+
type UntrackedState<K = unknown> = {
|
|
27
|
+
readonly token: K;
|
|
28
|
+
readonly metadata: never;
|
|
29
|
+
readonly callable: never;
|
|
30
|
+
readonly untracked: true;
|
|
31
|
+
};
|
|
32
|
+
type SourceState<S, K> = unknown extends S ? UntrackedState<K> : S extends {
|
|
33
|
+
readonly untracked: true;
|
|
34
|
+
} ? UntrackedState<K> : S;
|
|
35
|
+
type SourceTokens<S, K> = unknown extends S ? K : S extends {
|
|
36
|
+
readonly untracked: true;
|
|
37
|
+
} ? K : S extends {
|
|
38
|
+
readonly token: infer Token;
|
|
39
|
+
} ? Token : never;
|
|
40
|
+
type Append<S, K, E extends readonly AnyMetadataEntry[], F = never> = unknown extends S ? [MetadataKeyOf<E[number]> | F] extends [never] ? unknown : UntrackedState | State<K, E, F> : Replace<S, K, {
|
|
41
|
+
readonly token: K;
|
|
42
|
+
readonly metadata: [Extract<S, {
|
|
43
|
+
readonly token: K;
|
|
44
|
+
}>] extends [never] ? MetadataKeyOf<E[number]> : Extract<Extract<S, {
|
|
45
|
+
readonly token: K;
|
|
46
|
+
}> extends {
|
|
47
|
+
readonly metadata: infer M;
|
|
48
|
+
} ? M : never, MetadataKeyOf<E[number]>>;
|
|
49
|
+
readonly callable: F;
|
|
50
|
+
}>;
|
|
51
|
+
type TrackedState<S> = S extends {
|
|
52
|
+
readonly metadata: infer M;
|
|
53
|
+
readonly callable: infer F;
|
|
54
|
+
} ? [M | F] extends [never] ? never : S : never;
|
|
55
|
+
type Merge<S, K, N> = unknown extends S ? [TrackedState<N>] extends [never] ? unknown : Replace<S, K, N> : Replace<S, K, N>;
|
|
56
|
+
type MissingMetadata<R, S> = unknown extends S ? R : S extends {
|
|
57
|
+
readonly metadata: infer M;
|
|
58
|
+
} ? Exclude<R, M> : never;
|
|
59
|
+
/**
|
|
60
|
+
* Create a new DI container that follows a shared policy.
|
|
61
|
+
*
|
|
62
|
+
* Containers created with the same policy object share its settings and the origins it observes.
|
|
63
|
+
* Every registration must carry the policy's `requiredMetadata`, and `use()` accepts only modules
|
|
64
|
+
* with the same policy or without one. Declare the policy with `satisfies ContainerPolicy` to keep
|
|
65
|
+
* its concrete types.
|
|
66
|
+
*
|
|
67
|
+
* @param options `policy`: the shared policy object
|
|
68
|
+
*/
|
|
69
|
+
export declare function createContainer<const P extends ContainerPolicy>(options: {
|
|
70
|
+
readonly policy: P;
|
|
71
|
+
}): Container<Record<never, never>, never, never, Record<never, never>, never, never, RequiredMetadata<P>, never>;
|
|
72
|
+
/**
|
|
73
|
+
* Create a new DI container that follows a shared policy, with predeclared token type maps.
|
|
74
|
+
*
|
|
75
|
+
* @template T PropertyKey-based token type map (defined via interface, order-independent)
|
|
76
|
+
* @template ScopedT PropertyKey-based token type map for scoped registrations
|
|
77
|
+
* @param options `policy`: the shared policy object
|
|
78
|
+
*/
|
|
79
|
+
export declare function createContainer<T, ScopedT, const P extends ContainerPolicy>(options: {
|
|
80
|
+
readonly policy: P;
|
|
81
|
+
}): Container<T, never, never, ScopedT, never, never, RequiredMetadata<P>, never>;
|
|
3
82
|
/**
|
|
4
83
|
* Create a new DI container.
|
|
5
84
|
*
|
|
@@ -14,7 +93,9 @@ import type { AbstractConstructor, Resolver } from '../resolver/index.cjs';
|
|
|
14
93
|
* .registerTransient(GenerateTextUseCase, r => new GenerateTextUseCase(r.resolve(TextGenerationService)));
|
|
15
94
|
* ```
|
|
16
95
|
*/
|
|
17
|
-
export declare function createContainer<T = Record<never, never>, ScopedT = Record<never, never>>(): Container<T, never, never, ScopedT
|
|
96
|
+
export declare function createContainer<T = Record<never, never>, ScopedT = Record<never, never>>(): Container<T, never, never, ScopedT, never, never, readonly [], [
|
|
97
|
+
keyof T | keyof ScopedT
|
|
98
|
+
] extends [never] ? never : unknown>;
|
|
18
99
|
/**
|
|
19
100
|
* Lightweight DI container — registration only.
|
|
20
101
|
*
|
|
@@ -29,33 +110,43 @@ export declare function createContainer<T = Record<never, never>, ScopedT = Reco
|
|
|
29
110
|
* @template ScopedT PropertyKey-based token type map for scoped registrations
|
|
30
111
|
* @template ScopedSync Union of scoped sync class constructors (accumulated via chaining, order-dependent)
|
|
31
112
|
* @template ScopedAsync Union of scoped async class constructors (accumulated via chaining, order-dependent)
|
|
113
|
+
* @template Required Metadata keys the container's policy requires on every registration
|
|
114
|
+
* @template Registrations Registration state that tracks metadata and operations per token
|
|
32
115
|
*/
|
|
33
|
-
export declare class Container<T = Record<never, never>, Sync extends AbstractConstructor = never, Async extends AbstractConstructor = never, ScopedT = Record<never, never>, ScopedSync extends AbstractConstructor = never, ScopedAsync extends AbstractConstructor = never> {
|
|
116
|
+
export declare class Container<T = Record<never, never>, Sync extends AbstractConstructor = never, Async extends AbstractConstructor = never, ScopedT = Record<never, never>, ScopedSync extends AbstractConstructor = never, ScopedAsync extends AbstractConstructor = never, Required extends readonly AnyMetadataKey[] = readonly [], Registrations = unknown> {
|
|
34
117
|
private readonly registrations;
|
|
35
118
|
private readonly singletonCache;
|
|
119
|
+
private readonly requiredMetadata;
|
|
120
|
+
private readonly policy;
|
|
36
121
|
private disposed;
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
122
|
+
readonly [REGISTRATION_STATE]: Registrations;
|
|
123
|
+
readonly [INTERNALS]: ContainerInternals & {
|
|
124
|
+
readonly kind: 'container';
|
|
125
|
+
};
|
|
126
|
+
constructor(options?: {
|
|
127
|
+
readonly policy: ContainerPolicy<Required>;
|
|
128
|
+
});
|
|
44
129
|
/**
|
|
45
130
|
* Register a factory function as a singleton for the given token.
|
|
46
131
|
*
|
|
47
132
|
* Creates the instance on the first resolve and returns the cached value thereafter.
|
|
48
133
|
* If the same token is registered multiple times, all factories are accumulated.
|
|
49
134
|
* `resolve()` returns the last registered instance; `resolveAll()` returns all.
|
|
135
|
+
* Register request-dependent work as scoped instead.
|
|
50
136
|
*
|
|
51
137
|
* @param token Any value to use as a token
|
|
52
|
-
* @param factory Factory function that receives a resolver and returns an instance
|
|
138
|
+
* @param factory Factory function that receives a resolver and returns an instance. Wrap it with
|
|
139
|
+
* `entrypoint()` to expose the function it returns as an operation.
|
|
140
|
+
* @param options `metadata`: entries created with metadata keys. Required when the policy declares
|
|
141
|
+
* `requiredMetadata`.
|
|
53
142
|
* @returns The container for method chaining
|
|
54
143
|
*/
|
|
55
|
-
registerSingleton<
|
|
56
|
-
registerSingleton<
|
|
57
|
-
registerSingleton<
|
|
58
|
-
registerSingleton<V>(token:
|
|
144
|
+
registerSingleton<K extends PropertyKey, F extends Callable, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: ((resolver: Resolver<T, Sync, Async>) => F) & EntrypointFactory<Resolver<T, Sync, Async>, F>, ...options: RegistrationArguments<Required, E>): Container<Record<K, F> & T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E, F>>;
|
|
145
|
+
registerSingleton<K extends PropertyKey, F extends Callable, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: EntrypointFactory<Resolver<T, Sync, Async>, F>, ...options: RegistrationArguments<Required, E>): Container<Record<K, Promise<F>> & T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E, F>>;
|
|
146
|
+
registerSingleton<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: AbstractConstructor<V>, factory: (resolver: Resolver<T, Sync, Async>) => Promise<V>, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async | AbstractConstructor<V>, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, AbstractConstructor<V>, E>>;
|
|
147
|
+
registerSingleton<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: AbstractConstructor<V>, factory: (resolver: Resolver<T, Sync, Async>) => V, ...options: RegistrationArguments<Required, E>): Container<T, Sync | AbstractConstructor<V>, Async, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, AbstractConstructor<V>, E>>;
|
|
148
|
+
registerSingleton<K extends PropertyKey, V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: (resolver: Resolver<T, Sync, Async>) => V, ...options: RegistrationArguments<Required, E>): Container<Record<K, V> & T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E>>;
|
|
149
|
+
registerSingleton<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: unknown, factory: (resolver: Resolver<T, Sync, Async>) => V, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Registrations | State<unknown, E>>;
|
|
59
150
|
/**
|
|
60
151
|
* Register a factory function as transient for the given token.
|
|
61
152
|
*
|
|
@@ -64,13 +155,18 @@ export declare class Container<T = Record<never, never>, Sync extends AbstractCo
|
|
|
64
155
|
* `resolve()` returns the last registered instance; `resolveAll()` returns all.
|
|
65
156
|
*
|
|
66
157
|
* @param token Any value to use as a token
|
|
67
|
-
* @param factory Factory function that receives a resolver and returns an instance
|
|
158
|
+
* @param factory Factory function that receives a resolver and returns an instance. Wrap it with
|
|
159
|
+
* `entrypoint()` to expose the function it returns as an operation.
|
|
160
|
+
* @param options `metadata`: entries created with metadata keys. Required when the policy declares
|
|
161
|
+
* `requiredMetadata`.
|
|
68
162
|
* @returns The container for method chaining
|
|
69
163
|
*/
|
|
70
|
-
registerTransient<
|
|
71
|
-
registerTransient<
|
|
72
|
-
registerTransient<
|
|
73
|
-
registerTransient<V>(token:
|
|
164
|
+
registerTransient<K extends PropertyKey, F extends Callable, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: ((resolver: Resolver<T, Sync, Async>) => F) & EntrypointFactory<Resolver<T, Sync, Async>, F>, ...options: RegistrationArguments<Required, E>): Container<Record<K, F> & T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E, F>>;
|
|
165
|
+
registerTransient<K extends PropertyKey, F extends Callable, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: EntrypointFactory<Resolver<T, Sync, Async>, F>, ...options: RegistrationArguments<Required, E>): Container<Record<K, Promise<F>> & T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E, F>>;
|
|
166
|
+
registerTransient<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: AbstractConstructor<V>, factory: (resolver: Resolver<T, Sync, Async>) => Promise<V>, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async | AbstractConstructor<V>, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, AbstractConstructor<V>, E>>;
|
|
167
|
+
registerTransient<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: AbstractConstructor<V>, factory: (resolver: Resolver<T, Sync, Async>) => V, ...options: RegistrationArguments<Required, E>): Container<T, Sync | AbstractConstructor<V>, Async, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, AbstractConstructor<V>, E>>;
|
|
168
|
+
registerTransient<K extends PropertyKey, V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: (resolver: Resolver<T, Sync, Async>) => V, ...options: RegistrationArguments<Required, E>): Container<Record<K, V> & T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E>>;
|
|
169
|
+
registerTransient<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: unknown, factory: (resolver: Resolver<T, Sync, Async>) => V, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Registrations | State<unknown, E>>;
|
|
74
170
|
/**
|
|
75
171
|
* Register a factory function as scoped for the given token.
|
|
76
172
|
*
|
|
@@ -79,30 +175,41 @@ export declare class Container<T = Record<never, never>, Sync extends AbstractCo
|
|
|
79
175
|
* Scoped tokens cannot be resolved from the root container — use createScope() first.
|
|
80
176
|
*
|
|
81
177
|
* @param token Any value to use as a token
|
|
82
|
-
* @param factory Factory function that receives a resolver and returns an instance
|
|
178
|
+
* @param factory Factory function that receives a resolver and returns an instance. Wrap it with
|
|
179
|
+
* `entrypoint()` to expose the function it returns as an operation.
|
|
180
|
+
* @param options `metadata`: entries created with metadata keys. Required when the policy declares
|
|
181
|
+
* `requiredMetadata`.
|
|
83
182
|
* @returns The container for method chaining
|
|
84
183
|
*/
|
|
85
|
-
registerScoped<
|
|
86
|
-
registerScoped<
|
|
87
|
-
registerScoped<
|
|
88
|
-
registerScoped<V>(token:
|
|
184
|
+
registerScoped<K extends PropertyKey, F extends Callable, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: ((resolver: Resolver<T & ScopedT, Sync | ScopedSync, Async | ScopedAsync>) => F) & EntrypointFactory<Resolver<T & ScopedT, Sync | ScopedSync, Async | ScopedAsync>, F>, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async, Record<K, F> & ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E, F>>;
|
|
185
|
+
registerScoped<K extends PropertyKey, F extends Callable, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: EntrypointFactory<Resolver<T & ScopedT, Sync | ScopedSync, Async | ScopedAsync>, F>, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async, Record<K, Promise<F>> & ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E, F>>;
|
|
186
|
+
registerScoped<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: AbstractConstructor<V>, factory: (resolver: Resolver<T & ScopedT, Sync | ScopedSync, Async | ScopedAsync>) => Promise<V>, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async, ScopedT, ScopedSync, ScopedAsync | AbstractConstructor<V>, Required, Append<Registrations, AbstractConstructor<V>, E>>;
|
|
187
|
+
registerScoped<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: AbstractConstructor<V>, factory: (resolver: Resolver<T & ScopedT, Sync | ScopedSync, Async | ScopedAsync>) => V, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async, ScopedT, ScopedSync | AbstractConstructor<V>, ScopedAsync, Required, Append<Registrations, AbstractConstructor<V>, E>>;
|
|
188
|
+
registerScoped<K extends PropertyKey, V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: K, factory: (resolver: Resolver<T & ScopedT, Sync | ScopedSync, Async | ScopedAsync>) => V, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async, Record<K, V> & ScopedT, ScopedSync, ScopedAsync, Required, Append<Registrations, K, E>>;
|
|
189
|
+
registerScoped<V, const E extends readonly AnyMetadataEntry[] = readonly []>(token: unknown, factory: (resolver: Resolver<T & ScopedT, Sync | ScopedSync, Async | ScopedAsync>) => V, ...options: RegistrationArguments<Required, E>): Container<T, Sync, Async, ScopedT, ScopedSync, ScopedAsync, Required, Registrations | State<unknown, E>>;
|
|
190
|
+
/**
|
|
191
|
+
* Read the metadata of the last registration for a token without creating the instance.
|
|
192
|
+
*
|
|
193
|
+
* @param token A registered token
|
|
194
|
+
* @returns A read-only metadata reader
|
|
195
|
+
* @throws ContainerError if the token is not registered
|
|
196
|
+
*/
|
|
197
|
+
getMetadata<V>(token: AbstractConstructor<V> & (Sync | Async | ScopedSync | ScopedAsync)): MetadataReader;
|
|
198
|
+
getMetadata<K extends keyof (T & ScopedT)>(token: K): MetadataReader;
|
|
89
199
|
/**
|
|
90
200
|
* Apply all registrations from another container (module) to this container.
|
|
91
201
|
*
|
|
92
|
-
* Copies registration entries
|
|
202
|
+
* Copies registration entries by replacing existing entries for each token.
|
|
93
203
|
* Singleton instance caches are not shared — each container manages its own.
|
|
204
|
+
* A module with a policy must use this container's policy, and every copied registration must carry
|
|
205
|
+
* the metadata this container's policy requires; otherwise nothing is copied.
|
|
94
206
|
*
|
|
95
207
|
* @param source A container whose registrations will be copied into this container
|
|
96
208
|
* @returns The container for method chaining
|
|
97
209
|
*/
|
|
98
|
-
use<MT,
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
*
|
|
102
|
-
* @param token Token
|
|
103
|
-
* @param factory Factory function
|
|
104
|
-
* @param lifetime Lifetime of the registration
|
|
105
|
-
* @returns The container for method chaining
|
|
106
|
-
*/
|
|
210
|
+
use<MT, MS extends AbstractConstructor, MA extends AbstractConstructor, MST, MSS extends AbstractConstructor, MSA extends AbstractConstructor, MR extends readonly AnyMetadataKey[], State>(source: Container<MT, MS, MA, MST, MSS, MSA, MR, State> & ([MissingMetadata<Required[number], State>] extends [never] ? unknown : {
|
|
211
|
+
readonly missingRequiredMetadata: never;
|
|
212
|
+
})): Container<T & MT, Sync | MS, Async | MA, ScopedT & MST, ScopedSync | MSS, ScopedAsync | MSA, Required, Merge<Registrations, SourceTokens<State, keyof MT | keyof MST | MS | MA | MSS | MSA>, SourceState<State, keyof MT | keyof MST | MS | MA | MSS | MSA>>>;
|
|
107
213
|
private addRegistration;
|
|
108
214
|
}
|
|
215
|
+
export {};
|