@geekmidas/services 0.0.1 → 0.2.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/dist/ServiceDiscovery-BO2FzEGt.cjs +200 -0
- package/dist/ServiceDiscovery-BO2FzEGt.cjs.map +1 -0
- package/dist/ServiceDiscovery-CfVBrQHt.d.cts +189 -0
- package/dist/ServiceDiscovery-CfVBrQHt.d.cts.map +1 -0
- package/dist/ServiceDiscovery-DLMyH_yM.mjs +195 -0
- package/dist/ServiceDiscovery-DLMyH_yM.mjs.map +1 -0
- package/dist/ServiceDiscovery-DpeEKNe2.d.mts +189 -0
- package/dist/ServiceDiscovery-DpeEKNe2.d.mts.map +1 -0
- package/dist/ServiceDiscovery.cjs +4 -0
- package/dist/ServiceDiscovery.d.cts +3 -0
- package/dist/ServiceDiscovery.d.mts +3 -0
- package/dist/ServiceDiscovery.mjs +4 -0
- package/dist/context-B5YTspJR.mjs +61 -0
- package/dist/context-B5YTspJR.mjs.map +1 -0
- package/dist/context-BVeZOvOd.d.cts +45 -0
- package/dist/context-BVeZOvOd.d.cts.map +1 -0
- package/dist/context-DMExgNzl.d.mts +45 -0
- package/dist/context-DMExgNzl.d.mts.map +1 -0
- package/dist/context-DUTDtYd2.cjs +95 -0
- package/dist/context-DUTDtYd2.cjs.map +1 -0
- package/dist/context.cjs +4 -0
- package/dist/context.d.cts +3 -0
- package/dist/context.d.mts +3 -0
- package/dist/context.mjs +3 -0
- package/dist/index.cjs +5 -178
- package/dist/index.d.cts +4 -214
- package/dist/index.d.mts +4 -214
- package/dist/index.mjs +3 -177
- package/dist/types-CcHmCx_U.d.mts +86 -0
- package/dist/types-CcHmCx_U.d.mts.map +1 -0
- package/dist/types-D7d_yeU5.d.cts +86 -0
- package/dist/types-D7d_yeU5.d.cts.map +1 -0
- package/dist/types.cjs +0 -0
- package/dist/types.d.cts +2 -0
- package/dist/types.d.mts +2 -0
- package/dist/types.mjs +0 -0
- package/package.json +22 -6
- package/src/ServiceDiscovery.ts +254 -0
- package/src/__tests__/context.spec.ts +276 -0
- package/src/__tests__/index.spec.ts +556 -558
- package/src/context.ts +91 -0
- package/src/index.ts +15 -279
- package/src/types.ts +85 -0
- package/tsconfig.json +9 -0
- package/dist/index.cjs.map +0 -1
- package/dist/index.mjs.map +0 -1
package/src/context.ts
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { AsyncLocalStorage } from 'node:async_hooks';
|
|
2
|
+
import type { Logger } from '@geekmidas/logger';
|
|
3
|
+
import type { ServiceContext } from './types';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Internal storage for request context data.
|
|
7
|
+
* Not exported - services use ServiceContext interface.
|
|
8
|
+
*/
|
|
9
|
+
export interface RequestContextData {
|
|
10
|
+
logger: Logger;
|
|
11
|
+
requestId: string;
|
|
12
|
+
startTime: number;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Internal AsyncLocalStorage instance for request context.
|
|
17
|
+
* Not exported - use runWithRequestContext() to establish context
|
|
18
|
+
* and serviceContext to access it.
|
|
19
|
+
*/
|
|
20
|
+
const requestContextStorage = new AsyncLocalStorage<RequestContextData>();
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* ServiceContext implementation.
|
|
24
|
+
* Singleton that reads from AsyncLocalStorage.
|
|
25
|
+
* Methods throw if called outside a request context (catches bugs early).
|
|
26
|
+
*/
|
|
27
|
+
export const serviceContext: ServiceContext = {
|
|
28
|
+
getLogger() {
|
|
29
|
+
const store = requestContextStorage.getStore();
|
|
30
|
+
if (!store) {
|
|
31
|
+
throw new Error(
|
|
32
|
+
'ServiceContext.getLogger() called outside request context. ' +
|
|
33
|
+
'Ensure code runs within runWithRequestContext().',
|
|
34
|
+
);
|
|
35
|
+
}
|
|
36
|
+
return store.logger;
|
|
37
|
+
},
|
|
38
|
+
|
|
39
|
+
getRequestId() {
|
|
40
|
+
const store = requestContextStorage.getStore();
|
|
41
|
+
if (!store) {
|
|
42
|
+
throw new Error(
|
|
43
|
+
'ServiceContext.getRequestId() called outside request context. ' +
|
|
44
|
+
'Ensure code runs within runWithRequestContext().',
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
return store.requestId;
|
|
48
|
+
},
|
|
49
|
+
|
|
50
|
+
getRequestStartTime() {
|
|
51
|
+
const store = requestContextStorage.getStore();
|
|
52
|
+
if (!store) {
|
|
53
|
+
throw new Error(
|
|
54
|
+
'ServiceContext.getRequestStartTime() called outside request context. ' +
|
|
55
|
+
'Ensure code runs within runWithRequestContext().',
|
|
56
|
+
);
|
|
57
|
+
}
|
|
58
|
+
return store.startTime;
|
|
59
|
+
},
|
|
60
|
+
|
|
61
|
+
hasContext() {
|
|
62
|
+
return requestContextStorage.getStore() !== undefined;
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Run a function with request context.
|
|
68
|
+
* Used by endpoint/function/subscriber adaptors.
|
|
69
|
+
*
|
|
70
|
+
* @param data - Request context data (logger, requestId, startTime)
|
|
71
|
+
* @param fn - Function to run with context
|
|
72
|
+
* @returns Result of the function
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* ```typescript
|
|
76
|
+
* const result = await runWithRequestContext(
|
|
77
|
+
* { logger, requestId, startTime: Date.now() },
|
|
78
|
+
* async () => {
|
|
79
|
+
* // Inside here, serviceContext.getLogger() returns `logger`
|
|
80
|
+
* // serviceContext.getRequestId() returns `requestId`
|
|
81
|
+
* return await handleRequest();
|
|
82
|
+
* }
|
|
83
|
+
* );
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
export function runWithRequestContext<T>(
|
|
87
|
+
data: RequestContextData,
|
|
88
|
+
fn: () => T | Promise<T>,
|
|
89
|
+
): T | Promise<T> {
|
|
90
|
+
return requestContextStorage.run(data, fn);
|
|
91
|
+
}
|
package/src/index.ts
CHANGED
|
@@ -1,279 +1,15 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
* async register(envParser: EnvironmentParser<{}>): Promise<Database> {
|
|
17
|
-
* const config = envParser.create((get) => ({
|
|
18
|
-
* url: get('DATABASE_URL').string()
|
|
19
|
-
* })).parse();
|
|
20
|
-
*
|
|
21
|
-
* return new Database(config.url);
|
|
22
|
-
* }
|
|
23
|
-
* }
|
|
24
|
-
* ```
|
|
25
|
-
*/
|
|
26
|
-
export interface Service<TName extends string = string, TInstance = unknown> {
|
|
27
|
-
/**
|
|
28
|
-
* Unique name for the service, used for lookup via services.get()
|
|
29
|
-
*/
|
|
30
|
-
serviceName: TName;
|
|
31
|
-
/**
|
|
32
|
-
* Register method that returns the actual service instance.
|
|
33
|
-
* Called once on first access, then cached.
|
|
34
|
-
*/
|
|
35
|
-
register(envParser: EnvironmentParser<{}>): TInstance | Promise<TInstance>;
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
* Service discovery container that manages service registration and retrieval.
|
|
40
|
-
* Implements a singleton pattern with lazy initialization of services.
|
|
41
|
-
*
|
|
42
|
-
* @template TServices - Record type mapping service names to their instance types
|
|
43
|
-
* @template TLogger - Logger type for internal logging
|
|
44
|
-
*
|
|
45
|
-
* @example
|
|
46
|
-
* ```typescript
|
|
47
|
-
* // Define service types
|
|
48
|
-
* interface MyServices {
|
|
49
|
-
* database: Database;
|
|
50
|
-
* cache: CacheService;
|
|
51
|
-
* auth: AuthService;
|
|
52
|
-
* }
|
|
53
|
-
*
|
|
54
|
-
* // Get service discovery instance
|
|
55
|
-
* const discovery = ServiceDiscovery.getInstance<MyServices>(logger, envParser);
|
|
56
|
-
*
|
|
57
|
-
* // Register services
|
|
58
|
-
* await discovery.register([
|
|
59
|
-
* new DatabaseService(),
|
|
60
|
-
* new CacheService(),
|
|
61
|
-
* new AuthService()
|
|
62
|
-
* ]);
|
|
63
|
-
*
|
|
64
|
-
* // Retrieve services
|
|
65
|
-
* const db = await discovery.get('database');
|
|
66
|
-
* const { cache, auth } = await discovery.getMany(['cache', 'auth']);
|
|
67
|
-
* ```
|
|
68
|
-
*/
|
|
69
|
-
export class ServiceDiscovery<
|
|
70
|
-
TServices extends Record<string, unknown> = {},
|
|
71
|
-
TLogger extends Logger = Logger,
|
|
72
|
-
> {
|
|
73
|
-
/** Singleton instance of ServiceDiscovery */
|
|
74
|
-
private static _instance: ServiceDiscovery<any, any>;
|
|
75
|
-
/** Map of registered service definitions */
|
|
76
|
-
private services = new Map<string, Service>();
|
|
77
|
-
/** Map of instantiated service instances */
|
|
78
|
-
private instances = new Map<keyof TServices, TServices[keyof TServices]>();
|
|
79
|
-
|
|
80
|
-
/**
|
|
81
|
-
* Gets the singleton instance of ServiceDiscovery.
|
|
82
|
-
* Creates a new instance if one doesn't exist.
|
|
83
|
-
*
|
|
84
|
-
* @template T - Record type mapping service names to their instance types
|
|
85
|
-
* @template TLogger - Logger type for internal logging
|
|
86
|
-
* @param logger - Logger instance for service logging
|
|
87
|
-
* @param envParser - Environment parser for service configuration
|
|
88
|
-
* @returns The ServiceDiscovery singleton instance
|
|
89
|
-
*
|
|
90
|
-
* @example
|
|
91
|
-
* ```typescript
|
|
92
|
-
* const services = ServiceDiscovery.getInstance<MyServices>(logger, envParser);
|
|
93
|
-
* ```
|
|
94
|
-
*/
|
|
95
|
-
static getInstance<
|
|
96
|
-
T extends Record<any, unknown> = any,
|
|
97
|
-
TLogger extends Logger = Logger,
|
|
98
|
-
>(logger: TLogger, envParser: EnvironmentParser<{}>): ServiceDiscovery<T> {
|
|
99
|
-
if (!ServiceDiscovery._instance) {
|
|
100
|
-
ServiceDiscovery._instance = new ServiceDiscovery<T, TLogger>(
|
|
101
|
-
logger,
|
|
102
|
-
envParser,
|
|
103
|
-
);
|
|
104
|
-
}
|
|
105
|
-
return ServiceDiscovery._instance as ServiceDiscovery<T>;
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
/**
|
|
109
|
-
* Private constructor to enforce singleton pattern.
|
|
110
|
-
*
|
|
111
|
-
* @param logger - Logger instance for service logging
|
|
112
|
-
* @param envParser - Environment parser for service configuration
|
|
113
|
-
* @private
|
|
114
|
-
*/
|
|
115
|
-
private constructor(
|
|
116
|
-
readonly logger: TLogger,
|
|
117
|
-
readonly envParser: EnvironmentParser<{}>,
|
|
118
|
-
) {}
|
|
119
|
-
|
|
120
|
-
/**
|
|
121
|
-
* Register multiple services with the service discovery.
|
|
122
|
-
* Services are instantiated lazily on first access.
|
|
123
|
-
* Already instantiated services are returned from cache.
|
|
124
|
-
*
|
|
125
|
-
* @template T - Array type of services to register
|
|
126
|
-
* @param services - Array of services to register
|
|
127
|
-
* @returns Promise resolving to a record of service names to instances
|
|
128
|
-
*
|
|
129
|
-
* @example
|
|
130
|
-
* ```typescript
|
|
131
|
-
* const services = await discovery.register([
|
|
132
|
-
* new DatabaseService(),
|
|
133
|
-
* new CacheService(),
|
|
134
|
-
* new AuthService()
|
|
135
|
-
* ]);
|
|
136
|
-
*
|
|
137
|
-
* // services = {
|
|
138
|
-
* // database: Database instance,
|
|
139
|
-
* // cache: CacheService instance,
|
|
140
|
-
* // auth: AuthService instance
|
|
141
|
-
* // }
|
|
142
|
-
* ```
|
|
143
|
-
*/
|
|
144
|
-
async register<T extends Service[]>(services: T): Promise<ServiceRecord<T>> {
|
|
145
|
-
const registeredServices = {} as ServiceRecord<T>;
|
|
146
|
-
for (const service of services) {
|
|
147
|
-
const name = service.serviceName as T[number]['serviceName'];
|
|
148
|
-
if (this.instances.has(name)) {
|
|
149
|
-
(registeredServices as any)[name] = this.instances.get(
|
|
150
|
-
name,
|
|
151
|
-
) as TServices[keyof TServices];
|
|
152
|
-
continue;
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
const instance = await service.register(this.envParser);
|
|
156
|
-
|
|
157
|
-
this.instances.set(name, instance as TServices[keyof TServices]);
|
|
158
|
-
(registeredServices as any)[name] =
|
|
159
|
-
instance as TServices[keyof TServices];
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
return registeredServices;
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
/**
|
|
166
|
-
* Get a service from the service discovery.
|
|
167
|
-
* Services are instantiated on first access if not already cached.
|
|
168
|
-
*
|
|
169
|
-
* @template K - The service name key
|
|
170
|
-
* @param name - The name of the service to get
|
|
171
|
-
* @returns Promise resolving to the service instance
|
|
172
|
-
* @throws {Error} If the service is not registered
|
|
173
|
-
*
|
|
174
|
-
* @example
|
|
175
|
-
* ```typescript
|
|
176
|
-
* const database = await discovery.get('database');
|
|
177
|
-
* const users = await database.query('SELECT * FROM users');
|
|
178
|
-
* ```
|
|
179
|
-
*/
|
|
180
|
-
get<K extends keyof TServices & string>(name: K): Promise<TServices[K]> {
|
|
181
|
-
const service = this.services.get(name);
|
|
182
|
-
|
|
183
|
-
if (!service) {
|
|
184
|
-
throw new Error(`Service '${name}' not found in service discovery`);
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
return service.register(this.envParser) as Promise<TServices[K]>;
|
|
188
|
-
}
|
|
189
|
-
/**
|
|
190
|
-
* Get multiple services from the service discovery.
|
|
191
|
-
* Useful for retrieving multiple dependencies at once.
|
|
192
|
-
*
|
|
193
|
-
* @template K - Array of service name keys
|
|
194
|
-
* @param names - Array of service names to retrieve
|
|
195
|
-
* @returns Promise resolving to an object containing the service instances
|
|
196
|
-
*
|
|
197
|
-
* @example
|
|
198
|
-
* ```typescript
|
|
199
|
-
* const { database, cache, auth } = await discovery.getMany([
|
|
200
|
-
* 'database',
|
|
201
|
-
* 'cache',
|
|
202
|
-
* 'auth'
|
|
203
|
-
* ]);
|
|
204
|
-
* ```
|
|
205
|
-
*/
|
|
206
|
-
async getMany<K extends (keyof TServices & string)[]>(
|
|
207
|
-
names: [...K],
|
|
208
|
-
): Promise<{ [P in K[number]]: TServices[P] }> {
|
|
209
|
-
const result = {} as { [P in K[number]]: TServices[P] };
|
|
210
|
-
|
|
211
|
-
for (const name of names) {
|
|
212
|
-
result[name] = await this.get(name);
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
return result;
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
/**
|
|
219
|
-
* Check if a service exists in the service discovery.
|
|
220
|
-
* Can check by service name or service instance.
|
|
221
|
-
*
|
|
222
|
-
* @param service - The service name or service instance to check
|
|
223
|
-
* @returns True if the service exists, false otherwise
|
|
224
|
-
*
|
|
225
|
-
* @example
|
|
226
|
-
* ```typescript
|
|
227
|
-
* if (discovery.has('database')) {
|
|
228
|
-
* const db = await discovery.get('database');
|
|
229
|
-
* }
|
|
230
|
-
*
|
|
231
|
-
* // Or check with service instance
|
|
232
|
-
* const dbService = new DatabaseService();
|
|
233
|
-
* if (!discovery.has(dbService)) {
|
|
234
|
-
* await discovery.register([dbService]);
|
|
235
|
-
* }
|
|
236
|
-
* ```
|
|
237
|
-
*/
|
|
238
|
-
has(service: string | Service): boolean {
|
|
239
|
-
if (typeof service === 'string') {
|
|
240
|
-
return this.services.has(service);
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
return this.services.has(service.serviceName);
|
|
244
|
-
}
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
/**
|
|
248
|
-
* Utility type to extract service names from an array of services.
|
|
249
|
-
*
|
|
250
|
-
* @template T - Array of Service types
|
|
251
|
-
*
|
|
252
|
-
* @example
|
|
253
|
-
* ```typescript
|
|
254
|
-
* type Names = ExtractServiceNames<[DatabaseService, CacheService]>;
|
|
255
|
-
* // type Names = 'database' | 'cache'
|
|
256
|
-
* ```
|
|
257
|
-
*/
|
|
258
|
-
export type ExtractServiceNames<T extends Service[]> = T[number]['serviceName'];
|
|
259
|
-
|
|
260
|
-
/**
|
|
261
|
-
* Utility type to create a record type from an array of services.
|
|
262
|
-
* Maps service names to their registered instance types.
|
|
263
|
-
*
|
|
264
|
-
* @template T - Array of Service types
|
|
265
|
-
*
|
|
266
|
-
* @example
|
|
267
|
-
* ```typescript
|
|
268
|
-
* type MyServiceRecord = ServiceRecord<[DatabaseService, CacheService]>;
|
|
269
|
-
* // type MyServiceRecord = {
|
|
270
|
-
* // database: Database;
|
|
271
|
-
* // cache: CacheService;
|
|
272
|
-
* // }
|
|
273
|
-
* ```
|
|
274
|
-
*/
|
|
275
|
-
export type ServiceRecord<T extends Service[]> = {
|
|
276
|
-
[K in T[number] as K['serviceName']]: K extends Service
|
|
277
|
-
? Awaited<ReturnType<K['register']>>
|
|
278
|
-
: never;
|
|
279
|
-
};
|
|
1
|
+
// Re-export types
|
|
2
|
+
|
|
3
|
+
// Re-export context utilities
|
|
4
|
+
export {
|
|
5
|
+
type RequestContextData,
|
|
6
|
+
runWithRequestContext,
|
|
7
|
+
serviceContext,
|
|
8
|
+
} from './context';
|
|
9
|
+
// Re-export ServiceDiscovery and utility types
|
|
10
|
+
export {
|
|
11
|
+
type ExtractServiceNames,
|
|
12
|
+
ServiceDiscovery,
|
|
13
|
+
type ServiceRecord,
|
|
14
|
+
} from './ServiceDiscovery';
|
|
15
|
+
export type { Service, ServiceContext, ServiceRegisterOptions } from './types';
|
package/src/types.ts
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import type { EnvironmentParser } from '@geekmidas/envkit';
|
|
2
|
+
import type { Logger } from '@geekmidas/logger';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Request context available to services.
|
|
6
|
+
* Methods are guaranteed to return values when called within a request context.
|
|
7
|
+
* Throws if called outside a request context (catches bugs early).
|
|
8
|
+
*/
|
|
9
|
+
export interface ServiceContext {
|
|
10
|
+
/**
|
|
11
|
+
* Get the current request's logger.
|
|
12
|
+
* @throws Error if called outside a request context
|
|
13
|
+
*/
|
|
14
|
+
getLogger(): Logger;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Get the current request ID.
|
|
18
|
+
* @throws Error if called outside a request context
|
|
19
|
+
*/
|
|
20
|
+
getRequestId(): string;
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Get the current request's start time (from Date.now()).
|
|
24
|
+
* Useful for calculating request duration.
|
|
25
|
+
* @throws Error if called outside a request context
|
|
26
|
+
*/
|
|
27
|
+
getRequestStartTime(): number;
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Check if currently running inside a request context.
|
|
31
|
+
* Use this to guard calls if you need to handle both cases.
|
|
32
|
+
*/
|
|
33
|
+
hasContext(): boolean;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Options passed to service register method.
|
|
38
|
+
*/
|
|
39
|
+
export interface ServiceRegisterOptions {
|
|
40
|
+
/** Environment parser for configuration */
|
|
41
|
+
envParser: EnvironmentParser<{}>;
|
|
42
|
+
/** Request context for logging and tracing */
|
|
43
|
+
context: ServiceContext;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Service interface for the simplified service pattern.
|
|
48
|
+
* Services are objects with a serviceName and register method.
|
|
49
|
+
*
|
|
50
|
+
* @template TName - The literal string type for the service name
|
|
51
|
+
* @template TInstance - The type of the service instance that will be registered
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```typescript
|
|
55
|
+
* const databaseService = {
|
|
56
|
+
* serviceName: 'database' as const,
|
|
57
|
+
* register({ envParser, context }: ServiceRegisterOptions) {
|
|
58
|
+
* const config = envParser.create((get) => ({
|
|
59
|
+
* url: get('DATABASE_URL').string()
|
|
60
|
+
* })).parse();
|
|
61
|
+
*
|
|
62
|
+
* return {
|
|
63
|
+
* async query(sql: string) {
|
|
64
|
+
* const logger = context.getLogger();
|
|
65
|
+
* logger.debug({ sql }, 'Executing query');
|
|
66
|
+
* // ... execute query
|
|
67
|
+
* }
|
|
68
|
+
* };
|
|
69
|
+
* }
|
|
70
|
+
* } satisfies Service<'database', DatabaseInstance>;
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
export interface Service<TName extends string = string, TInstance = unknown> {
|
|
74
|
+
/**
|
|
75
|
+
* Unique name for the service, used for lookup via services.get()
|
|
76
|
+
*/
|
|
77
|
+
serviceName: TName;
|
|
78
|
+
/**
|
|
79
|
+
* Register method that returns the actual service instance.
|
|
80
|
+
* Called once on first access, then cached.
|
|
81
|
+
*
|
|
82
|
+
* @param options - Registration options including envParser and context
|
|
83
|
+
*/
|
|
84
|
+
register(options: ServiceRegisterOptions): TInstance | Promise<TInstance>;
|
|
85
|
+
}
|
package/tsconfig.json
ADDED
package/dist/index.cjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs","names":["logger: TLogger","envParser: EnvironmentParser<{}>","services: T","name: K","names: [...K]","service: string | Service"],"sources":["../src/index.ts"],"sourcesContent":["import type { EnvironmentParser } from '@geekmidas/envkit';\nimport type { Logger } from '@geekmidas/logger';\n\n/**\n * Service interface for the new simplified service pattern.\n * Services are objects with a serviceName and register method.\n *\n * @template TName - The literal string type for the service name\n * @template TInstance - The type of the service instance that will be registered\n *\n * @example\n * ```typescript\n * class DatabaseService implements Service<'database', Database> {\n * serviceName = 'database' as const;\n *\n * async register(envParser: EnvironmentParser<{}>): Promise<Database> {\n * const config = envParser.create((get) => ({\n * url: get('DATABASE_URL').string()\n * })).parse();\n *\n * return new Database(config.url);\n * }\n * }\n * ```\n */\nexport interface Service<TName extends string = string, TInstance = unknown> {\n /**\n * Unique name for the service, used for lookup via services.get()\n */\n serviceName: TName;\n /**\n * Register method that returns the actual service instance.\n * Called once on first access, then cached.\n */\n register(envParser: EnvironmentParser<{}>): TInstance | Promise<TInstance>;\n}\n\n/**\n * Service discovery container that manages service registration and retrieval.\n * Implements a singleton pattern with lazy initialization of services.\n *\n * @template TServices - Record type mapping service names to their instance types\n * @template TLogger - Logger type for internal logging\n *\n * @example\n * ```typescript\n * // Define service types\n * interface MyServices {\n * database: Database;\n * cache: CacheService;\n * auth: AuthService;\n * }\n *\n * // Get service discovery instance\n * const discovery = ServiceDiscovery.getInstance<MyServices>(logger, envParser);\n *\n * // Register services\n * await discovery.register([\n * new DatabaseService(),\n * new CacheService(),\n * new AuthService()\n * ]);\n *\n * // Retrieve services\n * const db = await discovery.get('database');\n * const { cache, auth } = await discovery.getMany(['cache', 'auth']);\n * ```\n */\nexport class ServiceDiscovery<\n TServices extends Record<string, unknown> = {},\n TLogger extends Logger = Logger,\n> {\n /** Singleton instance of ServiceDiscovery */\n private static _instance: ServiceDiscovery<any, any>;\n /** Map of registered service definitions */\n private services = new Map<string, Service>();\n /** Map of instantiated service instances */\n private instances = new Map<keyof TServices, TServices[keyof TServices]>();\n\n /**\n * Gets the singleton instance of ServiceDiscovery.\n * Creates a new instance if one doesn't exist.\n *\n * @template T - Record type mapping service names to their instance types\n * @template TLogger - Logger type for internal logging\n * @param logger - Logger instance for service logging\n * @param envParser - Environment parser for service configuration\n * @returns The ServiceDiscovery singleton instance\n *\n * @example\n * ```typescript\n * const services = ServiceDiscovery.getInstance<MyServices>(logger, envParser);\n * ```\n */\n static getInstance<\n T extends Record<any, unknown> = any,\n TLogger extends Logger = Logger,\n >(logger: TLogger, envParser: EnvironmentParser<{}>): ServiceDiscovery<T> {\n if (!ServiceDiscovery._instance) {\n ServiceDiscovery._instance = new ServiceDiscovery<T, TLogger>(\n logger,\n envParser,\n );\n }\n return ServiceDiscovery._instance as ServiceDiscovery<T>;\n }\n\n /**\n * Private constructor to enforce singleton pattern.\n *\n * @param logger - Logger instance for service logging\n * @param envParser - Environment parser for service configuration\n * @private\n */\n private constructor(\n readonly logger: TLogger,\n readonly envParser: EnvironmentParser<{}>,\n ) {}\n\n /**\n * Register multiple services with the service discovery.\n * Services are instantiated lazily on first access.\n * Already instantiated services are returned from cache.\n *\n * @template T - Array type of services to register\n * @param services - Array of services to register\n * @returns Promise resolving to a record of service names to instances\n *\n * @example\n * ```typescript\n * const services = await discovery.register([\n * new DatabaseService(),\n * new CacheService(),\n * new AuthService()\n * ]);\n *\n * // services = {\n * // database: Database instance,\n * // cache: CacheService instance,\n * // auth: AuthService instance\n * // }\n * ```\n */\n async register<T extends Service[]>(services: T): Promise<ServiceRecord<T>> {\n const registeredServices = {} as ServiceRecord<T>;\n for (const service of services) {\n const name = service.serviceName as T[number]['serviceName'];\n if (this.instances.has(name)) {\n (registeredServices as any)[name] = this.instances.get(\n name,\n ) as TServices[keyof TServices];\n continue;\n }\n\n const instance = await service.register(this.envParser);\n\n this.instances.set(name, instance as TServices[keyof TServices]);\n (registeredServices as any)[name] =\n instance as TServices[keyof TServices];\n }\n\n return registeredServices;\n }\n\n /**\n * Get a service from the service discovery.\n * Services are instantiated on first access if not already cached.\n *\n * @template K - The service name key\n * @param name - The name of the service to get\n * @returns Promise resolving to the service instance\n * @throws {Error} If the service is not registered\n *\n * @example\n * ```typescript\n * const database = await discovery.get('database');\n * const users = await database.query('SELECT * FROM users');\n * ```\n */\n get<K extends keyof TServices & string>(name: K): Promise<TServices[K]> {\n const service = this.services.get(name);\n\n if (!service) {\n throw new Error(`Service '${name}' not found in service discovery`);\n }\n\n return service.register(this.envParser) as Promise<TServices[K]>;\n }\n /**\n * Get multiple services from the service discovery.\n * Useful for retrieving multiple dependencies at once.\n *\n * @template K - Array of service name keys\n * @param names - Array of service names to retrieve\n * @returns Promise resolving to an object containing the service instances\n *\n * @example\n * ```typescript\n * const { database, cache, auth } = await discovery.getMany([\n * 'database',\n * 'cache',\n * 'auth'\n * ]);\n * ```\n */\n async getMany<K extends (keyof TServices & string)[]>(\n names: [...K],\n ): Promise<{ [P in K[number]]: TServices[P] }> {\n const result = {} as { [P in K[number]]: TServices[P] };\n\n for (const name of names) {\n result[name] = await this.get(name);\n }\n\n return result;\n }\n\n /**\n * Check if a service exists in the service discovery.\n * Can check by service name or service instance.\n *\n * @param service - The service name or service instance to check\n * @returns True if the service exists, false otherwise\n *\n * @example\n * ```typescript\n * if (discovery.has('database')) {\n * const db = await discovery.get('database');\n * }\n *\n * // Or check with service instance\n * const dbService = new DatabaseService();\n * if (!discovery.has(dbService)) {\n * await discovery.register([dbService]);\n * }\n * ```\n */\n has(service: string | Service): boolean {\n if (typeof service === 'string') {\n return this.services.has(service);\n }\n\n return this.services.has(service.serviceName);\n }\n}\n\n/**\n * Utility type to extract service names from an array of services.\n *\n * @template T - Array of Service types\n *\n * @example\n * ```typescript\n * type Names = ExtractServiceNames<[DatabaseService, CacheService]>;\n * // type Names = 'database' | 'cache'\n * ```\n */\nexport type ExtractServiceNames<T extends Service[]> = T[number]['serviceName'];\n\n/**\n * Utility type to create a record type from an array of services.\n * Maps service names to their registered instance types.\n *\n * @template T - Array of Service types\n *\n * @example\n * ```typescript\n * type MyServiceRecord = ServiceRecord<[DatabaseService, CacheService]>;\n * // type MyServiceRecord = {\n * // database: Database;\n * // cache: CacheService;\n * // }\n * ```\n */\nexport type ServiceRecord<T extends Service[]> = {\n [K in T[number] as K['serviceName']]: K extends Service\n ? Awaited<ReturnType<K['register']>>\n : never;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,IAAa,mBAAb,MAAa,iBAGX;;CAEA,OAAe;;CAEf,AAAQ,2BAAW,IAAI;;CAEvB,AAAQ,4BAAY,IAAI;;;;;;;;;;;;;;;;CAiBxB,OAAO,YAGLA,QAAiBC,WAAuD;AACxE,OAAK,iBAAiB,UACpB,kBAAiB,YAAY,IAAI,iBAC/B,QACA;AAGJ,SAAO,iBAAiB;CACzB;;;;;;;;CASD,AAAQ,YACGD,QACAC,WACT;EAFS;EACA;CACP;;;;;;;;;;;;;;;;;;;;;;;;;CA0BJ,MAAM,SAA8BC,UAAwC;EAC1E,MAAM,qBAAqB,CAAE;AAC7B,OAAK,MAAM,WAAW,UAAU;GAC9B,MAAM,OAAO,QAAQ;AACrB,OAAI,KAAK,UAAU,IAAI,KAAK,EAAE;AAC5B,IAAC,mBAA2B,QAAQ,KAAK,UAAU,IACjD,KACD;AACD;GACD;GAED,MAAM,WAAW,MAAM,QAAQ,SAAS,KAAK,UAAU;AAEvD,QAAK,UAAU,IAAI,MAAM,SAAuC;AAChE,GAAC,mBAA2B,QAC1B;EACH;AAED,SAAO;CACR;;;;;;;;;;;;;;;;CAiBD,IAAwCC,MAAgC;EACtE,MAAM,UAAU,KAAK,SAAS,IAAI,KAAK;AAEvC,OAAK,QACH,OAAM,IAAI,OAAO,WAAW,KAAK;AAGnC,SAAO,QAAQ,SAAS,KAAK,UAAU;CACxC;;;;;;;;;;;;;;;;;;CAkBD,MAAM,QACJC,OAC6C;EAC7C,MAAM,SAAS,CAAE;AAEjB,OAAK,MAAM,QAAQ,MACjB,QAAO,QAAQ,MAAM,KAAK,IAAI,KAAK;AAGrC,SAAO;CACR;;;;;;;;;;;;;;;;;;;;;CAsBD,IAAIC,SAAoC;AACtC,aAAW,YAAY,SACrB,QAAO,KAAK,SAAS,IAAI,QAAQ;AAGnC,SAAO,KAAK,SAAS,IAAI,QAAQ,YAAY;CAC9C;AACF"}
|
package/dist/index.mjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":["logger: TLogger","envParser: EnvironmentParser<{}>","services: T","name: K","names: [...K]","service: string | Service"],"sources":["../src/index.ts"],"sourcesContent":["import type { EnvironmentParser } from '@geekmidas/envkit';\nimport type { Logger } from '@geekmidas/logger';\n\n/**\n * Service interface for the new simplified service pattern.\n * Services are objects with a serviceName and register method.\n *\n * @template TName - The literal string type for the service name\n * @template TInstance - The type of the service instance that will be registered\n *\n * @example\n * ```typescript\n * class DatabaseService implements Service<'database', Database> {\n * serviceName = 'database' as const;\n *\n * async register(envParser: EnvironmentParser<{}>): Promise<Database> {\n * const config = envParser.create((get) => ({\n * url: get('DATABASE_URL').string()\n * })).parse();\n *\n * return new Database(config.url);\n * }\n * }\n * ```\n */\nexport interface Service<TName extends string = string, TInstance = unknown> {\n /**\n * Unique name for the service, used for lookup via services.get()\n */\n serviceName: TName;\n /**\n * Register method that returns the actual service instance.\n * Called once on first access, then cached.\n */\n register(envParser: EnvironmentParser<{}>): TInstance | Promise<TInstance>;\n}\n\n/**\n * Service discovery container that manages service registration and retrieval.\n * Implements a singleton pattern with lazy initialization of services.\n *\n * @template TServices - Record type mapping service names to their instance types\n * @template TLogger - Logger type for internal logging\n *\n * @example\n * ```typescript\n * // Define service types\n * interface MyServices {\n * database: Database;\n * cache: CacheService;\n * auth: AuthService;\n * }\n *\n * // Get service discovery instance\n * const discovery = ServiceDiscovery.getInstance<MyServices>(logger, envParser);\n *\n * // Register services\n * await discovery.register([\n * new DatabaseService(),\n * new CacheService(),\n * new AuthService()\n * ]);\n *\n * // Retrieve services\n * const db = await discovery.get('database');\n * const { cache, auth } = await discovery.getMany(['cache', 'auth']);\n * ```\n */\nexport class ServiceDiscovery<\n TServices extends Record<string, unknown> = {},\n TLogger extends Logger = Logger,\n> {\n /** Singleton instance of ServiceDiscovery */\n private static _instance: ServiceDiscovery<any, any>;\n /** Map of registered service definitions */\n private services = new Map<string, Service>();\n /** Map of instantiated service instances */\n private instances = new Map<keyof TServices, TServices[keyof TServices]>();\n\n /**\n * Gets the singleton instance of ServiceDiscovery.\n * Creates a new instance if one doesn't exist.\n *\n * @template T - Record type mapping service names to their instance types\n * @template TLogger - Logger type for internal logging\n * @param logger - Logger instance for service logging\n * @param envParser - Environment parser for service configuration\n * @returns The ServiceDiscovery singleton instance\n *\n * @example\n * ```typescript\n * const services = ServiceDiscovery.getInstance<MyServices>(logger, envParser);\n * ```\n */\n static getInstance<\n T extends Record<any, unknown> = any,\n TLogger extends Logger = Logger,\n >(logger: TLogger, envParser: EnvironmentParser<{}>): ServiceDiscovery<T> {\n if (!ServiceDiscovery._instance) {\n ServiceDiscovery._instance = new ServiceDiscovery<T, TLogger>(\n logger,\n envParser,\n );\n }\n return ServiceDiscovery._instance as ServiceDiscovery<T>;\n }\n\n /**\n * Private constructor to enforce singleton pattern.\n *\n * @param logger - Logger instance for service logging\n * @param envParser - Environment parser for service configuration\n * @private\n */\n private constructor(\n readonly logger: TLogger,\n readonly envParser: EnvironmentParser<{}>,\n ) {}\n\n /**\n * Register multiple services with the service discovery.\n * Services are instantiated lazily on first access.\n * Already instantiated services are returned from cache.\n *\n * @template T - Array type of services to register\n * @param services - Array of services to register\n * @returns Promise resolving to a record of service names to instances\n *\n * @example\n * ```typescript\n * const services = await discovery.register([\n * new DatabaseService(),\n * new CacheService(),\n * new AuthService()\n * ]);\n *\n * // services = {\n * // database: Database instance,\n * // cache: CacheService instance,\n * // auth: AuthService instance\n * // }\n * ```\n */\n async register<T extends Service[]>(services: T): Promise<ServiceRecord<T>> {\n const registeredServices = {} as ServiceRecord<T>;\n for (const service of services) {\n const name = service.serviceName as T[number]['serviceName'];\n if (this.instances.has(name)) {\n (registeredServices as any)[name] = this.instances.get(\n name,\n ) as TServices[keyof TServices];\n continue;\n }\n\n const instance = await service.register(this.envParser);\n\n this.instances.set(name, instance as TServices[keyof TServices]);\n (registeredServices as any)[name] =\n instance as TServices[keyof TServices];\n }\n\n return registeredServices;\n }\n\n /**\n * Get a service from the service discovery.\n * Services are instantiated on first access if not already cached.\n *\n * @template K - The service name key\n * @param name - The name of the service to get\n * @returns Promise resolving to the service instance\n * @throws {Error} If the service is not registered\n *\n * @example\n * ```typescript\n * const database = await discovery.get('database');\n * const users = await database.query('SELECT * FROM users');\n * ```\n */\n get<K extends keyof TServices & string>(name: K): Promise<TServices[K]> {\n const service = this.services.get(name);\n\n if (!service) {\n throw new Error(`Service '${name}' not found in service discovery`);\n }\n\n return service.register(this.envParser) as Promise<TServices[K]>;\n }\n /**\n * Get multiple services from the service discovery.\n * Useful for retrieving multiple dependencies at once.\n *\n * @template K - Array of service name keys\n * @param names - Array of service names to retrieve\n * @returns Promise resolving to an object containing the service instances\n *\n * @example\n * ```typescript\n * const { database, cache, auth } = await discovery.getMany([\n * 'database',\n * 'cache',\n * 'auth'\n * ]);\n * ```\n */\n async getMany<K extends (keyof TServices & string)[]>(\n names: [...K],\n ): Promise<{ [P in K[number]]: TServices[P] }> {\n const result = {} as { [P in K[number]]: TServices[P] };\n\n for (const name of names) {\n result[name] = await this.get(name);\n }\n\n return result;\n }\n\n /**\n * Check if a service exists in the service discovery.\n * Can check by service name or service instance.\n *\n * @param service - The service name or service instance to check\n * @returns True if the service exists, false otherwise\n *\n * @example\n * ```typescript\n * if (discovery.has('database')) {\n * const db = await discovery.get('database');\n * }\n *\n * // Or check with service instance\n * const dbService = new DatabaseService();\n * if (!discovery.has(dbService)) {\n * await discovery.register([dbService]);\n * }\n * ```\n */\n has(service: string | Service): boolean {\n if (typeof service === 'string') {\n return this.services.has(service);\n }\n\n return this.services.has(service.serviceName);\n }\n}\n\n/**\n * Utility type to extract service names from an array of services.\n *\n * @template T - Array of Service types\n *\n * @example\n * ```typescript\n * type Names = ExtractServiceNames<[DatabaseService, CacheService]>;\n * // type Names = 'database' | 'cache'\n * ```\n */\nexport type ExtractServiceNames<T extends Service[]> = T[number]['serviceName'];\n\n/**\n * Utility type to create a record type from an array of services.\n * Maps service names to their registered instance types.\n *\n * @template T - Array of Service types\n *\n * @example\n * ```typescript\n * type MyServiceRecord = ServiceRecord<[DatabaseService, CacheService]>;\n * // type MyServiceRecord = {\n * // database: Database;\n * // cache: CacheService;\n * // }\n * ```\n */\nexport type ServiceRecord<T extends Service[]> = {\n [K in T[number] as K['serviceName']]: K extends Service\n ? Awaited<ReturnType<K['register']>>\n : never;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,IAAa,mBAAb,MAAa,iBAGX;;CAEA,OAAe;;CAEf,AAAQ,2BAAW,IAAI;;CAEvB,AAAQ,4BAAY,IAAI;;;;;;;;;;;;;;;;CAiBxB,OAAO,YAGLA,QAAiBC,WAAuD;AACxE,OAAK,iBAAiB,UACpB,kBAAiB,YAAY,IAAI,iBAC/B,QACA;AAGJ,SAAO,iBAAiB;CACzB;;;;;;;;CASD,AAAQ,YACGD,QACAC,WACT;EAFS;EACA;CACP;;;;;;;;;;;;;;;;;;;;;;;;;CA0BJ,MAAM,SAA8BC,UAAwC;EAC1E,MAAM,qBAAqB,CAAE;AAC7B,OAAK,MAAM,WAAW,UAAU;GAC9B,MAAM,OAAO,QAAQ;AACrB,OAAI,KAAK,UAAU,IAAI,KAAK,EAAE;AAC5B,IAAC,mBAA2B,QAAQ,KAAK,UAAU,IACjD,KACD;AACD;GACD;GAED,MAAM,WAAW,MAAM,QAAQ,SAAS,KAAK,UAAU;AAEvD,QAAK,UAAU,IAAI,MAAM,SAAuC;AAChE,GAAC,mBAA2B,QAC1B;EACH;AAED,SAAO;CACR;;;;;;;;;;;;;;;;CAiBD,IAAwCC,MAAgC;EACtE,MAAM,UAAU,KAAK,SAAS,IAAI,KAAK;AAEvC,OAAK,QACH,OAAM,IAAI,OAAO,WAAW,KAAK;AAGnC,SAAO,QAAQ,SAAS,KAAK,UAAU;CACxC;;;;;;;;;;;;;;;;;;CAkBD,MAAM,QACJC,OAC6C;EAC7C,MAAM,SAAS,CAAE;AAEjB,OAAK,MAAM,QAAQ,MACjB,QAAO,QAAQ,MAAM,KAAK,IAAI,KAAK;AAGrC,SAAO;CACR;;;;;;;;;;;;;;;;;;;;;CAsBD,IAAIC,SAAoC;AACtC,aAAW,YAAY,SACrB,QAAO,KAAK,SAAS,IAAI,QAAQ;AAGnC,SAAO,KAAK,SAAS,IAAI,QAAQ,YAAY;CAC9C;AACF"}
|