mm-share-lib 0.0.4 → 0.0.5

package/index.ts

@@ -1 +1 @@
-export * from './src';
+export * from './src';

package/nest-cli.json

@@ -1,8 +1,8 @@
-{
-  "$schema": "https://json.schemastore.org/nest-cli",
-  "collection": "@nestjs/schematics",
-  "sourceRoot": "src",
-  "compilerOptions": {
-    "deleteOutDir": true
-  }
-}
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}

package/package.json

@@ -1,81 +1,82 @@
-{
-  "name": "mm-share-lib",
-  "version": "0.0.4",
-  "description": "Share the generic service, entity, dto.",
-  "author": "Mesa SOT",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "nest build",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "start": "nest start",
-    "start:dev": "nest start --watch",
-    "start:debug": "nest start --debug --watch",
-    "start:prod": "node dist/main",
-    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
-    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json",
-    "prepare": "husky install"
-  },
-  "dependencies": {
-    "@babel/runtime": "^7.22.5",
-    "@nestjs/common": "^9.4.2",
-    "@nestjs/core": "^9.4.2",
-    "@nestjs/platform-express": "^9.4.2",
-    "@nestjs/typeorm": "^9.0.1",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.0",
-    "dayjs": "^1.11.8",
-    "reflect-metadata": "^0.1.13",
-    "rxjs": "^7.8.1",
-    "typeorm": "^0.3.16",
-    "bcrypt": "^5.1.0",
-    "typesense": "^1.5.4"
-  },
-  "devDependencies": {
-    "@nestjs/cli": "^9.5.0",
-    "@nestjs/schematics": "^9.2.0",
-    "@nestjs/testing": "^9.4.2",
-    "@types/bcrypt": "^5.0.0",
-    "@types/express": "^4.17.17",
-    "@types/jest": "29.5.2",
-    "@types/node": "20.2.5",
-    "@types/supertest": "^2.0.12",
-    "@typescript-eslint/eslint-plugin": "^5.59.9",
-    "@typescript-eslint/parser": "^5.59.9",
-    "eslint": "^8.42.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.3",
-    "jest": "29.5.0",
-    "prettier": "^2.8.8",
-    "source-map-support": "^0.5.21",
-    "supertest": "^6.3.3",
-    "ts-jest": "29.1.0",
-    "ts-loader": "^9.4.3",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "4.2.0",
-    "typescript": "^5.1.3"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "collectCoverageFrom": [
-      "**/*.(t|j)s"
-    ],
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
-  }
-}
+{
+  "name": "mm-share-lib",
+  "version": "0.0.5",
+  "description": "Share the generic service, entity, dto.",
+  "author": "Mesa SOT",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "nest build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "prepare": "husky install"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.22.5",
+    "@nestjs/common": "^9.4.2",
+    "@nestjs/core": "^9.4.2",
+    "@nestjs/microservices": "^9.4.3",
+    "@nestjs/platform-express": "^9.4.2",
+    "@nestjs/typeorm": "^9.0.1",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0",
+    "dayjs": "^1.11.8",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.8.1",
+    "typeorm": "^0.3.16",
+    "bcrypt": "^5.1.0",
+    "typesense": "^1.5.4"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^9.5.0",
+    "@nestjs/schematics": "^9.2.0",
+    "@nestjs/testing": "^9.4.2",
+    "@types/bcrypt": "^5.0.0",
+    "@types/express": "^4.17.17",
+    "@types/jest": "29.5.2",
+    "@types/node": "20.2.5",
+    "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^5.59.9",
+    "@typescript-eslint/parser": "^5.59.9",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.3",
+    "jest": "29.5.0",
+    "prettier": "^2.8.8",
+    "source-map-support": "^0.5.21",
+    "supertest": "^6.3.3",
+    "ts-jest": "29.1.0",
+    "ts-loader": "^9.4.3",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "4.2.0",
+    "typescript": "^5.1.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  }
+}

package/src/constant/entity-state.constant.ts

@@ -1,4 +1,4 @@
-export enum EntityStateConstant {
-  Active = 1,
-  Archived = 0,
-}
+export enum EntityStateConstant {
+  Active = 1,
+  Archived = 0,
+}

package/src/constant/index.ts

@@ -1 +1 @@
-export * from './entity-state.constant';
+export * from './entity-state.constant';

package/src/dto/base-filter.dto.ts

