@sonoransoftware/sonoran.js 1.0.26 → 1.0.27

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/package.json

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