cityworks 0.0.37 → 0.0.39

package/src/event_layer.ts

@@ -1,231 +0,0 @@
-import { CWError } from './error'
-const _ = require('lodash')
-
-/**
- * A plugin that contains "event layer" methods for a Cityworks install
- */
-export class EventLayer {
-  /**
-   * @hidden
-   */
-  cw: any
-
-  /**
-   * @hidden
-   */
-  constructor(cw) {
-    this.cw = cw
-  }
-
-  /**
-   * Update (enable/disable) an event layer
-   *
-   * @param {string} eventLayerId - which event layer to update
-   * @param {boolean} enabled - true to enable, false to disable
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   update(eventLayerId: number, enabled: boolean) {
-     return new Promise((resolve, reject) => {
-       let data = {"EventLayerId": eventLayerId, "Enabled": enabled}
-       this.cw.runRequest('Ams/EventLayer/Update', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * Enable an event layer
-   *
-   * @param {string} eventLayerId - which event layer to update
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   enable(eventLayerId: number) {
-     return this.update(eventLayerId, true);
-   }
-
-   /**
-    * Disable an event layer
-    *
-    * @param {string} eventLayerId - which event layer to update
-    * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-    */
-    disable(eventLayerId: number) {
-      return this.update(eventLayerId, false);
-    }
-
-  /**
-   * ??
-   *
-   * @param {Array<number>} createBySids -
-   * @param {Array<string>} queryTypes -
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   createByID(createBySids: Array<number>, queryTypes: Array<number>) {
-     return new Promise((resolve, reject) => {
-       let data = {"CreateBySids": createBySids, "QueryTypes": queryTypes}
-       this.cw.runRequest('Ams/EurlQuery/IdNames', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * Save user preferences
-   *
-   * @param {string} element - "VisibleQeIds"
-   * @param {string} category - "qe-map"
-   * @param {Object} defaultValue - {all: [3]}
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   updatePreferences(element: number, category: boolean, defaultValue: Object) {
-     return new Promise((resolve, reject) => {
-       let data = {"Element": element, "Category": category, "DefaultValue": defaultValue}
-       this.cw.runRequest('Ams/Preferences/UserSave', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * Get all event layers
-   *
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   all() {
-     return new Promise((resolve, reject) => {
-       let data = {}
-       this.cw.runRequest('Ams/EventLayer/All', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * Get all EUrl Query Types
-   *
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   queryTypes() {
-     return new Promise((resolve, reject) => {
-       let data = {}
-       this.cw.runRequest('General/EurlQuery/QueryTypes', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * Get Preferences for User
-   *
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   preferences() {
-     return new Promise((resolve, reject) => {
-       let data = {}
-       this.cw.runRequest('Ams/Preferences/User', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * Get Styles for event layers
-   *
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   styles() {
-     return new Promise((resolve, reject) => {
-       let data = {}
-       this.cw.runRequest('Ams/EventLayer/Styles', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * ??
-   *
-   * @param {Array<string>} preferenceNames - ["VisibleQeIds"]
-   * @param {Array<string>} categories - ["qe-map"]
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   xxxxxx(preferenceNames: Array<string>, categories: Array<string>) {
-     return new Promise((resolve, reject) => {
-       let data = {"PreferenceNames": preferenceNames, "Categories": categories}
-       this.cw.runRequest('Ams/Preferences/User', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e);
-       })
-     })
-   }
-
-  /**
-   * Get all event layers
-   *
-   * @param {boolean} includeDisabled - Defaults to false
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   getAllEventLayers(includeDisabled: boolean = false) {
-     return new Promise((resolve, reject) => {
-       let data = {"IncludeDisabled": includeDisabled}
-       this.cw.runRequest('Ams/EventLayer/All', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * Filter event layers by provided search definitions
-   *
-   * @param {Array<number>} searchIds - Defaults to false
-   * @param {Array<number>} eventLayerIds - Defaults to false
-   * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-   */
-   filterEventLayersBySearches(searchIds: Array<number>, eventLayerIds: Array<number>) {
-     return new Promise((resolve, reject) => {
-       let data = {"SearchIds": searchIds, "EventLayerIds": eventLayerIds}
-       this.cw.runRequest('Ams/EventLayer/Filters', data).then(r => {
-         // console.log(r, 'response')
-         resolve(r.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-  /**
-   * eventLayer GIS endpoint, this may need to be a promise as well...
-   *
-   * @return {string} Returns string that is absolute URL for event layer GIS endpoint
-   */
-   getGISEndpoint(eventLayerId) {
-     return this.cw.base_url + '/' + this.cw.settings.path + '/eventlayer/1/' + eventLayerId + '/rest/services/cw/FeatureServer/{#}?f=json'; // 1 for SR, 2 for WorkOrders, 3 for Inspections, 5 for PLL Cases
-   }
-
-}

package/src/general.ts

@@ -1,143 +0,0 @@
-import { CWError } from './error'
-const _ = require('lodash')
-
-/**
- * A plugin that contains "general" methods for a Cityworks install
- */
-export class General {
-  /**
-   * @hidden
-   */
-  cw: any
-
-  /**
-   * @hidden
-   */
-  constructor(cw) {
-    this.cw = cw
-  }
-
-  /**
-   * Get notifications for currently authenticated user
-   *
-   * @return {Object} Returns Promise object that represents a collection of available notifications
-   */
-  notifications() {
-    return new Promise((resolve, reject) => {
-      this.cw.runRequest('General/ActivityNotification/User', {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-
-  /**
-   * Find out if the current user is watching a particular activity (case, task, null [as a string])
-   *
-   * @param {string} activityType - which activity type the following ID will be for.
-   * @param {number} activityId - activity Case or CaseTask (task instance) ID to check
-   * @return {Object} Returns Promise object that represents a boolean indicating the currently authenticated user is watching the provided activity
-   */
-  amIWatching(activityType, activityId: number) {
-    return new Promise((resolve, reject) => {
-      let aType = {'null': 0, 'case': 1, 'task': 2}
-      if(typeof(aType[activityType])=='undefined') {
-        // reject with error
-        reject(new CWError(1, "Activity type provided does not exist.", {provided: activityType, potential_activities: aType}))
-      } else {
-        let data = {"ActivityType": aType[activityType], "ActivityId": activityId}
-        this.cw.runRequest('General/ActivityNotification/UserWatching', data).then(r => {
-          // console.log(r, 'response')
-          resolve(r.Value)
-        }).catch(e => {
-          reject(e)
-        })
-      }
-    })
-  }
-
-  /**
-   * Get CwMetatData by Type and CwSid
-   *
-   * @param {Array<number>} Ids
-   * @param {string} TableName - INSPECTION, REQUEST, WORKORDER require View permission on the activities
-   * @return {Object} Returns Promise object that represents a
-   */
-  getActivityMetadataByIds(ids: Array<number>, table: string) {
-    return new Promise((resolve, reject) => {
-      let tables = ["INSPECTION", "REQUEST", "WORKORDER"]
-      if(_.indexOf(tables, table)==-1) {
-        reject(new CWError(2, 'TableName provided does not exist or is mispelled.', {'provided': table, 'available':tables}))
-      }
-      let data = {
-        "Ids": ids,
-        "TableName": table
-      }
-      this.cw.runRequest('General/CwMetaData/ByTableNameSids', data).then(r => {
-        console.log(r)
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get recent history for authenticated user
-   *
-   * @return {Object} Returns Promise object that represents a collection of RecentActivity objects
-   */
-  getHistory() {
-    return new Promise((resolve, reject) => {
-      let data = {}
-      this.cw.runRequest('Ams/Search/RecentActivity', data).then(r => {
-        console.log(r)
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get cost summary for WorkOrder entities
-   *
-   * @param {Array<number>} ObjectIds
-   * @return {Object} Returns Promise object that represents a
-   */
-  getWOEntityCostSummary(object_ids: Array<number>) {
-    return new Promise((resolve, reject) => {
-      let data = {
-        "ObjectIds": object_ids
-      }
-      this.cw.runRequest('General/CostSummary/WorkOrderEntity', data).then(r => {
-        console.log(r)
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get cost summary for WorkOrder entities selected through a search definition
-   *
-   * @param {number} SearchId - Search Definition Id
-   * @return {Object} Returns Promise object that represents a
-   */
-  searchWOEntityCostSummary(search_id: number) {
-    return new Promise((resolve, reject) => {
-      let data = {
-        "SearchId": search_id
-      }
-      this.cw.runRequest('General/CostSummary/WorkOrderEntitySearch', data).then(r => {
-        console.log(r)
-        resolve(r.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-}

package/src/gis.ts

@@ -1,242 +0,0 @@
-import { CWError } from './error'
-const _ = require('lodash')
-
-export class Gis {
-  /**
-   * @hidden
-   */
-  cw: any
-
-  /**
-   * @hidden
-   */
-  constructor(cw) {
-    this.cw = cw
-  }
-
-  /**
-   * Get gis service configuration for user, group, domain, or service id
-   *
-   * @param {string} [whichType] - domain, group, mapservice, or user
-   * @param {number} [whichId] - domain, group, mapservice, or user Id
-   * @param {number} [getGisData] - If true, check for feature server JSON data, default is true
-   * @param {Array<string>} [context] Filter returned list by specific context, i.e. Office, Field, Mobile, Public, etc. Default is all.
-   * @return {Object} Returns Promise object that represents an Object with the desired GIS service definitions
-   */
-  getConfig(whichType, whichId, getGisData: boolean = true, context: Array<string> = []) {
-    return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/Domain'
-      whichType = whichType.toLowerCase()
-      let data: {DomainId?: any, GroupId?: any, MapServiceId?: any, UserId?: any, GetGisData: boolean, Security: Array<string>}
-      switch(whichType) {
-        case 'domain':
-          data = {DomainId:whichId, GetGisData: getGisData, Security: context}
-          break
-        case 'group':
-          data = {GroupId:whichId, GetGisData: getGisData, Security: context}
-          break
-        case 'mapservice':
-          data = {MapServiceId:whichId, GetGisData: getGisData, Security: context}
-          break
-        case 'user':
-          data = {UserId:whichId, GetGisData: getGisData, Security: context}
-          break
-      }
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-    * Get domain gis services
-    *
-    * @param {number} domainId - The mobile map cache Id to download
-    * @return {Object} Returns Promise object that represents an Object with the domain's default GIS services
-    */
-  domain(domainId, getGisData: boolean = true) {
-    return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/Domain'
-      let data = {
-        DomainId: domainId
-      }
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-     * Download mobile map cache
-     *
-     * @param {number} cacheId - The mobile map cache Id to download
-     * @return {Object} Returns Promise object that represents a streaming download (?)
-     */
-  downloadMobile(cacheId, getGisData: boolean = true) {
-    return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/DownloadMobileMapCache'
-      let data = {
-        MobileMapCacheId: cacheId
-      }
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get initial extent for user
-   *
-   * @return {Object} Returns Promise object that represents ... (?)
-   */
-  initialExtent() {
-    return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/InitialExtent'
-      let data = {};
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get service request gis services
-   *
-   * @param {number} requestId - The WorkOrder to check against.
-   * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
-   * @return {Object} Returns Promise object that represents an Object with the specified request's entit(y|ies)
-   */
-  request(requestId, getGisData: boolean = true) {
-    return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/ServiceRequestConfiguration'
-      let data = {
-        RequestId: requestId,
-        GetGisData: getGisData
-      }
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-     * Get inspection gis services
-     *
-     * @param {number} inspectionId - The WorkOrder to check against.
-     * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
-     * @return {Object} Returns Promise object that represents an Object with the specified inspection's entity
-     */
-  inspection(inspectionId, getGisData: boolean = true) {
-    return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/InspectionConfiguration'
-      let data = {
-        InspectionId: inspectionId,
-        GetGisData: getGisData
-      }
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-     * Get workorder gis services
-     *
-     * @param {number} workOrderSid - The WorkOrder to check against.
-     * @param {boolean} getGisData - If true, check for feature server JSON data, default is true.
-     * @return {Object} Returns Promise object that represents an Object with the specified WorkOrder's entit(y|ies)
-     */
-  workOrder(workOrderSid, getGisData: boolean = true) {
-    return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/WorkOrderConfiguration'
-      let data = {
-        WorkOrderSid: workOrderSid,
-        GetGisData: getGisData
-      }
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-     * Get service request gis services
-     *
-     * @param {Array<string>} [context] Filter returned list by specific context, i.e. Office, Field, Mobile, Public, etc. Default is all.
-     * @param {boolean} [allDomains] services assigned to any domain the user belongs to, default is true
-     * @param {boolean} [allGroups] services assigned to any groups the user belongs to regardless of domain, default is true
-     * @param {boolean} [getGisData] If true, check for feature server JSON data, default is true
-     * @return {Object} Returns Promise object that represents an Object with the user's GIS services
-     */
-  user(context: Array<string> = [], allDomains: boolean = true, allGroups: boolean = true, getGisData: boolean = true) {
-    return new Promise((resolve, reject) => {
-      let path = 'Gis/MapService/User'
-      let data = {
-        AllDomains: allDomains,
-        AllGroups: allGroups,
-        GetGisData: getGisData,
-        Security: context
-      }
-      this.cw.runRequest(path, {}).then((response: any) => {
-        resolve(response.Value)
-      }).catch(e => {
-        reject(e)
-      })
-    })
-  }
-
-  /**
-   * Get Geocode server info by ServerId
-   *
-   * @param {number} ServiceId
-   * @return {Object} Returns Promise object that represents an object describing the provided Geocoder service configuration
-   */
-   // Gis/GeoCode/GeocodeServer
-
-   /**
-      * Get currently selected entities from the Cityworks install's session for your user
-      * @return {Object} Returns Promise object that represents an Object with the currently-selected entities
-      */
-   selectedEntities() {
-     return new Promise((resolve, reject) => {
-       let path = 'General/AppData/SelectedEntities'
-       this.cw.runRequest(path, {}).then((response: any) => {
-         resolve(response.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-
-   /**
-      * Get attributes available for provided entity
-      *
-      * @param {string} entityType - The entity type to describe
-      * @return {Object} Returns Promise object that represents a collection of attribute description objects
-      */
-   getEntityAttributes(entityType:string) {
-     return new Promise((resolve, reject) => {
-       let data = {EntityType: entityType}
-       let path = 'AMS/Entity/Attributes'
-       this.cw.runRequest(path, data).then((response: any) => {
-         resolve(response.Value)
-       }).catch(e => {
-         reject(e)
-       })
-     })
-   }
-}

package/src/index.ts

@@ -1 +0,0 @@
-export { Cityworks } from './cityworks'