dev4fun-utils 0.0.1 → 0.0.4

package/README.md

@@ -1,98 +1,340 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
-</p>
-
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
-
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
-
-## Description
-
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
-
-## Project setup
+# dev4fun-utils
+
+Thư viện tiện ích cho NestJS với TypeORM base entities, decorators và các công cụ hỗ trợ phổ biến.
+
+## Cài đặt
 
 ```bash
-$ yarn install
+bun add dev4fun-utils
 ```
 
-## Compile and run the project
+hoặc
 
 ```bash
-# development
-$ yarn run start
+npm install dev4fun-utils
+```
+
+## Tính năng
+
+### Base Entities
+
+#### BaseTypeormEntity
+
+Base entity cho TypeORM với các trường tự động:
+- `id`: Primary key tự động tăng
+- `createdAt`: Thời gian tạo (timestamp)
+- `updatedAt`: Thời gian cập nhật (timestamp)
+- `deletedAt`: Thời gian xóa (soft delete, timestamp)
 
-# watch mode
-$ yarn run start:dev
+```typescript
+import { BaseTypeormEntity } from 'dev4fun-utils';
+import { Entity } from 'typeorm';
 
-# production mode
-$ yarn run start:prod
+@Entity()
+export class User extends BaseTypeormEntity {
+  // Các trường của bạn
+}
 ```
 
-## Run tests
+### Base Exception
 
-```bash
-# unit tests
-$ yarn run test
+#### BaseException
+
+Class exception mở rộng từ HttpException với mã lỗi tùy chỉnh:
+
+```typescript
+import { BaseException } from 'dev4fun-utils';
 
-# e2e tests
-$ yarn run test:e2e
+// Sử dụng các exception có sẵn
+throw BaseException.NOT_FOUND;
+throw BaseException.BAD_REQUEST;
+throw BaseException.UNAUTHORIZED;
+throw BaseException.FORBIDDEN;
+throw BaseException.INTERNAL_SERVER_ERROR;
+throw BaseException.SERVICE_UNAVAILABLE;
+throw BaseException.GATEWAY_TIMEOUT;
+throw BaseException.PRECONDITION_FAILED;
+throw BaseException.PAYLOAD_TOO_LARGE;
+throw BaseException.UNPROCESSABLE_ENTITY;
+throw BaseException.TOO_MANY_REQUESTS;
 
-# test coverage
-$ yarn run test:cov
+// Hoặc tạo exception tùy chỉnh
+throw new BaseException('Custom message', 400, 'CUSTOM_ERROR');
 ```
 
-## Deployment
+### Decorators
 
-When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
+#### @Retry
 
-If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
+Thử lại method khi gặp lỗi:
 
-```bash
-$ yarn install -g @nestjs/mau
-$ mau deploy
+```typescript
+import { Retry } from 'dev4fun-utils';
+
+class MyService {
+  @Retry(3, 1000) // Thử lại 3 lần, mỗi lần cách nhau 1 giây
+  async fetchData() {
+    // Code của bạn
+  }
+}
+```
+
+#### @Timeout
+
+Thiết lập timeout cho method:
+
+```typescript
+import { Timeout } from 'dev4fun-utils';
+
+class MyService {
+  @Timeout(5000) // Timeout sau 5 giây
+  async fetchData() {
+    // Code của bạn
+  }
+}
 ```
 
-With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
+#### @Cache
 
-## Resources
+Cache kết quả của method:
+
+```typescript
+import { Cache } from 'dev4fun-utils';
+
+class MyService {
+  @Cache(60000) // Cache trong 60 giây
+  async getData() {
+    // Code của bạn
+  }
+}
+```
 
-Check out a few resources that may come in handy when working with NestJS:
+#### @Watch
 
-- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
-- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
-- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
-- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
-- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
-- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
-- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
-- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+Log thông tin khi method được gọi:
 
-## Support
+```typescript
+import { Watch } from 'dev4fun-utils';
 
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+class MyService {
+  @Watch()
+  async processData(data: any) {
+    // Code của bạn
+  }
+}
+```
+
+#### @Validate và @NonNull
+
+Validate tham số không được null:
+
+```typescript
+import { Validate, NonNull } from 'dev4fun-utils';
+
+class MyService {
+  @Validate()
+  async processData(@NonNull data: string) {
+    // Code của bạn
+  }
+}
+```
 
-## Stay in touch
+### DTOs
 
-- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+#### IdDto
+
+DTO cho ID:
+
+```typescript
+import { IdDto } from 'dev4fun-utils';
+
+class MyController {
+  @Get(':id')
+  async getById(@Param() params: IdDto) {
+    // params.id là number
+  }
+}
+```
+
+#### PageDto
+
+DTO cho phân trang:
+
+```typescript
+import { PageDto } from 'dev4fun-utils';
+
+class MyController {
+  @Get()
+  async getList(@Query() query: PageDto) {
+    // query.page, query.size, query.search, query.sort
+  }
+}
+```
+
+#### TimeDto
+
+DTO cho khoảng thời gian:
+
+```typescript
+import { TimeDto } from 'dev4fun-utils';
+
+class MyController {
+  @Get()
+  async getByTime(@Query() query: TimeDto) {
+    // query.startDate, query.endDate
+  }
+}
+```
+
+### Structs
+
+#### Page
+
+Struct cho phân trang với TypeORM:
+
+```typescript
+import { Page, PageDto } from 'dev4fun-utils';
+import { SelectQueryBuilder } from 'typeorm';
+
+async function getUsers(dto: PageDto) {
+  const page = new Page(dto, 0);
+  page.queryBuilder = userRepository.createQueryBuilder('user');
+  await page.execute();
+  return page; // page.data, page.total, page.totalPages, etc.
+}
+```
+
+#### Batch
+
+Xử lý dữ liệu theo batch:
+
+```typescript
+import { Batch } from 'dev4fun-utils';
+
+const batch = Batch.fromArray([1, 2, 3, 4, 5], 2); // Chia thành batch 2 phần tử
+
+await batch.runAsync(async (items, index) => {
+  console.log(`Batch ${index}:`, items);
+}, false, 1000); // Chạy tuần tự, delay 1 giây giữa các batch
+```
+
+#### Queue
+
+Hàng đợi (FIFO):
+
+```typescript
+import { Queue } from 'dev4fun-utils';
+
+const queue = Queue.fromArray([1, 2, 3]);
+
+queue.enqueue(4); // Thêm vào cuối
+const item = queue.dequeue(); // Lấy phần tử đầu tiên
+const peek = queue.peek(); // Xem phần tử đầu tiên không xóa
+```
+
+#### Stack
+
+Ngăn xếp (LIFO):
+
+```typescript
+import { Stack } from 'dev4fun-utils';
+
+const stack = Stack.fromArray([1, 2, 3]);
+
+stack.push(4); // Thêm vào đầu
+const item = stack.pop(); // Lấy phần tử đầu tiên
+const top = stack.top(); // Xem phần tử đầu tiên không xóa
+```
+
+#### Tree
+
+Cấu trúc cây:
+
+```typescript
+import { Tree, TreeNode } from 'dev4fun-utils';
+
+const tree = new Tree('root');
+const node1 = tree.addNode('node1');
+const node2 = tree.addNode('node2');
+
+node1.addChild(new TreeNode('child1', node1));
+```
+
+### Utils
+
+#### MethodUtil
+
+Các tiện ích cho method:
+
+```typescript
+import { MethodUtil } from 'dev4fun-utils';
+
+// Delay
+await MethodUtil.delay(1000); // Delay 1 giây
+
+// Execute với timeout
+await MethodUtil.executeWithTimeout(promise, 5000);
+
+// Execute với retry
+await MethodUtil.executeWithRetry(promise, 3, 1000);
+
+// Execute command
+const output = await MethodUtil.cmdExecute('ls -la');
+```
+
+#### NumberUtil
+
+Các tiện ích cho số:
+
+```typescript
+import { NumberUtil } from 'dev4fun-utils';
+
+// Random integer
+const num = NumberUtil.nextInt(1, 100);
+
+// Random float
+const float = NumberUtil.nextFloat(0, 1);
+
+// Format VND
+const formatted = NumberUtil.formatVND(1000000); // "1,000,000"
+```
+
+#### StringUtil
+
+Các tiện ích cho chuỗi:
+
+```typescript
+import { StringUtil } from 'dev4fun-utils';
+
+// Hash password
+const hash = await StringUtil.hashValue('password', 16);
+
+// Verify hash
+const isValid = await StringUtil.verifyHash('password', hash);
+
+// Random string
+const random = StringUtil.randomString(10);
+```
+
+## Module
+
+Import CommonModule vào ứng dụng NestJS của bạn:
+
+```typescript
+import { CommonModule } from 'dev4fun-utils';
+import { Module } from '@nestjs/common';
+
+@Module({
+  imports: [CommonModule],
+})
+export class AppModule {}
+```
 
 ## License
 
-Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
+MIT
+
+## Author
+
+Nguyen Chau Tuan
+

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "dev4fun-utils",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "Utility package for NestJS with TypeORM base entities and common decorators",
-  "author": "",
+  "author": "Nguyen Chau Tuan",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,30 +19,22 @@
   ],
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "https://github.com/nctuanit/dev4fun-utils"
   },
   "scripts": {
     "build": "nest build",
-    "prepublishOnly": "npm run 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"
+    "publish": "npm run build && npm version patch && bun publish --access public",
+    "version": "node updateversion.js"
   },
   "dependencies": {
     "@nestjs/common": "^11.0.1",
     "@nestjs/core": "^11.0.1",
     "@nestjs/platform-express": "^11.0.1",
     "@nestjs/swagger": "^11.2.3",
+    "argon2": "^0.44.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.3",
+    "hashids": "^2.3.0",
     "pg": "^8.16.3",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.1",

package/dist/common/base/base.typeorm.d.ts

@@ -1,9 +0,0 @@
-export declare abstract class BaseTypeormEntity {
-    readonly id: number;
-    readonly createdAt: number;
-    readonly updatedAt: number;
-    readonly deletedAt?: number;
-    static IsEntity(): boolean;
-    constructor(data?: Partial<BaseTypeormEntity>);
-    addJson(data: Partial<this>): void;
-}

package/dist/common/base/base.typeorm.js

@@ -1,75 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseTypeormEntity = void 0;
-const typeorm_1 = require("typeorm");
-const class_validator_1 = require("class-validator");
-const swagger_1 = require("@nestjs/swagger");
-const class_transformer_1 = require("class-transformer");
-class BaseTypeormEntity {
-    id;
-    createdAt;
-    updatedAt;
-    deletedAt;
-    static IsEntity() {
-        return true;
-    }
-    constructor(data) {
-        if (data) {
-            Object.assign(this, data);
-        }
-    }
-    addJson(data) {
-        Object.assign(this, data);
-    }
-}
-exports.BaseTypeormEntity = BaseTypeormEntity;
-__decorate([
-    (0, typeorm_1.PrimaryGeneratedColumn)(),
-    (0, class_validator_1.IsNumber)(),
-    (0, class_validator_1.Min)(0),
-    (0, swagger_1.ApiProperty)({
-        description: 'The id of the entity',
-        example: 1,
-    }),
-    __metadata("design:type", Number)
-], BaseTypeormEntity.prototype, "id", void 0);
-__decorate([
-    (0, typeorm_1.CreateDateColumn)({ type: 'timestamp' }),
-    (0, swagger_1.ApiProperty)({
-        description: 'The creation date of the entity',
-        example: Date.now(),
-        type: Number,
-    }),
-    (0, class_transformer_1.Transform)(({ value }) => value ? new Date(value).getTime() : null),
-    __metadata("design:type", Number)
-], BaseTypeormEntity.prototype, "createdAt", void 0);
-__decorate([
-    (0, typeorm_1.UpdateDateColumn)({ type: 'timestamp' }),
-    (0, swagger_1.ApiProperty)({
-        description: 'The update date of the entity',
-        example: Date.now(),
-        type: Number,
-    }),
-    (0, class_transformer_1.Transform)(({ value }) => value ? new Date(value).getTime() : null),
-    __metadata("design:type", Number)
-], BaseTypeormEntity.prototype, "updatedAt", void 0);
-__decorate([
-    (0, typeorm_1.DeleteDateColumn)({ type: 'timestamp' }),
-    (0, swagger_1.ApiProperty)({
-        description: 'The deletion date of the entity',
-        example: Date.now(),
-        type: Number,
-    }),
-    (0, class_transformer_1.Transform)(({ value }) => value ? new Date(value).getTime() : null),
-    __metadata("design:type", Number)
-], BaseTypeormEntity.prototype, "deletedAt", void 0);
-//# sourceMappingURL=base.typeorm.js.map

package/dist/common/base/base.typeorm.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"base.typeorm.js","sourceRoot":"","sources":["../../../src/common/base/base.typeorm.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAAuH;AACvH,qDAA4D;AAC5D,6CAA8C;AAC9C,yDAA8C;AAE9C,MAAsB,iBAAiB;IAQ1B,EAAE,CAAS;IASX,SAAS,CAAS;IASlB,SAAS,CAAS;IASlB,SAAS,CAAU;IAE5B,MAAM,CAAC,QAAQ;QACX,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,YAAY,IAAiC;QACzC,IAAI,IAAI,EAAE,CAAC;YACP,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC;IACL,CAAC;IAED,OAAO,CAAC,IAAmB;QACvB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9B,CAAC;CACJ;AAlDD,8CAkDC;AA1CY;IAPR,IAAA,gCAAsB,GAAE;IACxB,IAAA,0BAAQ,GAAE;IACV,IAAA,qBAAG,EAAC,CAAC,CAAC;IACN,IAAA,qBAAW,EAAC;QACT,WAAW,EAAE,sBAAsB;QACnC,OAAO,EAAE,CAAC;KACb,CAAC;;6CACkB;AASX;IAPR,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IACvC,IAAA,qBAAW,EAAC;QACT,WAAW,EAAE,iCAAiC;QAC9C,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;QACnB,IAAI,EAAE,MAAM;KACf,CAAC;IACD,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;;oDACxC;AASlB;IAPR,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IACvC,IAAA,qBAAW,EAAC;QACT,WAAW,EAAE,+BAA+B;QAC5C,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;QACnB,IAAI,EAAE,MAAM;KACf,CAAC;IACD,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;;oDACxC;AASlB;IAPR,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IACvC,IAAA,qBAAW,EAAC;QACT,WAAW,EAAE,iCAAiC;QAC9C,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE;QACnB,IAAI,EAAE,MAAM;KACf,CAAC;IACD,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;;oDACvC"}

package/dist/index.d.ts

@@ -1 +0,0 @@
-export * from './common/base/base.typeorm';

package/dist/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./common/base/base.typeorm"), exports);
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6DAA2C"}