@sonoransoftware/sonoran.js 1.0.41 → 1.0.45

package/dist/constants.d.ts

@@ -111,6 +111,29 @@ export interface CMSClockInType {
     id: string;
     label: string;
 }
+export interface AccountActivityLog {
+    id: string;
+    status: boolean;
+    accId: string;
+    serverId: number;
+    start: string;
+    end: string | null;
+    clearReason: string | null;
+    metadata: Record<string, any>;
+    objKey: string;
+}
+export interface AccountClockInLog {
+    id: number;
+    startTime: string | null;
+    endTime: string | null;
+    completed: boolean;
+    notes: {
+        timestamp: string;
+        message: string;
+    }[];
+    type?: string;
+    objKey: string;
+}
 export interface CMSGetClockInTypesPromiseResult {
     success: boolean;
     reason?: string;
@@ -119,7 +142,7 @@ export interface CMSGetClockInTypesPromiseResult {
 export interface CMSGetLatestActivityPromiseResult {
     success: boolean;
     reason?: string;
-    data?: string | null;
+    data?: AccountClockInLog[] | AccountActivityLog[];
 }
 export interface CMSClockInOutParams {
     accId?: string;

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

@@ -195,6 +195,18 @@ class REST extends events_1.EventEmitter {
                     type: args[5]
                 };
             }
+            case 'UNIT_STATUS': {
+                const payload = args[0];
+                if (payload && typeof payload === 'object' && !Array.isArray(payload)) {
+                    const { apiId, account, status, serverId } = payload;
+                    return { apiId, account, status, serverId };
+                }
+                return {
+                    apiId: args[0],
+                    status: args[1],
+                    serverId: args[2]
+                };
+            }
             case 'CHECK_COM_APIID': {
                 return {
                     apiId: args[0]
@@ -348,8 +360,9 @@ class REST extends events_1.EventEmitter {
             }
             case 'RADIO_SET_USER_CHANNELS': {
                 return {
-                    identity: args[0],
-                    options: (_c = args[1]) !== null && _c !== void 0 ? _c : {}
+                    roomId: args[0],
+                    identity: args[1],
+                    options: (_c = args[2]) !== null && _c !== void 0 ? _c : {}
                 };
             }
             case 'RADIO_SET_USER_DISPLAY_NAME': {

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

@@ -238,7 +238,7 @@ class RequestManager extends events_1.EventEmitter {
         return apiData;
     }
     static resolveRadioRequest(instance, apiURL, apiType, request, apiData) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         if (!apiURL || typeof apiURL !== 'string') {
             throw new Error('Radio API URL could not be resolved for request.');
         }
@@ -313,12 +313,20 @@ class RequestManager extends events_1.EventEmitter {
             }
             case 'RADIO_SET_USER_CHANNELS': {
                 const auth = ensureAuth();
+                const roomIdRaw = (_b = payload === null || payload === void 0 ? void 0 : payload.roomId) !== null && _b !== void 0 ? _b : payload === null || payload === void 0 ? void 0 : payload.roomID;
+                if (roomIdRaw === undefined) {
+                    throw new Error('roomId is required for RADIO_SET_USER_CHANNELS requests.');
+                }
+                const roomIdNumeric = typeof roomIdRaw === 'number' ? roomIdRaw : Number(roomIdRaw);
+                if (Number.isNaN(roomIdNumeric)) {
+                    throw new Error('roomId must be a number for RADIO_SET_USER_CHANNELS requests.');
+                }
                 const identity = payload === null || payload === void 0 ? void 0 : payload.identity;
                 if (!identity) {
                     throw new Error('identity is required for RADIO_SET_USER_CHANNELS requests.');
                 }
-                const options = (_b = payload === null || payload === void 0 ? void 0 : payload.options) !== null && _b !== void 0 ? _b : {};
-                path = `${apiType.path}/${auth.encodedId}/${auth.encodedKey}/${encodeSegment(identity)}`;
+                const options = (_c = payload === null || payload === void 0 ? void 0 : payload.options) !== null && _c !== void 0 ? _c : {};
+                path = `${apiType.path}/${auth.encodedId}/${auth.encodedKey}/${encodeSegment(roomIdNumeric)}/${encodeSegment(identity)}`;
                 method = 'POST';
                 const requestBody = {};
                 if ((options === null || options === void 0 ? void 0 : options.transmit) !== undefined) {
@@ -379,7 +387,7 @@ class RequestManager extends events_1.EventEmitter {
                     key: auth.key,
                     locations
                 };
-                const token = (_c = payload === null || payload === void 0 ? void 0 : payload.token) !== null && _c !== void 0 ? _c : auth.key;
+                const token = (_d = payload === null || payload === void 0 ? void 0 : payload.token) !== null && _d !== void 0 ? _d : auth.key;
                 if (token) {
                     headers.Authorization = `Bearer ${token}`;
                 }

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

@@ -273,6 +273,12 @@ export interface CADUnitLocationStruct {
     apiId: string;
     location: string;
 }
+export interface CADUnitStatusStruct {
+    apiId?: string;
+    account?: string;
+    status: number;
+    serverId: number;
+}
 export interface RESTTypedAPIDataStructs {
     GET_SERVERS: [];
     SET_SERVERS: [
@@ -348,6 +354,8 @@ export interface RESTTypedAPIDataStructs {
         apiId: string | undefined,
         status: number,
         serverId: number
+    ] | [
+        data: CADUnitStatusStruct
     ];
     GET_BLIPS: [serverId: number];
     ADD_BLIP: [data: CADAddBlipStruct[]];
@@ -575,6 +583,7 @@ export interface RESTTypedAPIDataStructs {
         identity: string
     ];
     RADIO_SET_USER_CHANNELS: [
+        roomId: number,
         identity: string,
         options?: RadioSetUserChannelsOptions
     ];
@@ -636,7 +645,8 @@ export type PossibleRequestData = undefined | {
     apiId: string;
     isPanic: boolean;
 } | {
-    apiId: string;
+    apiId?: string;
+    account?: string;
     status: number;
     serverId: number;
 } | {

package/dist/managers/CADManager.d.ts

@@ -160,6 +160,12 @@ export declare class CADManager extends BaseManager {
      * Updates a unit's status.
      */
     setUnitStatus(apiId: string | undefined, status: number, serverId: number): Promise<globalTypes.CADStandardResponse>;
+    setUnitStatus(params: {
+        apiId?: string;
+        account?: string;
+        status: number;
+        serverId: number;
+    }): Promise<globalTypes.CADStandardResponse>;
     /**
      * Retrieves live map blips for a CAD server.
      */

package/dist/managers/CADManager.js

@@ -382,14 +382,30 @@ class CADManager extends BaseManager_1.BaseManager {
     async setUnitPanic(apiId, isPanic) {
         return this.executeCadRequest('UNIT_PANIC', apiId, isPanic);
     }
-    /**
-     * Updates a unit's status.
-     */
-    async setUnitStatus(apiId, status, serverId) {
-        if (!Number.isInteger(serverId)) {
+    async setUnitStatus(apiIdOrParams, status, serverId) {
+        let payload;
+        if (apiIdOrParams && typeof apiIdOrParams === 'object' && !Array.isArray(apiIdOrParams)) {
+            payload = {
+                apiId: apiIdOrParams.apiId,
+                account: apiIdOrParams.account,
+                status: apiIdOrParams.status,
+                serverId: apiIdOrParams.serverId
+            };
+        }
+        else {
+            payload = { apiId: apiIdOrParams, status: status, serverId: serverId };
+        }
+        const { apiId, account, status: resolvedStatus, serverId: resolvedServerId } = payload;
+        if (!Number.isInteger(resolvedServerId)) {
             throw new Error('serverId must be an integer when updating unit status.');
         }
-        return this.executeCadRequest('UNIT_STATUS', apiId, status, serverId);
+        if (resolvedStatus === undefined) {
+            throw new Error('status is required when updating unit status.');
+        }
+        if (!apiId && !account) {
+            throw new Error('Either apiId or account is required when updating unit status.');
+        }
+        return this.executeCadRequest('UNIT_STATUS', { apiId, account, status: resolvedStatus, serverId: resolvedServerId });
     }
     /**
      * Retrieves live map blips for a CAD server.

package/dist/managers/CMSManager.js

@@ -578,7 +578,8 @@ class CMSManager extends BaseManager_1.BaseManager {
             var _a;
             try {
                 const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_LATEST_ACTIVITY', params));
-                resolve({ success: true, data: response });
+                const data = response && typeof response === 'object' && 'data' in response ? response.data : response;
+                resolve({ success: true, data });
             }
             catch (err) {
                 if (err instanceof src_1.APIError) {

package/dist/managers/RadioManager.d.ts

@@ -27,10 +27,11 @@ export declare class RadioManager extends BaseManager {
     getConnectedUser(roomId: number, identity: string): Promise<globalTypes.RadioGetConnectedUserPromiseResult>;
     /**
      * Updates a user's transmit and scanned channel configuration.
+     * @param {number} roomId Multi-server room id.
      * @param {string} identity The user's UUID.
      * @param {RadioSetUserChannelsOptions} options Transmit and scan channel configuration.
      */
-    setUserChannels(identity: string, options?: globalTypes.RadioSetUserChannelsOptions): Promise<globalTypes.RadioSetUserChannelsPromiseResult>;
+    setUserChannels(roomId: number, identity: string, options?: globalTypes.RadioSetUserChannelsOptions): Promise<globalTypes.RadioSetUserChannelsPromiseResult>;
     /**
      * Updates a user's display name.
      * @param {string} accId The user's account UUID.

package/dist/managers/RadioManager.js

@@ -115,14 +115,15 @@ class RadioManager extends BaseManager_1.BaseManager {
     }
     /**
      * Updates a user's transmit and scanned channel configuration.
+     * @param {number} roomId Multi-server room id.
      * @param {string} identity The user's UUID.
      * @param {RadioSetUserChannelsOptions} options Transmit and scan channel configuration.
      */
-    async setUserChannels(identity, options = {}) {
+    async setUserChannels(roomId, identity, options = {}) {
         return new Promise(async (resolve, reject) => {
             var _a, _b;
             try {
-                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('RADIO_SET_USER_CHANNELS', identity, options));
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('RADIO_SET_USER_CHANNELS', roomId, identity, options));
                 resolve({ success: true, result: (_b = response === null || response === void 0 ? void 0 : response.result) !== null && _b !== void 0 ? _b : response });
             }
             catch (err) {

package/package.json

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

@@ -103,11 +103,18 @@ const lookup = await instance.cad.lookupRecords({ apiId: '1234567890', types: [2
 ### Identifiers & Units
 - **`getIdentifiers(apiId)`**
 - **`modifyIdentifier(change)`** / **`setIdentifier(apiId?, identId)`**
-- **`setUnitPanic(apiId?, isPanic)`** / **`setUnitStatus(apiId?, status, serverId)`**
+- **`setUnitPanic(apiId?, isPanic)`** / **`setUnitStatus({ status, serverId, apiId?, account? })`**
 - **`getActiveUnits(options)`** - direct CAD fetch for active units.
 - **`kickUnit(apiId?, reason, serverId)`**
 - **`updateUnitLocations(locations)`**
 
+```js
+// Update a unit's status using an account UUID
+await instance.cad.setUnitStatus({ account: 'd5663516-ee35-11e9-9714-5600023b2434', status: 2, serverId: 1 });
+// Legacy positional call using an API ID
+await instance.cad.setUnitStatus('1234567890', 2, 1);
+```
+
 ### Map & Streetsigns
 - **`getBlips(serverId)`**
 - **`addBlips(blips)`** / **`updateBlips(blips)`** / **`removeBlip(id)`**
@@ -232,7 +239,7 @@ 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 `object` `{accId?: string, apiId?: string, forceClockIn?: boolean, discord?: string, uniqueId?: string, type?: string}`
 ```js
 const params = {
  accId: '',
@@ -240,11 +247,19 @@ const params = {
  forceClockIn: true,
  discord: '',
  uniqueId: '1234',
+ type: 'clockin-type-uuid'
 };
 // Clocks a user in or out
 const clock = await instance.cms.clockInOut(params);
 ```
 
+### getClockInTypes()
+Returns the configured clock-in types.
+```js
+const types = await instance.cms.getClockInTypes();
+// [{ id: 'uuid', label: 'Patrol' }]
+```
+
 ### checkComApiId(apiId)
 Checks if a given API ID is attatched to any account within the community, and if true, returns the username of the associated account.
 #### Arugment `apiId`
@@ -327,6 +342,16 @@ Fetches the current clock-in entry for the account if one exists.
 const currentEntry = await instance.cms.getCurrentClockIn({ apiId: '1234' });
 ```
 
+### getLatestActivity(params)
+Gets the latest clock-in or activity entries for an account.
+```js
+// Clock-in history
+const clockins = await instance.cms.getLatestActivity({ accId: 'account-uuid', type: 'clockin' });
+// Activity history (requires serverId)
+const activity = await instance.cms.getLatestActivity({ accId: 'account-uuid', type: 'activity', serverId: 1 });
+```
+*Returns an array of clock-in logs (`AccountClockInLog`) or activity logs (`AccountActivityLog`); each item includes `objKey` alongside the other fields.*
+
 ### getAccounts(options)
 Retrieves CMS accounts with optional pagination and status filters.
 ```js
@@ -430,10 +455,10 @@ Fetches a specific connected radio user by room and identity.
 const user = await instance.radio.getConnectedUser(1, 'account-uuid');
 ```
 
-### setUserChannels(identity, options)
-Updates a user's transmit or scan channels.
+### setUserChannels(roomId, identity, options)
+Updates a user's transmit or scan channels for a specific radio room.
 ```js
-await instance.radio.setUserChannels('account-uuid', { transmit: 12, scan: [10, 11, 12] });
+await instance.radio.setUserChannels(1, 'account-uuid', { transmit: 12, scan: [10, 11, 12] });
 ```
 
 ### setUserDisplayName(accId, displayName)

package/src/constants.ts

@@ -127,6 +127,31 @@ export interface CMSClockInType {
 	label: string;
 }
 
+export interface AccountActivityLog {
+	id: string;
+	status: boolean;
+	accId: string;
+	serverId: number;
+	start: string;
+	end: string | null;
+	clearReason: string | null;
+	metadata: Record<string, any>;
+	objKey: string;
+}
+
+export interface AccountClockInLog {
+	id: number;
+	startTime: string | null;
+	endTime: string | null;
+	completed: boolean;
+	notes: {
+		timestamp: string;
+		message: string;
+	}[];
+	type?: string;
+	objKey: string;
+}
+
 export interface CMSGetClockInTypesPromiseResult {
 	success: boolean;
 	reason?: string;
@@ -136,7 +161,7 @@ export interface CMSGetClockInTypesPromiseResult {
 export interface CMSGetLatestActivityPromiseResult {
 	success: boolean;
 	reason?: string;
-	data?: string | null;
+	data?: AccountClockInLog[] | AccountActivityLog[];
 }
 
 export interface CMSClockInOutParams {

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

@@ -299,6 +299,23 @@ export class REST extends EventEmitter {
 					type: args[5]
 				};
 			}
+			case 'UNIT_STATUS': {
+				const payload = args[0];
+				if (payload && typeof payload === 'object' && !Array.isArray(payload)) {
+					const { apiId, account, status, serverId } = payload as {
+						apiId?: string;
+						account?: string;
+						status: number;
+						serverId: number;
+					};
+					return { apiId, account, status, serverId };
+				}
+				return {
+					apiId: args[0],
+					status: args[1],
+					serverId: args[2]
+				};
+			}
 			case 'CHECK_COM_APIID': {
 				return {
 					apiId: args[0]
@@ -452,8 +469,9 @@ export class REST extends EventEmitter {
 			}
 			case 'RADIO_SET_USER_CHANNELS': {
 				return {
-					identity: args[0],
-					options: args[1] ?? {}
+					roomId: args[0],
+					identity: args[1],
+					options: args[2] ?? {}
 				}
 			}
 			case 'RADIO_SET_USER_DISPLAY_NAME': {

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

@@ -392,12 +392,20 @@ export class RequestManager extends EventEmitter {
       }
       case 'RADIO_SET_USER_CHANNELS': {
         const auth = ensureAuth();
+        const roomIdRaw = payload?.roomId ?? payload?.roomID;
+        if (roomIdRaw === undefined) {
+          throw new Error('roomId is required for RADIO_SET_USER_CHANNELS requests.');
+        }
+        const roomIdNumeric = typeof roomIdRaw === 'number' ? roomIdRaw : Number(roomIdRaw);
+        if (Number.isNaN(roomIdNumeric)) {
+          throw new Error('roomId must be a number for RADIO_SET_USER_CHANNELS requests.');
+        }
         const identity = payload?.identity;
         if (!identity) {
           throw new Error('identity is required for RADIO_SET_USER_CHANNELS requests.');
         }
         const options = payload?.options ?? {};
-        path = `${apiType.path}/${auth.encodedId}/${auth.encodedKey}/${encodeSegment(identity)}`;
+        path = `${apiType.path}/${auth.encodedId}/${auth.encodedKey}/${encodeSegment(roomIdNumeric)}/${encodeSegment(identity)}`;
         method = 'POST';
         const requestBody: Record<string, unknown> = {};
         if (options?.transmit !== undefined) {

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

@@ -900,7 +900,14 @@ export interface CADStreetSignStruct {
 
 export interface CADUnitLocationStruct {
 	apiId: string;
-location: string;
+	location: string;
+}
+
+export interface CADUnitStatusStruct {
+	apiId?: string;
+	account?: string;
+	status: number;
+	serverId: number;
 }
 
 export interface RESTTypedAPIDataStructs {
@@ -977,6 +984,8 @@ export interface RESTTypedAPIDataStructs {
 		apiId: string | undefined,
 		status: number,
 		serverId: number
+	] | [
+		data: CADUnitStatusStruct
 	];
 	GET_BLIPS: [serverId: number];
 	ADD_BLIP: [data: CADAddBlipStruct[]];
@@ -1209,6 +1218,7 @@ export interface RESTTypedAPIDataStructs {
 		identity: string
 	];
 	RADIO_SET_USER_CHANNELS: [
+		roomId: number,
 		identity: string,
 		options?: RadioSetUserChannelsOptions
 	];
@@ -1287,7 +1297,8 @@ export type PossibleRequestData =
 		isPanic: boolean;
 	} |
 	{
-		apiId: string;
+		apiId?: string;
+		account?: string;
 		status: number;
 		serverId: number;
 	} |

package/src/managers/CADManager.ts

@@ -19,7 +19,8 @@ import type {
   CADGetActiveUnitsStruct,
   CADNewDispatchStruct,
   CADStreetSignStruct,
-  CADUnitLocationStruct
+  CADUnitLocationStruct,
+  CADUnitStatusStruct
 } from '../libs/rest/src';
 import { BaseManager } from './BaseManager';
 import * as globalTypes from '../constants';
@@ -405,11 +406,35 @@ export class CADManager extends BaseManager {
   /**
    * Updates a unit's status.
    */
-  public async setUnitStatus(apiId: string | undefined, status: number, serverId: number): Promise<globalTypes.CADStandardResponse> {
-    if (!Number.isInteger(serverId)) {
+  public async setUnitStatus(apiId: string | undefined, status: number, serverId: number): Promise<globalTypes.CADStandardResponse>;
+  public async setUnitStatus(params: { apiId?: string; account?: string; status: number; serverId: number }): Promise<globalTypes.CADStandardResponse>;
+  public async setUnitStatus(
+    apiIdOrParams: string | undefined | { apiId?: string; account?: string; status: number; serverId: number },
+    status?: number,
+    serverId?: number
+  ): Promise<globalTypes.CADStandardResponse> {
+    let payload: CADUnitStatusStruct;
+    if (apiIdOrParams && typeof apiIdOrParams === 'object' && !Array.isArray(apiIdOrParams)) {
+      payload = {
+        apiId: apiIdOrParams.apiId,
+        account: apiIdOrParams.account,
+        status: apiIdOrParams.status,
+        serverId: apiIdOrParams.serverId
+      };
+    } else {
+      payload = { apiId: apiIdOrParams as string | undefined, status: status as number, serverId: serverId as number };
+    }
+    const { apiId, account, status: resolvedStatus, serverId: resolvedServerId } = payload;
+    if (!Number.isInteger(resolvedServerId)) {
       throw new Error('serverId must be an integer when updating unit status.');
     }
-    return this.executeCadRequest('UNIT_STATUS', apiId, status, serverId);
+    if (resolvedStatus === undefined) {
+      throw new Error('status is required when updating unit status.');
+    }
+    if (!apiId && !account) {
+      throw new Error('Either apiId or account is required when updating unit status.');
+    }
+    return this.executeCadRequest('UNIT_STATUS', { apiId, account, status: resolvedStatus, serverId: resolvedServerId });
   }
 
   /**

package/src/managers/CMSManager.ts

@@ -520,7 +520,8 @@ export class CMSManager extends BaseManager {
     return new Promise(async (resolve, reject) => {
       try {
         const response: any = await this.rest?.request('GET_LATEST_ACTIVITY', params);
-        resolve({ success: true, data: response });
+        const data = response && typeof response === 'object' && 'data' in response ? (response as any).data : response;
+        resolve({ success: true, data });
       } catch (err) {
         if (err instanceof APIError) {
           resolve({ success: false, reason: err.response });

package/src/managers/RadioManager.ts

@@ -90,13 +90,14 @@ export class RadioManager extends BaseManager {
 
   /**
    * Updates a user's transmit and scanned channel configuration.
+   * @param {number} roomId Multi-server room id.
    * @param {string} identity The user's UUID.
    * @param {RadioSetUserChannelsOptions} options Transmit and scan channel configuration.
    */
-  public async setUserChannels(identity: string, options: globalTypes.RadioSetUserChannelsOptions = {}): Promise<globalTypes.RadioSetUserChannelsPromiseResult> {
+  public async setUserChannels(roomId: number, identity: string, options: globalTypes.RadioSetUserChannelsOptions = {}): Promise<globalTypes.RadioSetUserChannelsPromiseResult> {
     return new Promise(async (resolve, reject) => {
       try {
-        const response: any = await this.rest?.request('RADIO_SET_USER_CHANNELS', identity, options);
+        const response: any = await this.rest?.request('RADIO_SET_USER_CHANNELS', roomId, identity, options);
         resolve({ success: true, result: response?.result ?? response });
       } catch (err) {
         if (err instanceof APIError) {