mstate-cli 0.3.0 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mstate-cli",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "main": "index.js",
   "bin": {
     "mstate": "./dist/index.js"
@@ -15,7 +15,8 @@
     "mstate",
     "workflow",
     "cli",
-    "automation"
+    "automation",
+    "mobioffice"
   ],
   "author": "",
   "license": "ISC",

package/src/common/constant.ts

@@ -14,13 +14,6 @@ export const CRED_FILE_PATH = path.join(
 
 export const ENCRYPT_KEY: string = 'THIS_IS_MOBIOFFICE';
 
-// export const MSTATE_DOMAIN: string = `https://mstate.ai/`;
 export const MSTATE_DOMAIN: string = MSTATE_FRONTEND_URL;
-// export const MSTATE_DOMAIN: string = `https://dev.mstate.ai/`;
-
-// export const MSTATE_URL: string = 'https://dev.mstate.mobioffice.io/api';
 export const MSTATE_URL = MSTATE_API_URL;
-// export const MSTATE_URL = 'https://api.mstate.mobioffice.io/api';
-
 export const MOBIOFFICE_URL: string = MOBIOFFICE_API_URL;
-// export const MOBIOFFICE_URL: string = 'https://dev-server.mobioffice.io/api';

package/src/common/enum.ts

@@ -5,7 +5,7 @@ export enum CmdAction {
   DEV = 'dev',
   UNLINK = 'unlink',
   PERMISSION = 'permission',
-  USER = 'user',
+  ADD_USER = 'add-user',
   ADD = 'add',
   CLONE = 'clone',
   PUSH = 'push',
@@ -14,3 +14,13 @@ export enum CmdAction {
   VERSION = '--version',
   VERSION_FLAG = '-v',
 }
+
+export enum Variables {
+  WORKFLOW = '-w',
+  SECRET = '-s',
+  USER_ID = '-u',
+  PERMISSIONS = '-p',
+  COMPANY_ID = '-c',
+  EMAIL = '-e',
+  PHONE = '-m',
+}

package/src/common/helpers.ts

@@ -1,12 +1,28 @@
 import CryptoJS from 'crypto-js';
 import os from 'os';
 import { ENCRYPT_KEY } from './constant';
+import { customLog } from './utils';
+import { Variables } from './enum';
 
-export function getValueFromArgs(args: string[], key: string) {
-  return args.find((str) => str.includes(key))?.replace(key, '') ?? '';
+const variables = Object.entries(Variables);
+
+export function getValueFromArgs(key: string, allowed = false) {
+  const args = process.argv;
+  const variableIndex = args.indexOf(key);
+  const value = variableIndex !== -1 ? (args[variableIndex + 1] ?? '') : '';
+
+  if (allowed && !value) {
+    const [desc] = variables.find(([, flag]) => key === flag) ?? [];
+    customLog.changeAndThrow(
+      `Value for ${desc} is required. \n\t\t Use '${key}' flag for assigning value`,
+    );
+  }
+
+  return value;
 }
 
-export function hasFlag(args: string[], flag: string) {
+export function hasFlag(flag: string) {
+  const args = process.argv;
   return args.includes(flag.toUpperCase()) || args.includes(flag.toLowerCase());
 }
 

package/src/common/utils.ts

@@ -1,6 +1,7 @@
 import fs from 'fs';
 import { CRED_FILE_PATH, CRED_FOLDER_PATH } from './constant';
 import { decryptData, encryptData, getValueFromArgs } from './helpers';
+import { Variables } from './enum';
 
 export const customLog = {
   changeAndThrow(...message: string[]) {
@@ -45,15 +46,14 @@ export function getSecretKey() {
   try {
     const fileData = fs.readFileSync(CRED_FILE_PATH, 'utf8');
     const secret =
-      getValueFromArgs(process.argv, 'secret=') ||
-      decryptData(fileData)?.secret;
+      getValueFromArgs(Variables.SECRET) || decryptData(fileData)?.secret;
     if (!secret) {
       customLog.changeAndThrow(`Please login or Parameter secret is required`);
     }
 
     return secret;
   } catch (error) {
-    const secretKey = getValueFromArgs(process.argv, 'secret=');
+    const secretKey = getValueFromArgs(Variables.SECRET);
     if (secretKey) {
       return secretKey;
     }

package/src/handlers/action.handler.ts

@@ -3,37 +3,16 @@ import path from 'path';
 import { MSTATE_URL } from '../common/constant';
 import { getValueFromArgs } from '../common/helpers';
 import { customLog, getSecretKey } from '../common/utils';
-
-enum Key {
-  WORKFLOW = 'workflow=',
-  SECRET_KEY = 'secret=',
-  TYPE = 'type=',
-}
+import { Variables } from 'src/common/enum';
 
 class ActionHandler {
   constructor() {}
 
   async cloneActions() {
-    const args = process.argv;
-    const workflowName = getValueFromArgs(args, Key.WORKFLOW);
+    const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
     const secretKey = getSecretKey();
-    const type = getValueFromArgs(args, Key.TYPE);
-
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!workflowName) {
-      customLog.changeAndThrow(`Parameter workflow is required`);
-      return;
-    }
 
     let query = `?workflow=${workflowName}`;
-    if (type) {
-      query += `&type=${type}`;
-    }
-
     const url = `${MSTATE_URL}/action/config/all/${query}`;
 
     const responseJSON = await fetch(url, {
@@ -73,28 +52,12 @@ class ActionHandler {
   }
 
   async saveToDB() {
-    const args = process.argv;
-    const workflowName = getValueFromArgs(args, Key.WORKFLOW);
-    const type = getValueFromArgs(args, Key.TYPE);
+    const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
     const secretKey = getSecretKey();
 
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!workflowName) {
-      customLog.changeAndThrow(`Parameter workflow is required`);
-      return;
-    }
-
     const folderPath = path.resolve(workflowName, 'actions');
 
     let query = `?workflow=${workflowName}`;
-    if (type) {
-      query += `&type=${type}`;
-    }
-
     // loop to every folder to publish workflow
     fs.readdir(folderPath, (err, files) => {
       if (!files) return;

package/src/handlers/company.handler.ts

@@ -9,49 +9,23 @@ import { getValueFromArgs } from '../common/helpers';
 import open from 'open';
 import express from 'express';
 import cors from 'cors';
-
-enum Key {
-  PERMISSIONS = 'permissions=',
-  SECRET_KEY = 'secret=',
-  USER_ID = 'user=',
-  NAME = 'name=',
-  EMAIL = 'email=',
-  PHONE = 'phone=',
-  COMPANY_ID = 'company=',
-}
+import { Variables } from 'src/common/enum';
 
 class CompanyHandler {
   constructor() {}
 
   async addToken() {
-    const args = process.argv;
-
-    const pString = getValueFromArgs(args, Key.PERMISSIONS).trim();
+    const pString = getValueFromArgs(Variables.PERMISSIONS).trim();
     const permissions = pString.split(',').map((s) => s.trim());
     const secretKey = getSecretKey();
-    const user = getValueFromArgs(args, Key.USER_ID);
-    const companyID = getValueFromArgs(args, Key.COMPANY_ID);
+    const user = getValueFromArgs(Variables.USER_ID, true);
+    const companyID = getValueFromArgs(Variables.COMPANY_ID, true);
 
     if (!permissions.length && permissions[0]?.length) {
       customLog.changeAndThrow(`Parameter permissions is required`);
       return;
     }
 
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!user) {
-      customLog.changeAndThrow(`Parameter user is required`);
-      return;
-    }
-
-    if (!companyID) {
-      customLog.changeAndThrow(`Parameter company is required`);
-      return;
-    }
-
     const url = `${MSTATE_URL}/company/permission`;
     const responseJSON = await fetch(url, {
       method: 'POST',
@@ -78,32 +52,10 @@ class CompanyHandler {
   }
 
   async addUser() {
-    const args = process.argv;
-
     const secretKey = getSecretKey();
-    const name = getValueFromArgs(args, Key.NAME);
-    const email = getValueFromArgs(args, Key.EMAIL);
-    const phone = getValueFromArgs(args, Key.PHONE);
-
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!name) {
-      customLog.changeAndThrow(`Parameter name is required`);
-      return;
-    }
-
-    if (!email) {
-      customLog.changeAndThrow(`Parameter email is required`);
-      return;
-    }
-
-    if (!phone) {
-      customLog.changeAndThrow(`Parameter phone is required`);
-      return;
-    }
+    const name = getValueFromArgs(Variables.USER_ID, true);
+    const email = getValueFromArgs(Variables.EMAIL, true);
+    const phone = getValueFromArgs(Variables.PHONE, true);
 
     const url = `${MSTATE_URL}/um/user`;
     const responseJSON = await fetch(url, {
@@ -133,34 +85,17 @@ class CompanyHandler {
   }
 
   async revokePermission() {
-    const args = process.argv;
-
-    const pString = getValueFromArgs(args, Key.PERMISSIONS);
+    const pString = getValueFromArgs(Variables.PERMISSIONS);
     const permissions = pString.split(',').map((s) => s.trim());
     const secretKey = getSecretKey();
-    const user = getValueFromArgs(args, Key.USER_ID);
-    const companyID = getValueFromArgs(args, Key.COMPANY_ID);
+    const user = getValueFromArgs(Variables.USER_ID, true);
+    const companyID = getValueFromArgs(Variables.COMPANY_ID, true);
 
     if (!permissions.length && permissions[0]?.length) {
       customLog.changeAndThrow(`Parameter permissions is required`);
       return;
     }
 
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!user) {
-      customLog.changeAndThrow(`Parameter user is required`);
-      return;
-    }
-
-    if (!companyID) {
-      customLog.changeAndThrow(`Parameter company is required`);
-      return;
-    }
-
     const url = `${MSTATE_URL}/company/permission`;
     const responseJSON = await fetch(url, {
       method: 'DELETE',
@@ -259,8 +194,8 @@ class CompanyHandler {
   }
 
   logToken() {
-    customLog.info('Token', getSecretKey());
     customLog.info('MSTATE_URL', MSTATE_URL);
+    customLog.info('Token', getSecretKey());
   }
 }
 

package/src/handlers/environment.handler.ts

@@ -3,36 +3,16 @@ import path from 'path';
 import { MSTATE_URL } from '../common/constant';
 import { customLog, getSecretKey } from '../common/utils';
 import { getValueFromArgs } from '../common/helpers';
-
-enum Key {
-  WORKFLOW = 'workflow=',
-  SECRET_KEY = 'secret=',
-  TYPE = 'type=',
-}
+import { Variables } from 'src/common/enum';
 
 class EnvironmentHandler {
   constructor() {}
 
   async cloneEnvironments() {
-    const args = process.argv;
-    const workflowName = getValueFromArgs(args, Key.WORKFLOW);
+    const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
     const secretKey = getSecretKey();
-    const type = getValueFromArgs(args, Key.TYPE);
-
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!workflowName) {
-      customLog.changeAndThrow(`Parameter workflow is required`);
-      return;
-    }
 
     let query = `?workflow=${workflowName}`;
-    if (type) {
-      query += `&type=${type}`;
-    }
     const url = `${MSTATE_URL}/env/${query}`;
 
     const responseJSON = await fetch(url, {
@@ -57,21 +37,8 @@ class EnvironmentHandler {
   }
 
   async saveToDB() {
-    const args = process.argv;
-
-    const workflowName = getValueFromArgs(args, Key.WORKFLOW);
+    const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
     const secretKey = getSecretKey();
-    const type = getValueFromArgs(args, Key.TYPE) || undefined;
-
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!workflowName) {
-      customLog.changeAndThrow(`Parameter workflow is required`);
-      return;
-    }
 
     const filePath = path.resolve(workflowName, 'environment.json');
 
@@ -89,7 +56,6 @@ class EnvironmentHandler {
         body: JSON.stringify({
           workflow: workflowName,
           env: environments,
-          type,
         }),
       });
 

package/src/handlers/help.handler.ts

@@ -1,9 +1,9 @@
-import { CmdAction } from '../common/enum';
+import { CmdAction, Variables } from '../common/enum';
 import { customLog } from '../common/utils';
 
 class HelpHandler {
   logCommandInfo() {
-    console.log('\n\nUsage: mstate [cmd] [parameter]="[value]"\n');
+    console.log('\n\nUsage: mstate <command> [arguments] \n');
 
     console.log('Commands:');
     customLog.info(CmdAction.ADD, 'Create a new workflow');
@@ -12,6 +12,7 @@ class HelpHandler {
       'Clone workflow with actions and environments',
     );
     customLog.info(CmdAction.PUSH, 'Update the changes one in cloned workflow');
+    customLog.info(CmdAction.ADD_USER, 'Add new user to your company');
     customLog.info(
       CmdAction.LINK,
       'Add workflow and allow user to view workflow in the mobioffice application',
@@ -27,15 +28,50 @@ class HelpHandler {
   }
 
   logActionInfo(action: CmdAction) {
+    console.log('Used Arguments: ');
+
     switch (action) {
       case CmdAction.ADD:
+        customLog.info(
+          Variables.WORKFLOW,
+          'Specifying workflow name with path',
+        );
+        break;
+      case CmdAction.CLONE:
+        customLog.info(
+          Variables.WORKFLOW,
+          'Specifying workflow name with path',
+        );
+        break;
+      case CmdAction.LINK:
+      case CmdAction.UNLINK:
+        customLog.info(
+          Variables.WORKFLOW,
+          'Specifying workflow name with path',
+        );
+        customLog.info(Variables.COMPANY_ID, 'Specifying company nickname');
+        customLog.info(Variables.USER_ID, 'Specifying user phone number');
+        break;
+      case CmdAction.PUSH:
+        customLog.info(
+          Variables.WORKFLOW,
+          'Specifying workflow name with path',
+        );
+        break;
+      case CmdAction.ADD_USER:
+        customLog.info(
+          Variables.USER_ID,
+          'Specifying user unique name for the company',
+        );
+        customLog.info(Variables.EMAIL, 'Specifying user email');
+        customLog.info(Variables.PHONE, 'Specifying user phone number');
         break;
       default:
         customLog.error(
-          `${action ? 'Invalid' : 'Missing'} script: ${action ?? ''}`,
+          `${action ? 'Invalid' : 'Missing'} command: ${action ?? ''}`,
         );
         console.log(
-          `use 'mstate ${CmdAction.HELP_FLAG}, ${CmdAction.HELP}' for getting allowed action`,
+          `\t\t use 'mstate ${CmdAction.HELP_FLAG}, ${CmdAction.HELP}' for getting allowed action`,
         );
     }
   }

package/src/handlers/mobioffice.handler.ts

@@ -1,52 +1,18 @@
 import { MOBIOFFICE_URL } from '../common/constant';
-import { CmdAction } from '../common/enum';
+import { CmdAction, Variables } from '../common/enum';
 import { getValueFromArgs } from '../common/helpers';
 import { customLog, getSecretKey } from '../common/utils';
 
-enum Key {
-  WORKFLOW = 'workflow=',
-  PERMISSIONS = 'permissions=',
-  SECRET_KEY = 'secret=',
-  COMPANY_NAME = 'company=',
-  USER_ID = 'user=',
-  TYPE = 'type=',
-}
-
 class MobiofficeHandler {
-  private MOBIOFFICE_URL: string = MOBIOFFICE_URL;
-
   constructor() {}
 
   async linkToMobioffice(action: CmdAction.LINK | CmdAction.UNLINK) {
-    const args = process.argv;
-
-    const workflowName = getValueFromArgs(args, Key.WORKFLOW);
+    const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
     const secretKey = getSecretKey();
-    const companyName = getValueFromArgs(args, Key.COMPANY_NAME);
-    const user = getValueFromArgs(args, Key.USER_ID);
-    const type = getValueFromArgs(args, Key.TYPE) || 'private';
-
-    if (!workflowName) {
-      customLog.changeAndThrow(`Parameter workflow is required`);
-      return;
-    }
-
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!companyName) {
-      customLog.changeAndThrow(`Parameter company is required`);
-      return;
-    }
-
-    if (!user) {
-      customLog.changeAndThrow(`Parameter user is required`);
-      return;
-    }
+    const companyName = getValueFromArgs(Variables.COMPANY_ID, true);
+    const user = getValueFromArgs(Variables.USER_ID, true);
 
-    const url = `${this.MOBIOFFICE_URL}/Mstate/workFlow/user`;
+    const url = `${MOBIOFFICE_URL}/Mstate/workFlow/user`;
     const responseJSON = await fetch(url, {
       method: 'POST',
       headers: {
@@ -58,7 +24,6 @@ class MobiofficeHandler {
         workflow: workflowName,
         secret: secretKey,
         nickname: companyName,
-        type,
         user,
       }),
     });

package/src/handlers/workflow.handler.ts

@@ -3,25 +3,13 @@ import path from 'path';
 import { MSTATE_URL } from '../common/constant';
 import { customLog, getSecretKey } from '../common/utils';
 import { getValueFromArgs } from '../common/helpers';
-
-enum Key {
-  PATH = 'path=',
-  FILE = 'file=',
-  SECRET_KEY = 'secret=',
-  WORKFLOW = 'workflow=',
-  TYPE = 'type=',
-}
+import { Variables } from 'src/common/enum';
 
 class WorkflowHandler {
   constructor() {}
 
-  async addNewWorkflow() {
+  private async addNewWorkflow(workflowPath: string, file: string) {
     try {
-      const args = process.argv;
-
-      const workflowPath = getValueFromArgs(args, Key.PATH);
-      const file = getValueFromArgs(args, Key.FILE);
-      const type = getValueFromArgs(args, Key.TYPE);
       const secretKey = getSecretKey();
 
       if (!file) {
@@ -46,10 +34,6 @@ class WorkflowHandler {
         query = '?' + query;
       }
 
-      if (type) {
-        query += query ? `&type=${type}` : `?type=${type}`;
-      }
-
       const url = `${MSTATE_URL}/workflow/config/new${query}`;
       const responseJSON = await fetch(url, {
         method: 'POST',
@@ -75,22 +59,9 @@ class WorkflowHandler {
   }
 
   async updateWorkflowToDB() {
-    const args = process.argv;
-
-    const workflowName = getValueFromArgs(args, Key.WORKFLOW);
-    const type = getValueFromArgs(args, Key.TYPE);
+    const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
     const secretKey = getSecretKey();
 
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!workflowName) {
-      customLog.changeAndThrow(`Parameter workflow is required`);
-      return;
-    }
-
     const folderPath = path.resolve(workflowName);
     const filePath = path.join(folderPath, 'workflow.json');
 
@@ -98,10 +69,6 @@ class WorkflowHandler {
 
     let query = `?workflow=${workflowName}`;
 
-    if (type) {
-      query += `&type=${type}`;
-    }
-
     const url = `${MSTATE_URL}/workflow/config${query}`;
     const responseJSON = await fetch(url, {
       method: 'PUT',
@@ -126,25 +93,10 @@ class WorkflowHandler {
   }
 
   async cloneWorkflow() {
-    const args = process.argv;
-
-    const workflowName = getValueFromArgs(args, Key.WORKFLOW);
-    const type = getValueFromArgs(args, Key.TYPE);
-
+    const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
     const secretKey = getSecretKey();
 
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!workflowName) {
-      customLog.changeAndThrow(`Parameter workflow is required`);
-      return;
-    }
-    const typeQuery = type ? `&type=${type}` : '';
-
-    const url = `${MSTATE_URL}/workflow/config/?workflow=${workflowName}${typeQuery}`;
+    const url = `${MSTATE_URL}/workflow/config/?workflow=${workflowName}`;
     const responseJSON = await fetch(url, {
       method: 'GET',
       headers: {
@@ -174,47 +126,28 @@ class WorkflowHandler {
 
   async copyWorkflow() {
     try {
-      const args = process.argv;
+      const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
 
-      const workflowName = getValueFromArgs(args, Key.WORKFLOW);
-
-      if (!workflowName) {
-        customLog.changeAndThrow(`Parameter workflow is required`);
-        return;
-      }
+      let path = '';
+      let file = '';
 
       const workflowPath = ('/' + workflowName).replace(/\/([^\/]*)$/, '');
       if (workflowPath) {
-        process.argv.push(`path=${workflowPath.slice(1, workflowPath.length)}`);
+        path = workflowPath.slice(1, workflowPath.length);
       }
-      process.argv.push(`file=${workflowName + '/workflow.json'}`);
+      file = workflowName + '/workflow.json';
 
-      await this.addNewWorkflow();
+      await this.addNewWorkflow(path, file);
     } catch (error: any) {
       customLog.changeAndThrow(error.message);
     }
   }
 
   async resetCache() {
-    const args = process.argv;
-    const type = getValueFromArgs(args, Key.TYPE);
-
-    const workflowName = getValueFromArgs(args, Key.WORKFLOW);
+    const workflowName = getValueFromArgs(Variables.WORKFLOW, true);
     const secretKey = getSecretKey();
 
-    if (!secretKey) {
-      customLog.changeAndThrow(`Parameter secret is required`);
-      return;
-    }
-
-    if (!workflowName) {
-      customLog.changeAndThrow(`Parameter workflow is required`);
-      return;
-    }
-
-    const typeQuery = type ? `&type=${type}` : '';
-
-    const url = `${MSTATE_URL}/cache/reset/?workflow=${workflowName}${typeQuery}`;
+    const url = `${MSTATE_URL}/cache/reset/?workflow=${workflowName}`;
     const responseJSON = await fetch(url, {
       method: 'DELETE',
       headers: {