@@ -1,4 +1,4 @@
-export abstract class BaseFilterDto {
-  excludeIds: number[] = undefined;
-  includeIds: number[] = undefined;
-}
+export abstract class BaseFilterDto {
+  excludeIds: number[] = undefined;
+  includeIds: number[] = undefined;
+}

package/src/dto/index.ts

@@ -1,2 +1,2 @@
-export * from './pagination.dto';
-export * from './base-filter.dto';
+export * from './pagination.dto';
+export * from './base-filter.dto';

package/src/dto/pagination.dto.ts

@@ -1,4 +1,4 @@
-export class PaginationDto {
-  limit = 25;
-  offset = 0;
-}
+export class PaginationDto {
+  limit = 25;
+  offset = 0;
+}

package/src/exception/bad-request-error.exception.spec.ts

@@ -0,0 +1,24 @@
+import { HttpStatus } from '@nestjs/common';
+import { BadRequestException } from './bad-request-error.exception';
+
+describe('BadRequestException', () => {
+  it('should set default message and status code if no parameters are provided', () => {
+    const error = new BadRequestException();
+
+    expect(error.message).toBe('BadRequestException');
+    expect(error.statusCode).toBe(HttpStatus.BAD_REQUEST);
+    expect(error.parameters).toBeUndefined();
+  });
+
+  it('should set custom message, status code, and parameters if provided', () => {
+    const customMessage = 'Custom message';
+    const customStatusCode = HttpStatus.BAD_REQUEST;
+    const customParameters = { key: 'value' };
+    const error = new BadRequestException(customMessage, customParameters);
+
+    expect(error.message).toBe(customMessage);
+    expect(error.statusCode).toBe(customStatusCode);
+    expect(error.parameters).toEqual(customParameters);
+    console.log(error);
+  });
+});

package/src/exception/bad-request-error.exception.ts

@@ -0,0 +1,8 @@
+import { HttpStatus } from '@nestjs/common';
+import { BaseException, ParametersType } from './base.exception';
+
+export class BadRequestException extends BaseException {
+  constructor(message?: string, parameters?: ParametersType) {
+    super(message ?? 'BadRequestException', HttpStatus.BAD_REQUEST, parameters);
+  }
+}

package/src/exception/base.exception.ts

@@ -0,0 +1,36 @@
+import { HttpException, HttpStatus } from '@nestjs/common';
+
+export type ErrorModel = {
+  error: {
+    code: string | number;
+    traceid: string;
+    message: string;
+    timestamp: string;
+    path: string;
+  };
+};
+
+export type ParametersType = { [key: string]: unknown };
+
+export class BaseException extends HttpException {
+  traceid: string;
+  readonly context: string;
+  readonly statusCode: number;
+  readonly code?: string;
+  readonly parameters: ParametersType;
+
+  constructor(
+    message: string,
+    status: HttpStatus,
+    parameters?: ParametersType,
+  ) {
+    super(message, status);
+
+    if (parameters) {
+      this.parameters = parameters;
+    }
+
+    this.statusCode = super.getStatus();
+    Error.captureStackTrace(this);
+  }
+}

package/src/exception/conflict-error.exception.spec.ts

@@ -0,0 +1,23 @@
+import { HttpStatus } from '@nestjs/common';
+import { ConflictException } from './conflict-error.exception';
+
+describe('ConflictException', () => {
+  it('should set default message and status code if no parameters are provided', () => {
+    const error = new ConflictException();
+
+    expect(error.message).toBe('ConflictException');
+    expect(error.statusCode).toBe(HttpStatus.CONFLICT);
+    expect(error.parameters).toBeUndefined();
+  });
+
+  it('should set custom message, status code, and parameters if provided', () => {
+    const customMessage = 'Custom message';
+    const customStatusCode = HttpStatus.CONFLICT;
+    const customParameters = { key: 'value' };
+    const error = new ConflictException(customMessage, customParameters);
+
+    expect(error.message).toBe(customMessage);
+    expect(error.statusCode).toBe(customStatusCode);
+    expect(error.parameters).toEqual(customParameters);
+  });
+});

package/src/exception/conflict-error.exception.ts

@@ -0,0 +1,8 @@
+import { HttpStatus } from '@nestjs/common';
+import { BaseException, ParametersType } from './base.exception';
+
+export class ConflictException extends BaseException {
+  constructor(message?: string, parameters?: ParametersType) {
+    super(message ?? 'ConflictException', HttpStatus.CONFLICT, parameters);
+  }
+}

