@alacard-project/shared 1.1.0 → 1.1.2

package/src/errors/error-map.ts

@@ -1,105 +0,0 @@
-import { ErrorCode } from '../enums/error.enum';
-
-export interface ErrorDetail {
-    message: string;
-    statusCode: number;
-    description?: string;
-}
-
-export const ERROR_MAP: Record<ErrorCode, ErrorDetail> = {
-    [ErrorCode.AUTH_USER_NOT_FOUND]: {
-        message: 'User not found',
-        statusCode: 404,
-        description: 'The requested user could not be found in the system.',
-    },
-    [ErrorCode.AUTH_USER_ALREADY_EXISTS]: {
-        message: 'User already exists',
-        statusCode: 409,
-        description: 'A user with this email already exists.',
-    },
-    [ErrorCode.AUTH_USER_INACTIVE]: {
-        message: 'User is inactive',
-        statusCode: 403,
-        description: 'The user account is currently deactivated.',
-    },
-    [ErrorCode.AUTH_INVALID_PASSWORD]: {
-        message: 'Invalid password',
-        statusCode: 401,
-        description: 'The provided password does not match.',
-    },
-    [ErrorCode.AUTH_INVALID_TOKEN]: {
-        message: 'Invalid token',
-        statusCode: 401,
-        description: 'The provided authentication token is invalid or malformed.',
-    },
-    [ErrorCode.AUTH_TOKEN_EXPIRED]: {
-        message: 'Token expired',
-        statusCode: 401,
-        description: 'The authentication token has expired. Please log in again.',
-    },
-    [ErrorCode.AUTH_ACCESS_DENIED]: {
-        message: 'Access denied',
-        statusCode: 403,
-        description: 'You do not have permission to perform this action.',
-    },
-    [ErrorCode.AUTH_INSUFFICIENT_SCOPES]: {
-        message: 'Insufficient scopes',
-        statusCode: 403,
-        description: 'Your token does not have the required scopes for this resource.',
-    },
-    [ErrorCode.AUTH_INVALID_CREDENTIALS]: {
-        message: 'Invalid credentials',
-        statusCode: 401,
-        description: 'The email or password you entered is incorrect.',
-    },
-    [ErrorCode.CONFIG_NOT_FOUND]: {
-        message: 'Configuration not found',
-        statusCode: 404,
-        description: 'The requested configuration key was not found.',
-    },
-    [ErrorCode.CONFIG_LOAD_FAILED]: {
-        message: 'Configuration load failed',
-        statusCode: 500,
-        description: 'Failed to load configuration from the source.',
-    },
-    [ErrorCode.LOG_WRITE_FAILED]: {
-        message: 'Log write failed',
-        statusCode: 500,
-        description: 'Failed to write log to the destination.',
-    },
-    [ErrorCode.LOG_READ_FAILED]: {
-        message: 'Log read failed',
-        statusCode: 500,
-        description: 'Failed to read logs from the source.',
-    },
-    [ErrorCode.INTERNAL_SERVER_ERROR]: {
-        message: 'Internal server error',
-        statusCode: 500,
-        description: 'An unexpected error occurred on the server.',
-    },
-    [ErrorCode.BAD_REQUEST]: {
-        message: 'Bad request',
-        statusCode: 400,
-        description: 'The request is invalid or cannot be served.',
-    },
-    [ErrorCode.NOT_FOUND]: {
-        message: 'Resource not found',
-        statusCode: 404,
-        description: 'The requested resource could not be found.',
-    },
-    [ErrorCode.VALIDATION_ERROR]: {
-        message: 'Validation error',
-        statusCode: 422,
-        description: 'The provided data failed validation.',
-    },
-    [ErrorCode.AUTH_USER_BLOCKED]: {
-        message: 'User blocked',
-        statusCode: 403,
-        description: 'The user account has been blocked.',
-    },
-    [ErrorCode.INVALID_TOKEN]: {
-        message: 'Invalid token',
-        statusCode: 401,
-        description: 'The provided token is invalid.',
-    },
-};

package/src/filters/http-exception.filter.ts

