create-sip 1.1.2 → 1.2.0

package/expressapi/README.md

@@ -89,12 +89,12 @@ The next command generates the default config file:
 node op conf:generate
 ```
 
-## Database seed
+## Database import
 
 The database can be seeded with the following command:
 
 ```bash
-node op db:seed <model_name> <file_path>
+node op db:import <model_name> <file_path>
 ```
 
 The model name must be given in the singular and lowercase. The file extension must be:
@@ -106,6 +106,50 @@ The keys in the JSON file and the field names in the CSV file must match the mod
 
 If the CSV file contains quotation marks, they are automatically removed.
 
+## Migration
+
+Generate a migration:
+
+```bash
+node op make/migration thing
+```
+
+Run all migration:
+
+```bash
+node op migration:run
+```
+
+Run a migration:
+
+```bash
+node op migration:run <migration_name>
+```
+
+Rollback a migration:
+
+```bash
+node op migration:rollback
+```
+
+Rollback two migrations:
+
+```bash
+node op migration:rollback 2
+```
+
+Reset the database:
+
+```bash
+node op migration:reset
+```
+
+Reset the database and run all migrations:
+
+```bash
+node op migration:fresh
+```
+
 ## Licence
 
 May be freely distributed under the MIT license.

package/expressapi/docs/user_doc.md

@@ -62,3 +62,36 @@ Send the bearer token.
 node op create model thing
 node op create controller thing
 ```
+
+## Key generation
+
+```cmd
+node op key:generate
+```
+
+## Generate admin user
+
+```cmd
+node op admin:generate
+```
+
+## Database import
+
+```cmd
+node op db:import thing things.json
+node op db:import thing things.csv
+node op db:import thing things.csv ,
+node op db:import thing things.csv ";"
+node op db:import thing things.csv :
+```
+
+## Migration
+
+```cmd
+node op make:migration thing
+node op migrate:run
+node op migrate:fresh
+node op migrate:rollback
+node op migrate:rollback --step 2
+node op migrate:reset
+```

package/expressapi/op

@@ -1,3 +1,5 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
 import replace from 'replace';
 import fse from 'fs-extra';
 import fsp from 'fs/promises';
@@ -6,78 +8,162 @@ import bcrypt from 'bcryptjs';
 import path from 'path';
 import { read } from 'read';
 
