Feature/documentations

apps/documentations-server-e2e/eslint.config.cjs

@@ -0,0 +1,3 @@
+const baseConfig = require('../../eslint.config.js');
+
+module.exports = [...baseConfig];

apps/documentations-server-e2e/jest.config.ts

@@ -0,0 +1,18 @@
+export default {
+  displayName: 'documentations-server-e2e',
+  preset: '../../jest.preset.js',
+  globalSetup: '<rootDir>/src/support/global-setup.ts',
+  globalTeardown: '<rootDir>/src/support/global-teardown.ts',
+  setupFiles: ['<rootDir>/src/support/test-setup.ts'],
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+      },
+    ],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/documentations-server-e2e',
+};

apps/documentations-server-e2e/project.json

@@ -0,0 +1,17 @@
+{
+  "name": "documentations-server-e2e",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "application",
+  "implicitDependencies": ["documentations-server"],
+  "targets": {
+    "e2e": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{e2eProjectRoot}"],
+      "options": {
+        "jestConfig": "apps/documentations-server-e2e/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "dependsOn": ["documentations-server:build"]
+    }
+  }
+}

apps/documentations-server-e2e/src/documentations-server/documentations-server.spec.ts

@@ -0,0 +1,10 @@
+import axios from 'axios';
+
+describe('GET /api', () => {
+  it('should return a message', async () => {
+    const res = await axios.get(`/api`);
+
+    expect(res.status).toBe(200);
+    expect(res.data).toEqual({ message: 'Hello API' });
+  });
+});

apps/documentations-server-e2e/src/support/global-setup.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+var __TEARDOWN_MESSAGE__: string;
+
+module.exports = async function () {
+  // Start services that that the app needs to run (e.g. database, docker-compose, etc.).
+  console.log('\nSetting up...\n');
+
+  // Hint: Use `globalThis` to pass variables to global teardown.
+  globalThis.__TEARDOWN_MESSAGE__ = '\nTearing down...\n';
+};

apps/documentations-server-e2e/src/support/global-teardown.ts

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+module.exports = async function () {
+  // Put clean up logic here (e.g. stopping services, docker-compose, etc.).
+  // Hint: `globalThis` is shared between setup and teardown.
+  console.log(globalThis.__TEARDOWN_MESSAGE__);
+};

apps/documentations-server-e2e/src/support/test-setup.ts

@@ -0,0 +1,9 @@
+/* eslint-disable */
+import axios from 'axios';
+
+module.exports = async function () {
+  // Configure axios for tests to use.
+  const host = process.env.HOST ?? 'localhost';
+  const port = process.env.PORT ?? '3000';
+  axios.defaults.baseURL = `http://${host}:${port}`;
+};

apps/documentations-server-e2e/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true
+  }
+}

apps/documentations-server-e2e/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.ts"]
+}

apps/documentations-server/eslint.config.cjs

@@ -0,0 +1,3 @@
+const baseConfig = require('../../eslint.config.js');
+
+module.exports = [...baseConfig];

apps/documentations-server/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  displayName: 'documentations-server',
+  preset: '../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/apps/documentations-server',
+};

apps/documentations-server/project.json

@@ -0,0 +1,43 @@
+{
+  "name": "documentations-server",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/documentations-server/src",
+  "projectType": "application",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "webpack-cli build",
+        "args": ["node-env=production"]
+      },
+      "configurations": {
+        "development": {
+          "args": ["node-env=development"]
+        }
+      }
+    },
+    "serve": {
+      "executor": "@nx/js:node",
+      "defaultConfiguration": "development",
+      "dependsOn": ["build"],
+      "options": {
+        "buildTarget": "documentations-server:build",
+        "runBuildTargetDependencies": false
+      },
+      "configurations": {
+        "development": {
+          "buildTarget": "documentations-server:build:development"
+        },
+        "production": {
+          "buildTarget": "documentations-server:build:production"
+        }
+      }
+    },
+    "test": {
+      "options": {
+        "passWithNoTests": true
+      }
+    }
+  }
+}

apps/documentations-server/src/app/app.controller.spec.ts

@@ -0,0 +1,21 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+
+describe('AppController', () => {
+  let app: TestingModule;
+
+  beforeAll(async () => {
+    app = await Test.createTestingModule({
+      controllers: [AppController],
+      providers: [AppService],
+    }).compile();
+  });
+
+  describe('getData', () => {
+    it('should return "Hello API"', () => {
+      const appController = app.get<AppController>(AppController);
+      expect(appController.getData()).toEqual({ message: 'Hello API' });
+    });
+  });
+});

apps/documentations-server/src/app/app.controller.ts

@@ -0,0 +1,12 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+
+@Controller()
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  getData() {
+    return this.appService.getData();
+  }
+}

apps/documentations-server/src/app/app.module.ts

