@sonoransoftware/sonoran.js 1.0.34 → 1.0.35

package/package.json

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

@@ -64,6 +64,36 @@ const params = {
 const account = await instance.cad.getAccount(params);
 ```
 
+### setClockTime
+Synchronizes the CAD clock with your in-game time.
+#### Argument `params`
+##### Type: `object` `{ serverId: number, currentUtc: string, currentGame: string, secondsPerHour: number }`
+```js
+await instance.cad.setClockTime({
+  serverId: 1,
+  currentUtc: new Date().toISOString(),
+  currentGame: '2025-07-04T18:00:00Z',
+  secondsPerHour: 60
+});
+```
+
+### joinCommunity
+Adds one or more accounts to the community using an internal key.
+```js
+await instance.cad.joinCommunity('internal-key', [
+  { account: '1234567890' },
+  '0987654321'
+]);
+```
+
+### leaveCommunity
+Removes one or more accounts from the community using an internal key.
+```js
+await instance.cad.leaveCommunity('internal-key', [
+  { account: '1234567890' }
+]);
+```
+
 ## CMS Functions
 ### verifyWhitelist(obj)
 Verifies that a user is whitelisted in the specified server.
@@ -176,5 +206,145 @@ const params = {
 const setRanks = await instance.cms.setAccountRanks(params, undefined, undefined, undefined, '12345678', undefined);
 ```
 
+### setAccountName(apiId, username, accId, discord, uniqueId, newName)
+Sets the display name used in CMS for an account.
+```js
+await instance.cms.setAccountName(undefined, undefined, 'account-uuid', undefined, undefined, 'New Display Name');
+```
+
+### cmsBanAccount(params)
+Adds a ban flag to the targeted account.
+```js
+await instance.cms.cmsBanAccount({ apiId: '1234' });
+```
+
+### cmsKickAccount(params)
+Performs a CMS kick request for the targeted account.
+```js
+await instance.cms.cmsKickAccount({ discord: '1234567890' });
+```
+
+### forceSync(params)
+Manually triggers a CMS force-sync for the targeted identifiers.
+```js
+await instance.cms.forceSync({ username: 'SomeUser' });
+```
+
+### getCurrentClockIn(params)
+Fetches the current clock-in entry for the account if one exists.
+```js
+const currentEntry = await instance.cms.getCurrentClockIn({ apiId: '1234' });
+```
+
+### getAccounts(options)
+Retrieves CMS accounts with optional pagination and status filters.
+```js
+const accounts = await instance.cms.getAccounts({ take: 50, banned: false });
+```
+
+### getProfileFields()
+Returns profile field definitions configured for the community.
+```js
+const profileFields = await instance.cms.getProfileFields();
+```
+
+### rsvp(eventId, params)
+Toggles RSVP for an event for the provided account identifiers.
+```js
+await instance.cms.rsvp('event-id', { accId: 'account-uuid' });
+```
+
+### getFormSubmissions(templateId, options)
+Retrieves form submissions with optional pagination.
+```js
+const submissions = await instance.cms.getFormSubmissions(42, { skip: 0, take: 25 });
+```
+
+### editAccountProfileFields(params)
+Updates profile fields for an account.
+```js
+await instance.cms.editAccountProfileFields({
+  accId: 'account-uuid',
+  profileFields: [
+    { fieldId: 10, value: 'Value' }
+  ]
+});
+```
+
+### erlcGetOnlinePlayers(robloxJoinCode)
+Returns the current ERLC player list for the join code.
+```js
+const players = await instance.cms.erlcGetOnlinePlayers('join-code');
+```
+
+### erlcGetPlayerQueue(robloxJoinCode)
+Returns the current ERLC player queue count for the join code.
+```js
+const queue = await instance.cms.erlcGetPlayerQueue('join-code');
+```
+
+### erlcAddNewRecord(data)
+Adds a moderation record for a player in ERLC.
+```js
+await instance.cms.erlcAddNewRecord({
+  robloxJoinCode: 'join-code',
+  executerDiscordId: '1234567890',
+  type: 'Warning',
+  reason: 'Reckless driving'
+});
+```
+
+## Radio Functions
+### getCommunityChannels()
+Retrieves configured community channel groups and channels.
+```js
+const channels = await instance.radio.getCommunityChannels();
+```
+
+### getConnectedUsers()
+Lists all connected radio users in the community.
+```js
+const users = await instance.radio.getConnectedUsers();
+```
+
+### getConnectedUser(roomId, identity)
+Fetches a specific connected radio user by room and identity.
+```js
+const user = await instance.radio.getConnectedUser(1, 'account-uuid');
+```
+
+### setUserChannels(identity, options)
+Updates a user's transmit or scan channels.
+```js
+await instance.radio.setUserChannels('account-uuid', { transmit: 12, scan: [10, 11, 12] });
+```
+
+### setUserDisplayName(accId, displayName)
+Sets the user's radio display name.
+```js
+await instance.radio.setUserDisplayName('account-uuid', 'Dispatch 101');
+```
+
+### getServerSubscriptionFromIp()
+Resolves the community's subscription level for the calling server IP.
+```js
+const subscription = await instance.radio.getServerSubscriptionFromIp();
+```
+
+### setServerIp(pushUrl)
+Registers the push event URL for radio webhooks.
+```js
+await instance.radio.setServerIp('https://example.com/sonoran-radio');
+```
+
+### setInGameSpeakerLocations(locations, token?)
+Publishes available in-game speaker locations for tone routing.
+```js
+await instance.radio.setInGameSpeakerLocations(
+  [{ name: 'Station 1', x: 123.4, y: 567.8, z: 90.1 }],
+  'optional-bearer-token'
+);
+```
+
 ## 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

@@ -6,7 +6,8 @@ import { CADActiveUnit } from './structures/CADActiveUnit';
 
 export enum productEnums {
   CAD,
-  CMS
+  CMS,
+  RADIO
 }
 
 export interface CADNewDispatchBuilderOptions {
@@ -252,6 +253,31 @@ export interface CMSSetAccountNamePromiseResult {
 	reason?: string;
 }
 
+export interface CADSetClockTimePromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: unknown;
+}
+
+export interface CADJoinCommunityPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: unknown;
+}
+
+export interface CADLeaveCommunityPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: unknown;
+}
+
+export interface CMSProfileField {
+	id: string;
+	type: string;
+	label: string;
+	options: unknown;
+}
+
 export interface CMSKickAccountPromiseResult {
 	success: boolean;
 	reason?: string;
@@ -267,6 +293,84 @@ export interface CMSForceSyncPromiseResult {
 	reason?: string;
 }
 
+export interface CMSGetCurrentClockInPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: clockInOutRequest | null;
+}
+
+export interface CMSAccountSummary {
+	accId: string;
+	accName: string;
+	activeApiIds: string[];
+	discordId?: string;
+	sysStatus: boolean;
+	comStatus: boolean;
+	archived: boolean;
+	banned: boolean;
+	[key: string]: unknown;
+}
+
+export interface CMSAccountsPage {
+	total: number;
+	skip: number;
+	take: number;
+	accounts: CMSAccountSummary[];
+}
+
+export interface CMSGetAccountsPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: CMSAccountsPage;
+}
+
+export interface CMSGetProfileFieldsPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: CMSProfileField[];
+}
+
+export interface CMSProfileFieldUpdate {
+	id: string;
+	value: unknown;
+}
+
+export interface CMSEditAccountProfileFieldsPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: CMSProfileFieldUpdate[];
+}
+
+export interface CMSRsvpPromiseResult {
+	success: boolean;
+	reason?: string;
+	status?: string;
+	data?: unknown;
+}
+
+export interface CMSSetGameServerStruct {
+	id?: number;
+	name: string;
+	description?: string;
+	ip?: string;
+	port?: string;
+	allowedRanks?: string[];
+	blockedRanks?: string[];
+	[key: string]: unknown;
+}
+
+export interface CMSSetGameServersPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: CMSSetGameServerStruct[];
+}
+
+export interface CMSGetFormSubmissionsPromiseResult<T = unknown> {
+	success: boolean;
+	reason?: string;
+	data?: T[];
+}
+
 export interface CMSERLCGetOnlinePlayersPromiseResult {
 	success: boolean;
 	reason?: string;
@@ -289,3 +393,130 @@ export interface CMSERLCAddNewRecordPromiseResult {
 	reason?: string;
 	logId?: string;
 }
+
+export interface RadioChannelGroup {
+	id: number;
+	name: string;
+	orderIndex: number;
+}
+
+export interface RadioChannel {
+	id: number;
+	groupId: number;
+	displayName: string;
+	recvFreqMajor: number;
+	recvFreqMinor: number;
+	xmitFreqMajor: number;
+	xmitFreqMinor: number;
+	repeatsXmit: boolean;
+	status: boolean;
+	orderIndex: number;
+	talkoverProtection: boolean;
+	[key: string]: unknown;
+}
+
+export interface RadioConnectedUserMetadataScanList {
+	id: number;
+	name: string;
+	channelIds: number[];
+	[key: string]: unknown;
+}
+
+export interface RadioConnectedUserMetadataState {
+	primaryChId?: number;
+	scannedChIds?: number[];
+	scanLists?: RadioConnectedUserMetadataScanList[];
+	spec?: number;
+	[key: string]: unknown;
+}
+
+export interface RadioConnectedUserMetadata {
+	sonrad?: boolean;
+	state?: RadioConnectedUserMetadataState;
+	[key: string]: unknown;
+}
+
+export interface RadioConnectedUser {
+	identity: string;
+	name: string;
+	roomId?: number;
+	metadata: RadioConnectedUserMetadata;
+	[key: string]: unknown;
+}
+
+export interface RadioSpeakerLocation {
+	label: string;
+	id: string;
+}
+
+export interface RadioSetUserChannelsOptions {
+	transmit?: number;
+	scan?: number[];
+}
+
+export type RadioSubscriptionLevel = 0 | 1 | 2;
+
+export interface RadioGetCommunityChannelsPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: {
+		result: string;
+		groups: RadioChannelGroup[];
+		channels: RadioChannel[];
+		[key: string]: unknown;
+	};
+}
+
+export interface RadioGetConnectedUsersPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: {
+		result: string;
+		connectedUsers: RadioConnectedUser[];
+		[key: string]: unknown;
+	};
+}
+
+export interface RadioGetConnectedUserPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: {
+		result: string;
+		data: RadioConnectedUser;
+		[key: string]: unknown;
+	};
+}
+
+export interface RadioSetUserChannelsPromiseResult {
+	success: boolean;
+	reason?: string;
+	result?: string;
+}
+
+export interface RadioSetUserDisplayNamePromiseResult {
+	success: boolean;
+	reason?: string;
+	result?: string;
+}
+
+export interface RadioGetServerSubscriptionFromIpPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: {
+		result: string;
+		subscription: RadioSubscriptionLevel;
+		[key: string]: unknown;
+	};
+}
+
+export interface RadioSetServerIpPromiseResult {
+	success: boolean;
+	reason?: string;
+	result?: string;
+}
+
+export interface RadioSetInGameSpeakerLocationsPromiseResult {
+	success: boolean;
+	reason?: string;
+	result?: string;
+}

