@sonoransoftware/sonoran.js 1.0.2 → 1.0.5

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

@@ -1,158 +1,158 @@
-// import { setTimeout as sleep } from 'node:timers/promises';
-import { AsyncQueue } from '@sapphire/async-queue';
-import fetch, { RequestInit, Response } from 'node-fetch';
-import { AbortController } from "node-abort-controller";
-// import { DiscordAPIError, DiscordErrorData, OAuthErrorData } from '../errors/DiscordAPIError';
-import { APIError } from '../errors';
-import { HTTPError } from '../errors/HTTPError';
-// import { RateLimitError } from '../errors/RateLimitError';
-import type { RequestManager, APIData, /**RequestData*/ } from '../RequestManager';
-import { RateLimitData } from '../REST';
-// import { RESTEvents } from '../utils/constants';
-// import type { RateLimitData } from '../REST';
-import type { IHandler } from './IHandler';
-
-export class SequentialHandler implements IHandler {
-	/**
-	 * The unique id of the handler
-	 */
-	public readonly id: string;
-
-	/**
-	 * The total number of requests that can be made before we are rate limited
-	 */
-	// private limit = Infinity;
-
-	/**
-	 * The interface used to sequence async requests sequentially
-	 */
-	// eslint-disable-next-line @typescript-eslint/explicit-member-accessibility
-	#asyncQueue = new AsyncQueue();
-
-	/**
-	 * @param manager The request manager
-	 * @param hash The hash that this RequestHandler handles
-	 * @param majorParameter The major parameter for this handler
-	 */
-	public constructor(
-		private readonly manager: RequestManager,
-		private readonly data: APIData,
-	) {
-		this.id = `${this.data.typePath}:${String(this.data.product)}`;
-	}
-
-	/**
-	 * If the bucket is currently inactive (no pending requests)
-	 */
-	public get inactive(): boolean {
-		return (
-			this.#asyncQueue.remaining === 0
-		);
-	}
-
-	public getMang(): RequestManager {
-		return this.manager;
-	}
-
-	/**
-	 * Emits a debug message
-	 * @param message The message to debug
-	 */
-	// private debug(message: string) {
-	// 	this.manager.emit(RESTEvents.Debug, `[REST ${this.id}] ${message}`);
-	// }
-
-	/*
-	 * Determines whether the request should be queued or whether a RateLimitError should be thrown
-	 */
-	// private async onRateLimit(rateLimitData: RateLimitData) {
-	// 	const { options } = this.manager;
-	// 	if (options.rejectOnRateLimit) {
-	// 		throw new RateLimitError(rateLimitData);
-	// 	}
-	// }
-
-	/**
-	 * Queues a request to be sent
-	 * @param routeId The generalized api route with literal ids for major parameters
-	 * @param url The url to do the request on
-	 * @param options All the information needed to make a request
-	 * @param requestData Extra data from the user's request needed for errors and additional processing
-	 */
-	public async queueRequest(
-		url: string,
-		options: RequestInit,
-    data: APIData
-	): Promise<unknown> {
-		let queue = this.#asyncQueue;
-		// Wait for any previous requests to be completed before this one is run
-		await queue.wait();
-		try {
-			// Make the request, and return the results
-			return await this.runRequest(url, options, data);
-		} finally {
-			// Allow the next request to fire
-			queue.shift();
-		}
-	}
-
-	/**
-	 * The method that actually makes the request to the api, and updates info about the bucket accordingly
-	 * @param routeId The generalized api route with literal ids for major parameters
-	 * @param url The fully resolved url to make the request to
-	 * @param options The node-fetch options needed to make the request
-	 * @param requestData Extra data from the user's request needed for errors and additional processing
-	 * @param retries The number of retries this request has already attempted (recursion)
-	 */
-	private async runRequest(
-		url: string,
-		options: RequestInit,
-    data: APIData,
-		// retries = 0,
-	): Promise<unknown> {
-		const controller = new AbortController();
-		const timeout = setTimeout(() => controller.abort(), 30000).unref();
-		let res: Response;
-
-		try {
-			// node-fetch typings are a bit weird, so we have to cast to any to get the correct signature
-			// Type 'AbortSignal' is not assignable to type 'import('discord.js-modules/node_modules/@types/node-fetch/externals').AbortSignal'
-			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-			res = await fetch(url, { ...options, signal: controller.signal as any });
-		} catch (error: unknown) {
-			throw error;
-		} finally {
-			clearTimeout(timeout);
-		}
-
-		if (res.ok) {
-			const parsedRes = await SequentialHandler.parseResponse(res);
-			return parsedRes;
-		} else if (res.status === 400 || res.status === 401 || res.status === 404) {
-			const parsedRes = await SequentialHandler.parseResponse(res);
-			// throw new HTTPError(String(parsedRes), res.constructor.name, res.status, data.method, url);
-			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);
-			}, 60 * 1000);
-			const ratelimitData: RateLimitData = {
-				product: data.product,
-				type: data.type,
-				timeTill: timeout
-			};
-			this.manager.onRateLimit(data.requestTypeId, ratelimitData);
-		} else if (res.status >= 500 && res.status < 600) {
-			throw new HTTPError(res.statusText, res.constructor.name, res.status, data.method, url);
-		}
-    return null;
-	}
-
-	private static parseResponse(res: Response): Promise<unknown> {
-		if (res.headers.get('Content-Type')?.startsWith('application/json')) {
-			return res.json();
-		}
-	
-		return res.text();
-	}
+// import { setTimeout as sleep } from 'node:timers/promises';
+import { AsyncQueue } from '@sapphire/async-queue';
+import fetch, { RequestInit, Response } from 'node-fetch';
+import { AbortController } from "node-abort-controller";
+// import { DiscordAPIError, DiscordErrorData, OAuthErrorData } from '../errors/DiscordAPIError';
+import { APIError } from '../errors';
+import { HTTPError } from '../errors/HTTPError';
+// import { RateLimitError } from '../errors/RateLimitError';
+import type { RequestManager, APIData, /**RequestData*/ } from '../RequestManager';
+import { RateLimitData } from '../REST';
+// import { RESTEvents } from '../utils/constants';
+// import type { RateLimitData } from '../REST';
+import type { IHandler } from './IHandler';
+
+export class SequentialHandler implements IHandler {
+	/**
+	 * The unique id of the handler
+	 */
+	public readonly id: string;
+
+	/**
+	 * The total number of requests that can be made before we are rate limited
+	 */
+	// private limit = Infinity;
+
+	/**
+	 * The interface used to sequence async requests sequentially
+	 */
+	// eslint-disable-next-line @typescript-eslint/explicit-member-accessibility
+	#asyncQueue = new AsyncQueue();
+
+	/**
+	 * @param manager The request manager
+	 * @param hash The hash that this RequestHandler handles
+	 * @param majorParameter The major parameter for this handler
+	 */
+	public constructor(
+		private readonly manager: RequestManager,
+		private readonly data: APIData,
+	) {
+		this.id = `${this.data.typePath}:${String(this.data.product)}`;
+	}
+
+	/**
+	 * If the bucket is currently inactive (no pending requests)
+	 */
+	public get inactive(): boolean {
+		return (
+			this.#asyncQueue.remaining === 0
+		);
+	}
+
+	public getMang(): RequestManager {
+		return this.manager;
+	}
+
+	/**
+	 * Emits a debug message
+	 * @param message The message to debug
+	 */
+	// private debug(message: string) {
+	// 	this.manager.emit(RESTEvents.Debug, `[REST ${this.id}] ${message}`);
+	// }
+
+	/*
+	 * Determines whether the request should be queued or whether a RateLimitError should be thrown
+	 */
+	// private async onRateLimit(rateLimitData: RateLimitData) {
+	// 	const { options } = this.manager;
+	// 	if (options.rejectOnRateLimit) {
+	// 		throw new RateLimitError(rateLimitData);
+	// 	}
+	// }
+
+	/**
+	 * Queues a request to be sent
+	 * @param routeId The generalized api route with literal ids for major parameters
+	 * @param url The url to do the request on
+	 * @param options All the information needed to make a request
+	 * @param requestData Extra data from the user's request needed for errors and additional processing
+	 */
+	public async queueRequest(
+		url: string,
+		options: RequestInit,
+    data: APIData
+	): Promise<unknown> {
+		let queue = this.#asyncQueue;
+		// Wait for any previous requests to be completed before this one is run
+		await queue.wait();
+		try {
+			// Make the request, and return the results
+			return await this.runRequest(url, options, data);
+		} finally {
+			// Allow the next request to fire
+			queue.shift();
+		}
+	}
+
+	/**
+	 * The method that actually makes the request to the api, and updates info about the bucket accordingly
+	 * @param routeId The generalized api route with literal ids for major parameters
+	 * @param url The fully resolved url to make the request to
+	 * @param options The node-fetch options needed to make the request
+	 * @param requestData Extra data from the user's request needed for errors and additional processing
+	 * @param retries The number of retries this request has already attempted (recursion)
+	 */
+	private async runRequest(
+		url: string,
+		options: RequestInit,
+    data: APIData,
+		// retries = 0,
+	): Promise<unknown> {
+		const controller = new AbortController();
+		const timeout = setTimeout(() => controller.abort(), 30000).unref();
+		let res: Response;
+
+		try {
+			// node-fetch typings are a bit weird, so we have to cast to any to get the correct signature
+			// Type 'AbortSignal' is not assignable to type 'import('discord.js-modules/node_modules/@types/node-fetch/externals').AbortSignal'
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+			res = await fetch(url, { ...options, signal: controller.signal as any });
+		} catch (error: unknown) {
+			throw error;
+		} finally {
+			clearTimeout(timeout);
+		}
+
+		if (res.ok) {
+			const parsedRes = await SequentialHandler.parseResponse(res);
+			return parsedRes;
+		} else if (res.status === 400 || res.status === 401 || res.status === 404) {
+			const parsedRes = await SequentialHandler.parseResponse(res);
+			// throw new HTTPError(String(parsedRes), res.constructor.name, res.status, data.method, url);
+			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);
+			}, 60 * 1000);
+			const ratelimitData: RateLimitData = {
+				product: data.product,
+				type: data.type,
+				timeTill: timeout
+			};
+			this.manager.onRateLimit(data.requestTypeId, ratelimitData);
+		} else if (res.status >= 500 && res.status < 600) {
+			throw new HTTPError(res.statusText, res.constructor.name, res.status, data.method, url);
+		}
+    return null;
+	}
+
+	private static parseResponse(res: Response): Promise<unknown> {
+		if (res.headers.get('Content-Type')?.startsWith('application/json')) {
+			return res.json();
+		}
+	
+		return res.text();
+	}
 }

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

