@sonoransoftware/sonoran.js 1.0.33 → 1.0.34

package/dist/constants.d.ts

@@ -253,6 +253,11 @@ export interface CMSERLCGetOnlinePlayersPromiseResult {
         Team?: string;
     }[];
 }
+export interface CMSERLCGetPlayerQueuePromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: number;
+}
 export interface CMSERLCAddNewRecordPromiseResult {
     success: boolean;
     reason?: string;

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

@@ -200,6 +200,11 @@ class REST extends events_1.EventEmitter {
                     robloxJoinCode: args[0]
                 };
             }
+            case 'ERLC_GET_PLAYER_QUEUE': {
+                return {
+                    robloxJoinCode: args[0]
+                };
+            }
             case 'ERLC_ADD_NEW_RECORD': {
                 return {
                     robloxJoinCode: args[0],

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

@@ -36,7 +36,7 @@ export declare const FormsCMSAPITypes: APITypeData[];
 export declare const CommunitiesCMSAPITypes: APITypeData[];
 export declare const ERLCMSAPITypes: 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' | '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' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE' | 'KICK_ACCOUNT' | 'BAN_ACCOUNT' | 'LOOKUP' | 'EDIT_ACC_PROFLIE_FIELDS' | 'SET_ACCOUNT_NAME' | 'FORCE_SYNC' | "ERLC_GET_ONLINE_PLAYERS" | "ERLC_ADD_NEW_RECORD";
+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' | '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' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE' | 'KICK_ACCOUNT' | 'BAN_ACCOUNT' | 'LOOKUP' | 'EDIT_ACC_PROFLIE_FIELDS' | 'SET_ACCOUNT_NAME' | 'FORCE_SYNC' | "ERLC_GET_ONLINE_PLAYERS" | "ERLC_GET_PLAYER_QUEUE" | "ERLC_ADD_NEW_RECORD";
 export interface CMSServerAPIStruct {
     id: number;
     name: string;
@@ -493,6 +493,9 @@ export interface RESTTypedAPIDataStructs {
     ERLC_GET_ONLINE_PLAYERS: [
         robloxJoinCode: string
     ];
+    ERLC_GET_PLAYER_QUEUE: [
+        robloxJoinCode: string
+    ];
     ERLC_ADD_NEW_RECORD: [
         robloxJoinCode: string,
         executerDiscordId: string | number,

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

@@ -434,6 +434,12 @@ exports.ERLCMSAPITypes = [
         method: "POST",
         minVersion: 0
     },
+    {
+        type: "ERLC_GET_PLAYER_QUEUE",
+        path: "erlc/get_player_queue",
+        method: "POST",
+        minVersion: 0
+    },
     {
         type: "ERLC_ADD_NEW_RECORD",
         path: "erlc/add_new_record",

package/dist/managers/CMSManager.d.ts

@@ -176,6 +176,12 @@ export declare class CMSManager extends BaseManager {
      * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed and the list of online players if successful.
      */
     erlcGetOnlinePlayers(robloxJoinCode: string): Promise<globalTypes.CMSERLCGetOnlinePlayersPromiseResult>;
+    /**
+     * Gets the current ERLC player queue count for the provided roblox join code.
+     * @param {string} robloxJoinCode The roblox join code to get the player queue size for.
+     * @returns {Promise} Promise object indicates success and includes the queue count when successful.
+     */
+    erlcGetPlayerQueue(robloxJoinCode: string): Promise<globalTypes.CMSERLCGetPlayerQueuePromiseResult>;
     /**
      * 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

@@ -395,6 +395,28 @@ class CMSManager extends BaseManager_1.BaseManager {
             }
         });
     }
+    /**
+     * Gets the current ERLC player queue count for the provided roblox join code.
+     * @param {string} robloxJoinCode The roblox join code to get the player queue size for.
+     * @returns {Promise} Promise object indicates success and includes the queue count when successful.
+     */
+    async erlcGetPlayerQueue(robloxJoinCode) {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const erlcGetPlayerQueueRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('ERLC_GET_PLAYER_QUEUE', robloxJoinCode));
+                resolve({ success: true, data: erlcGetPlayerQueueRequest });
+            }
+            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/package.json

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

@@ -278,8 +278,14 @@ export interface CMSERLCGetOnlinePlayersPromiseResult {
 	}[];
 }
 
+export interface CMSERLCGetPlayerQueuePromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: number;
+}
+
 export interface CMSERLCAddNewRecordPromiseResult {
 	success: boolean;
 	reason?: string;
 	logId?: string;
-}
+}

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

@@ -306,6 +306,11 @@ export class REST extends EventEmitter {
 					robloxJoinCode: args[0]
 				}
 			}
+			case 'ERLC_GET_PLAYER_QUEUE': {
+				return {
+					robloxJoinCode: args[0]
+				}
+			}
 			case 'ERLC_ADD_NEW_RECORD': {
 				return {
 					robloxJoinCode: args[0],

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

@@ -470,6 +470,12 @@ export const ERLCMSAPITypes: APITypeData[] = [
 		method: "POST",
 		minVersion: 0
 	},
+	{
+		type: "ERLC_GET_PLAYER_QUEUE",
+		path: "erlc/get_player_queue",
+		method: "POST",
+		minVersion: 0
+	},
 	{
 		type: "ERLC_ADD_NEW_RECORD",
 		path: "erlc/add_new_record",
@@ -489,7 +495,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) ];
 
-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' | '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' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE' | 'KICK_ACCOUNT' | 'BAN_ACCOUNT' | 'LOOKUP' | 'EDIT_ACC_PROFLIE_FIELDS' | 'SET_ACCOUNT_NAME' | 'FORCE_SYNC' | "ERLC_GET_ONLINE_PLAYERS" | "ERLC_ADD_NEW_RECORD";
+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' | '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' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS' | 'RSVP' | 'CHANGE_FORM_STAGE' | 'KICK_ACCOUNT' | 'BAN_ACCOUNT' | 'LOOKUP' | 'EDIT_ACC_PROFLIE_FIELDS' | 'SET_ACCOUNT_NAME' | 'FORCE_SYNC' | "ERLC_GET_ONLINE_PLAYERS" | "ERLC_GET_PLAYER_QUEUE" | "ERLC_ADD_NEW_RECORD";
 
 export interface CMSServerAPIStruct {
 	id: number;
@@ -984,6 +990,9 @@ export interface RESTTypedAPIDataStructs {
 	ERLC_GET_ONLINE_PLAYERS: [
 		robloxJoinCode: string
 	]
+	ERLC_GET_PLAYER_QUEUE: [
+		robloxJoinCode: string
+	]
 	ERLC_ADD_NEW_RECORD: [
 		robloxJoinCode: string,
 		executerDiscordId: string | number,
@@ -1120,4 +1129,4 @@ export type PossibleRequestData =
 		},
 		add?: string[],
 		remove?: string[],
-	};
+	};

package/src/managers/CMSManager.ts

@@ -348,6 +348,26 @@ export class CMSManager extends BaseManager {
     });
   }
 
+  /**
+   * Gets the current ERLC player queue count for the provided roblox join code.
+   * @param {string} robloxJoinCode The roblox join code to get the player queue size for.
+   * @returns {Promise} Promise object indicates success and includes the queue count when successful.
+   */
+  public async erlcGetPlayerQueue(robloxJoinCode: string): Promise<globalTypes.CMSERLCGetPlayerQueuePromiseResult> {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const erlcGetPlayerQueueRequest: any = await this.rest?.request('ERLC_GET_PLAYER_QUEUE', robloxJoinCode);
+        resolve({ success: true, data: erlcGetPlayerQueueRequest });
+      } 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.
@@ -374,4 +394,4 @@ export class CMSManager extends BaseManager {
       }
     });
   }
-}
+}