profoundjs 6.2.0 → 6.4.0

package/setup/modules/papisamples/README.md

@@ -0,0 +1,17 @@
+
+# Profound API Samples
+
+A sample Profound API program. Server-side API logic is defined in low-code and JavaScript. A client-side program exists to demonstrate calling the API end point.
+
+## Sample GET, POST, PUT, DELETE, and Grid Request
+
+Run the sample user interface by clicking either
+* Launch > Launch App in Browser Tab
+* Launch > Launch App in IDE
+
+## Files
+* APISample.api.json - the server-side logic for the API endpoints, as Low Code steps
+* APISample.js - program logic for the sample user interface to interact with the APIs
+* APISample.json - sample user interface to interact with the APIs
+* hobbyshop.csv - sample data file
+* readCSVFile.js - sample module to handle reading and writing to the data file. Used in Low Code steps.

package/setup/modules/papisamples/hobbyshop.csv

@@ -0,0 +1,6 @@
+1,Nintendo Switch,200,8
+2,AC Ambient,100 ,6
+3,XBOX one,120,3
+4,Sega Saturn,120,3
+5,Playstation 3,100,5
+6,bicycle gears,16,18

package/setup/modules/papisamples/readCSVFile.js

@@ -0,0 +1,136 @@
+"use strict";
+/**
+ * A utility function to read a CSV file and output its contents in a pre-determined format.
+ */
+const fs = require("fs"); // filestream module
+const readline = require("readline"); // line-by-line reading module
+
+/**
+ * Read a file line by line and output an object with its contents, with each field as properties of the object.
+ * @param {String} filename
+ * @param {Number} rowID
+ * @returns {Object}
+ */
+async function fileRead(filename, rowID = 0) {
+  let fLength = 0;
+  const lData = [];
+  let lTemp = null;
+  // Start a file stream to read the file line-by-line
+  const fstream = fs.createReadStream(filename);
+  const linereader = readline.createInterface({
+    input: fstream,
+    crlfDelay: Infinity // used to identify all \r\n entries in the file as single line breaks
+  });
+
+  // Start reading the lines of the file
+  for await (const line of linereader) {
+    fLength++;
+    if (rowID == 0) { // read the whole file, parse each line into arrays
+      lTemp = line.split(",");
+      lData.push({ ID: lTemp[0], Name: lTemp[1], Price: lTemp[2], Quantity: lTemp[3] });
+    }
+    else if (fLength == rowID) {
+      lTemp = line.split(",");
+      lData.push({ ID: lTemp[0], Name: lTemp[1], Price: lTemp[2], Quantity: lTemp[3] });
+    }
+  };
+
+  return { length: fLength, data: lData };
+}
+
+/**
+ * Read a file line by line, changing the specified line, and then write the data back to the file.
+ * Return a message indicating which row was updated.
+ * The original file is changed.
+ * @param {String} filename
+ * @param {Number} rowID
+ * @returns {String}
+ */
+async function fileUpdate(filename, rowID, data) {
+  let fLength = 0;
+  // Start a file stream to read the file line-by-line
+  const fstream = fs.createReadStream(filename);
+  const linereader = readline.createInterface({
+    input: fstream,
+    crlfDelay: Infinity // used to identify all \r\n entries in the file as single line breaks
+  });
+
+  let strUpdated = "";
+
+  // Start reading the lines of the file
+  for await (const line of linereader) {
+    fLength++;
+    if (fLength == rowID) {
+      strUpdated += fLength + "," + data + "\n"; // update the specific line if found
+    }
+    else strUpdated += line + "\n";
+  };
+  linereader.close();
+  fstream.close();
+
+  // remove the last entry of \n
+  strUpdated = strUpdated.substring(0, strUpdated.length - 1);
+
+  const message = await new Promise((resolve, reject) => {
+    // rewrite the file with the updated data
+    fs.writeFile(filename, strUpdated, (err) => {
+      if (err) reject(err);
+      else resolve("Row ID: " + iID + "\nData Updated: " + data);
+    });
+  });
+
+  return message;
+}
+
+/**
+ * Read a file line by line and build a string with the file contents, with the line specified by rowID removed.
+ * Write the new string to the file, overwriting the original file.
+ * Return a message indicating which row was deleted.
+ * @param {String} filename
+ * @param {Number} rowID
+ * @returns {String}
+ */
+async function lineDelete(filename, rowID) {
+  let iCol = 0;
+  let fLength = 0;
+  let strUpdated = "";
+  let strTemp = "";
+  // Start a file stream to read the file line-by-line
+  const fstream = fs.createReadStream(filename);
+  const linereader = readline.createInterface({
+    input: fstream,
+    crlfDelay: Infinity // used to identify all \r\n entries in the file as single line breaks
+  });
+
+  // Start reading the lines of the file
+  for await (const line of linereader) {
+    fLength++;
+    if (fLength < rowID) { // Copy the line as is if it's not the row ID requested
+      strUpdated += line + "\n";
+    }
+    else if (fLength > rowID) { // Update the first column to reflect the correct line
+      iCol = line.indexOf(","); // find first occurence of , as the first column
+      strTemp = line.substring(iCol, line.length); // move the , and the data to temp string
+      strUpdated += (fLength - 1) + strTemp + "\n"; // add the line and its updated column number
+    }
+  };
+  linereader.close();
+  fstream.close();
+
+  // remove the last entry of \n
+  strUpdated = strUpdated.substring(0, strUpdated.length - 1);
+
+  // Write the strUpdated string to the file at filename:
+  const message = new Promise((resolve, reject) => {
+    fs.writeFile(filename, strUpdated, (err) => {
+      if (err) reject(err);
+      else resolve("Row " + rowID + " deleted.");
+    });
+  });
+
+  return message;
+}
+
+exports.fileRead = fileRead;
+exports.fileUpdate = fileUpdate;
+exports.lineDelete = lineDelete;

