@alacard-project/shared 1.1.4 → 1.1.6

package/dist/utils/app.utils.d.ts

@@ -1,13 +1,18 @@
 import { INestApplication } from '@nestjs/common';
-import { IRemoteLogger } from '../types/logger.interface';
 export interface AppSetupOptions {
-    corsOrigins?: string[];
+    corsOrigins?: string | string[];
     apiPrefix?: string;
     helmet?: boolean;
     validation?: boolean;
     shutdownHooks?: boolean;
     enableTelemetry?: boolean;
-    remoteLogger?: IRemoteLogger;
+    remoteLogger?: any;
     logger?: any;
+    swagger?: {
+        title: string;
+        description: string;
+        version: string;
+        path?: string;
+    };
 }
 export declare function setupStandardApp(app: INestApplication, options?: AppSetupOptions): void;

package/dist/utils/app.utils.js

@@ -5,8 +5,9 @@ const common_1 = require("@nestjs/common");
 const http_constants_1 = require("../constants/http.constants");
 const helmet_1 = require("helmet");
 const filters_1 = require("../filters");
+const swagger_1 = require("@nestjs/swagger");
 function setupStandardApp(app, options = {}) {
-    const { corsOrigins = ['*'], apiPrefix = http_constants_1.API_PREFIX.V1, helmet: useHelmet = true, validation = true, shutdownHooks = true, enableTelemetry = true, remoteLogger, logger, } = options;
+    const { corsOrigins = ['*'], apiPrefix = http_constants_1.API_PREFIX.V1, helmet: useHelmet = true, validation = true, shutdownHooks = true, enableTelemetry = true, remoteLogger, logger, swagger, } = options;
     if (logger) {
         app.useLogger(logger);
     }
@@ -17,7 +18,9 @@ function setupStandardApp(app, options = {}) {
         origin: corsOrigins,
         credentials: true,
     });
-    app.setGlobalPrefix(apiPrefix);
+    app.setGlobalPrefix(apiPrefix, {
+        exclude: ['metrics', 'health/live', 'health/ready', 'health/info'],
+    });
     if (useHelmet) {
         app.use((0, helmet_1.default)());
     }
@@ -34,5 +37,19 @@ function setupStandardApp(app, options = {}) {
     if (enableTelemetry) {
         app.useGlobalFilters(new filters_1.GlobalExceptionFilter(remoteLogger));
     }
+    if (process.env.NODE_ENV !== 'production' || swagger) {
+        const title = swagger?.title || 'Alacard Microservice API';
+        const description = swagger?.description || 'Alacard v5 Monorepo Service';
+        const version = swagger?.version || '1.0.0';
+        const path = swagger?.path || 'docs';
+        const config = new swagger_1.DocumentBuilder()
+            .setTitle(title)
+            .setDescription(description)
+            .setVersion(version)
+            .addBearerAuth()
+            .build();
+        const document = swagger_1.SwaggerModule.createDocument(app, config);
+        swagger_1.SwaggerModule.setup(path, app, document);
+    }
 }
 //# sourceMappingURL=app.utils.js.map

