@ghentcdh/tools-api 0.0.1

package/README.md

@@ -0,0 +1,59 @@
+This library consist of a group of tools used by the GhentCDH projects.
+
+# Health api
+
+This will add a health check endpoint to the nestjs application.
+
+Add it to the `AppModule` imports
+
+```typescript
+
+import { HealthApiModule } from '@ghentcdh/tools/health/api';
+
+@Module({
+  imports: [
+    ...
+    HealthApiModule,
+  ],
+})
+export class AppModule {}
+
+```
+
+# Logging api for nestjs application
+
+## Configuration
+
+1. adjust the nestjs file `main.ts` to include the logging module
+
+```typescript
+
+import {Logger as MyLogger} from '@ghentcdh/tools/api';
+
+// bootstrap the application
+
+
+async function bootstrap() {
+    const app = await NestFactory.create(AppModule);
+    //...
+
+    app.useLogger(new MyLogger())
+    //...
+}
+
+```
+
+2. configure the logging environment variable ```LOG_DIR``` in the `.env` file
+
+```
+LOG_DIR=/tmp/logs
+```
+
+3. Use the logging command
+
+```typescript
+import {Logger} from '@ghentcdh/tools/api';
+
+
+Logger.log('Nest hello api', 'AppController');
+```

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@ghentcdh/tools-api",
+  "version": "0.0.1",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "tslib": "^2.3.0",
+    "@nestjs/axios": "^4.0.0",
+    "@nestjs/common": "^10.0.2",
+    "@nestjs/config": "^4.0.0",
+    "@nestjs/terminus": "^11.0.0",
+    "log4js": "^6.9.1",
+    "@nx/vite": "20.4.5",
+    "vite": "^5.0.0",
+    "vite-plugin-node": "^4.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GhentCDH/ghentcdh-monorepo.git"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/health';
+export * from './lib/logging';