package/src/index.ts

@@ -1,4 +1,38 @@
 export * from './instance/Instance';
 export * from './builders';
 export * from './libs/rest/src';
-export { productEnums, CADNewDispatchBuilderOptions, CADSubscriptionVersionEnum, CMSSubscriptionVersionEnum } from './constants';
+export {
+  productEnums,
+  CADNewDispatchBuilderOptions,
+  CADSubscriptionVersionEnum,
+  CMSSubscriptionVersionEnum,
+  RadioSubscriptionLevel,
+  RadioSetUserChannelsOptions,
+  RadioChannel,
+  RadioChannelGroup,
+  RadioConnectedUser,
+  RadioSpeakerLocation,
+  RadioGetCommunityChannelsPromiseResult,
+  RadioGetConnectedUsersPromiseResult,
+  RadioGetConnectedUserPromiseResult,
+  RadioSetUserChannelsPromiseResult,
+  RadioSetUserDisplayNamePromiseResult,
+  RadioGetServerSubscriptionFromIpPromiseResult,
+  RadioSetServerIpPromiseResult,
+  RadioSetInGameSpeakerLocationsPromiseResult,
+  CADSetClockTimePromiseResult,
+  CADJoinCommunityPromiseResult,
+  CADLeaveCommunityPromiseResult,
+  CMSProfileField,
+  CMSGetCurrentClockInPromiseResult,
+  CMSAccountsPage,
+  CMSAccountSummary,
+  CMSGetAccountsPromiseResult,
+  CMSGetProfileFieldsPromiseResult,
+  CMSProfileFieldUpdate,
+  CMSEditAccountProfileFieldsPromiseResult,
+  CMSRsvpPromiseResult,
+  CMSSetGameServerStruct,
+  CMSSetGameServersPromiseResult,
+  CMSGetFormSubmissionsPromiseResult
+} from './constants';

