@koalarx/nest-cli 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Igor D. Rangel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# @koalarx/nest-cli
+
+Biblioteca de CLI para criação de projetos utilizando Koala Nest
+
+## Instalação
+
+```bash
+npm i -g @koalarx/nest-cli
+```
+
+> Versão do Node >= 20.18.0
+
+## Uso
+
+```bash
+koala-nest new app-demo
+```

package/code-base/startup-project/.gitattributes

@@ -0,0 +1 @@
+eol=lf

package/code-base/startup-project/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Igor D. Rangel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/code-base/startup-project/README.md

@@ -0,0 +1,5 @@
+<p align="center">
+  <a href="https://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
+</p>
+
+<h1 align="center">[projectName]</h1>

package/code-base/startup-project/eslint.config.mjs

@@ -0,0 +1,22 @@
+import js from "@eslint/js";
+import { defineConfig } from "eslint/config";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default defineConfig([
+  { files: ["**/*.{js,mjs,cjs,ts}"] },
+  { files: ["**/*.{js,mjs,cjs,ts}"], languageOptions: { globals: globals.node } },
+  { files: ["**/*.{js,mjs,cjs,ts}"], plugins: { js }, extends: ["js/recommended"] },
+  tseslint.configs.recommended,
+  { ignores: ["node_modules", "dist"] },
+  {
+    rules: {
+      "@typescript-eslint/ban-ts-comment": "off",
+      "@typescript-eslint/no-unused-vars": "off",
+      "@typescript-eslint/no-unsafe-function-type": "off",
+      "@typescript-eslint/no-useless-constructor": "off",
+      "@typescript-eslint/no-new": "off",
+      "@typescript-eslint/no-explicit-any": "off"
+    }
+  }
+]);

