visualvault-api 1.2.0 → 2.0.0-beta.2

package/lib/VVRestApi/VVRestApiNodeJs/DocApi.js

@@ -1,66 +0,0 @@
-//DocApi
-var common = require('./common');
-
-module.exports = class DocApi {
-    constructor(sessionToken, docApiConfig) {
-        if (!sessionToken['tokenType'] && sessionToken['tokenType'] != 'jwt') {
-            return;
-        }
-
-        var yaml = require('js-yaml');
-        var fs = require('fs');
-        var yamlConfig = yaml.safeLoad(fs.readFileSync(__dirname + '/config.yml', 'utf8'));
-        this._httpHelper = new common.httpHelper(sessionToken, yamlConfig);
-
-        this.isEnabled = docApiConfig['isEnabled'] || false;
-        this.baseUrl = docApiConfig['apiUrl'] || null;
-        this.roleSecurity = docApiConfig['roleSecurity'] || false;
-
-    }
-
-    async GetRevision(documentRevisionId) {
-        let resourceUri = this._httpHelper._config.ResourceUri.DocApi.GetRevision;
-        resourceUri = resourceUri.replace('{id}', documentRevisionId);
-        const url = this._httpHelper.getUrl(resourceUri);
-        const opts = { method: 'GET' };
-
-        return this._httpHelper.doVvClientRequest(url, opts, null, null);
-    }
-
-    async getDocumentOcrStatus(documentRevisionId) {
-        let resourceUri = this._httpHelper._config.ResourceUri.DocApi.OcrStatus;
-        resourceUri = resourceUri.replace('{id}', documentRevisionId);
-        const url = this._httpHelper.getUrl(resourceUri);
-
-        const opts = { method: 'GET' };
-        return this._httpHelper.doVvClientRequest(url, opts, null, null);
-    }
-
-    async updateDocumentOcrStatus(documentRevisionId, data) {
-        let resourceUri = this._httpHelper._config.ResourceUri.DocApi.OcrStatus;
-        resourceUri = resourceUri.replace('{id}', documentRevisionId);
-        const url = this._httpHelper.getUrl(resourceUri);
-
-        const opts = { method: 'PUT' };
-        return this._httpHelper.doVvClientRequest(url, opts, null, data);
-    }
-
-    async search(criteriaList, searchFolders, excludeFolders, sortBy, sortDirection = 'desc', page = 0, take = 15, archiveType = 0, roleSecurity = false) {
-        const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.DocApi.AdvancedSearch);
-
-        var data = {
-            criteriaList,
-            searchFolders,
-            excludeFolders,
-            sortBy,
-            sortDirection,
-            page,
-            take,
-            archiveType,
-            roleSecurity
-        };
-
-        const options = { method: 'POST'};
-        return this._httpHelper.doVvClientRequest(url, options, null, data);
-    }
-}

package/lib/VVRestApi/VVRestApiNodeJs/FormsApi.js

@@ -1,51 +0,0 @@
-//forms api
-var common = require('./common');
-
-module.exports = class FormsApi {
-    constructor(sessionToken, formsApiConfig){
-        if(!sessionToken['tokenType'] && sessionToken['tokenType'] != 'jwt'){
-            return;
-        }
-        
-        var yaml = require('js-yaml');
-        var fs = require('fs');
-        var yamlConfig = yaml.safeLoad(fs.readFileSync(__dirname + '/config.yml', 'utf8'));
-        this._httpHelper = new common.httpHelper(sessionToken, yamlConfig);
-
-        this.isEnabled = formsApiConfig['isEnabled'] || false;
-        this.baseUrl = formsApiConfig['formsApiUrl'] || null;
-        
-        if(this.isEnabled){
-            this.formInstances = new FormInstanceManager(this._httpHelper);
-        }
-    }
-}
-
-class FormInstanceManager{
-    constructor(httpHelper){
-        this._httpHelper = httpHelper;
-    }
-
-    async postForm(params, data, formTemplateRevisionId) {
-        var resourceUri = this._httpHelper._config.ResourceUri.FormsApi.FormInstance;
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'POST' };
-
-        data['formTemplateId'] = formTemplateRevisionId || data['formTemplateId'];
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    async postFormRevision(params, data, formTemplateRevisionId, formId){
-        var resourceUri = this._httpHelper._config.ResourceUri.FormsApi.FormInstance;
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'PUT' };
-
-        // only add these if provided. params could already have the value
-        data['formTemplateId'] = formTemplateRevisionId || data['formTemplateId'];
-        data['formId'] = formId || data['formId'];
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-}
-

package/lib/VVRestApi/VVRestApiNodeJs/NotificationsApi.js

