cityworks 0.0.37 → 0.0.38

package/README.md

@@ -6,6 +6,8 @@ Require the class:
 
       const Cityworks = require('cityworks')
 
+      import { Cityworks } from 'cityworks'
+
 Instantiate the Class for the instance of Cityworks available given a domain:
 
       let cw = new Cityworks('cw.domain.tld', {path: 'cityworks'})
@@ -23,11 +25,11 @@ Authenticate with the Cityworks install:
 
 Get the currently valid token in order to store it in a session or cookie:
 
-      cityworks.getToken()
+      cw.getToken()
 
 Provide a saved token instead of the standard u/p auth:
 
-      cityworks.setToken('mytoken')
+      cw.setToken('mytoken')
 
 ## Main method calls
 

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "cityworks",
-  "version": "0.0.37",
+  "version": "0.0.38",
   "description": "A Cityworks API wrapper",
   "main": "dist/index.js",
   "umd:main": "dist/index.umd.js",
   "module": "dist/index.m.js",
   "source": "src/index.ts",
+  "files": ["dist/*"],
   "directories": {
     "test": "test"
   },

package/index.js

@@ -1 +0,0 @@
-module.exports require('./dist/index.js');

package/src/activity_link.ts

@@ -1,241 +0,0 @@
-import { CWError } from './error'
-import ReversibleMap from 'reversible-map'
-const _ = require('lodash')
-
-/**
- * ActivityLink interface for ActivityLinks
- *
- */
-export interface ActivityLink {
-  linkTypes: ReversibleMap<string, number>
-  activityTypes: ReversibleMap<string, number>
-  cw: any
-}
-
-/**
- * ActivityLinks implements the activity link functions via using the ActivityLink interface
- *
- */
-export class ActivityLinks implements ActivityLink {
-  /**
-   * Activity types to map string to number for internal use. Activity types available are:
-   *
-   *      "null", "case", "inspection", "request", "workorder", "wipcase"
-   */
-  activityTypes: ReversibleMap<string, number>
-  /**
-   * Link types to map string to number for internal use. Link types available are:
-   *
-   *      "null", "parent", "related"
-   */
-  linkTypes: ReversibleMap<string, number>
-  /**
-   * @hidden
-   */
-  cw: any
-
-  /**
-   * @hidden
-   */
-  constructor(cw) {
-    this.cw = cw
-    this.activityTypes = new ReversibleMap<string, number>()
-    this.activityTypes.set("null", 0)
-    this.activityTypes.set("case", 1)
-    this.activityTypes.set("inspection", 2)
-    this.activityTypes.set("request", 3)
-    this.activityTypes.set("workorder", 4)
-    this.activityTypes.set("wipcase", 5)
-
-    this.linkTypes = new ReversibleMap<string, number>()
-    this.linkTypes.set("null", 0)
-    this.linkTypes.set("parent", 1)
-    this.linkTypes.set("related", 2)
-  }
-
-  /**
-   * Create a new activity link between two items.
-   *
-   * @param {string} source_type - Source type as string. Options:
-   *
-   *      "null", "case", "inspection", "request", "workorder", "wipcase"
-   *
-   * @param {number} source_sid - Source SID (numeric ID) one wishes to remove a link between SID as source and a particular destination
-   * @param {string} destination_type - Destination type as string
-   *
-   *      "null", "case", "inspection", "request", "workorder", "wipcase"
-   *
-   * @param {number} destination_sid - Destination SID (numeric ID) one wishes to remove a link between SID as destination and a particular source
-   * @param {string} link_type - The type of link which exists between provided source and destination. Defaults to `related`. Options:
-   *
-   *      "null", "parent", "related"
-   *
-   * @return {Object} Returns Promise object that represents a
-   */
-  add(source_type: string, source_sid: number, destination_type: string, destination_sid: number, link_type: string = 'related') {
-    return new Promise((resolve, reject) => {
-      if(!this.activityTypes.has(source_type)) {
-        reject(new CWError(1, 'Source type not found.', {'provided': source_type, 'options':this.activityTypes}))
-      }
-      if(!this.activityTypes.has(destination_type)) {
-        reject(new CWError(2, 'Destination type not found.', {'provided': destination_type, 'options':this.activityTypes}))
-      }
-      if(!this.linkTypes.has(link_type)) {
-        reject(new CWError(3, 'Link type not found.', {'provided': link_type, 'options':this.linkTypes}))
-      }
-      let data = {
-        SourceType: this.activityTypes.get(source_type),
-        SourceSid: source_sid,
-        DestType: this.activityTypes.get(destination_type),
-        DestSid: destination_sid,
-        LinkType: this.linkTypes.get(link_type)
-      }
-      let path = 'General/ActivityLink/Add'
-      this.cw.runRequest(path, data).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get the links for a particular node type by ID.
-   *
-   * @param {string} type - Source type as string. Options:
-   *
-   *      "null", "case", "inspection", "request", "workorder", "wipcase"
-   *
-   * @param {Array<number>} sids - Array of numeric (S)IDs you wish to get of the specified type
-   * @return {Object} Returns Promise object that represents a collection
-   */
-  get(type: string, sids: Array<number>) {
-    return new Promise((resolve, reject) => {
-      if(!this.activityTypes.has(type)) {
-        reject(new CWError(4, 'Activity type not found.', {'provided': type, 'options':this.activityTypes}))
-      }
-      let data = {
-        ActivityType: this.activityTypes.get(type),
-        ActivitySids: sids
-      }
-      let _this = this
-      let path = 'General/ActivityLink/ByActivitySids'
-      this.cw.runRequest(path, data).then((response: any) => {
-        let return_data = new Array()
-        _.forEach(response.Value, (link, key) => {
-          link.DestType = _this.activityTypes.get(link.DestType)
-          link.SourceType = _this.activityTypes.get(link.SourceType)
-          link.LinkType = _this.linkTypes.get(link.LinkType)
-          return_data.push(link)
-        })
-        resolve(return_data)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Clone a current activity link.
-   *
-   * @param {string} source_type - Source type as string. Options:
-   *
-   *      "null", "case", "inspection", "request", "workorder", "wipcase"
-   *
-   * @param {number} source_sid - Source SID (numeric ID) one wishes to clone a link between SID as source and a particular destination
-   * @param {string} destination_type - Destination type as string
-   *
-   *      "null", "case", "inspection", "request", "workorder", "wipcase"
-   *
-   * @param {number} destination_sid - Destination SID (numeric ID) one wishes to clone a link between SID as destination and a particular source
-   * @return {Object} Returns Promise object that represents a
-   */
-  clone(source_type: string, source_sid: number, destination_type: string, destination_sid: number) {
-    return new Promise((resolve, reject) => {
-      if(!this.activityTypes.has(source_type)) {
-        reject(new CWError(1, 'Source type not found.', {'provided': source_type, 'options':this.activityTypes}))
-      }
-      if(!this.activityTypes.has(destination_type)) {
-        reject(new CWError(2, 'Destination type not found.', {'provided': destination_type, 'options':this.activityTypes}))
-      }
-      let data = {
-        SourceActivityType: this.activityTypes.get(source_type),
-        SourceActivitySid: source_sid,
-        DestinationActivityType: this.activityTypes.get(destination_type),
-        DestinationActivitySid: destination_sid
-      }
-      let path = 'General/ActivityLink/CloneByActivitySid'
-      this.cw.runRequest(path, data).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Delete an activity link by ID
-   *
-   * @param {number} activity_link_id - The ID of the activity link one wishes to delete
-   * @return {Object} Returns Promise object that represents a
-   */
-  delete(activity_link_id: number) {
-    return new Promise((resolve, reject) => {
-      let data = {
-        ActivityLinkId: activity_link_id
-      }
-      let path = 'General/ActivityLink/Delete'
-      this.cw.runRequest(path, data).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Remove a link by specifying everything.
-   *
-   * @param {string} source_type - Source type as string. Options:
-   *
-   *      "null", "case", "inspection", "request", "workorder", "wipcase"
-   *
-   * @param {number} source_sid - Source SID (numeric ID) one wishes to remove a link between SID as source and a particular destination
-   * @param {string} destination_type - Destination type as string
-   *
-   *      "null", "case", "inspection", "request", "workorder", "wipcase"
-   *
-   * @param {number} destination_sid - Destination SID (numeric ID) one wishes to remove a link between SID as destination and a particular source
-   * @param {string} link_type - The type of link which exists between provided source and destination. Defaults to `related`. Options:
-   *
-   *      "null", "parent", "related"
-   *
-   * @return {Object} Returns Promise object that represents a
-   */
-  remove(source_type: string, source_sid: number, destination_type: string, destination_sid: number, link_type: string = 'related') {
-    return new Promise((resolve, reject) => {
-      if(!this.activityTypes.has(source_type)) {
-        reject(new CWError(1, 'Source type not found.', {'provided': source_type, 'options':this.activityTypes}))
-      }
-      if(!this.activityTypes.has(destination_type)) {
-        reject(new CWError(1, 'Destination type not found.', {'provided': destination_type, 'options':this.activityTypes}))
-      }
-      if(!this.linkTypes.has(link_type)) {
-        reject(new CWError(1, 'Link type not found.', {'provided': link_type, 'options':this.linkTypes}))
-      }
-      let data = {
-        SourceType: this.activityTypes.get(source_type),
-        SourceSid: source_sid,
-        DestType: this.activityTypes.get(destination_type),
-        DestSid: destination_sid,
-        LinkType: this.linkTypes.get(link_type)
-      }
-      let path = 'General/ActivityLink/Remove'
-      this.cw.runRequest(path, data).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-}

package/src/case.ts

@@ -1,282 +0,0 @@
-import { CWError } from './error'
-const _ = require('lodash')
-
-import { CaseData } from './case_data'
-import { CaseFinancial } from './case_financial'
-import { CaseWorkflow} from './case_workflow'
-import { CaseAdmin } from './case_admin'
-import { Comments } from './comments'
-import { CaseAssets } from './case_assets'
-
-export class Case {
-  /**
-   * @hidden
-   */
-  cw: any
-
-
-  /**
-   * Data Detail methods
-   */
-  data?: Object
-  /**
-   * Asset (Address) methods
-   */
-  asset?: Object
-  /**
-   * Workflow & task methods
-   */
-  workflow?: Object
-  /**
-   * Payment, Receipt, & Fee methods
-   */
-  financial?: Object
-  /**
-   * Commenting methods
-   */
-  comment?: Object
-  /**
-   * PLL Administration methods
-   */
-  admin?: Object
-
-  /**
-   * @hidden
-   */
-  constructor(cw) {
-    this.cw = cw
-    this.data = new CaseData(cw)
-    this.asset = new CaseAssets(cw)
-    this.workflow = new CaseWorkflow(cw)
-    this.financial = new CaseFinancial(cw)
-    this.comment = new Comments(cw, 'CaObject')
-    this.admin = new CaseAdmin(cw)
-  }
-
-  /**
-   * Create new case
-   *
-   * @category Cases
-   * @param {number} caseTypeId - The case Type ID
-   * @param {number} subTypeId - The case subType ID
-   * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-   * @return {Object} Returns Promise that represents an object describing the newly-created case
-   */
-  create(caseTypeId: number, subTypeId: number, options?: Object) {
-    return new Promise((resolve, reject) => {
-      var data_init = {
-        CaseTypeId: caseTypeId,
-        SubTypeId: subTypeId
-      }
-      var data = _.merge(data_init, options)
-      this.cw.runRequest('Pll/Case/Create', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Create a child case
-   *
-   * @category Cases
-   * @param {number} busCaseId - The case Type ID
-   * @param {number} parentCaObjectId - The case subType ID
-   * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-   * @return {Object} Returns Promise that represents an object describing the newly-created case
-   */
-  createChild(busCaseId: number, parentCaObjectId: number, options?: Object) {
-    return new Promise((resolve, reject) => {
-      var data_init = {
-        BusCaseId: busCaseId,
-        ParentCaObjectId: parentCaObjectId
-      }
-      var data = _.merge(data_init, options)
-      this.cw.runRequest('Pll/Case/CreateChild', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Create a case from a Service Request
-   *
-   * @category Cases
-   * @param {number} caseTypeId - The case Type ID
-   * @param {number} subTypeId - The case subType ID
-   * @param {number} requestId - The service request ID
-   * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-   * @return {Object} Returns Promise that represents an object describing the newly-created case
-   */
-  createFromRequest(caseTypeId: number, subTypeId: number, requestId: number, options?: Object) {
-    return new Promise((resolve, reject) => {
-      var data_init = {
-        CaseTypeId: caseTypeId,
-        SubTypeId: subTypeId,
-        ServiceRequestId: requestId
-      }
-      var data = _.merge(data_init, options)
-      this.cw.runRequest('Pll/CaseObject/CreateCaseFromServiceRequest', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Update a case
-   *
-   * @category Cases
-   * @param {number} caObjectId - The case Object ID to update
-   * @param {Object} [options] - See /{subdirectory}/apidocs/#/data-type-info;dataType=CaObjectItemBase
-   * @return {Object} Returns Promise that represents an object describing the updated case
-   */
-  update(caObjectId: number, options?: Object) {
-    return new Promise((resolve, reject) => {
-      var data_init = {
-        CaObjectId: caObjectId
-      }
-      var data = _.merge(data_init, options)
-      this.cw.runRequest('Pll/CaseObject/Update', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get cases by IDs
-   *
-   * @category Cases
-   * @param {Array<number>} caObjectIds - The case Object ID to update
-   * @return {Object} Returns Promise that represents a collection of objects describing the cases
-   */
-  getByIds(caObjectIds: Array<number>) {
-    return new Promise((resolve, reject) => {
-      var data = {
-        CaObjectIds: caObjectIds
-      }
-      this.cw.runRequest('Pll/CaseObject/ByIds', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Search for Cases. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.
-   *
-   * @category Cases
-   * @param {Object} filters - The parameter(s) to search by
-   * @return {Object} Returns Promise that represents an Array of case Object IDs
-   */
-  search(filters: Object) {
-    return new Promise((resolve, reject) => {
-      var data = filters
-      this.cw.runRequest('Pll/CaseObject/Search', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Move a Case point
-   *
-   * @category Cases
-   * @param {string} caObjectId
-   * @param {number} x
-   * @param {number} y
-   * @param {Object} projection - Should include at least WKT _or_ WKID attribute. Can also include VcsWKID attribute.
-   * @param {number} [z] - Optional Z coordinate
-   * @return {Object} Returns Promise that represents an object describing the updated GISPoint
-   */
-  move(caObjectId: number, x: number, y: number, projection: {WKID?: string, WKT?: string, VcsWKID?: string}, z?: number) {
-    return new Promise((resolve, reject) => {
-      if(!_.has(projection, 'WKID') && !_.has(projection, 'WKT')) {
-        // Throw error
-        reject(new CWError(1, 'You must provide either the WKID or WKT for the x/y coordinates.', {'projection': projection}))
-      }
-      var data_init = {
-        CaObjectId: caObjectId,
-        X: x,
-        Y: y
-      };
-      if(typeof(z)!='undefined') {
-        _.set(data_init, 'Z', z)
-      }
-      var data = _.merge(data_init, projection);
-      this.cw.runRequest('Pll/CaseObject/Move', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Delete case
-   *
-   * @category Cases
-   * @param {number} caObjectId - The case Object ID
-   * @return {Object} Returns Promise that represents an object describing the deleted case
-   */
-  delete(caObjectId: number) {
-    return new Promise((resolve, reject) => {
-      var data = {
-        CaObjectId: caObjectId
-      }
-      this.cw.runRequest('Pll/CaseObject/DeleteCase', data).then(r => {
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  // importCase(caseTypeId: number, subTypeId: number, caseName: string, location: string, x: number, y:number, appData: object, comment: string, expiration: string, assetIds: object) {
-  //   return new Promise(resolve => {
-  //     const _this = this;
-  //     let case_data = {"CaseName":caseName, "Location":location, "DateExpiration": expiration, "X":x,"Y":y}
-  //     this.create(caseTypeId, subTypeId, case_data).then((response: any) => {
-  //       if(response) {
-  //         if(typeof(response.CaObjectId)!='undefined') {
-  //           var CaObjectId = response.CaObjectId
-  //           if(typeof(comment) != 'undefined') {
-  //             _this.comments.add(CaObjectId, comment)
-  //           }
-  //           if(assetIds) {
-  //             _this.assets!.attach(CaObjectId, true, assetIds)
-  //           }
-  //           if(appData) {
-  //             _this.data!.getGroupsByCaseId(response.CaObjectId).then(response_one => {
-  //               // loop through all groups
-  //               let data_details_items = []
-  //               _this.data!.caseDataGroupIterator(appData, response_one, data_details_items).then(di => {
-  //                 _this.data!.caseDataDetailIterator(appData, di).then(resp => {
-  //                   resolve(response)
-  //                 })
-  //               })
-  //             })
-  //           } else {
-  //             resolve(response)
-  //           }
-  //         } else {
-  //           console.log('Error creating case: '+ JSON.stringify(case_data))
-  //           process.exit(0)
-  //         }
-  //       } else {
-  //         resolve(false)
-  //       }
-  //     })
-  //   })
-  // }
-
-}