@@ -1,49 +0,0 @@
-
-import { ExceptionFilter, Catch, ArgumentsHost, HttpException, HttpStatus, Logger } from '@nestjs/common';
-import { Request, Response } from 'express';
-
-@Catch()
-export class HttpExceptionFilter implements ExceptionFilter {
-    private readonly logger = new Logger(HttpExceptionFilter.name);
-
-    catch(exception: unknown, host: ArgumentsHost) {
-        const ctx = host.switchToHttp();
-        const response = ctx.getResponse<Response>();
-        const request = ctx.getRequest<Request>();
-
-        const status =
-            exception instanceof HttpException
-                ? exception.getStatus()
-                : HttpStatus.INTERNAL_SERVER_ERROR;
-
-        const message =
-            exception instanceof HttpException
-                ? exception.getResponse()
-                : 'Internal server error';
-
-        // Determine the actual error message string
-        const errorMessage = typeof message === 'string'
-            ? message
-            : (message as any).message || message;
-
-        // Log the error
-        if (status >= 500) {
-            this.logger.error(
-                `[${request.method}] ${request.url} - ${status} - ${JSON.stringify(errorMessage)}`,
-                exception instanceof Error ? exception.stack : '',
-            );
-        } else {
-            this.logger.warn(
-                `[${request.method}] ${request.url} - ${status} - ${JSON.stringify(errorMessage)}`,
-            );
-        }
-
-        response.status(status).json({
-            statusCode: status,
-            timestamp: new Date().toISOString(),
-            path: request.url,
-            method: request.method,
-            error: errorMessage,
-        });
-    }
-}

package/src/filters/index.ts

@@ -1,2 +0,0 @@
-
-export * from './http-exception.filter';

package/src/index.ts

@@ -1,17 +0,0 @@
-export * from './enums';
-export * from './constants';
-export * from './types';
-export * from './contracts';
-export * from './dto';
-export * from './errors/app.error';
-export * from './errors/error-map';
-export * from './decorators';
-export * from './utils/proto-path';
-export * from './utils/user.utils';
-export * from './utils/app.utils';
-export * from './utils/health.utils';
-export * from './filters';
-export * from './interceptors';
-export * from './observability';
-export * from './resilience/resilience.module';
-export * from './resilience/circuit-breaker.service';

package/src/interceptors/index.ts

@@ -1,3 +0,0 @@
-
-export * from './logging.interceptor';
-export * from './transform.interceptor';

package/src/interceptors/logging.interceptor.ts

@@ -1,37 +0,0 @@
-
-import { Injectable, NestInterceptor, ExecutionContext, CallHandler, Logger } from '@nestjs/common';
-import { Observable } from 'rxjs';
-import { tap } from 'rxjs/operators';
-import { randomUUID } from 'crypto';
-import { Request, Response } from 'express';
-
-@Injectable()
-export class LoggingInterceptor implements NestInterceptor {
-    private readonly logger = new Logger(LoggingInterceptor.name);
-
-    intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
-        const httpContext = context.switchToHttp();
-        const request = httpContext.getRequest<Request>();
-        const response = httpContext.getResponse<Response>();
-
-        const userAgent = request.get('user-agent') || '';
-        const { ip, method, path: url } = request;
-
-        // Generate or retrieve Trace ID
-        const traceId = request.headers['x-request-id'] || randomUUID();
-        request.headers['x-request-id'] = traceId as string;
-        response.setHeader('x-request-id', traceId);
-
-        this.logger.log(`[${traceId}] Incoming Request: ${method} ${url} - ${userAgent} ${ip}`);
-
-        const now = Date.now();
-        return next
-            .handle()
-            .pipe(
-                tap(() => {
-                    const duration = Date.now() - now;
-                    this.logger.log(`[${traceId}] Response Sent: ${method} ${url} ${response.statusCode} - ${duration}ms`);
-                }),
-            );
-    }
-}

package/src/interceptors/transform.interceptor.ts

@@ -1,21 +0,0 @@
-
-import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
-import { Observable } from 'rxjs';
-import { map } from 'rxjs/operators';
-
-export interface Response<T> {
-    statusCode: number;
-    data: T;
-}
-
-@Injectable()
-export class TransformInterceptor<T> implements NestInterceptor<T, Response<T>> {
-    intercept(context: ExecutionContext, next: CallHandler): Observable<Response<T>> {
-        return next.handle().pipe(
-            map(data => ({
-                statusCode: context.switchToHttp().getResponse().statusCode,
-                data,
-            })),
-        );
-    }
-}

