@guren/server 2.14.0 → 2.16.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/{DocsViewerServiceProvider-qFCaeiUv.js → DocsViewerServiceProvider-D2cuVgtN.js} +7 -12
- package/dist/{Hash-CzrwKeDp.js → Hash-D2DFd8xX.js} +12 -57
- package/dist/{HttpException-BkS3euNG.js → HttpException-BlQ2yEmT.js} +2 -79
- package/dist/{Job-BVT813DO.js → Job-DxQK8h3P.js} +24 -179
- package/dist/{McpServiceProvider-BawsYjgN.js → McpServiceProvider-nNcbCIQX.js} +11 -20
- package/dist/{Random-DbIJ22KQ.js → Random-S0OvCuR8.js} +9 -106
- package/dist/agent/AgentApprovalRequested.d.ts +31 -0
- package/dist/agent/approval.d.ts +184 -0
- package/dist/agent/audit-emitter.d.ts +36 -0
- package/dist/agent/audit.d.ts +67 -0
- package/dist/agent/derive.d.ts +32 -66
- package/dist/agent/dispatch.d.ts +53 -63
- package/dist/agent/events.d.ts +11 -19
- package/dist/agent/meta-tools.d.ts +34 -0
- package/dist/agent/public.d.ts +14 -0
- package/dist/agent/public.js +2 -0
- package/dist/agent/redact.d.ts +16 -38
- package/dist/agent/scopes.d.ts +23 -69
- package/dist/auth/AuthManager.d.ts +19 -40
- package/dist/auth/AuthenticatableModel.d.ts +2 -2
- package/dist/auth/SessionGuard.d.ts +0 -1
- package/dist/auth/TokenGuard.d.ts +6 -26
- package/dist/auth/api-token.d.ts +16 -148
- package/dist/auth/context.d.ts +5 -10
- package/dist/auth/email-verification.d.ts +29 -127
- package/dist/auth/index.js +1 -1
- package/dist/auth/oauth/index.d.ts +35 -57
- package/dist/auth/password/DefaultHasher.d.ts +9 -5
- package/dist/auth/password/PasswordHasher.d.ts +7 -0
- package/dist/auth/password/hash-format.d.ts +11 -0
- package/dist/auth/password-reset.d.ts +16 -42
- package/dist/auth/providers/ModelUserProvider.d.ts +3 -4
- package/dist/auth/providers/UserProvider.d.ts +4 -4
- package/dist/auth/signed-token.d.ts +18 -0
- package/dist/auth/types.d.ts +9 -32
- package/dist/auth/utils.d.ts +6 -27
- package/dist/{auth-BSUc14CD.js → auth-CbdPH4Cd.js} +252 -496
- package/dist/authorization/Gate.d.ts +9 -145
- package/dist/authorization/Policy.d.ts +6 -53
- package/dist/authorization/index.js +1 -1
- package/dist/authorization/middleware.d.ts +16 -62
- package/dist/authorization/types.d.ts +8 -64
- package/dist/{authorization-CdfbCj8J.js → authorization-CdEWZZw3.js} +44 -309
- package/dist/broadcasting/BroadcastManager.d.ts +29 -149
- package/dist/broadcasting/channels/Channel.d.ts +1 -19
- package/dist/broadcasting/channels/PresenceChannel.d.ts +1 -55
- package/dist/broadcasting/channels/PrivateChannel.d.ts +1 -23
- package/dist/broadcasting/drivers/MemoryDriver.d.ts +18 -70
- package/dist/broadcasting/drivers/RedisDriver.d.ts +3 -80
- package/dist/broadcasting/drivers/index.d.ts +1 -1
- package/dist/broadcasting/index.d.ts +1 -1
- package/dist/broadcasting/index.js +1 -1
- package/dist/broadcasting/types.d.ts +7 -88
- package/dist/{broadcasting-BxU-LIfF.js → broadcasting-B5RzB0A2.js} +87 -414
- package/dist/cache/CacheManager.d.ts +8 -62
- package/dist/cache/TaggedCache.d.ts +2 -35
- package/dist/cache/index.js +1 -1
- package/dist/cache/stores/FileStore.d.ts +2 -36
- package/dist/cache/stores/MemoryStore.d.ts +2 -26
- package/dist/cache/stores/RedisStore.d.ts +1 -29
- package/dist/cache/types.d.ts +21 -128
- package/dist/{cache-BYnZf2FR.js → cache-BOOIr324.js} +19 -198
- package/dist/client-C4TEr_Dd.js +9 -0
- package/dist/console/Command.d.ts +17 -126
- package/dist/console/ConsoleKernel.d.ts +2 -74
- package/dist/console/Input.d.ts +5 -113
- package/dist/console/Output.d.ts +3 -99
- package/dist/console/types.d.ts +3 -33
- package/dist/container/Container.d.ts +12 -103
- package/dist/container/ServiceProvider.d.ts +17 -61
- package/dist/container/bindings.d.ts +10 -12
- package/dist/container/defineModule.d.ts +16 -54
- package/dist/container/definePlugin.d.ts +12 -45
- package/dist/container/types.d.ts +2 -34
- package/dist/context-CXk_umpT.js +21 -0
- package/dist/database/Factory.d.ts +4 -57
- package/dist/database/Seeder.d.ts +8 -46
- package/dist/database/SeederRunner.d.ts +3 -33
- package/dist/database/types.d.ts +3 -24
- package/dist/discovery/AutoDiscovery.d.ts +10 -82
- package/dist/dispatch-BAwzftws.js +238 -0
- package/dist/docs-viewer/DocsViewerServiceProvider.d.ts +2 -5
- package/dist/docs-viewer/endpoint.d.ts +5 -11
- package/dist/encryption/Encrypter.d.ts +5 -71
- package/dist/encryption/Hash.d.ts +7 -57
- package/dist/encryption/Random.d.ts +6 -99
- package/dist/encryption/index.js +3 -3
- package/dist/encryption/types.d.ts +10 -72
- package/dist/{encryption-DJtkkhiw.js → encryption-uwP3Di4D.js} +13 -79
- package/dist/{endpoint-D6GIqOpe.js → endpoint-BXipU2Jj.js} +6 -12
- package/dist/endpoint-Dsw3Acvq.js +26 -0
- package/dist/errors/ExceptionHandler.d.ts +3 -90
- package/dist/errors/HttpException.d.ts +2 -79
- package/dist/errors/debug-page.d.ts +3 -17
- package/dist/errors/error-page.d.ts +1 -0
- package/dist/errors/exceptions/AuthenticationException.d.ts +2 -24
- package/dist/errors/exceptions/AuthorizationException.d.ts +1 -24
- package/dist/errors/exceptions/MethodNotAllowedException.d.ts +1 -23
- package/dist/errors/exceptions/NotFoundHttpException.d.ts +1 -27
- package/dist/errors/exceptions/ValidationException.d.ts +2 -43
- package/dist/errors/types.d.ts +1 -25
- package/dist/{errors-BgeOl_DC.js → errors-JpkcCjjn.js} +3 -41
- package/dist/events/Event.d.ts +1 -28
- package/dist/events/EventManager.d.ts +5 -107
- package/dist/events/Listener.d.ts +7 -55
- package/dist/events/builtin.d.ts +0 -24
- package/dist/events/index.js +1 -1
- package/dist/events/types.d.ts +4 -22
- package/dist/{events-aIH_bWRx.js → events-DOmAHDeP.js} +11 -191
- package/dist/facades/index.d.ts +2 -14
- package/dist/health/HealthCheck.d.ts +0 -24
- package/dist/health/HealthManager.d.ts +0 -36
- package/dist/health/checks/CacheCheck.d.ts +2 -17
- package/dist/health/checks/CustomCheck.d.ts +0 -9
- package/dist/health/checks/DatabaseCheck.d.ts +2 -17
- package/dist/health/checks/MemoryCheck.d.ts +3 -12
- package/dist/health/checks/RedisCheck.d.ts +1 -13
- package/dist/health/checks/StorageCheck.d.ts +2 -17
- package/dist/health/index.js +1 -1
- package/dist/health/types.d.ts +4 -24
- package/dist/{health-VWdWXRwh.js → health-DQSvUplL.js} +1 -76
- package/dist/hot-disposables-B5BXqaIH.js +167 -0
- package/dist/hot-reload/hot-disposables.d.ts +22 -74
- package/dist/hot-reload/testing.d.ts +4 -9
- package/dist/http/Application.d.ts +62 -208
- package/dist/http/FormRequest.d.ts +4 -55
- package/dist/http/dev-assets.d.ts +16 -18
- package/dist/http/dev-banner.d.ts +2 -5
- package/dist/http/inertia-assets.d.ts +3 -6
- package/dist/http/middleware/capabilities.d.ts +27 -50
- package/dist/http/middleware/cors.d.ts +4 -29
- package/dist/http/middleware/csp.d.ts +2 -25
- package/dist/http/middleware/csrf.d.ts +20 -95
- package/dist/http/middleware/detect-locale.d.ts +7 -27
- package/dist/http/middleware/force-https.d.ts +6 -24
- package/dist/http/middleware/host-authorization.d.ts +2 -12
- package/dist/http/middleware/loopback-guard.d.ts +15 -33
- package/dist/http/middleware/rate-limit.d.ts +29 -126
- package/dist/http/middleware/redirect-safety.d.ts +2 -20
- package/dist/http/middleware/request-id.d.ts +1 -14
- package/dist/http/middleware/request-logging.d.ts +2 -13
- package/dist/http/middleware/response-headers.d.ts +5 -13
- package/dist/http/middleware/security-headers.d.ts +2 -16
- package/dist/http/middleware/session.d.ts +15 -34
- package/dist/http/middleware/validation-errors-cookie.d.ts +7 -18
- package/dist/http/middleware/validation.d.ts +8 -63
- package/dist/http/public-assets.d.ts +14 -0
- package/dist/http/request.d.ts +49 -48
- package/dist/http/resources/CursorPaginator.d.ts +5 -64
- package/dist/http/resources/Paginator.d.ts +7 -84
- package/dist/http/resources/Resource.d.ts +9 -65
- package/dist/http/resources/ResourceCollection.d.ts +5 -39
- package/dist/http/resources/types.d.ts +10 -30
- package/dist/http/static-documents.d.ts +21 -0
- package/dist/http/validation/Validator.d.ts +25 -85
- package/dist/http/validation/rules.d.ts +48 -147
- package/dist/http/validation/types.d.ts +16 -61
- package/dist/http/vite-assets.d.ts +5 -28
- package/dist/http/vite-dev-server.d.ts +6 -9
- package/dist/http/vite-manifest.d.ts +19 -33
- package/dist/i18n/I18nManager.d.ts +12 -78
- package/dist/i18n/Translator.d.ts +3 -54
- package/dist/i18n/index.js +1 -1
- package/dist/i18n/loaders/JsonLoader.d.ts +4 -31
- package/dist/i18n/loaders/MemoryLoader.d.ts +1 -21
- package/dist/i18n/pluralization.d.ts +4 -13
- package/dist/i18n/types.d.ts +17 -69
- package/dist/{i18n-mcWi7LCd.js → i18n-Cg1aajRP.js} +31 -225
- package/dist/index.d.ts +13 -4
- package/dist/index.js +1036 -3080
- package/dist/internal/agent-preflight.d.ts +9 -21
- package/dist/internal/request.d.ts +10 -17
- package/dist/internal/request.js +2 -2
- package/dist/internal/route-path.d.ts +9 -21
- package/dist/internal/route-path.js +9 -21
- package/dist/internal/zod-compat.d.ts +55 -122
- package/dist/internal/zod-compat.js +39 -70
- package/dist/internal/zod-json-schema.d.ts +18 -54
- package/dist/internal/zod-json-schema.js +46 -123
- package/dist/jsx-runtime.d.ts +3 -8
- package/dist/lambda/index.d.ts +17 -79
- package/dist/lambda/index.js +11 -59
- package/dist/logging/LogManager.d.ts +1 -51
- package/dist/logging/Logger.d.ts +8 -47
- package/dist/logging/channels/ConsoleChannel.d.ts +1 -3
- package/dist/logging/channels/DailyFileChannel.d.ts +1 -5
- package/dist/logging/channels/FileChannel.d.ts +1 -3
- package/dist/logging/daily-file-path.d.ts +15 -0
- package/dist/logging/index.d.ts +1 -0
- package/dist/logging/index.js +2 -2
- package/dist/logging/types.d.ts +13 -45
- package/dist/{logging-CPaRMuPP.js → logging-zOY1XCtq.js} +83 -129
- package/dist/{loopback-guard-D0Kc7-xc.js → loopback-guard-DT9gHF0F.js} +41 -92
- package/dist/mail/Mail.d.ts +10 -106
- package/dist/mail/MailManager.d.ts +2 -60
- package/dist/mail/index.js +1 -1
- package/dist/mail/transports/LogTransport.d.ts +1 -4
- package/dist/mail/transports/MemoryTransport.d.ts +1 -63
- package/dist/mail/transports/ResendTransport.d.ts +1 -23
- package/dist/mail/transports/SmtpTransport.d.ts +1 -31
- package/dist/mail/types.d.ts +28 -150
- package/dist/{mail-DfEfSQEr.js → mail-76DWy9lj.js} +31 -289
- package/dist/mcp/McpServiceProvider.d.ts +4 -10
- package/dist/mcp/create-mcp-server.d.ts +25 -57
- package/dist/mcp/endpoint.d.ts +12 -36
- package/dist/mcp/index.js +1 -1
- package/dist/mvc/Controller.d.ts +46 -253
- package/dist/mvc/Router.d.ts +50 -129
- package/dist/mvc/inertia/InertiaEngine.d.ts +18 -48
- package/dist/mvc/inertia/shared.d.ts +6 -19
- package/dist/mvc/mount-route.d.ts +2 -6
- package/dist/mvc/view.d.ts +1 -2
- package/dist/notifications/Notification.d.ts +8 -75
- package/dist/notifications/NotificationManager.d.ts +15 -88
- package/dist/notifications/channels/DatabaseChannel.d.ts +1 -41
- package/dist/notifications/channels/MailChannel.d.ts +2 -31
- package/dist/notifications/channels/MemoryChannel.d.ts +2 -62
- package/dist/notifications/channels/SlackChannel.d.ts +3 -48
- package/dist/notifications/index.js +1 -1
- package/dist/notifications/notifiable-type.d.ts +3 -6
- package/dist/notifications/registry.d.ts +8 -27
- package/dist/notifications/types.d.ts +16 -53
- package/dist/{notifications-BGqmUNZ8.js → notifications-okWFs9ly.js} +37 -335
- package/dist/providers/AuthServiceProvider.d.ts +1 -3
- package/dist/providers/AuthorizationServiceProvider.d.ts +2 -3
- package/dist/providers/BroadcastServiceProvider.d.ts +1 -3
- package/dist/providers/CacheServiceProvider.d.ts +1 -3
- package/dist/providers/EncryptionServiceProvider.d.ts +1 -3
- package/dist/providers/ErrorServiceProvider.d.ts +1 -4
- package/dist/providers/EventServiceProvider.d.ts +1 -3
- package/dist/providers/HealthServiceProvider.d.ts +1 -3
- package/dist/providers/I18nServiceProvider.d.ts +6 -10
- package/dist/providers/InertiaServiceProvider.d.ts +1 -4
- package/dist/providers/LogServiceProvider.d.ts +1 -3
- package/dist/providers/MailServiceProvider.d.ts +1 -3
- package/dist/providers/NotificationServiceProvider.d.ts +1 -3
- package/dist/providers/OAuthServiceProvider.d.ts +1 -3
- package/dist/providers/QueueServiceProvider.d.ts +1 -3
- package/dist/providers/SchedulingServiceProvider.d.ts +1 -3
- package/dist/providers/StorageServiceProvider.d.ts +1 -3
- package/dist/queue/FailedJobReporter.d.ts +1 -24
- package/dist/queue/Job.d.ts +12 -99
- package/dist/queue/QueueManager.d.ts +6 -57
- package/dist/queue/Worker.d.ts +4 -65
- package/dist/queue/drivers/MemoryDriver.d.ts +3 -44
- package/dist/queue/drivers/RedisDriver.d.ts +7 -65
- package/dist/queue/drivers/SqsDriver.d.ts +6 -57
- package/dist/queue/drivers/SyncDriver.d.ts +10 -13
- package/dist/queue/index.js +2 -2
- package/dist/queue/types.d.ts +10 -92
- package/dist/{queue-CXrRK85G.js → queue-CcXCjuJI.js} +32 -260
- package/dist/redis/RedisApiTokenStore.d.ts +4 -56
- package/dist/redis/RedisEmailVerificationStore.d.ts +4 -37
- package/dist/redis/RedisOAuthStateStore.d.ts +2 -10
- package/dist/redis/RedisPasswordResetStore.d.ts +4 -37
- package/dist/redis/RedisRateLimitStore.d.ts +16 -49
- package/dist/redis/RedisSessionStore.d.ts +3 -44
- package/dist/redis/client.d.ts +2 -32
- package/dist/redis/index.js +47 -232
- package/dist/redis/redis-values.d.ts +6 -12
- package/dist/redis/scan-keys.d.ts +1 -4
- package/dist/request-CLOYytGP.js +68 -0
- package/dist/runtime/index.d.ts +2 -0
- package/dist/runtime/index.js +108 -74
- package/dist/scheduling/CronParser.d.ts +0 -29
- package/dist/scheduling/Schedule.d.ts +1 -153
- package/dist/scheduling/ScheduledTask.d.ts +0 -31
- package/dist/scheduling/Scheduler.d.ts +0 -70
- package/dist/scheduling/index.js +1 -1
- package/dist/scheduling/types.d.ts +4 -65
- package/dist/{scheduling-CPiEdtQd.js → scheduling-C6tcOtUl.js} +2 -287
- package/dist/storage/StorageManager.d.ts +0 -48
- package/dist/storage/drivers/LocalDriver.d.ts +1 -25
- package/dist/storage/drivers/MemoryDriver.d.ts +5 -35
- package/dist/storage/drivers/S3Driver.d.ts +6 -36
- package/dist/storage/drivers/s3-acl.d.ts +5 -10
- package/dist/storage/index.js +1 -1
- package/dist/storage/types.d.ts +27 -265
- package/dist/{storage-TLD9t0Q2.js → storage-BB59f07j.js} +17 -157
- package/dist/support/contained-path.d.ts +10 -20
- package/dist/support/error-polyfill.d.ts +4 -6
- package/dist/support/expiry.d.ts +17 -33
- package/dist/support/expiry.js +17 -33
- package/dist/support/import-map.d.ts +3 -7
- package/dist/support/inertia-defaults.d.ts +5 -10
- package/dist/support/redirect-target.d.ts +4 -6
- package/dist/support/stack-frames.d.ts +11 -50
- package/dist/support/trim-slashes.d.ts +4 -7
- package/dist/support/warn-once.d.ts +2 -6
- package/dist/{trim-slashes-ZJ_VsY5s.js → trim-slashes-BLY9hKAa.js} +4 -7
- package/dist/{vite-manifest-BGfWbPYp.js → vite-manifest-CTQp-SOo.js} +34 -58
- package/package.json +6 -2
- package/dist/client-Dd7vLcqp.js +0 -27
- package/dist/context-DoD0c7J_.js +0 -26
- package/dist/endpoint-D-20PiHY.js +0 -46
- package/dist/hot-disposables-WsTX2ySN.js +0 -281
- package/dist/request-CRVuIiQr.js +0 -78
|
@@ -1,75 +1,27 @@
|
|
|
1
1
|
import type { Event } from './Event.js';
|
|
2
2
|
import type { EventClass } from './types.js';
|
|
3
|
-
/**
|
|
4
|
-
* Base class for event listeners.
|
|
5
|
-
* Extend this class to create reusable, class-based event listeners.
|
|
6
|
-
*
|
|
7
|
-
* @example
|
|
8
|
-
* ```ts
|
|
9
|
-
* class SendWelcomeEmail extends Listener<UserRegistered> {
|
|
10
|
-
* static event = UserRegistered
|
|
11
|
-
* static shouldQueue = true
|
|
12
|
-
* static queue = 'emails'
|
|
13
|
-
*
|
|
14
|
-
* async handle(event: UserRegistered): Promise<void> {
|
|
15
|
-
* await mail.to(event.email).subject('Welcome!').send()
|
|
16
|
-
* }
|
|
17
|
-
*
|
|
18
|
-
* shouldHandle(event: UserRegistered): boolean {
|
|
19
|
-
* // Only send to non-admin users
|
|
20
|
-
* return !event.isAdmin
|
|
21
|
-
* }
|
|
22
|
-
* }
|
|
23
|
-
* ```
|
|
24
|
-
*/
|
|
3
|
+
/** Base class for reusable, class-based event listeners. */
|
|
25
4
|
export declare abstract class Listener<T extends Event = Event> {
|
|
26
|
-
/**
|
|
27
|
-
* The event class this listener handles.
|
|
28
|
-
* Must be set by subclasses.
|
|
29
|
-
*/
|
|
5
|
+
/** Must be set by subclasses. */
|
|
30
6
|
static event: EventClass;
|
|
31
|
-
/**
|
|
32
|
-
* Whether this listener should be queued instead of executed immediately.
|
|
33
|
-
* @default false
|
|
34
|
-
*/
|
|
7
|
+
/** @default false */
|
|
35
8
|
static shouldQueue: boolean;
|
|
36
9
|
/**
|
|
37
|
-
*
|
|
10
|
+
* Used when `shouldQueue`.
|
|
38
11
|
* @default 'default'
|
|
39
12
|
*/
|
|
40
13
|
static queue: string;
|
|
41
14
|
/**
|
|
42
|
-
*
|
|
15
|
+
* Higher runs first.
|
|
43
16
|
* @default 0
|
|
44
17
|
*/
|
|
45
18
|
static priority: number;
|
|
46
|
-
/**
|
|
47
|
-
* Handle the event.
|
|
48
|
-
* This method must be implemented by subclasses.
|
|
49
|
-
*
|
|
50
|
-
* @param event - The event instance
|
|
51
|
-
*/
|
|
52
19
|
abstract handle(event: T): void | Promise<void>;
|
|
53
|
-
/**
|
|
54
|
-
* Determine if this listener should handle the event.
|
|
55
|
-
* Override this method to conditionally handle events.
|
|
56
|
-
*
|
|
57
|
-
* @param event - The event instance
|
|
58
|
-
* @returns true if the listener should handle the event
|
|
59
|
-
*/
|
|
20
|
+
/** Optional filter: return false to skip the event. */
|
|
60
21
|
shouldHandle?(event: T): boolean;
|
|
61
|
-
/**
|
|
62
|
-
* Called when the listener fails to handle the event.
|
|
63
|
-
* Override this method to handle errors.
|
|
64
|
-
*
|
|
65
|
-
* @param event - The event instance
|
|
66
|
-
* @param error - The error that occurred
|
|
67
|
-
*/
|
|
22
|
+
/** Called when `handle` throws. */
|
|
68
23
|
failed?(event: T, error: Error): void | Promise<void>;
|
|
69
24
|
}
|
|
70
|
-
/**
|
|
71
|
-
* Listener class constructor type.
|
|
72
|
-
*/
|
|
73
25
|
export interface ListenerClass<T extends Event = Event> {
|
|
74
26
|
new (): Listener<T>;
|
|
75
27
|
event: EventClass<T>;
|
package/dist/events/builtin.d.ts
CHANGED
|
@@ -1,16 +1,10 @@
|
|
|
1
1
|
import { Event } from './Event.js';
|
|
2
|
-
/**
|
|
3
|
-
* Emitted when an HTTP request is received.
|
|
4
|
-
*/
|
|
5
2
|
export declare class RequestReceived extends Event {
|
|
6
3
|
readonly method: string;
|
|
7
4
|
readonly path: string;
|
|
8
5
|
readonly requestId?: string | undefined;
|
|
9
6
|
constructor(method: string, path: string, requestId?: string | undefined);
|
|
10
7
|
}
|
|
11
|
-
/**
|
|
12
|
-
* Emitted when an HTTP request has finished processing.
|
|
13
|
-
*/
|
|
14
8
|
export declare class RequestFinished extends Event {
|
|
15
9
|
readonly method: string;
|
|
16
10
|
readonly path: string;
|
|
@@ -19,25 +13,16 @@ export declare class RequestFinished extends Event {
|
|
|
19
13
|
readonly requestId?: string | undefined;
|
|
20
14
|
constructor(method: string, path: string, status: number, durationMs: number, requestId?: string | undefined);
|
|
21
15
|
}
|
|
22
|
-
/**
|
|
23
|
-
* Emitted when a user successfully authenticates.
|
|
24
|
-
*/
|
|
25
16
|
export declare class UserAuthenticated extends Event {
|
|
26
17
|
readonly userId: string | number;
|
|
27
18
|
readonly guard: string;
|
|
28
19
|
constructor(userId: string | number, guard?: string);
|
|
29
20
|
}
|
|
30
|
-
/**
|
|
31
|
-
* Emitted when a user logs out.
|
|
32
|
-
*/
|
|
33
21
|
export declare class UserLoggedOut extends Event {
|
|
34
22
|
readonly userId: string | number;
|
|
35
23
|
readonly guard: string;
|
|
36
24
|
constructor(userId: string | number, guard?: string);
|
|
37
25
|
}
|
|
38
|
-
/**
|
|
39
|
-
* Emitted when a queued job is successfully processed.
|
|
40
|
-
*/
|
|
41
26
|
export declare class JobProcessed extends Event {
|
|
42
27
|
readonly jobId: string;
|
|
43
28
|
readonly jobName: string;
|
|
@@ -45,9 +30,6 @@ export declare class JobProcessed extends Event {
|
|
|
45
30
|
readonly durationMs: number;
|
|
46
31
|
constructor(jobId: string, jobName: string, queue: string, durationMs: number);
|
|
47
32
|
}
|
|
48
|
-
/**
|
|
49
|
-
* Emitted when a queued job fails.
|
|
50
|
-
*/
|
|
51
33
|
export declare class JobFailed extends Event {
|
|
52
34
|
readonly jobId: string;
|
|
53
35
|
readonly jobName: string;
|
|
@@ -56,17 +38,11 @@ export declare class JobFailed extends Event {
|
|
|
56
38
|
readonly attempts: number;
|
|
57
39
|
constructor(jobId: string, jobName: string, queue: string, error: Error, attempts: number);
|
|
58
40
|
}
|
|
59
|
-
/**
|
|
60
|
-
* Emitted when the application starts.
|
|
61
|
-
*/
|
|
62
41
|
export declare class ApplicationStarted extends Event {
|
|
63
42
|
readonly port: number;
|
|
64
43
|
readonly host: string;
|
|
65
44
|
constructor(port: number, host: string);
|
|
66
45
|
}
|
|
67
|
-
/**
|
|
68
|
-
* Emitted when the application is shutting down.
|
|
69
|
-
*/
|
|
70
46
|
export declare class ApplicationShutdown extends Event {
|
|
71
47
|
readonly reason?: string | undefined;
|
|
72
48
|
constructor(reason?: string | undefined);
|
package/dist/events/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as RequestFinished, c as UserLoggedOut, d as createEventManager, f as Event, i as JobProcessed, l as Listener, n as ApplicationStarted, o as RequestReceived, r as JobFailed, s as UserAuthenticated, t as ApplicationShutdown, u as EventManager } from "../events-
|
|
1
|
+
import { a as RequestFinished, c as UserLoggedOut, d as createEventManager, f as Event, i as JobProcessed, l as Listener, n as ApplicationStarted, o as RequestReceived, r as JobFailed, s as UserAuthenticated, t as ApplicationShutdown, u as EventManager } from "../events-DOmAHDeP.js";
|
|
2
2
|
export { ApplicationShutdown, ApplicationStarted, Event, EventManager, JobFailed, JobProcessed, Listener, RequestFinished, RequestReceived, UserAuthenticated, UserLoggedOut, createEventManager };
|
package/dist/events/types.d.ts
CHANGED
|
@@ -1,48 +1,30 @@
|
|
|
1
1
|
import type { Event } from './Event.js';
|
|
2
|
-
/**
|
|
3
|
-
* Event class constructor type.
|
|
4
|
-
*/
|
|
5
2
|
export interface EventClass<T extends Event = Event> {
|
|
6
3
|
new (...args: any[]): T;
|
|
7
4
|
eventName: string;
|
|
8
5
|
}
|
|
9
|
-
/**
|
|
10
|
-
* Event listener function type.
|
|
11
|
-
*/
|
|
12
6
|
export type EventListener<T extends Event = Event> = (event: T) => void | Promise<void>;
|
|
13
|
-
/**
|
|
14
|
-
* Options for registering an event listener.
|
|
15
|
-
*/
|
|
16
7
|
export interface ListenerOptions {
|
|
17
8
|
/**
|
|
18
|
-
*
|
|
9
|
+
* Removed after its first invocation.
|
|
19
10
|
* @default false
|
|
20
11
|
*/
|
|
21
12
|
once?: boolean;
|
|
22
13
|
/**
|
|
23
|
-
*
|
|
14
|
+
* Higher runs first.
|
|
24
15
|
* @default 0
|
|
25
16
|
*/
|
|
26
17
|
priority?: number;
|
|
27
18
|
/**
|
|
28
|
-
*
|
|
29
|
-
*
|
|
19
|
+
* Dispatch to this queue instead of running inline. Requires the Queue
|
|
20
|
+
* system to be configured.
|
|
30
21
|
*/
|
|
31
22
|
queue?: string;
|
|
32
23
|
}
|
|
33
|
-
/**
|
|
34
|
-
* Internal representation of a registered listener.
|
|
35
|
-
*/
|
|
36
24
|
export interface RegisteredListener<T extends Event = Event> {
|
|
37
25
|
listener: EventListener<T>;
|
|
38
26
|
options: ListenerOptions;
|
|
39
27
|
}
|
|
40
|
-
/**
|
|
41
|
-
* Event subscription handle for unsubscribing.
|
|
42
|
-
*/
|
|
43
28
|
export interface EventSubscription {
|
|
44
|
-
/**
|
|
45
|
-
* Unsubscribe the listener.
|
|
46
|
-
*/
|
|
47
29
|
unsubscribe(): void;
|
|
48
30
|
}
|
|
@@ -1,92 +1,20 @@
|
|
|
1
1
|
//#region src/events/Event.ts
|
|
2
|
-
/**
|
|
3
|
-
* Base class for all application events.
|
|
4
|
-
*
|
|
5
|
-
* @example
|
|
6
|
-
* ```ts
|
|
7
|
-
* class UserRegistered extends Event {
|
|
8
|
-
* constructor(
|
|
9
|
-
* public readonly userId: string,
|
|
10
|
-
* public readonly email: string
|
|
11
|
-
* ) {
|
|
12
|
-
* super()
|
|
13
|
-
* }
|
|
14
|
-
* }
|
|
15
|
-
*
|
|
16
|
-
* // Emit the event
|
|
17
|
-
* await events.emit(new UserRegistered('123', 'user@example.com'))
|
|
18
|
-
* ```
|
|
19
|
-
*/
|
|
2
|
+
/** Base class for all application events. */
|
|
20
3
|
var Event = class {
|
|
21
|
-
/**
|
|
22
|
-
* Timestamp when the event was created.
|
|
23
|
-
*/
|
|
24
4
|
timestamp = /* @__PURE__ */ new Date();
|
|
25
|
-
/**
|
|
26
|
-
* Get the event name (class name by default).
|
|
27
|
-
* Override this to customize the event name.
|
|
28
|
-
*/
|
|
29
5
|
static get eventName() {
|
|
30
6
|
return this.name;
|
|
31
7
|
}
|
|
32
|
-
/**
|
|
33
|
-
* Get the event name from an instance.
|
|
34
|
-
*/
|
|
35
8
|
get eventName() {
|
|
36
9
|
return this.constructor.eventName;
|
|
37
10
|
}
|
|
38
11
|
};
|
|
39
12
|
//#endregion
|
|
40
13
|
//#region src/events/EventManager.ts
|
|
41
|
-
/**
|
|
42
|
-
* Event manager for registering listeners and emitting events.
|
|
43
|
-
*
|
|
44
|
-
* @example
|
|
45
|
-
* ```ts
|
|
46
|
-
* const events = new EventManager()
|
|
47
|
-
*
|
|
48
|
-
* // Register a listener
|
|
49
|
-
* events.on(UserRegistered, async (event) => {
|
|
50
|
-
* console.log(`User ${event.userId} registered`)
|
|
51
|
-
* await sendWelcomeEmail(event.email)
|
|
52
|
-
* })
|
|
53
|
-
*
|
|
54
|
-
* // Register a one-time listener
|
|
55
|
-
* events.once(AppStarted, () => {
|
|
56
|
-
* console.log('App started!')
|
|
57
|
-
* })
|
|
58
|
-
*
|
|
59
|
-
* // Emit an event
|
|
60
|
-
* await events.emit(new UserRegistered('123', 'user@example.com'))
|
|
61
|
-
* ```
|
|
62
|
-
*/
|
|
14
|
+
/** Registers listeners and emits events. */
|
|
63
15
|
var EventManager = class {
|
|
64
16
|
listeners = /* @__PURE__ */ new Map();
|
|
65
|
-
/**
|
|
66
|
-
* Queue dispatcher function (set when Queue system is integrated).
|
|
67
|
-
*/
|
|
68
17
|
queueDispatcher;
|
|
69
|
-
/**
|
|
70
|
-
* Register a listener for an event.
|
|
71
|
-
*
|
|
72
|
-
* @param event - Event class to listen for
|
|
73
|
-
* @param listener - Listener function
|
|
74
|
-
* @param options - Listener options
|
|
75
|
-
* @returns Subscription handle for unsubscribing
|
|
76
|
-
*
|
|
77
|
-
* @example
|
|
78
|
-
* ```ts
|
|
79
|
-
* // Basic usage
|
|
80
|
-
* events.on(UserRegistered, (e) => console.log(e.email))
|
|
81
|
-
*
|
|
82
|
-
* // With options
|
|
83
|
-
* events.on(UserRegistered, (e) => sendEmail(e), { priority: 10 })
|
|
84
|
-
*
|
|
85
|
-
* // Unsubscribe later
|
|
86
|
-
* const sub = events.on(UserRegistered, handler)
|
|
87
|
-
* sub.unsubscribe()
|
|
88
|
-
* ```
|
|
89
|
-
*/
|
|
90
18
|
on(event, listener, options = {}) {
|
|
91
19
|
const eventName = typeof event === "string" ? event : event.eventName;
|
|
92
20
|
const registeredListeners = this.listeners.get(eventName) ?? [];
|
|
@@ -103,27 +31,13 @@ var EventManager = class {
|
|
|
103
31
|
this.listeners.set(eventName, registeredListeners);
|
|
104
32
|
return { unsubscribe: () => this.off(event, listener) };
|
|
105
33
|
}
|
|
106
|
-
/**
|
|
107
|
-
* Register a one-time listener for an event.
|
|
108
|
-
* The listener will be automatically removed after the first invocation.
|
|
109
|
-
*
|
|
110
|
-
* @param event - Event class to listen for
|
|
111
|
-
* @param listener - Listener function
|
|
112
|
-
* @param options - Additional listener options (once is always true)
|
|
113
|
-
* @returns Subscription handle for unsubscribing
|
|
114
|
-
*/
|
|
115
34
|
once(event, listener, options = {}) {
|
|
116
35
|
return this.on(event, listener, {
|
|
117
36
|
...options,
|
|
118
37
|
once: true
|
|
119
38
|
});
|
|
120
39
|
}
|
|
121
|
-
/**
|
|
122
|
-
* Remove a listener for an event.
|
|
123
|
-
*
|
|
124
|
-
* @param event - Event class
|
|
125
|
-
* @param listener - Listener to remove (if omitted, all listeners for the event are removed)
|
|
126
|
-
*/
|
|
40
|
+
/** Omitting `listener` removes every listener for the event. */
|
|
127
41
|
off(event, listener) {
|
|
128
42
|
const eventName = typeof event === "string" ? event : event.eventName;
|
|
129
43
|
const registeredListeners = this.listeners.get(eventName);
|
|
@@ -138,18 +52,7 @@ var EventManager = class {
|
|
|
138
52
|
if (registeredListeners.length === 0) this.listeners.delete(eventName);
|
|
139
53
|
}
|
|
140
54
|
}
|
|
141
|
-
/**
|
|
142
|
-
* Emit an event to all registered listeners.
|
|
143
|
-
* Listeners are executed in order of priority (highest first).
|
|
144
|
-
* Async listeners are awaited sequentially.
|
|
145
|
-
*
|
|
146
|
-
* @param event - Event instance to emit
|
|
147
|
-
*
|
|
148
|
-
* @example
|
|
149
|
-
* ```ts
|
|
150
|
-
* await events.emit(new UserRegistered('123', 'user@example.com'))
|
|
151
|
-
* ```
|
|
152
|
-
*/
|
|
55
|
+
/** Highest priority first, awaited one at a time. */
|
|
153
56
|
async emit(event) {
|
|
154
57
|
const eventName = event.eventName;
|
|
155
58
|
const registeredListeners = this.listeners.get(eventName);
|
|
@@ -167,12 +70,7 @@ var EventManager = class {
|
|
|
167
70
|
}
|
|
168
71
|
if (registeredListeners.length === 0) this.listeners.delete(eventName);
|
|
169
72
|
}
|
|
170
|
-
/**
|
|
171
|
-
* Emit an event to all registered listeners in parallel.
|
|
172
|
-
* Use this when listener execution order doesn't matter and you want faster execution.
|
|
173
|
-
*
|
|
174
|
-
* @param event - Event instance to emit
|
|
175
|
-
*/
|
|
73
|
+
/** {@link emit} without the ordering guarantee. */
|
|
176
74
|
async emitParallel(event) {
|
|
177
75
|
const eventName = event.eventName;
|
|
178
76
|
const registeredListeners = this.listeners.get(eventName);
|
|
@@ -190,113 +88,56 @@ var EventManager = class {
|
|
|
190
88
|
}
|
|
191
89
|
if (registeredListeners.length === 0) this.listeners.delete(eventName);
|
|
192
90
|
}
|
|
193
|
-
/**
|
|
194
|
-
* Check if an event has any listeners registered.
|
|
195
|
-
*
|
|
196
|
-
* @param event - Event class or event name
|
|
197
|
-
*/
|
|
198
91
|
hasListeners(event) {
|
|
199
92
|
const eventName = typeof event === "string" ? event : event.eventName;
|
|
200
93
|
const listeners = this.listeners.get(eventName);
|
|
201
94
|
return listeners !== void 0 && listeners.length > 0;
|
|
202
95
|
}
|
|
203
|
-
/**
|
|
204
|
-
* Get all listeners for an event.
|
|
205
|
-
*
|
|
206
|
-
* @param event - Event class or event name
|
|
207
|
-
*/
|
|
208
96
|
getListeners(event) {
|
|
209
97
|
const eventName = typeof event === "string" ? event : event.eventName;
|
|
210
98
|
const registeredListeners = this.listeners.get(eventName);
|
|
211
99
|
if (!registeredListeners) return [];
|
|
212
100
|
return registeredListeners.map((r) => r.listener);
|
|
213
101
|
}
|
|
214
|
-
/**
|
|
215
|
-
* Get the count of listeners for an event.
|
|
216
|
-
*
|
|
217
|
-
* @param event - Event class or event name
|
|
218
|
-
*/
|
|
219
102
|
listenerCount(event) {
|
|
220
103
|
const eventName = typeof event === "string" ? event : event.eventName;
|
|
221
104
|
return this.listeners.get(eventName)?.length ?? 0;
|
|
222
105
|
}
|
|
223
|
-
/**
|
|
224
|
-
* Get all registered event names.
|
|
225
|
-
*/
|
|
226
106
|
eventNames() {
|
|
227
107
|
return Array.from(this.listeners.keys());
|
|
228
108
|
}
|
|
229
|
-
/**
|
|
230
|
-
* Remove all listeners for all events.
|
|
231
|
-
*/
|
|
232
109
|
removeAllListeners() {
|
|
233
110
|
this.listeners.clear();
|
|
234
111
|
}
|
|
235
|
-
/**
|
|
236
|
-
* Set the queue dispatcher function.
|
|
237
|
-
* This is called by the Queue system when it's integrated.
|
|
238
|
-
*/
|
|
112
|
+
/** Called by the Queue system when it is integrated. */
|
|
239
113
|
setQueueDispatcher(dispatcher) {
|
|
240
114
|
this.queueDispatcher = dispatcher;
|
|
241
115
|
}
|
|
242
116
|
};
|
|
243
|
-
/**
|
|
244
|
-
* Create a new EventManager instance.
|
|
245
|
-
*/
|
|
246
117
|
function createEventManager() {
|
|
247
118
|
return new EventManager();
|
|
248
119
|
}
|
|
249
120
|
//#endregion
|
|
250
121
|
//#region src/events/Listener.ts
|
|
251
|
-
/**
|
|
252
|
-
* Base class for event listeners.
|
|
253
|
-
* Extend this class to create reusable, class-based event listeners.
|
|
254
|
-
*
|
|
255
|
-
* @example
|
|
256
|
-
* ```ts
|
|
257
|
-
* class SendWelcomeEmail extends Listener<UserRegistered> {
|
|
258
|
-
* static event = UserRegistered
|
|
259
|
-
* static shouldQueue = true
|
|
260
|
-
* static queue = 'emails'
|
|
261
|
-
*
|
|
262
|
-
* async handle(event: UserRegistered): Promise<void> {
|
|
263
|
-
* await mail.to(event.email).subject('Welcome!').send()
|
|
264
|
-
* }
|
|
265
|
-
*
|
|
266
|
-
* shouldHandle(event: UserRegistered): boolean {
|
|
267
|
-
* // Only send to non-admin users
|
|
268
|
-
* return !event.isAdmin
|
|
269
|
-
* }
|
|
270
|
-
* }
|
|
271
|
-
* ```
|
|
272
|
-
*/
|
|
122
|
+
/** Base class for reusable, class-based event listeners. */
|
|
273
123
|
var Listener = class {
|
|
274
|
-
/**
|
|
275
|
-
* The event class this listener handles.
|
|
276
|
-
* Must be set by subclasses.
|
|
277
|
-
*/
|
|
124
|
+
/** Must be set by subclasses. */
|
|
278
125
|
static event;
|
|
279
|
-
/**
|
|
280
|
-
* Whether this listener should be queued instead of executed immediately.
|
|
281
|
-
* @default false
|
|
282
|
-
*/
|
|
126
|
+
/** @default false */
|
|
283
127
|
static shouldQueue = false;
|
|
284
128
|
/**
|
|
285
|
-
*
|
|
129
|
+
* Used when `shouldQueue`.
|
|
286
130
|
* @default 'default'
|
|
287
131
|
*/
|
|
288
132
|
static queue = "default";
|
|
289
133
|
/**
|
|
290
|
-
*
|
|
134
|
+
* Higher runs first.
|
|
291
135
|
* @default 0
|
|
292
136
|
*/
|
|
293
137
|
static priority = 0;
|
|
294
138
|
};
|
|
295
139
|
//#endregion
|
|
296
140
|
//#region src/events/builtin.ts
|
|
297
|
-
/**
|
|
298
|
-
* Emitted when an HTTP request is received.
|
|
299
|
-
*/
|
|
300
141
|
var RequestReceived = class extends Event {
|
|
301
142
|
method;
|
|
302
143
|
path;
|
|
@@ -308,9 +149,6 @@ var RequestReceived = class extends Event {
|
|
|
308
149
|
this.requestId = requestId;
|
|
309
150
|
}
|
|
310
151
|
};
|
|
311
|
-
/**
|
|
312
|
-
* Emitted when an HTTP request has finished processing.
|
|
313
|
-
*/
|
|
314
152
|
var RequestFinished = class extends Event {
|
|
315
153
|
method;
|
|
316
154
|
path;
|
|
@@ -326,9 +164,6 @@ var RequestFinished = class extends Event {
|
|
|
326
164
|
this.requestId = requestId;
|
|
327
165
|
}
|
|
328
166
|
};
|
|
329
|
-
/**
|
|
330
|
-
* Emitted when a user successfully authenticates.
|
|
331
|
-
*/
|
|
332
167
|
var UserAuthenticated = class extends Event {
|
|
333
168
|
userId;
|
|
334
169
|
guard;
|
|
@@ -338,9 +173,6 @@ var UserAuthenticated = class extends Event {
|
|
|
338
173
|
this.guard = guard;
|
|
339
174
|
}
|
|
340
175
|
};
|
|
341
|
-
/**
|
|
342
|
-
* Emitted when a user logs out.
|
|
343
|
-
*/
|
|
344
176
|
var UserLoggedOut = class extends Event {
|
|
345
177
|
userId;
|
|
346
178
|
guard;
|
|
@@ -350,9 +182,6 @@ var UserLoggedOut = class extends Event {
|
|
|
350
182
|
this.guard = guard;
|
|
351
183
|
}
|
|
352
184
|
};
|
|
353
|
-
/**
|
|
354
|
-
* Emitted when a queued job is successfully processed.
|
|
355
|
-
*/
|
|
356
185
|
var JobProcessed = class extends Event {
|
|
357
186
|
jobId;
|
|
358
187
|
jobName;
|
|
@@ -366,9 +195,6 @@ var JobProcessed = class extends Event {
|
|
|
366
195
|
this.durationMs = durationMs;
|
|
367
196
|
}
|
|
368
197
|
};
|
|
369
|
-
/**
|
|
370
|
-
* Emitted when a queued job fails.
|
|
371
|
-
*/
|
|
372
198
|
var JobFailed = class extends Event {
|
|
373
199
|
jobId;
|
|
374
200
|
jobName;
|
|
@@ -384,9 +210,6 @@ var JobFailed = class extends Event {
|
|
|
384
210
|
this.attempts = attempts;
|
|
385
211
|
}
|
|
386
212
|
};
|
|
387
|
-
/**
|
|
388
|
-
* Emitted when the application starts.
|
|
389
|
-
*/
|
|
390
213
|
var ApplicationStarted = class extends Event {
|
|
391
214
|
port;
|
|
392
215
|
host;
|
|
@@ -396,9 +219,6 @@ var ApplicationStarted = class extends Event {
|
|
|
396
219
|
this.host = host;
|
|
397
220
|
}
|
|
398
221
|
};
|
|
399
|
-
/**
|
|
400
|
-
* Emitted when the application is shutting down.
|
|
401
|
-
*/
|
|
402
222
|
var ApplicationShutdown = class extends Event {
|
|
403
223
|
reason;
|
|
404
224
|
constructor(reason) {
|
package/dist/facades/index.d.ts
CHANGED
|
@@ -1,20 +1,8 @@
|
|
|
1
1
|
import type { Container } from '../container/Container.js';
|
|
2
2
|
import type { ServiceBindings } from '../container/bindings.js';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* The returned proxy intercepts all property access and method calls,
|
|
7
|
-
* resolving the underlying service from the container on each access.
|
|
8
|
-
* This ensures that container fakes and flushes are respected.
|
|
9
|
-
*
|
|
10
|
-
* @example
|
|
11
|
-
* ```typescript
|
|
12
|
-
* import { createFacades } from '@guren/server/facades'
|
|
13
|
-
*
|
|
14
|
-
* const { Cache, Events } = createFacades(container)
|
|
15
|
-
* await Cache.get('key')
|
|
16
|
-
* Events.emit('user.created', payload)
|
|
17
|
-
* ```
|
|
4
|
+
* A proxy that re-resolves `key` from the container on every access, so
|
|
5
|
+
* container fakes and flushes are respected.
|
|
18
6
|
*/
|
|
19
7
|
export declare function createFacade<K extends keyof ServiceBindings>(container: Pick<Container, 'make'>, key: K): ServiceBindings[K];
|
|
20
8
|
export declare function createFacades(container: Pick<Container, 'make'>): {
|
|
@@ -1,34 +1,10 @@
|
|
|
1
1
|
import type { CheckResult } from './types.js';
|
|
2
|
-
/**
|
|
3
|
-
* Abstract base class for health checks.
|
|
4
|
-
*/
|
|
5
2
|
export declare abstract class HealthCheck {
|
|
6
|
-
/**
|
|
7
|
-
* The name of this health check.
|
|
8
|
-
*/
|
|
9
3
|
abstract readonly name: string;
|
|
10
|
-
/**
|
|
11
|
-
* Perform the health check.
|
|
12
|
-
*/
|
|
13
4
|
abstract check(): Promise<CheckResult>;
|
|
14
|
-
/**
|
|
15
|
-
* Create a healthy result.
|
|
16
|
-
*/
|
|
17
5
|
protected healthy(message?: string, meta?: Record<string, unknown>): CheckResult;
|
|
18
|
-
/**
|
|
19
|
-
* Create a degraded result.
|
|
20
|
-
*/
|
|
21
6
|
protected degraded(message?: string, meta?: Record<string, unknown>): CheckResult;
|
|
22
|
-
/**
|
|
23
|
-
* Create an unhealthy result.
|
|
24
|
-
*/
|
|
25
7
|
protected unhealthy(message?: string, meta?: Record<string, unknown>): CheckResult;
|
|
26
|
-
/**
|
|
27
|
-
* Create an unhealthy result from a caught error.
|
|
28
|
-
*/
|
|
29
8
|
protected handleError(error: unknown, fallbackMessage: string): CheckResult;
|
|
30
|
-
/**
|
|
31
|
-
* Create a check result.
|
|
32
|
-
*/
|
|
33
9
|
private result;
|
|
34
10
|
}
|
|
@@ -1,53 +1,17 @@
|
|
|
1
1
|
import type { Middleware } from '../http/middleware/index.js';
|
|
2
2
|
import type { HealthReport, CheckResult, HealthCheckOptions, HealthMiddlewareOptions } from './types.js';
|
|
3
3
|
import type { HealthCheck } from './HealthCheck.js';
|
|
4
|
-
/**
|
|
5
|
-
* Health check manager.
|
|
6
|
-
*/
|
|
7
4
|
export declare class HealthManager {
|
|
8
5
|
private checks;
|
|
9
|
-
/**
|
|
10
|
-
* Register a health check.
|
|
11
|
-
*/
|
|
12
6
|
register(check: HealthCheck, options?: HealthCheckOptions): this;
|
|
13
|
-
/**
|
|
14
|
-
* Unregister a health check.
|
|
15
|
-
*/
|
|
16
7
|
unregister(name: string): this;
|
|
17
|
-
/**
|
|
18
|
-
* Get all registered check names.
|
|
19
|
-
*/
|
|
20
8
|
getCheckNames(): string[];
|
|
21
|
-
/**
|
|
22
|
-
* Run all health checks.
|
|
23
|
-
*/
|
|
24
9
|
check(): Promise<HealthReport>;
|
|
25
|
-
/**
|
|
26
|
-
* Run specific health checks.
|
|
27
|
-
*/
|
|
28
10
|
checkOnly(names: string[]): Promise<HealthReport>;
|
|
29
|
-
/**
|
|
30
|
-
* Get a specific check result.
|
|
31
|
-
*/
|
|
32
11
|
getCheck(name: string): Promise<CheckResult | null>;
|
|
33
|
-
/**
|
|
34
|
-
* Create middleware for health endpoints.
|
|
35
|
-
*/
|
|
36
12
|
middleware(options?: HealthMiddlewareOptions): Middleware;
|
|
37
|
-
/**
|
|
38
|
-
* Run the specified checks.
|
|
39
|
-
*/
|
|
40
13
|
private runChecks;
|
|
41
|
-
/**
|
|
42
|
-
* Run a single check with timeout.
|
|
43
|
-
*/
|
|
44
14
|
private runCheck;
|
|
45
|
-
/**
|
|
46
|
-
* Create a timeout promise.
|
|
47
|
-
*/
|
|
48
15
|
private timeoutPromise;
|
|
49
16
|
}
|
|
50
|
-
/**
|
|
51
|
-
* Create a health manager.
|
|
52
|
-
*/
|
|
53
17
|
export declare function createHealthManager(): HealthManager;
|
|
@@ -1,31 +1,16 @@
|
|
|
1
1
|
import type { CheckResult } from '../types.js';
|
|
2
2
|
import { HealthCheck } from '../HealthCheck.js';
|
|
3
|
-
/**
|
|
4
|
-
* Cache store interface (minimal).
|
|
5
|
-
*/
|
|
6
3
|
export interface CacheStoreInterface {
|
|
7
4
|
get<T>(key: string): Promise<T | null>;
|
|
8
5
|
put<T>(key: string, value: T, ttl?: number): Promise<void>;
|
|
9
6
|
forget(key: string): Promise<boolean>;
|
|
10
7
|
}
|
|
11
|
-
/**
|
|
12
|
-
* Options for cache health check.
|
|
13
|
-
*/
|
|
14
8
|
export interface CacheCheckOptions {
|
|
15
|
-
/**
|
|
16
|
-
* Custom name for this check.
|
|
17
|
-
* @default 'cache'
|
|
18
|
-
*/
|
|
9
|
+
/** @default 'cache' */
|
|
19
10
|
name?: string;
|
|
20
|
-
/**
|
|
21
|
-
* Key to use for health check test.
|
|
22
|
-
* @default '__health_check__'
|
|
23
|
-
*/
|
|
11
|
+
/** @default '__health_check__' */
|
|
24
12
|
testKey?: string;
|
|
25
13
|
}
|
|
26
|
-
/**
|
|
27
|
-
* Health check for cache functionality.
|
|
28
|
-
*/
|
|
29
14
|
export declare class CacheCheck extends HealthCheck {
|
|
30
15
|
readonly name: string;
|
|
31
16
|
private cache;
|