@velajs/vela 0.4.0 → 0.4.1

package/dist/health/health.http.d.ts

@@ -0,0 +1,14 @@
+import { HealthIndicatorService } from './health.indicator';
+import type { HealthIndicatorResult, ResponseCheckCallback } from './health.types';
+export interface HttpPingOptions {
+    method?: string;
+    headers?: Record<string, string>;
+    timeout?: number;
+    expectedStatus?: number;
+}
+export declare class HttpHealthIndicator {
+    private indicator;
+    constructor(indicator: HealthIndicatorService);
+    pingCheck(key: string, url: string, options?: HttpPingOptions): Promise<HealthIndicatorResult>;
+    responseCheck(key: string, url: string, callback: ResponseCheckCallback, options?: HttpPingOptions): Promise<HealthIndicatorResult>;
+}

package/dist/health/health.http.js

@@ -0,0 +1,75 @@
+function _ts_decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+function _ts_metadata(k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+import { Injectable } from "../container/index.js";
+import { HealthIndicatorService } from "./health.indicator.js";
+export class HttpHealthIndicator {
+    indicator;
+    constructor(indicator){
+        this.indicator = indicator;
+    }
+    async pingCheck(key, url, options) {
+        const { method = 'GET', headers, timeout = 5000, expectedStatus } = options ?? {};
+        try {
+            const response = await fetch(url, {
+                method,
+                headers,
+                signal: AbortSignal.timeout(timeout)
+            });
+            const statusCode = response.status;
+            const isHealthy = expectedStatus !== undefined ? statusCode === expectedStatus : statusCode >= 200 && statusCode < 300;
+            if (isHealthy) {
+                return this.indicator.check(key).up({
+                    statusCode
+                });
+            }
+            return this.indicator.check(key).down({
+                statusCode,
+                message: response.statusText
+            });
+        } catch (error) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            return this.indicator.check(key).down({
+                message
+            });
+        }
+    }
+    async responseCheck(key, url, callback, options) {
+        const { method = 'GET', headers, timeout = 5000 } = options ?? {};
+        try {
+            const response = await fetch(url, {
+                method,
+                headers,
+                signal: AbortSignal.timeout(timeout)
+            });
+            const statusCode = response.status;
+            const isHealthy = await callback(response);
+            if (isHealthy) {
+                return this.indicator.check(key).up({
+                    statusCode
+                });
+            }
+            return this.indicator.check(key).down({
+                statusCode
+            });
+        } catch (error) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            return this.indicator.check(key).down({
+                message
+            });
+        }
+    }
+}
+HttpHealthIndicator = _ts_decorate([
+    Injectable(),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof HealthIndicatorService === "undefined" ? Object : HealthIndicatorService
+    ])
+], HttpHealthIndicator);

package/dist/health/health.indicator.d.ts

@@ -0,0 +1,9 @@
+import type { HealthIndicatorResult } from './health.types';
+interface HealthIndicatorBuilder {
+    up(data?: Record<string, unknown>): HealthIndicatorResult;
+    down(data?: Record<string, unknown>): HealthIndicatorResult;
+}
+export declare class HealthIndicatorService {
+    check(key: string): HealthIndicatorBuilder;
+}
+export {};

package/dist/health/health.indicator.js

@@ -0,0 +1,32 @@
+function _ts_decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+import { Injectable } from "../container/index.js";
+export class HealthIndicatorService {
+    check(key) {
+        return {
+            up (data) {
+                return {
+                    [key]: {
+                        status: 'up',
+                        ...data
+                    }
+                };
+            },
+            down (data) {
+                return {
+                    [key]: {
+                        status: 'down',
+                        ...data
+                    }
+                };
+            }
+        };
+    }
+}
+HealthIndicatorService = _ts_decorate([
+    Injectable()
+], HealthIndicatorService);

package/dist/health/health.module.d.ts

@@ -0,0 +1,2 @@
+export declare class HealthModule {
+}

package/dist/health/health.module.js

@@ -0,0 +1,26 @@
+function _ts_decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+import { Module } from "../module/index.js";
+import { HealthCheckService } from "./health.service.js";
+import { HealthIndicatorService } from "./health.indicator.js";
+import { HttpHealthIndicator } from "./health.http.js";
+export class HealthModule {
+}
+HealthModule = _ts_decorate([
+    Module({
+        providers: [
+            HealthCheckService,
+            HealthIndicatorService,
+            HttpHealthIndicator
+        ],
+        exports: [
+            HealthCheckService,
+            HealthIndicatorService,
+            HttpHealthIndicator
+        ]
+    })
+], HealthModule);

package/dist/health/health.service.d.ts

@@ -0,0 +1,7 @@
+import type { BeforeApplicationShutdown } from '../lifecycle/index';
+import type { HealthCheckResult, HealthIndicatorFunction } from './health.types';
+export declare class HealthCheckService implements BeforeApplicationShutdown {
+    private isShuttingDown;
+    beforeApplicationShutdown(): void;
+    check(indicators: HealthIndicatorFunction[]): Promise<HealthCheckResult>;
+}

package/dist/health/health.service.js