@@ -0,0 +1,19 @@
+import { APP_INTERCEPTOR } from '@nestjs/core';
+import { ApiResponseInterceptor } from './core/utilities/http-response.interceptor';
+import { AppController } from './app.controller';
+import { AppMenuModule } from './modules/app-menu/app-menu.module';
+import { AppPageModule } from './modules/app-page/app-page.module';
+import { AppService } from './app.service';
+import { Module } from '@nestjs/common';
+@Module({
+  imports: [AppMenuModule, AppPageModule],
+  controllers: [AppController],
+  providers: [
+    AppService,
+    {
+      provide: APP_INTERCEPTOR,
+      useClass: ApiResponseInterceptor,
+    },
+  ],
+})
+export class AppModule {}

apps/documentations-server/src/app/app.service.spec.ts

@@ -0,0 +1,20 @@
+import { Test } from '@nestjs/testing';
+import { AppService } from './app.service';
+
+describe('AppService', () => {
+  let service: AppService;
+
+  beforeAll(async () => {
+    const app = await Test.createTestingModule({
+      providers: [AppService],
+    }).compile();
+
+    service = app.get<AppService>(AppService);
+  });
+
+  describe('getData', () => {
+    it('should return "Hello API"', () => {
+      expect(service.getData()).toEqual({ message: 'Hello API' });
+    });
+  });
+});

apps/documentations-server/src/app/app.service.ts

@@ -0,0 +1,8 @@
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class AppService {
+  getData(): { message: string } {
+    return { message: 'Hello API' };
+  }
+}

apps/documentations-server/src/app/core/services/content-fetching/content-fetching.service.spec.ts

@@ -0,0 +1,19 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { ContentFetchingService } from './content-fetching.service';
+
+describe('ContentFetchingService', () => {
+  let service: ContentFetchingService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [ContentFetchingService],
+    }).compile();
+
+    service = module.get<ContentFetchingService>(ContentFetchingService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

apps/documentations-server/src/app/core/services/content-fetching/content-fetching.service.ts

@@ -0,0 +1,44 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { existsSync, readFile } from 'fs';
+
+import { join } from 'path';
+import { promisify } from 'util';
+import { workspaceRoot } from '@nx/devkit';
+
+@Injectable()
+export class ContentFetchingService {
+  async load(filePath: string): Promise<string> {
+    Logger.log('ContentFetchingService, load file by given filePath', {
+      filePath,
+    });
+    const fullPath = join(
+      workspaceRoot,
+      'apps/documentations-server/src/assets/contents',
+      filePath,
+    );
+
+    Logger.log('ContentFetchingService, parsed fullPath', { fullPath });
+    if (!existsSync(fullPath)) {
+      Logger.error('ContentFetchingService, File does not exist', { fullPath });
+      throw new Error(`File not found: ${fullPath}`);
+    }
+
+    const readFileAsync = promisify(readFile);
+
+    try {
+      Logger.log('ContentFetchingService, start reading file', { fullPath });
+      const data = await readFileAsync(fullPath, 'utf-8');
+      Logger.log('ContentFetchingService, Success readFile given filepath', {
+        fullPath,
+        data,
+      });
+      return data;
+    } catch (err) {
+      Logger.error('ContentFetchingService, Error while reading filepath', {
+        fullPath,
+        err,
+      });
+      throw err;
+    }
+  }
+}

apps/documentations-server/src/app/core/utilities/http-response.interceptor.ts

@@ -0,0 +1,47 @@
+import {
+  CallHandler,
+  ExecutionContext,
+  Injectable,
+  NestInterceptor,
+} from '@nestjs/common';
+import { Observable, lastValueFrom } from 'rxjs';
+import { failureResponse, successResponse } from './http-response.utils';
+
+@Injectable()
+export class ApiResponseInterceptor<T> implements NestInterceptor<T> {
+  async intercept(
+    context: ExecutionContext,
+    next: CallHandler,
+  ): Promise<Observable<unknown>> {
+    const httpContext = context.switchToHttp();
+    const response = httpContext.getResponse();
+
+    try {
+      const data = await lastValueFrom(next.handle());
+
+      // Set success status code
+      response.status(200);
+
+      return new Observable((observer) => {
+        observer.next(successResponse('Request success', data || null)); // Ensure null is handled
+        observer.complete();
+      });
+    } catch (error) {
+      // Extract error status or fallback to 500
+      const statusCode = error.status || 500;
+
+      // Set error status code
+      response.status(statusCode);
+
+      return new Observable((observer) => {
+        observer.next(
+          failureResponse(
+            'Request failed',
+            error.response || error.message || error,
+          ),
+        );
+        observer.complete();
+      });
+    }
+  }
+}

apps/documentations-server/src/app/core/utilities/http-response.utils.ts

@@ -0,0 +1,25 @@
+export class ApiResponseHelper<T> {
+  success: boolean;
+  message: string;
+  data?: T; // Generic type for response payload
+  error?: Error | Record<string, unknown> | unknown; // Error details, if applicable
+}
+
+export function createApiResponse<T>(
+  success: boolean,
+  message: string,
+  data?: T,
+  error?: Error | Record<string, unknown> | unknown,
+): ApiResponseHelper<T> {
+  return {
+    success,
+    message,
+    data,
+    error,
+  };
+}
+
+export const successResponse = <T>(message: string, data: T) =>
+  createApiResponse(true, message, data);
+export const failureResponse = <E>(message: string, error: E) =>
+  createApiResponse(false, message, null, error);