package/setup/plugins/mathoperation.js

@@ -0,0 +1,84 @@
+
+module.exports = {
+	
+    name: "Math-Operation",
+    
+	// The title that is displayed for this sample plugin on the plugin selection
+	text: "Math Operation",
+    
+	// The plugin category that the sample plugin will be placed into.
+	// A category will be created if the category name does not currently exist
+	category: "Sample User Plugins",
+    
+	// The help text that is displayed when the help icon is clicked on this plugin's menu
+	help: `This plugin does a math operation set by the user for 2 different numbers from 2 widget sources`,
+    
+	// Specifies if the plugin is a client-side or server-side step. A plugin is server-side by default.
+	clientSide: true,
+    
+	context: "rdf",
+    
+	// An array used to generate the plugin questions and assign values set by the user.
+	questions: [
+
+        {
+            id: "firstNumber",
+            text: "ID of Widget containing the first number",
+            required: true,
+			insertDynamic: true,
+            dynamicSource: "widgets"
+        },
+
+        {
+            id: "secondNumber",
+            text: "ID of Widget containing the second number",
+            required: true,
+            insertDynamic: true,
+            dynamicSource: "widgets"
+        },
+		
+		{
+			id: "operation",
+			text: "Math operation",
+			required: true,
+			type: "dropdown",
+			source: ["+","-","*","/"],
+			required: true
+		},
+		
+		{
+			id: "result",
+			text: "ID of Widget where result will be stored",
+			required: true,
+			insertDynamic: true,
+			dynamicSource: "widgets"
+		}
+    ],
+    
+	// This is where code is generated for the plugin once the questions are answered.
+	// You can also see this code via the "convert to code" plugin icon.
+	generator: function(answers) {
+		
+		let result = 0;
+		let code = "";
+		
+		switch (answers["operation"]) {
+        
+			case "+":
+				code = 'pui.set( "' + answers.result + '", parseInt( pui.get("' + answers.firstNumber + '") ) + parseInt( pui.get("' + answers.secondNumber + '") ) );';
+				break;
+			case "-":
+				code = 'pui.set( "' + answers.result + '", parseInt( pui.get("' + answers.firstNumber + '") ) - parseInt( pui.get("' + answers.secondNumber + '") ) );';
+				break;
+			case "*":
+				code = 'pui.set( "' + answers.result + '", parseInt( pui.get("' + answers.firstNumber + '") ) * parseInt( pui.get("' + answers.secondNumber + '") ) );';
+				break;	
+			case "/":
+				code = 'pui.set( "' + answers.result + '", parseInt( pui.get("' + answers.firstNumber + '") ) / parseInt( pui.get("' + answers.secondNumber + '") ) );';
+				break;	
+				
+		}
+		
+        return code;
+    }
+}

