@sonoransoftware/sonoran.js 1.0.36 → 1.0.38

package/LICENSE

@@ -0,0 +1,24 @@
+PolyForm Noncommercial License 1.0.0
+
+Copyright (c) [2025] [Sonoran Software Systems, LLC]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to
+use, copy, modify, and distribute the Software, for any noncommercial purpose,
+subject to the following conditions:
+
+1. Noncommercial Use Only. You may not use the Software for a commercial
+   purpose. “Commercial purpose” means the sale, lease, license, or other
+   commercial exploitation of the Software, or the use of the Software to
+   provide a service or product for which you receive compensation.
+
+2. Compliance and Attribution. You must ensure that anyone who uses the
+   Software complies with this license, and you must retain the above
+   copyright notice and this license in all copies or substantial portions
+   of the Software.
+
+3. No Warranty. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY
+   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+
+See https://polyformproject.org/licenses/noncommercial/1.0.0/ for the full license text.

package/dist/constants.d.ts

@@ -394,6 +394,17 @@ export interface CMSERLCAddNewRecordPromiseResult {
     reason?: string;
     logId?: string;
 }
+export interface CMSERLCExecuteCommandPayload {
+    type: string;
+    args: unknown;
+    discordId: string | number;
+    includesPlayerNameOrId: boolean;
+}
+export interface CMSERLCExecuteCommandPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: unknown;
+}
 export interface RadioChannelGroup {
     id: number;
     name: string;
@@ -442,6 +453,15 @@ export interface RadioSpeakerLocation {
     label: string;
     id: string;
 }
+export type RadioTonePlayTargetType = 'channel' | 'group' | 'game';
+export interface RadioTonePlayTarget {
+    label: string;
+    type: RadioTonePlayTargetType;
+    value: unknown;
+    group: number | null;
+    icon?: string;
+    color?: string;
+}
 export interface RadioSetUserChannelsOptions {
     transmit?: number;
     scan?: number[];
@@ -504,3 +524,8 @@ export interface RadioSetInGameSpeakerLocationsPromiseResult {
     reason?: string;
     result?: string;
 }
+export interface RadioPlayTonePromiseResult {
+    success: boolean;
+    reason?: string;
+    result?: string;
+}

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, CMSGetFormSubmissionsPromiseResult } from './constants';
+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, CMSGetFormSubmissionsPromiseResult, CMSERLCGetOnlinePlayersPromiseResult, CMSERLCGetPlayerQueuePromiseResult, CMSERLCAddNewRecordPromiseResult, CMSERLCExecuteCommandPayload, CMSERLCExecuteCommandPromiseResult } from './constants';

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

@@ -300,6 +300,13 @@ class REST extends events_1.EventEmitter {
                     points: args[6],
                 };
             }
+            case 'ERLC_EXECUTE_COMMAND': {
+                const payload = args[0];
+                if (!Array.isArray(payload)) {
+                    throw new Error('ERLC_EXECUTE_COMMAND requires an array of command payloads.');
+                }
+                return payload;
+            }
             case 'RADIO_GET_COMMUNITY_CHANNELS':
             case 'RADIO_GET_CONNECTED_USERS':
             case 'RADIO_GET_SERVER_SUBSCRIPTION_FROM_IP': {
@@ -334,6 +341,13 @@ class REST extends events_1.EventEmitter {
                     token: args[1]
                 };
             }
+            case 'PLAY_TONE': {
+                return {
+                    roomId: args[0],
+                    tones: args[1],
+                    playTo: args[2]
+                };
+            }
             default: {
                 return args;
             }

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

@@ -101,6 +101,10 @@ class RequestManager extends events_1.EventEmitter {
                     apiData.data.data = [];
                     break;
                 }
