xcally-nest-library 0.0.28 → 0.0.30

package/index.ts

@@ -1,3 +1,9 @@
 export * from './src/modules/logger/pino/logger.service';
 export * from './src/modules/logger/pino/logger.module';
 export * from './src/modules/logger/pino/logger.default';
+export * from './src/core/application/base.interface';
+export * from './src/core/application/base.service';
+export * from './src/core/domain/interfaces/base.repository.interface';
+export * from './src/core/infrastracture/databases/base.entity';
+export * from './src/core/infrastracture/databases/base.entity.interface';
+export * from './src/core/infrastracture/databases/base.repository';

package/package.json

@@ -1,32 +1,23 @@
 {
   "name": "xcally-nest-library",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "",
   "license": "UNLICENSED",
-  "scripts": {
-    "bump:patch": "npm version patch -m \"Bump version to %s\"",
-    "prepublishOnly": "npm run build",
-    "build": "tsc",
-    "build:watch": "rimraf dist && tsc-watch -b -v",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "prettier:check": "prettier --check ./**/*.{ts,js,json,*rc}",
-    "prettier:write": "prettier --write ./**/*.{ts,js,json,*rc}",
-    "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",
-    "lib:link": "pnpm link --global",
-    "lib:unlink": "pnpm unlink xcally-nest-libs --global"
-  },
   "dependencies": {
     "@nestjs/common": "^11.0.7",
     "@nestjs/config": "^4.0.0",
     "@nestjs/core": "^11.0.7",
-    "nestjs-pino": "^4.3.0"
+    "@nestjs/microservices": "^11.0.9",
+    "class-transformer": "^0.5.1",
+    "nestjs-grpc-exceptions": "^0.2.2",
+    "nestjs-paginate": "^11.0.0",
+    "nestjs-pino": "^4.3.0",
+    "pino": "^9.6.0",
+    "pino-pretty": "^13.0.0",
+    "typeorm": "^0.3.20"
   },
   "devDependencies": {
     "@nestjs/cli": "^11.0.2",
@@ -41,5 +32,20 @@
     "ts-node": "^10.9.2",
     "tsc-watch": "^6.2.1",
     "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "bump:patch": "npm version patch -m \"Bump version to %s\"",
+    "build": "tsc",
+    "build:watch": "rimraf dist && tsc-watch -b -v",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "prettier:check": "prettier --check ./**/*.{ts,js,json,*rc}",
+    "prettier:write": "prettier --write ./**/*.{ts,js,json,*rc}",
+    "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",
+    "lib:link": "pnpm link --global",
+    "lib:unlink": "pnpm unlink xcally-nest-libs --global"
   }
-}
+}

package/src/core/application/base.interface.ts

@@ -0,0 +1,16 @@
+import { Paginated, PaginateQuery } from 'nestjs-paginate';
+
+export interface IBaseService<
+  Entity,
+  CreateMessage extends Partial<Entity>,
+  UpdateMessage extends Partial<Entity> & { id: number },
+  Message,
+> {
+  findOne(id: number): Promise<Message>;
+  findAll(): Promise<{ data: Message[] }>;
+  getMany(query?: PaginateQuery): Promise<Paginated<Message>>;
+  create(createDTO: CreateMessage): Promise<Message>;
+  update(updateDTO: UpdateMessage): Promise<Message>;
+  remove(id: number): Promise<void>;
+  count(options?: any): Promise<{ count: number }>;
+}

package/src/core/application/base.service.ts