package/src/exception/forbidden-error.exception.spec.ts

@@ -0,0 +1,23 @@
+import { ForbiddenException } from './forbidden-error.exception';
+import { HttpStatus } from '@nestjs/common';
+
+describe('ForbiddenException', () => {
+  it('should set default message and status code if no parameters are provided', () => {
+    const error = new ForbiddenException();
+
+    expect(error.message).toBe('BadRequestException');
+    expect(error.statusCode).toBe(HttpStatus.FORBIDDEN);
+    expect(error.parameters).toBeUndefined();
+  });
+
+  it('should set custom message, status code, and parameters if provided', () => {
+    const customMessage = 'Custom message';
+    const customStatusCode = HttpStatus.FORBIDDEN;
+    const customParameters = { key: 'value' };
+    const error = new ForbiddenException(customMessage, customParameters);
+
+    expect(error.message).toBe(customMessage);
+    expect(error.statusCode).toBe(customStatusCode);
+    expect(error.parameters).toEqual(customParameters);
+  });
+});

package/src/exception/forbidden-error.exception.ts

@@ -0,0 +1,8 @@
+import { HttpStatus } from '@nestjs/common';
+import { BaseException, ParametersType } from './base.exception';
+
+export class ForbiddenException extends BaseException {
+  constructor(message?: string, parameters?: ParametersType) {
+    super(message ?? 'BadRequestException', HttpStatus.FORBIDDEN, parameters);
+  }
+}

package/src/exception/index.ts

@@ -0,0 +1,7 @@
+export * from './base.exception';
+export * from './conflict-error.exception';
+export * from './not-found-error.exception';
+export * from './forbidden-error.exception';
+export * from './bad-request-error.exception';
+export * from './unauthorized-error.exception';
+export * from './internal-server-error.exception';

package/src/exception/internal-server-error.exception.spec.ts

@@ -0,0 +1,23 @@
+import { InternalServerException } from './internal-server-error.exception';
+import { HttpStatus } from '@nestjs/common';
+
+describe('InternalServerException', () => {
+  it('should set default message and status code if no parameters are provided', () => {
+    const error = new InternalServerException();
+
+    expect(error.message).toBe('InternalServerException');
+    expect(error.statusCode).toBe(HttpStatus.INTERNAL_SERVER_ERROR);
+    expect(error.parameters).toBeUndefined();
+  });
+
+  it('should set custom message, status code, and parameters if provided', () => {
+    const customMessage = 'Custom message';
+    const customStatusCode = HttpStatus.INTERNAL_SERVER_ERROR;
+    const customParameters = { key: 'value' };
+    const error = new InternalServerException(customMessage, customParameters);
+
+    expect(error.message).toBe(customMessage);
+    expect(error.statusCode).toBe(customStatusCode);
+    expect(error.parameters).toEqual(customParameters);
+  });
+});

package/src/exception/internal-server-error.exception.ts

@@ -0,0 +1,12 @@
+import { HttpStatus } from '@nestjs/common';
+import { BaseException, ParametersType } from './base.exception';
+
+export class InternalServerException extends BaseException {
+  constructor(message?: string, parameters?: ParametersType) {
+    super(
+      message ?? 'InternalServerException',
+      HttpStatus.INTERNAL_SERVER_ERROR,
+      parameters,
+    );
+  }
+}

package/src/exception/not-found-error.exception.spec.ts

@@ -0,0 +1,23 @@
+import { NotFoundException } from './not-found-error.exception';
+import { HttpStatus } from '@nestjs/common';
+
+describe('NotFoundException', () => {
+  it('should set default message and status code if no parameters are provided', () => {
+    const error = new NotFoundException();
+
+    expect(error.message).toBe('NotFoundException');
+    expect(error.statusCode).toBe(HttpStatus.NOT_FOUND);
+    expect(error.parameters).toBeUndefined();
+  });
+
+  it('should set custom message, status code, and parameters if provided', () => {
+    const customMessage = 'Custom message';
+    const customStatusCode = HttpStatus.INTERNAL_SERVER_ERROR;
+    const customParameters = { key: 'value' };
+    const error = new NotFoundException(customMessage, customParameters);
+
+    expect(error.message).toBe(customMessage);
+    expect(error.statusCode).toBe(customStatusCode);
+    expect(error.parameters).toEqual(customParameters);
+  });
+});

package/src/exception/not-found-error.exception.ts