@@ -1,39 +0,0 @@
-// Notifications API
-var common = require('./common');
-
-module.exports = class NotificationsApi {
-    constructor(sessionToken, notificationsApiConfig) {
-        if(!sessionToken['tokenType'] && sessionToken['tokenType'] != 'jwt'){
-            return;
-        }
-
-        var yaml = require('js-yaml');
-        var fs = require('fs');
-        var yamlConfig = yaml.safeLoad(fs.readFileSync(__dirname + '/config.yml', 'utf8'));
-        console.log("Before")
-        this._httpHelper = new common.httpHelper(sessionToken, yamlConfig);
-        console.log('After');
-
-        this.isEnabled = notificationsApiConfig['isEnabled'] || false;
-        this.baseUrl = notificationsApiConfig['apiUrl'] || null;
-
-        if (this.isEnabled) {
-            this.users = new UserNotificationsManager(this._httpHelper);
-        }
-    }
-}
-
-class UserNotificationsManager {
-    constructor (httpHelper) {
-        this._httpHelper = httpHelper;
-    }
-
-    async forceUIRefresh(userGuid) {
-        var resourceUri = this._httpHelper._config.ResourceUri.NotificationsApi.ForceUIRefresh.replace('{id}', userGuid);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'POST' };
-        var params = {};
-        var data = {};
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-}

package/lib/VVRestApi/VVRestApiNodeJs/ObjectsApi.js