@@ -347,6 +347,24 @@ export const GeneralCMSAPITypes: APITypeData[] = [
 		method: 'POST', // Would've been 'GET' but fetch doesn't allow body with GET requests.
 		minVersion: 3
 	},
+	{
+		type: 'GET_ACCOUNT_RANKS',
+		path: 'general/get_account_ranks',
+		method: 'POST', // Would've been 'GET' but fetch doesn't allow body with GET requests.
+		minVersion: 2,
+	},
+	{
+		type: 'SET_ACCOUNT_RANKS',
+		path: 'general/set_account_ranks',
+		method: 'POST', // Would've been 'GET' but fetch doesn't allow body with GET requests.
+		minVersion: 2,
+	},
+	{
+		type: 'GET_DEPARTMENTS',
+		path: 'general/get_departments',
+		method: 'POST', // Would've been 'GET' but fetch doesn't allow body with GET requests.
+		minVersion: 2,
+	},
 	{
 		type: 'GET_SUB_VERSION',
 		path: 'general/get_sub_version',
@@ -379,6 +397,12 @@ export const ServersCMSAPITypes: APITypeData[] = [
 		path: 'servers/verify_whitelist',
 		method: 'POST',
 		minVersion: 3
+	},
+	{
+		type: 'FULL_WHITELIST',
+		path: 'servers/full_whitelist',
+		method: 'POST',
+		minVersion: 3
 	}
 ];
 
