@sonoransoftware/sonoran.js 1.0.34 → 1.0.36

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,37 @@ 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 CADStandardResponse<T = unknown> {
+	success: boolean;
+	data?: T;
+	reason?: unknown;
+}
+
+export interface CMSProfileField {
+	id: string;
+	type: string;
+	label: string;
+	options: unknown;
+}
+
 export interface CMSKickAccountPromiseResult {
 	success: boolean;
 	reason?: string;
@@ -267,6 +299,127 @@ 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 CMSChangeFormStagePromiseResult {
+	success: boolean;
+	reason?: 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 CMSExecuteRankPromotionResult {
+	users: string[];
+	flow: string;
+	promote: boolean;
+	succeeded: boolean;
+	message?: string;
+}
+
+export interface CMSTriggerPromotionFlowPayload {
+	userId: string;
+	flowId: string;
+	users: string[];
+	promote: boolean;
+}
+
+export interface CMSPromotionFlow {
+	id: string;
+	communityUuid: string;
+	labelFrom: string;
+	labelTo: string;
+	ranksToAdd: string[];
+	ranksToRemove: string[];
+	actions: unknown[];
+}
+
+export interface CMSTriggerPromotionFlowsPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: CMSExecuteRankPromotionResult[];
+}
+
+export interface CMSGetPromotionFlowsPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: CMSPromotionFlow[];
+}
+
+export interface CMSGetFormSubmissionsPromiseResult<T = unknown> {
+	success: boolean;
+	reason?: string;
+	data?: T[];
+}
+
 export interface CMSERLCGetOnlinePlayersPromiseResult {
 	success: boolean;
 	reason?: string;
@@ -289,3 +442,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,45 @@
 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,
+  CADStandardResponse,
+  CMSProfileField,
+  CMSGetCurrentClockInPromiseResult,
+  CMSAccountsPage,
+  CMSAccountSummary,
+  CMSGetAccountsPromiseResult,
+  CMSGetProfileFieldsPromiseResult,
+  CMSProfileFieldUpdate,
+  CMSEditAccountProfileFieldsPromiseResult,
+  CMSRsvpPromiseResult,
+  CMSChangeFormStagePromiseResult,
+  CMSSetGameServerStruct,
+  CMSSetGameServersPromiseResult,
+  CMSExecuteRankPromotionResult,
+  CMSTriggerPromotionFlowPayload,
+  CMSPromotionFlow,
+  CMSTriggerPromotionFlowsPromiseResult,
+  CMSGetPromotionFlowsPromiseResult,
+  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 ;
-};
+};

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

@@ -14,6 +14,7 @@ import type { RequestInit, Response } from 'node-fetch';
 import { Instance } from '../../../../instance/Instance';
 import { CADManager } from '../../../../managers/CADManager';
 import { CMSManager } from '../../../../managers/CMSManager';
