@sonoransoftware/sonoran.js 1.0.26 → 1.0.28

package/dist/constants.d.ts

@@ -225,3 +225,8 @@ export interface clockInOutRequest {
     completed: boolean;
     startTime: string;
 }
+export interface CMSSetAccountNamePromiseResult {
+    success: boolean;
+    data?: string;
+    reason?: string;
+}

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

@@ -174,6 +174,16 @@ class REST extends events_1.EventEmitter {
                     profileFields: args[5]
                 };
             }
+            case 'SET_ACCOUNT_NAME': {
+                return {
+                    apiId: args[0],
+                    username: args[1],
+                    accId: args[2],
+                    discordId: args[3],
+                    uniqueId: args[4],
+                    newName: args[5]
+                };
+            }
             default: {
                 return args;
             }

package/dist/libs/rest/src/lib/handlers/SequentialHandler.js

@@ -113,7 +113,12 @@ class SequentialHandler {
             return parsedRes;
         }
         else if (res.status === 400 || res.status === 401 || res.status === 404) {
-            throw new errors_1.APIError(parsedRes, data.type, data.fullUrl, res.status, data);
+            if (typeof parsedRes === 'object' && !(parsedRes === null || parsedRes === void 0 ? void 0 : parsedRes.authorized)) {
+                return parsedRes;
+            }
+            else {
+                throw new errors_1.APIError(parsedRes, data.type, data.fullUrl, res.status, data);
+            }
         }
         else if (res.status === 429) {
             const timeout = setTimeout(() => {

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

@@ -35,7 +35,7 @@ export declare const EventsCMSAPITypes: APITypeData[];
 export declare const FormsCMSAPITypes: APITypeData[];
 export declare const CommunitiesCMSAPITypes: 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';
+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';
 export interface CMSServerAPIStruct {
     id: number;
     name: string;
@@ -424,6 +424,14 @@ export interface RESTTypedAPIDataStructs {
         discord?: string,
         uniqueId?: string
     ];
+    SET_ACCOUNT_NAME: [
+        apiId: string | undefined,
+        username: string | undefined,
+        accId: string | undefined,
+        discordId: string | undefined,
+        uniqueId: string | undefined,
+        newName: string
+    ];
     GET_GAME_SERVERS: [];
     VERIFY_WHITELIST: [
         apiId: string | undefined,

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

@@ -369,6 +369,12 @@ exports.GeneralCMSAPITypes = [
         path: 'general/edit_acc_profile_fields',
         method: 'POST',
         minVersion: 0
+    },
+    {
+        type: 'SET_ACCOUNT_NAME',
+        path: 'general/set_account_name',
+        method: 'POST',
+        minVersion: 0
     }
 ];
 exports.ServersCMSAPITypes = [

package/dist/managers/CMSManager.d.ts

@@ -107,4 +107,16 @@ export declare class CMSManager extends BaseManager {
      * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
      */
     setAccountRanks(changes: globalTypes.CMSSetAccountRanksChangesObject, apiId?: string, accId?: string, username?: string, discord?: string, uniqueId?: string): Promise<globalTypes.CMSSetAccountRanksPromiseResult>;
+    /**
+   * Sets a community account's name for the CMS community.
+   * @param {Object} data The object that contains critical data to set an account's name.
+   * @param {string} [data.apiId] (Optional) The api id to set the account name.
+   * @param {string} [data.username] (Optional) The username to set the account name.
+   * @param {string} [data.accId] (Optional) The account id to set the account name.
+   * @param {string} [data.discordId] (Optional) The discord id to set the account name.
+   * @param {string} [data.uniqueId] (Optional) The unique id to set the account name.
+   * @param {string} [data.newName] (Optional) The new name to set the account name.
+   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+   */
+    setAccountName(apiId: string | undefined, username: string | undefined, accId: string | undefined, discordId: string | undefined, uniqueId: string | undefined, newName: string): Promise<globalTypes.CMSSetAccountNamePromiseResult>;
 }

package/dist/managers/CMSManager.js

@@ -264,5 +264,33 @@ class CMSManager extends BaseManager_1.BaseManager {
             }
         });
     }
+    /**
+   * Sets a community account's name for the CMS community.
+   * @param {Object} data The object that contains critical data to set an account's name.
+   * @param {string} [data.apiId] (Optional) The api id to set the account name.
+   * @param {string} [data.username] (Optional) The username to set the account name.
+   * @param {string} [data.accId] (Optional) The account id to set the account name.
+   * @param {string} [data.discordId] (Optional) The discord id to set the account name.
+   * @param {string} [data.uniqueId] (Optional) The unique id to set the account name.
+   * @param {string} [data.newName] (Optional) The new name to set the account name.
+   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+   */
+    async setAccountName(apiId, username, accId, discordId, uniqueId, newName) {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const setAccountNameRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('SET_ACCOUNT_NAME', apiId, username, accId, discordId, uniqueId, newName));
+                resolve({ success: true, data: setAccountNameRequest });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
 }
 exports.CMSManager = CMSManager;

package/package.json

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

@@ -50,5 +50,131 @@ instance.cms.verifyWhitelist({
 });
 ```
 
+## CAD Functions
+### getAccount
+Returns the user's account object.
+#### Argument `params`
+##### Type: `object` `{apiId?, username?}`
+```js
+const params = {
+ apiId: '',
+ username: 'SomeUser',
+};
+// Get user account object
+const account = await instance.cad.getAccount(params);
+```
+
+## CMS Functions
+### verifyWhitelist(obj)
+Verifies that a user is whitelisted in the specified server.
+#### Arugment `params`
+##### Type `object` `{accId?: string, apiId?: string, username?: string, discord?: string, uniqueId?: number, serverId?: number}`
+##### Type `string` (Account UUID or API ID as a string)
+*Note: If passing a `string` for data (Account UUID or API ID) the `serverId` will default to `1`*
+```js
+const params = {
+ accId: '',
+ apiId: '',
+ username: '',
+ discord: '',
+ uniqueId: 1234,
+ serverId: 1
+};
+// Check if user with Unique ID 1234 is whitelisted on Server ID 1
+const isWhitelisted = await instance.cms.verifyWhitelist(params);
+```
+
+### getFullWhitelist()
+Returns a full list of whitelisted users in the specified server.
+#### Arugment `serverId`
+##### Type `number` `1`
+```js
+// Get the full whitelist for server ID 1
+const fullWhitelist = await instance.cms.getFullWhitelist(1);
+```
+
+### getComAccount(obj)
+Returns the user's account object
+#### Arugment `params`
+##### Type `object` `{accId?: string, apiId?: string, username?: string, discord?: string, uniqueId?: string}`
+```js
+const params = {
+ accId: '',
+ apiId: '',
+ username: '',
+ discord: '',
+ uniqueId: '1234',
+};
+// Get a user's account as an object
+const getAccount = await instance.cms.getComAccount(params);
+```
+
+### getAccountRanks(obj)
+Returns a user account's ranks
+#### Arugment `params`
+##### Type `object` `{accId?: string, apiId?: string, username?: string, discord?: string, uniqueId?: string}`
+```js
+const params = {
+ accId: '',
+ apiId: '',
+ username: '',
+ discord: '',
+ uniqueId: '1234',
+};
+// Get a user's ranks
+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}`
+```js
+const params = {
+ accId: '',
+ apiId: '',
+ forceClockIn: true,
+ discord: '',
+ uniqueId: '1234',
+};
+// Clocks a user in or out
+const clock = await instance.cms.clockInOut(params);
+```
+
+### 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`
+##### Type `string` `1234`
+```js
+// Checks if API ID is attatched to a user, returns username if true
+const apiIdUsername = await instance.cms.checkComApiId('1234');
+```
+
+### getDepartments()
+Gets all department information for a CMS community
+```js
+// Gets department information for community
+const getDepts = await instance.cms.getDepartments();
+```
+
+### setAccountRanks(obj, apiId, accId, username, discord, uniqueId)
+Gets all department information for a CMS community
+#### Arugment `params`
+##### Type `object` `{set?: string[]; add?: string[]; remove?: string[]}`
+#### Arguments `apiId`, `accId`, `username`, `discord`, `uniqueId`
+##### Type `string` or `undefined`
+*Note: Only one identifier is required (Discord, accID, etc.) pass in undefined for variables you are not searching by*
+```js
+const params = {
+ set: ['9ad00ded-93d1-422e-8470-d2515f02652c'],
+ add: undefined,
+ remove: undefined
+};
+// Wipe users existing ranks, and set ones provided
+// Add and Remove are undefined as we don't want to call them here
+// Sets account ranks by the discord ID parameter
+const setRanks = await instance.cms.setAccountRanks(params, undefined, undefined, undefined, '12345678', undefined);
+```
+
 ## 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).
