cityworks 0.0.28 → 0.0.32

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Walker <3987+walker@users.noreply.github.com>
+Copyright (c) 2021 Walker Hamilton <3987+walker@users.noreply.github.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,17 +4,17 @@ This API wrapper for Cityworks follows the Cityworks release schedule as closely
 
 Require the class:
 
-      var cityworks = require('cityworks');
+      const Cityworks = require('cityworks');
 
-Configure the instance that is then available:
+Instantiate the Class for the instance of Cityworks available given a domain:
 
-      cityworks.configure('my.cityworks.domain')
+      let cw = new Cityworks(CW_DOMAIN)
 
 ## Authentication
 
 Authenticate with the Cityworks install:
 
-      cityworks.authenticate('myuser', 'mypassword').then(resp => {
+      cw.authenticate('myuser', 'mypassword').then(resp => {
 
       }).catch(error => {
         console.log(error.message);
@@ -33,16 +33,16 @@ Provide a saved token instead of the standard u/p auth:
 
 Access the primary AMS ([Inspection](https://walker.github.io/cityworks/classes/inspection.Inspection.html), [WorkOrder](https://walker.github.io/cityworks/classes/workorder.WorkOrder.html), & [{Service} Request](https://walker.github.io/cityworks/classes/request.Request.html)) & [PLL](https://walker.github.io/cityworks/classes/case.Case.html) object libraries like so:
 
-      cityworks.inspection.methodHere().then(resp => {
+      cw.inspection.methodHere().then(resp => {
 
       })
-      cityworks.workorder.methodHere().then(resp => {
+      cw.workorder.methodHere().then(resp => {
 
       })
-      cityworks.request.methodHere().then(resp => {
+      cw.request.methodHere().then(resp => {
 
       })
-      cityworks.case.methodHere().then(resp => {
+      cw.case.methodHere().then(resp => {
 
       })
 
@@ -50,25 +50,25 @@ Some of the methods are general or top-level, and so, are accessed separately ar
 
 [General methods](https://walker.github.io/cityworks/classes/general.General.html) including authentication:
 
-      cityworks.general.methodHere().then(resp => {
+      cw.general.methodHere().then(resp => {
 
       })
 
 [Message queue](https://walker.github.io/cityworks/classes/message_queue.MessageQueue.html) methods for examining, processing, and troubleshooting webhooks and activity events:
 
-      cityworks.message_queue.methodHere().then(resp => {
+      cw.message_queue.methodHere().then(resp => {
 
       })
 
 [Activity link](https://walker.github.io/cityworks/classes/activity_link.ActivityLinks.html) for linking one node/object to another:
 
-      cityworks.activity_link.methodHere().then(resp => {
+      cw.activity_link.methodHere().then(resp => {
 
       })
 
 [Mapping and GIS methods](https://walker.github.io/cityworks/classes/gis.Gis.html) not specific to a single object type:
 
-      cityworks.gis.methodHere().then(resp => {
+      cw.gis.methodHere().then(resp => {
 
       })
 
@@ -84,25 +84,25 @@ For the sake of organizing some of the other methods needed by the primary and s
 
 For [PLL case financial actions](https://walker.github.io/cityworks/classes/case_financial.CaseFinancial.html):
 
-      cityworks.case.financial.methodHere().then(resp => {
+      cw.case.financial.methodHere().then(resp => {
 
       })
 
 For [PLL case data details & data groups](https://walker.github.io/cityworks/classes/case_data.CaseData.html):
 
-      cityworks.case.data.methodHere().then(resp => {
+      cw.case.data.methodHere().then(resp => {
 
       })
 
 For PLL case [workflow and task actions](https://walker.github.io/cityworks/classes/case_workflow.CaseWorkflow.html):
 
-      cityworks.case.workflow.methodHere().then(resp => {
+      cw.case.workflow.methodHere().then(resp => {
 
       })
 
 For [PLL administration actions](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html):
 
-      cityworks.case.admin.methodHere().then(resp => {
+      cw.case.admin.methodHere().then(resp => {
 
       })
 
@@ -110,14 +110,14 @@ For [PLL administration actions](https://walker.github.io/cityworks/classes/case
 
 For any object in Cityworks which can be commented on, use the [Comments class](https://walker.github.io/cityworks/classes/case_admin.CaseAdmin.html) via the class the comment is to be made on:
 
-      cityworks.case.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {
+      cw.case.comment.add(CaObjectIdGoesHere, "Comment goes here").then(resp => {
 
       })
 
-      cityworks.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {
+      cw.workorder.comment.add(WorkOrderSIDGoesHere, "Comment goes here").then(resp => {
 
       })
 
-      cityworks.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {
+      cw.request.comment.add(RequestIDGoesHere, "Comment goes here").then(resp => {
 
       })

package/dist/activity_link.d.ts

@@ -1,11 +1,15 @@
 import ReversibleMap from 'reversible-map';
-interface ActivityLink {
+/**
+ * ActivityLink interface for ActivityLinks
+ *
+ */
+export interface ActivityLink {
     linkTypes: ReversibleMap<string, number>;
     activityTypes: ReversibleMap<string, number>;
     cw: any;
 }
 /**
- * ActivityLinks implements the activity link functions
+ * ActivityLinks implements the activity link functions via using the ActivityLink interface
  *
  */
 export declare class ActivityLinks implements ActivityLink {
@@ -104,4 +108,3 @@ export declare class ActivityLinks implements ActivityLink {
      */
     remove(source_type: string, source_sid: number, destination_type: string, destination_sid: number, link_type?: string): Promise<unknown>;
 }
-export {};

package/dist/error.d.ts

@@ -1,4 +1,10 @@
-interface CWErrorInt {
+/**
+ * CWErrorInt interface definition for implementation by CWError
+ *
+ * `{name: string, code: number, message: string, info?: string}`
+ *
+ */
+export interface CWErrorInt {
     name: string;
     code: number;
     message: string;
@@ -7,8 +13,6 @@ interface CWErrorInt {
 /**
  * CWError implements a custom error class for this codebase with additional information
  *
- * `{name: string, code:number, info: object}`
- *
  */
 export declare class CWError implements CWErrorInt {
     /**
@@ -37,4 +41,3 @@ export declare class CWError implements CWErrorInt {
      */
     constructor(code: number, message: string, info?: object);
 }
-export {};

package/dist/gis.d.ts

@@ -71,9 +71,22 @@ export declare class Gis {
        * @return {Object} Returns Promise object that represents an Object with the user's GIS services
        */
     user(context?: Array<string>, allDomains?: boolean, allGroups?: boolean, getGisData?: boolean): Promise<unknown>;
+    /**
+     * Get Geocode server info by ServerId
+     *
+     * @param {number} ServiceId
+     * @return {Object} Returns Promise object that represents an object describing the provided Geocoder service configuration
+     */
     /**
        * 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(): Promise<unknown>;
+    /**
+       * 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): Promise<unknown>;
 }