chore(generators/with-mongo): refactor model creation using createModel func call, add more comments

Author: phatpham9

generators/with-mongo/templates/<%= compNameParamCasePlural %>/controller.ts

@@ -24,6 +24,8 @@ const getById = async (
     try {
       // get object by id
       const object = await repository.get(id);
+
+      // assign object to request for using in the next handlers
       Object.assign(req, { [ENTITY]: object });
 
       next();

generators/with-mongo/templates/<%= compNameParamCasePlural %>/model.ts

@@ -1,9 +1,10 @@
-import mongoose, {
+import {
   Schema,
   Document as MongooseDocument,
   Model as MongooseModel,
 } from 'mongoose';
 
+import mongo from '../../db/mongo';
 import { <%= compNamePascalCase %> } from './types';
 import { ENTITY } from './constants';
 
@@ -12,7 +13,8 @@ interface Model extends MongooseModel<Document> {}
 
 const schema = new Schema<Document>({
   name: String,
+  // TODO: add more fields here
 });
 
-export default mongoose.model<Document, Model>(ENTITY, schema);
+export default mongo.createModel<Document, Model>(ENTITY, schema);
 export { Model, Document };

generators/with-mongo/templates/<%= compNameParamCasePlural %>/repository.ts

@@ -3,15 +3,6 @@ import { MyError } from '@boringcodes/utils/error';
 import { <%= compNamePascalCase %> } from './types';
 import Model, { Document } from './model';
 
-const transform = (document: Document): <%= compNamePascalCase %> => {
-  const { _id, ...restObject } = document.toObject({
-    virtuals: true,
-    versionKey: false,
-  });
-
-  return restObject;
-};
-
 const list = async (): Promise<<%= compNamePascalCase %>[]> => {
   // list documents
   const documents = await Model.find();
@@ -78,4 +69,14 @@ const del = async (id: string): Promise<<%= compNamePascalCase %>> => {
   return transform(document);
 };
 
+// transform document to json object
+const transform = (document: Document): <%= compNamePascalCase %> => {
+  const { _id, ...restObject } = document.toObject({
+    virtuals: true,
+    versionKey: false,
+  });
+
+  return restObject;
+};
+
 export default { list, create, get, updatePartial, update, del };

generators/with-mongo/templates/<%= compNameParamCasePlural %>/types.ts

@@ -1,6 +1,7 @@
 interface <%= compNamePascalCase %> {
   readonly id?: string;
   readonly name?: string;
+  // TODO: add more props here
 }
 
 export { <%= compNamePascalCase %> };