package/code-base/startup-project/nest-cli.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "monorepo": true,
+  "projects": {
+    "koala-nest": {
+      "type": "library",
+      "root": "apps/koala-nest",
+      "entryFile": "index",
+      "sourceRoot": "apps/koala-nest/src",
+      "compilerOptions": {
+        "tsConfigPath": "apps/koala-nest/tsconfig.lib.json"
+      }
+    },
+    "example": {
+      "type": "application",
+      "root": "apps/example",
+      "entryFile": "example/src/infra/main",
+      "sourceRoot": "apps/example/src",
+      "compilerOptions": {
+        "deleteOutDir": true,
+        "tsConfigPath": "apps/example/tsconfig.app.json",
+        "plugins": [
+          {
+            "name": "@nestjs/swagger",
+            "options": {
+              "classValidatorShim": false,
+              "introspectComments": true
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/code-base/startup-project/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "demo",
+  "version": "1.0.0",
+  "description": "",
+  "author": "",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "nest build",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:e2e": "vitest run --config ./vitest.config.e2e.mts",
+    "test:all": "npm run test && npm run test:e2e"
+  },
+  "dependencies": {
+    "@koalarx/utils": "3.1.3",
+    "@nestjs/common": "11.0.12",
+    "@nestjs/config": "4.0.1",
+    "@nestjs/core": "11.0.12",
+    "@nestjs/mapped-types": "2.1.0",
+    "@nestjs/platform-express": "11.0.12",
+    "@nestjs/swagger": "11.0.7",
+    "@prisma/client": "6.5.0",
+    "@scalar/nestjs-api-reference": "0.4.2",
+    "cookie-parser": "1.4.6",
+    "dotenv": "16.0.3",
+    "express-basic-auth": "1.2.1",
+    "ioredis": "5.3.2",
+    "reflect-metadata": "0.1.13",
+    "rimraf": "3.0.2",
+    "zod": "3.22.4",
+    "zod-validation-error": "1.5.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.23.0",
+    "@faker-js/faker": "^9.6.0",
+    "@nestjs/cli": "11.0.5",
+    "@nestjs/schematics": "10.0.2",
+    "@nestjs/testing": "11.0.12",
+    "@types/cookie-parser": "1.4.8",
+    "@types/express": "5.0.1",
+    "@types/jest": "29.5.14",
+    "@types/node": "22.13.11",
+    "@types/supertest": "6.0.2",
+    "@typescript-eslint/eslint-plugin": "8.27.0",
+    "@typescript-eslint/parser": "8.27.0",
+    "@vitest/coverage-v8": "3.0.9",
+    "eslint": "9.23.0",
+    "eslint-config-prettier": "10.1.1",
+    "eslint-plugin-prettier": "5.2.3",
+    "eslint-plugin-vitest": "0.5.4",
+    "eslint-plugin-vitest-globals": "1.5.0",
+    "globals": "16.0.0",
+    "prettier": "3.5.3",
+    "prisma": "6.5.0",
+    "source-map-support": "0.5.20",
+    "supertest": "7.1.0",
+    "tsconfig-paths": "4.2.0",
+    "typescript": "5.1.3",
+    "typescript-eslint": "8.27.0",
+    "unplugin-swc": "1.5.1",
+    "vite-tsconfig-paths": "5.1.4",
+    "vitest": "3.0.9"
+  }
+}

package/code-base/startup-project/prisma/schema.prisma

@@ -0,0 +1,30 @@
+generator client {
+  provider      = "prisma-client-js"
+  binaryTargets = ["native", "linux-musl"]
+}
+
+datasource db {
+  provider  = "postgresql"
+  url       = env("DATABASE_URL")
+  directUrl = env("DIRECT_URL")
+}
+
+model Person {
+  id     Int     @id @default(autoincrement())
+  name   String
+  active Boolean @default(true)
+
+  phones PersonPhone[]
+
+  @@map("person")
+}
+
+model PersonPhone {
+  id    Int    @id @default(autoincrement())
+  phone String
+
+  personId Int    @map("person_id")
+  person   Person @relation(fields: [personId], references: [id], onDelete: Cascade)
+
+  @@map("person_phone")
+}

package/code-base/startup-project/src/application/person/create/create-person.handler.spec.ts

@@ -0,0 +1,22 @@
+import { createUnitTestApp } from "@/test/create-unit-test-app"
+import { createPersonRequestMockup } from "@/test/mockup/person/create-person-request.mockup"
+import { CreatePersonHandler } from "./create-person.handler"
+
+describe('CreatePersonHandler', () => {
+  const app = createUnitTestApp()
+
+  it('should create a person', async () => {
+    const handler = app.get(CreatePersonHandler)
+    const request = createPersonRequestMockup
+
+    const result = await handler.handle(request)
+    
+    expect(result.isOk()).toBeTruthy()
+
+    if (result.isOk()) {
+      expect(result.value).toEqual({
+        id: expect.any(Number)
+      })
+    }
+  })
+})

package/code-base/startup-project/src/application/person/create/create-person.handler.ts

@@ -0,0 +1,39 @@
+import { Person } from '@/domain/entities/person/person'
+import { IPersonRepository } from '@/domain/repositories/iperson.repository'
+import { AutoMappingService } from '@koalarx/nest/core/mapping/auto-mapping.service'
+import { RequestHandlerBase } from '@koalarx/nest/core/request-overflow/request-handler.base'
+import {
+  ok,
+  RequestResult,
+} from '@koalarx/nest/core/request-overflow/request-result'
+import { Injectable } from '@nestjs/common'
+import { CreatePersonRequest } from './create-person.request'
+import { CreatePersonResponse } from './create-person.response'
+import { CreatePersonValidator } from './create-person.validator'
+
+@Injectable()
+export class CreatePersonHandler extends RequestHandlerBase<
+  CreatePersonRequest,
+  RequestResult<Error, CreatePersonResponse>
+> {
+  constructor(
+    private readonly mapper: AutoMappingService,
+    private readonly repository: IPersonRepository,
+  ) {
+    super()
+  }
+
+  async handle(
+    req: CreatePersonRequest,
+  ): Promise<RequestResult<Error, CreatePersonResponse>> {
+    const person = this.mapper.map(
+      new CreatePersonValidator(req).validate(),
+      CreatePersonRequest,
+      Person,
+    )
+
+    const result = await this.repository.save(person)
+
+    return ok({ id: result.id })
+  }
+}

package/code-base/startup-project/src/application/person/create/create-person.request.ts

@@ -0,0 +1,18 @@
+import { AutoMap } from '@koalarx/nest/core/mapping/auto-mapping.decorator'
+import { ApiProperty } from '@nestjs/swagger'
+
+export class CreatePersonPhoneRequest {
+  @ApiProperty()
+  @AutoMap()
+  phone: string
+}
+
+export class CreatePersonRequest {
+  @ApiProperty()
+  @AutoMap()
+  name: string
+
+  @ApiProperty({ type: [CreatePersonPhoneRequest] })
+  @AutoMap({ type: CreatePersonPhoneRequest, isArray: { addTo: true } })
+  phones: Array<CreatePersonPhoneRequest>
+}

package/code-base/startup-project/src/application/person/create/create-person.response.ts

@@ -0,0 +1,3 @@
+import { CreatedRegistreResponseBase } from '@koalarx/nest/core/controllers/created-registre-response.base'
+
+export class CreatePersonResponse extends CreatedRegistreResponseBase<number> {}

package/code-base/startup-project/src/application/person/create/create-person.validator.ts

@@ -0,0 +1,16 @@
+import { RequestValidatorBase } from '@koalarx/nest/core/request-overflow/request-validator.base'
+import { CreatePersonRequest } from './create-person.request'
+import { z, ZodType, ZodTypeDef } from 'zod'
+
+export class CreatePersonValidator extends RequestValidatorBase<CreatePersonRequest> {
+  protected get schema(): ZodType<any, ZodTypeDef, any> {
+    return z.object({
+      name: z.string(),
+      phones: z.array(
+        z.object({
+          phone: z.string(),
+        }),
+      ),
+    })
+  }
+}

package/code-base/startup-project/src/application/person/create-person-job/create-person-job.ts

@@ -0,0 +1,57 @@
+import { IPersonRepository } from '@/domain/repositories/iperson.repository'
+import {
+  CronJob,
+  CronJobResponse,
+} from '@koalarx/nest/core/backgroud-services/cron-service/cron-job'
+import { EventQueue } from '@koalarx/nest/core/backgroud-services/event-service/event-queue'
+import { ok } from '@koalarx/nest/core/request-overflow/request-result'
+import { ILoggingService } from '@koalarx/nest/services/logging/ilogging.service'
+import { IRedLockService } from '@koalarx/nest/services/redlock/ired-lock.service'
+import { Injectable } from '@nestjs/common'
+import { CreatePersonHandler } from '../create/create-person.handler'
+import { InactivePersonEvent } from '../events/inactive-person/inactive-person-event'
+import { PersonEventJob } from '../events/person-event.job'
+
+@Injectable()
+export class CreatePersonJob extends CronJob {
+  constructor(
+    redlockService: IRedLockService,
+    loggingService: ILoggingService,
+    private readonly createPerson: CreatePersonHandler,
+    private readonly repository: IPersonRepository,
+  ) {
+    super(redlockService, loggingService)
+  }
+
+  protected async run(): Promise<CronJobResponse> {
+    const result = await this.createPerson.handle({
+      name: 'John Doe',
+      phones: [{phone: '22999999999'}],
+    })
+
+    if (result.isOk()) {
+      const person = await this.repository.read(result.value.id)
+
+      if (person) {
+        const jobs = new PersonEventJob()
+        jobs.addEvent(new InactivePersonEvent())
+
+        EventQueue.dispatchEventsForAggregate(jobs._id)
+      }
+
+      console.log('Person created with id:', result.value.id)
+    } else {
+      console.error('Error creating person:', result.value)
+    }
+
+    return ok(null)
+  }
+
+  protected async isActive(): Promise<boolean> {
+    return true
+  }
+
+  protected defineTimeInMinutes(): number {
+    return 1
+  }
+}

package/code-base/startup-project/src/application/person/delete/delete-person.handler.spec.ts

@@ -0,0 +1,24 @@
+import { createUnitTestApp } from "@/test/create-unit-test-app"
+import { createPersonRequestMockup } from "@/test/mockup/person/create-person-request.mockup"
+import { CreatePersonHandler } from "../create/create-person.handler"
+import { DeletePersonHandler } from "./delete-person.handler"
+
+describe('DeletePersonHandler', () => {
+  const app = createUnitTestApp()
+
+  it('should delete a person', async () => {
+    const createResult = await app
+      .get(CreatePersonHandler)
+      .handle(createPersonRequestMockup)
+    
+    expect(createResult.isOk()).toBeTruthy()
+
+    if (createResult.isOk()) {
+      const result = await app
+        .get(DeletePersonHandler)
+        .handle(createResult.value.id)
+
+      expect(result.isOk()).toBeTruthy()
+    }
+  })
+})

package/code-base/startup-project/src/application/person/delete/delete-person.handler.ts

@@ -0,0 +1,33 @@
+import { IPersonRepository } from '@/domain/repositories/iperson.repository'
+import { ResourceNotFoundError } from '@koalarx/nest/core/errors/resource-not-found.error'
+import { RequestHandlerBase } from '@koalarx/nest/core/request-overflow/request-handler.base'
+import {
+  failure,
+  ok,
+  RequestResult,
+} from '@koalarx/nest/core/request-overflow/request-result'
+import { Injectable } from '@nestjs/common'
+
+@Injectable()
+export class DeletePersonHandler extends RequestHandlerBase<
+  number,
+  RequestResult<ResourceNotFoundError, null>
+> {
+  constructor(private readonly repository: IPersonRepository) {
+    super()
+  }
+
+  async handle(
+    id: number,
+  ): Promise<RequestResult<ResourceNotFoundError, null>> {
+    const person = await this.repository.read(id)
+
+    if (!person) {
+      return failure(new ResourceNotFoundError('Pessoa'))
+    }
+
+    await this.repository.delete(id)
+
+    return ok(null)
+  }
+}

package/code-base/startup-project/src/application/person/delete-inative-job/delete-inactive-job.ts

@@ -0,0 +1,49 @@
+import {
+  CronJob,
+  CronJobResponse,
+} from '@koalarx/nest/core/backgroud-services/cron-service/cron-job'
+import { ok } from '@koalarx/nest/core/request-overflow/request-result'
+import { ILoggingService } from '@koalarx/nest/services/logging/ilogging.service'
+import { IRedLockService } from '@koalarx/nest/services/redlock/ired-lock.service'
+import { Injectable } from '@nestjs/common'
+import { DeletePersonHandler } from '../delete/delete-person.handler'
+import { ReadManyPersonHandler } from '../read-many/read-many-person.handler'
+import { ReadManyPersonRequest } from '../read-many/read-many-person.request'
+
+@Injectable()
+export class DeleteInactiveJob extends CronJob {
+  constructor(
+    redlockService: IRedLockService,
+    loggingService: ILoggingService,
+    private readonly readManyPerson: ReadManyPersonHandler,
+    private readonly deletePerson: DeletePersonHandler,
+  ) {
+    super(redlockService, loggingService)
+  }
+
+  protected async run(): Promise<CronJobResponse> {
+    const result = await this.readManyPerson.handle(
+      new ReadManyPersonRequest({ active: false }),
+    )
+
+    if (result.isOk()) {
+      for (const person of result.value.items) {
+        await this.deletePerson.handle(person.id)
+
+        console.log('Person with id was deleted:', person.id)
+      }
+    } else {
+      console.error('Error to search inactive people:', result.value)
+    }
+
+    return ok(null)
+  }
+
+  protected async isActive(): Promise<boolean> {
+    return true
+  }
+
+  protected defineTimeInMinutes(): number {
+    return 1
+  }
+}

package/code-base/startup-project/src/application/person/events/inactive-person/inactive-person-event.ts

@@ -0,0 +1,3 @@
+import { EventClass } from '@koalarx/nest/core/backgroud-services/event-service/event-class'
+
+export class InactivePersonEvent extends EventClass {}

package/code-base/startup-project/src/application/person/events/inactive-person/inactive-person-handler.ts

@@ -0,0 +1,27 @@
+import { IPersonRepository } from '@/domain/repositories/iperson.repository'
+import { EventHandler } from '@koalarx/nest/core/backgroud-services/event-service/event-handler'
+import { Injectable } from '@nestjs/common'
+import { ReadManyPersonRequest } from '../../read-many/read-many-person.request'
+import { InactivePersonEvent } from './inactive-person-event'
+
+@Injectable()
+export class InactivePersonHandler extends EventHandler<InactivePersonEvent> {
+  constructor(private readonly repository: IPersonRepository) {
+    super()
+  }
+
+  async handleEvent(): Promise<void> {
+    const result = await this.repository.readMany(
+      new ReadManyPersonRequest({ active: true }),
+    )
+
+    for (const person of result.items) {
+      person.active = false
+      await this.repository.save(person)
+    }
+
+    console.log(
+      'InactivePersonHandler: Registros ativos inativados com sucesso!',
+    )
+  }
+}

package/code-base/startup-project/src/application/person/events/person-event.job.ts

@@ -0,0 +1,11 @@
+import { Person } from '@/domain/entities/person/person'
+import { EventHandler } from '@koalarx/nest/core/backgroud-services/event-service/event-handler'
+import { EventJob } from '@koalarx/nest/core/backgroud-services/event-service/event-job'
+import { Type } from '@nestjs/common'
+import { InactivePersonHandler } from './inactive-person/inactive-person-handler'
+
+export class PersonEventJob extends EventJob<Person> {
+  defineHandlers(): Type<EventHandler<any>>[] {
+    return [InactivePersonHandler]
+  }
+}

package/code-base/startup-project/src/application/person/read/read-person.handler.spec.ts

@@ -0,0 +1,29 @@
+import { createUnitTestApp } from "@/test/create-unit-test-app"
+import { createPersonRequestMockup } from "@/test/mockup/person/create-person-request.mockup"
+import { CreatePersonHandler } from "../create/create-person.handler"
+import { ReadPersonHandler } from "./read-person.handler"
+
+describe('ReadPersonHandler', () => {
+  const app = createUnitTestApp()
+
+  it('should get a person by id', async () => {
+    const person = createPersonRequestMockup
+    const createResult = await app
+      .get(CreatePersonHandler)
+      .handle(createPersonRequestMockup)
+    
+    expect(createResult.isOk()).toBeTruthy()
+
+    if (createResult.isOk()) {
+      const result = await app
+        .get(ReadPersonHandler)
+        .handle(createResult.value.id)
+
+      expect(result.value).toEqual({
+        ...person,
+        id: createResult.value.id,
+        status: 'inactive'
+      })
+    }
+  })
+})

package/code-base/startup-project/src/application/person/read/read-person.handler.ts

@@ -0,0 +1,37 @@
+import { Person } from '@/domain/entities/person/person'
+import { IPersonRepository } from '@/domain/repositories/iperson.repository'
+import { ResourceNotFoundError } from '@koalarx/nest/core/errors/resource-not-found.error'
+import { AutoMappingService } from '@koalarx/nest/core/mapping/auto-mapping.service'
+import { RequestHandlerBase } from '@koalarx/nest/core/request-overflow/request-handler.base'
+import {
+  failure,
+  ok,
+  RequestResult,
+} from '@koalarx/nest/core/request-overflow/request-result'
+import { Injectable } from '@nestjs/common'
+import { ReadPersonResponse } from './read-person.response'
+
+@Injectable()
+export class ReadPersonHandler extends RequestHandlerBase<
+  number,
+  RequestResult<ResourceNotFoundError, ReadPersonResponse>
+> {
+  constructor(
+    private readonly mapper: AutoMappingService,
+    private readonly repository: IPersonRepository,
+  ) {
+    super()
+  }
+
+  async handle(
+    id: number,
+  ): Promise<RequestResult<ResourceNotFoundError, ReadPersonResponse>> {
+    const person = await this.repository.read(id)
+
+    if (!person) {
+      return failure(new ResourceNotFoundError('Pessoa'))
+    }
+
+    return ok(this.mapper.map(person, Person, ReadPersonResponse))
+  }
+}

package/code-base/startup-project/src/application/person/read/read-person.response.ts

@@ -0,0 +1,30 @@
+import { AutoMap } from '@koalarx/nest/core/mapping/auto-mapping.decorator'
+import { ApiProperty } from '@nestjs/swagger'
+
+export class ReadPersonPhoneResponse {
+  @ApiProperty()
+  @AutoMap()
+  id: number
+
+  @ApiProperty()
+  @AutoMap()
+  phone: string
+}
+
+export class ReadPersonResponse {
+  @ApiProperty()
+  @AutoMap()
+  id: number
+
+  @ApiProperty()
+  @AutoMap()
+  name: string
+
+  @ApiProperty({ type: [ReadPersonPhoneResponse] })
+  @AutoMap({ type: ReadPersonPhoneResponse, isArray: true})
+  phones: Array<ReadPersonPhoneResponse>
+
+  @ApiProperty()
+  @AutoMap()
+  status: string
+}