@@ -393,7 +417,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) ];
 
-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_SUB_VERSION' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT';
+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';
 
 export interface CMSServerAPIStruct {
 	id: number;
@@ -782,7 +806,8 @@ export interface RESTTypedAPIDataStructs {
 	GET_COM_ACCOUNT: [
 		apiId?: string,
 		username?: string,
-		accId?: string
+		accId?: string,
+		discord?: string,
 	];
 	GET_SUB_VERSION: [];
 	CHECK_COM_APIID: [apiId: string];
@@ -791,6 +816,22 @@ export interface RESTTypedAPIDataStructs {
 		accId?: string,
 		forceClockIn?: boolean
 	];
+	GET_DEPARTMENTS: [];
+	GET_ACCOUNT_RANKS: [
+		apiId?: string,
+		username?: string,
+		accId?: string,
+		discord?: string,
+	],
+	SET_ACCOUNT_RANKS: [
+		accountId: string,
+		set?: {
+			primary?: string | null,
+			secondary?: string[]
+		},
+		add?: string[],
+		remove?: string[],
+	],
 	// CMS - Servers
 	GET_GAME_SERVERS: [];
 	VERIFY_WHITELIST: [
@@ -798,6 +839,9 @@ export interface RESTTypedAPIDataStructs {
 		accId: string | undefined,
 		serverId: number
 	];
+	FULL_WHITELIST: [
+		serverId?: number,
+	]
 }
 
 export type PossibleRequestData = 
@@ -916,4 +960,13 @@ export type PossibleRequestData =
 	{
 		apiId: string;
 		forceClockIn: boolean;
+	} |
+	{
+		accountId: string,
+		set?: {
+			primary: string[],
+			secondary: string[]
+		},
+		add?: string[],
+		remove?: string[],
 	};

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

@@ -1,18 +1,18 @@
-export function convertSubNumToName(subLevel: number) {
-  switch (subLevel) {
-    case 0:
-      return 'FREE';
-    case 1:
-      return 'STARTER';
-    case 2:
-      return 'STANDARD';
-    case 3:
-      return 'PLUS';
-    case 4:
-      return 'PRO';
-    case 6:
-      return 'ONE';
-    default:
-      return 'FREE';
-  }
+export function convertSubNumToName(subLevel: number) {
+  switch (subLevel) {
+    case 0:
+      return 'FREE';
+    case 1:
+      return 'STARTER';
+    case 2:
+      return 'STANDARD';
+    case 3:
+      return 'PLUS';
+    case 4:
+      return 'PRO';
+    case 6:
+      return 'ONE';
+    default:
+      return 'FREE';
+  }
 }

package/src/managers/BaseManager.ts

@@ -1,15 +1,15 @@
-import { Instance } from '../instance/Instance';
-
-/**
- * Manages the API methods of a data model or a specific product methods.
- * @abstract
- */
-export abstract class BaseManager {
-  /**
-   * 
-   * @param {Instance} instance The instance that instantiated this Manager
-   * @readonly
-   */
-  constructor(public readonly instance: Instance) {
-  }
-}
+import { Instance } from '../instance/Instance';
+
+/**
+ * Manages the API methods of a data model or a specific product methods.
+ * @abstract
+ */
+export abstract class BaseManager {
+  /**
+   * 
+   * @param {Instance} instance The instance that instantiated this Manager
+   * @readonly
+   */
+  constructor(public readonly instance: Instance) {
+  }
+}

package/src/managers/CADActiveUnitsManager.ts

@@ -1,50 +1,50 @@
-// Work in progress still...
-
-// import { CADActiveUnitFetchOptions } from '../constants';
-import { Instance } from '../instance/Instance';
-import { CADActiveUnit, CADActiveUnitResolvable, CADActiveUnitStruct } from '../structures/CADActiveUnit';
-import { CacheManager } from './CacheManager';
-
-export class CADActiveUnitsManager extends CacheManager<number, CADActiveUnit, CADActiveUnitResolvable> {
-  public serverId: number;
-  public instance: Instance;
-  constructor(instance: Instance, iterable: Iterable<CADActiveUnitStruct>, serverId: number) {
-    super(instance, CADActiveUnit, iterable);
-    this.instance = instance;
-    this.serverId = serverId;
-  }
-
-  _add(data: any, cache = true) {
-    return super._add(data, cache, data.id);
-  }
-
-  fetch(/*options: CADActiveUnitResolvable | CADActiveUnitFetchOptions**/) {
-    // if (!options) return this._fetchMany();
-    this._fetchSingle({
-      unit: -1,
-      includeOffline: false,
-      force: false
-    });
-  }
-
-  async _fetchSingle({
-    unit,
-    includeOffline = false,
-    force = false
-  }:{
-    unit: CADActiveUnitResolvable;
-    includeOffline: boolean;
-    force: boolean;
-  }) {
-    if (!force) {
-      const existing = this.cache.get(unit);
-      if (existing) return existing;
-    }
-
-    const data = await this.instance.cad?.rest?.request('GET_ACTIVE_UNITS', {
-      serverId: this.serverId,
-      includeOffline
-    });
-    console.log(data);
-  }
+// Work in progress still...
+
+// import { CADActiveUnitFetchOptions } from '../constants';
+import { Instance } from '../instance/Instance';
+import { CADActiveUnit, CADActiveUnitResolvable, CADActiveUnitStruct } from '../structures/CADActiveUnit';
+import { CacheManager } from './CacheManager';
+
+export class CADActiveUnitsManager extends CacheManager<number, CADActiveUnit, CADActiveUnitResolvable> {
+  public serverId: number;
+  public instance: Instance;
+  constructor(instance: Instance, iterable: Iterable<CADActiveUnitStruct>, serverId: number) {
+    super(instance, CADActiveUnit, iterable);
+    this.instance = instance;
+    this.serverId = serverId;
+  }
+
+  _add(data: any, cache = true) {
+    return super._add(data, cache, data.id);
+  }
+
+  fetch(/*options: CADActiveUnitResolvable | CADActiveUnitFetchOptions**/) {
+    // if (!options) return this._fetchMany();
+    this._fetchSingle({
+      unit: -1,
+      includeOffline: false,
+      force: false
+    });
+  }
+
+  async _fetchSingle({
+    unit,
+    includeOffline = false,
+    force = false
+  }:{
+    unit: CADActiveUnitResolvable;
+    includeOffline: boolean;
+    force: boolean;
+  }) {
+    if (!force) {
+      const existing = this.cache.get(unit);
+      if (existing) return existing;
+    }
+
+    const data = await this.instance.cad?.rest?.request('GET_ACTIVE_UNITS', {
+      serverId: this.serverId,
+      includeOffline
+    });
+    console.log(data);
+  }
 }