@sonoransoftware/sonoran.js 1.0.51 → 1.0.55

package/dist/constants.d.ts

@@ -148,6 +148,7 @@ export interface CMSClockInOutParams {
     accId?: string;
     apiId?: string;
     forceClockIn?: boolean;
+    forceClockOut?: boolean;
     discord?: string;
     uniqueId?: string;
     type?: string;

package/dist/libs/rest/src/lib/REST.js

@@ -222,7 +222,8 @@ class REST extends events_1.EventEmitter {
                     forceClockIn: args[2],
                     discord: args[3],
                     uniqueId: args[4],
-                    type: args[5]
+                    type: args[5],
+                    forceClockOut: args[6]
                 };
             }
             case 'ADD_CALL_NOTE': {
@@ -237,6 +238,16 @@ class REST extends events_1.EventEmitter {
                     label: args[3]
                 };
             }
+            case 'CLOSE_CALL': {
+                const payload = args[0];
+                if (payload && typeof payload === 'object' && !Array.isArray(payload)) {
+                    return payload;
+                }
+                return {
+                    serverId: args[0],
+                    callId: args[1]
+                };
+            }
             case 'UNIT_STATUS': {
                 const payload = args[0];
                 if (payload && typeof payload === 'object' && !Array.isArray(payload)) {

package/dist/libs/rest/src/lib/RequestManager.js

@@ -239,6 +239,10 @@ class RequestManager extends events_1.EventEmitter {
                     }
                     break;
                 }
+                case 'CLOSE_CALL': {
+                    apiData.data.data = [clonedData];
+                    break;
+                }
                 case 'UNIT_PANIC': {
                     const payload = data.data;
                     if (Array.isArray(payload)) {

package/dist/libs/rest/src/lib/utils/constants.d.ts

@@ -245,6 +245,12 @@ export interface CADGetActiveUnitsStruct {
     limit?: number;
     offset?: number;
 }
+export interface CADDispatchNoteStruct {
+    time: string;
+    label: string;
+    type: string;
+    content: string;
+}
 export interface CADAttachUnitsStruct {
     serverId: number;
     callId: number;
@@ -285,6 +291,7 @@ interface CADNewDispatchBaseStruct {
     primary: number;
     trackPrimary: boolean;
     description: string;
+    notes: CADDispatchNoteStruct[];
     metaData: Record<string, string>;
 }
 export type CADNewDispatchStruct = (CADNewDispatchBaseStruct & {
@@ -504,7 +511,8 @@ export interface RESTTypedAPIDataStructs {
         forceClockIn?: boolean,
         discord?: string,
         uniqueId?: string,
-        type?: string
+        type?: string,
+        forceClockOut?: boolean
     ];
     GET_DEPARTMENTS: [];
     GET_ACCOUNT_RANKS: [
@@ -784,6 +792,7 @@ export type PossibleRequestData = undefined | {
     apiId?: string;
     accId?: string;
     forceClockIn?: boolean;
+    forceClockOut?: boolean;
     discord?: string;
     uniqueId?: string;
     type?: string;

package/dist/managers/CMSManager.d.ts

@@ -77,6 +77,7 @@ export declare class CMSManager extends BaseManager {
      * @param {string} [data.accId] (Optional) The account id to clock in or out.
      * @param {string} [data.apiId] (Optional) The api id to clock in or out.
      * @param {boolean} [data.forceClockIn] If true, it will override any current clock in with a new clock in at the time of the request.
+     * @param {boolean} [data.forceClockOut] If true, it will force a clock out regardless of current status.
      * @param {string} [data.discord] (Optional) The discord ID to clock in or out.
      * @param {string} [data.uniqueId] (Optional) The unique ID to clock in or out.
      * @param {string} [data.type] (Optional) The UUID of a specific clock-in type to use.

package/dist/managers/CMSManager.js

@@ -176,6 +176,7 @@ class CMSManager extends BaseManager_1.BaseManager {
      * @param {string} [data.accId] (Optional) The account id to clock in or out.
      * @param {string} [data.apiId] (Optional) The api id to clock in or out.
      * @param {boolean} [data.forceClockIn] If true, it will override any current clock in with a new clock in at the time of the request.
+     * @param {boolean} [data.forceClockOut] If true, it will force a clock out regardless of current status.
      * @param {string} [data.discord] (Optional) The discord ID to clock in or out.
      * @param {string} [data.uniqueId] (Optional) The unique ID to clock in or out.
      * @param {string} [data.type] (Optional) The UUID of a specific clock-in type to use.
@@ -185,7 +186,7 @@ class CMSManager extends BaseManager_1.BaseManager {
         return new Promise(async (resolve, reject) => {
             var _a;
             try {
-                const clockInOutRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('CLOCK_IN_OUT', data.apiId, data.accId, !!data.forceClockIn, data.discord, data.uniqueId, data.type));
+                const clockInOutRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('CLOCK_IN_OUT', data.apiId, data.accId, !!data.forceClockIn, data.discord, data.uniqueId, data.type, !!data.forceClockOut));
                 const clockInOutResponse = clockInOutRequest;
                 if (!clockInOutResponse)
                     resolve({ success: false, reason: clockInOutRequest });

package/docs/CMS-Methods-and-Usage.md

@@ -139,6 +139,7 @@ if (comAccount.success) {
 | data.apiId | Yes | String | Must have at least apiId or accId |
 | data.accId | Yes | String | Must have at least apiId or accId |
 | data.forceClockIn | Yes | Boolean | Will start a new clock in and overrite any current clock in |
+| data.forceClockOut | Yes | Boolean | Forces a clock out regardless of the current status |
 
 Returns *clockResult*;
 | Property   |      Optional      |  Type | Note |
@@ -162,6 +163,12 @@ const clockResult = await instance.cms.clockInOut({
   forceClockIn: true
 });
 // OR
+// This will force a clock out on the community account found by the specified API ID if found.
+const clockResult = await instance.cms.clockInOut({
+  apiId: '235947056630333440',
+  forceClockOut: true
+});
+// OR
 // This will either clock in or out the community account found by the specified API ID if found.
 // Will determine to clock in or out depending on what is pending.
 const clockResult = await instance.cms.clockInOut({
@@ -209,4 +216,4 @@ if (checkResult.success) {
 } else {
   console.log('Unsuccessful', checkResult.reason);
 }
-```
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sonoransoftware/sonoran.js",
-  "version": "1.0.51",
+  "version": "1.0.55",
   "description": "Sonoran.js is a library that allows you to interact with the Sonoran CAD and Sonoran CMS API. Based off of and utilizes several Discord.js library techniques for ease of use.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -267,12 +267,13 @@ const getRanks = await instance.cms.getAccountRanks(params);
 ### clockInOut(obj)
 Clock a user in or out in the CMS system
 #### Arugment `obj`
-##### Type `object` `{accId?: string, apiId?: string, forceClockIn?: boolean, discord?: string, uniqueId?: string, type?: string}`
+##### Type `object` `{accId?: string, apiId?: string, forceClockIn?: boolean, forceClockOut?: boolean, discord?: string, uniqueId?: string, type?: string}`
 ```js
 const params = {
  accId: '',
  apiId: '',
  forceClockIn: true,
+ forceClockOut: false,
  discord: '',
  uniqueId: '1234',
  type: 'clockin-type-uuid'

package/src/constants.ts

@@ -168,6 +168,7 @@ export interface CMSClockInOutParams {
 	accId?: string;
 	apiId?: string;
 	forceClockIn?: boolean;
+	forceClockOut?: boolean;
 	discord?: string;
 	uniqueId?: string;
 	type?: string;

package/src/libs/rest/src/lib/REST.ts

@@ -326,7 +326,8 @@ export class REST extends EventEmitter {
 					forceClockIn: args[2],
 					discord: args[3],
 					uniqueId: args[4],
-					type: args[5]
+					type: args[5],
+					forceClockOut: args[6]
 				};
 			}
 			case 'ADD_CALL_NOTE': {
@@ -341,6 +342,16 @@ export class REST extends EventEmitter {
 					label: args[3]
 				};
 			}
+			case 'CLOSE_CALL': {
+				const payload = args[0];
+				if (payload && typeof payload === 'object' && !Array.isArray(payload)) {
+					return payload;
+				}
+				return {
+					serverId: args[0],
+					callId: args[1]
+				};
+			}
 			case 'UNIT_STATUS': {
 				const payload = args[0];
 				if (payload && typeof payload === 'object' && !Array.isArray(payload)) {

package/src/libs/rest/src/lib/RequestManager.ts

@@ -306,6 +306,10 @@ export class RequestManager extends EventEmitter {
           }
           break;
         }
+        case 'CLOSE_CALL': {
+          apiData.data.data = [clonedData];
+          break;
+        }
         case 'UNIT_PANIC': {
           const payload = data.data;
           if (Array.isArray(payload)) {

package/src/libs/rest/src/lib/utils/constants.ts

@@ -914,6 +914,13 @@ export interface CADGetActiveUnitsStruct {
 	offset?: number;
 }
 
+export interface CADDispatchNoteStruct {
+	time: string;
+	label: string;
+	type: string;
+	content: string;
+}
+
 export interface CADAttachUnitsStruct {
 	serverId: number;
 	callId: number;
@@ -959,6 +966,7 @@ interface CADNewDispatchBaseStruct {
 	primary: number;
 	trackPrimary: boolean;
 	description: string;
+	notes: CADDispatchNoteStruct[];
 	metaData: Record<string, string>;
 }
 
@@ -1179,7 +1187,8 @@ export interface RESTTypedAPIDataStructs {
 		forceClockIn?: boolean,
 		discord?: string,
 		uniqueId?: string,
-		type?: string
+		type?: string,
+		forceClockOut?: boolean
 	];
 	GET_DEPARTMENTS: [];
 	GET_ACCOUNT_RANKS: [
@@ -1496,6 +1505,7 @@ export type PossibleRequestData =
 		apiId?: string;
 		accId?: string;
 		forceClockIn?: boolean;
+		forceClockOut?: boolean;
 		discord?: string;
 		uniqueId?: string;
 		type?: string;

package/src/managers/CMSManager.ts

@@ -149,6 +149,7 @@ export class CMSManager extends BaseManager {
    * @param {string} [data.accId] (Optional) The account id to clock in or out.
    * @param {string} [data.apiId] (Optional) The api id to clock in or out.
    * @param {boolean} [data.forceClockIn] If true, it will override any current clock in with a new clock in at the time of the request.
+   * @param {boolean} [data.forceClockOut] If true, it will force a clock out regardless of current status.
    * @param {string} [data.discord] (Optional) The discord ID to clock in or out.
    * @param {string} [data.uniqueId] (Optional) The unique ID to clock in or out.
    * @param {string} [data.type] (Optional) The UUID of a specific clock-in type to use.
@@ -157,7 +158,7 @@ export class CMSManager extends BaseManager {
   public async clockInOut(data: globalTypes.CMSClockInOutParams): Promise<globalTypes.CMSClockInOutPromiseResult> {
     return new Promise(async (resolve, reject) => {
       try {
-        const clockInOutRequest = await this.rest?.request('CLOCK_IN_OUT', data.apiId, data.accId, !!data.forceClockIn, data.discord, data.uniqueId, data.type);
+        const clockInOutRequest = await this.rest?.request('CLOCK_IN_OUT', data.apiId, data.accId, !!data.forceClockIn, data.discord, data.uniqueId, data.type, !!data.forceClockOut);
         const clockInOutResponse = clockInOutRequest as globalTypes.clockInOutRequest;
         if (!clockInOutResponse) resolve({ success: false, reason: clockInOutRequest as string });
         resolve({ success: true, clockedIn: clockInOutResponse.completed });