@alacard-project/shared 1.1.1 → 1.1.4

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,
-                },
-            })
-        );
-    }
-}

package/src/utils/health.utils.ts

@@ -1,24 +0,0 @@
-import { JsonValue } from '../types/common.types';
-
-export type HealthCheckStatus = 'up' | 'down';
-
-export interface ComponentHealth {
-    status: HealthCheckStatus;
-    [key: string]: JsonValue;
-}
-
-export interface PrismaLike {
-    $queryRaw: (query: TemplateStringsArray, ...values: unknown[]) => Promise<unknown>;
-}
-
-export const createPrismaHealthCheck = (prisma: PrismaLike) => {
-    return async (): Promise<ComponentHealth> => {
-        try {
-            await prisma.$queryRaw`SELECT 1`;
-            return { status: 'up' };
-        } catch (e: unknown) {
-            const message = e instanceof Error ? e.message : 'Unknown error';
-            return { status: 'down', error: message };
-        }
-    };
-};

package/src/utils/proto-path.ts

@@ -1,21 +0,0 @@
-import { join } from 'path';
-
-export function getProtoPath(serviceName: string): string {
-    // Priority 1: Environment variable override
-    if (process.env.PROTO_PATH_OVERRIDE) {
-        return join(process.env.PROTO_PATH_OVERRIDE, `${serviceName}.proto`);
-    }
-
-    // Priority 2: Well-known Docker location (even in development mode if running in container)
-    // We detect container by checking if we are on Linux and /app directory exists
-    // but a simpler check is often just looking for common Docker env vars or assuming /app/proto
-    const dockerProtoPath = '/app/proto';
-
-    // In our specific Docker stack, we ALWAYS want this path if it's likely we are in Docker
-    if (process.platform === 'linux' || process.env.NODE_ENV === 'production' || process.env.KUBERNETES_SERVICE_HOST) {
-        return join(dockerProtoPath, `${serviceName}.proto`);
-    }
-
-    // Priority 3: Default path relative to the current working directory (local development)
-    return join(process.cwd(), 'proto', `${serviceName}.proto`);
-}

package/src/utils/user.utils.ts

@@ -1,3 +0,0 @@
-export function generateFullName(firstName?: string, lastName?: string, middleName?: string): string {
-    return [lastName, firstName, middleName].filter(Boolean).join(' ').trim();
-}

package/tsconfig.json

@@ -1,28 +0,0 @@
-{
-    "compilerOptions": {
-        "module": "commonjs",
-        "declaration": true,
-        "removeComments": true,
-        "emitDecoratorMetadata": true,
-        "experimentalDecorators": true,
-        "allowSyntheticDefaultImports": true,
-        "target": "es2021",
-        "sourceMap": true,
-        "outDir": "./dist",
-        "baseUrl": "./src",
-        "incremental": true,
-        "skipLibCheck": true,
-        "strict": true,
-        "noImplicitAny": true,
-        "strictNullChecks": true,
-        "strictPropertyInitialization": false,
-        "forceConsistentCasingInFileNames": true
-    },
-    "include": [
-        "src/**/*"
-    ],
-    "exclude": [
-        "node_modules",
-        "dist"
-    ]
-}