package/src/observability/index.ts

@@ -1,3 +0,0 @@
-
-export * from './metrics/metrics.module';
-export * from './tracing';

package/src/observability/metrics/metrics.module.ts

@@ -1,16 +0,0 @@
-
-import { Module } from '@nestjs/common';
-import { PrometheusModule } from '@willsoto/nestjs-prometheus';
-
-@Module({
-    imports: [
-        PrometheusModule.register({
-            path: '/metrics',
-            defaultMetrics: {
-                enabled: true,
-            },
-        }),
-    ],
-    exports: [PrometheusModule],
-})
-export class MetricsModule { }

package/src/observability/tracing.ts

@@ -1,33 +0,0 @@
-import { NodeSDK } from '@opentelemetry/sdk-node';
-import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
-import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
-import { Logger } from '@nestjs/common';
-
-const logger = new Logger('Tracing');
-
-export function initTracing(serviceName: string) {
-    const otelExporterOtlpEndpoint = process.env.OTEL_EXPORTER_OTLP_ENDPOINT || 'http://jaeger:4318/v1/traces';
-
-    const traceExporter = new OTLPTraceExporter({
-        url: otelExporterOtlpEndpoint,
-    });
-
-    // Set service name via env var so auto-detection picks it up
-    process.env.OTEL_SERVICE_NAME = serviceName;
-
-    const sdk = new NodeSDK({
-        traceExporter,
-        instrumentations: [getNodeAutoInstrumentations()],
-    });
-
-    sdk.start();
-
-    logger.log(`Initialized tracing for ${serviceName} sending to ${otelExporterOtlpEndpoint}`);
-
-    process.on('SIGTERM', () => {
-        sdk.shutdown()
-            .then(() => console.log('Tracing terminated'))
-            .catch((error) => console.log('Error terminating tracing', error))
-            .finally(() => process.exit(0));
-    });
-}

package/src/resilience/circuit-breaker.service.ts

@@ -1,46 +0,0 @@
-import { Injectable, Logger } from '@nestjs/common';
-import CircuitBreaker = require('opossum');
-
-@Injectable()
-export class CircuitBreakerService {
-    private readonly logger = new Logger(CircuitBreakerService.name);
-    private readonly breakers = new Map<string, CircuitBreaker>();
-
-    /**
-     * Execute an async action through a circuit breaker.
-     * @param key Unique key for the breaker (e.g., service URL)
-     * @param action The async action to execute
-     * @param options Circuit Breaker options
-     */
-    async execute<T>(
-        key: string,
-        action: () => Promise<T>,
-        options?: CircuitBreaker.Options
-    ): Promise<T> {
-        let breaker = this.breakers.get(key);
-
-        if (!breaker) {
-            const defaultOptions: CircuitBreaker.Options = {
-                timeout: 5000,
-                errorThresholdPercentage: 50,
-                resetTimeout: 10000,
-                ...options,
-            };
-
-            // Wrap a pass-through function to allow dynamic actions
-            const passThrough = async (promiseFactory: () => Promise<T>) => promiseFactory();
-            breaker = new CircuitBreaker(passThrough, defaultOptions);
-            this.bindEvents(breaker, key);
-            this.breakers.set(key, breaker);
-        }
-
-        return breaker.fire(action) as Promise<T>;
-    }
-
-    private bindEvents(breaker: CircuitBreaker, key: string) {
-        breaker.on('open', () => this.logger.warn(`Circuit Breaker OPEN for ${key}`));
-        breaker.on('halfOpen', () => this.logger.log(`Circuit Breaker HALF-OPEN for ${key}`));
-        breaker.on('close', () => this.logger.log(`Circuit Breaker CLOSED for ${key}`));
-        breaker.on('fallback', () => this.logger.warn(`Circuit Breaker FALLBACK for ${key}`));
-    }
-}

package/src/resilience/resilience.module.ts

@@ -1,9 +0,0 @@
-import { Module, Global } from '@nestjs/common';
-import { CircuitBreakerService } from './circuit-breaker.service';
-
-@Global()
-@Module({
-    providers: [CircuitBreakerService],
-    exports: [CircuitBreakerService],
-})
-export class ResilienceModule { }