package/dist/utils/app.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.utils.js","sourceRoot":"","sources":["../../src/utils/app.utils.ts"],"names":[],"mappings":";;AAiBA,4CAmDC;AApED,2CAAkE;AAClE,gEAAyD;AACzD,mCAA4B;AAC5B,wCAAmD;AAcnD,SAAgB,gBAAgB,CAC5B,GAAqB,EACrB,UAA2B,EAAE;IAE7B,MAAM,EACF,WAAW,GAAG,CAAC,GAAG,CAAC,EACnB,SAAS,GAAG,2BAAU,CAAC,EAAE,EACzB,MAAM,EAAE,SAAS,GAAG,IAAI,EACxB,UAAU,GAAG,IAAI,EACjB,aAAa,GAAG,IAAI,EACpB,eAAe,GAAG,IAAI,EACtB,YAAY,EACZ,MAAM,GACT,GAAG,OAAO,CAAC;IAEZ,IAAI,MAAM,EAAE,CAAC;QACT,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAChB,GAAG,CAAC,mBAAmB,EAAE,CAAC;IAC9B,CAAC;IAED,GAAG,CAAC,UAAU,CAAC;QACX,MAAM,EAAE,WAAW;QACnB,WAAW,EAAE,IAAI;KACpB,CAAC,CAAC;IAEH,GAAG,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IAE/B,IAAI,SAAS,EAAE,CAAC;QACZ,GAAG,CAAC,GAAG,CAAC,IAAA,gBAAM,GAAE,CAAC,CAAC;IACtB,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACb,GAAG,CAAC,cAAc,CACd,IAAI,uBAAc,CAAC;YACf,SAAS,EAAE,IAAI;YACf,oBAAoB,EAAE,IAAI;YAC1B,SAAS,EAAE,IAAI;YACf,gBAAgB,EAAE;gBACd,wBAAwB,EAAE,IAAI;aACjC;SACJ,CAAC,CACL,CAAC;IACN,CAAC;IAED,IAAI,eAAe,EAAE,CAAC;QAElB,GAAG,CAAC,gBAAgB,CAAC,IAAI,+BAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;IAClE,CAAC;AACL,CAAC"}
+{"version":3,"file":"app.utils.js","sourceRoot":"","sources":["../../src/utils/app.utils.ts"],"names":[],"mappings":";;AAwBA,4CAwEC;AAhGD,2CAAkE;AAClE,gEAAyD;AACzD,mCAA4B;AAC5B,wCAAmD;AAEnD,6CAAiE;AAmBjE,SAAgB,gBAAgB,CAC5B,GAAqB,EACrB,UAA2B,EAAE;IAE7B,MAAM,EACF,WAAW,GAAG,CAAC,GAAG,CAAC,EACnB,SAAS,GAAG,2BAAU,CAAC,EAAE,EACzB,MAAM,EAAE,SAAS,GAAG,IAAI,EACxB,UAAU,GAAG,IAAI,EACjB,aAAa,GAAG,IAAI,EACpB,eAAe,GAAG,IAAI,EACtB,YAAY,EACZ,MAAM,EACN,OAAO,GACV,GAAG,OAAO,CAAC;IAEZ,IAAI,MAAM,EAAE,CAAC;QACT,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAChB,GAAG,CAAC,mBAAmB,EAAE,CAAC;IAC9B,CAAC;IAED,GAAG,CAAC,UAAU,CAAC;QACX,MAAM,EAAE,WAAW;QACnB,WAAW,EAAE,IAAI;KACpB,CAAC,CAAC;IAEH,GAAG,CAAC,eAAe,CAAC,SAAS,EAAE;QAC3B,OAAO,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,CAAC;KACrE,CAAC,CAAC;IAEH,IAAI,SAAS,EAAE,CAAC;QACZ,GAAG,CAAC,GAAG,CAAC,IAAA,gBAAM,GAAE,CAAC,CAAC;IACtB,CAAC;IAED,IAAI,UAAU,EAAE,CAAC;QACb,GAAG,CAAC,cAAc,CACd,IAAI,uBAAc,CAAC;YACf,SAAS,EAAE,IAAI;YACf,oBAAoB,EAAE,IAAI;YAC1B,SAAS,EAAE,IAAI;YACf,gBAAgB,EAAE;gBACd,wBAAwB,EAAE,IAAI;aACjC;SACJ,CAAC,CACL,CAAC;IACN,CAAC;IAED,IAAI,eAAe,EAAE,CAAC;QAElB,GAAG,CAAC,gBAAgB,CAAC,IAAI,+BAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;IAClE,CAAC;IAGD,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,IAAI,OAAO,EAAE,CAAC;QACnD,MAAM,KAAK,GAAG,OAAO,EAAE,KAAK,IAAI,0BAA0B,CAAC;QAC3D,MAAM,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,6BAA6B,CAAC;QAC1E,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,OAAO,CAAC;QAC5C,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,IAAI,MAAM,CAAC;QAErC,MAAM,MAAM,GAAG,IAAI,yBAAe,EAAE;aAC/B,QAAQ,CAAC,KAAK,CAAC;aACf,cAAc,CAAC,WAAW,CAAC;aAC3B,UAAU,CAAC,OAAO,CAAC;aACnB,aAAa,EAAE;aACf,KAAK,EAAE,CAAC;QAEb,MAAM,QAAQ,GAAG,uBAAa,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC3D,uBAAa,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;AACL,CAAC"}

package/dist/utils/bootstrap.utils.d.ts

@@ -0,0 +1,15 @@
+export interface BootstrapOptions {
+    serviceName: string;
+    apiPrefix: string;
+    grpcPackage?: string;
+    port?: number;
+    grpcPort?: number;
+    corsOrigins?: string | string[];
+    kafka?: {
+        brokers?: string[];
+        groupId?: string;
+    };
+}
+export declare class StandardBootstrap {
+    static run(appModule: any, options: BootstrapOptions): Promise<import("@nestjs/common").INestApplication<any>>;
+}