@@ -0,0 +1,97 @@
+import { GrpcNotFoundException } from 'nestjs-grpc-exceptions';
+import { Paginated, PaginateQuery } from 'nestjs-paginate';
+import { IBaseRepository } from '@domain/interfaces/base.repository.interface';
+import { instanceToPlain } from 'class-transformer';
+import { IBaseService } from './base.interface';
+
+export class BaseService<
+  Entity,
+  CreateMessage extends Partial<Entity>,
+  UpdateMessage extends Partial<Entity> & { id: number },
+  Message,
+> implements IBaseService<Entity, CreateMessage, UpdateMessage, Message>
+{
+  constructor(private readonly repository: IBaseRepository<Entity>) {}
+
+  /**
+   * Finds a single entity by its ID.
+   * @param id - The ID of the entity to find.
+   * @returns A promise that resolves to the mapped message.
+   * @throws GrpcNotFoundException if the entity is not found.
+   */
+  async findOne(id: number): Promise<Message> {
+    const entity = await this.repository.findById(id);
+    if (!entity) {
+      throw new GrpcNotFoundException(`${this.constructor.name.replace('Service', '')} not found`);
+    }
+    return entity as Message;
+  }
+
+  /**
+   * Retrieves all entities.
+   * @returns A promise that resolves to an object containing an array of mapped messages.
+   */
+  async findAll(): Promise<{ data: Message[] }> {
+    const entities: Entity[] = await this.repository.find();
+    return {
+      data: entities as unknown as Message[],
+    };
+  }
+
+  /**
+   * Retrieves paginated entities based on the provided query.
+   * @param query - Pagination and filter criteria.
+   * @returns A promise that resolves to the paginated result with rows and count.
+   */
+  async getMany(query?: PaginateQuery): Promise<Paginated<Message>> {
+    const entities: Paginated<Entity> = await this.repository.getMany(query);
+    return entities as unknown as Paginated<Message>;
+  }
+
+  /**
+   * Creates a new entity from the provided DTO.
+   * @param createDTO - The data transfer object for creating an entity.
+   * @returns A promise that resolves to the mapped message of the created entity.
+   */
+  async create(createDTO: CreateMessage): Promise<Message> {
+    const plain = instanceToPlain(createDTO);
+    const entity = this.repository.create(plain as Entity);
+    await this.repository.save(entity);
+    return entity as unknown as Message;
+  }
+
+  /**
+   * Updates an existing entity with the provided DTO.
+   * @param updateDTO - The data transfer object for updating an entity.
+   * @returns A promise that resolves to the mapped message of the updated entity.
+   * @throws GrpcNotFoundException if the entity is not found.
+   */
+  async update(updateDTO: UpdateMessage): Promise<Message> {
+    const entity = await this.repository.findById(updateDTO.id);
+    if (!entity) {
+      throw new GrpcNotFoundException(`${this.constructor.name.replace('Service', '')} not found`);
+    }
+    await this.repository.update(updateDTO.id, instanceToPlain(updateDTO) as any);
+    const updatedEntity: Entity = await this.repository.findById(updateDTO.id);
+    return updatedEntity as unknown as Message;
+  }
+
+  /**
+   * Deletes an entity by its ID.
+   * @param id - The ID of the entity to delete.
+   * @returns A promise that resolves when the entity is deleted.
+   */
+  async remove(id: number): Promise<void> {
+    await this.repository.delete(id);
+  }
+
+  /**
+   * Counts all entities.
+   * @param options - Optional query options for counting entities.
+   * @returns A promise that resolves to an object containing the count.
+   */
+  async count(options?: any): Promise<{ count: number }> {
+    const count = await this.repository.count(options || {});
+    return { count };
+  }
+}

package/src/core/domain/interfaces/base.repository.interface.ts

@@ -0,0 +1,11 @@
+import { PaginateQuery, Paginated } from 'nestjs-paginate';
+import { Repository } from 'typeorm';
+export interface IId {
+  id: number;
+}
+
+export interface IBaseRepository<E> extends Repository<E> {
+  getMany(query: PaginateQuery): Promise<Paginated<E>>;
+  findById(id: number): Promise<E>;
+  find(options?: any): Promise<E[]>;
+}

package/src/core/infrastracture/databases/base.entity.interface.ts

@@ -0,0 +1,5 @@
+export interface IBaseEntity {
+  id: number;
+  createdAt: Date;
+  updatedAt: Date;
+}

package/src/core/infrastracture/databases/base.entity.ts

