ddd-backend-cli 1.0.0 → 1.0.1

package/README.md

@@ -3,7 +3,7 @@
 
 ###
 
-<p align="left">CLI para generar automáticamente la estructura base de un módulo CRUD en un proyecto Backend usando Node.js + TypeScript + Express + EJS templates.<br><br>Este proyecto te permite crear tu propio template de Backend y personalizarlo usando solo comandos, sin necesidad de escribir todo el código repetitivo cada vez.</p>
+<p align="left">CLI para generar automáticamente la estructura base de un módulo CRUD en un proyecto Backend usando Node.js + TypeScript + Express + EJS templates + Scalar + Tsyrinnge.<br><br>Este proyecto te permite crear tu propio template de Backend y personalizarlo usando solo comandos, sin necesidad de escribir todo el código repetitivo cada vez.</p>
 
 Documentación paso a paso en mi Notion, para que puedas replicar la lógica y adaptarlo a tu manera: https://www.notion.so/oscarmolina/Automatizacion-Backend-3037c9c9fb1780f5bb06db3a9fb9ef83?source=copy_link
 
@@ -93,7 +93,7 @@ debes ubicarte en el espacio sobre el que trabajaras, en mi caso el Escritorio(D
 
 #para iniciar el proyecto nuevo y crear una base usa el siguiente comando
 
-mycli init test-api
+ddd-cli init test-api
 
 #donde init es el comando de inicializacion y test-api el nombre del proyecto,
 # una vez creado debemos entrar en el proyecto con el comando:
@@ -103,7 +103,7 @@ cd test-api
 #luego ejecutaremos el siguiente comando que se encargara de crearnos la estructura
 # de carpetas y archivos de manera automatizada
 
-mycli generate Product name:string price:number
+ddd-cli generate-model Product name:string price:number
 
 #El CLI:
 #Crea una carpeta src/product

package/dist/generators/module/fileCreator.js

@@ -8,7 +8,7 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 const ejs_1 = __importDefault(require("ejs"));
 async function createFile(template, destination, data) {
-    const templatePath = path_1.default.resolve(__dirname, "../../../templates", template);
+    const templatePath = path_1.default.resolve(__dirname, "../../templates", template);
     if (await fs_extra_1.default.pathExists(destination)) {
         console.log(`Skipped: ${destination}`);
         return;

package/dist/templates/controller.ejs

@@ -0,0 +1,41 @@
+import { inject, injectable } from "tsyringe";
+import { Request, Response } from "express";
+import { I<%= name %>Service } from './../../Application/interfaces/<%= moduleName %>.service.interface';
+
+@injectable()
+export class <%= name %>Controller {
+
+  private readonly _<%= moduleName %>Service: I<%= name %>Service;
+
+  constructor(@inject("I<%= name %>Service") service: I<%= name %>Service) {
+    this._<%= moduleName %>Service = service;
+  }
+
+  create= async (req: Request, res: Response)=> {
+    const result = await this._<%= moduleName %>Service.create(req.body);
+    res.status(201).json(result);
+  }
+
+  getAll= async (req: Request, res: Response)=> {
+    const result = await this._<%= moduleName %>Service.findAll();
+    res.json(result);
+  }
+
+  getById= async (req: Request, res: Response)=> {
+    const id = req.params.id as string;
+    const result = await this._<%= moduleName %>Service.findById(id);
+    res.json(result);
+  }
+
+  update= async (req: Request, res: Response)=> {
+    const id = req.params.id as string;
+    const result = await this._<%= moduleName %>Service.update(id, req.body);
+    res.json(result);
+  }
+
+  delete= async (req: Request, res: Response)=> {
+    const id = req.params.id as string;
+    await this._<%= moduleName %>Service.delete(id);
+    res.status(204).send();
+  }
+}

package/dist/templates/dto.ejs

@@ -0,0 +1,5 @@
+export interface <%= name %>Dto {
+<% fields.forEach(field => { -%>
+  <%= field.fieldName %>: <%= field.type %>;
+<% }) -%>
+}

package/dist/templates/entity.ejs

@@ -0,0 +1,40 @@
+import BaseModel from "./base.model";
+
+export default class <%= name %> extends BaseModel {
+<% fields.forEach(field => { -%>
+  <%= field.fieldName %>: <%= field.type %>;
+<% }) -%>
+  createdAt: Date;
+  updatedAt: Date;
+  createdBy: string;
+  updatedBy: string;
+
+  constructor({
+    id,
+<% fields.forEach(field => { -%>
+    <%= field.fieldName %>,
+<% }) -%>
+    createdAt,
+    updatedAt,
+    createdBy,
+    updatedBy,
+  }: {
+    id: string;
+<% fields.forEach(field => { -%>
+    <%= field.fieldName %>: <%= field.type %>;
+<% }) -%>
+    createdAt: Date;
+    updatedAt: Date;
+    createdBy: string;
+    updatedBy: string;
+  }) {
+    super(id);
+<% fields.forEach(field => { -%>
+    this.<%= field.fieldName %> = <%= field.fieldName %>;
+<% }) -%>
+    this.createdAt = createdAt;
+    this.updatedAt = updatedAt;
+    this.createdBy = createdBy;
+    this.updatedBy = updatedBy;
+  }
+}

package/dist/templates/path.ejs

@@ -0,0 +1,116 @@
+export const <%= name %>Paths = {
+  "/<%= moduleName %>": {
+    get: {
+      summary: "Get all <%= name %>",
+      tags: ["<%= name %>"],
+      responses: {
+        200: {
+          description: "List of <%= name %>",
+          content: {
+            "application/json": {
+              schema: {
+                type: "array",
+                items: { $ref: "#/components/schemas/<%= name %>" }
+              }
+            }
+          }
+        }
+      }
+    },
+    post: {
+      summary: "Create <%= name %>",
+      tags: ["<%= name %>"],
+      requestBody: {
+        required: true,
+        content: {
+          "application/json": {
+            schema: { $ref: "#/components/schemas/<%= name %>Request" }
+          }
+        }
+      },
+      responses: {
+        201: {
+          description: "<%= name %> created"
+        }
+      }
+    }
+  },
+
+  "/<%= moduleName %>/{id}": {
+    get: {
+      summary: "Get <%= name %> by id",
+      tags: ["<%= name %>"],
+      parameters: [
+        {
+          name: "id",
+          in: "path",
+          required: true,
+          schema: { type: "string" }
+        }
+      ],
+      responses: {
+        200: {
+          description: "<%= name %> found",
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/<%= name %>" }
+            }
+          }
+        },
+        404: {
+          description: "Not found"
+        }
+      }
+    },
+
+    put: {
+      summary: "Update <%= name %>",
+      tags: ["<%= name %>"],
+      parameters: [
+        {
+          name: "id",
+          in: "path",
+          required: true,
+          schema: { type: "string" }
+        }
+      ],
+      requestBody: {
+        required: true,
+        content: {
+          "application/json": {
+            schema: { $ref: "#/components/schemas/<%= name %>Request" }
+          }
+        }
+      },
+      responses: {
+        200: {
+          description: "<%= name %> updated"
+        },
+        404: {
+          description: "Not found"
+        }
+      }
+    },
+
+    delete: {
+      summary: "Delete <%= name %>",
+      tags: ["<%= name %>"],
+      parameters: [
+        {
+          name: "id",
+          in: "path",
+          required: true,
+          schema: { type: "string" }
+        }
+      ],
+      responses: {
+        204: {
+          description: "<%= name %> deleted"
+        },
+        404: {
+          description: "Not found"
+        }
+      }
+    }
+  }
+};

package/dist/templates/repository.impl.ejs

@@ -0,0 +1,29 @@
+import { injectable } from "tsyringe";
+import { I<%= name %>Repository } from "../../Domain/repositories/<%= moduleName %>Repository.interface";
+//import { DatabaseConnection } from "../database/DatabaseConnection";
+import { <%= name %>Dto } from "../../Application/dtos/<%= moduleName %>.dto";
+import <%= name %>  from "../../Domain/entities/<%= moduleName %>";
+
+@injectable()
+export class <%= name %>Repository implements I<%= name %>Repository {
+  //private db = DatabaseConnection.getInstance();
+
+  async create(data: <%= name %>Dto) : Promise<<%= name %>>{
+    // implementar luego
+    throw new Error("Method not implemented.");
+  }
+
+  async findAll(): Promise<<%= name %>[]> {
+    throw new Error("Method not implemented.");
+  }
+
+  async findById(id: string): Promise<<%= name %>> {
+    throw new Error("Method not implemented.");
+  }
+
+  async update(id: string, data: <%= name %>Dto): Promise<<%= name %>> {
+    throw new Error("Method not implemented.");
+  }
+
+  async delete(id: string) {}
+}

package/dist/templates/repository.interface.ejs

@@ -0,0 +1,10 @@
+import <%= name %> from '../entities/<%= moduleName %>';
+import { <%= name %>Dto } from './../../Application/dtos/<%= moduleName %>.dto';
+
+export interface I<%= name %>Repository {
+  create(data: <%= name %>Dto): Promise<<%= name %>>;
+  findAll(): Promise<<%= name %>[]>;
+  findById(id: string): Promise<<%= name %>>;
+  update(id: string, data: <%= name %>Dto): Promise<<%= name %>>;
+  delete(id: string): Promise<void>;
+}

package/dist/templates/routes.ejs

@@ -0,0 +1,14 @@
+import express from "express";
+import { container } from "tsyringe";
+import { <%= name %>Controller } from "../controllers/<%= name.toLowerCase() %>.controller";
+
+const router = express.Router();
+const controller = container.resolve(<%= name %>Controller);
+
+router.post("/", controller.create);
+router.get("/", controller.getAll);
+router.get("/:id", controller.getById);
+router.put("/:id", controller.update);
+router.delete("/:id", controller.delete);
+
+export default router;

package/dist/templates/schema.ejs

@@ -0,0 +1,27 @@
+export const <%= name %>Schemas = {
+  <%= name %>Request: {
+    type: "object",
+    required: [
+      <% fields.forEach((field, index) => { %>
+        "<%= field.fieldName %>"<%= index < fields.length - 1 ? "," : "" %>
+      <% }) %>
+    ],
+    properties: {
+      <% fields.forEach(field => { %>
+      <%= field.fieldName %>: { type: "<%= field.type === 'number' ? 'number' : 'string' %>" },
+      <% }) %>
+    }
+  },
+
+  <%= name %>: {
+    type: "object",
+    properties: {
+      id: { type: "string" },
+      <% fields.forEach(field => { %>
+      <%= field.fieldName %>: { type: "<%= field.type === 'number' ? 'number' : 'string' %>" },
+      <% }) %>
+      createdAt: { type: "string", format: "date-time" },
+      updatedAt: { type: "string", format: "date-time" }
+    }
+  }
+};

package/dist/templates/service.impl.ejs

@@ -0,0 +1,33 @@
+import { inject, injectable } from "tsyringe";
+import { I<%= name %>Service } from "../interfaces/<%= moduleName %>.service.interface";
+import { I<%= name %>Repository } from "../../Domain/repositories/<%= moduleName %>Repository.interface";
+import { <%= name %>Dto } from "../dtos/<%= moduleName %>.dto";
+
+@injectable()
+export class <%= name %>Service implements I<%= name %>Service {
+  private readonly _<%= moduleName %>Repository: I<%= name %>Repository;
+
+  constructor(@inject("I<%= name %>Repository") repository: I<%= name %>Repository) {
+    this._<%= moduleName %>Repository = repository;
+  }
+
+  async create(data: <%= name %>Dto) {
+    return this._<%= moduleName %>Repository.create(data);
+  }
+
+  async findAll() {
+    return this._<%= moduleName %>Repository.findAll();
+  }
+
+  async findById(id: string) {
+    return this._<%= moduleName %>Repository.findById(id);
+  }
+
+  async update(id: string, data: <%= name %>Dto) {
+    return this._<%= moduleName %>Repository.update(id, data);
+  }
+
+  async delete(id: string) {
+    return this._<%= moduleName %>Repository.delete(id);
+  }
+}

package/dist/templates/service.interface.ejs

@@ -0,0 +1,10 @@
+import <%= name %> from "../../Domain/entities/<%= moduleName %>";
+import { <%= name %>Dto } from './../dtos/<%= moduleName %>.dto';
+
+export interface I<%= name %>Service {
+  create(data: <%= name %>Dto): Promise<<%= name %>>;
+  findAll(): Promise<<%= name %>[]>;
+  findById(id: string): Promise<<%= name %>>;
+  update(id: string, data: <%= name %>Dto): Promise<<%= name %>>;
+  delete(id: string): Promise<void>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ddd-backend-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "CLI para generar proyectos backend con DDD",
   "main": "dist/index.js",
   "bin": {
@@ -17,8 +17,12 @@
   ],
   "author": "Oscar Molina",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/oscarMolina1523/BackendAutomation.git"
+  },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && cpx \"src/templates/**/*\" dist/templates",
     "dev": "tsc -w"
   },
   "dependencies": {
@@ -30,6 +34,7 @@
     "@types/ejs": "^3.1.5",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^20.11.30",
+    "cpx": "^1.5.0",
     "typescript": "^5.3.3"
   }
 }