package/dist/utils/bootstrap.utils.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandardBootstrap = void 0;
+const core_1 = require("@nestjs/core");
+const microservices_1 = require("@nestjs/microservices");
+const config_sdk_1 = require("@alacard-project/config-sdk");
+const logging_sdk_1 = require("@alacard-project/logging-sdk");
+const app_utils_1 = require("./app.utils");
+const tracing_utils_1 = require("./tracing.utils");
+const proto_path_1 = require("./proto-path");
+class StandardBootstrap {
+    static async run(appModule, options) {
+        const environment = process.env.NODE_ENV || 'development';
+        const configServiceUrl = process.env.CONFIG_SERVICE_URL || 'config-microservice:50055';
+        const internalKey = process.env.INTERNAL_CONFIG_KEY;
+        (0, tracing_utils_1.initTracing)(options.serviceName);
+        await config_sdk_1.ConfigClient.initialize({
+            serviceName: options.serviceName,
+            environment,
+            grpcUrl: configServiceUrl,
+            internalKey,
+        });
+        const app = await core_1.NestFactory.create(appModule, {
+            bufferLogs: true,
+        });
+        const remoteLogger = app.get(logging_sdk_1.RemoteLogger);
+        app.useLogger(remoteLogger);
+        (0, app_utils_1.setupStandardApp)(app, {
+            apiPrefix: options.apiPrefix,
+            remoteLogger,
+            corsOrigins: options.corsOrigins,
+        });
+        if (options.grpcPackage) {
+            const finalGrpcPort = options.grpcPort || 50051;
+            app.connectMicroservice({
+                transport: microservices_1.Transport.GRPC,
+                options: {
+                    package: options.grpcPackage,
+                    protoPath: (0, proto_path_1.getProtoPath)(options.grpcPackage),
+                    url: `0.0.0.0:${finalGrpcPort}`,
+                },
+            });
+        }
+        if (options.kafka) {
+            app.connectMicroservice({
+                transport: microservices_1.Transport.KAFKA,
+                options: {
+                    client: {
+                        brokers: options.kafka.brokers || (process.env.KAFKA_BROKERS || 'kafka:29092').split(','),
+                    },
+                    consumer: {
+                        groupId: options.kafka.groupId || `${options.serviceName}-consumer`,
+                    },
+                },
+            });
+        }
+        if (options.grpcPackage || options.kafka) {
+            await app.startAllMicroservices();
+        }
+        const finalPort = options.port || 3000;
+        await app.listen(finalPort, '0.0.0.0');
+        console.log(`🚀 ${options.serviceName} is running on: http://localhost:${finalPort}`);
+        if (options.grpcPackage) {
+            console.log(`📊 gRPC is running on: 0.0.0.0:${options.grpcPort || 50051}`);
+        }
+        return app;
+    }
+}
+exports.StandardBootstrap = StandardBootstrap;
+//# sourceMappingURL=bootstrap.utils.js.map

package/dist/utils/bootstrap.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.utils.js","sourceRoot":"","sources":["../../src/utils/bootstrap.utils.ts"],"names":[],"mappings":";;;AAAA,uCAA2C;AAC3C,yDAAuE;AACvE,4DAA2D;AAC3D,8DAA4D;AAC5D,2CAA+C;AAC/C,mDAA8C;AAC9C,6CAA4C;AAgB5C,MAAa,iBAAiB;IACnB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,SAAc,EAAE,OAAyB;QAC7D,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAC;QAC1D,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,2BAA2B,CAAC;QACvF,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QAGpD,IAAA,2BAAW,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAGjC,MAAM,yBAAY,CAAC,UAAU,CAAC;YAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,WAAW;YACX,OAAO,EAAE,gBAAgB;YACzB,WAAW;SACd,CAAC,CAAC;QAGH,MAAM,GAAG,GAAG,MAAM,kBAAW,CAAC,MAAM,CAAC,SAAS,EAAE;YAC5C,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QAGH,MAAM,YAAY,GAAG,GAAG,CAAC,GAAG,CAAC,0BAAY,CAAC,CAAC;QAC3C,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAG5B,IAAA,4BAAgB,EAAC,GAAU,EAAE;YACzB,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,YAAY;YACZ,WAAW,EAAE,OAAO,CAAC,WAAW;SACnC,CAAC,CAAC;QAGH,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;YAChD,GAAG,CAAC,mBAAmB,CAAsB;gBACzC,SAAS,EAAE,yBAAS,CAAC,IAAI;gBACzB,OAAO,EAAE;oBACL,OAAO,EAAE,OAAO,CAAC,WAAW;oBAC5B,SAAS,EAAE,IAAA,yBAAY,EAAC,OAAO,CAAC,WAAW,CAAC;oBAC5C,GAAG,EAAE,WAAW,aAAa,EAAE;iBAClC;aACJ,CAAC,CAAC;QACP,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,GAAG,CAAC,mBAAmB,CAAsB;gBACzC,SAAS,EAAE,yBAAS,CAAC,KAAK;gBAC1B,OAAO,EAAE;oBACL,MAAM,EAAE;wBACJ,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,aAAa,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;qBAC5F;oBACD,QAAQ,EAAE;wBACN,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,IAAI,GAAG,OAAO,CAAC,WAAW,WAAW;qBACtE;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC;QAED,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YACvC,MAAM,GAAG,CAAC,qBAAqB,EAAE,CAAC;QACtC,CAAC;QAGD,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC;QACvC,MAAM,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAEvC,OAAO,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,WAAW,oCAAoC,SAAS,EAAE,CAAC,CAAC;QACtF,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,CAAC,GAAG,CAAC,kCAAkC,OAAO,CAAC,QAAQ,IAAI,KAAK,EAAE,CAAC,CAAC;QAC/E,CAAC;QAED,OAAO,GAAG,CAAC;IACf,CAAC;CACJ;AA3ED,8CA2EC"}