+                case 'ERLC_EXECUTE_COMMAND': {
+                    apiData.data.data = clonedData;
+                    break;
+                }
                 case 'SET_PENAL_CODES': {
                     apiData.data.data = [clonedData[0]];
                     break;
@@ -378,6 +382,35 @@ class RequestManager extends events_1.EventEmitter {
                 path = apiType.path;
                 break;
             }
+            case 'PLAY_TONE': {
+                const auth = ensureAuth();
+                const roomIdRaw = payload === null || payload === void 0 ? void 0 : payload.roomId;
+                if (roomIdRaw === undefined || roomIdRaw === null) {
+                    throw new Error('roomId is required for PLAY_TONE requests.');
+                }
+                const roomIdNumber = typeof roomIdRaw === 'number' ? roomIdRaw : Number(roomIdRaw);
+                if (Number.isNaN(roomIdNumber)) {
+                    throw new Error('roomId must be a number for PLAY_TONE requests.');
+                }
+                const tones = payload === null || payload === void 0 ? void 0 : payload.tones;
+                if (!Array.isArray(tones) || tones.length === 0) {
+                    throw new Error('tones array is required for PLAY_TONE requests.');
+                }
+                const playTo = payload === null || payload === void 0 ? void 0 : payload.playTo;
+                if (!Array.isArray(playTo) || playTo.length === 0) {
+                    throw new Error('playTo array is required for PLAY_TONE requests.');
+                }
+                method = 'POST';
+                body = {
+                    id: auth.id,
+                    key: auth.key,
+                    roomId: roomIdNumber,
+                    tones,
+                    playTo
+                };
+                path = apiType.path;
+                break;
+            }
             default: {
                 throw new Error(`Unsupported radio API type received: ${apiType.type}`);
             }

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

@@ -1,4 +1,4 @@
-import { productEnums, RadioSetUserChannelsOptions, RadioSpeakerLocation, CMSProfileFieldUpdate, CMSSetGameServerStruct, CMSTriggerPromotionFlowPayload } from '../../../../../constants';
+import { productEnums, RadioSetUserChannelsOptions, RadioSpeakerLocation, RadioTonePlayTarget, CMSProfileFieldUpdate, CMSSetGameServerStruct, CMSTriggerPromotionFlowPayload, CMSERLCExecuteCommandPayload } from '../../../../../constants';
 import type { RESTOptions } from '../REST';
 export declare const DefaultUserAgent = "Sonoran.js NPM Module";
 export declare const DefaultCADRestOptions: Required<RESTOptions>;
@@ -38,7 +38,7 @@ export declare const CommunitiesCMSAPITypes: APITypeData[];
 export declare const ERLCMSAPITypes: APITypeData[];
 export declare const RadioAPITypes: APITypeData[];
 export declare const AllAPITypes: AllAPITypeData[];
-export type AllAPITypesType = 'GET_SERVERS' | 'SET_SERVERS' | 'GET_VERSION' | 'SET_PENAL_CODES' | 'SET_API_ID' | 'GET_TEMPLATES' | 'NEW_RECORD' | 'EDIT_RECORD' | 'REMOVE_RECORD' | 'LOOKUP_INT' | 'LOOKUP' | 'GET_ACCOUNT' | 'CHECK_APIID' | 'APPLY_PERMISSION_KEY' | 'SET_ACCOUNT_PERMISSIONS' | 'BAN_USER' | 'VERIFY_SECRET' | 'AUTH_STREETSIGNS' | 'SET_POSTALS' | 'SEND_PHOTO' | 'SET_CLOCK' | 'JOIN_COMMUNITY' | 'LEAVE_COMMUNITY' | 'GET_CHARACTERS' | 'NEW_CHARACTER' | 'EDIT_CHARACTER' | 'REMOVE_CHARACTER' | 'GET_IDENTIFIERS' | 'MODIFY_IDENTIFIER' | 'SET_IDENTIFIER' | 'UNIT_PANIC' | 'UNIT_STATUS' | 'GET_BLIPS' | 'ADD_BLIP' | 'MODIFY_BLIP' | 'REMOVE_BLIP' | '911_CALL' | 'REMOVE_911' | 'GET_CALLS' | 'GET_ACTIVE_UNITS' | 'KICK_UNIT' | 'NEW_DISPATCH' | 'ATTACH_UNIT' | 'DETACH_UNIT' | 'SET_CALL_POSTAL' | 'SET_CALL_PRIMARY' | 'ADD_CALL_NOTE' | 'CLOSE_CALL' | 'UNIT_LOCATION' | 'SET_STREETSIGN_CONFIG' | 'UPDATE_STREETSIGN' | 'GET_COM_ACCOUNT' | 'GET_DEPARTMENTS' | 'GET_SUB_VERSION' | 'GET_CURRENT_CLOCK_IN' | 'GET_ACCOUNTS' | 'GET_PROFILE_FIELDS' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE' | 'GET_FORM_TEMPLATE_SUBMISSIONS' | 'KICK_ACCOUNT' | 'BAN_ACCOUNT' | 'LOOKUP' | 'EDIT_ACC_PROFLIE_FIELDS' | 'SET_ACCOUNT_NAME' | 'FORCE_SYNC' | 'TRIGGER_PROMOTION_FLOWS' | 'GET_PROMOTION_FLOWS' | 'SET_GAME_SERVERS' | 'ERLC_GET_ONLINE_PLAYERS' | 'ERLC_GET_PLAYER_QUEUE' | 'ERLC_ADD_NEW_RECORD' | 'RADIO_GET_COMMUNITY_CHANNELS' | 'RADIO_GET_CONNECTED_USERS' | 'RADIO_GET_CONNECTED_USER' | 'RADIO_SET_USER_CHANNELS' | 'RADIO_SET_USER_DISPLAY_NAME' | 'RADIO_GET_SERVER_SUBSCRIPTION_FROM_IP' | 'RADIO_SET_SERVER_IP' | 'RADIO_SET_IN_GAME_SPEAKER_LOCATIONS';
+export type AllAPITypesType = 'GET_SERVERS' | 'SET_SERVERS' | 'GET_VERSION' | 'SET_PENAL_CODES' | 'SET_API_ID' | 'GET_TEMPLATES' | 'NEW_RECORD' | 'EDIT_RECORD' | 'REMOVE_RECORD' | 'LOOKUP_INT' | 'LOOKUP' | 'GET_ACCOUNT' | 'CHECK_APIID' | 'APPLY_PERMISSION_KEY' | 'SET_ACCOUNT_PERMISSIONS' | 'BAN_USER' | 'VERIFY_SECRET' | 'AUTH_STREETSIGNS' | 'SET_POSTALS' | 'SEND_PHOTO' | 'SET_CLOCK' | 'JOIN_COMMUNITY' | 'LEAVE_COMMUNITY' | 'GET_CHARACTERS' | 'NEW_CHARACTER' | 'EDIT_CHARACTER' | 'REMOVE_CHARACTER' | 'GET_IDENTIFIERS' | 'MODIFY_IDENTIFIER' | 'SET_IDENTIFIER' | 'UNIT_PANIC' | 'UNIT_STATUS' | 'GET_BLIPS' | 'ADD_BLIP' | 'MODIFY_BLIP' | 'REMOVE_BLIP' | '911_CALL' | 'REMOVE_911' | 'GET_CALLS' | 'GET_ACTIVE_UNITS' | 'KICK_UNIT' | 'NEW_DISPATCH' | 'ATTACH_UNIT' | 'DETACH_UNIT' | 'SET_CALL_POSTAL' | 'SET_CALL_PRIMARY' | 'ADD_CALL_NOTE' | 'CLOSE_CALL' | 'UNIT_LOCATION' | 'SET_STREETSIGN_CONFIG' | 'UPDATE_STREETSIGN' | 'GET_COM_ACCOUNT' | 'GET_DEPARTMENTS' | 'GET_SUB_VERSION' | 'GET_CURRENT_CLOCK_IN' | 'GET_ACCOUNTS' | 'GET_PROFILE_FIELDS' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE' | 'GET_FORM_TEMPLATE_SUBMISSIONS' | 'KICK_ACCOUNT' | 'BAN_ACCOUNT' | 'LOOKUP' | 'EDIT_ACC_PROFLIE_FIELDS' | 'SET_ACCOUNT_NAME' | 'FORCE_SYNC' | 'TRIGGER_PROMOTION_FLOWS' | 'GET_PROMOTION_FLOWS' | 'SET_GAME_SERVERS' | 'ERLC_GET_ONLINE_PLAYERS' | 'ERLC_GET_PLAYER_QUEUE' | 'ERLC_ADD_NEW_RECORD' | 'ERLC_EXECUTE_COMMAND' | 'RADIO_GET_COMMUNITY_CHANNELS' | 'RADIO_GET_CONNECTED_USERS' | 'RADIO_GET_CONNECTED_USER' | 'RADIO_SET_USER_CHANNELS' | 'RADIO_SET_USER_DISPLAY_NAME' | 'RADIO_GET_SERVER_SUBSCRIPTION_FROM_IP' | 'RADIO_SET_SERVER_IP' | 'RADIO_SET_IN_GAME_SPEAKER_LOCATIONS' | 'PLAY_TONE';
 export interface CMSServerAPIStruct {
     id: number;
     name: string;
@@ -555,6 +555,9 @@ export interface RESTTypedAPIDataStructs {
         playerRobloxId?: string | number,
         points?: number
     ];
+    ERLC_EXECUTE_COMMAND: [
+        commands: CMSERLCExecuteCommandPayload[]
+    ];
     RADIO_GET_COMMUNITY_CHANNELS: [];
     RADIO_GET_CONNECTED_USERS: [];
     RADIO_GET_CONNECTED_USER: [
@@ -577,6 +580,11 @@ export interface RESTTypedAPIDataStructs {
         locations: RadioSpeakerLocation[],
         token?: string
     ];
+    PLAY_TONE: [
+        roomId: number,
+        tones: number[],
+        playTo: RadioTonePlayTarget[]
+    ];
 }
 export type PossibleRequestData = undefined | {
     data: CADPenalCodeStruct[] | CADSetAPIIDStruct | CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct | CADLookupByIntStruct | CADLookupStruct | CADModifyAccountPermsStruct | CADKickBanUserStruct | CADSetPostalStruct[] | CADModifyIdentifierStruct | CADAddBlipStruct[] | CADModifyBlipStruct[] | CADGetCallsStruct | CADGetActiveUnitsStruct | CADNewDispatchStruct | CMSTriggerPromotionFlowPayload[];

package/dist/libs/rest/src/lib/utils/constants.js

@@ -511,6 +511,12 @@ exports.ERLCMSAPITypes = [
         path: "erlc/add_new_record",
         method: "POST",
         minVersion: 0
+    },
+    {
+        type: "ERLC_EXECUTE_COMMAND",
+        path: "erlc/execute_command",
+        method: "POST",
+        minVersion: 0
     }
 ];
 exports.RadioAPITypes = [
@@ -561,6 +567,12 @@ exports.RadioAPITypes = [
         path: 'radio/set-server-speakers',
         method: 'POST',
         minVersion: 0
+    },
+    {
+        type: 'PLAY_TONE',
+        path: 'api/play-tone',
+        method: 'POST',
+        minVersion: 0
     }
 ];
 function formatForAll(array, product) {

package/dist/managers/CMSManager.d.ts

@@ -260,6 +260,10 @@ export declare class CMSManager extends BaseManager {
      * @returns {Promise} Promise object indicates success and includes the queue count when successful.
      */
     erlcGetPlayerQueue(robloxJoinCode: string): Promise<globalTypes.CMSERLCGetPlayerQueuePromiseResult>;
+    /**
+     * Sends an ERLC command payload to CMS.
+     */
+    erlcExecuteCommand(commands: globalTypes.CMSERLCExecuteCommandPayload[]): Promise<globalTypes.CMSERLCExecuteCommandPromiseResult>;
     /**
      * Adds a new ERLC record for a player.
      * @param {Object} data The object that contains critical data to add a new ERLC record.

package/dist/managers/CMSManager.js

@@ -627,6 +627,29 @@ class CMSManager extends BaseManager_1.BaseManager {
             }
         });
     }
+    /**
+     * Sends an ERLC command payload to CMS.
+     */
+    async erlcExecuteCommand(commands) {
+        if (!Array.isArray(commands) || commands.length === 0) {
+            throw new Error('ERLC execute command requires at least one command payload.');
+        }
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const erlcExecuteCommandRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('ERLC_EXECUTE_COMMAND', commands));
+                resolve({ success: true, data: erlcExecuteCommandRequest });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
     /**
      * Adds a new ERLC record for a player.
      * @param {Object} data The object that contains critical data to add a new ERLC record.

package/dist/managers/RadioManager.d.ts

@@ -52,4 +52,11 @@ export declare class RadioManager extends BaseManager {
      * @param {string} [token] Optional bearer token for authorization. Defaults to the community API key.
      */
     setInGameSpeakerLocations(locations: globalTypes.RadioSpeakerLocation[], token?: string): Promise<globalTypes.RadioSetInGameSpeakerLocationsPromiseResult>;
+    /**
+     * Plays one or more tones to radio channels, groups, or in-game speakers.
+     * @param {number} roomId Multi-server room id for tone playback.
+     * @param {number[]} tones Tone identifiers to play.
+     * @param {globalTypes.RadioTonePlayTarget[]} playTo Targets that should receive the tones.
+     */
+    playTone(roomId: number, tones: number[], playTo: globalTypes.RadioTonePlayTarget[]): Promise<globalTypes.RadioPlayTonePromiseResult>;
 }

package/dist/managers/RadioManager.js

@@ -220,5 +220,28 @@ class RadioManager extends BaseManager_1.BaseManager {
             }
         });
     }