package/src/types/auth.types.ts

@@ -1,38 +0,0 @@
-import { JsonObject, JsonValue } from './common.types';
-import { SubjectType } from '../enums/iam.enum';
-export interface JwtPayload extends JsonObject {
-    sub: string;
-    email?: string;
-    role: string;
-    subjectType: SubjectType;
-    scopes: string[];
-    iat?: number;
-    exp?: number;
-    iss?: string;
-}
-export interface JwtTokens {
-    accessToken: string;
-    refreshToken: string;
-    expiresIn: number;
-}
-
-export interface AuthenticatedRequest {
-    user: JwtPayload;
-    [key: string]: JsonValue;
-}
-export interface ValidateServiceTokenResponse {
-    isValid: boolean;
-    identityId?: string;
-    tokenId?: string;
-}
-
-export interface Session {
-    sessionId: string;
-    identityId: string;
-    ipAddress?: string;
-    userAgent?: string;
-    deviceInfo?: string;
-    createdAt: Date;
-    expiresAt: Date;
-    isRevoked?: boolean;
-}

package/src/types/common.types.ts

@@ -1,18 +0,0 @@
-export type JsonPrimitive = string | number | boolean | null | undefined;
-
-export interface JsonObject {
-    [key: string]: JsonValue;
-}
-
-export interface JsonArray extends Array<JsonValue> { }
-
-export type JsonValue =
-    | JsonPrimitive
-    | JsonObject
-    | JsonArray;
-
-export interface Metadata {
-    [key: string]: JsonValue;
-}
-
-export type MetricType = 'counter' | 'gauge' | 'histogram' | 'summary';

package/src/types/config.types.ts

@@ -1,32 +0,0 @@
-import { Environment } from '../enums/env.enum';
-
-export interface IBaseConfig {
-    environment: Environment;
-}
-
-export interface DbConfig {
-    url: string;
-    poolSize?: number;
-}
-
-export interface RedisConfig {
-    host: string;
-    port: number;
-    password?: string;
-}
-
-export interface BrokerConfig {
-    brokers: string[];
-}
-
-export interface AppConfig {
-    port: number;
-    host?: string;
-    serviceName: string;
-    environment?: Environment;
-    version?: string;
-    description?: string;
-    databaseUrl?: string;
-    rabbitMqUrl?: string;
-    [key: string]: any;
-}

package/src/types/iam.types.ts

@@ -1,78 +0,0 @@
-import { SubjectType, IdentityStatus, UserRole, IdentifierType } from '../enums';
-import { JsonValue } from './common.types';
-
-/**
- * Identity
- * Core identity model for IAM service
- */
-export interface Identity {
-    identityId: string;
-    subjectType: SubjectType;
-    role: UserRole;
-    status: IdentityStatus;
-    createdAt?: Date;
-    updatedAt?: Date;
-}
-
-/**
- * Identity Attributes
- * ABAC attributes for fine-grained access control
- */
-export interface IdentityAttributes {
-    department?: string;
-    companyId?: string;
-    permissions: string[];
-    metadata?: Record<string, JsonValue>;
-}
-
-/**
- * Policy Check Request
- * Request structure for policy engine checks
- */
-export interface PolicyCheckRequest {
-    identityId: string;
-    resource: string;
-    action: string;
-    context?: Record<string, JsonValue>;
-}
-
-/**
- * Policy Check Response
- */
-export interface PolicyCheckResponse {
-    allowed: boolean;
-    reason?: string;
-}
-
-/**
- * Ownership Check Request
- */
-export interface OwnershipCheckRequest {
-    identityId: string;
-    resourceId: string;
-    resourceType: string;
-}
-
-/**
- * Scope Check Request
- */
-export interface ScopeCheckRequest {
-    identityId: string;
-    scope: string;
-    context?: Record<string, JsonValue>;
-}
-
-/**
- * Credential Model
- * Authentication credential structure
- */
-export interface Credential {
-    id: string;
-    identityId: string;
-    identifierType: IdentifierType;
-    identifierValue: string;
-    passwordHash: string;
-    status: string;
-    createdAt?: Date;
-    updatedAt?: Date;
-}

package/src/types/index.ts