package/dist/utils/standard-health.module.d.ts

@@ -0,0 +1,10 @@
+import { HealthCheckService, HealthCheckResult, MemoryHealthIndicator } from '@nestjs/terminus';
+export declare class StandardHealthController {
+    private health;
+    private memory;
+    constructor(health: HealthCheckService, memory: MemoryHealthIndicator);
+    checkLiveness(): Promise<HealthCheckResult>;
+    checkReadiness(): Promise<HealthCheckResult>;
+}
+export declare class StandardHealthModule {
+}

package/dist/utils/standard-health.module.js

@@ -0,0 +1,59 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandardHealthModule = exports.StandardHealthController = void 0;
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+let StandardHealthController = class StandardHealthController {
+    constructor(health, memory) {
+        this.health = health;
+        this.memory = memory;
+    }
+    async checkLiveness() {
+        return this.health.check([]);
+    }
+    async checkReadiness() {
+        return this.health.check([
+            () => this.memory.checkHeap('memory_heap', 150 * 1024 * 1024),
+        ]);
+    }
+};
+exports.StandardHealthController = StandardHealthController;
+__decorate([
+    (0, common_1.Get)('live'),
+    (0, terminus_1.HealthCheck)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], StandardHealthController.prototype, "checkLiveness", null);
+__decorate([
+    (0, common_1.Get)('ready'),
+    (0, terminus_1.HealthCheck)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], StandardHealthController.prototype, "checkReadiness", null);
+exports.StandardHealthController = StandardHealthController = __decorate([
+    (0, common_1.Controller)('health'),
+    __metadata("design:paramtypes", [terminus_1.HealthCheckService,
+        terminus_1.MemoryHealthIndicator])
+], StandardHealthController);
+let StandardHealthModule = class StandardHealthModule {
+};
+exports.StandardHealthModule = StandardHealthModule;
+exports.StandardHealthModule = StandardHealthModule = __decorate([
+    (0, common_1.Module)({
+        imports: [terminus_1.TerminusModule],
+        controllers: [StandardHealthController],
+        exports: [terminus_1.TerminusModule],
+    })
+], StandardHealthModule);
+//# sourceMappingURL=standard-health.module.js.map

package/dist/utils/standard-health.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard-health.module.js","sourceRoot":"","sources":["../../src/utils/standard-health.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAyD;AACzD,+CAA6H;AAGtH,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;IACjC,YACY,MAA0B,EAC1B,MAA6B;QAD7B,WAAM,GAAN,MAAM,CAAoB;QAC1B,WAAM,GAAN,MAAM,CAAuB;IACrC,CAAC;IAIC,AAAN,KAAK,CAAC,aAAa;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAIK,AAAN,KAAK,CAAC,cAAc;QAGhB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACrB,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,aAAa,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;SAChE,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AArBY,4DAAwB;AAQ3B;IAFL,IAAA,YAAG,EAAC,MAAM,CAAC;IACX,IAAA,sBAAW,GAAE;;;;6DAGb;AAIK;IAFL,IAAA,YAAG,EAAC,OAAO,CAAC;IACZ,IAAA,sBAAW,GAAE;;;;8DAOb;mCApBQ,wBAAwB;IADpC,IAAA,mBAAU,EAAC,QAAQ,CAAC;qCAGG,6BAAkB;QAClB,gCAAqB;GAHhC,wBAAwB,CAqBpC;AAOM,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;CAAI,CAAA;AAAxB,oDAAoB;+BAApB,oBAAoB;IALhC,IAAA,eAAM,EAAC;QACJ,OAAO,EAAE,CAAC,yBAAc,CAAC;QACzB,WAAW,EAAE,CAAC,wBAAwB,CAAC;QACvC,OAAO,EAAE,CAAC,yBAAc,CAAC;KAC5B,CAAC;GACW,oBAAoB,CAAI"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alacard-project/shared",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "engines": {
     "node": ">=22.0.0"
   },