@guren/server 2.1.0 → 2.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/{McpServiceProvider-7BB5FPF3.js → McpServiceProvider-GRDYNEQG.js} +1 -1
- package/dist/auth/AuthManager.d.ts +30 -0
- package/dist/auth/AuthenticatableModel.d.ts +25 -0
- package/dist/auth/RequestAuthContext.d.ts +24 -0
- package/dist/auth/SessionGuard.d.ts +31 -0
- package/dist/auth/api-token.d.ts +299 -0
- package/dist/auth/email-verification.d.ts +203 -0
- package/dist/auth/index.d.ts +18 -110
- package/dist/auth/index.js +3 -1
- package/dist/auth/oauth/index.d.ts +239 -0
- package/dist/auth/password/DefaultHasher.d.ts +13 -0
- package/dist/auth/password/NodeHasher.d.ts +22 -0
- package/dist/auth/password/PasswordHasher.d.ts +5 -0
- package/dist/auth/password/ScryptHasher.d.ts +26 -0
- package/dist/auth/password-reset.d.ts +91 -0
- package/dist/auth/providers/ModelUserProvider.d.ts +36 -0
- package/dist/auth/providers/UserProvider.d.ts +9 -0
- package/dist/auth/types.d.ts +102 -0
- package/dist/auth/utils.d.ts +39 -0
- package/dist/{Gate-CynjZCtS.d.ts → authorization/Gate.d.ts} +30 -111
- package/dist/authorization/Policy.d.ts +77 -0
- package/dist/authorization/index.d.ts +5 -129
- package/dist/authorization/index.js +3 -1
- package/dist/authorization/middleware.d.ts +49 -0
- package/dist/authorization/types.d.ts +108 -0
- package/dist/broadcasting/BroadcastManager.d.ts +205 -0
- package/dist/broadcasting/channels/Channel.d.ts +28 -0
- package/dist/broadcasting/channels/PresenceChannel.d.ts +72 -0
- package/dist/broadcasting/channels/PrivateChannel.d.ts +32 -0
- package/dist/broadcasting/channels/index.d.ts +3 -0
- package/dist/broadcasting/drivers/MemoryDriver.d.ts +93 -0
- package/dist/broadcasting/drivers/RedisDriver.d.ts +112 -0
- package/dist/broadcasting/drivers/index.d.ts +2 -0
- package/dist/broadcasting/index.d.ts +6 -233
- package/dist/broadcasting/index.js +1 -1
- package/dist/broadcasting/typed.d.ts +23 -0
- package/dist/broadcasting/types.d.ts +155 -0
- package/dist/cache/CacheManager.d.ts +87 -0
- package/dist/cache/TaggedCache.d.ts +62 -0
- package/dist/cache/index.d.ts +6 -233
- package/dist/cache/index.js +1 -1
- package/dist/cache/stores/FileStore.d.ts +64 -0
- package/dist/cache/stores/MemoryStore.d.ts +52 -0
- package/dist/cache/stores/RedisStore.d.ts +53 -0
- package/dist/{CacheManager-BmDzUKrF.d.ts → cache/types.d.ts} +26 -99
- package/dist/{chunk-TVY72CLV.js → chunk-4VE3LYOM.js} +3 -2
- package/dist/{chunk-FZD2AKJI.js → chunk-7OB2YXRE.js} +56 -28
- package/dist/{chunk-HONCNQXZ.js → chunk-BUQXOZCT.js} +97 -10
- package/dist/{chunk-DSDX3ASM.js → chunk-CDZUNKI6.js} +65 -83
- package/dist/{chunk-CWI4AJ47.js → chunk-HPET6XY5.js} +13 -9
- package/dist/{chunk-A3ISJVEV.js → chunk-HR2KZ3WL.js} +23 -5
- package/dist/{chunk-EARA7JM4.js → chunk-PZKUDFMW.js} +11 -8
- package/dist/console/Command.d.ts +179 -0
- package/dist/{ConsoleKernel-CJg975mp.d.ts → console/ConsoleKernel.d.ts} +4 -6
- package/dist/console/Input.d.ts +140 -0
- package/dist/console/Output.d.ts +161 -0
- package/dist/console/index.d.ts +5 -0
- package/dist/console/types.d.ts +106 -0
- package/dist/container/Container.d.ts +148 -0
- package/dist/container/ServiceProvider.d.ts +103 -0
- package/dist/container/bindings.d.ts +55 -0
- package/dist/container/defineModule.d.ts +88 -0
- package/dist/container/definePlugin.d.ts +62 -0
- package/dist/container/index.d.ts +8 -0
- package/dist/container/types.d.ts +73 -0
- package/dist/database/Factory.d.ts +82 -0
- package/dist/database/Seeder.d.ts +35 -0
- package/dist/database/SeederRunner.d.ts +41 -0
- package/dist/database/index.d.ts +4 -0
- package/dist/database/types.d.ts +49 -0
- package/dist/discovery/AutoDiscovery.d.ts +113 -0
- package/dist/discovery/index.d.ts +2 -0
- package/dist/docs-viewer/DocsViewerServiceProvider.d.ts +12 -0
- package/dist/docs-viewer/endpoint.d.ts +19 -0
- package/dist/encryption/Encrypter.d.ts +96 -0
- package/dist/encryption/Hash.d.ts +69 -0
- package/dist/encryption/MessageSigner.d.ts +21 -0
- package/dist/encryption/Random.d.ts +119 -0
- package/dist/encryption/app-key.d.ts +12 -0
- package/dist/encryption/index.d.ts +10 -222
- package/dist/encryption/signed-url.d.ts +9 -0
- package/dist/encryption/types.d.ts +103 -0
- package/dist/errors/ExceptionHandler.d.ts +118 -0
- package/dist/errors/HttpException.d.ts +106 -0
- package/dist/errors/debug-page.d.ts +22 -0
- package/dist/errors/error-page.d.ts +1 -0
- package/dist/errors/exceptions/AuthenticationException.d.ts +32 -0
- package/dist/errors/exceptions/AuthorizationException.d.ts +32 -0
- package/dist/errors/exceptions/MethodNotAllowedException.d.ts +31 -0
- package/dist/errors/exceptions/NotFoundHttpException.d.ts +36 -0
- package/dist/errors/exceptions/ValidationException.d.ts +60 -0
- package/dist/errors/exceptions/index.d.ts +5 -0
- package/dist/errors/index.d.ts +5 -0
- package/dist/errors/types.d.ts +43 -0
- package/dist/events/Event.d.ts +33 -0
- package/dist/{EventManager-CmIoLt7r.d.ts → events/EventManager.d.ts} +4 -86
- package/dist/events/Listener.d.ts +79 -0
- package/dist/events/builtin.d.ts +73 -0
- package/dist/events/index.d.ts +6 -155
- package/dist/events/types.d.ts +48 -0
- package/dist/facades/index.d.ts +31 -0
- package/dist/health/HealthCheck.d.ts +34 -0
- package/dist/health/HealthManager.d.ts +53 -0
- package/dist/health/checks/CacheCheck.d.ts +35 -0
- package/dist/health/checks/CustomCheck.d.ts +23 -0
- package/dist/health/checks/DatabaseCheck.d.ts +33 -0
- package/dist/health/checks/MemoryCheck.d.ts +32 -0
- package/dist/health/checks/RedisCheck.d.ts +27 -0
- package/dist/health/checks/StorageCheck.d.ts +35 -0
- package/dist/health/checks/index.d.ts +12 -0
- package/dist/health/index.d.ts +5 -185
- package/dist/health/types.d.ts +52 -0
- package/dist/hot-reload/hot-disposables.d.ts +96 -0
- package/dist/hot-reload/testing.d.ts +14 -0
- package/dist/http/Application.d.ts +187 -0
- package/dist/http/FormRequest.d.ts +73 -0
- package/dist/http/dev-assets.d.ts +51 -0
- package/dist/http/dev-banner.d.ts +7 -0
- package/dist/http/inertia-assets.d.ts +22 -0
- package/dist/http/middleware/auth.d.ts +13 -0
- package/dist/http/middleware/capabilities.d.ts +22 -0
- package/dist/http/middleware/cors.d.ts +40 -0
- package/dist/http/middleware/csp.d.ts +59 -0
- package/dist/http/middleware/csrf.d.ts +121 -0
- package/dist/http/middleware/detect-locale.d.ts +65 -0
- package/dist/http/middleware/force-https.d.ts +34 -0
- package/dist/http/middleware/host-authorization.d.ts +24 -0
- package/dist/http/middleware/index.d.ts +19 -0
- package/dist/http/middleware/loopback-guard.d.ts +38 -0
- package/dist/{rate-limit-D9J2b4S1.d.ts → http/middleware/rate-limit.d.ts} +22 -50
- package/dist/http/middleware/redirect-safety.d.ts +29 -0
- package/dist/http/middleware/request-id.d.ts +19 -0
- package/dist/http/middleware/request-logging.d.ts +16 -0
- package/dist/http/middleware/security-headers.d.ts +49 -0
- package/dist/http/middleware/session.d.ts +93 -0
- package/dist/http/middleware/validation.d.ts +94 -0
- package/dist/http/public-assets.d.ts +15 -0
- package/dist/http/request.d.ts +24 -0
- package/dist/http/resources/CursorPaginator.d.ts +106 -0
- package/dist/http/resources/Paginator.d.ts +130 -0
- package/dist/http/resources/Resource.d.ts +67 -0
- package/dist/http/resources/ResourceCollection.d.ts +60 -0
- package/dist/http/resources/index.d.ts +6 -0
- package/dist/http/resources/types.d.ts +91 -0
- package/dist/http/validation/Validator.d.ts +128 -0
- package/dist/http/validation/index.d.ts +3 -0
- package/dist/http/validation/rules.d.ts +196 -0
- package/dist/http/validation/types.d.ts +96 -0
- package/dist/http/vite-dev-server.d.ts +27 -0
- package/dist/i18n/I18nManager.d.ts +114 -0
- package/dist/i18n/Translator.d.ts +80 -0
- package/dist/i18n/index.d.ts +6 -101
- package/dist/i18n/index.js +5 -3
- package/dist/i18n/loaders/JsonLoader.d.ts +47 -0
- package/dist/i18n/loaders/MemoryLoader.d.ts +37 -0
- package/dist/i18n/pluralization.d.ts +19 -0
- package/dist/i18n/types.d.ts +106 -0
- package/dist/index.d.ts +69 -2605
- package/dist/index.js +332 -152
- package/dist/lambda/index.d.ts +17 -37
- package/dist/logging/LogManager.d.ts +83 -0
- package/dist/logging/Logger.d.ts +76 -0
- package/dist/logging/channels/ConsoleChannel.d.ts +11 -0
- package/dist/logging/channels/DailyFileChannel.d.ts +20 -0
- package/dist/logging/channels/FileChannel.d.ts +15 -0
- package/dist/logging/index.d.ts +8 -50
- package/dist/logging/types.d.ts +96 -0
- package/dist/mail/Mail.d.ts +138 -0
- package/dist/mail/MailManager.d.ts +79 -0
- package/dist/mail/address.d.ts +8 -0
- package/dist/mail/index.d.ts +7 -316
- package/dist/mail/transports/LogTransport.d.ts +19 -0
- package/dist/mail/transports/MemoryTransport.d.ts +84 -0
- package/dist/mail/transports/ResendTransport.d.ts +32 -0
- package/dist/mail/transports/SmtpTransport.d.ts +40 -0
- package/dist/{MailManager-DpMvYiP9.d.ts → mail/types.d.ts} +11 -92
- package/dist/mcp/McpServiceProvider.d.ts +17 -0
- package/dist/mcp/create-mcp-server.d.ts +144 -0
- package/dist/mcp/endpoint.d.ts +29 -0
- package/dist/mcp/index.d.ts +3 -185
- package/dist/mcp/index.js +1 -1
- package/dist/mvc/Controller.d.ts +326 -0
- package/dist/mvc/Router.d.ts +239 -0
- package/dist/mvc/ViewEngine.d.ts +11 -0
- package/dist/mvc/inertia/InertiaEngine.d.ts +114 -0
- package/dist/mvc/inertia/shared.d.ts +90 -0
- package/dist/mvc/mount-route.d.ts +10 -0
- package/dist/notifications/Notification.d.ts +99 -0
- package/dist/notifications/NotificationManager.d.ts +150 -0
- package/dist/notifications/channels/DatabaseChannel.d.ts +55 -0
- package/dist/notifications/channels/MailChannel.d.ts +45 -0
- package/dist/notifications/channels/MemoryChannel.d.ts +85 -0
- package/dist/notifications/channels/SlackChannel.d.ts +73 -0
- package/dist/notifications/channels/index.d.ts +4 -0
- package/dist/notifications/index.d.ts +6 -322
- package/dist/notifications/notifiable-type.d.ts +10 -0
- package/dist/notifications/registry.d.ts +39 -0
- package/dist/notifications/types.d.ts +162 -0
- package/dist/providers/AuthServiceProvider.d.ts +7 -0
- package/dist/providers/AuthorizationServiceProvider.d.ts +9 -0
- package/dist/providers/BroadcastServiceProvider.d.ts +7 -0
- package/dist/providers/CacheServiceProvider.d.ts +7 -0
- package/dist/providers/EncryptionServiceProvider.d.ts +7 -0
- package/dist/providers/ErrorServiceProvider.d.ts +9 -0
- package/dist/providers/EventServiceProvider.d.ts +7 -0
- package/dist/providers/HealthServiceProvider.d.ts +7 -0
- package/dist/providers/I18nServiceProvider.d.ts +27 -0
- package/dist/providers/InertiaServiceProvider.d.ts +20 -0
- package/dist/providers/LogServiceProvider.d.ts +7 -0
- package/dist/providers/MailServiceProvider.d.ts +7 -0
- package/dist/providers/NotificationServiceProvider.d.ts +8 -0
- package/dist/providers/OAuthServiceProvider.d.ts +7 -0
- package/dist/providers/QueueServiceProvider.d.ts +7 -0
- package/dist/providers/SchedulingServiceProvider.d.ts +7 -0
- package/dist/providers/StorageServiceProvider.d.ts +7 -0
- package/dist/providers/index.d.ts +17 -0
- package/dist/queue/FailedJobReporter.d.ts +40 -0
- package/dist/queue/Job.d.ts +140 -0
- package/dist/queue/QueueManager.d.ts +79 -0
- package/dist/queue/Worker.d.ts +99 -0
- package/dist/queue/drivers/MemoryDriver.d.ts +60 -0
- package/dist/queue/drivers/RedisDriver.d.ts +96 -0
- package/dist/queue/drivers/SqsDriver.d.ts +108 -0
- package/dist/queue/drivers/SyncDriver.d.ts +28 -0
- package/dist/queue/index.d.ts +9 -453
- package/dist/queue/types.d.ts +171 -0
- package/dist/redis/RedisApiTokenStore.d.ts +78 -0
- package/dist/redis/RedisEmailVerificationStore.d.ts +54 -0
- package/dist/redis/RedisOAuthStateStore.d.ts +26 -0
- package/dist/redis/RedisPasswordResetStore.d.ts +57 -0
- package/dist/redis/RedisRateLimitStore.d.ts +77 -0
- package/dist/redis/RedisSessionStore.d.ts +61 -0
- package/dist/redis/client.d.ts +41 -0
- package/dist/redis/index.d.ts +14 -356
- package/dist/redis/index.js +5 -2
- package/dist/redis/scan-keys.d.ts +6 -0
- package/dist/runtime/index.d.ts +8 -95
- package/dist/runtime/index.js +1 -1
- package/dist/scheduling/CronParser.d.ts +37 -0
- package/dist/scheduling/Schedule.d.ts +229 -0
- package/dist/scheduling/ScheduledTask.d.ts +47 -0
- package/dist/scheduling/Scheduler.d.ts +99 -0
- package/dist/scheduling/index.d.ts +5 -41
- package/dist/scheduling/types.d.ts +97 -0
- package/dist/storage/StorageManager.d.ts +65 -0
- package/dist/storage/drivers/LocalDriver.d.ts +55 -0
- package/dist/storage/drivers/MemoryDriver.d.ts +66 -0
- package/dist/storage/drivers/S3Driver.d.ts +72 -0
- package/dist/storage/index.d.ts +5 -197
- package/dist/{StorageManager-oZTHqaza.d.ts → storage/types.d.ts} +10 -77
- package/dist/support/error-polyfill.d.ts +9 -0
- package/dist/support/import-map.d.ts +13 -0
- package/dist/support/redirect-target.d.ts +11 -0
- package/dist/support/stack-frames.d.ts +56 -0
- package/dist/support/trim-slashes.d.ts +11 -0
- package/dist/vite/index.d.ts +2 -35
- package/dist/vite/index.js +0 -3
- package/dist/vite/plugin.d.ts +34 -0
- package/package.json +3 -3
- package/dist/AuthManager-DBP4KYsx.d.ts +0 -79
- package/dist/BroadcastManager-D8KoJxiV.d.ts +0 -492
- package/dist/HealthManager-DUyMIzsZ.d.ts +0 -141
- package/dist/I18nManager-BiSoczfV.d.ts +0 -275
- package/dist/LogManager-7mxnkaPM.d.ts +0 -256
- package/dist/Scheduler-pZiT8i57.d.ts +0 -471
- package/dist/api-token-D24VPr_E.d.ts +0 -663
- package/dist/app-key-CsBfRC_Q.d.ts +0 -214
- package/dist/email-verification-D60YF2ZO.d.ts +0 -329
- package/dist/index-9_Jzj5jo.d.ts +0 -7
- package/dist/validation-yAL53e1S.d.ts +0 -2610
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
import { Context } from 'hono';
|
|
2
|
-
import { Model } from '@guren/orm';
|
|
3
|
-
import { A as Authenticatable, U as UserProvider, a as AuthCredentials, b as AuthManagerContract, c as AuthManagerOptions, G as GuardFactory, P as ProviderFactory, d as GuardContext, e as Guard, f as AttachContextOptions, g as AuthContext } from './api-token-D24VPr_E.js';
|
|
4
|
-
|
|
5
|
-
interface PasswordHasher {
|
|
6
|
-
hash(plain: string): Promise<string>;
|
|
7
|
-
verify(hashed: string, plain: string): Promise<boolean>;
|
|
8
|
-
needsRehash?(hashed: string): boolean;
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
declare abstract class BaseUserProvider<User extends Authenticatable = Authenticatable> implements UserProvider<User> {
|
|
12
|
-
abstract retrieveById(identifier: unknown): Promise<User | null>;
|
|
13
|
-
abstract retrieveByCredentials(credentials: AuthCredentials): Promise<User | null>;
|
|
14
|
-
abstract validateCredentials(user: User, credentials: AuthCredentials): Promise<boolean>;
|
|
15
|
-
abstract getId(user: User): unknown;
|
|
16
|
-
setRememberToken(user: User, token: string | null): Promise<void>;
|
|
17
|
-
getRememberToken(user: User): Promise<string | null>;
|
|
18
|
-
}
|
|
19
|
-
|
|
20
|
-
interface ModelUserProviderOptions {
|
|
21
|
-
idColumn?: string;
|
|
22
|
-
usernameColumn?: string;
|
|
23
|
-
passwordColumn?: string;
|
|
24
|
-
rememberTokenColumn?: string;
|
|
25
|
-
hasher?: PasswordHasher;
|
|
26
|
-
credentialsPasswordField?: string;
|
|
27
|
-
}
|
|
28
|
-
declare class ModelUserProvider<User extends Authenticatable = Authenticatable> extends BaseUserProvider<User> {
|
|
29
|
-
private readonly model;
|
|
30
|
-
private readonly idColumn;
|
|
31
|
-
private readonly usernameColumn;
|
|
32
|
-
private readonly passwordColumn;
|
|
33
|
-
private readonly rememberTokenColumn;
|
|
34
|
-
private readonly hasher;
|
|
35
|
-
private readonly credentialsPasswordField;
|
|
36
|
-
constructor(model: typeof Model, options?: ModelUserProviderOptions);
|
|
37
|
-
private cast;
|
|
38
|
-
retrieveById(identifier: unknown): Promise<User | null>;
|
|
39
|
-
retrieveByCredentials(credentials: AuthCredentials): Promise<User | null>;
|
|
40
|
-
validateCredentials(user: User, credentials: AuthCredentials): Promise<boolean>;
|
|
41
|
-
getId(user: User): unknown;
|
|
42
|
-
/**
|
|
43
|
-
* Strip the password hash, remember token, and the model's `hidden`
|
|
44
|
-
* fields before the record leaves the auth layer. Credential
|
|
45
|
-
* validation happens on the raw record before sanitizing, so this
|
|
46
|
-
* never affects login — only what `auth.user()` exposes.
|
|
47
|
-
*/
|
|
48
|
-
sanitize(user: User): User;
|
|
49
|
-
setRememberToken(user: User, token: string | null): Promise<void>;
|
|
50
|
-
getRememberToken(user: User): Promise<string | null>;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
declare class AuthManager implements AuthManagerContract {
|
|
54
|
-
private readonly guards;
|
|
55
|
-
private readonly providers;
|
|
56
|
-
private defaultGuard;
|
|
57
|
-
constructor(options?: AuthManagerOptions);
|
|
58
|
-
registerGuard<User>(name: string, factory: GuardFactory<User>): void;
|
|
59
|
-
registerProvider<User>(name: string, factory: ProviderFactory<User>): void;
|
|
60
|
-
getProvider<User>(name: string): UserProvider<User>;
|
|
61
|
-
createGuard<User>(name: string, context: GuardContext): Guard<User>;
|
|
62
|
-
guardNames(): string[];
|
|
63
|
-
setDefaultGuard(name: string): void;
|
|
64
|
-
getDefaultGuard(): string;
|
|
65
|
-
createAuthContext(ctx: Context, options?: AttachContextOptions): AuthContext;
|
|
66
|
-
attempt(name: string, ctx: Context, credentials: AuthCredentials, remember?: boolean): Promise<boolean>;
|
|
67
|
-
/**
|
|
68
|
-
* Shorthand method to register a model-based authentication provider and session guard.
|
|
69
|
-
* This simplifies the common case of authenticating users via a database model.
|
|
70
|
-
*
|
|
71
|
-
* @param model - The model class to use for user authentication
|
|
72
|
-
* @param options - Options for the ModelUserProvider (partial, with defaults)
|
|
73
|
-
* @param providerName - Name for the provider (defaults to 'users')
|
|
74
|
-
* @param guardName - Name for the guard (defaults to 'web')
|
|
75
|
-
*/
|
|
76
|
-
useModel(model: typeof Model<PlainObject>, options?: Partial<ModelUserProviderOptions>, providerName?: string, guardName?: string): void;
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
export { AuthManager as A, BaseUserProvider as B, ModelUserProvider as M, type PasswordHasher as P };
|
|
@@ -1,492 +0,0 @@
|
|
|
1
|
-
import { M as Middleware } from './index-9_Jzj5jo.js';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Broadcast event payload.
|
|
5
|
-
*/
|
|
6
|
-
interface BroadcastEvent {
|
|
7
|
-
channel: string;
|
|
8
|
-
event: string;
|
|
9
|
-
data: unknown;
|
|
10
|
-
timestamp: Date;
|
|
11
|
-
}
|
|
12
|
-
/**
|
|
13
|
-
* Broadcast driver interface.
|
|
14
|
-
*/
|
|
15
|
-
interface BroadcastDriver {
|
|
16
|
-
/**
|
|
17
|
-
* Publish an event to a channel.
|
|
18
|
-
*/
|
|
19
|
-
publish(channel: string, event: string, data: unknown): Promise<void>;
|
|
20
|
-
/**
|
|
21
|
-
* Subscribe to a channel.
|
|
22
|
-
* Returns an unsubscribe function.
|
|
23
|
-
*/
|
|
24
|
-
subscribe(channel: string, callback: (event: BroadcastEvent) => void): () => void;
|
|
25
|
-
/**
|
|
26
|
-
* Unsubscribe from a channel.
|
|
27
|
-
*/
|
|
28
|
-
unsubscribe(channel: string, callback: (event: BroadcastEvent) => void): void;
|
|
29
|
-
}
|
|
30
|
-
/**
|
|
31
|
-
* Broadcast driver with presence support.
|
|
32
|
-
*/
|
|
33
|
-
interface PresenceBroadcastDriver extends BroadcastDriver {
|
|
34
|
-
/**
|
|
35
|
-
* Get members of a presence channel.
|
|
36
|
-
*/
|
|
37
|
-
getMembers(channel: string): PresenceMember[];
|
|
38
|
-
/**
|
|
39
|
-
* Add a member to a presence channel.
|
|
40
|
-
*/
|
|
41
|
-
addMember(channel: string, member: PresenceMember): void;
|
|
42
|
-
/**
|
|
43
|
-
* Remove a member from a presence channel.
|
|
44
|
-
*/
|
|
45
|
-
removeMember(channel: string, memberId: string | number): void;
|
|
46
|
-
}
|
|
47
|
-
/**
|
|
48
|
-
* Channel authorizer function.
|
|
49
|
-
*/
|
|
50
|
-
interface ChannelAuthorizer {
|
|
51
|
-
(channelName: string, user: unknown): boolean | Promise<boolean>;
|
|
52
|
-
}
|
|
53
|
-
/**
|
|
54
|
-
* Presence channel authorizer function.
|
|
55
|
-
* Returns member info if authorized, null otherwise.
|
|
56
|
-
*/
|
|
57
|
-
interface PresenceChannelAuthorizer {
|
|
58
|
-
(channelName: string, user: unknown): PresenceMember | null | Promise<PresenceMember | null>;
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
* Presence channel member.
|
|
62
|
-
*/
|
|
63
|
-
interface PresenceMember {
|
|
64
|
-
id: string | number;
|
|
65
|
-
info?: Record<string, unknown>;
|
|
66
|
-
}
|
|
67
|
-
/**
|
|
68
|
-
* SSE client connection.
|
|
69
|
-
*/
|
|
70
|
-
interface SSEClient {
|
|
71
|
-
id: string;
|
|
72
|
-
userId?: string | number;
|
|
73
|
-
channels: Set<string>;
|
|
74
|
-
send(event: string, data: unknown): void;
|
|
75
|
-
close(): void;
|
|
76
|
-
}
|
|
77
|
-
/**
|
|
78
|
-
* WebSocket client connection.
|
|
79
|
-
*/
|
|
80
|
-
interface WebSocketClient {
|
|
81
|
-
id: string;
|
|
82
|
-
userId?: string | number;
|
|
83
|
-
channels: Set<string>;
|
|
84
|
-
send(event: string, data: unknown): void | Promise<void>;
|
|
85
|
-
close(): void;
|
|
86
|
-
}
|
|
87
|
-
/**
|
|
88
|
-
* Broadcast manager options.
|
|
89
|
-
*/
|
|
90
|
-
interface BroadcastManagerOptions {
|
|
91
|
-
/**
|
|
92
|
-
* Default driver name.
|
|
93
|
-
*/
|
|
94
|
-
default?: string;
|
|
95
|
-
/**
|
|
96
|
-
* Driver factories.
|
|
97
|
-
*/
|
|
98
|
-
drivers?: Record<string, BroadcastDriverFactory>;
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* Broadcast driver factory.
|
|
102
|
-
*/
|
|
103
|
-
interface BroadcastDriverFactory {
|
|
104
|
-
(): BroadcastDriver;
|
|
105
|
-
}
|
|
106
|
-
/**
|
|
107
|
-
* Channel registration.
|
|
108
|
-
*/
|
|
109
|
-
interface ChannelRegistration {
|
|
110
|
-
pattern: string;
|
|
111
|
-
type: 'public' | 'private' | 'presence';
|
|
112
|
-
authorizer: ChannelAuthorizer | PresenceChannelAuthorizer;
|
|
113
|
-
}
|
|
114
|
-
/**
|
|
115
|
-
* SSE middleware options.
|
|
116
|
-
*/
|
|
117
|
-
interface SSEMiddlewareOptions {
|
|
118
|
-
/**
|
|
119
|
-
* Ping interval in milliseconds.
|
|
120
|
-
*/
|
|
121
|
-
pingInterval?: number;
|
|
122
|
-
/**
|
|
123
|
-
* Retry delay for SSE reconnection.
|
|
124
|
-
*/
|
|
125
|
-
retry?: number;
|
|
126
|
-
/**
|
|
127
|
-
* Function to get the user from the request context, used to authorize
|
|
128
|
-
* channels requested via the `?channels=` query parameter.
|
|
129
|
-
*/
|
|
130
|
-
getUser?: (ctx: unknown) => unknown | Promise<unknown>;
|
|
131
|
-
}
|
|
132
|
-
/**
|
|
133
|
-
* Auth middleware options.
|
|
134
|
-
*/
|
|
135
|
-
interface AuthMiddlewareOptions {
|
|
136
|
-
/**
|
|
137
|
-
* Function to get user from context.
|
|
138
|
-
*/
|
|
139
|
-
getUser?: (ctx: unknown) => unknown | Promise<unknown>;
|
|
140
|
-
}
|
|
141
|
-
/**
|
|
142
|
-
* Broadcasted event interface (for Event class integration).
|
|
143
|
-
*/
|
|
144
|
-
interface BroadcastableEvent {
|
|
145
|
-
/**
|
|
146
|
-
* Get channels to broadcast to.
|
|
147
|
-
*/
|
|
148
|
-
broadcastOn(): string[];
|
|
149
|
-
/**
|
|
150
|
-
* Get the event name for broadcasting.
|
|
151
|
-
*/
|
|
152
|
-
broadcastAs?(): string;
|
|
153
|
-
/**
|
|
154
|
-
* Get the data to broadcast.
|
|
155
|
-
*/
|
|
156
|
-
broadcastWith?(): Record<string, unknown>;
|
|
157
|
-
}
|
|
158
|
-
|
|
159
|
-
/**
|
|
160
|
-
* Base broadcast channel.
|
|
161
|
-
*
|
|
162
|
-
* @example
|
|
163
|
-
* ```typescript
|
|
164
|
-
* const channel = new Channel('notifications', driver)
|
|
165
|
-
* await channel.broadcast('NewMessage', { content: 'Hello!' })
|
|
166
|
-
* ```
|
|
167
|
-
*/
|
|
168
|
-
declare class Channel {
|
|
169
|
-
readonly name: string;
|
|
170
|
-
protected driver: BroadcastDriver;
|
|
171
|
-
constructor(name: string, driver: BroadcastDriver);
|
|
172
|
-
/**
|
|
173
|
-
* Broadcast an event to this channel.
|
|
174
|
-
*/
|
|
175
|
-
broadcast(event: string, data: unknown): Promise<void>;
|
|
176
|
-
/**
|
|
177
|
-
* Subscribe to events on this channel.
|
|
178
|
-
* Returns an unsubscribe function.
|
|
179
|
-
*/
|
|
180
|
-
subscribe(callback: (event: string, data: unknown) => void): () => void;
|
|
181
|
-
/**
|
|
182
|
-
* Get the full channel name for broadcasting.
|
|
183
|
-
*/
|
|
184
|
-
getChannelName(): string;
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
/**
|
|
188
|
-
* Private broadcast channel.
|
|
189
|
-
*
|
|
190
|
-
* Requires authentication to subscribe.
|
|
191
|
-
*
|
|
192
|
-
* @example
|
|
193
|
-
* ```typescript
|
|
194
|
-
* const channel = new PrivateChannel('orders.123', driver)
|
|
195
|
-
* await channel.broadcast('OrderUpdated', { status: 'shipped' })
|
|
196
|
-
* ```
|
|
197
|
-
*/
|
|
198
|
-
declare class PrivateChannel extends Channel {
|
|
199
|
-
/**
|
|
200
|
-
* Channel name prefix.
|
|
201
|
-
*/
|
|
202
|
-
static readonly PREFIX = "private-";
|
|
203
|
-
constructor(name: string, driver: BroadcastDriver);
|
|
204
|
-
/**
|
|
205
|
-
* Get the channel name without the private prefix.
|
|
206
|
-
*/
|
|
207
|
-
getBaseName(): string;
|
|
208
|
-
/**
|
|
209
|
-
* Check if a channel name is a private channel.
|
|
210
|
-
*/
|
|
211
|
-
static isPrivateChannel(name: string): boolean;
|
|
212
|
-
/**
|
|
213
|
-
* Normalize a channel name to include the private prefix.
|
|
214
|
-
*/
|
|
215
|
-
static normalize(name: string): string;
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
/**
|
|
219
|
-
* Presence broadcast channel.
|
|
220
|
-
*
|
|
221
|
-
* Tracks members who have joined the channel.
|
|
222
|
-
*
|
|
223
|
-
* @example
|
|
224
|
-
* ```typescript
|
|
225
|
-
* const channel = new PresenceChannel('chat.1', driver)
|
|
226
|
-
*
|
|
227
|
-
* // Join channel
|
|
228
|
-
* await channel.join({ id: 1, info: { name: 'John' } })
|
|
229
|
-
*
|
|
230
|
-
* // Get members
|
|
231
|
-
* const members = channel.members()
|
|
232
|
-
*
|
|
233
|
-
* // Leave channel
|
|
234
|
-
* await channel.leave(1)
|
|
235
|
-
*
|
|
236
|
-
* // Broadcast
|
|
237
|
-
* await channel.broadcast('UserTyping', { userId: 1 })
|
|
238
|
-
* ```
|
|
239
|
-
*/
|
|
240
|
-
declare class PresenceChannel extends Channel {
|
|
241
|
-
/**
|
|
242
|
-
* Channel name prefix.
|
|
243
|
-
*/
|
|
244
|
-
static readonly PREFIX = "presence-";
|
|
245
|
-
protected presenceDriver: PresenceBroadcastDriver;
|
|
246
|
-
constructor(name: string, driver: BroadcastDriver);
|
|
247
|
-
/**
|
|
248
|
-
* Check if a driver supports presence.
|
|
249
|
-
*/
|
|
250
|
-
protected isPresenceDriver(driver: BroadcastDriver): driver is PresenceBroadcastDriver;
|
|
251
|
-
/**
|
|
252
|
-
* Get members in this channel.
|
|
253
|
-
*/
|
|
254
|
-
members(): PresenceMember[];
|
|
255
|
-
/**
|
|
256
|
-
* Join the channel.
|
|
257
|
-
*/
|
|
258
|
-
join(member: PresenceMember): Promise<void>;
|
|
259
|
-
/**
|
|
260
|
-
* Leave the channel.
|
|
261
|
-
*/
|
|
262
|
-
leave(memberId: string | number): Promise<void>;
|
|
263
|
-
/**
|
|
264
|
-
* Check if a member is in the channel.
|
|
265
|
-
*/
|
|
266
|
-
hasMember(memberId: string | number): boolean;
|
|
267
|
-
/**
|
|
268
|
-
* Get member by ID.
|
|
269
|
-
*/
|
|
270
|
-
getMember(memberId: string | number): PresenceMember | undefined;
|
|
271
|
-
/**
|
|
272
|
-
* Get member count.
|
|
273
|
-
*/
|
|
274
|
-
count(): number;
|
|
275
|
-
/**
|
|
276
|
-
* Get the channel name without the presence prefix.
|
|
277
|
-
*/
|
|
278
|
-
getBaseName(): string;
|
|
279
|
-
/**
|
|
280
|
-
* Check if a channel name is a presence channel.
|
|
281
|
-
*/
|
|
282
|
-
static isPresenceChannel(name: string): boolean;
|
|
283
|
-
/**
|
|
284
|
-
* Normalize a channel name to include the presence prefix.
|
|
285
|
-
*/
|
|
286
|
-
static normalize(name: string): string;
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
/**
|
|
290
|
-
* Broadcast manager for real-time event broadcasting.
|
|
291
|
-
*
|
|
292
|
-
* @example
|
|
293
|
-
* ```typescript
|
|
294
|
-
* const broadcast = new BroadcastManager({
|
|
295
|
-
* default: 'memory',
|
|
296
|
-
* drivers: {
|
|
297
|
-
* memory: () => new MemoryDriver(),
|
|
298
|
-
* redis: () => new RedisDriver(redis),
|
|
299
|
-
* },
|
|
300
|
-
* })
|
|
301
|
-
*
|
|
302
|
-
* // Register channel authorizers
|
|
303
|
-
* broadcast
|
|
304
|
-
* .channel('public.*', () => true)
|
|
305
|
-
* .privateChannel('orders.{orderId}', async (channel, user) => {
|
|
306
|
-
* const orderId = channel.split('.')[1]
|
|
307
|
-
* return order.userId === user.id
|
|
308
|
-
* })
|
|
309
|
-
* .presenceChannel('chat.{roomId}', async (channel, user) => {
|
|
310
|
-
* return { id: user.id, info: { name: user.name } }
|
|
311
|
-
* })
|
|
312
|
-
*
|
|
313
|
-
* // Broadcast events
|
|
314
|
-
* await broadcast.broadcast('notifications', 'NewMessage', { content: 'Hello!' })
|
|
315
|
-
*
|
|
316
|
-
* // Or use channel helpers
|
|
317
|
-
* await broadcast.toChannel('notifications').broadcast('NewMessage', data)
|
|
318
|
-
* await broadcast.toPrivate('orders.123').broadcast('OrderUpdated', data)
|
|
319
|
-
* await broadcast.toPresence('chat.1').broadcast('UserTyping', data)
|
|
320
|
-
* ```
|
|
321
|
-
*/
|
|
322
|
-
declare class BroadcastManager {
|
|
323
|
-
/**
|
|
324
|
-
* Default driver name.
|
|
325
|
-
*/
|
|
326
|
-
protected defaultDriver: string;
|
|
327
|
-
/**
|
|
328
|
-
* Driver factories.
|
|
329
|
-
*/
|
|
330
|
-
protected driverFactories: Map<string, BroadcastDriverFactory>;
|
|
331
|
-
/**
|
|
332
|
-
* Resolved drivers.
|
|
333
|
-
*/
|
|
334
|
-
protected resolvedDrivers: Map<string, BroadcastDriver>;
|
|
335
|
-
/**
|
|
336
|
-
* Channel registrations.
|
|
337
|
-
*/
|
|
338
|
-
protected channelRegistrations: ChannelRegistration[];
|
|
339
|
-
/**
|
|
340
|
-
* SSE clients.
|
|
341
|
-
*/
|
|
342
|
-
protected sseClients: Map<string, SSEClient>;
|
|
343
|
-
/**
|
|
344
|
-
* WebSocket clients.
|
|
345
|
-
*/
|
|
346
|
-
protected wsClients: Map<string, WebSocketClient>;
|
|
347
|
-
constructor(options?: BroadcastManagerOptions);
|
|
348
|
-
/**
|
|
349
|
-
* Register a driver factory.
|
|
350
|
-
*/
|
|
351
|
-
registerDriver(name: string, factory: BroadcastDriverFactory): this;
|
|
352
|
-
/**
|
|
353
|
-
* Get a driver by name.
|
|
354
|
-
*/
|
|
355
|
-
driver(name?: string): BroadcastDriver;
|
|
356
|
-
/**
|
|
357
|
-
* Register a public channel authorizer.
|
|
358
|
-
*/
|
|
359
|
-
channel(pattern: string, authorizer: ChannelAuthorizer): this;
|
|
360
|
-
/**
|
|
361
|
-
* Register a private channel authorizer.
|
|
362
|
-
*/
|
|
363
|
-
privateChannel(pattern: string, authorizer: ChannelAuthorizer): this;
|
|
364
|
-
/**
|
|
365
|
-
* Register a presence channel authorizer.
|
|
366
|
-
*/
|
|
367
|
-
presenceChannel(pattern: string, authorizer: PresenceChannelAuthorizer): this;
|
|
368
|
-
/**
|
|
369
|
-
* Broadcast an event to a channel.
|
|
370
|
-
*/
|
|
371
|
-
broadcast(channelName: string, event: string, data: unknown): Promise<void>;
|
|
372
|
-
/**
|
|
373
|
-
* Get a public channel.
|
|
374
|
-
*/
|
|
375
|
-
toChannel(name: string): Channel;
|
|
376
|
-
/**
|
|
377
|
-
* Get a private channel.
|
|
378
|
-
*/
|
|
379
|
-
toPrivate(name: string): PrivateChannel;
|
|
380
|
-
/**
|
|
381
|
-
* Get a presence channel.
|
|
382
|
-
*/
|
|
383
|
-
toPresence(name: string): PresenceChannel;
|
|
384
|
-
/**
|
|
385
|
-
* Authorize a channel for a user.
|
|
386
|
-
*/
|
|
387
|
-
authorize(channelName: string, user: unknown): Promise<boolean | {
|
|
388
|
-
id: string | number;
|
|
389
|
-
info?: Record<string, unknown>;
|
|
390
|
-
} | null>;
|
|
391
|
-
/**
|
|
392
|
-
* Find channel registration for a channel name.
|
|
393
|
-
*/
|
|
394
|
-
protected findChannelRegistration(channelName: string): ChannelRegistration | undefined;
|
|
395
|
-
/**
|
|
396
|
-
* Match a channel name against a pattern.
|
|
397
|
-
*/
|
|
398
|
-
protected matchPattern(pattern: string, channelName: string): boolean;
|
|
399
|
-
/**
|
|
400
|
-
* Create SSE middleware.
|
|
401
|
-
*/
|
|
402
|
-
sseMiddleware(options?: SSEMiddlewareOptions): Middleware;
|
|
403
|
-
/**
|
|
404
|
-
* Create auth middleware for channel authorization.
|
|
405
|
-
*/
|
|
406
|
-
authMiddleware(options?: AuthMiddlewareOptions): Middleware;
|
|
407
|
-
/**
|
|
408
|
-
* Subscribe a client to a channel.
|
|
409
|
-
*/
|
|
410
|
-
subscribeClient(clientId: string, channel: string): boolean;
|
|
411
|
-
/**
|
|
412
|
-
* Register a WebSocket client and return its generated client ID.
|
|
413
|
-
*/
|
|
414
|
-
registerWebSocketClient(client: Omit<WebSocketClient, 'id' | 'channels'> & {
|
|
415
|
-
userId?: string | number;
|
|
416
|
-
}): string;
|
|
417
|
-
/**
|
|
418
|
-
* Remove a WebSocket client and close the underlying connection.
|
|
419
|
-
*/
|
|
420
|
-
removeWebSocketClient(clientId: string): boolean;
|
|
421
|
-
/**
|
|
422
|
-
* Subscribe a WebSocket client to a channel.
|
|
423
|
-
*/
|
|
424
|
-
subscribeWebSocketClient(clientId: string, channel: string): boolean;
|
|
425
|
-
/**
|
|
426
|
-
* Unsubscribe a WebSocket client from a channel.
|
|
427
|
-
*/
|
|
428
|
-
unsubscribeWebSocketClient(clientId: string, channel: string): boolean;
|
|
429
|
-
/**
|
|
430
|
-
* Get a WebSocket client by ID.
|
|
431
|
-
*/
|
|
432
|
-
getWebSocketClient(clientId: string): WebSocketClient | undefined;
|
|
433
|
-
/**
|
|
434
|
-
* Get all WebSocket clients.
|
|
435
|
-
*/
|
|
436
|
-
getWebSocketClients(): WebSocketClient[];
|
|
437
|
-
/**
|
|
438
|
-
* Unsubscribe a client from a channel.
|
|
439
|
-
*/
|
|
440
|
-
unsubscribeClient(clientId: string, channel: string): boolean;
|
|
441
|
-
/**
|
|
442
|
-
* Get SSE client by ID.
|
|
443
|
-
*/
|
|
444
|
-
getClient(clientId: string): SSEClient | undefined;
|
|
445
|
-
/**
|
|
446
|
-
* Get all SSE clients.
|
|
447
|
-
*/
|
|
448
|
-
getClients(): SSEClient[];
|
|
449
|
-
/**
|
|
450
|
-
* Get clients subscribed to a channel.
|
|
451
|
-
*/
|
|
452
|
-
getChannelClients(channel: string): SSEClient[];
|
|
453
|
-
/**
|
|
454
|
-
* Close every SSE connection this manager is holding.
|
|
455
|
-
*
|
|
456
|
-
* Each connection owns a ping timer that is only cleared when the stream is
|
|
457
|
-
* cancelled or the request aborts. `Bun.serve().stop()` without forcing waits
|
|
458
|
-
* for in-flight requests instead of cutting them, and an SSE response never
|
|
459
|
-
* finishes — so on a hot reload those connections outlive the manager, and
|
|
460
|
-
* their timers go on pinging a stream nobody reads.
|
|
461
|
-
*
|
|
462
|
-
* `getClients()` returns a snapshot. A `Map` iterator does tolerate an entry
|
|
463
|
-
* deleting itself, which is all `cleanup()` does today — but not a `close()`
|
|
464
|
-
* that reaches another client, which would drop that one from the iteration
|
|
465
|
-
* unvisited and leave its timer running.
|
|
466
|
-
*/
|
|
467
|
-
disconnectAll(): void;
|
|
468
|
-
/**
|
|
469
|
-
* Generate a unique client ID.
|
|
470
|
-
*/
|
|
471
|
-
protected generateClientId(prefix?: 'sse' | 'ws'): string;
|
|
472
|
-
}
|
|
473
|
-
/**
|
|
474
|
-
* Set the global broadcast manager.
|
|
475
|
-
*/
|
|
476
|
-
declare function setBroadcastManager(manager: BroadcastManager): void;
|
|
477
|
-
/**
|
|
478
|
-
* Get the global broadcast manager.
|
|
479
|
-
*/
|
|
480
|
-
declare function getBroadcastManager(): BroadcastManager;
|
|
481
|
-
/**
|
|
482
|
-
* Create a broadcast manager.
|
|
483
|
-
*
|
|
484
|
-
* Under `bun --hot`, the manager this one replaces has its SSE connections
|
|
485
|
-
* closed first, so their ping timers stop with it. Registered from the factory
|
|
486
|
-
* rather than the constructor because the factory is what application code
|
|
487
|
-
* calls: frame 2 of the stack is the provider that built the manager, not this
|
|
488
|
-
* file. A bare `new BroadcastManager()` is left alone.
|
|
489
|
-
*/
|
|
490
|
-
declare function createBroadcastManager(options?: BroadcastManagerOptions): BroadcastManager;
|
|
491
|
-
|
|
492
|
-
export { type AuthMiddlewareOptions as A, BroadcastManager as B, Channel as C, type PresenceBroadcastDriver as P, type SSEClient as S, type WebSocketClient as W, type BroadcastDriver as a, type BroadcastDriverFactory as b, type BroadcastEvent as c, type BroadcastManagerOptions as d, type BroadcastableEvent as e, type ChannelAuthorizer as f, type ChannelRegistration as g, PresenceChannel as h, type PresenceChannelAuthorizer as i, type PresenceMember as j, PrivateChannel as k, type SSEMiddlewareOptions as l, createBroadcastManager as m, getBroadcastManager as n, setBroadcastManager as s };
|
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
import { M as Middleware } from './index-9_Jzj5jo.js';
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* Health check status.
|
|
5
|
-
*/
|
|
6
|
-
type HealthStatus = 'healthy' | 'degraded' | 'unhealthy';
|
|
7
|
-
/**
|
|
8
|
-
* Result of a single health check.
|
|
9
|
-
*/
|
|
10
|
-
interface CheckResult {
|
|
11
|
-
name: string;
|
|
12
|
-
status: HealthStatus;
|
|
13
|
-
message?: string;
|
|
14
|
-
meta?: Record<string, unknown>;
|
|
15
|
-
duration: number;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* Complete health report.
|
|
19
|
-
*/
|
|
20
|
-
interface HealthReport {
|
|
21
|
-
status: HealthStatus;
|
|
22
|
-
timestamp: Date;
|
|
23
|
-
checks: CheckResult[];
|
|
24
|
-
meta?: Record<string, unknown>;
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Options for registering a health check.
|
|
28
|
-
*/
|
|
29
|
-
interface HealthCheckOptions {
|
|
30
|
-
/**
|
|
31
|
-
* Timeout in milliseconds for the check.
|
|
32
|
-
* @default 5000
|
|
33
|
-
*/
|
|
34
|
-
timeout?: number;
|
|
35
|
-
/**
|
|
36
|
-
* If true, failure of this check will set overall status to unhealthy.
|
|
37
|
-
* @default false
|
|
38
|
-
*/
|
|
39
|
-
critical?: boolean;
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* Options for health middleware.
|
|
43
|
-
*/
|
|
44
|
-
interface HealthMiddlewareOptions {
|
|
45
|
-
/**
|
|
46
|
-
* Only run these specific checks.
|
|
47
|
-
*/
|
|
48
|
-
checks?: string[];
|
|
49
|
-
/**
|
|
50
|
-
* Include detailed check results.
|
|
51
|
-
* @default true
|
|
52
|
-
*/
|
|
53
|
-
detailed?: boolean;
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
/**
|
|
57
|
-
* Abstract base class for health checks.
|
|
58
|
-
*/
|
|
59
|
-
declare abstract class HealthCheck {
|
|
60
|
-
/**
|
|
61
|
-
* The name of this health check.
|
|
62
|
-
*/
|
|
63
|
-
abstract readonly name: string;
|
|
64
|
-
/**
|
|
65
|
-
* Perform the health check.
|
|
66
|
-
*/
|
|
67
|
-
abstract check(): Promise<CheckResult>;
|
|
68
|
-
/**
|
|
69
|
-
* Create a healthy result.
|
|
70
|
-
*/
|
|
71
|
-
protected healthy(message?: string, meta?: Record<string, unknown>): CheckResult;
|
|
72
|
-
/**
|
|
73
|
-
* Create a degraded result.
|
|
74
|
-
*/
|
|
75
|
-
protected degraded(message?: string, meta?: Record<string, unknown>): CheckResult;
|
|
76
|
-
/**
|
|
77
|
-
* Create an unhealthy result.
|
|
78
|
-
*/
|
|
79
|
-
protected unhealthy(message?: string, meta?: Record<string, unknown>): CheckResult;
|
|
80
|
-
/**
|
|
81
|
-
* Create an unhealthy result from a caught error.
|
|
82
|
-
*/
|
|
83
|
-
protected handleError(error: unknown, fallbackMessage: string): CheckResult;
|
|
84
|
-
/**
|
|
85
|
-
* Create a check result.
|
|
86
|
-
*/
|
|
87
|
-
private result;
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* Health check manager.
|
|
92
|
-
*/
|
|
93
|
-
declare class HealthManager {
|
|
94
|
-
private checks;
|
|
95
|
-
/**
|
|
96
|
-
* Register a health check.
|
|
97
|
-
*/
|
|
98
|
-
register(check: HealthCheck, options?: HealthCheckOptions): this;
|
|
99
|
-
/**
|
|
100
|
-
* Unregister a health check.
|
|
101
|
-
*/
|
|
102
|
-
unregister(name: string): this;
|
|
103
|
-
/**
|
|
104
|
-
* Get all registered check names.
|
|
105
|
-
*/
|
|
106
|
-
getCheckNames(): string[];
|
|
107
|
-
/**
|
|
108
|
-
* Run all health checks.
|
|
109
|
-
*/
|
|
110
|
-
check(): Promise<HealthReport>;
|
|
111
|
-
/**
|
|
112
|
-
* Run specific health checks.
|
|
113
|
-
*/
|
|
114
|
-
checkOnly(names: string[]): Promise<HealthReport>;
|
|
115
|
-
/**
|
|
116
|
-
* Get a specific check result.
|
|
117
|
-
*/
|
|
118
|
-
getCheck(name: string): Promise<CheckResult | null>;
|
|
119
|
-
/**
|
|
120
|
-
* Create middleware for health endpoints.
|
|
121
|
-
*/
|
|
122
|
-
middleware(options?: HealthMiddlewareOptions): Middleware;
|
|
123
|
-
/**
|
|
124
|
-
* Run the specified checks.
|
|
125
|
-
*/
|
|
126
|
-
private runChecks;
|
|
127
|
-
/**
|
|
128
|
-
* Run a single check with timeout.
|
|
129
|
-
*/
|
|
130
|
-
private runCheck;
|
|
131
|
-
/**
|
|
132
|
-
* Create a timeout promise.
|
|
133
|
-
*/
|
|
134
|
-
private timeoutPromise;
|
|
135
|
-
}
|
|
136
|
-
/**
|
|
137
|
-
* Create a health manager.
|
|
138
|
-
*/
|
|
139
|
-
declare function createHealthManager(): HealthManager;
|
|
140
|
-
|
|
141
|
-
export { type CheckResult as C, HealthManager as H, HealthCheck as a, type HealthCheckOptions as b, type HealthMiddlewareOptions as c, type HealthReport as d, type HealthStatus as e, createHealthManager as f };
|