+    /**
+     * Plays one or more tones to radio channels, groups, or in-game speakers.
+     * @param {number} roomId Multi-server room id for tone playback.
+     * @param {number[]} tones Tone identifiers to play.
+     * @param {globalTypes.RadioTonePlayTarget[]} playTo Targets that should receive the tones.
+     */
+    async playTone(roomId, tones, playTo) {
+        return new Promise(async (resolve, reject) => {
+            var _a, _b;
+            try {
+                const response = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('PLAY_TONE', roomId, tones, playTo));
+                resolve({ success: true, result: (_b = response === null || response === void 0 ? void 0 : response.result) !== null && _b !== void 0 ? _b : response });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
 }
 exports.RadioManager = RadioManager;

package/package.json

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

@@ -1,5 +1,10 @@
 # Sonoran.js
-Sonoran.js is a library that allows you to interact with the [Sonoran CAD](https://sonorancad.com/) and [Sonoran CMS](https://sonorancms.com/) API. Based off of and utilizes several Discord.js library techniques for ease of use.
+Sonoran.js is a library that allows you to interact with the [Sonoran CAD](https://docs.sonoransoftware.com/cad), [Sonoran Radio](https://docs.sonoransoftware.com/radio), and [Sonoran CMS](https://docs.sonoransoftware.com/cms) API. Based off of and utilizes several Discord.js library techniques for ease of use.
+
+## Installation
+```js
+npm i @sonoransoftware/sonoran.js
+```
 
 ## Example Instance Setup
 
@@ -458,5 +463,14 @@ await instance.radio.setInGameSpeakerLocations(
 );
 ```
 
+### playTone(roomId, tones, playTo)
+Dispatches tones to channels, groups, or in-game speakers.
+```js
+await instance.radio.playTone(1, [1001, 1002], [
+  { label: 'Primary Dispatch', type: 'channel', value: 10, group: 2 },
+  { label: 'Station Speakers', type: 'game', value: 'station-1', group: null }
+]);
+```
+
 ## Further Documentation
 More documentation for Sonoran CAD specific methods and usage can be found [here](/docs/CAD-Methods-and-Usage.md), Sonoran CMS specific methods and usage can be found [here](/docs/CMS-Methods-and-Usage.md), and usage information for the REST class [here](/docs/REST-Methods-and-Usage.md).

package/src/constants.ts

@@ -443,6 +443,19 @@ export interface CMSERLCAddNewRecordPromiseResult {
 	logId?: string;
 }
 
+export interface CMSERLCExecuteCommandPayload {
+	type: string;
+	args: unknown;
+	discordId: string | number;
+	includesPlayerNameOrId: boolean;
+}
+
+export interface CMSERLCExecuteCommandPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: unknown;
+}
+
 export interface RadioChannelGroup {
 	id: number;
 	name: string;
@@ -498,6 +511,17 @@ export interface RadioSpeakerLocation {
 	id: string;
 }
 
+export type RadioTonePlayTargetType = 'channel' | 'group' | 'game';
+
+export interface RadioTonePlayTarget {
+	label: string;
+	type: RadioTonePlayTargetType;
+	value: unknown;
+	group: number | null;
+	icon?: string;
+	color?: string;
+}
+
 export interface RadioSetUserChannelsOptions {
 	transmit?: number;
 	scan?: number[];
@@ -569,3 +593,9 @@ export interface RadioSetInGameSpeakerLocationsPromiseResult {
 	reason?: string;
 	result?: string;
 }
+
+export interface RadioPlayTonePromiseResult {
+	success: boolean;
+	reason?: string;
+	result?: string;
+}

package/src/index.ts

@@ -41,5 +41,10 @@ export {
   CMSPromotionFlow,
   CMSTriggerPromotionFlowsPromiseResult,
   CMSGetPromotionFlowsPromiseResult,
-  CMSGetFormSubmissionsPromiseResult
+  CMSGetFormSubmissionsPromiseResult,
+  CMSERLCGetOnlinePlayersPromiseResult,
+  CMSERLCGetPlayerQueuePromiseResult,
+  CMSERLCAddNewRecordPromiseResult,
+  CMSERLCExecuteCommandPayload,
+  CMSERLCExecuteCommandPromiseResult
 } from './constants';

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

@@ -404,6 +404,13 @@ export class REST extends EventEmitter {
 					points: args[6],
 				}
 			}
+			case 'ERLC_EXECUTE_COMMAND': {
+				const payload = args[0];
+				if (!Array.isArray(payload)) {
+					throw new Error('ERLC_EXECUTE_COMMAND requires an array of command payloads.');
+				}
+				return payload;
+			}
 			case 'RADIO_GET_COMMUNITY_CHANNELS':
 			case 'RADIO_GET_CONNECTED_USERS':
 			case 'RADIO_GET_SERVER_SUBSCRIPTION_FROM_IP': {
@@ -438,6 +445,13 @@ export class REST extends EventEmitter {
 					token: args[1]
 				}
 			}
+			case 'PLAY_TONE': {
+				return {
+					roomId: args[0],
+					tones: args[1],
+					playTo: args[2]
+				}
+			}
 			default: {
 				return args;
 			}

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

@@ -174,6 +174,10 @@ export class RequestManager extends EventEmitter {
           apiData.data.data = [];
           break;
         }
+        case 'ERLC_EXECUTE_COMMAND': {
+          apiData.data.data = clonedData;
+          break;
+        }
         case 'SET_PENAL_CODES': {
           apiData.data.data = [clonedData[0]];
           break;
@@ -457,6 +461,35 @@ export class RequestManager extends EventEmitter {
         path = apiType.path;
         break;
       }
+      case 'PLAY_TONE': {
+        const auth = ensureAuth();
+        const roomIdRaw = payload?.roomId;
+        if (roomIdRaw === undefined || roomIdRaw === null) {
+          throw new Error('roomId is required for PLAY_TONE requests.');
+        }
+        const roomIdNumber = typeof roomIdRaw === 'number' ? roomIdRaw : Number(roomIdRaw);
+        if (Number.isNaN(roomIdNumber)) {
+          throw new Error('roomId must be a number for PLAY_TONE requests.');
+        }
+        const tones = payload?.tones;
+        if (!Array.isArray(tones) || tones.length === 0) {
+          throw new Error('tones array is required for PLAY_TONE requests.');
+        }
+        const playTo = payload?.playTo;
+        if (!Array.isArray(playTo) || playTo.length === 0) {
+          throw new Error('playTo array is required for PLAY_TONE requests.');
+        }
+        method = 'POST';
+        body = {
+          id: auth.id,
+          key: auth.key,
+          roomId: roomIdNumber,
+          tones,
+          playTo
+        };
+        path = apiType.path;
+        break;
+      }
       default: {
         throw new Error(`Unsupported radio API type received: ${apiType.type}`);
       }

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

@@ -1,4 +1,4 @@
-import { productEnums, RadioSetUserChannelsOptions, RadioSpeakerLocation, CMSProfileFieldUpdate, CMSSetGameServerStruct, CMSTriggerPromotionFlowPayload } from '../../../../../constants';
+import { productEnums, RadioSetUserChannelsOptions, RadioSpeakerLocation, RadioTonePlayTarget, CMSProfileFieldUpdate, CMSSetGameServerStruct, CMSTriggerPromotionFlowPayload, CMSERLCExecuteCommandPayload } from '../../../../../constants';
 import type { RESTOptions } from '../REST';
 
 export const DefaultUserAgent = 'Sonoran.js NPM Module';
@@ -548,6 +548,12 @@ export const ERLCMSAPITypes: APITypeData[] = [
 		path: "erlc/add_new_record",
 		method: "POST",
 		minVersion: 0
+	},
+	{
+		type: "ERLC_EXECUTE_COMMAND",
+		path: "erlc/execute_command",
+		method: "POST",
+		minVersion: 0
 	}
 ];
 
@@ -599,6 +605,12 @@ export const RadioAPITypes: APITypeData[] = [
 		path: 'radio/set-server-speakers',
 		method: 'POST',
 		minVersion: 0
+	},
+	{
+		type: 'PLAY_TONE',
+		path: 'api/play-tone',
+		method: 'POST',
+		minVersion: 0
 	}
 ];
 
@@ -613,7 +625,7 @@ function formatForAll(array: APITypeData[], product: productEnums): AllAPITypeDa
 
 export const AllAPITypes: AllAPITypeData[] = [ ...formatForAll(GeneralCADAPITypes, productEnums.CAD), ...formatForAll(CivilianCADAPITypes, productEnums.CAD), ...formatForAll(EmergencyCADAPITypes, productEnums.CAD), ...formatForAll(GeneralCMSAPITypes, productEnums.CMS), ...formatForAll(ServersCMSAPITypes, productEnums.CMS), ...formatForAll(EventsCMSAPITypes, productEnums.CMS),  ...formatForAll(FormsCMSAPITypes, productEnums.CMS), ...formatForAll(CommunitiesCMSAPITypes, productEnums.CMS), ...formatForAll(ERLCMSAPITypes, productEnums.CMS), ...formatForAll(RadioAPITypes, productEnums.RADIO) ];
 
-export type AllAPITypesType = 'GET_SERVERS' | 'SET_SERVERS' | 'GET_VERSION' | 'SET_PENAL_CODES' | 'SET_API_ID' | 'GET_TEMPLATES' | 'NEW_RECORD' | 'EDIT_RECORD' | 'REMOVE_RECORD' | 'LOOKUP_INT' | 'LOOKUP' | 'GET_ACCOUNT' | 'CHECK_APIID' | 'APPLY_PERMISSION_KEY' | 'SET_ACCOUNT_PERMISSIONS' | 'BAN_USER' | 'VERIFY_SECRET' | 'AUTH_STREETSIGNS' | 'SET_POSTALS' | 'SEND_PHOTO' | 'SET_CLOCK' | 'JOIN_COMMUNITY' | 'LEAVE_COMMUNITY' | 'GET_CHARACTERS' | 'NEW_CHARACTER' | 'EDIT_CHARACTER' | 'REMOVE_CHARACTER' | 'GET_IDENTIFIERS' | 'MODIFY_IDENTIFIER' | 'SET_IDENTIFIER' | 'UNIT_PANIC' | 'UNIT_STATUS' | 'GET_BLIPS' | 'ADD_BLIP' | 'MODIFY_BLIP' | 'REMOVE_BLIP' | '911_CALL' | 'REMOVE_911' | 'GET_CALLS' | 'GET_ACTIVE_UNITS' | 'KICK_UNIT' | 'NEW_DISPATCH' | 'ATTACH_UNIT' | 'DETACH_UNIT' | 'SET_CALL_POSTAL' | 'SET_CALL_PRIMARY' | 'ADD_CALL_NOTE' | 'CLOSE_CALL' | 'UNIT_LOCATION' | 'SET_STREETSIGN_CONFIG' | 'UPDATE_STREETSIGN' | 'GET_COM_ACCOUNT' | 'GET_DEPARTMENTS' | 'GET_SUB_VERSION' | 'GET_CURRENT_CLOCK_IN' | 'GET_ACCOUNTS' | 'GET_PROFILE_FIELDS' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE' | 'GET_FORM_TEMPLATE_SUBMISSIONS' | 'KICK_ACCOUNT' | 'BAN_ACCOUNT' | 'LOOKUP' | 'EDIT_ACC_PROFLIE_FIELDS' | 'SET_ACCOUNT_NAME' | 'FORCE_SYNC' | 'TRIGGER_PROMOTION_FLOWS' | 'GET_PROMOTION_FLOWS' | 'SET_GAME_SERVERS' | 'ERLC_GET_ONLINE_PLAYERS' | 'ERLC_GET_PLAYER_QUEUE' | 'ERLC_ADD_NEW_RECORD' | 'RADIO_GET_COMMUNITY_CHANNELS' | 'RADIO_GET_CONNECTED_USERS' | 'RADIO_GET_CONNECTED_USER' | 'RADIO_SET_USER_CHANNELS' | 'RADIO_SET_USER_DISPLAY_NAME' | 'RADIO_GET_SERVER_SUBSCRIPTION_FROM_IP' | 'RADIO_SET_SERVER_IP' | 'RADIO_SET_IN_GAME_SPEAKER_LOCATIONS';
+export type AllAPITypesType = 'GET_SERVERS' | 'SET_SERVERS' | 'GET_VERSION' | 'SET_PENAL_CODES' | 'SET_API_ID' | 'GET_TEMPLATES' | 'NEW_RECORD' | 'EDIT_RECORD' | 'REMOVE_RECORD' | 'LOOKUP_INT' | 'LOOKUP' | 'GET_ACCOUNT' | 'CHECK_APIID' | 'APPLY_PERMISSION_KEY' | 'SET_ACCOUNT_PERMISSIONS' | 'BAN_USER' | 'VERIFY_SECRET' | 'AUTH_STREETSIGNS' | 'SET_POSTALS' | 'SEND_PHOTO' | 'SET_CLOCK' | 'JOIN_COMMUNITY' | 'LEAVE_COMMUNITY' | 'GET_CHARACTERS' | 'NEW_CHARACTER' | 'EDIT_CHARACTER' | 'REMOVE_CHARACTER' | 'GET_IDENTIFIERS' | 'MODIFY_IDENTIFIER' | 'SET_IDENTIFIER' | 'UNIT_PANIC' | 'UNIT_STATUS' | 'GET_BLIPS' | 'ADD_BLIP' | 'MODIFY_BLIP' | 'REMOVE_BLIP' | '911_CALL' | 'REMOVE_911' | 'GET_CALLS' | 'GET_ACTIVE_UNITS' | 'KICK_UNIT' | 'NEW_DISPATCH' | 'ATTACH_UNIT' | 'DETACH_UNIT' | 'SET_CALL_POSTAL' | 'SET_CALL_PRIMARY' | 'ADD_CALL_NOTE' | 'CLOSE_CALL' | 'UNIT_LOCATION' | 'SET_STREETSIGN_CONFIG' | 'UPDATE_STREETSIGN' | 'GET_COM_ACCOUNT' | 'GET_DEPARTMENTS' | 'GET_SUB_VERSION' | 'GET_CURRENT_CLOCK_IN' | 'GET_ACCOUNTS' | 'GET_PROFILE_FIELDS' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE' | 'GET_FORM_TEMPLATE_SUBMISSIONS' | 'KICK_ACCOUNT' | 'BAN_ACCOUNT' | 'LOOKUP' | 'EDIT_ACC_PROFLIE_FIELDS' | 'SET_ACCOUNT_NAME' | 'FORCE_SYNC' | 'TRIGGER_PROMOTION_FLOWS' | 'GET_PROMOTION_FLOWS' | 'SET_GAME_SERVERS' | 'ERLC_GET_ONLINE_PLAYERS' | 'ERLC_GET_PLAYER_QUEUE' | 'ERLC_ADD_NEW_RECORD' | 'ERLC_EXECUTE_COMMAND' | 'RADIO_GET_COMMUNITY_CHANNELS' | 'RADIO_GET_CONNECTED_USERS' | 'RADIO_GET_CONNECTED_USER' | 'RADIO_SET_USER_CHANNELS' | 'RADIO_SET_USER_DISPLAY_NAME' | 'RADIO_GET_SERVER_SUBSCRIPTION_FROM_IP' | 'RADIO_SET_SERVER_IP' | 'RADIO_SET_IN_GAME_SPEAKER_LOCATIONS' | 'PLAY_TONE';
 
 export interface CMSServerAPIStruct {
 	id: number;
@@ -1164,6 +1176,9 @@ export interface RESTTypedAPIDataStructs {
 		playerRobloxId?: string | number,
 		points?: number,
 	]
+	ERLC_EXECUTE_COMMAND: [
+		commands: CMSERLCExecuteCommandPayload[]
+	]
 	// Radio
 	RADIO_GET_COMMUNITY_CHANNELS: [];
 	RADIO_GET_CONNECTED_USERS: [];
@@ -1187,6 +1202,11 @@ export interface RESTTypedAPIDataStructs {
 		locations: RadioSpeakerLocation[],
 		token?: string
 	];
+	PLAY_TONE: [
+		roomId: number,
+		tones: number[],
+		playTo: RadioTonePlayTarget[]
+	];
 }
 
 export type PossibleRequestData =

package/src/managers/CMSManager.ts

@@ -562,6 +562,28 @@ export class CMSManager extends BaseManager {
     });
   }
 
+  /**
+   * Sends an ERLC command payload to CMS.
+   */
+  public async erlcExecuteCommand(commands: globalTypes.CMSERLCExecuteCommandPayload[]): Promise<globalTypes.CMSERLCExecuteCommandPromiseResult> {
+    if (!Array.isArray(commands) || commands.length === 0) {
+      throw new Error('ERLC execute command requires at least one command payload.');
+    }
+
+    return new Promise(async (resolve, reject) => {
+      try {
+        const erlcExecuteCommandRequest: any = await this.rest?.request('ERLC_EXECUTE_COMMAND', commands);
+        resolve({ success: true, data: erlcExecuteCommandRequest });
+      } catch (err) {
+        if (err instanceof APIError) {
+          resolve({ success: false, reason: err.response });
+        } else {
+          reject(err);
+        }
+      }
+    });
+  }
+
   /**
    * Adds a new ERLC record for a player.
    * @param {Object} data The object that contains critical data to add a new ERLC record.

package/src/managers/RadioManager.ts

@@ -184,4 +184,25 @@ export class RadioManager extends BaseManager {
       }
     });
   }
+
+  /**
+   * Plays one or more tones to radio channels, groups, or in-game speakers.
+   * @param {number} roomId Multi-server room id for tone playback.
+   * @param {number[]} tones Tone identifiers to play.
+   * @param {globalTypes.RadioTonePlayTarget[]} playTo Targets that should receive the tones.
+   */
+  public async playTone(roomId: number, tones: number[], playTo: globalTypes.RadioTonePlayTarget[]): Promise<globalTypes.RadioPlayTonePromiseResult> {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const response: any = await this.rest?.request('PLAY_TONE', roomId, tones, playTo);
+        resolve({ success: true, result: response?.result ?? response });
+      } catch (err) {
+        if (err instanceof APIError) {
+          resolve({ success: false, reason: err.response });
+        } else {
+          reject(err);
+        }
+      }
+    });
+  }
 }