-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> [sep]');
-  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> [sep]');
-      console.log('Examples:');
-      console.log('node op db:seed thing somethings.json');
-      console.log('node op db:seed thing somethings.csv');
-      console.log('node op db:seed thing somethings.csv ,');
-      console.log('node op db:seed thing somethings.csv :');
-      console.log('node op db:seed thing somethings.csv ";"');
+const { argv } = yargs(hideBin(process.argv))
+.version()
+.usage('Használat: node op <command>  [name]')
+.help()
+.demandCommand(1, 'Not enough arguments!')
+.command('make:model <name>',
+  'Generates a new Sequelize model',
+  (yargs) => {
+    return yargs
+      .positional('name', {
+        type: 'string',
+        description: 'Name of the model'
+      })
+  },
+  async (argv) => {
+    const { name } = argv;
+    await copyModel(name);
   }
-  const model = process.argv[3];
-  const filePath = process.argv[4];
-  if(process.argv.length == 6) {
-    const sep = process.argv[5];
-    runSeed(model, filePath, sep);
-  }else {
-    runSeed(model, filePath);
+)
+.command('make:controller <name>',
+  'Generates a new controller',
+  (yargs) => {
+    return yargs
+      .positional('name', {
+        type: 'string',
+        description: 'Name of the controller'
+      })
+  },
+  async (argv) => {
+    const { name } = argv;
+    await copyController(name);
   }
-  
-} 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');
+)
+.command('key:generate',
+  'Generates a new API key',
+  (yargs) => {
+    return yargs
+  },
+  async (argv) => {
+    startGenerateKey();
   }
-  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');
+)
+.command('conf:generate',
+  'Generates a new config file',
+  (yargs) => {
+    return yargs
+  },
+  async (argv) => {
+    startGenerateConf();
   }
-  copyController(process.argv[3]);
-
-} 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(process.argv[4]);
-    }
-    if(process.argv[3] === 'controller') {
-      copyController(process.argv[4]);
-    }
+)
+.command('admin:generate',
+  'Generates a new admin user',
+  (yargs) => {
+    return yargs
+  },
+  async (argv) => {
+    startGenerateAdmin();
   }
-}
+)
+.command('db:import <model> <filePath> [sep]',
+  `Import CSV or JSON file to database table
+
+Examples:
+node op db:import thing somethings.json
+node op db:import thing somethings.csv
+node op db:import thing somethings.csv ,
+node op db:import thing somethings.csv :
+node op db:import thing somethings.csv ";"
+
+In CSV file the field names must match the model fields.
+  `,
+  (yargs) => {
+    return yargs
+      .positional('model', {
+        type: 'string',
+        description: 'Name of the model'
+      })
+      .positional('filePath', {
+        type: 'string',
+        description: 'Path to the file'
+      })
+      .positional('sep', {
+        type: 'string',
+        description: 'Separator for the CSV file'
+      })
+  },
+  async (argv) => {
+    const { model, filePath, sep } = argv;
+    await runImportData(model, filePath, sep);
+  }
+)
+.command('make:migration <name>',
+  'Generates a new migration file',
+  (yargs) => {
+    return yargs
+      .positional('name', {
+        type: 'string',
+        description: 'Name of the migration'
+      })
+  },
+  async (argv) => {
+    const { name } = argv;
+    await createMigration(name);
+  }
+)
+.command('migration:run [migrationName]',
+  'Runs migrations',
+  (yargs) => {
+    return yargs
+      .positional('migrationName', {
+        type: 'string',
+        description: 'Name of the migration'
+      })
+  },
+  async (argv) => {
+    const { migrationName } = argv;
+    await startMigrations(migrationName);
+  }
+)
+.command('migration:rollback',
+  'Rolls back migrations',
+  (yargs) => {
+    return yargs
+      .options({
+        step: {
+          type: 'number',
+          description: 'Number of migrations to rollback',
+          default: 1
+        }
+      })
+  },
+  async (argv) => {
+    const { step } = argv;
+    await rollbackMigrations(step);
+  }
+)
+.command('migration:fresh',
+  'Rolls back all migrations',
+  (yargs) => {
+    return yargs
+  },
+  async (argv) => {
+    await freshMigrations();
+  }
+)
+.command('migration:reset',
+  'Rolls back all migrations',
+  (yargs) => {
+    return yargs
+  },
+  async (argv) => {
+    await resetMigrations();
+  }
+)
+.parse();
 
 async function copyController(className) {
   const lowerName = className.toLowerCase()
@@ -232,17 +318,17 @@ async function startGenerateAdmin() {
   }
 }
 
