visualvault-api 1.1.0

package/lib/VVRestApi/VVRestApiNodeJs/samples/SendEmailScript.js

@@ -0,0 +1,51 @@
+
+// Send Email using VisualVault API
+
+var logger = require('../log');
+
+module.exports.getCredentials = function () {
+    var options = {};
+	
+	//Your customer name found in the VisualVault URL
+    options.customerAlias = "ACME";
+	
+	//Your customer database name found in the VisualVault URL
+    options.databaseAlias = "main5";
+	
+	//User account credentials
+    options.userId = "vault.config";	
+    options.password = "p";
+	
+	//Developer account or registered OAuth application credentials
+	options.clientId = "fbb02e0c-2e97-4527-a6d7-9438d8b7b23c";
+    options.clientSecret = "bBb+IlcCV5duoyyHvrYYamSrDVMGf+rgJ4Gbhn6R7N4=";
+
+    return options;
+};
+
+module.exports.main = function (vvClient, response) {
+    var currentDate = new Date();
+    var Q = require('q');
+
+    var emailParams = '';
+    var emailData = {};
+    emailData.recipients = 'someone@visualvault.com';
+    emailData.body = 'test';
+    emailData.subject = 'scheduled script test';
+
+	//Q is a node package used to create promise objects
+	//Node.js scripts are asynchronous!
+	
+    Q
+        .allSettled(
+            [
+                vvClient.email.postEmails(emailParams, emailData)
+            ]
+        )
+        .then(function (result) {
+            logger.info("PostEmails success");
+        })
+        .fail(function (error) {
+            logger.info("Error response from postEmails: " + error.message);
+        });   
+}

package/lib/VVRestApi/VVRestApiNodeJs/samples/fileTest.js

@@ -0,0 +1,60 @@
+// credentials
+module.exports.getCredentials = function () {
+    var options = {};
+    options.customerAlias = "customer";
+    options.databaseAlias = "alias";
+    options.userId = "userId";    
+    options.password = "password";
+    options.clientId = "clientId";
+    options.clientSecret = "clientSecret";
+
+    return options;
+};
+
+module.exports.main = function (vvClient, response, token) {   
+    var Q = require('q');
+    // message for writing file called
+    function err(){console.log("wrote file!");}    
+    // first promise to get related documents of a form by id
+    Q
+    .when(
+        // get form related documents
+        vvClient.forms.getFormRelatedDocs('34260ABE-22C1-E511-A698-E094676F83F7')
+        )
+        
+    .then(
+        function (result) {
+            var response = JSON.parse(result);
+            // grabs the first id from response object
+            var id = response.data[0].id;
+                // 2nd promise taking in the id from the first promise and passing it into the second. 
+                Q
+                .when( 
+                    // request file bytes by id
+                    vvClient.files.getFileBytesId(id)
+                    )
+                .then(
+                    function (result) {
+                        // the result will be the buffer (byte array) of requested file.
+                        var bytes = result;
+                        // log bytes to console or proceed with buisness logic.
+                        // Here I write the bytes to the file system.
+                        console.log(bytes);
+                        var fs = require('fs');
+                        fs.writeFile("c:/nodeTest/textNEW.xlsx",bytes,err);
+                        }
+                    )                 
+                
+                .fail(
+                function (error) {
+                    console.log(error);
+                });  
+                        
+            }
+        )                 
+    
+    .fail(
+     function (error) {
+        console.log(error);
+     });
+};

package/lib/VVRestApi/VVRestApiNodeJs/samples/sampleFormValidationScript.js

@@ -0,0 +1,126 @@
+
+
+
+module.exports.getCredentials = function () {
+    var options = {};
+    options.customerAlias = "sampleCustomer";
+    options.databaseAlias = "main";
+    options.userId = "sample.user";
+    options.password = "mypassword";
+    options.clientId = "ce9e042d-87f5-42d5-97af-435aff70152b";
+    options.clientSecret = "/PbgaChHbPoboS/1s07E6pfHCNFSdqPsD3B/yiKHfHw=";
+
+
+    return options;
+};
+
+module.exports.main = function (ffColl, vvClient, response) {
+    console.log('In user Main method');
+    var meta = { code: 200, error: '' };
+    
+    try {
+        //example of accessing formfields to be validated
+        var outArray = [];
+        var ff1 = ffColl.getFormFieldByName("Name");
+        if (ff1 != null) {
+            console.log('Field 1 name: ' + ff1.name);
+            console.log('Field 1 name: ' + ff1.value);
+            outArray.push(ff1);
+        }
+
+        ff1 = ffColl.getFormFieldByName("Dept");
+        if (ff1 != null) {
+            console.log('Field 2 name: ' + ff1.name);
+            console.log('Field 2 name: ' + ff1.value);
+            outArray.push(ff1);
+        }
+
+        //setup parameters for making requests to VisualVault
+        var formParams = {};
+        formParams.fields = "id, name, description, revision";
+
+        var siteParams = {};
+        siteParams.fields = "id, name, sitetype";
+
+        var foldersData = {};
+        foldersData.q = '';
+        foldersData.fields = 'id,name';
+        foldersData.folderpath = '/General';
+        foldersData.metaonly = 'true';
+
+        var Q = require('q');
+
+        //.sites.getSites(siteParams),
+
+        //make request to VisualVault
+        Q
+            .allSettled(
+                [
+                    vvClient.forms.getFormTemplates(formParams),
+                    vvClient.sites.getSites(siteParams),
+                    vvClient.library.getFolders(foldersData)
+
+                ]
+            )
+            .then(
+                function (promises) {
+                    console.log("Results count: " + promises.length);
+
+                    //example of accessing returned data from request to VisualVault
+                    var promiseFormTemplates = promises[0];
+                    if (promiseFormTemplates.state == 'fulfilled'){
+                        var responseData = JSON.parse(promiseFormTemplates.value);
+                    
+                        var formTemplates = responseData.data;
+                    
+                        console.log("Listing Form Templates");
+                        for (var x=0; x < formTemplates.length; x++){
+                            var formTemplate = formTemplates[x];
+                            console.log('FormTemplate Id: ' + formTemplate.id);
+                            console.log('FormTemplate Name: ' + formTemplate.name);
+                        }
+                    }
+
+                    var outputCollection = [];
+
+                    var fld = new vvClient.forms.returnField(
+                        outArray[0].id,
+                        outArray[0].name,
+                        'New replacement value',
+                        false,
+                        '');
+                    outputCollection.push(fld);
+
+                    var fld1 = new vvClient.forms.returnField(
+                        outArray[1].id,
+                        outArray[1].name,
+                        '',
+                        true,
+                        'This field is required');
+                    outputCollection.push(fld1);
+
+                    console.log("Returning: " + outputCollection);
+
+                    response.json(200, outputCollection);
+                }
+            )
+            .fail(
+                function (error) {
+                    console.log(error);
+                    
+                    meta.code = 400;
+                    meta.error = "An error occurred while validating form";
+                    response.json(200, meta);
+                }
+            );
+
+
+
+
+    } catch (ex) {
+        meta.code = 400;
+        meta.error = "An exception occurred while validating form";
+        response.json(200, meta);
+    }
+
+};