+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

@@ -243,4 +243,10 @@ export interface clockInOutRequest {
 	endTime: string;
 	completed: boolean;
 	startTime: string;
+}
+
+export interface CMSSetAccountNamePromiseResult {
+	success: boolean;
+	data?: string;
+	reason?: string;
 }

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

@@ -280,6 +280,16 @@ export class REST extends EventEmitter {
 					profileFields: args[5]
 				}
 			}
+			case 'SET_ACCOUNT_NAME': {
+				return {
+					apiId: args[0],
+					username: args[1],
+					accId: args[2],
+					discordId: args[3],
+					uniqueId: args[4],
+					newName: args[5]
+				}
+			}
 			default: {
 				return args;
 			}

package/src/libs/rest/src/lib/handlers/SequentialHandler.ts

@@ -134,7 +134,11 @@ export class SequentialHandler implements IHandler {
 		if (res.ok) {
 			return parsedRes;
 		} else if (res.status === 400 || res.status === 401 || res.status === 404) {
-			throw new APIError(parsedRes as string, data.type, data.fullUrl, res.status, data);
+			if (typeof parsedRes === 'object' && !(parsedRes as any)?.authorized) {
+				return parsedRes;
+			} else {
+				throw new APIError(parsedRes as string, data.type, data.fullUrl, res.status, data);
+			}
 		} else if (res.status === 429) {
 			const timeout = setTimeout(() => {
 				this.manager.removeRateLimit(data.requestTypeId);
@@ -155,7 +159,7 @@ export class SequentialHandler implements IHandler {
 		if (res.headers.get('Content-Type')?.startsWith('application/json')) {
 			return res.json();
 		}
-	
+
 		return res.text();
 	}
 }

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

@@ -400,6 +400,12 @@ export const GeneralCMSAPITypes: APITypeData[] = [
 		path: 'general/edit_acc_profile_fields',
 		method: 'POST',
 		minVersion: 0
+	},
+	{
+		type: 'SET_ACCOUNT_NAME',
+		path: 'general/set_account_name',
+		method: 'POST',
+		minVersion: 0
 	}
 ];
 
@@ -462,7 +468,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) ];
 