@@ -0,0 +1,8 @@
+import { HttpStatus } from '@nestjs/common';
+import { BaseException, ParametersType } from './base.exception';
+
+export class NotFoundException extends BaseException {
+  constructor(message?: string, parameters?: ParametersType) {
+    super(message ?? 'NotFoundException', HttpStatus.NOT_FOUND, parameters);
+  }
+}

package/src/exception/unauthorized-error.exception.spec.ts

@@ -0,0 +1,23 @@
+import { UnauthorizedException } from './unauthorized-error.exception';
+import { HttpStatus } from '@nestjs/common';
+
+describe('UnauthorizedException', () => {
+  it('should set default message and status code if no parameters are provided', () => {
+    const error = new UnauthorizedException();
+
+    expect(error.message).toBe('UnauthorizedException');
+    expect(error.statusCode).toBe(HttpStatus.UNAUTHORIZED);
+    expect(error.parameters).toBeUndefined();
+  });
+
+  it('should set custom message, status code, and parameters if provided', () => {
+    const customMessage = 'Custom message';
+    const customStatusCode = HttpStatus.UNAUTHORIZED;
+    const customParameters = { key: 'value' };
+    const error = new UnauthorizedException(customMessage, customParameters);
+
+    expect(error.message).toBe(customMessage);
+    expect(error.statusCode).toBe(customStatusCode);
+    expect(error.parameters).toEqual(customParameters);
+  });
+});

package/src/exception/unauthorized-error.exception.ts

@@ -0,0 +1,12 @@
+import { HttpStatus } from '@nestjs/common';
+import { BaseException, ParametersType } from './base.exception';
+
+export class UnauthorizedException extends BaseException {
+  constructor(message?: string, parameters?: ParametersType) {
+    super(
+      message ?? 'UnauthorizedException',
+      HttpStatus.UNAUTHORIZED,
+      parameters,
+    );
+  }
+}

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

@@ -0,0 +1,23 @@
+import {
+  ExceptionFilter,
+  Catch,
+  ArgumentsHost,
+  HttpException,
+} from '@nestjs/common';
+import { Request, Response } from 'express';
+
+@Catch(HttpException)
+export class HttpExceptionFilter implements ExceptionFilter {
+  catch(exception: HttpException, host: ArgumentsHost) {
+    const ctx = host.switchToHttp();
+    const response = ctx.getResponse<Response>();
+    const request = ctx.getRequest<Request>();
+    const status = exception.getStatus();
+
+    response.status(status).json({
+      statusCode: status,
+      timestamp: new Date().toISOString(),
+      path: request.url,
+    });
+  }
+}

package/src/filter/index.ts

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

package/src/generic/entity/entity.generic.ts

@@ -1,34 +1,34 @@
-import {
-  Column,
-  VersionColumn,
-  CreateDateColumn,
-  UpdateDateColumn,
-  PrimaryGeneratedColumn,
-} from 'typeorm';
-
-export class EntityGeneric {
-  constructor(id?: number) {
-    this.id = id;
-  }
-
-  @PrimaryGeneratedColumn()
-  id: number;
-
-  @CreateDateColumn()
-  createdAt: Date;
-
-  @UpdateDateColumn()
-  updatedAt: Date;
-
-  @Column()
-  createdBy: number;
-
-  @Column({ select: false })
-  updatedBy: number;
-
-  @Column()
-  state: number;
-
-  @VersionColumn({ select: false })
-  version: number;
-}
+import {
+  Column,
+  VersionColumn,
+  CreateDateColumn,
+  UpdateDateColumn,
+  PrimaryGeneratedColumn,
+} from 'typeorm';
+
+export class EntityGeneric {
+  constructor(id?: number) {
+    this.id = id;
+  }
+
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @UpdateDateColumn()
+  updatedAt: Date;
+
+  @Column()
+  createdBy: number;
+
+  @Column({ select: false })
+  updatedBy: number;
+
+  @Column()
+  state: number;
+
+  @VersionColumn({ select: false })
+  version: number;
+}

package/src/generic/entity/index.ts

@@ -1 +1 @@
-export * from './entity.generic';
+export * from './entity.generic';

package/src/generic/index.ts

@@ -1,2 +1,2 @@
-export * from './entity/entity.generic';
-export * from './service/service.generic';
+export * from './entity/entity.generic';
+export * from './service/service.generic';

package/src/generic/service/index.ts

@@ -1 +1 @@
-export * from './service.generic';
+export * from './service.generic';