create-sip 0.14.3 → 0.15.0

package/create-sip.js

@@ -61,7 +61,7 @@ const questions = [
       },
       { 
         title: 'Express API',
-        description: 'Express API with simple Sequelize',
+        description: 'Express API with simple Sequelize and ES modules',
         value: 'expressapi' 
       },
       { 
@@ -111,7 +111,7 @@ const questions = [
     return;
   }
   if(res.type === 'expressapi') {
-    console.log('Create a new Express API...');
+    console.log('Create a new Express API with ES modules...');
     genExpressApi(res.name);
     return;
   }

package/expressapi/README.md

@@ -65,11 +65,46 @@ npm start
 You can generate a model and controller with the following commands:
 
 ```bash
-node op create model thing
-node op create controller thing
+node op make:model something
+node op make:controller something
 ```
 
-The name after the model and controller statements must be given in the singular.
+The name after the model and controller statements must be given in the singular. Controller generation automatically appends the "Controller" suffix.
+
+## Admin user
+
+The admin user can be created with the following command:
+
+```bash
+node op admin:generate
+```
+
+The command will prompt for the password.
+
+## Config generation
+
+The next command generates the default config file:
+
+```bash
+node op conf:generate
+```
+
+## Database seed
+
+The database can be seeded with the following command:
+
+```bash
+node op db:seed <model_name> <file_path>
+```
+
+The model name must be given in the singular and lowercase. The file extension must be:
+
+* .json
+* .csv
+
+The keys in the JSON file and the field names in the CSV file must match the model fields.
+
+If the CSV file contains quotation marks, they are automatically removed.
 
 ## Licence
 

package/expressapi/op

@@ -1,20 +1,55 @@
-import replace from 'replace';
-import fs from 'fs-extra';
-
+import replace from 'replace'
+import fse from 'fs-extra'
 import fsp from 'fs/promises'
 import { generateApiKey } from 'generate-api-key'
-
 import bcrypt from 'bcryptjs';
 import path from 'path';
-
 import { read } from 'read'
 
-if(process.argv.length == 3 && process.argv[2] == 'key:generate') {
+if(process.argv.length == 3 && process.argv[2] == 'help') {
+  console.log('Usable commands:');
+  console.log('  node op make:model <name>');
+  console.log('  node op make:controller <name>');
+  console.log('  node op key:generate');
+  console.log('  node op conf:generate');
+  console.log('  node op admin:generate');
+  console.log('  node op db:seed <model> <filePath>');
+  process.exit(0);
+} else 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 == 3 && process.argv[2] == 'admin:generate') {
   startGenerateAdmin();
+} else if(process.argv[2] === 'db:seed') {
+  if(process.argv.length < 5) {
+      console.log('Usage:');
+      console.log('node op db:seed <model> <filePath>');
+      console.log('Examples:');
+      console.log('node op db:seed thing somethings.json');
+      console.log('node op db:seed thing somethings.csv');
+  }
+  const model = process.argv[3];
+  const filePath = process.argv[4];
+  runSeed(model, filePath);
+} else if(process.argv[2] === 'make:model') {
+  if(process.argv.length < 4) {
+      console.log('Usage:');
+      console.log('node op make:model <name>');
+      console.log('Examples:');
+      console.log('node op make:model something');
+  }
+  copyModel(process.argv[3]);
+
+} else if(process.argv[2] === 'make:controller') {
+  if(process.argv.length < 4) {
+      console.log('Usage:');
+      console.log('node op make:controller <name>');
+      console.log('Examples:');
+      console.log('node op make:controller something');
+  }
+  copyController(process.argv[3]);
+
 } else if(process.argv.length < 4) {
   console.log('Usage:');
   console.log('node op <command> <type> <name>');
@@ -27,22 +62,20 @@ if(process.argv.length == 3 && process.argv[2] == 'key:generate') {
   if(process.argv[2] === 'create') {
     console.log('Create a new ' + process.argv[3] + '...');
     if(process.argv[3] === 'model') {
-      copyModel();
+      copyModel(process.argv[4]);
     }
     if(process.argv[3] === 'controller') {
-      copyController();
+      copyController(process.argv[4]);
     }
   }
 }
 
-async function copyController() {
-
-  const className = process.argv[4]
+async function copyController(className) {
   const lowerName = className.toLowerCase()
 
   const src = 'templates/controllerTemplate.js'
   const dest = `app/controllers/${lowerName}controller.js`
-  await fs.copy(src, dest)
+  await fse.copy(src, dest)
 
   replace({
       regex: 'Thing',
@@ -61,14 +94,12 @@ async function copyController() {
   })
 }
 
-async function copyModel() {
-
-  const className = process.argv[4]
+async function copyModel(className) {
   const lowerName = className.toLowerCase()
-
   const src = 'templates/modelTemplate.js'
   const dest = `app/models/${lowerName}.js`
-  await fs.copy(src, dest)
+
+  await fse.copy(src, dest)
 
   replace({
       regex: 'Thing',
@@ -96,16 +127,20 @@ function startGenerateKey() {
           return json
       })
       .then(json => JSON.stringify(json, null, 4))
-      .then(body => fs.writeFile(fileName, body, 'utf8'))
+      .then(body => fse.writeFile(fileName, body, 'utf8'))
       .catch(error => console.log(error))
 }
 
-function startGenerateConf() {
+async 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));
+  try {
+    await fse.copyFile(sourceFileName, destinationFileName)
+  } catch (error) {
+    console.log(error)
+  }
+      
 }
 
 async function loadConfig() {
@@ -158,4 +193,89 @@ async function startGenerateAdmin() {
     console.error('Error creating admin!')
     console.error(err)
   }
-}
+}
+
+const seedFromJson = async (model, filePath) => {
+  try {
+      const data = JSON.parse(await fsp.readFile(filePath, 'utf8'))
+      await model.bulkCreate(data)
+      console.log(`Data seeded successfully! ${model.name}`)
+  } catch (error) {
+      console.error(error)
+  }
+}
+
+const seedFromCsv = async (model, filePath) => {
+  const sep = ','
+  try {
+      const data = await fsp.readFile(filePath, 'utf8')
+      const clearData = data.replace(/"/g, '').trim()
+      const rows = clearData.split('\n')
+      const headerColumns = rows.shift().split(sep)
+      
+      const dataToInsert = rows.map(row => {
+          const columns = row.split(sep).map(item => {
+            const number = Number(item)
+            return Number.isNaN(number) ? `${item}` : number
+          })
+          return headerColumns.reduce((obj, header, index) => {
+              obj[header] = columns[index]
+              return obj
+          }, {})
+      })
+
+      await model.bulkCreate(dataToInsert)
+      console.log(`Data seeded successfully! ${model.name}`)
+  } catch (error) {
+      console.error(error)
+  }
+}
+
+async function runSeed(model, filePath) {
+  
+  if(!filePath || !model) {
+      console.log('Usage: node seed.js <modelName> <filePath>')
+      process.exit(1)
+  }
+  
+  try {
+    await import(`./app/models/${model}.js`)
+  } catch (error) {
+    console.log(`The ${model} model file does not exist!`)
+    process.exit(1)
+  }
+
+  try {
+    await fsp.stat(filePath)
+  } catch (error) {
+    if (error.code === 'ENOENT') {
+      console.log(`The file ${filePath} does not exist!`)
+      process.exit(1)
+    } else {
+      console.error(error)
+      process.exit(1)
+    }
+  }
+
+  const modelInstance = await import(`./app/models/${model}.js`)
+  const modelObject = modelInstance.default
+
+  const ext = path.extname(filePath).toLowerCase()
+  if(ext !== '.json' && ext !== '.csv') {
+      console.log('The file must have .json or .csv extension!')
+      process.exit(1)
+  }
+  const { default: sequelize } = await import('./app/database/database.js')
+  try {
+      await sequelize.sync({ force: true })
+      await sequelize.authenticate()
+      if(ext === '.csv') {
+          await seedFromCsv(modelObject, filePath)
+      }else {
+          await seedFromJson(modelObject, filePath)
+      }        
+  } catch (error) {
+      console.error(error)
+  }
+
+}

package/manager.js

@@ -71,10 +71,11 @@ const genExpressApi = (target) => {
   console.log('  node op key:generate');
   console.log('  npm run dev');
   console.log('Usable commands:');
-  console.log('  node op create model thing');
-  console.log('  node op create controller thing');
+  console.log('  node op make:model something');
+  console.log('  node op make:controller something');
   console.log('The model and controller names must be');
-  console.log('given in the singular');
+  console.log('given in the singular. More info:');
+  console.log('  node op help')
 }
 
 module.exports = {

package/package.json

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