-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';
+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';
 
 export interface CMSServerAPIStruct {
 	id: number;
@@ -886,6 +892,14 @@ export interface RESTTypedAPIDataStructs {
 		discord?: string,
 		uniqueId?: string,
 	],
+	SET_ACCOUNT_NAME: [
+		apiId: string | undefined,
+		username: string | undefined,
+		accId: string | undefined,
+		discordId: string | undefined,
+		uniqueId: string | undefined,
+		newName: string,
+	],
 	// CMS - Servers
 	GET_GAME_SERVERS: [];
 	VERIFY_WHITELIST: [

package/src/managers/CMSManager.ts

@@ -226,4 +226,30 @@ export class CMSManager extends BaseManager {
       }
     });
   }
+
+    /**
+   * Sets a community account's name for the CMS community.
+   * @param {Object} data The object that contains critical data to set an account's name.
+   * @param {string} [data.apiId] (Optional) The api id to set the account name.
+   * @param {string} [data.username] (Optional) The username to set the account name.
+   * @param {string} [data.accId] (Optional) The account id to set the account name.
+   * @param {string} [data.discordId] (Optional) The discord id to set the account name.
+   * @param {string} [data.uniqueId] (Optional) The unique id to set the account name.
+   * @param {string} [data.newName] (Optional) The new name to set the account name.
+   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+   */
+  public async setAccountName(apiId: string | undefined, username: string | undefined, accId: string | undefined, discordId: string | undefined, uniqueId: string | undefined, newName: string ): Promise<globalTypes.CMSSetAccountNamePromiseResult> {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const setAccountNameRequest: any = await this.rest?.request('SET_ACCOUNT_NAME', apiId, username, accId, discordId, uniqueId, newName);
+        resolve({ success: true, data: setAccountNameRequest });
+      } catch (err) {
+        if (err instanceof APIError) {
+          resolve({ success: false, reason: err.response });
+        } else {
+          reject(err);
+        }
+      }
+    });
+  }
 }