@@ -1,6 +0,0 @@
-export * from './config.types';
-export * from './auth.types';
-export * from './iam.types';
-export * from './user.types';
-export * from './common.types';
-export * from './monitoring.types';

package/src/types/monitoring.types.ts

@@ -1,77 +0,0 @@
-import { MetricType } from './common.types';
-
-export interface PrometheusMetric {
-    name: string;
-    help: string;
-    type: MetricType;
-    labelNames?: string[];
-}
-
-export interface MetricValue {
-    value: number;
-    labels?: Record<string, string>;
-    timestamp?: number;
-}
-
-export interface ServiceMetrics {
-    serviceName: string;
-    timestamp: Date;
-    metrics: {
-        // HTTP Metrics
-        httpRequestsTotal?: number;
-        httpRequestDuration?: number;
-        httpErrorsTotal?: number;
-
-        // Database Metrics
-        dbConnectionsActive?: number;
-        dbConnectionsIdle?: number;
-        dbQueryDuration?: number;
-        dbQueriesTotal?: number;
-
-        // System Metrics
-        cpuUsage?: number;
-        memoryUsage?: number;
-        heapUsed?: number;
-        heapTotal?: number;
-
-        // Application Metrics
-        activeUsers?: number;
-        requestsPerSecond?: number;
-        errorRate?: number;
-
-        // Custom Metrics
-        [key: string]: number | undefined;
-    };
-}
-
-export interface HealthCheckResult {
-    status: 'healthy' | 'unhealthy' | 'degraded';
-    checks: {
-        [component: string]: {
-            status: 'up' | 'down';
-            message?: string;
-            responseTime?: number;
-        };
-    };
-    timestamp: Date;
-}
-
-export interface GrafanaDashboard {
-    id: string;
-    title: string;
-    panels: GrafanaPanel[];
-    tags: string[];
-}
-
-export interface GrafanaPanel {
-    id: number;
-    title: string;
-    type: 'graph' | 'singlestat' | 'table' | 'heatmap';
-    targets: GrafanaTarget[];
-}
-
-export interface GrafanaTarget {
-    expr: string; // Prometheus query
-    legendFormat?: string;
-    refId: string;
-}

package/src/types/user.types.ts

@@ -1,11 +0,0 @@
-import { Observable } from 'rxjs';
-import { UserResponse } from '../dto/auth.dto';
-import { GetUserByIdGrpcRequest, GetUserByEmailGrpcRequest } from '../contracts/auth.contract';
-
-export interface IUserService {
-    getUserById(data: GetUserByIdGrpcRequest): Observable<UserResponse>;
-    getUserByEmail(data: GetUserByEmailGrpcRequest): Observable<UserResponse>;
-    createUser(data: unknown): Observable<UserResponse>;
-    updateUser(data: unknown): Observable<UserResponse>;
-    deleteUser(data: { id: string }): Observable<{ success: boolean }>;
-}

package/src/utils/app.utils.ts

@@ -1,52 +0,0 @@
-import { INestApplication, ValidationPipe } from '@nestjs/common';
-import { API_PREFIX } from '../constants/http.constants';
-import helmet from 'helmet';
-
-export interface AppSetupOptions {
-    corsOrigins?: string[];
-    apiPrefix?: string;
-    helmet?: boolean;
-    validation?: boolean;
-    shutdownHooks?: boolean;
-}
-
-export function setupStandardApp(
-    app: INestApplication,
-    options: AppSetupOptions = {}
-): void {
-    const {
-        corsOrigins = ['*'],
-        apiPrefix = API_PREFIX.V1,
-        helmet: useHelmet = true,
-        validation = true,
-        shutdownHooks = true,
-    } = options;
-
-    if (shutdownHooks) {
-        app.enableShutdownHooks();
-    }
-
-    app.enableCors({
-        origin: corsOrigins,
-        credentials: true,
-    });
-
-    app.setGlobalPrefix(apiPrefix);
-
-    if (useHelmet) {
-        app.use(helmet());
-    }
-
-    if (validation) {
-        app.useGlobalPipes(
-            new ValidationPipe({
-                whitelist: true,
-                forbidNonWhitelisted: true,
-                transform: true,
-                transformOptions: {
-                    enableImplicitConversion: true,
-                },
-            })
-        );
-    }
-}