@@ -0,0 +1,65 @@
+function _ts_decorate(decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+import { Injectable } from "../container/index.js";
+import { ServiceUnavailableException } from "../errors/http-exception.js";
+export class HealthCheckService {
+    isShuttingDown = false;
+    beforeApplicationShutdown() {
+        this.isShuttingDown = true;
+    }
+    async check(indicators) {
+        if (this.isShuttingDown) {
+            const result = {
+                status: 'shutting_down',
+                info: {},
+                error: {},
+                details: {}
+            };
+            throw new ServiceUnavailableException('Service Unavailable', result);
+        }
+        const results = await Promise.allSettled(indicators.map((fn)=>fn()));
+        const info = {};
+        const error = {};
+        const details = {};
+        for (const result of results){
+            if (result.status === 'fulfilled') {
+                const indicatorResult = result.value;
+                for (const [key, value] of Object.entries(indicatorResult)){
+                    details[key] = value;
+                    if (value.status === 'up') {
+                        info[key] = value;
+                    } else {
+                        error[key] = value;
+                    }
+                }
+            } else {
+                const message = result.reason instanceof Error ? result.reason.message : 'Health check failed';
+                const key = 'unknown';
+                const value = {
+                    status: 'down',
+                    message
+                };
+                details[key] = value;
+                error[key] = value;
+            }
+        }
+        const status = Object.keys(error).length > 0 ? 'error' : 'ok';
+        const checkResult = {
+            status,
+            info,
+            error,
+            details
+        };
+        if (status === 'error') {
+            throw new ServiceUnavailableException('Service Unavailable', checkResult);
+        }
+        return checkResult;
+    }
+}
+HealthCheckService = _ts_decorate([
+    Injectable()
+], HealthCheckService);

package/dist/health/health.types.d.ts

@@ -0,0 +1,15 @@
+export type HealthCheckStatus = 'ok' | 'error' | 'shutting_down';
+export interface HealthIndicatorResult {
+    [key: string]: {
+        status: 'up' | 'down';
+        [key: string]: unknown;
+    };
+}
+export interface HealthCheckResult {
+    status: HealthCheckStatus;
+    info: HealthIndicatorResult;
+    error: HealthIndicatorResult;
+    details: HealthIndicatorResult;
+}
+export type HealthIndicatorFunction = () => Promise<HealthIndicatorResult>;
+export type ResponseCheckCallback = (response: Response) => boolean | Promise<boolean>;

package/dist/health/health.types.js

@@ -0,0 +1 @@
+export { };

package/dist/health/index.d.ts

@@ -0,0 +1,6 @@
+export { HealthModule } from './health.module';
+export { HealthCheckService } from './health.service';
+export { HealthIndicatorService } from './health.indicator';
+export { HttpHealthIndicator } from './health.http';
+export type { HealthCheckResult, HealthCheckStatus, HealthIndicatorResult, HealthIndicatorFunction, ResponseCheckCallback, } from './health.types';
+export type { HttpPingOptions } from './health.http';

package/dist/health/index.js

@@ -0,0 +1,4 @@
+export { HealthModule } from "./health.module.js";
+export { HealthCheckService } from "./health.service.js";
+export { HealthIndicatorService } from "./health.indicator.js";
+export { HttpHealthIndicator } from "./health.http.js";

package/dist/index.d.ts

@@ -18,6 +18,8 @@ export { EventEmitterModule, EventEmitter, EventEmitterSubscriber, OnEvent, ON_E
 export type { EventHandler, OnEventMetadata } from './event-emitter/index';
 export { ScheduleModule, ScheduleRegistry, ScheduleExecutor, Cron, Interval, SCHEDULE_MODULE_OPTIONS, CRON_METADATA, INTERVAL_METADATA, } from './schedule/index';
 export type { RegisteredCronJob, RegisteredIntervalJob, CronMetadata, IntervalMetadata, ScheduleModuleOptions, } from './schedule/index';
+export { HealthModule, HealthCheckService, HealthIndicatorService, HttpHealthIndicator, } from './health/index';
+export type { HealthCheckResult, HealthCheckStatus, HealthIndicatorResult, HealthIndicatorFunction, ResponseCheckCallback, HttpPingOptions, } from './health/index';
 export { ThrottlerModule, ThrottlerGuard, ThrottlerStorage, Throttle, SkipThrottle, THROTTLER_OPTIONS, THROTTLER_STORAGE, THROTTLE_METADATA, SKIP_THROTTLE_METADATA, } from './throttler/index';
 export type { ThrottlerModuleOptions, ThrottleConfig, ThrottlerStore, ThrottlerStorageRecord, RateLimitInfo, } from './throttler/index';
 export { Module } from './module/index';

package/dist/index.js

@@ -21,6 +21,8 @@ export { CacheModule, CacheService, CacheInterceptor, MemoryCacheStore, CacheKey
 export { EventEmitterModule, EventEmitter, EventEmitterSubscriber, OnEvent, ON_EVENT_METADATA } from "./event-emitter/index.js";
 // Schedule
 export { ScheduleModule, ScheduleRegistry, ScheduleExecutor, Cron, Interval, SCHEDULE_MODULE_OPTIONS, CRON_METADATA, INTERVAL_METADATA } from "./schedule/index.js";
+// Health
+export { HealthModule, HealthCheckService, HealthIndicatorService, HttpHealthIndicator } from "./health/index.js";
 // Throttler
 export { ThrottlerModule, ThrottlerGuard, ThrottlerStorage, Throttle, SkipThrottle, THROTTLER_OPTIONS, THROTTLER_STORAGE, THROTTLE_METADATA, SKIP_THROTTLE_METADATA } from "./throttler/index.js";
 // Module

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velajs/vela",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "NestJS-compatible framework for edge runtimes, powered by Hono",
   "type": "module",
   "main": "./dist/index.js",