-const seedFromJson = async (model, filePath) => {
+const importFromJson = async (model, filePath) => {
   try {
       const data = JSON.parse(await fsp.readFile(filePath, 'utf8'))
       await model.bulkCreate(data)
-      console.log(`Data seeded successfully! ${model.name}`)
+      console.log(`Data imported successfully! ${model.name}`)
   } catch (error) {
       console.error(error)
   }
 }
 
-const seedFromCsv = async (model, filePath, sep) => {
+const importFromCsv = async (model, filePath, sep) => {
   try {
       const data = await fsp.readFile(filePath, 'utf8')
       const clearData = data.replace(/"/g, '').trim()
@@ -261,16 +347,16 @@ const seedFromCsv = async (model, filePath, sep) => {
       })
 
       await model.bulkCreate(dataToInsert)
-      console.log(`Data seeded successfully! ${model.name}`)
+      console.log(`Data imported successfully! ${model.name}`)
   } catch (error) {
       console.error(error)
   }
 }
 
-async function runSeed(model, filePath, sep=',') {
+async function runImportData(model, filePath, sep=',') {
   
   if(!filePath || !model) {
-      console.log('Usage: node seed.js <modelName> <filePath> [sep]')
+      console.log('Usage: node db:import <modelName> <filePath> [sep]')
       process.exit(1)
   }
   
@@ -306,12 +392,107 @@ async function runSeed(model, filePath, sep=',') {
       await sequelize.sync({ force: true })
       await sequelize.authenticate()
       if(ext === '.csv') {
-          await seedFromCsv(modelObject, filePath, sep)
+          await importFromCsv(modelObject, filePath, sep)
       }else {
-          await seedFromJson(modelObject, filePath)
+          await importFromJson(modelObject, filePath)
       }        
   } catch (error) {
       console.error(error)
   }
 
 }
+
+async function createMigration(name) {
+  console.log('Create a new migration...', name)
+
+  const lowerName = name.toLowerCase()
+  const date = new Date()
+  const year = date.getFullYear()
+  const month = String(date.getMonth() + 1).padStart(2, '0')
+  const day = String(date.getDate()).padStart(2, '0')
+  const hours = String(date.getHours()).padStart(2, '0')
+  const minutes = String(date.getMinutes()).padStart(2, '0')
+  const seconds = String(date.getSeconds()).padStart(2, '0')
+  const timestamp = `${year}_${month}_${day}_${hours}${minutes}${seconds}`
+
+  const migrationName = `${timestamp}_${lowerName}`
+
+  const src = 'templates/migrationTemplate.js'
+  const dest = `database/migrations/${migrationName}.js`
+
+  if(await startCheckIfFileExists(dest)) {
+    process.exit(1);
+  }
+
+  await fse.copy(src, dest)
+
+  replace({
+      regex: 'thing',
+      replacement: name,
+      paths: [dest]
+  }) 
+
+}
+
+async function getUmzug() {
+  const { default: sequelize } = await import('./app/database/database.js')
+  const { Umzug, SequelizeStorage } = await import('umzug')
+
+  const umzug = new Umzug({
+    migrations: { glob: './database/migrations/*.js' },
+    context: sequelize.getQueryInterface(),
+    storage: new SequelizeStorage({ sequelize }),
+    logger: console
+  })
+
+  return umzug
+}
+
+async function startMigrations(name) {
+  if(name) {
+    await runOneMigration(name)
+  } else {
+    await runMigrations()
+  }
+}
+
+async function runOneMigration(name) {
+  console.log('Run one migration...', name)
+
+  if(!name.endsWith('.js')) {
+    name += '.js'
+  }
+
+  const migrationPath = `database/migrations/${name}`
+  if(!await startCheckIfFileExists(migrationPath)) {
+    console.log(`The migration file ${migrationPath} not already exists.`)
+    process.exit(1)
+  }
+
+  const umzug = await getUmzug()
+  await umzug.up()
+}
+
+async function runMigrations() {
+  console.log('Run migrations...')
+  const umzug = await getUmzug()
+  await umzug.up()
+}
+
+async function resetMigrations() {
+  console.log('Reset migrations...')
+  const umzug = await getUmzug()
+  await umzug.down({ to: 0 })
+}
+
+async function freshMigrations() {
+  console.log('Fresh migrations...')
+  await resetMigrations()
+  await runMigrations()
+}
+
+async function rollbackMigrations(step = 1) {
+  console.log('Rollback migrations...')
+  const umzug = await getUmzug()
+  await umzug.down({ step: step })
+}

package/expressapi/package.json

@@ -5,14 +5,14 @@
   "main": "index.js",
   "scripts": {
     "test": "mocha",
-    "dev": "nodemon app",
+    "dev": "nodemon app --watch app --watch config",
     "start": "node app"
   },
   "keywords": [
     "express",
     "api"
   ],
-  "author": "Sallai András",
+  "author": "your name",
   "license": "ISC",
   "dependencies": {
     "bcryptjs": "^2.4.3",
@@ -25,10 +25,13 @@
     "read": "^4.1.0",
     "replace": "^1.2.2",
     "sequelize": "^6.32.0",
-    "sqlite3": "^5.1.6"
+    "sqlite3": "^5.1.6",
+    "umzug": "^3.8.2",
+    "yargs": "^18.0.0"
   },
   "devDependencies": {
-    "fs-extra": "^11.3.0",    
+    "@types/bcryptjs": "^2.4.6",
+    "fs-extra": "^11.3.0",
     "nodemon": "^2.0.22",
     "supertest": "^6.3.3"
   },

package/expressapi/templates/controllerTemplate.js

@@ -41,9 +41,9 @@ const ThingController = {
             data: thing
         })
     },
-    async create(req, res) {
+    async store(req, res) {
         try {
-            await ThingController.tryCreate(req, res)
+            await ThingController.tryStore(req, res)
         }catch(error) {
             res.status(500)
             res.json({
@@ -53,7 +53,7 @@ const ThingController = {
             })
         }
     },
-    async tryCreate(req, res) {
+    async tryStore(req, res) {
         const thing = await Thing.create(req.body)
         res.status(201)
         res.json({

package/expressapi/templates/migrationTemplate.js

@@ -0,0 +1,21 @@
+import { DataTypes } from 'sequelize';
+
+async function up({context: QueryInterface}) {
+  await QueryInterface.createTable('things', {
+    id: {
+      allowNull: false,
+      autoIncrement: true,
+      primaryKey: true,
+      type: DataTypes.INTEGER
+    },
+    name: {
+      type: DataTypes.STRING
+    }
+  });
+}
+
+async function down({context: QueryInterface}) {
+  await QueryInterface.dropTable('things');
+}
+
+export { up, down }

package/package.json

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

package/expressapi/config/default.json

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