api key controller, dto, and readme update

Author: andrechristikan

README.md

@@ -15,17 +15,17 @@
 
 # ACK NestJs Boilerplate  🔥 🚀
 
-> Amazon web service will be the cloud provider. This is why this project is focused on AWS features.
+> This repo will representative of authentication service and authorization service
 
 [ACK NestJs][ack] is a [Http NestJs v9.x][ref-nestjs] boilerplate. Best uses for backend service.
 
 *You can [request feature][ack-issues] or [report bug][ack-issues] with following this link*
 
 ## Other Repo
 
-* [Mongoose Mini Version][ack-mongoose] : Mini version
-* [Typeorm Integration][ack-typeorm] : Typeorm integration
-* [Kafka Integration][ack-kafka] : Apache Kafka integration
+* [Mini Version][ack-mongoose] : Mini version
+* [Typeorm Integration][ack-typeorm] : Typeorm integration `(Outdated)`
+* [Kafka Integration][ack-kafka] : Hybrid Between HTTP and Microservice (Apache Kafka Integration)
 
 ## Table of contents
 
@@ -56,40 +56,17 @@
 
 ## Important
 
-> If you want to implement `database transactions`, you must run MongoDB as a `replication set`.
-
-If you change the environment value of `APP_ENV` to `production`, that will trigger.
-
-1. CorsMiddleware will implement `src/configs/middleware.config.ts`.Otherwise is `*`.
-2. Documentation will `disable`.
+* The features will replated with AWS Features
+* If you want to implement `database transactions`, you must run MongoDB as a `replication set`.
+* If you change the environment value of `APP_ENV` to `production`, that will trigger.
+    1. CorsMiddleware will implement `src/configs/middleware.config.ts`.
+    2. Documentation will `disable`.
 
 ## Next Todo
 
 Next development
 
-* [x] Implement Repository Design Pattern / Data Access Object Design Pattern
-* [x] Swagger for API Documentation
-* [x] Mongo Repository soft delete
-* [x] Make it simple
-* [x] Encrypt jwt payload
-* [x] Optimize Unit Testing
-* [x] Make serverless separate repo
-* [x] Optimize Swagger
-* [x] Remove enum endpoint
-* [x] Permission group fixed
-* [x] Reduce the payload of access token
-* [x] Update authorization mechanism, permission token on `x-permission-token`
-* [x] Update package, cors setting, check all interfaces, husky trigger switch to on and check test
-* [x] AuthApiKey mechanism
-* [x] AuthApi Controller
-    * [x] AuthApi Get, Active, Inactive Endpoint
-    * [x] AuthApi Create (Random Key), and Reset Secret Endpoint
-    * [x] AuthApi Controller Test E2E
-* [x] Fix automation testing
-* [x] Pagination move from decorator to service pagination -> make pipe transformer -> wrap into group decorator ResponsePaging
-* [x] Check Swagger for pagination
-* [x] ApiKey add startDate and endDate
-* [x] Make docker port expose be difference with port app
+* Validation guard change to pipe
 * [ ] SSO
     * [ ] Google
     * [ ] Apple
@@ -122,28 +99,29 @@ Describes which version.
 * Component based folder structure
 * Repository Design Pattern or Data Access Layer Design Pattern
 * Support Microservice Architecture, Serverless Architecture, Clean Architecture, and/or Hexagonal Architecture
+* Follow Community Guide Line
 * Follow The Twelve-Factor App
 * Adopt SOLID and KISS principle
 
 ## Features
 
+### Main Features
+
 * NestJs v9.x 🥳
 * Typescript 🚀
 * Production ready 🔥
 * Repository Design Pattern
 * Swagger included
-* Authentication and authorization (`JWT`, `API Key`) 💪
-* Role management system
-* Storage integration with `AwsS3`
-* Upload file `single` and `multipart` to AwsS3
+* Authentication (`Access Token`, `Refresh Token`, `API Key`)
+* Authorization, Role and Permission Management (`PermissionToken`)
 * Support multi-language `i18n` 🗣
 * Request validation with `class-validation`
 * Serialization with `class-transformer`
 * Url Versioning
 * Server Side Pagination, there have 3 of types
 * Import and export data with excel by using `decorator`
 
-## Database
+### Database
 
 * MongoDB integrate by using [mongoose][ref-mongoose] 🎉
 * Multi Database
@@ -171,6 +149,11 @@ Describes which version.
 * Setting from database 🗿
 * Maintenance mode on / off from database 🐤
 
+### Third Party Integration
+
+* Storage integration with `AwsS3`
+* Upload file `single` and `multipart` to AwsS3
+
 ### Others
 
 * Support Docker Installation
@@ -215,7 +198,8 @@ Full structure of module
     ├── pipes
     ├── repository
         ├── entities // database entities
-        └── repositories // database repositories
+        ├── repositories // database repositories
+        └── module1.repository.module.ts
     ├── serializations // response serialization
     ├── services
     ├── tasks // task for cron job