package/src/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/health"), exports);
+tslib_1.__exportStar(require("./lib/logging"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/tools/api/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAE7B,wDAA8B"}

package/src/lib/health/health-api.module.d.ts

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

package/src/lib/health/health-api.module.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthApiModule = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = require("@nestjs/axios");
+const common_1 = require("@nestjs/common");
+const config_1 = require("@nestjs/config");
+const terminus_1 = require("@nestjs/terminus");
+const health_controller_1 = require("./health.controller");
+let HealthApiModule = class HealthApiModule {
+};
+exports.HealthApiModule = HealthApiModule;
+exports.HealthApiModule = HealthApiModule = tslib_1.__decorate([
+    (0, common_1.Module)({
+        imports: [terminus_1.TerminusModule,
+            axios_1.HttpModule,
+            config_1.ConfigModule
+            // PrismaModule
+        ],
+        controllers: [health_controller_1.HealthController],
+        providers: [],
+        exports: [],
+    })
+], HealthApiModule);
+//# sourceMappingURL=health-api.module.js.map

package/src/lib/health/health-api.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health-api.module.js","sourceRoot":"","sources":["../../../../../../../libs/tools/api/src/lib/health/health-api.module.ts"],"names":[],"mappings":";;;;AAAA,yCAAyC;AACzC,2CAAsC;AACtC,2CAA4C;AAC5C,+CAAgD;AAEhD,2DAAqD;AAa9C,IAAM,eAAe,GAArB,MAAM,eAAe;CAC3B,CAAA;AADY,0CAAe;0BAAf,eAAe;IAV3B,IAAA,eAAM,EAAC;QACJ,OAAO,EAAE,CAAC,yBAAc;YACpB,kBAAU;YACV,qBAAY;YACZ,eAAe;SAClB;QACD,WAAW,EAAE,CAAC,oCAAgB,CAAC;QAC/B,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE;KACd,CAAC;GACW,eAAe,CAC3B"}

package/src/lib/health/health.controller.d.ts

@@ -0,0 +1,9 @@
+import { ConfigService } from '@nestjs/config';
+import { HealthCheckService, HttpHealthIndicator } from '@nestjs/terminus';
+export declare class HealthController {
+    private readonly health;
+    private http;
+    private readonly configService;
+    constructor(health: HealthCheckService, http: HttpHealthIndicator, configService: ConfigService);
+    check(): Promise<import("@nestjs/terminus").HealthCheckResult>;
+}

package/src/lib/health/health.controller.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthController = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const config_1 = require("@nestjs/config");
+const terminus_1 = require("@nestjs/terminus");
+// import {
+//     HealthCheck,
+//     HealthCheckService,
+//     PrismaHealthIndicator,
+// } from '@nestjs/terminus';
+// import { PrismaService } from 'src/prisma/prisma.service';
+let HealthController = class HealthController {
+    constructor(health, http, configService) {
+        this.health = health;
+        this.http = http;
+        this.configService = configService;
+    }
+    check() {
+        const keycloakHost = this.configService.get('KEYCLOAK_HOST');
+        return this.health.check([
+            () => this.http.pingCheck('Keycloak', `${keycloakHost}heatlh`),
+            // async () => this.prismaHealth.pingCheck('prisma', this.prisma),
+        ]);
+    }
+};
+exports.HealthController = HealthController;
+tslib_1.__decorate([
+    (0, common_1.Get)(),
+    (0, terminus_1.HealthCheck)(),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], HealthController.prototype, "check", null);
+exports.HealthController = HealthController = tslib_1.__decorate([
+    (0, common_1.Controller)('health'),
+    tslib_1.__metadata("design:paramtypes", [terminus_1.HealthCheckService,
+        terminus_1.HttpHealthIndicator,
+        config_1.ConfigService])
+], HealthController);
+//# sourceMappingURL=health.controller.js.map

package/src/lib/health/health.controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.controller.js","sourceRoot":"","sources":["../../../../../../../libs/tools/api/src/lib/health/health.controller.ts"],"names":[],"mappings":";;;;AAAA,2CAAiD;AACjD,2CAA+C;AAC/C,+CAI0B;AAE1B,WAAW;AACX,mBAAmB;AACnB,0BAA0B;AAC1B,6BAA6B;AAC7B,6BAA6B;AAC7B,6DAA6D;AAGtD,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAC3B,YACmB,MAA0B,EACnC,IAAyB,EAChB,aAA4B;QAF5B,WAAM,GAAN,MAAM,CAAoB;QACnC,SAAI,GAAJ,IAAI,CAAqB;QAChB,kBAAa,GAAb,aAAa,CAAe;IAG5C,CAAC;IAIJ,KAAK;QACH,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,eAAe,CAAE,CAAC;QAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACvB,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,GAAG,YAAY,QAAQ,CAAC;YAC9D,kEAAkE;SACnE,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAlBY,4CAAgB;AAW3B;IAFC,IAAA,YAAG,GAAE;IACL,IAAA,sBAAW,GAAE;;;;6CAOb;2BAjBU,gBAAgB;IAD5B,IAAA,mBAAU,EAAC,QAAQ,CAAC;6CAGQ,6BAAkB;QAC7B,8BAAmB;QACD,sBAAa;GAJpC,gBAAgB,CAkB5B"}

package/src/lib/health/index.d.ts

@@ -0,0 +1 @@
+export * from './health-api.module';

package/src/lib/health/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./health-api.module"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/health/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../libs/tools/api/src/lib/health/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC"}

package/src/lib/logging/index.d.ts

@@ -0,0 +1 @@
+export * from './logger';

package/src/lib/logging/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./logger"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/logging/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../libs/tools/api/src/lib/logging/index.ts"],"names":[],"mappings":";;;AAAA,mDAAwB"}

package/src/lib/logging/logger.d.ts

@@ -0,0 +1,15 @@
+import { ConsoleLogger } from '@nestjs/common';
+export declare class Logger extends ConsoleLogger {
+    static debug(context: string, message: string): void;
+    static log(context: string, message: string): void;
+    static error(context: string, message: string, trace?: any): void;
+    static warn(context: string, message: string): void;
+    private readonly _logger;
+    private static instance;
+    private constructor();
+    static init(): Logger;
+    debug(message: string, context: string): void;
+    log(message: string, context: string): void;
+    error(message: string, stack?: string, context?: string): void;
+    warn(message: string, context: string): void;
+}

package/src/lib/logging/logger.js

