mm-share-lib 0.0.1 → 0.0.3

package/package.json

@@ -1,77 +1,81 @@
-{
-  "name": "mm-share-lib",
-  "version": "0.0.1",
-  "description": "Share the generic service, entity, dto.",
-  "author": "Mesa SOT",
-  "license": "MIT",
-  "homepage": "https://github.com/memotechs/share-lib",
-  "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",
-    "reflect-metadata": "^0.1.13",
-    "rxjs": "^7.8.1",
-    "typeorm": "^0.3.16",
-    "typesense": "^1.5.4"
-  },
-  "devDependencies": {
-    "@nestjs/cli": "^9.5.0",
-    "@nestjs/schematics": "^9.2.0",
-    "@nestjs/testing": "^9.4.2",
-    "@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.3",
+  "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"
+  }
+}

package/src/{common/constant → 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/{common/constant → constant}/index.ts

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

package/src/{common/generic → 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/{common/generic → generic}/entity/index.ts

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

package/src/{common/generic → 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/{common/generic → generic}/service/index.ts

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

package/src/{common/generic → generic}/service/service.generic.ts

@@ -1,112 +1,112 @@
-import {
-  Repository,
-  Connection,
-  EntityManager,
-  SelectQueryBuilder,
-} from 'typeorm';
-import { EntityGeneric } from '../entity';
-import { PaginationDto, BaseFilterDto } from '../../../dto';
-import { EntityStateConstant } from '../../constant';
-import { PaginationResponse } from '../../../response';
-
-export abstract class ServiceGeneric<
-  Entity extends EntityGeneric,
-  CustomRepository extends Repository<Entity>,
-> {
-  protected readonly entityName: string;
-  protected readonly loggable: boolean = false;
-  protected repository: CustomRepository;
-  protected connection: Connection;
-  constructor(
-    protected readonly connectionOrManager: Connection | EntityManager,
-    repositoryType: { new (connection: Connection): CustomRepository },
-  ) {
-    if (connectionOrManager instanceof EntityManager) {
-      this.connection = connectionOrManager.connection;
-    } else {
-      this.connection = connectionOrManager;
-    }
-    this.repository = this.connection.getCustomRepository(repositoryType);
-  }
-
-  create = async (entity: Entity): Promise<Entity> => {
-    return this.repository.save(entity);
-  };
-
-  update = async (entity: Entity): Promise<Entity> => {
-    return this.repository.save(entity);
-  };
-
-  getListWithPagination = async (
-    paginationDto: PaginationDto,
-    callback?: (query: SelectQueryBuilder<Entity>) => void,
-  ): Promise<PaginationResponse<Entity>> => {
-    const { limit = 25, offset = 0 } = paginationDto;
-    const query = this.repository.createQueryBuilder(this.entityName);
-    query.limit(limit);
-    query.offset(offset);
-    query.where(`${this.entityName}.state != :state`, {
-      state: EntityStateConstant.Archived,
-    });
-    const defaultSelectable = ['createdAt', 'updatedAt'];
-    query.orderBy(`${this.entityName}.updatedAt`, 'DESC');
-    const selection = defaultSelectable.map(
-      (column: string) => `${this.entityName}.${column}`,
-    );
-    query.addSelect(selection);
-    if (callback != null) {
-      callback(query);
-    }
-    const entities = await query.getMany();
-    const total = await query.getCount();
-    const response = new PaginationResponse(entities, total, limit, offset);
-    return response;
-  };
-
-  getAutocompleteWithPagination = async (
-    paginationDto: PaginationDto,
-    filter: BaseFilterDto,
-    callback?: (query: SelectQueryBuilder<Entity>) => void,
-  ): Promise<PaginationResponse<Entity>> => {
-    const { limit = 25, offset = 0 } = paginationDto;
-    const query = this.repository.createQueryBuilder(this.entityName);
-    query.limit(limit);
-    query.offset(offset);
-    query.where(`${this.entityName}.state != :state`, {
-      state: EntityStateConstant.Archived,
-    });
-    const defaultSelectable = ['createdAt', 'updatedAt'];
-    query.orderBy(`${this.entityName}.updatedAt`, 'DESC');
-    const selection = defaultSelectable.map(
-      (column: string) => `${this.entityName}.${column}`,
-    );
-    query.addSelect(selection);
-    if (callback != null) {
-      callback(query);
-    }
-    const { excludeIds = [], includeIds = [] } = { ...filter };
-    // Exclude some ids from the list.
-    if (excludeIds?.length > 0) {
-      query.andWhere(`${this.entityName}.id NOT IN (:ids)`, {
-        ids: excludeIds,
-      });
-    }
-    let entities = await query.getMany();
-    const total = await query.getCount();
-    // Include some ids to the list.
-    const allIds: number[] = [];
-    for (const id of includeIds) {
-      const entity = entities.filter((entity: Entity) => entity.id === id);
-      if (entity.length == 0) {
-        allIds.push(id);
-      }
-    }
-    if (allIds.length > 0) {
-      query.where(`${this.entityName}.id IN (:ids)`, { ids: allIds });
-      const data = await query.getMany();
-      entities = data.concat(entities);
-    }
-    const response = new PaginationResponse(entities, total, limit, offset);
-    return response;
-  };
-}
+import {
+  Repository,
+  Connection,
+  EntityManager,
+  SelectQueryBuilder,
+} from 'typeorm';
+import { EntityGeneric } from '../entity';
+import { PaginationDto, BaseFilterDto } from '../../dto';
+import { EntityStateConstant } from '../../constant';
+import { PaginationResponse } from '../../response';
+
+export abstract class ServiceGeneric<
+  Entity extends EntityGeneric,
+  CustomRepository extends Repository<Entity>,
+> {
+  protected readonly entityName: string;
+  protected readonly loggable: boolean = false;
+  protected repository: CustomRepository;
+  protected connection: Connection;
+  constructor(
+    protected readonly connectionOrManager: Connection | EntityManager,
+    repositoryType: { new (connection: Connection): CustomRepository },
+  ) {
+    if (connectionOrManager instanceof EntityManager) {
+      this.connection = connectionOrManager.connection;
+    } else {
+      this.connection = connectionOrManager;
+    }
+    this.repository = this.connection.getCustomRepository(repositoryType);
+  }
+
+  async create(entity: Entity): Promise<Entity> {
+    return this.repository.save(entity);
+  }
+
+  async update(entity: Entity): Promise<Entity> {
+    return this.repository.save(entity);
+  }
+
+  async getListWithPagination(
+    paginationDto: PaginationDto,
+    callback?: (query: SelectQueryBuilder<Entity>) => void,
+  ): Promise<PaginationResponse<Entity>> {
+    const { limit = 25, offset = 0 } = paginationDto;
+    const query = this.repository.createQueryBuilder(this.entityName);
+    query.limit(limit);
+    query.offset(offset);
+    query.where(`${this.entityName}.state != :state`, {
+      state: EntityStateConstant.Archived,
+    });
+    const defaultSelectable = ['createdAt', 'updatedAt'];
+    query.orderBy(`${this.entityName}.updatedAt`, 'DESC');
+    const selection = defaultSelectable.map(
+      (column: string) => `${this.entityName}.${column}`,
+    );
+    query.addSelect(selection);
+    if (callback != null) {
+      callback(query);
+    }
+    const entities = await query.getMany();
+    const total = await query.getCount();
+    const response = new PaginationResponse(entities, total, limit, offset);
+    return response;
+  }
+
+  async getAutocompleteWithPagination(
+    paginationDto: PaginationDto,
+    filter: BaseFilterDto,
+    callback?: (query: SelectQueryBuilder<Entity>) => void,
+  ): Promise<PaginationResponse<Entity>> {
+    const { limit = 25, offset = 0 } = paginationDto;
+    const query = this.repository.createQueryBuilder(this.entityName);
+    query.limit(limit);
+    query.offset(offset);
+    query.where(`${this.entityName}.state != :state`, {
+      state: EntityStateConstant.Archived,
+    });
+    const defaultSelectable = ['createdAt', 'updatedAt'];
+    query.orderBy(`${this.entityName}.updatedAt`, 'DESC');
+    const selection = defaultSelectable.map(
+      (column: string) => `${this.entityName}.${column}`,
+    );
+    query.addSelect(selection);
+    if (callback != null) {
+      callback(query);
+    }
+    const { excludeIds = [], includeIds = [] } = { ...filter };
+    // Exclude some ids from the list.
+    if (excludeIds?.length > 0) {
+      query.andWhere(`${this.entityName}.id NOT IN (:ids)`, {
+        ids: excludeIds,
+      });
+    }
+    let entities = await query.getMany();
+    const total = await query.getCount();
+    // Include some ids to the list.
+    const allIds: number[] = [];
+    for (const id of includeIds) {
+      const entity = entities.filter((entity: Entity) => entity.id === id);
+      if (entity.length == 0) {
+        allIds.push(id);
+      }
+    }
+    if (allIds.length > 0) {
+      query.where(`${this.entityName}.id IN (:ids)`, { ids: allIds });
+      const data = await query.getMany();
+      entities = data.concat(entities);
+    }
+    const response = new PaginationResponse(entities, total, limit, offset);
+    return response;
+  }
+}

package/src/index.ts

@@ -1,4 +1,5 @@
-export * from './common';
+export * from './generic';
+export * from './constant';
 export * from './dto';
 export * from './lib';
 export * from './response';

package/src/util/date.util.spec.ts

@@ -0,0 +1,49 @@
+import dayjs from 'dayjs';
+import { addSecond, isExpired } from './date.util';
+
+describe('Utility Functions', () => {
+  test('addSecond should return a Date object with the specified duration added', () => {
+    // Arrange
+    const duration = 10;
+
+    // Act
+    const result = addSecond(duration);
+
+    // Assert
+    const expectedDate = dayjs().add(duration, 'seconds').toDate();
+    expect(result).toEqual(expectedDate);
+  });
+
+  test('isExpired should return true for a past date', () => {
+    // Arrange
+    const pastDate = dayjs().subtract(1, 'day').toDate();
+
+    // Act
+    const result = isExpired(pastDate);
+
+    // Assert
+    expect(result).toBe(true);
+  });
+
+  test('isExpired should return false for a future date', () => {
+    // Arrange
+    const futureDate = dayjs().add(1, 'day').toDate();
+
+    // Act
+    const result = isExpired(futureDate);
+
+    // Assert
+    expect(result).toBe(false);
+  });
+
+  test('isExpired should return false for the current date', () => {
+    // Arrange
+    const currentDate = dayjs().toDate();
+
+    // Act
+    const result = isExpired(currentDate);
+
+    // Assert
+    expect(result).toBe(false);
+  });
+});

package/src/util/date.util.ts

@@ -1 +1,10 @@
-export class Test {}
+import dayjs from 'dayjs';
+
+export const addSecond = (duration: number): Date => {
+  return dayjs().add(duration, 'seconds').toDate();
+};
+
+export const isExpired = (date: Date): boolean => {
+  const currentDate = dayjs();
+  return dayjs(date).isBefore(currentDate);
+};