@@ -1,138 +0,0 @@
-//objects api
-var common = require('./common');
-
-module.exports = class ObjectsApi {
-    constructor(sessionToken, objectsApiConfig) {
-        if(!sessionToken['tokenType'] && sessionToken['tokenType'] != 'jwt') {
-            return;
-        }
-        
-        var yaml = require('js-yaml');
-        var fs = require('fs');
-        var yamlConfig = yaml.safeLoad(fs.readFileSync(__dirname + '/config.yml', 'utf8'));
-        this._httpHelper = new common.httpHelper(sessionToken, yamlConfig);
-
-        this.isEnabled = objectsApiConfig['isEnabled'] || false;
-        this.baseUrl = objectsApiConfig['apiUrl'] || null;
-    }
-
-    /**
-     * Retrieves a list of available models
-     * @param {object} params - Optional URL parameters to include in the request
-     */
-    async getModels(params) {
-        var resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.Models;
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-
-        params = params || {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, null);
-    }
-
-    /**
-     * Retrieves a specific model by its ID
-     * @param {string} modelId - The ID (Guid) for the requested model
-     * @param {object} params - Optional URL parameters to include in the request
-     */
-    async getModelById(modelId, params) {
-        var resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ModelById;
-        resourceUri = resourceUri.replace('{id}', modelId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-
-        params = params || {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, null);
-    }
-
-    /**
-     * Retrieves a specific object by its ID
-     * @param {string} objectId - The ID (Guid) for the requested object
-     * @param {object} params - Optional URL parameters to include in the request
-     */
-    async getObject(objectId, params) {
-        var resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ObjectById;
-        resourceUri = resourceUri.replace('{id}', objectId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-
-        params = params || {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, null);
-    }
-
-    /**
-     * Retrieves a paged list of objects associated with a given model
-     * @param {string} modelId - The ID (Guid) for the requested model to search
-     * @param {object} data - Data to send in the request body
-     * @param {object} params - Optional URL parameters to include in the request
-     */
-    async getObjectsByModelId(modelId, data, params) {
-        var resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ObjectSearchByModelId;
-        resourceUri = resourceUri.replace('{modelId}', modelId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'POST' };
-
-        data = data || {};
-        params = params || {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /**
-     * Creates a new object adhering to a given model
-     * @param {string} modelId - The ID (Guid) used to create a new object for that model
-     * @param {object} data - Data to send in the request body
-     * @param {object} params - Optional URL parameters to include in the request
-     */
-    async createObject(modelId, data, params) {
-        var resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.Object;
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'POST' };
-
-        data = data || {};
-        params = params || {};
-
-        data['modelId'] = modelId || data['modelId'];
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /**
-     * Updates an existing object by its ID (Guid) and revision ID (Guid)
-     * @param {string} objectId - The ID (Guid) for the requested object to update
-     * @param {string} objectRevisionId - The revision ID (Guid) for the requested object to update
-     * @param {object} data - Data to send in the request body
-     * @param {object} params - Optional URL parameters to include in the request
-     */
-    async updateObject(objectId, objectRevisionId, data, params) {
-        var resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ObjectById;
-        resourceUri = resourceUri.replace('{id}', objectId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'PUT' };
-
-        data = data || {};
-        params = params || {};
-
-        data['revisionId'] = objectRevisionId || data['revisionId'];
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /**
-     * Deletes an existing object by its ID (Guid)
-     * @param {string} objectId - The ID (Guid) for the requested object to delete
-     * @param {object} params - Optional URL parameters to include in the request
-     */
-    async deleteObject(objectId, params) {
-        var resourceUri = this._httpHelper._config.ResourceUri.ObjectsApi.ObjectById;
-        resourceUri = resourceUri.replace('{id}', objectId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'DELETE' };
-
-        params = params || {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, null);
-    }
-}

package/lib/VVRestApi/VVRestApiNodeJs/StudioApi.js

@@ -1,156 +0,0 @@
-//studio api
-var common = require('./common');
-
-module.exports = class StudioApi {
-    constructor(sessionToken, studioApiConfig){
-        if(!sessionToken['tokenType'] && sessionToken['tokenType'] != 'jwt'){
-            return;
-        }
-        
-        var yaml = require('js-yaml');
-        var fs = require('fs');
-        var yamlConfig = yaml.safeLoad(fs.readFileSync(__dirname + '/config.yml', 'utf8'));
-        this._httpHelper = new common.httpHelper(sessionToken, yamlConfig);
-
-        this.isEnabled = studioApiConfig['isEnabled'] || false;
-        this.baseUrl = studioApiConfig['studioApiUrl'] || null;
-        this.apiUrl = '';
-        
-        if(this.isEnabled){
-            this.workflow = new WorkflowManager(this._httpHelper);
-            this.permissions = new RolesAndPermissionsManager(this._httpHelper);
-        }
-    }
-}
-
-/** Manage Workflows */
-class WorkflowManager{
-    constructor(httpHelper){
-        this._httpHelper = httpHelper;
-    }
-
-    /** Gets the latest published workflow by Id*/
-    async getWorkflow(workflowId){
-        var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowLatestPublishedId.replace('{id}', workflowId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-        var data = {};
-        var params = {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /** Gets the latest published workflow by Name */
-    async getWorkflowByName(workflowName){
-        var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowLatestPublished;
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-        var data = {};
-        var params = { name: workflowName };
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /** Gets workflow variables assigned to the workflow */
-    async getWorkflowVariables(params, workflowId){
-        var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowVariables.replace('{id}', workflowId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-        var data = {};
-        params = params || {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /** 
-     * Triggers workflow
-     * @param {string} workflowId
-     * @param {number} workflowRevision
-     * @param {string} objectId
-     * @param {object[]} workflowVariables - workflow values to be submitted to the workflow
-     * * @param {string} workflowVariables[].name = name of variable
-     * * @param {*} workflowVariables[].value - value to be passed
-     * * @param {number} workflowVariables[].dataType - Text: 1, Number: 2, Date: 3, Boolean: 4
-     */
-    async triggerWorkflow(workflowId, workflowRevision, objectId, workflowVariables){
-        var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowRun.replace('{id}', workflowId).replace('{revision}', workflowRevision);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'POST' };
-        var data ={
-            objectId: objectId,
-            reference: 'API',
-            data: {
-                workflowVariables: workflowVariables,
-                dataSetVariables: []
-            }
-        };
-        var params = {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /**
-     * Terminates the workflow instance
-     * @param {string} workflowId 
-     * @param {string} instanceId 
-     * @returns 
-     */
-    async terminateWorkflow(workflowId, instanceId){
-        var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowTerminate.replace('{workflowId}', workflowId).replace('{instanceId}', instanceId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'POST' };
-        var data ={}
-        var params = {};
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /**
-         * Returns workflow history for an object under the provided workflow
-         * @param {string} workflowId 
-         * @param {string} objectId 
-         * @returns 
-         */
-    async GetWorkflowHistoryForObject(objectId, workflowId){
-        var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowHistoryObject.replace('{workflowId}', workflowId).replace('{objectId}', objectId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-        var data ={}
-        var params = {};
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-
-    /**
-     * Returns the running workflow, if any, for an object under the provided workflow
-     * @param {string} workflowId 
-     * @param {string} objectId 
-     * @returns 
-     */
-    async GetRunningWorkflowForObject(objectId, workflowId){
-        var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.WorkflowHistoryRunningObject.replace('{workflowId}', workflowId).replace('{objectId}', objectId);
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-        var data ={}
-        var params = {};
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-}
-
-class RolesAndPermissionsManager {
-    constructor(httpHelper) {
-        this._httpHelper = httpHelper;
-    }
-
-    /**
-     * Retrieves available features for the requesting user
-     * @param {object} params - Optional URL parameters to include in the request
-     */
-    async getUserFeatures(params) {
-        var resourceUri = this._httpHelper._config.ResourceUri.StudioApi.ResourceUserFeatures;
-        var url = this._httpHelper.getUrl(resourceUri);
-        var opts = { method: 'GET' };
-        var data = {};
-        params = params || {};
-
-        return this._httpHelper.doVvClientRequest(url, opts, params, data);
-    }
-}