package/setup/removeExtraComponents.js

@@ -3,7 +3,7 @@
 
 /*
   Discovers and removes additional components that exist outside of the package installation directory.
-  
+
   It's used by Profound Installer
 
   Any changes to the behavior may require changes to the "install_info.json" file or Profound Installer.
@@ -15,9 +15,8 @@ const readline = require("readline");
 
 const IBMi = iutils.isIBMi();
 
-(async () => {
+(async() => {
   try {
-
     // Parse arguments.
     const argDefs = {
       alias: {
@@ -39,7 +38,7 @@ const IBMi = iutils.isIBMi();
 
     // Show help and quit, if requested.
     if (args["help"] === true) {
-const HELP = `Usage: node removeExtraComponents.js [OPTION]
+      const HELP = `Usage: node removeExtraComponents.js [OPTION]
 -h, --help        Print this help and exit.
 -d, --dry-run     Report what items would be removed, without removing them.
 -s, --silent      Bypass confirmation prompt.
@@ -170,7 +169,6 @@ It is intended to be used before uninstalling the package via NPM.
     }
     console.log("Removal of extra components complete.");
     process.stdin.destroy();
-
   }
   catch (error) {
     process.stdin.destroy();
@@ -194,7 +192,7 @@ function exec(command, quiet = false) {
   const opts = {
     env: {
       QIBM_USE_DESCRIPTOR_STDIO: "Y",
-      QIBM_MULTI_THREADED: "N",
+      QIBM_MULTI_THREADED: "N"
     },
     stdio: "pipe",
     windowsHide: true

package/setup/setup.js

@@ -38,7 +38,7 @@ let logFile;
 
 let SILENT_MODE = false;
 
-(async () => {
+(async() => {
   try {
     // Parse arguments.
     const args = minimist(
@@ -63,7 +63,7 @@ let SILENT_MODE = false;
           "ibmi-instance-node-path",
           "nodegit-version"
         ],
-        unknown: function (arg) {
+        unknown: function(arg) {
           console.error("Unknown argument:", arg);
           process.exit(1);
         }
@@ -253,6 +253,15 @@ let SILENT_MODE = false;
       log("Creating modules directory.");
       fs.mkdirSync(path.join(deployDir, "modules"));
     }
+	
+	// Create plugins directory. 
+    if (directoryExists(path.join(deployDir, "plugins"))) {
+      log("plugins directory exists.");
+    }
+    else {
+      log("Creating plugins directory.");
+      fs.mkdirSync(path.join(deployDir, "plugins"));
+    }
 
     // Grant PROFOUNDJS user all permissions to modules directory tree.
     if (IBMi) {
@@ -280,6 +289,15 @@ let SILENT_MODE = false;
       log("Creating puidnlexit.js.");
       copyFile(path.join(__dirname, "modules", "puidnlexit.js"), path.join(deployDir, "modules"), "utf8");
     }
+	
+	// Create mathoperation.js.
+    if (fileExists(path.join(deployDir, "plugins", "mathoperation.js"))) {
+      log("mathoperation.js file exists.");
+    }
+    else {
+      log("Creating mathoperation.js.");
+      copyFile(path.join(__dirname, "plugins", "mathoperation.js"), path.join(deployDir, "plugins"), "utf8");
+    }
 
     // Create samples directory.
     if (directoryExists(path.join(deployDir, "modules", "pjssamples"))) {
@@ -288,6 +306,13 @@ let SILENT_MODE = false;
     log("Copying pjssamples.");
     copyDir(path.join(__dirname, "modules", "pjssamples"), path.join(deployDir, "modules"));
 
+    // Create PAPI samples directory
+    if (directoryExists(path.join(deployDir, "modules", "papisamples"))) {
+      fs.removeSync(path.join(deployDir, "modules", "papisamples"));
+    }
+    log("Copying papisamples.");
+    copyDir(path.join(__dirname, "modules", "papisamples"), path.join(deployDir, "modules"));
+
     // Create store_credentials.js.
     if (fileExists(path.join(deployDir, "store_credentials.js"))) {
       log("store_credentials.js file exists.");
@@ -306,6 +331,17 @@ let SILENT_MODE = false;
       log("store_options.js created.");
     }
 
+    // Begin OAuth2 requirements.
+    // Create encrypt_client_file.js.
+    if (fileExists(path.join(deployDir, "encrypt_client_file.js"))) {
+      log("encrypt_client_file.js file exists.");
+    }
+    else {
+      copyFile(path.join(__dirname, "encrypt_client_file.js"), deployDir, "utf8");
+      log("encrypt_client_file.js created.");
+    }
+    // End OAuth2 requirements.
+
     // Create call.js.
     if (fileExists(path.join(deployDir, "call.js"))) {
       log("call.js file exists.");
@@ -414,17 +450,17 @@ let SILENT_MODE = false;
   }
 })();
 
-function log (...args) {
+function log(...args) {
   console.log(...args);
   logToFile(...args);
 }
 
-function logError (...args) {
+function logError(...args) {
   console.error(...args);
   logToFile(...args);
 }
 
-function logToFile (...args) {
+function logToFile(...args) {
   if (SILENT_MODE) {
     return;
   }
@@ -433,7 +469,7 @@ function logToFile (...args) {
   fs.writeFileSync(logFile, output, { flag: "a" });
 }
 
-function die () {
+function die() {
   logError(`\n${RED}Profound.js installation failed.${RESET}`);
   if (!SILENT_MODE) {
     console.error(`${RED}See installation log:${RESET} ${logPath}\n`);
@@ -441,11 +477,11 @@ function die () {
   process.exit(1);
 }
 
-function copyDir (dir, destinationDir) {
+function copyDir(dir, destinationDir) {
   const dirName = path.basename(dir);
   fs.mkdirSync(path.join(destinationDir, dirName));
   const files = fs.readdirSync(dir);
-  files.forEach(function (file, index) {
+  files.forEach(function(file, index) {
     if (fs.lstatSync(path.join(dir, file)).isDirectory()) { // recurse
       copyDir(path.join(dir, file), path.join(destinationDir, dirName));
     }
@@ -455,7 +491,7 @@ function copyDir (dir, destinationDir) {
   });
 }
 
-function copyFile (file, destination, type) {
+function copyFile(file, destination, type) {
   if (type == null) type = "binary";
   let toFile;
   if (directoryExists(destination)) {
@@ -468,9 +504,9 @@ function copyFile (file, destination, type) {
   fs.writeFileSync(toFile, content, type);
 }
 
-function createPuiscreens (deployDir) {
+function createPuiscreens(deployDir) {
   const targetPuiScreensFile = path.join(deployDir, "modules", "puiscreens.json");
-  function copyFileOldVersionIs (version, compareStr) {
+  function copyFileOldVersionIs(version, compareStr) {
     compareStr = compareStr || "=";
     log("Found Standard puiscreens.json file version " + compareStr + " " + version + ", replacing with current version...");
     copyFile(path.join(__dirname, "modules", "puiscreens.json"), targetPuiScreensFile, "utf8");
@@ -598,7 +634,7 @@ function createPuiscreens (deployDir) {
   }
 }
 
-function directoryExists (dir) {
+function directoryExists(dir) {
   let exists = false;
   try {
     const stat = fs.statSync(dir);
@@ -610,7 +646,7 @@ function directoryExists (dir) {
   return exists;
 }
 
-function fileExists (file) {
+function fileExists(file) {
   let exists = false;
   try {
     const stat = fs.statSync(file);
@@ -622,7 +658,7 @@ function fileExists (file) {
   return exists;
 }
 
-function runCommand (command, switches) {
+function runCommand(command, switches) {
   log("Executing IBM i command: " + command);
   const args = [command];
   if (typeof switches == "string") {