package/lib/VVRestApi/VVRestApiNodeJs/views/error.ejs

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+    <meta charset="utf-8">
+    <title>VisualVault NodeJs Client Library</title>
+</head>

package/lib/VVRestApi/VVRestApiNodeJs/views/index.ejs

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+    <meta charset="utf-8">
+    <title>VisualVault NodeJs Client Library</title>
+</head>

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "visualvault-api",
+  "version": "1.1.0",
+  "description": "Simplifies the use of VisualVault REST APIs from a Node.Js app",
+  "main": "lib/VVRestApi/VVRestApiNodeJs/VVRestApi.js",
+  "_comments": [
+    {
+      "checkout-node-sdk-v5": "file:checkout-node-sdk-v5-5.4.0.tgz",
+      "comment": "This dependency has been removed from the dependencies. It may be required to support a specific customer feature."
+    }
+  ],
+  "dependencies": {
+    "@aws-sdk/client-comprehend": "^3.418.0",
+    "@esri/arcgis-rest-request": "^4.5.0",
+    "amazon-textract-response-parser": "^0.3.1",
+    "aws-sdk": "^2.1472.0",
+    "axios": "^1.9.0",
+    "body-parser": "^1.18.3",
+    "cors": "^2.8.5",
+    "cross-fetch": "^3.1.4",
+    "csv": "^4.0.0",
+    "currency.js": "^2.0.4",
+    "dayjs": "^1.11.7",
+    "digest-fetch": "^1.1.6",
+    "ejs": "^2.6.1",
+    "eml-parser": "^2.0.3",
+    "exceljs": "^4.4.0",
+    "express": "^4.16.3",
+    "express-error-handler": "^1.1.0",
+    "fetch": "^1.1.0",
+    "file-type-es5": "^6.2.1",
+    "form-data": "^4.0.2",
+    "FormData": "^0.10.1",
+    "https": "^1.0.0",
+    "isomorphic-form-data": "^2.0.0",
+    "js-yaml": "^2.1.3",
+    "jsforce": "^1.9.1",
+    "jsonwebtoken": "^9.0.2",
+    "libreoffice-convert": "^1.5.1",
+    "moment": "^2.22.2",
+    "moment-business-days": "^1.2.0",
+    "moment-timezone": "^0.5.23",
+    "mssql": "^6.0.1",
+    "multer": "^1.3.1",
+    "node-fetch": "^2.6.1",
+    "node-uuid": "^1.4.1",
+    "p-limit": "^3.1.0",
+    "parse-full-name": "^1.2.6",
+    "pdf-lib": "^1.17.1",
+    "pdf-merger-js": "^4.3.1",
+    "properties-reader": "^2.3.0",
+    "puppeteer": "^13.0.0",
+    "q": "^0.9.7",
+    "read-chunk": "^3.2.0",
+    "request": "^2.27.0",
+    "serve-favicon": "^2.5.0",
+    "ssh2-sftp-client": "^8.1.0",
+    "ssl-root-cas": "^1.3.1",
+    "sweetalert2": "^11.17.2",
+    "talisman": "^1.1.3",
+    "text-encoder": "^0.0.4",
+    "winston": "^2.4.2",
+    "winston-cloudwatch": "^1.13.1",
+    "winston-cloudwatch-transport": "^1.0.8"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "echo \"Ready to publish VVRestApi library\""
+  },
+  "keywords": [
+    "visualvault",
+    "api",
+    "rest",
+    "client",
+    "document",
+    "management",
+    "forms",
+    "nodejs"
+  ],
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "files": [
+    "lib/VVRestApi/**/*",
+    "README.md",
+    "package.json"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/VisualVault/nodeJs-rest-client-library.git"
+  },
+  "author": "VisualVault",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/VisualVault/nodeJs-rest-client-library/issues"
+  },
+  "homepage": "https://github.com/VisualVault/nodeJs-rest-client-library#readme"
+}