feat(generators/with-postgres): rename app to with-postgres-sequelize, pluralize model name & RESOURCE const

Author: phatpham9

README.md

@@ -61,8 +61,8 @@ $ yo create-service-component
 # or :with-mongo
 $ yo create-service-component:with-mongo
 
-# or :with-postgres
-$ yo create-service-component:with-postgres
+# or :with-postgres-sequelize
+$ yo create-service-component:with-postgres-sequelize
 
 # or :with-postgres-typeorm
 $ yo create-service-component:with-postgres-typeorm
@@ -80,8 +80,8 @@ This scaffolds out:
 │   │   │   ├── constants.ts
 │   │   │   ├── controller.ts
 │   │   │   ├── index.ts
-│   │   │   ├── model.ts        (:with-mongo/:with-postgres/:with-postgres-typeorm)
-│   │   │   ├── repository.ts   (:with-mongo/:with-postgres/:with-postgres-typeorm/:with-postgres-prisma)
+│   │   │   ├── model.ts        (:with-mongo/:with-postgres-sequelize/:with-postgres-typeorm)
+│   │   │   ├── repository.ts   (:with-mongo/:with-postgres-sequelize/:with-postgres-typeorm/:with-postgres-prisma)
 │   │   │   ├── types.ts
 │   │   └── ...
 │   ├── ...

generators/with-postgres/index.js renamed to generators/with-postgres-sequelize/index.js

@@ -22,12 +22,21 @@ module.exports = class extends Generator {
     return this.prompt(prompts).then((props) => {
       const compNameParamCase = changeCase.paramCase(props.compName);
       const compNamePascalCase = changeCase.pascalCase(props.compName);
+      const compNameCamelCase = changeCase.camelCase(props.compName);
 
       this.props = {
-        ...props,
+        // param-case
         compNameParamCase,
-        compNamePascalCase,
+        // param-cases
         compNameParamCasePlural: pluralize(compNameParamCase),
+        // PascalCase
+        compNamePascalCase,
+        // PasCalCases
+        compNamePascalCasePlural: pluralize(compNamePascalCase),
+        // camelCase
+        compNameCamelCase,
+        // camelCases
+        compNameCamelCasePlural: pluralize(compNameCamelCase),
       };
     });
   }

generators/with-postgres/templates/<%= compNameParamCasePlural %>/constants.ts renamed to generators/with-postgres-sequelize/templates/<%= compNameParamCasePlural %>/constants.ts

@@ -1,4 +1,6 @@
+import pluralize from 'pluralize';
+
 const ENTITY = '<%= compNameParamCase %>';
-const RESOURCE = '<%= compNameParamCasePlural %>';
+const RESOURCE = pluralize(ENTITY);
 
 export { ENTITY, RESOURCE };

generators/with-postgres/templates/<%= compNameParamCasePlural %>/controller.ts renamed to generators/with-postgres-sequelize/templates/<%= compNameParamCasePlural %>/controller.ts

@@ -5,16 +5,17 @@ import {
   ModelCtor,
   DataTypes,
 } from 'sequelize';
+import pluralize from 'pluralize';
 
 import { <%= compNamePascalCase %> } from './types';
 import { ENTITY } from './constants';
 
-interface Instance extends SequelizeModel<<%= compNamePascalCase %>, Omit<<%= compNamePascalCase %>, 'id'>>, <%= compNamePascalCase %> {}
-interface Model extends ModelCtor<Instance> {}
+interface Document extends SequelizeModel<<%= compNamePascalCase %>, Omit<<%= compNamePascalCase %>, 'id'>>, <%= compNamePascalCase %> {}
+interface Model extends ModelCtor<Document> {}
 
-const name = ENTITY;
+const name = pluralize(ENTITY);
 
-const schema: ModelAttributes<Instance> = {
+const schema: ModelAttributes<Document> = {
   id: {
     type: DataTypes.INTEGER,
     primaryKey: true,
@@ -24,7 +25,9 @@ const schema: ModelAttributes<Instance> = {
   // TODO: add more fields
 };
 
-const options: ModelOptions<SequelizeModel> = {};
+const options: ModelOptions<SequelizeModel> = {
+  timestamps: false,
+};
 
 export default { name, schema, options };
-export { Instance, Model };
+export { Document, Model };

generators/with-postgres/templates/<%= compNameParamCasePlural %>/index.ts renamed to generators/with-postgres-sequelize/templates/<%= compNameParamCasePlural %>/index.ts

@@ -0,0 +1,72 @@
+import { MyError } from '@boringcodes/utils/error';
+
+import postgres from '../../db/postgres';
+import { <%= compNamePascalCase %> } from './types';
+import model, { Document, Model } from './model';
+
+const list = async (): Promise<<%= compNamePascalCase %>[]> => {
+  // list documents
+  const documents = await getModel().findAll();
+
+  return documents.map(transform);
+};
+
+const create = async (object: Omit<<%= compNamePascalCase %>, 'id'>): Promise<<%= compNamePascalCase %>> => {
+  // create document
+  const document = getModel().build(object);
+  await document.save();
+
+  return transform(document);
+};
+
+const get = async (id: number): Promise<<%= compNamePascalCase %>> => {
+  // get document
+  const document = await getModel().findByPk(id);
+  if (document === null) {
+    throw new MyError('Document not found');
+  }
+
+  return transform(document);
+};
+
+const update = async (
+  id: number,
+  object: Omit<<%= compNamePascalCase %>, 'id'>,
+): Promise<<%= compNamePascalCase %>> => {
+  // get document
+  const document = await getModel().findByPk(id);
+  if (document === null) {
+    throw new MyError('Document not found');
+  }
+
+  // update document
+  document.set(object);
+  await document.save();
+
+  return transform(document);
+};
+
+const del = async (id: number): Promise<<%= compNamePascalCase %>> => {
+  // get document
+  const document = await getModel().findByPk(id);
+  if (document === null) {
+    throw new MyError('Document not found');
+  }
+
+  // delete document
+  await document.destroy();
+
+  return transform(document);
+};
+
+// get model
+const getModel = (): Model => {
+  return postgres.getModel(model.name) as Model;
+};
+
+// transform document to <%= compNamePascalCase %>
+const transform = (document: Document): <%= compNamePascalCase %> => {
+  return document.toJSON() as <%= compNamePascalCase %>;
+};
+
+export default { list, create, get, update, del };

generators/with-postgres/templates/<%= compNameParamCasePlural %>/model.ts renamed to generators/with-postgres-sequelize/templates/<%= compNameParamCasePlural %>/model.ts

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