@@ -252,9 +236,11 @@ export interface IResponseMetadata {
 Default response for the response
 
 ```ts
-export interface IResponse {
+export class ResponseDefaultSerialization {
+    statusCode: number;
+    message: string;
     metadata?: IResponseMetadata;
-    [key: string]: any;
+    data?: Record<string, any>;
 }
 ```
 
@@ -263,7 +249,9 @@ export interface IResponse {
 Default response for pagination.
 
 ```ts
-export interface IResponsePaging {
+export class ResponsePagingSerialization {
+    statusCode: number;
+    message: string;
     totalData: number;
     totalPage?: number;
     currentPage?: number;
@@ -301,8 +289,6 @@ The recommended version is the LTS version for every tool and package.
 2. [MongoDB][ref-mongodb]
 3. [Yarn][ref-yarn]
 4. [Git][ref-git]
-5. [Docker][ref-docker]
-6. [Docker-Compose][ref-dockercompose]
 
 ### Clone Repo
 
@@ -390,6 +376,13 @@ yarn start:dev
 
 ### Run Project with Docker
 
+For docker installation, we need more tools to be installed in our instance.
+
+1. [Docker][ref-docker]
+2. [Docker-Compose][ref-dockercompose]
+
+Then run
+
 ```bash
 docker-compose up -d
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ack-nestjs-boilerplate",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "description": "Ack NestJs Boilerplate",
   "repository": {
     "type": "git",

src/common/api-key/controllers/api-key.admin.controller.ts

@@ -35,7 +35,7 @@ import {
 import { ApiKeyCreateDto } from 'src/common/api-key/dtos/api-key.create.dto';
 import { ApiKeyRequestDto } from 'src/common/api-key/dtos/api-key.request.dto';
 import { ApiKeyUpdateDateDto } from 'src/common/api-key/dtos/api-key.update-date.dto';
-import { ApiKeyUpdateNameDto } from 'src/common/api-key/dtos/api-key.update-name.dto';
+import { ApiKeyUpdateDto } from 'src/common/api-key/dtos/api-key.update.dto';
 import { IApiKeyEntity } from 'src/common/api-key/interfaces/api-key.interface';
 import { ApiKeyEntity } from 'src/common/api-key/repository/entities/api-key.entity';
 import { ApiKeyCreateSerialization } from 'src/common/api-key/serializations/api-key.create.serialization';
@@ -262,11 +262,11 @@ export class ApiKeyAdminController {
     @AuthJwtAdminAccessProtected()
     @Put('/update/:apiKey')
     async updateName(
-        @Body() body: ApiKeyUpdateNameDto,
+        @Body() body: ApiKeyUpdateDto,
         @GetApiKey() apiKey: ApiKeyEntity
     ): Promise<IResponse> {
         try {
-            await this.apiKeyService.updateName(apiKey._id, body);
+            await this.apiKeyService.update(apiKey._id, body);
         } catch (err: any) {
             throw new InternalServerErrorException({
                 statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,

src/common/api-key/dtos/api-key.create.dto.ts

@@ -7,7 +7,10 @@ import {
     IsOptional,
     IsString,
     MaxLength,
+    MinLength,
 } from 'class-validator';
+import { MinGreaterThanEqual } from 'src/common/request/validations/request.min-greater-than-equal.validation';
+import { MinDateToday } from 'src/common/request/validations/request.min-date-today.validation';
 
 export class ApiKeyCreateDto {
     @ApiProperty({
@@ -29,6 +32,7 @@ export class ApiKeyCreateDto {
     @IsOptional()
     @Type(() => Date)
     @IsDate()
+    @MinDateToday()
     startDate?: Date;
 
     @ApiProperty({
@@ -40,6 +44,7 @@ export class ApiKeyCreateDto {
     @IsOptional()
     @Type(() => Date)
     @IsDate()
+    @MinGreaterThanEqual('startDate')
     endDate?: Date;
 
     @ApiProperty({
@@ -49,6 +54,7 @@ export class ApiKeyCreateDto {
     })
     @IsOptional()
     @IsString()
+    @MinLength(1)
     @MaxLength(100)
     description?: string;
 }

src/common/api-key/dtos/api-key.update-date.dto.ts

@@ -2,27 +2,31 @@ import { ApiProperty } from '@nestjs/swagger';
 import { faker } from '@faker-js/faker';
 import { IsDate, IsNotEmpty } from 'class-validator';
 import { Type } from 'class-transformer';
+import { MinGreaterThanEqual } from 'src/common/request/validations/request.min-greater-than-equal.validation';
+import { MinDateToday } from 'src/common/request/validations/request.min-date-today.validation';
 
 export class ApiKeyUpdateDateDto {
     @ApiProperty({
         description: 'Api Key start date',
         example: faker.date.recent(),
-        required: true,
-        nullable: false,
+        required: false,
+        nullable: true,
     })
     @IsNotEmpty()
     @Type(() => Date)
     @IsDate()
+    @MinDateToday()
     startDate: Date;
 
     @ApiProperty({
         description: 'Api Key end date',
         example: faker.date.recent(),
-        required: true,
-        nullable: false,
+        required: false,
+        nullable: true,
     })
     @IsNotEmpty()
     @Type(() => Date)
     @IsDate()
+    @MinGreaterThanEqual('startDate')
     endDate: Date;
 }

src/common/api-key/dtos/api-key.update-name.dto.ts

@@ -0,0 +1,7 @@
+import { PickType } from '@nestjs/swagger';
+import { ApiKeyCreateDto } from './api-key.create.dto';
+
+export class ApiKeyUpdateDto extends PickType(ApiKeyCreateDto, [
+    'name',
+    'description',
+] as const) {}

src/common/api-key/dtos/api-key.update.dto.ts

@@ -3,7 +3,7 @@ import {
     ApiKeyCreateRawDto,
 } from 'src/common/api-key/dtos/api-key.create.dto';
 import { ApiKeyUpdateDateDto } from 'src/common/api-key/dtos/api-key.update-date.dto';
-import { ApiKeyUpdateNameDto } from 'src/common/api-key/dtos/api-key.update-name.dto';
+import { ApiKeyUpdateDto } from 'src/common/api-key/dtos/api-key.update.dto';
 import { IApiKeyEntity } from 'src/common/api-key/interfaces/api-key.interface';
 import { ApiKeyEntity } from 'src/common/api-key/repository/entities/api-key.entity';
 import {
@@ -60,9 +60,9 @@ export interface IApiKeyService {
         options?: IDatabaseCreateOptions
     ): Promise<IApiKeyEntity>;
 
-    updateName(
+    update(
         _id: string,
-        data: ApiKeyUpdateNameDto,
+        data: ApiKeyUpdateDto,
         options?: IDatabaseOptions
     ): Promise<ApiKeyEntity>;
 

src/common/api-key/interfaces/api-key.service.interface.ts

@@ -20,7 +20,7 @@ import {
     ApiKeyCreateDto,
     ApiKeyCreateRawDto,
 } from 'src/common/api-key/dtos/api-key.create.dto';
-import { ApiKeyUpdateNameDto } from 'src/common/api-key/dtos/api-key.update-name.dto';
+import { ApiKeyUpdateDto } from 'src/common/api-key/dtos/api-key.update.dto';
 import { ApiKeyUpdateDateDto } from 'src/common/api-key/dtos/api-key.update-date.dto';
 import { HelperDateService } from 'src/common/helper/services/helper.date.service';
 
@@ -161,8 +161,8 @@ export class ApiKeyService implements IApiKeyService {
         dto.isActive = true;
 
         if (startDate && endDate) {
-            dto.startDate = startDate;
-            dto.endDate = endDate;
+            dto.startDate = this.helperDateService.startOfDay(startDate);
+            dto.endDate = this.helperDateService.endOfDay(endDate);
         }
 
         const created: ApiKeyEntity =
@@ -171,12 +171,12 @@ export class ApiKeyService implements IApiKeyService {
         return { ...created, secret };
     }
 
-    async updateName(
+    async update(
         _id: string,
-        data: ApiKeyUpdateNameDto,
+        data: ApiKeyUpdateDto,
         options?: IDatabaseOptions
     ): Promise<ApiKeyEntity> {
-        return this.apiKeyRepository.updateOneById<ApiKeyUpdateNameDto>(
+        return this.apiKeyRepository.updateOneById<ApiKeyUpdateDto>(
             _id,
             data,
             options
@@ -185,12 +185,15 @@ export class ApiKeyService implements IApiKeyService {
 
     async updateDate(
         _id: string,
-        data: ApiKeyUpdateDateDto,
+        { startDate, endDate }: ApiKeyUpdateDateDto,
         options?: IDatabaseOptions
     ): Promise<ApiKeyEntity> {
         return this.apiKeyRepository.updateOneById<ApiKeyUpdateDateDto>(
             _id,
-            data,
+            {
+                startDate: this.helperDateService.startOfDay(startDate),
+                endDate: this.helperDateService.endOfDay(endDate),
+            },
             options
         );
     }

src/common/api-key/services/api-key.service.ts

@@ -331,17 +331,17 @@ describe('ApiKeyService', () => {
         });
     });
 
-    describe('updateName', () => {
+    describe('update', () => {
         it('should return a updated apikey', async () => {
             const nameUpdate = faker.random.alphaNumeric(10);
-            const result: ApiKeyEntity = await apiKeyService.updateName(
+            const result: ApiKeyEntity = await apiKeyService.update(
                 apiKey._id,
                 {
                     name: nameUpdate,
                     description: faker.random.alphaNumeric(20),
                 }
             );
-            jest.spyOn(apiKeyService, 'updateName').mockReturnValueOnce(
+            jest.spyOn(apiKeyService, 'update').mockReturnValueOnce(
                 result as any
             );
 
@@ -360,7 +360,7 @@ describe('ApiKeyService', () => {
                     endDate,
                 }
             );
-            jest.spyOn(apiKeyService, 'updateName').mockReturnValueOnce(
+            jest.spyOn(apiKeyService, 'updateDate').mockReturnValueOnce(
                 result as any
             );