@@ -0,0 +1,72 @@
+"use strict";
+var Logger_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const log4js = require("log4js");
+let Logger = Logger_1 = class Logger extends common_1.ConsoleLogger {
+    static debug(context, message) {
+        //  super.debug.apply(message, context);
+        Logger_1.instance.debug(message, context);
+    }
+    static log(context, message) {
+        // super.log(message, context);
+        console.log(message);
+        Logger_1.instance.log(`[${context}]`, message);
+    }
+    // tslint:disable-next-line:no-any
+    static error(context, message, trace) {
+        // add your tailored logic here
+        // super.error(message, trace);
+        console.error(message);
+        Logger_1.instance.error(`[${context}]`, message, trace);
+    }
+    static warn(context, message) {
+        // add your tailored logic here
+        //   super.warn(message, context);
+        console.warn(message);
+        Logger_1.instance.warn(`[${context}]`, message);
+    }
+    constructor() {
+        super();
+        const logDir = process.env['LOG_DIR'] ?? 'logs';
+        console.log('logDir:', logDir);
+        log4js.configure({
+            appenders: { app: { type: "file", filename: `${logDir}/app.log` } },
+            categories: { default: { appenders: ["app"], level: "info" } },
+        });
+        this._logger = log4js.getLogger('app');
+    }
+    static init() {
+        if (!Logger_1.instance) {
+            Logger_1.instance = new Logger_1();
+        }
+        return Logger_1.instance;
+    }
+    debug(message, context) {
+        super.log(message, context);
+        this._logger.debug(`[${context}]`, message);
+        // this._logger.message(`[${context}]`, message);
+    }
+    log(message, context) {
+        super.log(message, context);
+        this._logger.log(`[${context}]`, message);
+    }
+    error(message, stack, context) {
+        // add your tailored logic here
+        super.error(message, stack, context);
+        this._logger.error(`[${context}]`, message, stack);
+    }
+    warn(message, context) {
+        // add your tailored logic here
+        super.warn(message, context);
+        this._logger.warn(`[${context}]`, message);
+    }
+};
+exports.Logger = Logger;
+exports.Logger = Logger = Logger_1 = tslib_1.__decorate([
+    (0, common_1.Injectable)({ scope: common_1.Scope.TRANSIENT }),
+    tslib_1.__metadata("design:paramtypes", [])
+], Logger);
+//# sourceMappingURL=logger.js.map

package/src/lib/logging/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../../../../../libs/tools/api/src/lib/logging/logger.ts"],"names":[],"mappings":";;;;;AAAA,2CAAgE;AAChE,iCAAiC;AAG1B,IAAM,MAAM,cAAZ,MAAM,MAAO,SAAQ,sBAAa;IAC9B,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,OAAe;QAChD,wCAAwC;QACxC,QAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,OAAe;QAC9C,+BAA+B;QAC/B,OAAO,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC;QACtB,QAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,kCAAkC;IAC3B,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,OAAe,EAAE,KAAW;QAC7D,+BAA+B;QAC/B,+BAA+B;QAC/B,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvB,QAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAEM,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,OAAe;QAC/C,+BAA+B;QAC/B,kCAAkC;QAClC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,QAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAKD;QACI,KAAK,EAAE,CAAC;QACR,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,MAAM,CAAC;QAChD,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC/B,MAAM,CAAC,SAAS,CAAC;YACb,SAAS,EAAE,EAAC,GAAG,EAAE,EAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,UAAU,EAAC,EAAC;YAC/D,UAAU,EAAE,EAAC,OAAO,EAAE,EAAC,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,MAAM,EAAC,EAAC;SAC7D,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAEM,MAAM,CAAC,IAAI;QACd,IAAI,CAAC,QAAM,CAAC,QAAQ,EAAE,CAAC;YACnB,QAAM,CAAC,QAAQ,GAAG,IAAI,QAAM,EAAE,CAAA;QAClC,CAAC;QAED,OAAO,QAAM,CAAC,QAAQ,CAAA;IAC1B,CAAC;IAEe,KAAK,CAAC,OAAe,EAAE,OAAe;QAClD,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC;QAC5C,iDAAiD;IACrD,CAAC;IAEe,GAAG,CAAC,OAAe,EAAE,OAAe;QAChD,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAEe,KAAK,CAAC,OAAe,EAAE,KAAc,EAAE,OAAgB;QACnE,+BAA+B;QAC/B,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAEe,IAAI,CAAC,OAAe,EAAE,OAAe;QACjD,+BAA+B;QAC/B,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;CAGJ,CAAA;AA1EY,wBAAM;iBAAN,MAAM;IADlB,IAAA,mBAAU,EAAC,EAAC,KAAK,EAAE,cAAK,CAAC,SAAS,EAAC,CAAC;;GACxB,MAAM,CA0ElB"}