create-sip 0.10.9 → 0.12.0

package/README.md

@@ -21,3 +21,60 @@ npm create sip@latest
 
 * Write project name.
 * Select project type.
+
+## Express API
+
+Key generation:
+
+```bash
+node op key:generate
+```
+
+Afte project generation, you have an config/default.json file. If you want generate a new file, delete the config/default.json file and run next command:
+
+```bash
+node op conf:generate
+```
+
+Create model:
+
+```bash
+node op create model <name>
+```
+
+Create controller:
+
+```bash
+node op create controller <name>
+```
+
+Exmple:
+
+```bash
+node op create model employee
+node op create controller employee
+```
+
+### Database
+
+Default database type is sqlite :memory:. If you want to use another database, edit the config/default.json file. For example SQLite:
+
+```json
+{
+    "app": {
+        "port": 8000,
+        "key": "",
+        "log": "console.log"
+    },
+    "db": {
+        "dialect": "sqlite",
+        "host": "127.0.0.1",
+        "name": "",
+        "user": "",
+        "pass": "",
+        "path": "database.sqlite"
+    }
+}
+```
+
+Must be set the database path in the config/default.json file.

package/expressapi/config/default.json

@@ -0,0 +1,15 @@
+{
+    "app": {
+        "port": 8000,
+        "key": "",
+        "log": "console.log"
+    },
+    "db": {
+        "dialect": "sqlite",
+        "host": "127.0.0.1",
+        "name": "",
+        "user": "",
+        "pass": "",
+        "path": ":memory:"
+    }
+}

package/expressapi/op

@@ -0,0 +1,104 @@
+import replace from 'replace';
+import fs from 'fs-extra';
+
+import fsp from 'fs/promises'
+import { generateApiKey } from 'generate-api-key'
+
+console.log(process.argv[2])
+
+if(process.argv.length == 3 && process.argv[2] == 'key:generate') {
+  startGenerateKey();
+} else if(process.argv.length == 3 && process.argv[2] == 'conf:generate') {
+  startGenerateConf();
+} else if(process.argv.length < 4) {
+  console.log('Usage:');
+  console.log('node op <command> <type> <name>');
+  console.log('Example:');
+  console.log('node op create model something');
+  console.log('node op create controller something');
+  console.log('node op key:generate');
+  process.exit(1);
+} else {
+  if(process.argv[2] === 'create') {
+    console.log('Create a new ' + process.argv[3] + '...');
+    if(process.argv[3] === 'model') {
+      copyModel();
+    }
+    if(process.argv[3] === 'controller') {
+      copyController();
+    }
+  }
+}
+
+async function copyController() {
+
+  const className = process.argv[4]
+  const lowerName = className.toLowerCase()
+
+  const src = 'templates/controllerTemplate.js'
+  const dest = `app/controllers/${lowerName}controller.js`
+  await fs.copy(src, dest)
+
+  replace({
+      regex: 'Thing',
+      replacement: capitalizeFirstLetter(className),
+      paths: [dest]
+  })
+  replace({
+      regex: 'thing',
+      replacement: className,
+      paths: [dest]
+  })
+  replace({
+    regex: 'things',
+    replacement: className + 's',
+    paths: [dest]
+  })
+}
+
+async function copyModel() {
+
+  const className = process.argv[4]
+  const lowerName = className.toLowerCase()
+
+  const src = 'templates/modelTemplate.js'
+  const dest = `app/models/${lowerName}.js`
+  await fs.copy(src, dest)
+
+  replace({
+      regex: 'Thing',
+      replacement: capitalizeFirstLetter(className),
+      paths: [dest]
+  })
+  replace({
+      regex: 'thing',
+      replacement: className,
+      paths: [dest]
+  })
+}
+
+function capitalizeFirstLetter(word) {
+  return word.charAt(0).toUpperCase() + word.slice(1);
+}
+
+function startGenerateKey() {
+  console.log('Generate key...');
+  const fileName = 'config/default.json'
+  fsp.readFile(fileName)
+      .then(body => JSON.parse(body))
+      .then(json => {
+          json.app.key = generateApiKey({method: 'bytes', length: 32})
+          return json
+      })
+      .then(json => JSON.stringify(json, null, 4))
+      .then(body => fs.writeFile(fileName, body, 'utf8'))
+      .catch(error => console.log(error))
+}
+
+function startGenerateConf() {
+  console.log('Generate conf...');
+  const sourceFileName = 'config/default.json.example';
+  const destinationFileName = 'config/default.json';
+  fs.copyFile(sourceFileName, destinationFileName)
+      .catch(error => console.log(error));
+}

