create-sip 0.11.0 → 0.12.1

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/create-sip.js

@@ -55,7 +55,7 @@ const questions = [
         value: 'webesbuildts'
       },
       { 
-        title: 'MockAPI',
+        title: 'hai mock API',
         description: 'API server with hai-server 0.0.4',
         value: 'mockapi'
       },
@@ -106,7 +106,7 @@ const questions = [
     return;
   }
   if(res.type === 'mockapi') {
-    console.log('Create a new MockAPI server...');
+    console.log('Create a new hai mock API server...');
     genMockApi(res.name);
     return;
   }

package/expressapi/docs/user_doc.md

@@ -3,7 +3,7 @@
 ## Install dependencies
 
 ```cmd
-pnpm install
+npm install
 ```
 
 ## Copy config file
@@ -13,7 +13,7 @@ Copy **config/default.json.example** to **config/default.json** file.
 ## App key generation
 
 ```cmd
-node tools/genkey.js
+node op key:generate
 ```
 
 ## Database setup
@@ -55,3 +55,10 @@ You receive the bearear token with accessToken key.
 ## The users endpoint
 
 Send the bearer token.
+
+## Model and controller generation
+
+```cmd
+node op create model thing
+node op create controller thing
+```

package/expressapi/op

@@ -3,14 +3,13 @@ import fs from 'fs-extra';
 
 import fsp from 'fs/promises'
 import { generateApiKey } from 'generate-api-key'
-import path, { dirname } from 'path';
-import url from 'url';
 
-console.log(process.argv.length)
 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>');
@@ -29,11 +28,6 @@ if(process.argv.length == 3 && process.argv[2] == 'key:generate') {
       copyController();
     }
   }
-  if(process.argv[2] === 'key:generate') {
-    console.log('Genearete key ... ');
-    
-  }
-  
 }
 
 async function copyController() {
@@ -87,11 +81,6 @@ function capitalizeFirstLetter(word) {
   return word.charAt(0).toUpperCase() + word.slice(1);
 }
 
-function generateKey(size = 32, format = 'base64') {
-  const buffer = crypto.randomBytes(size);
-  return buffer.toString(format);
-}
-
 function startGenerateKey() {
   console.log('Generate key...');
   const fileName = 'config/default.json'
@@ -105,3 +94,11 @@ function startGenerateKey() {
       .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/templates/controllerTemplate.js

@@ -19,6 +19,86 @@ const ThingController = {
             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
+        })
     }
 }
 

package/manager.js

@@ -68,8 +68,7 @@ const genExpressApi = (target) => {
   console.log('Run next commands:');
   console.log(`  cd ${target}`);
   console.log('  npm install');
-  console.log('  node tools/genconf.js');
-  console.log('  node tools/genkey.js');  
+  console.log('  node op key:generate');
   console.log('  npm run dev');
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-sip",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "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))