cityworks 0.0.28 → 0.0.32

package/src/search.ts

@@ -82,7 +82,9 @@ export class Search {
    */
   execute(searchId: number, options?: {EmployeeSid?: number, ExcludeEmptyXY?: boolean, Extent?: Object, Frequency?: boolean, IdsOnly?: boolean, IncludeSearchOrder?: boolean, MaxResults?: number, ResultFields?: Array<string>, TotalOnly?: boolean}) {
     return new Promise((resolve, reject) => {
-      var data = {}
+      var data = {
+        SearchId: searchId
+      }
       data = _.merge(data, options)
       this.cw.runRequest('Ams/Search/Execute', data).then(r => {
         resolve(r.Value)
@@ -106,7 +108,7 @@ export class Search {
     return new Promise((resolve, reject) => {
       if(!_.has(this.searchTypes, searchType)) {
         reject(new CWError(2, 'SearchType provided does not exist or is mispelled.', {'provided': searchType, 'available':this.searchTypes}))
-      } else if(typeof(applyToEntities)!='undefined' && applyToEntities!=null && (typeof(employeeSid)!='undefined' || typeof(domainId)!='undefined')) {
+      } else if(typeof(applyToEntities)!='undefined' && applyToEntities!=null && applyToEntities.length>0 && (typeof(employeeSid)!='undefined' || typeof(domainId)!='undefined')) {
         reject(new CWError(3, 'You cannot specify both applyToEntities AND employeeSid/domainId'))
       }
       var data = {}
@@ -244,18 +246,22 @@ export class Search {
   }
 
   /**
-   * Get search definition names
+   * Get search definitions
    *
    * @category Search Definitions
    * @param {Array<number>} searchIds - SearchIds to get.
-   * @return {Object} Returns Promise object that represents a collection of SearchDefinitionNames
+   * @param {number} employeeSid - Enforces employee security settings on search definition if provided.
+   * @return {Object} Returns Promise object that represents a collection of SearchDefinition objects
    */
-  getDefinitionNames(searchIds: Array<number>) {
+  getDefinitions(searchIds: Array<number>, employeeSid?: number) {
     return new Promise((resolve, reject) => {
       var data = {
         SearchIds: searchIds
       }
-      this.cw.runRequest('Ams/Search/DefinitionNames', data).then(r => {
+      if(typeof(employeeSid)!='undefined') {
+        _.set(data, 'EmployeeSid', employeeSid)
+      }
+      this.cw.runRequest('Ams/Search/Definitions', data).then(r => {
         resolve(r.Value)
       }).catch(e => {
         reject(e)
@@ -264,22 +270,18 @@ export class Search {
   }
 
   /**
-   * Get search definitions
+   * Get search definition names
    *
    * @category Search Definitions
    * @param {Array<number>} searchIds - SearchIds to get.
-   * @param {number} employeeSid - Enforces employee security settings on search definition if provided.
-   * @return {Object} Returns Promise object that represents a collection of SearchDefinition objects
+   * @return {Object} Returns Promise object that represents a collection of SearchDefinitionNames
    */
-  getDefinitions(searchIds: Array<number>, employeeSid?: number) {
+  getDefinitionNames(searchIds: Array<number>) {
     return new Promise((resolve, reject) => {
       var data = {
         SearchIds: searchIds
       }
-      if(typeof(employeeSid)!='undefined') {
-        _.set(data, 'EmployeeSid', employeeSid)
-      }
-      this.cw.runRequest('Ams/Search/Definitions', data).then(r => {
+      this.cw.runRequest('Ams/Search/DefinitionNames', data).then(r => {
         resolve(r.Value)
       }).catch(e => {
         reject(e)

package/src/workorder.ts

@@ -208,7 +208,7 @@ export class WorkOrder {
       var data = {}
       if(workOrderSIds.length==0) {
         // throw error
-        reject(new CWError(10, 'No workorder S/IDs were provided.', {'workorderSId': workOrderSIds}))
+        reject(new CWError(101, 'No workorder S/IDs were provided.', {'workorderSId': workOrderSIds}))
       } else {
         var path = 'Ams/WorkOrder/ByIds';
         if(_.isString(workOrderSIds[0])) {
@@ -242,7 +242,7 @@ export class WorkOrder {
       var data = {}
       if(workOrderSIds.length==0) {
         // throw error
-        reject(new CWError(10, 'No workorder S/IDs were provided.', {'workorderSId': workOrderSIds}))
+        reject(new CWError(102, 'No workorder S/IDs were provided.', {'workorderSId': workOrderSIds}))
       } else {
         var path = 'Ams/WorkOrder/ByIds';
         if(_.isString(workOrderSIds[0])) {

package/src/workorder_admin.ts

@@ -14,4 +14,235 @@ export class WorkOrderAdmin {
     this.cw = cw
   }
 
+  /**
+   * Get entity groups
+   *
+   * @category WorkOrders Admin
+   * @return {Object} Returns Promise that represents a collection of all entity groups
+   */
+  getEntityGroups() {
+    return new Promise((resolve, reject) => {
+      var data = {}
+      this.cw.runRequest('Ams/Entity/Groups', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get entity types
+   *
+   * @category WorkOrders Admin
+   * @return {Object} Returns Promise that represents a collection of all GIS Work Order entity types
+   */
+  getEntityTypes(entityGroups:Array<string>) {
+    return new Promise((resolve, reject) => {
+      var data = {EntityGroups: entityGroups}
+      this.cw.runRequest('Ams/Designer/WOTemplates', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get work order templates
+   *
+   * @category WorkOrders Admin
+   * @return {Object} Returns Promise that represents a collection of all Work Order templates
+   */
+  getTemplates(entityType:string, includeComments:boolean=true, includeInstructions:boolean=true) {
+    return new Promise((resolve, reject) => {
+      var data = {EntityType: entityType, IncludeComments: includeComments, IncludeInstructions: includeInstructions}
+      this.cw.runRequest('Ams/Designer/WOTemplates', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Update Work Order template
+   *
+   * @category WorkOrders Admin
+   * @param {Object} wOTemplate - Obect that describes the Work Order Template
+   * @return {Object} Returns Promise that represents a collection of all
+   */
+  updateTemplate(wOTemplate:Object) {
+    let valid_fields = ["AcctNum", "AutoCreateTask", "Cancel", "Comments", "CopyCustomFieldVal", "CycleFrom", "CycleIncludeWeekends", "CycleIntervalNum", "CycleIntervalUnit", "CycleType", "DaysToComplete", "DefaultProject", "DefaultProjectSid", "Description", "Effort", "ExpenseType", "Instructions", "IsReactive", "MaintScore", "NumDaysBefore", "Priority",   "RequireAssetOnClose", "Shop", "Stage", "SubmitToEmployeeSid", "SupervisorEmployeeSid", "UnitsAccompDesc", "UnitsAccompDescLock", "WOCategory", "WOCustFieldCatId", "WOPrintTmpt", "WOTemplateId", "WorkMonth"]
+    return new Promise((resolve, reject) => {
+      var data = wOTemplate
+      this.cw.runRequest('Ams/Designer/WOTemplates', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get template group rights for provided WorkOrder Templates
+   *
+   * @category WorkOrders Admin
+   * @param {Array<number>} wOTemplateIds - Array one or more WorkOrder Template IDs
+   * @return {Object} Returns Promise that represents a collection of all
+   */
+  getTemplateGroupRights(wOTemplateIds:Array<number>) {
+    return new Promise((resolve, reject) => {
+      var data = {WOTemplateIds: wOTemplateIds}
+      this.cw.runRequest('Ams/Designer/WOTemplates', data).then(r => { // TODO: Update this URL
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get template activity services for provided WorkOrder Templates
+   *
+   * @category WorkOrders Admin
+   * @param {Array<number>} wOTemplateIds - Array one or more WorkOrder Template IDs
+   * @return {Object} Returns Promise that represents a collection of all
+   */
+  getTemplateActivity(wOTemplateIds:Array<number>) {
+    return new Promise((resolve, reject) => {
+      var data = {WOTemplateIds: wOTemplateIds}
+      this.cw.runRequest('Ams/Designer/WOTemplateActivityService', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get fields which will be updated when provided WorkOrder Template instance closes
+   *
+   * @category WorkOrders Admin
+   * @param {Array<number>} wOTemplateIds - Array one or more WorkOrder Template IDs
+   * @return {Object} Returns Promise that represents a collection of all
+   */
+  getUpdateFields(wOTemplateIds:Array<number>) {
+    return new Promise((resolve, reject) => {
+      var data = {WOTemplateIds: wOTemplateIds}
+      this.cw.runRequest('Ams/Designer/WOTemplateUpdateFields', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get equipment
+   *
+   * @category WorkOrders Admin
+   * @param {Array<number>} wOTemplateIds - WorkOrder Template ID
+   * @return {Object} Returns Promise that represents a collection of all
+   */
+  getTemplateEquipment(wOTemplateId:number) {
+    return new Promise((resolve, reject) => {
+      var data = {WOTemplateId: wOTemplateId}
+      this.cw.runRequest('Ams/Designer/WOTemplateEquipment', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get labor
+   *
+   * @category WorkOrders Admin
+   * @param {Array<number>} wOTemplateIds - WorkOrder Template ID
+   * @return {Object} Returns Promise that represents a collection of all
+   */
+  getTemplateLabor(wOTemplateId:number) {
+    return new Promise((resolve, reject) => {
+      var data = {WOTemplateId: wOTemplateId}
+      this.cw.runRequest('Ams/Designer/WOTemplateLabor', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get material
+   *
+   * @category WorkOrders Admin
+   * @param {number} wOTemplateId - WorkOrder Template ID
+   * @return {Object} Returns Promise that represents a collection of all
+   */
+  getTemplateMaterial(wOTemplateId:number) {
+    return new Promise((resolve, reject) => {
+      var data = {WOTemplateId: wOTemplateId}
+      this.cw.runRequest('Ams/Designer/WOTemplateMaterial', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get map layer fields configured for provided work order template
+   *
+   * @category WorkOrders Admin
+   * @param {number} wOTemplateId - WorkOrder Template ID
+   * @return {Object} Returns Promise that represents a collection of all
+   */
+  getTemplateMapLayerFields(wOTemplateId:number) {
+    return new Promise((resolve, reject) => {
+      var data = {WorkOrderTemplateId: wOTemplateId}
+      this.cw.runRequest('Ams/Designer/WorkOrderTemplateMapLayerFields', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get tasks configured for provided work order template
+   *
+   * @category WorkOrders Admin
+   * @param {number} wOTemplateId - WorkOrder Template ID
+   * @return {Object} Returns Promise that represents a collection of all tasks on work order template
+   */
+  getTemplateTasks(wOTemplateId:number) {
+    return new Promise((resolve, reject) => {
+      var data = {WOTemplateId: wOTemplateId}
+      this.cw.runRequest('Ams/Tasks/ByWorkOrderTemplate', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
+
+  /**
+   * Get inspections connected to provided work order template
+   *
+   * @category WorkOrders Admin
+   * @param {number} wOTemplateId - WorkOrder Template ID
+   * @return {Object} Returns Promise that represents a collection of all tasks on work order template
+   */
+  getRelatedInspectionTemplates(wOTemplateId:number) {
+    return new Promise((resolve, reject) => {
+      var data = {WOTemplateId: wOTemplateId}
+      this.cw.runRequest('Ams/Designer/WOTemplateInspections', data).then(r => {
+        resolve(r.Value)
+      }).catch(e => {
+        reject(e)
+      })
+    })
+  }
 }

package/test/01.cityworksTest.js

@@ -28,7 +28,7 @@ describe('[Cityworks (construct)] function test', () => {
 describe('[Cityworks::authenticate] function test', () => {
     it('should throw Unknown Error if username provided is not known', (done) => {
       cw1.authenticate('myuser', 'mypassword').then(res => {
-        assert.isUndefined(cw1.Token);
+        // assert.isUndefined(cw1.Token);
         done();
       })
       .catch(error => {
@@ -38,19 +38,19 @@ describe('[Cityworks::authenticate] function test', () => {
     });
 
     // TODO: Uncomment for commit
-    // it('should throw invalid login error if password provided is not provided user\'s password', () => {
-    //   let cw4 = new Cityworks(process.env.domain, {path:process.env.path})
-    //   cw4.authenticate('mrrobot', 'mypassword').then(resp => {
-    //     assert.isNotEmpty(cw4.Token);
-    //     return true;
-    //   }).catch(error => {
-    //     assert.equal(error.message, 'Invalid Credentials');
-    //     return true;
-    //   });
-    // });
+    it('should throw invalid login error if password provided is not provided user\'s password', () => {
+      let cw4 = new Cityworks(process.env.domain, {path:process.env.path})
+      cw4.authenticate('mrrobot', 'mypassword').then(resp => {
+        // assert.isNotEmpty(cw4.Token);
+        return true;
+      }).catch(error => {
+        assert.equal(error.message, 'Invalid Credentials');
+        return true;
+      });
+    });
 });
 
-describe('[Citywork::validateToken] function test', () => {
+describe('[Cityworks::validateToken] function test', () => {
   it('should have a valid token set, if logged in', (done) => {
     cw1.authenticate(process.env.login, process.env.password).then(resp => {
       cw1.validateToken(cw1.Token).then(res => {

package/test/03.generalTest.js

@@ -0,0 +1,87 @@
+'use strict';
+ require('dotenv').config();
+ var chai = require('chai');
+ var expect = require('chai').expect;
+ var assert = require('chai').assert;
+ var chaiAsPromised = require("chai-as-promised");
+ chai.use(chaiAsPromised);
+ var Cityworks = require('../dist/index.js');
+ var cw3 = new Cityworks(process.env.domain, {path: process.env.path});
+
+ before(function(done) {
+   this.timeout(20000000);
+   cw3.authenticate(process.env.login, process.env.password).then(resp => {
+     done();
+   }).catch(e => {
+     console.log(e, 'unexpected error')
+     done();
+   });
+ });
+
+ describe('[General::notifications] function test', () => {
+   it('should resolve a collection', (done) => {
+     cw3.general.notifications().then(resp => {
+       assert.isArray(resp);
+       done();
+     });
+   });
+ });
+
+ describe('[General::amIWatching] function test', () => {
+   it('should reject with an error if the activity type is not available or does not exist', (done) => {
+     cw3.general.amIWatching('request', 42015).then(r => {
+     }).catch(e => {
+       assert.equal(e.message, 'Activity type provided does not exist.');
+       done();
+     });
+   });
+   it('should resolve a boolean', (done) => {
+     cw3.general.amIWatching('case', 42015).then(r => {
+       assert.isBoolean(r);
+       done();
+     });
+   });
+   it('should resolve with false if id does not exist', (done) => {
+     cw3.general.amIWatching('case', 200042015).then(r => {
+       assert.isFalse(r);
+       done();
+     }).catch(e => {
+       done();
+     });
+   });
+   it('should reject with an error if the activity id is too large', (done) => {
+     cw3.general.amIWatching('case', 10000000000).then(response => {
+     }).catch(e => {
+       assert.equal(e.message, 'Unknown error.');
+       done();
+     });
+   });
+ });
+
+ describe('[General::quickSearch] function test', () => {
+   it('should resolve results', (done) => {
+     cw3.general.quickSearch('256460').then(r => {
+       assert.property(r, 'Permits');
+       done();
+     });
+   });
+
+   it('should resolve (empty) results even when the string is not found', (done) => {
+     cw3.general.quickSearch('SomethingSidewalk').then(r => {
+       assert.property(r, 'Permits');
+       done();
+     });
+   });
+ });
+
+ describe('[General::getActivityMetadataByIds] function test', () => {
+   it('should resolve an activity based on the metadata ids');
+ });
+
+ describe('[General::getWOEntityCostSummary] function test', () => {
+   it('should get an Entity\'s cost summary');
+ });
+
+ describe('[General::searchWOEntityCostSummary] function test', () => {
+   it('should resolve reults of a search for cost summary of an entity');
+ });

package/test/04.requestTest.js

@@ -21,6 +21,14 @@ describe('[Request (construct)] function test', () => {
     assert.isObject(cw4.request, 'Request is an object');
     done();
   });
+  it('should have an admin property which is a defined object', (done) => {
+    assert.isObject(cw4.request.admin, 'Admin is an object');
+    done();
+  });
+  it('should have an comment property which is a defined object', (done) => {
+    assert.isObject(cw4.request.comment, 'Comment is an object');
+    done();
+  });
 });
 
 describe('[Request::getProblemNodes] function test', () => {

package/test/05.caseTest.js

@@ -8,7 +8,7 @@ const _ = require('lodash')
 
 before(function(done) {
   this.timeout(20000000);
-  cw5.authenticate(process.env.login, process.env.password).then(resp => {
+  cw5.authenticate(process.env.login, process.env.password).then(r => {
     done();
   }).catch(e => {
     console.log(e, 'unexpected error')
@@ -18,12 +18,93 @@ before(function(done) {
 
 describe('[Case (construct)] function test', () => {
   it('should be a defined object', (done) => {
-    assert.isObject(cw5.case, 'Request is an object');
+    assert.isObject(cw5.case, 'Case is an object');
+    done();
+  });
+  it('should have an financial property which is a defined object', (done) => {
+    assert.isObject(cw5.case.financial, 'Financial is an object');
+    done();
+  });
+  it('should have an data property which is a defined object', (done) => {
+    assert.isObject(cw5.case.data, 'Financial is an object');
+    done();
+  });
+  it('should have an workflow property which is a defined object', (done) => {
+    assert.isObject(cw5.case.workflow, 'Financial is an object');
+    done();
+  });
+  it('should have an comment property which is a defined object', (done) => {
+    assert.isObject(cw5.case.comment, 'Financial is an object');
+    done();
+  });
+  it('should have an admin property which is a defined object', (done) => {
+    assert.isObject(cw5.case.admin, 'Financial is an object');
     done();
   });
 });
 
-describe('[Case (construct)] function test', () => {
-  // it('should resolve a boolean', (done) => {
-  // });
+describe('[Case::create] function test', () => {
+  it('should resolve an object describing the new case', (done) => {
+    cw5.case.create(51, 93).then(r => {
+      assert.isObject(r);
+      done();
+    });
+  });
+  it('should resolve null if case type/subtype do not exist', (done) => {
+    cw5.case.create(999999, 99999999).then(r => {
+      assert.isNull(r);
+      done();
+    }).catch(e => {
+      console.log(e, 'unexpected error')
+      done();
+    });
+  });
+});
+
+describe('[Case::createChild] function test', () => {
+  it('should resolve an object describing the new case', (done) => {
+  });
+});
+
+describe('[Case::createFromRequest] function test', () => {
+  it('should resolve an object describing the new case', (done) => {
+  });
+});
+
+describe('[Case::update] function test', () => {
+  it('should resolve an object describing the updated case', (done) => {
+  });
+});
+
+describe('[Case::getByIds] function test', () => {
+  it('should resolve a collection of case objects', (done) => {
+  });
+});
+
+describe('[Case::search] function test', () => {
+  it('should resolve a collection of case objects meeting the search criteria', (done) => {
+  });
+});
+
+describe('[Case::move] function test', () => {
+  it('should resolve an object describing the moved case', (done) => {
+  });
+});
+
+describe('[Case::delete] function test', () => {
+  it('should resolve a 1 (success) or 0 (failure)', (done) => {
+    cw5.case.delete(44069).then(rez => {
+      expect(rez).to.satisfy(function (deletionSwitch) {
+          if (deletionSwitch===1 || deletionSwitch===0) {
+              return true;
+          } else {
+              return false;
+          }
+      });
+      done();
+    }).catch(e => {
+      console.log(e, 'unexpected error')
+      done();
+    });
+  });
 });