package/expressapi/package.json

@@ -27,6 +27,7 @@
     "sqlite3": "^5.1.6"
   },
   "devDependencies": {
+    "fs-extra": "^11.3.0",    
     "nodemon": "^2.0.22",
     "supertest": "^6.3.3"
   },

package/expressapi/templates/controllerTemplate.js

@@ -0,0 +1,105 @@
+import Thing from '../models/thing.js'
+
+const ThingController = {
+    async index(req, res) {
+        try {
+            ThingController.tryIndex(req, res)
+        }catch(error) {
+            res.status(500)
+            res.json({
+                success: false,
+                message: 'Error! The query is failed!'
+            })
+        }
+    },
+    async tryIndex(req, res) {
+        const things = await Thing.findAll()
+        res.status(200)
+        res.json({
+            success: true,
+            data: things
+        })
+    },
+    async show(req, res) {
+        try {
+            ThingController.tryShow(req, res)
+        }catch(error) {
+            res.status(500)
+            res.json({
+                success: false,
+                message: 'Error! The query is failed!'
+            })
+        }
+    },
+    async tryShow(req, res) {
+        const thing = await Thing.findByPk(req.params.id)
+        res.status(200)
+        res.json({
+            success: true,
+            data: thing
+        })
+    },
+    async create(req, res) {
+        try {
+            ThingController.tryCreate(req, res)
+        }catch(error) {
+            res.status(500)
+            res.json({
+                success: false,
+                message: 'Error! The query is failed!'
+            })
+        }
+    },
+    async tryCreate(req, res) {
+        const thing = await Thing.create(req.body)
+        res.status(201)
+        res.json({
+            success: true,
+            data: thing
+        })
+    },
+    async update(req, res) {
+        try {
+            ThingController.tryUpdate(req, res)
+        }catch(error) {
+            res.status(500)
+            res.json({
+                success: false,
+                message: 'Error! The query is failed!'
+            })
+        }
+    },
+    async tryUpdate(req, res) {
+        const thing = await Thing.update(req.body, {
+            where: { id: req.params.id }
+        })
+        res.status(200)
+        res.json({
+            success: true,
+            data: thing
+        })
+    },
+    async destroy(req, res) {
+        try {
+            ThingController.tryDestroy(req, res)
+        }catch(error) {
+            res.status(500)
+            res.json({
+                success: false,
+                message: 'Error! The query is failed!'
+            })
+        }
+    },
+    async tryDestroy(req, res) {
+        const thing = await Thing.destroy({
+            where: { id: req.params.id }
+        })
+        res.status(200)
+        res.json({
+            success: true,
+            data: thing
+        })
+    }
+}
+
+export default ThingController

package/expressapi/templates/modelTemplate.js

@@ -0,0 +1,18 @@
+import { DataTypes } from 'sequelize'
+import sequelize from '../database/database.js'
+
+const Thing = sequelize.define('thing', {
+    id: { 
+        type: DataTypes.INTEGER,
+        autoIncrement: true,
+        primaryKey: true
+    },
+    name: { type: DataTypes.STRING,  allowNull: false  }
+})
+
+
+sequelize.sync({
+    force: false
+})
+
+export default Thing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-sip",
-  "version": "0.10.9",
+  "version": "0.12.0",
   "main": "index.js",
   "bin": {
     "create-sip": "create-sip.js"

package/expressapi/tools/genconf.js

@@ -1,12 +0,0 @@
-import fs from 'fs/promises'
-import path from 'path';
-import url from 'url';
-
-const __filename = url.fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const sourceFileName = path.join(__dirname, '../config/default.json.example');
-const destinationFileName = path.join(__dirname, '../config/default.json');
-
-fs.copyFile(sourceFileName, destinationFileName)
-    .catch(error => console.log(error));
-

package/expressapi/tools/genkey.js

@@ -1,23 +0,0 @@
-import fs from 'fs/promises'
-import { generateApiKey } from 'generate-api-key'
-import path, { dirname } from 'path';
-import url from 'url';
-
-const __filename = url.fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-const fileName = path.join(__dirname, '../config/default.json');
-
-function generateKey(size = 32, format = 'base64') {
-    const buffer = crypto.randomBytes(size);
-    return buffer.toString(format);
-}
-
-fs.readFile(fileName)
-    .then(body => JSON.parse(body))
-    .then(json => {
-        json.app.key = generateApiKey({method: 'bytes', length: 32})
-        return json
-    })
-    .then(json => JSON.stringify(json, null, 4))
-    .then(body => fs.writeFile(fileName, body, 'utf8'))
-    .catch(error => console.log(error))