+import { RadioManager } from '../../../../managers/RadioManager';
 
 /**
  * Options to be passed when creating the REST instance
@@ -106,7 +107,7 @@ export interface REST {
 		(<S extends string | symbol>(event?: Exclude<S, keyof RestEvents>) => this);
 }
 
-export type RestManagerTypes = CADManager | CMSManager;
+export type RestManagerTypes = CADManager | CMSManager | RadioManager;
 
 export class REST extends EventEmitter {
 	public readonly requestManager: RequestManager;
@@ -150,6 +151,11 @@ export class REST extends EventEmitter {
 				apiKey = this.instance.cmsApiKey;
 				break;
 			}
+			case productEnums.RADIO: {
+				communityId = this.instance.radioCommunityId;
+				apiKey = this.instance.radioApiKey;
+				break;
+			}
 		}
 		if (!communityId || !apiKey) throw new Error(`Community ID or API Key could not be found for request. P${apiType.product}`);
 		// if (apiType.minVersion > this.manager.version) throw new Error(`[${type}] Subscription version too low for this API type request. Current Version: ${convertSubNumToName(this.manager.version)} Needed Version: ${convertSubNumToName(apiType.minVersion)}`);  // Verifies API Subscription Level Requirement which is deprecated currently
@@ -179,6 +185,9 @@ export class REST extends EventEmitter {
 					serverId: args[0]
 				}
 			}
+			case 'SET_GAME_SERVERS': {
+				return args[0] ?? [];
+			}
 			case 'RSVP': {
 				return {
 					eventId: args[0],
@@ -206,6 +215,62 @@ export class REST extends EventEmitter {
 					uniqueId: args[4]
 				};
 			}
+			case 'GET_CURRENT_CLOCK_IN': {
+				return {
+					apiId: args[0],
+					username: args[1],
+					accId: args[2],
+					discord: args[3],
+					uniqueId: args[4]
+				};
+			}
+			case 'GET_ACCOUNTS': {
+				return args[0] ?? {};
+			}
+			case 'GET_PROFILE_FIELDS': {
+				return {};
+			}
+			case 'SET_CLOCK': {
+				if (args[0] && typeof args[0] === 'object' && !Array.isArray(args[0])) {
+					return args[0];
+				}
+				return {
+					serverId: args[0],
+					currentUtc: args[1],
+					currentGame: args[2],
+					secondsPerHour: args[3]
+				};
+			}
+			case 'JOIN_COMMUNITY':
+			case 'LEAVE_COMMUNITY': {
+				const payload = args[0] && typeof args[0] === 'object' && !Array.isArray(args[0]) && 'internalKey' in args[0]
+					? args[0]
+					: null;
+				const internalKey = payload ? payload.internalKey : args[0];
+				const accountsInput = payload ? payload.accounts : args[1];
+				let accounts: Array<{ account: string }> = [];
+				if (Array.isArray(accountsInput)) {
+					accounts = accountsInput.map((entry) => {
+						if (typeof entry === 'string') {
+							return { account: entry };
+						}
+						if (entry && typeof entry === 'object' && 'account' in entry) {
+							return entry as { account: string };
+						}
+						return { account: String(entry) };
+					});
+				} else if (accountsInput) {
+					if (typeof accountsInput === 'string') {
+						accounts = [{ account: accountsInput }];
+					} else if (typeof accountsInput === 'object' && 'account' in accountsInput) {
+						accounts = [accountsInput as { account: string }];
+					}
+				}
+				return {
+					internalKey,
+					accounts
+				};
+			}
 			case 'CLOCK_IN_OUT': {
 				return {
 					apiId: args[0],
@@ -237,6 +302,13 @@ export class REST extends EventEmitter {
 					secret: args[0],
 				};
 			}
+			case 'GET_FORM_TEMPLATE_SUBMISSIONS': {
+				return {
+					templateId: args[0],
+					skip: args[1],
+					take: args[2],
+				};
+			}
 			case 'CHANGE_FORM_STAGE': {
 				return {
 					accId: args[0],
@@ -301,6 +373,16 @@ export class REST extends EventEmitter {
 					uniqueId: args[4],
 				}
 			}
+			case 'TRIGGER_PROMOTION_FLOWS': {
+				const payload = args[0];
+				if (!Array.isArray(payload)) {
+					throw new Error('TRIGGER_PROMOTION_FLOWS requires an array of promotion flow payloads.');
+				}
+				return payload;
+			}
+			case 'GET_PROMOTION_FLOWS': {
+				return [];
+			}
 			case 'ERLC_GET_ONLINE_PLAYERS': {
 				return {
 					robloxJoinCode: args[0]
@@ -322,6 +404,40 @@ export class REST extends EventEmitter {
 					points: args[6],
 				}
 			}
+			case 'RADIO_GET_COMMUNITY_CHANNELS':
+			case 'RADIO_GET_CONNECTED_USERS':
+			case 'RADIO_GET_SERVER_SUBSCRIPTION_FROM_IP': {
+				return undefined;
+			}
+			case 'RADIO_GET_CONNECTED_USER': {
+				return {
+					roomId: args[0],
+					identity: args[1]
+				}
+			}
+			case 'RADIO_SET_USER_CHANNELS': {
+				return {
+					identity: args[0],
+					options: args[1] ?? {}
+				}
+			}
+			case 'RADIO_SET_USER_DISPLAY_NAME': {
+				return {
+					accId: args[0],
+					displayName: args[1]
+				}
+			}
+			case 'RADIO_SET_SERVER_IP': {
+				return {
+					pushUrl: args[0]
+				}
+			}
+			case 'RADIO_SET_IN_GAME_SPEAKER_LOCATIONS': {
+				return {
+					locations: args[0],
+					token: args[1]
+				}
+			}
 			default: {
 				return args;
 			}