@@ -0,0 +1,44 @@
+import { CreateDateColumn, PrimaryGeneratedColumn, UpdateDateColumn, UpdateEvent } from 'typeorm';
+import { EntitySubscriberInterface, EventSubscriber, InsertEvent } from 'typeorm';
+import { IBaseEntity } from './base.entity.interface';
+
+export class BaseEntity implements IBaseEntity {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @CreateDateColumn({
+    type: 'datetime',
+  })
+  createdAt: Date;
+
+  @UpdateDateColumn({
+    type: 'datetime',
+  })
+  updatedAt: Date;
+}
+
+@EventSubscriber()
+export class BaseEntitySubscriber implements EntitySubscriberInterface<BaseEntity> {
+  /**
+   * Indicates that this subscriber only listens to YourEntity events.
+   */
+  public listenTo() {
+    return BaseEntity;
+  }
+
+  /**
+   * Called before entity insertion.
+   */
+  public beforeInsert(event: InsertEvent<BaseEntity>) {
+    const now = new Date();
+    now.setMilliseconds((now.getMilliseconds() + 1) % 1000);
+    event.entity.createdAt = now;
+    event.entity.updatedAt = now;
+  }
+
+  public beforeUpdate(event: UpdateEvent<BaseEntity>): void | Promise<any> {
+    const now = new Date();
+    now.setMilliseconds((now.getMilliseconds() + 1) % 1000);
+    event.entity.updatedAt = now;
+  }
+}

package/src/core/infrastracture/databases/base.repository.ts

@@ -0,0 +1,53 @@
+import { Repository, EntityManager, Equal, FindOptionsWhere, ObjectLiteral } from 'typeorm';
+import { PaginateConfig, PaginateQuery, Paginated, paginate } from 'nestjs-paginate';
+import { IBaseRepository } from '@domain/interfaces/base.repository.interface';
+
+/**
+ * Represents a generic repository for managing entities.
+ */
+export class BaseRepository<E extends ObjectLiteral> extends Repository<E> implements IBaseRepository<E> {
+  protected paginateConfig: PaginateConfig<E>;
+
+  constructor(manager: EntityManager, entityCls: new () => E, paginateConfig?: PaginateConfig<E>) {
+    super(entityCls, manager);
+    this.paginateConfig = paginateConfig || {
+      sortableColumns: [],
+    };
+  }
+
+  /**
+   * Retrieves a paginated list of entities based on the provided query.
+   *
+   * @param query - The pagination query parameters.
+   * @returns A promise that resolves to a paginated list of entities.
+   */
+  async getMany(query: PaginateQuery): Promise<Paginated<E>> {
+    if (query.select) {
+      if (typeof query.select === 'string') {
+        const selectArray = (query.select as string).split(',');
+        if (!selectArray.includes('id')) {
+          selectArray.unshift('id');
+          query.select = selectArray;
+        }
+        // query.select = selectArray.join(',');
+      } else if (Array.isArray(query.select)) {
+        if (!query.select.includes('id')) {
+          query.select.unshift('id');
+        }
+      }
+    }
+    return paginate(query, this, this.paginateConfig);
+  }
+
+  /**
+   * Retrieves an entity from the database based on its ID.
+   *
+   * @param id - The ID of the entity to retrieve.
+   * @returns A promise that resolves to the retrieved entity.
+   */
+  async findById(id: number): Promise<E> {
+    return await this.findOneBy({
+      id: Equal(id),
+    } as unknown as FindOptionsWhere<E>);
+  }
+}

package/tsconfig.json

@@ -16,6 +16,22 @@
     "noImplicitAny": false,
     "strictBindCallApply": false,
     "forceConsistentCasingInFileNames": false,
-    "noFallthroughCasesInSwitch": false
+    "noFallthroughCasesInSwitch": false,
+    "paths": {
+      "@/*": ["./src/*"],
+      "@interfaces-pb/*": ["./interfaces-pb/*"],
+      "@filters/*": ["./src/lib/filters/*"],
+      "@interceptors/*": ["./src/lib/interceptors/*"],
+      "@guards/*": ["./src/lib/guards/*"],
+      "@decorators/*": ["./src/lib/decorators/*"],
+      "@misc/*": ["./src/lib/misc/*"],
+      "@lib/*": ["./src/lib/*"],
+      "@infrastructure/*": ["./src/core/infrastructure/*"],
+      "@application/*": ["./src/core/application/*"],
+      "@presentation/*": ["./src/core/presentation/*"],
+      "@domain/*": ["./src/core/domain/*"],
+      "@bootstrap/*": ["./src/bootstrap/*"],
+      "@interfaces/*": ["./src/interfaces/*"]
+    }
   }
 }