package/src/instance/Instance.ts

@@ -4,6 +4,7 @@ import * as globalTypes from '../constants';
 import * as InstanceTypes from './instance.types';
 import { CADManager } from '../managers/CADManager';
 import { CMSManager } from '../managers/CMSManager';
+import { RadioManager } from '../managers/RadioManager';
 import { debugLog } from '../utils';
 
 export class Instance extends EventEmitter {
@@ -17,9 +18,14 @@ export class Instance extends EventEmitter {
   public cmsApiUrl: string = 'https://api.sonorancms.com';
   public cmsDefaultServerId: number = 1;
   public isCMSSuccessful: boolean = false;
+  public radioCommunityId: string | undefined;
+  public radioApiKey: string | undefined;
+  public radioApiUrl: string = 'https://api.sonoranradio.com';
+  public isRadioSuccessful: boolean = false;
 
   public cad: CADManager | undefined;
   public cms: CMSManager | undefined;
+  public radio: RadioManager | undefined;
 
   public debug: boolean = false;
   public apiHeaders: HeadersInit = {};
@@ -64,6 +70,17 @@ export class Instance extends EventEmitter {
             this.initialize();
             break;
           }
+          case globalTypes.productEnums.RADIO: {
+            this.radioCommunityId = options.communityId;
+            this.radioApiKey = options.apiKey;
+            if (Object.prototype.hasOwnProperty.call(options, 'radioApiUrl') && typeof options.radioApiUrl === 'string') {
+              this._debugLog(`Overriding Radio API URL... ${options.radioApiUrl}`);
+              this.radioApiUrl = options.radioApiUrl;
+            }
+            this._debugLog('About to initialize instance.');
+            this.initialize();
+            break;
+          }
           default: {
             throw new Error('Invalid product enum given for constructor.');
           }
@@ -76,6 +93,8 @@ export class Instance extends EventEmitter {
       this.cadApiKey = options.cadApiKey;
       this.cmsCommunityId = options.cmsCommunityId;
       this.cmsApiKey = options.cmsApiKey;
+      this.radioCommunityId = options.radioCommunityId;
+      this.radioApiKey = options.radioApiKey;
 
       if (options.cadDefaultServerId !== undefined) {
         this._debugLog(`Overriding default CAD server id... ${options.serverId}`);
@@ -93,6 +112,10 @@ export class Instance extends EventEmitter {
         this._debugLog(`Overriding CMS API URL... ${options.cmsApiUrl}`);
         this.cmsApiUrl = options.cmsApiUrl;
       }
+      if (Object.prototype.hasOwnProperty.call(options, 'radioApiUrl') && typeof options.radioApiUrl === 'string') {
+        this._debugLog(`Overriding Radio API URL... ${options.radioApiUrl}`);
+        this.radioApiUrl = options.radioApiUrl;
+      }
       this.initialize();
     }
   }
@@ -112,6 +135,12 @@ export class Instance extends EventEmitter {
     } else {
       this._debugLog('Not initializing CMS Manager due to a missing community id, api key, or api url.');
     }
+    if (this.radioCommunityId && this.radioApiKey && this.radioApiUrl) {
+      this._debugLog('About to initialize Radio Manager');
+      this.radio = new RadioManager(this);
+    } else {
+      this._debugLog('Not initializing Radio Manager due to a missing community id, api key, or api url.');
+    }
   }
 
   public _debugLog(message: string): void {
@@ -119,4 +148,4 @@ export class Instance extends EventEmitter {
       debugLog(message);
     }
   }
-}
+}

package/src/instance/instance.types.ts

@@ -13,6 +13,9 @@ export type InstanceOptions = {
   cmsApiKey?: string;
   cmsApiUrl?: string;
   cmsDefaultServerId?: number;
+  radioCommunityId?: string;
+  radioApiKey?: string;
+  radioApiUrl?: string;
   debug?: boolean;
   apiHeaders?: HeadersInit ;
-};
+};