cityworks 0.0.52 → 1.0.1

package/dist/gis.js

@@ -0,0 +1,250 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Gis = void 0;
+var _ = require('lodash');
+var Gis = /** @class */ (function () {
+    /**
+     * @hidden
+     */
+    function Gis(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
+     */
+    Gis.prototype.getConfig = function (whichType, whichId, getGisData, context) {
+        var _this = this;
+        if (getGisData === void 0) { getGisData = true; }
+        if (context === void 0) { context = []; }
+        return new Promise(function (resolve, reject) {
+            var path = 'Gis/MapService/Domain';
+            whichType = whichType.toLowerCase();
+            var data;
+            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(function (response) {
+                resolve(response.Value);
+            }).catch(function (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
+      */
+    Gis.prototype.domain = function (domainId, getGisData) {
+        var _this = this;
+        if (getGisData === void 0) { getGisData = true; }
+        return new Promise(function (resolve, reject) {
+            var path = 'Gis/MapService/Domain';
+            var data = {
+                DomainId: domainId
+            };
+            _this.cw.runRequest(path, {}).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (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 (?)
+       */
+    Gis.prototype.downloadMobile = function (cacheId, getGisData) {
+        var _this = this;
+        if (getGisData === void 0) { getGisData = true; }
+        return new Promise(function (resolve, reject) {
+            var path = 'Gis/MapService/DownloadMobileMapCache';
+            var data = {
+                MobileMapCacheId: cacheId
+            };
+            _this.cw.runRequest(path, {}).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    /**
+     * Get initial extent for user
+     *
+     * @return {Object} Returns Promise object that represents ... (?)
+     */
+    Gis.prototype.initialExtent = function () {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var path = 'Gis/MapService/InitialExtent';
+            var data = {};
+            _this.cw.runRequest(path, {}).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (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)
+     */
+    Gis.prototype.request = function (requestId, getGisData) {
+        var _this = this;
+        if (getGisData === void 0) { getGisData = true; }
+        return new Promise(function (resolve, reject) {
+            var path = 'Gis/MapService/ServiceRequestConfiguration';
+            var data = {
+                RequestId: requestId,
+                GetGisData: getGisData
+            };
+            _this.cw.runRequest(path, {}).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (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
+       */
+    Gis.prototype.inspection = function (inspectionId, getGisData) {
+        var _this = this;
+        if (getGisData === void 0) { getGisData = true; }
+        return new Promise(function (resolve, reject) {
+            var path = 'Gis/MapService/InspectionConfiguration';
+            var data = {
+                InspectionId: inspectionId,
+                GetGisData: getGisData
+            };
+            _this.cw.runRequest(path, {}).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (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)
+       */
+    Gis.prototype.workOrder = function (workOrderSid, getGisData) {
+        var _this = this;
+        if (getGisData === void 0) { getGisData = true; }
+        return new Promise(function (resolve, reject) {
+            var path = 'Gis/MapService/WorkOrderConfiguration';
+            var data = {
+                WorkOrderSid: workOrderSid,
+                GetGisData: getGisData
+            };
+            _this.cw.runRequest(path, {}).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (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
+       */
+    Gis.prototype.user = function (context, allDomains, allGroups, getGisData) {
+        var _this = this;
+        if (context === void 0) { context = []; }
+        if (allDomains === void 0) { allDomains = true; }
+        if (allGroups === void 0) { allGroups = true; }
+        if (getGisData === void 0) { getGisData = true; }
+        return new Promise(function (resolve, reject) {
+            var path = 'Gis/MapService/User';
+            var data = {
+                AllDomains: allDomains,
+                AllGroups: allGroups,
+                GetGisData: getGisData,
+                Security: context
+            };
+            _this.cw.runRequest(path, {}).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (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
+       */
+    Gis.prototype.selectedEntities = function () {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var path = 'General/AppData/SelectedEntities';
+            _this.cw.runRequest(path, {}).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (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
+       */
+    Gis.prototype.getEntityAttributes = function (entityType) {
+        var _this = this;
+        return new Promise(function (resolve, reject) {
+            var data = { EntityType: entityType };
+            var path = 'AMS/Entity/Attributes';
+            _this.cw.runRequest(path, data).then(function (response) {
+                resolve(response.Value);
+            }).catch(function (e) {
+                reject(e);
+            });
+        });
+    };
+    return Gis;
+}());
+exports.Gis = Gis;

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { ActivityLinks } from './activity_link';
 import { Gis } from './gis';
 import { MessageQueue } from './message_queue';
 import { Search } from './search';
+import { Query } from './query';
 import { Request } from './request';
 import { Inspection } from './inspection';
 import { WorkOrder } from './workorder';
@@ -47,8 +48,8 @@ declare class Cityworks implements Citywork {
     private potential_loads;
     /**
        * Contructor for a new cityworks instance's object, allows one to optionally configure the domain and other settings right from the get-go
-       * @param {string} [base_url] - The first color, in hexadecimal format.
-       * @param {object} [settings] - The second color, in hexadecimal format.
+       * @param {string} [base_url] - The base url of your Cityworks instance
+       * @param {object} [settings] - The settings for your Cityworks site. Full list: {path: (defaults to "cityworks"), secure: defaults to true, expires: defaults to NULL, does not expire, default_domain: defaults to NULL, uses default user domain, version: defaults to 23, for 15.x set to 15}
        * @param {array} [load] - allows user to choose which modules to load and make available. Full availability array: ['general', 'activity_link', 'message_queue', 'gis', 'workorder', 'inspection', 'request', 'case']
        */
     constructor(base_url?: string, settings?: Object, load?: Array<string>);
@@ -66,14 +67,14 @@ declare class Cityworks implements Citywork {
        *
        * If one ever needs to access or call an unimplemented API endpoint of a Cityworks install, one can call this method directly with the path and data payload:
        *
-       * `cityworks.runRequest(path, data)`
+       * `cityworks.runRequest(service_path, post_data)`
        *
-       * @param {string} path - The path to the particular endpoint
-       * @param {Object} data - The data object to be sent to the Cityworks API
-       * @param {any} file - The file to send in binary to the Cityworks API
+       * @param {string} service_path - The path to the particular endpoint
+       * @param {any} post_data - The data object to be sent to the Cityworks API
+       * @param {string} post_file - The path of the file to send to the Cityworks API
        * @return {Object} Returns Promise object that represents the json object returned from the Cityworks API
        */
-    runRequest(path: any, data?: any, file?: any): Promise<unknown>;
+    runRequest(service_path: string, post_data?: any, post_file?: string): Promise<unknown>;
     /**
        * Authenticate with the Cityworks API and store an access token for use. Stores the token on cityworks.Token.
        * @param {string} login - User's login name
@@ -214,9 +215,10 @@ declare const general: General;
 declare const activity_link: ActivityLinks;
 declare const message_queue: MessageQueue;
 declare const search: Search;
+declare const query: Query;
 declare const gis: Gis;
 declare const request: Request;
 declare const inspection: Inspection;
 declare const workorder: WorkOrder;
 declare const briefcase: Briefcase;
-export { cw as Cityworks, general, activity_link, message_queue, search, gis, request, inspection, workorder, briefcase };
+export { cw as Cityworks, general, activity_link, message_queue, search, query, gis, request, inspection, workorder, briefcase };