@sonoransoftware/sonoran.js 1.0.68 → 1.0.70

package/dist/constants.d.ts

@@ -1,5 +1,6 @@
 import { Collection } from '@discordjs/collection';
 import { CADDispatchOriginEnums, CADDispatchStatusEnums } from './libs/rest/src';
+import type { CADDispatchNoteStruct } from './libs/rest/src';
 import { DataManager } from './managers/DataManager';
 import { CADActiveUnitsManager } from './managers/CADActiveUnitsManager';
 import { CADActiveUnit } from './structures/CADActiveUnit';
@@ -25,6 +26,24 @@ export interface CADNewDispatchBuilderOptions {
     units?: string[];
     deleteAfterMinutes?: number;
 }
+export interface CADDispatchCallStruct {
+    callId: number;
+    origin: CADDispatchOriginEnums;
+    status: CADDispatchStatusEnums;
+    priority: 1 | 2 | 3;
+    block: string;
+    address: string;
+    postal: string;
+    title: string;
+    code: string;
+    primary: number;
+    trackPrimary: boolean;
+    description: string;
+    notes: CADDispatchNoteStruct[];
+    idents: number[];
+    metaData: Record<string, string>;
+    updated: string;
+}
 export type Constructable<T> = abstract new (...args: any[]) => T;
 export interface Caches {
     CADActiveUnitsManager: [manager: typeof CADActiveUnitsManager, holds: CADActiveUnit];

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from './instance/Instance';
 export * from './builders';
 export * from './libs/rest/src';
-export { productEnums, CADNewDispatchBuilderOptions, CADSubscriptionVersionEnum, CMSSubscriptionVersionEnum, RadioSubscriptionLevel, RadioSetUserChannelsOptions, RadioChannel, RadioChannelGroup, RadioConnectedUser, RadioSpeakerLocation, RadioGetCommunityChannelsPromiseResult, RadioGetConnectedUsersPromiseResult, RadioGetConnectedUserPromiseResult, RadioSetUserChannelsPromiseResult, RadioSetUserDisplayNamePromiseResult, RadioGetServerSubscriptionFromIpPromiseResult, RadioSetServerIpPromiseResult, RadioSetInGameSpeakerLocationsPromiseResult, CADSetClockTimePromiseResult, CADJoinCommunityPromiseResult, CADLeaveCommunityPromiseResult, CADStandardResponse, CMSProfileField, CMSGetCurrentClockInPromiseResult, CMSAccountsPage, CMSAccountSummary, CMSGetAccountsPromiseResult, CMSGetProfileFieldsPromiseResult, CMSProfileFieldUpdate, CMSEditAccountProfileFieldsPromiseResult, CMSRsvpPromiseResult, CMSChangeFormStagePromiseResult, CMSSetGameServerStruct, CMSSetGameServersPromiseResult, CMSExecuteRankPromotionResult, CMSTriggerPromotionFlowPayload, CMSPromotionFlow, CMSTriggerPromotionFlowsPromiseResult, CMSGetPromotionFlowsPromiseResult, CMSCustomLogType, CMSGetCustomLogTypesPromiseResult, CMSGetFormSubmissionsPromiseResult, CMSERLCGetOnlinePlayersPromiseResult, CMSERLCGetPlayerQueuePromiseResult, CMSERLCAddNewRecordPromiseResult, CMSERLCExecuteCommandPayload, CMSERLCExecuteCommandPromiseResult, CMSERLCTeamsLockPromiseResult, CMSERLCTeamsUnlockPromiseResult } from './constants';
+export { productEnums, CADNewDispatchBuilderOptions, CADDispatchCallStruct, CADSubscriptionVersionEnum, CMSSubscriptionVersionEnum, RadioSubscriptionLevel, RadioSetUserChannelsOptions, RadioChannel, RadioChannelGroup, RadioConnectedUser, RadioSpeakerLocation, RadioGetCommunityChannelsPromiseResult, RadioGetConnectedUsersPromiseResult, RadioGetConnectedUserPromiseResult, RadioSetUserChannelsPromiseResult, RadioSetUserDisplayNamePromiseResult, RadioGetServerSubscriptionFromIpPromiseResult, RadioSetServerIpPromiseResult, RadioSetInGameSpeakerLocationsPromiseResult, CADSetClockTimePromiseResult, CADJoinCommunityPromiseResult, CADLeaveCommunityPromiseResult, CADStandardResponse, CMSProfileField, CMSGetCurrentClockInPromiseResult, CMSAccountsPage, CMSAccountSummary, CMSGetAccountsPromiseResult, CMSGetProfileFieldsPromiseResult, CMSProfileFieldUpdate, CMSEditAccountProfileFieldsPromiseResult, CMSRsvpPromiseResult, CMSChangeFormStagePromiseResult, CMSSetGameServerStruct, CMSSetGameServersPromiseResult, CMSExecuteRankPromotionResult, CMSTriggerPromotionFlowPayload, CMSPromotionFlow, CMSTriggerPromotionFlowsPromiseResult, CMSGetPromotionFlowsPromiseResult, CMSCustomLogType, CMSGetCustomLogTypesPromiseResult, CMSGetFormSubmissionsPromiseResult, CMSERLCGetOnlinePlayersPromiseResult, CMSERLCGetPlayerQueuePromiseResult, CMSERLCAddNewRecordPromiseResult, CMSERLCExecuteCommandPayload, CMSERLCExecuteCommandPromiseResult, CMSERLCTeamsLockPromiseResult, CMSERLCTeamsUnlockPromiseResult } from './constants';

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

@@ -231,11 +231,24 @@ class REST extends events_1.EventEmitter {
                 if (payload && typeof payload === 'object' && !Array.isArray(payload)) {
                     return payload;
                 }
+                const noteTypeOrLabel = args[3];
+                const isNoteType = noteTypeOrLabel === 'text' || noteTypeOrLabel === 'link';
                 return {
                     serverId: args[0],
                     callId: args[1],
                     note: args[2],
-                    label: args[3]
+                    noteType: isNoteType ? noteTypeOrLabel : undefined,
+                    label: isNoteType ? args[4] : noteTypeOrLabel
+                };
+            }
+            case 'REMOVE_911': {
+                const payload = args[0];
+                if (payload && typeof payload === 'object' && !Array.isArray(payload)) {
+                    return payload;
+                }
+                return {
+                    serverId: args[0],
+                    callId: args[1]
                 };
             }
             case 'CLOSE_CALL': {

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

@@ -249,6 +249,11 @@ export interface CADAddCallNoteStruct {
     callId: number;
     note: string;
     label?: string;
+    noteType?: 'text' | 'link';
+}
+export interface CADRemove911Struct {
+    serverId: number;
+    callId: number;
 }
 export interface CADGetActiveUnitsStruct {
     serverId?: number;
@@ -422,7 +427,12 @@ export interface RESTTypedAPIDataStructs {
     ADD_BLIP: [data: CADAddBlipStruct[]];
     MODIFY_BLIP: [data: CADModifyBlipStruct[]];
     REMOVE_BLIP: [id: number];
-    REMOVE_911: [callId: number];
+    REMOVE_911: [
+        serverId: number,
+        callId: number
+    ] | [
+        data: CADRemove911Struct
+    ];
     GET_CALLS: [data: CADGetCallsStruct];
     GET_MY_CALL: [data: CADGetMyCallStruct];
     GET_ACTIVE_UNITS: [data: CADGetActiveUnitsStruct];
@@ -461,6 +471,11 @@ export interface RESTTypedAPIDataStructs {
         serverId: number,
         callId: number,
         note: string
+    ] | [
+        serverId: number,
+        callId: number,
+        note: string,
+        noteType: 'text' | 'link'
     ] | [
         data: CADAddCallNoteStruct
     ];

package/dist/managers/CADManager.d.ts

@@ -1,7 +1,7 @@
 import { Instance } from '../instance/Instance';
 import { CADSubscriptionVersionEnum } from '../constants';
 import { REST } from '../libs/rest/src';
-import type { CADPenalCodeStruct, CADSetAPIIDStruct, CADNewEditRecordOptionOneStruct, CADNewEditRecordOptionTwoStruct, CADSendDraftStruct, CADLookupByIntStruct, CADLookupStruct, CADModifyAccountPermsStruct, CADKickBanUserStruct, CADSetPostalStruct, CADModifyIdentifierStruct, CADIdentsToGroupStruct, CADAddBlipStruct, CADModifyBlipStruct, CADGetCallsStruct, CADGetMyCallStruct, CADAddCallNoteStruct, CADGetActiveUnitsStruct, CADNewDispatchStruct, CADAttachUnitsStruct, CADDetachUnitsStruct, CADStreetSignStruct, CADUnitLocationStruct, CADUnitPanicStruct } from '../libs/rest/src';
+import type { CADPenalCodeStruct, CADSetAPIIDStruct, CADNewEditRecordOptionOneStruct, CADNewEditRecordOptionTwoStruct, CADSendDraftStruct, CADLookupByIntStruct, CADLookupStruct, CADModifyAccountPermsStruct, CADKickBanUserStruct, CADSetPostalStruct, CADModifyIdentifierStruct, CADIdentsToGroupStruct, CADAddBlipStruct, CADModifyBlipStruct, CADGetCallsStruct, CADGetMyCallStruct, CADAddCallNoteStruct, CADRemove911Struct, CADGetActiveUnitsStruct, CADNewDispatchStruct, CADAttachUnitsStruct, CADDetachUnitsStruct, CADStreetSignStruct, CADUnitLocationStruct, CADUnitPanicStruct } from '../libs/rest/src';
 import { BaseManager } from './BaseManager';
 import * as globalTypes from '../constants';
 import { CADServerManager } from './CADServerManager';
@@ -207,7 +207,8 @@ export declare class CADManager extends BaseManager {
     /**
      * Removes a 911 call by its identifier.
      */
-    remove911Call(callId: number): Promise<globalTypes.CADStandardResponse>;
+    remove911Call(serverId: number, callId: number): Promise<globalTypes.CADStandardResponse>;
+    remove911Call(params: CADRemove911Struct): Promise<globalTypes.CADStandardResponse>;
     /**
      * Retrieves dispatch calls with optional pagination.
      */
@@ -227,7 +228,7 @@ export declare class CADManager extends BaseManager {
     /**
      * Creates a new dispatch call.
      */
-    createDispatch(data: CADNewDispatchStruct): Promise<globalTypes.CADStandardResponse>;
+    createDispatch(data: CADNewDispatchStruct): Promise<globalTypes.CADStandardResponse<globalTypes.CADDispatchCallStruct>>;
     /**
      * Attaches units to an existing dispatch call.
      */
@@ -250,6 +251,7 @@ export declare class CADManager extends BaseManager {
      * Adds a note to an active call.
      */
     addCallNote(serverId: number, callId: number, note: string, label?: string): Promise<globalTypes.CADStandardResponse>;
+    addCallNote(serverId: number, callId: number, note: string, noteType: 'text' | 'link', label?: string): Promise<globalTypes.CADStandardResponse>;
     addCallNote(params: CADAddCallNoteStruct): Promise<globalTypes.CADStandardResponse>;
     /**
      * Closes a CAD call.

package/dist/managers/CADManager.js

@@ -535,14 +535,19 @@ class CADManager extends BaseManager_1.BaseManager {
         }
         return this.executeCadRequest('911_CALL', serverId, isEmergency, caller, location, description, metaData);
     }
-    /**
-     * Removes a 911 call by its identifier.
-     */
-    async remove911Call(callId) {
-        if (!Number.isInteger(callId)) {
-            throw new Error('callId must be an integer when removing a 911 call.');
+    async remove911Call(serverIdOrParams, callId) {
+        let payload;
+        if (serverIdOrParams && typeof serverIdOrParams === 'object') {
+            payload = { ...serverIdOrParams };
+        }
+        else {
+            payload = { serverId: serverIdOrParams, callId: callId };
         }
-        return this.executeCadRequest('REMOVE_911', callId);
+        const { serverId, callId: resolvedCallId } = payload;
+        if (!Number.isInteger(serverId) || !Number.isInteger(resolvedCallId)) {
+            throw new Error('serverId and callId must be integers when removing a 911 call.');
+        }
+        return this.executeCadRequest('REMOVE_911', { serverId, callId: resolvedCallId });
     }
     /**
      * Retrieves dispatch calls with optional pagination.
@@ -675,22 +680,29 @@ class CADManager extends BaseManager_1.BaseManager {
         }
         return this.executeCadRequest('SET_CALL_PRIMARY', serverId, callId, primary, trackPrimary);
     }
-    async addCallNote(serverIdOrParams, callId, note, label) {
+    async addCallNote(serverIdOrParams, callId, note, noteTypeOrLabel, label) {
         let payload;
         if (serverIdOrParams && typeof serverIdOrParams === 'object') {
             payload = { ...serverIdOrParams };
         }
         else {
-            payload = { serverId: serverIdOrParams, callId: callId, note: note, label };
+            const isNoteType = noteTypeOrLabel === 'text' || noteTypeOrLabel === 'link';
+            payload = {
+                serverId: serverIdOrParams,
+                callId: callId,
+                note: note,
+                noteType: isNoteType ? noteTypeOrLabel : undefined,
+                label: isNoteType ? label : noteTypeOrLabel
+            };
         }
-        const { serverId, callId: resolvedCallId, note: resolvedNote, label: resolvedLabel } = payload;
+        const { serverId, callId: resolvedCallId, note: resolvedNote, label: resolvedLabel, noteType } = payload;
         if (!Number.isInteger(serverId) || !Number.isInteger(resolvedCallId)) {
             throw new Error('serverId and callId must be integers when adding a call note.');
         }
         if (!resolvedNote) {
             throw new Error('note is required when adding a call note.');
         }
-        return this.executeCadRequest('ADD_CALL_NOTE', { serverId, callId: resolvedCallId, note: resolvedNote, label: resolvedLabel });
+        return this.executeCadRequest('ADD_CALL_NOTE', { serverId, callId: resolvedCallId, note: resolvedNote, label: resolvedLabel, noteType });
     }
     /**
      * Closes a CAD call.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sonoransoftware/sonoran.js",
-  "version": "1.0.68",
+  "version": "1.0.70",
   "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

@@ -130,13 +130,13 @@ await instance.cad.setUnitPanic({ identIds: [101, 102], isPanic: true });
 - **`updateStreetSign(serverId, signData)`**
 
 ### Calls & Dispatch
-- **`create911Call(details)`** / **`remove911Call(callId)`**
+- **`create911Call(details)`** / **`remove911Call(serverId, callId)`**
 - **`getCalls(options)`**
 - **`getMyCall({ account })`**
 - **`createDispatch(data)`** - accepts either `units` (API IDs) or `accounts` (account UUIDs) as arrays.
 - **`attachUnits(serverId, callId, unitsOrAccount)`** / **`detachUnits(serverId, unitsOrAccount)`**
 - **`setCallPostal(serverId, callId, postal)`** / **`setCallPrimary(serverId, callId, primary, trackPrimary)`**
-- **`addCallNote({ serverId, callId, note, label? })`**
+- **`addCallNote({ serverId, callId, note, noteType?, label? })`**
 - **`closeCall(serverId, callId)`**
 
 ```js
@@ -179,8 +179,8 @@ await instance.cad.attachUnits({ serverId: 1, callId: 1001, account: '91de0ce8-c
 await instance.cad.detachUnits({ serverId: 1, account: '91de0ce8-c571-11e9-9714-5600023b2434' });
 // Fetch the current call for an account UUID
 const myCall = await instance.cad.getMyCall({ account: '91de0ce8-c571-11e9-9714-5600023b2434' });
-// Add a call note with optional label
-await instance.cad.addCallNote({ serverId: 1, callId: 1001, note: 'This is a test!', label: 'A-10' });
+// Add a call note with optional type/label
+await instance.cad.addCallNote({ serverId: 1, callId: 1001, note: 'This is a test!', noteType: 'text', label: 'A-10' });
 ```
 
 ## CAD Server Functions

package/src/constants.ts

@@ -1,5 +1,6 @@
 import { Collection } from '@discordjs/collection';
 import { CADDispatchOriginEnums, CADDispatchStatusEnums } from './libs/rest/src';
+import type { CADDispatchNoteStruct } from './libs/rest/src';
 import { DataManager } from './managers/DataManager';
 import { CADActiveUnitsManager } from './managers/CADActiveUnitsManager';
 import { CADActiveUnit } from './structures/CADActiveUnit';
@@ -28,6 +29,25 @@ export interface CADNewDispatchBuilderOptions {
 	deleteAfterMinutes?: number;
 }
 
+export interface CADDispatchCallStruct {
+	callId: number;
+	origin: CADDispatchOriginEnums;
+	status: CADDispatchStatusEnums;
+	priority: 1 | 2 | 3;
+	block: string;
+	address: string;
+	postal: string;
+	title: string;
+	code: string;
+	primary: number;
+	trackPrimary: boolean;
+	description: string;
+	notes: CADDispatchNoteStruct[];
+	idents: number[];
+	metaData: Record<string, string>;
+	updated: string;
+}
+
 export type Constructable<T> = abstract new (...args: any[]) => T;
 
 export interface Caches {

package/src/index.ts

@@ -4,6 +4,7 @@ export * from './libs/rest/src';
 export {
   productEnums,
   CADNewDispatchBuilderOptions,
+  CADDispatchCallStruct,
   CADSubscriptionVersionEnum,
   CMSSubscriptionVersionEnum,
   RadioSubscriptionLevel,

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

@@ -335,11 +335,24 @@ export class REST extends EventEmitter {
 				if (payload && typeof payload === 'object' && !Array.isArray(payload)) {
 					return payload;
 				}
+				const noteTypeOrLabel = args[3];
+				const isNoteType = noteTypeOrLabel === 'text' || noteTypeOrLabel === 'link';
 				return {
 					serverId: args[0],
 					callId: args[1],
 					note: args[2],
-					label: args[3]
+					noteType: isNoteType ? noteTypeOrLabel : undefined,
+					label: isNoteType ? args[4] : noteTypeOrLabel
+				};
+			}
+			case 'REMOVE_911': {
+				const payload = args[0];
+				if (payload && typeof payload === 'object' && !Array.isArray(payload)) {
+					return payload;
+				}
+				return {
+					serverId: args[0],
+					callId: args[1]
 				};
 			}
 			case 'CLOSE_CALL': {

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

@@ -954,6 +954,12 @@ export interface CADAddCallNoteStruct {
 	callId: number;
 	note: string;
 	label?: string;
+	noteType?: 'text' | 'link';
+}
+
+export interface CADRemove911Struct {
+	serverId: number;
+	callId: number;
 }
 
 export interface CADGetActiveUnitsStruct {
@@ -1135,7 +1141,12 @@ export interface RESTTypedAPIDataStructs {
 	ADD_BLIP: [data: CADAddBlipStruct[]];
 	MODIFY_BLIP: [data: CADModifyBlipStruct[]];
 	REMOVE_BLIP: [id: number];
-	REMOVE_911: [callId: number];
+	REMOVE_911: [
+		serverId: number,
+		callId: number
+	] | [
+		data: CADRemove911Struct
+	];
 	GET_CALLS: [data: CADGetCallsStruct];
 	GET_MY_CALL: [data: CADGetMyCallStruct];
 	GET_ACTIVE_UNITS: [data: CADGetActiveUnitsStruct];
@@ -1174,6 +1185,11 @@ export interface RESTTypedAPIDataStructs {
 		serverId: number,
 		callId: number,
 		note: string
+	] | [
+		serverId: number,
+		callId: number,
+		note: string,
+		noteType: 'text' | 'link'
 	] | [
 		data: CADAddCallNoteStruct
 	];

package/src/managers/CADManager.ts

@@ -20,6 +20,7 @@ import type {
   CADGetCallsStruct,
   CADGetMyCallStruct,
   CADAddCallNoteStruct,
+  CADRemove911Struct,
   CADGetActiveUnitsStruct,
   CADNewDispatchStruct,
   CADAttachUnitsStruct,
@@ -587,11 +588,20 @@ export class CADManager extends BaseManager {
   /**
    * Removes a 911 call by its identifier.
    */
-  public async remove911Call(callId: number): Promise<globalTypes.CADStandardResponse> {
-    if (!Number.isInteger(callId)) {
-      throw new Error('callId must be an integer when removing a 911 call.');
+  public async remove911Call(serverId: number, callId: number): Promise<globalTypes.CADStandardResponse>;
+  public async remove911Call(params: CADRemove911Struct): Promise<globalTypes.CADStandardResponse>;
+  public async remove911Call(serverIdOrParams: number | CADRemove911Struct, callId?: number): Promise<globalTypes.CADStandardResponse> {
+    let payload: CADRemove911Struct;
+    if (serverIdOrParams && typeof serverIdOrParams === 'object') {
+      payload = { ...serverIdOrParams };
+    } else {
+      payload = { serverId: serverIdOrParams as number, callId: callId as number };
+    }
+    const { serverId, callId: resolvedCallId } = payload;
+    if (!Number.isInteger(serverId) || !Number.isInteger(resolvedCallId)) {
+      throw new Error('serverId and callId must be integers when removing a 911 call.');
     }
-    return this.executeCadRequest('REMOVE_911', callId);
+    return this.executeCadRequest('REMOVE_911', { serverId, callId: resolvedCallId });
   }
 
   /**
@@ -634,7 +644,7 @@ export class CADManager extends BaseManager {
   /**
    * Creates a new dispatch call.
    */
-  public async createDispatch(data: CADNewDispatchStruct): Promise<globalTypes.CADStandardResponse> {
+  public async createDispatch(data: CADNewDispatchStruct): Promise<globalTypes.CADStandardResponse<globalTypes.CADDispatchCallStruct>> {
     const hasUnits = Array.isArray(data.units);
     const hasAccounts = Array.isArray(data.accounts);
     const payload: CADNewDispatchStruct = {
@@ -756,27 +766,36 @@ export class CADManager extends BaseManager {
    * Adds a note to an active call.
    */
   public async addCallNote(serverId: number, callId: number, note: string, label?: string): Promise<globalTypes.CADStandardResponse>;
+  public async addCallNote(serverId: number, callId: number, note: string, noteType: 'text' | 'link', label?: string): Promise<globalTypes.CADStandardResponse>;
   public async addCallNote(params: CADAddCallNoteStruct): Promise<globalTypes.CADStandardResponse>;
   public async addCallNote(
     serverIdOrParams: number | CADAddCallNoteStruct,
     callId?: number,
     note?: string,
+    noteTypeOrLabel?: 'text' | 'link' | string,
     label?: string
   ): Promise<globalTypes.CADStandardResponse> {
     let payload: CADAddCallNoteStruct;
     if (serverIdOrParams && typeof serverIdOrParams === 'object') {
       payload = { ...serverIdOrParams };
     } else {
-      payload = { serverId: serverIdOrParams as number, callId: callId as number, note: note as string, label };
+      const isNoteType = noteTypeOrLabel === 'text' || noteTypeOrLabel === 'link';
+      payload = {
+        serverId: serverIdOrParams as number,
+        callId: callId as number,
+        note: note as string,
+        noteType: isNoteType ? (noteTypeOrLabel as 'text' | 'link') : undefined,
+        label: isNoteType ? label : (noteTypeOrLabel as string | undefined)
+      };
     }
-    const { serverId, callId: resolvedCallId, note: resolvedNote, label: resolvedLabel } = payload;
+    const { serverId, callId: resolvedCallId, note: resolvedNote, label: resolvedLabel, noteType } = payload;
     if (!Number.isInteger(serverId) || !Number.isInteger(resolvedCallId)) {
       throw new Error('serverId and callId must be integers when adding a call note.');
     }
     if (!resolvedNote) {
       throw new Error('note is required when adding a call note.');
     }
-    return this.executeCadRequest('ADD_CALL_NOTE', { serverId, callId: resolvedCallId, note: resolvedNote, label: resolvedLabel });
+    return this.executeCadRequest('ADD_CALL_NOTE', { serverId, callId: resolvedCallId, note: resolvedNote, label: resolvedLabel, noteType });
   }
 
   /**