cityworks 1.0.4 → 1.0.6

package/dist/comments.js

@@ -1,126 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Comments = void 0;
-var error_1 = require("./error");
-var reversible_map_1 = require("reversible-map");
-var _ = require('lodash');
-/**
- * A plugin that contains "comments" methods
- */
-var Comments = /** @class */ (function () {
-    /**
-     * @hidden
-     */
-    function Comments(cw, activityType) {
-        this.cw = cw;
-        this.activityTypes = new reversible_map_1.default();
-        this.activityTypes.set("Unknown", 0);
-        this.activityTypes.set("Request", 1);
-        this.activityTypes.set("WorkOrder", 2);
-        this.activityTypes.set("CaTask", 3);
-        this.activityTypes.set("CaObject", 4);
-        this.activityTypes.set("CaCorrection", 5);
-        this.activityTypes.set("Project", 6);
-        this.activityTypes.set("Contract", 7);
-        if (!this.activityTypes.has(activityType)) {
-            throw new error_1.CWError(1, 'Comment activity type not found.', { 'provided': activityType, 'options': this.activityTypes });
-        }
-        this.currentActivityType = activityType;
-    }
-    /**
-     * Add a comment - for adding a comment to an object when the object is already known. Always call comment.add from request, case, workorder, or inspection.
-     *
-     * @param {number} sid - The SID of the activity to which the comment should be attached
-     * @param {string} comment - The text for the comment
-     * @return {Object} Returns a Promise which represents a CommentRecord object
-     */
-    Comments.prototype.add = function (sid, comment) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                ActivityType: _this.activityTypes.get(_this.currentActivityType),
-                ActivitySid: sid,
-                Comments: comment
-            };
-            _this.cw.runRequest('Ams/Comment/Add', data).then(function (response) {
-                resolve(response.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Update a comment
-     *
-     * @param {number} id - The ID of the comment which should be updated
-     * @param {string} comment - The new text for the updated comment
-     * @return {Object} Returns a Promise which represents a CommentRecord object
-     */
-    Comments.prototype.update = function (id, comment) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                ActivityType: _this.activityTypes.get(_this.currentActivityType),
-                CommentId: id,
-                Comments: comment
-            };
-            _this.cw.runRequest('Ams/Comment/Update', data).then(function (response) {
-                resolve(response.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get comments for activity items
-     *
-     * @param {Array<number>} sids - The options SIDs to get comments for.
-     * @return {Object} Returns Promise object that represents a collection of available comments
-     */
-    Comments.prototype.get = function (sids) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            if (typeof (sids) != 'undefined' && sids != null) {
-                var data = {
-                    ActivitySids: sids,
-                    ActivityType: _this.activityTypes.get(_this.currentActivityType),
-                };
-                _this.cw.runRequest('Ams/Comment/ByActivitySids', data).then(function (response) {
-                    if (sids.length == 1) {
-                        resolve(response.Value[sids[0]]);
-                    }
-                    else {
-                        resolve(response.Value);
-                    }
-                });
-            }
-        });
-    };
-    /**
-     * Get pre-defined comments for activityTypes
-     *
-     * @param {number} problemSid - The ProblemSid if currentActivityType is (Service) Request
-     * @param {string} [category] - Only applies to WorkOrder and ServiceRequest category comments.
-     * @return {Object} Returns Promise object that represents a collection of available comment templates.
-     */
-    Comments.prototype.getPredefined = function (problemSid, category) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {};
-            if (_this.currentActivityType == 'Request') {
-                _.set(data, 'ProblemSid', problemSid);
-            }
-            if (typeof (category) != 'undefined' && (_this.currentActivityType == 'Request' || _this.currentActivityType == 'WorkOrder')) {
-                _.set(data, 'Category', category);
-            }
-            _.set(data, 'ActivityType', _this.activityTypes.get(_this.currentActivityType));
-            _this.cw.runRequest('Ams/Comment/PredefinedComments', data).then(function (response) {
-                resolve(response.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    return Comments;
-}());
-exports.Comments = Comments;

package/dist/error.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CWError = void 0;
-var _ = require('lodash');
-/**
- * CWError implements a custom error class for this codebase with additional information
- *
- */
-var CWError = /** @class */ (function () {
-    /**
-     * CWError implements a custom error class for this codebase with additional information
-     *
-     * @param {number} code - Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
-     * @param {string} message - The error message
-     * @param {Object} info - Object stuffed with any other information one wishes to include in the thrown error
-     * @return {Object} Returns instance of CWError object
-     */
-    function CWError(code, message, info) {
-        this.name = "Cityworks Exception";
-        this.code = code;
-        this.message = message;
-        if (typeof (info) !== 'undefined') {
-            if (_.has(info, 'Message'))
-                this.message = _.get(info, 'Message');
-            this.info = JSON.stringify(info);
-        }
-    }
-    return CWError;
-}());
-exports.CWError = CWError;

package/dist/event_layer.d.ts

@@ -1,97 +0,0 @@
-/**
- * A plugin that contains "event layer" methods for a Cityworks install
- */
-export declare class EventLayer {
-    /**
-     * @hidden
-     */
-    cw: any;
-    /**
-     * @hidden
-     */
-    constructor(cw: any);
-    /**
-     * 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): Promise<unknown>;
-    /**
-     * 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): Promise<unknown>;
-    /**
-     * 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): Promise<unknown>;
-    /**
-     * ??
-     *
-     * @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>): Promise<unknown>;
-    /**
-     * 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): Promise<unknown>;
-    /**
-     * Get all event layers
-     *
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    all(): Promise<unknown>;
-    /**
-     * Get all EUrl Query Types
-     *
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    queryTypes(): Promise<unknown>;
-    /**
-     * Get Preferences for User
-     *
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    preferences(): Promise<unknown>;
-    /**
-     * Get Styles for event layers
-     *
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    styles(): Promise<unknown>;
-    /**
-     * Get all event layers
-     *
-     * @param {boolean} includeDisabled - Defaults to false
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    getAllEventLayers(includeDisabled?: boolean): Promise<unknown>;
-    /**
-     * 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>): Promise<unknown>;
-    /**
-     * 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: any): string;
-}

package/dist/event_layer.js

@@ -1,207 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventLayer = void 0;
-var _ = require('lodash');
-/**
- * A plugin that contains "event layer" methods for a Cityworks install
- */
-var EventLayer = /** @class */ (function () {
-    /**
-     * @hidden
-     */
-    function EventLayer(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
-     */
-    EventLayer.prototype.update = function (eventLayerId, enabled) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = { "EventLayerId": eventLayerId, "Enabled": enabled };
-            _this.cw.runRequest('Ams/EventLayer/Update', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (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
-     */
-    EventLayer.prototype.enable = function (eventLayerId) {
-        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
-     */
-    EventLayer.prototype.disable = function (eventLayerId) {
-        return this.update(eventLayerId, false);
-    };
-    /**
-     * ??
-     *
-     * @param {Array<number>} createBySids -
-     * @param {Array<string>} queryTypes -
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    EventLayer.prototype.createByID = function (createBySids, queryTypes) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = { "CreateBySids": createBySids, "QueryTypes": queryTypes };
-            _this.cw.runRequest('Ams/EurlQuery/IdNames', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (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
-     */
-    EventLayer.prototype.updatePreferences = function (element, category, defaultValue) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = { "Element": element, "Category": category, "DefaultValue": defaultValue };
-            _this.cw.runRequest('Ams/Preferences/UserSave', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get all event layers
-     *
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    EventLayer.prototype.all = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {};
-            _this.cw.runRequest('Ams/EventLayer/All', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get all EUrl Query Types
-     *
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    EventLayer.prototype.queryTypes = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {};
-            _this.cw.runRequest('General/EurlQuery/QueryTypes', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get Preferences for User
-     *
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    EventLayer.prototype.preferences = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {};
-            _this.cw.runRequest('Ams/Preferences/User', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get Styles for event layers
-     *
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    EventLayer.prototype.styles = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {};
-            _this.cw.runRequest('Ams/EventLayer/Styles', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get all event layers
-     *
-     * @param {boolean} includeDisabled - Defaults to false
-     * @return {Object} Returns Promise object which represents a xxxxx indicating xxxxxxx
-     */
-    EventLayer.prototype.getAllEventLayers = function (includeDisabled) {
-        var _this = this;
-        if (includeDisabled === void 0) { includeDisabled = false; }
-        return new Promise(function (resolve, reject) {
-            var data = { "IncludeDisabled": includeDisabled };
-            _this.cw.runRequest('Ams/EventLayer/All', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (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
-     */
-    EventLayer.prototype.filterEventLayersBySearches = function (searchIds, eventLayerIds) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = { "SearchIds": searchIds, "EventLayerIds": eventLayerIds };
-            _this.cw.runRequest('Ams/EventLayer/Filters', data).then(function (r) {
-                // console.log(r, 'response')
-                resolve(r.Value);
-            }).catch(function (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
-     */
-    EventLayer.prototype.getGISEndpoint = function (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
-    };
-    return EventLayer;
-}());
-exports.EventLayer = EventLayer;

package/dist/general.js

@@ -1,212 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.General = void 0;
-var error_1 = require("./error");
-var _ = require('lodash');
-/**
- * A plugin that contains "general" methods for a Cityworks install
- */
-var General = /** @class */ (function () {
-    /**
-     * @hidden
-     */
-    function General(cw) {
-        this.cw = cw;
-    }
-    /**
-     * Get notifications for currently authenticated user
-     *
-     * @return {Object} Returns Promise object that represents a collection of available notifications
-     */
-    General.prototype.notifications = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            _this.cw.runRequest('General/ActivityNotification/User', {}).then(function (response) {
-                resolve(response.Value);
-            }).catch(function (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
-     */
-    General.prototype.amIWatching = function (activityType, activityId) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var aType = { 'null': 0, 'case': 1, 'task': 2 };
-            if (typeof (aType[activityType]) == 'undefined') {
-                // reject with error
-                reject(new error_1.CWError(1, "Activity type provided does not exist.", { provided: activityType, potential_activities: aType }));
-            }
-            else {
-                var data = { "ActivityType": aType[activityType], "ActivityId": activityId };
-                _this.cw.runRequest('General/ActivityNotification/UserWatching', data).then(function (r) {
-                    // console.log(r, 'response')
-                    resolve(r.Value);
-                }).catch(function (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
-     */
-    General.prototype.getActivityMetadataByIds = function (ids, table) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var tables = ["INSPECTION", "REQUEST", "WORKORDER"];
-            if (_.indexOf(tables, table) == -1) {
-                reject(new error_1.CWError(2, 'TableName provided does not exist or is mispelled.', { 'provided': table, 'available': tables }));
-            }
-            var data = {
-                "Ids": ids,
-                "TableName": table
-            };
-            _this.cw.runRequest('General/CwMetaData/ByTableNameSids', data).then(function (r) {
-                console.log(r);
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get recent history for authenticated user
-     *
-     * @return {Object} Returns Promise object that represents a collection of RecentActivity objects
-     */
-    General.prototype.getHistory = function () {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {};
-            _this.cw.runRequest('Ams/Search/RecentActivity', data).then(function (r) {
-                console.log(r);
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get cost summary for WorkOrder entities
-     *
-     * @param {Array<number>} ObjectIds
-     * @return {Object} Returns Promise object that represents a
-     */
-    General.prototype.getWOEntityCostSummary = function (object_ids) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                "ObjectIds": object_ids
-            };
-            _this.cw.runRequest('General/CostSummary/WorkOrderEntity', data).then(function (r) {
-                console.log(r);
-                resolve(r.Value);
-            }).catch(function (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
-     */
-    General.prototype.searchWOEntityCostSummary = function (search_id) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                "SearchId": search_id
-            };
-            _this.cw.runRequest('General/CostSummary/WorkOrderEntitySearch', data).then(function (r) {
-                console.log(r);
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Get Holidays
-     *
-     * @param {Date} startDate - Date to search for Holidays, including this date.
-     * @param {Date} [endDate] - If not specified, Holidays _on_ startDate are returned. If specified, Holidays on startDate up to, but not including endDate are returned.
-     * @return {Object} Returns Promise object that represents a list of the holiday(s) found
-     */
-    General.prototype.getHolidays = function (startDate, endDate) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {};
-            var api_path = 'General/Holidays/All';
-            if (typeof (endDate) == 'undefined') {
-                _.set(data, "Date", startDate);
-                var api_path = 'General/Holidays/ByDate';
-            }
-            else {
-                _.set(data, "StartDate", startDate);
-                _.set(data, "EndDate", endDate);
-            }
-            _this.cw.runRequest(api_path, data).then(function (r) {
-                console.log(r);
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Add Holidays
-     *
-     * @param {Date} holiday - The holiday's date
-     * @param {string} description - The holiday's name/description
-     * @return {Object} Returns Promise object that represents a
-     */
-    General.prototype.addHolidays = function (holiday, description) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                "Holiday": holiday,
-                "Description": description
-            };
-            _this.cw.runRequest('General/Holidays/Add', data).then(function (r) {
-                console.log(r);
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    /**
-     * Delete Holidays
-     *
-     * @param {Array<Date>} holidays - List of datetimes which should have holidays deleted
-     * @return {Object} Returns Promise object that represents a
-     */
-    General.prototype.deleteHolidays = function (holidays) {
-        var _this = this;
-        return new Promise(function (resolve, reject) {
-            var data = {
-                "Holidays": holidays
-            };
-            _this.cw.runRequest('General/Holidays/Delete', data).then(function (r) {
-                console.log(r);
-                resolve(r.Value);
-            }).catch(function (e) {
-                reject(e);
-            });
-        });
-    };
-    return General;
-}());
-exports.General = General;