cityworks 0.0.37 → 0.0.39

package/src/workorder_admin.ts

@@ -1,248 +0,0 @@
-import { CWError } from './error'
-const _ = require('lodash')
-
-export class WorkOrderAdmin {
-  /**
-   * @hidden
-   */
-  cw: any
-
-  /**
-   * @hidden
-   */
-  constructor(cw) {
-    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 WorkOrder 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 WorkOrder templates
-   *
-   * @category WorkOrders Admin
-   * @return {Object} Returns Promise that represents a collection of all WorkOrder 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 WorkOrder template
-   *
-   * @category WorkOrders Admin
-   * @param {Object} wOTemplate - Obect that describes the WorkOrder 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 WorkOrder 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 WorkOrder template
-   *
-   * @category WorkOrders Admin
-   * @param {number} wOTemplateId - WorkOrder Template ID
-   * @return {Object} Returns Promise that represents a collection of all tasks on WorkOrder 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 WorkOrder template
-   *
-   * @category WorkOrders Admin
-   * @param {number} wOTemplateId - WorkOrder Template ID
-   * @return {Object} Returns Promise that represents a collection of all tasks on WorkOrder 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

@@ -1,80 +0,0 @@
-'use strict';
-require('dotenv').config();
-var expect = require('chai').expect;
-var assert = require('chai').assert;
-var Cityworks = require('../dist/index.js');
-var cw1;
-
-before(function(done) {
-  this.timeout(20000000);
-  done();
-});
-
-beforeEach(function() {
-  return cw1 = new Cityworks(process.env.domain, {path:process.env.path});
-});
-
-describe('[Cityworks (construct)] function test', () => {
-    it('should return a Cityworks object', (done) => {
-        assert.isObject(cw1, 'cw is an object');
-        done();
-    });
-    it('should not have a token set if authentication not run', (done) => {
-      assert.isUndefined(cw1.Token);
-      done();
-    });
-});
-
-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);
-        done();
-      })
-      .catch(error => {
-        assert.equal(error.message, 'Unknown Error');
-        done();
-      });
-    });
-
-    // 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;
-      });
-    });
-});
-
-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 => {
-        assert.isTrue(res);
-        done();
-      }).catch(error => {
-        console.log(error, 'unexpected error');
-        done();
-      });
-    }).catch(error => {
-      console.log(error, 'unexpected error');
-      done();
-    });
-  })
-})
-
-describe('[Cityworks::setToken] function test', () => {
-  it('should have set token', (done) => {
-    cw1.authenticate(process.env.login, process.env.password).then(res => {
-      assert.isTrue(cw1.setToken(cw1.Token));
-      done();
-    }).catch(error => {
-      console.log(error, 'unexpected error');
-      done();
-    });
-  })
-})

package/test/02.activitylinkTest.js

@@ -1,58 +0,0 @@
-'use strict';
-require('dotenv').config();
-var expect = require('chai').expect;
-var assert = require('chai').assert;
-var Cityworks = require('../dist/index.js');
-var cw2 = new Cityworks(process.env.domain, {path: process.env.path});
-
-before(function(done) {
-  this.timeout(20000000);
-  cw2.authenticate(process.env.login, process.env.password).then(resp => {
-    done();
-  }).catch(e => {
-    console.log(e, 'unexpected error')
-    done();
-  });
-});
-
-describe('[ActivityLink (construct)] function test', () => {
-  it('should be a defined object', (done) => {
-    assert.isObject(cw2.activity_link, 'ActivityLink is an object');
-    done();
-  });
-});
-
-describe('[ActivityLink::get] function test', () => {
-  it('should return error if type doesn\'t exist', (done) => {
-    cw2.activity_link.get('something').then(resp => {
-    }).catch(error => {
-      assert.equal(error.message, 'Activity type not found.');
-      done();
-    });
-  });
-
-  it('should return collection', (done) => {
-    cw2.activity_link.get('case', [10512]).then(resp => {
-      assert.isArray(resp);
-      done();
-    }).catch(error => {
-      console.log(error, 'unexpected error');
-      done();
-    });
-  });
-});
-
-describe('[ActivityLink::clone] function test', () => {
-  it('should create a clone of an existing link, if it exists');
-  it('should not create a clone of an existing link, if it does not exist');
-});
-
-describe('[ActivityLink::delete] function test', () => {
-  it('should delete an activity link if the ID is found');
-  it('should fail to delete an activity link if the ID cannot be found');
-});
-
-describe('[ActivityLink::remove] function test', () => {
-  it('should remove a link when all items provided');
-  it('should fail when any 1 item is not provided');
-});

package/test/03.generalTest.js

@@ -1,87 +0,0 @@
-'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');
- });