@sonoransoftware/sonoran.js 1.0.19 → 1.0.22

package/readme.md

@@ -1,54 +1,54 @@
-# Sonoran.js
-Sonoran.js is a library that allows you to interact with the [Sonoran CAD](https://sonorancad.com/) and [Sonoran CMS](https://sonorancms.com/) API. Based off of and utilizes several Discord.js library techniques for ease of use.
-
-## Example Instance Setup
-
-Utilizing both Sonoran CMS & Sonoran CAD
-```js
-const Sonoran = require('sonoran.js');
-const instance = Sonoran.instance({
-  cadCommunityId: 'mycommunity',
-  cadApiKey: 'DF58F1E-FD8A-44C5-BA',
-  cmsCommunityId: 'mycommunity',
-  cmsApiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf'
-});
-```
-
-Utilizing just Sonoran CMS or Sonoran CAD
-```js
-const Sonoran = require('sonoran.js');
-const instance = Sonoran.instance({
-  communityId: 'mycommunity',
-  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
-  product: Sonoran.productEnums.CMS
-});
-```
-
-## Example Method Usage
-```js
-const Sonoran = require('sonoran.js');
-const instance = Sonoran.instance({
-  communityId: 'mycommunity',
-  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
-  product: Sonoran.productEnums.CMS,
-  serverId: 2 // Optional - The default server id for both CAD & CMS is 1
-});
-
-// This will verify the whitelist of the given API ID or account ID for server id 2 as specified above
-instance.cms.verifyWhitelist('459798465498798432');
-// OR
-// This will verify the whitelist of the given API ID for server id 1 since I specified that
-instance.cms.verifyWhitelist({
-  apiId: '459798465498798432',
-  serverId: 1
-});
-// OR
-// This will verify the whitelist of the given account ID for server id 1 since I specified that
-instance.cms.verifyWhitelist({
-  accId: 'd5663516-ee35-11e9-9714-5600023b2434',
-  serverId: 1
-});
-```
-
-## Further Documentation
+# Sonoran.js
+Sonoran.js is a library that allows you to interact with the [Sonoran CAD](https://sonorancad.com/) and [Sonoran CMS](https://sonorancms.com/) API. Based off of and utilizes several Discord.js library techniques for ease of use.
+
+## Example Instance Setup
+
+Utilizing both Sonoran CMS & Sonoran CAD
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  cadCommunityId: 'mycommunity',
+  cadApiKey: 'DF58F1E-FD8A-44C5-BA',
+  cmsCommunityId: 'mycommunity',
+  cmsApiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf'
+});
+```
+
+Utilizing just Sonoran CMS or Sonoran CAD
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS
+});
+```
+
+## Example Method Usage
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS,
+  serverId: 2 // Optional - The default server id for both CAD & CMS is 1
+});
+
+// This will verify the whitelist of the given API ID or account ID for server id 2 as specified above
+instance.cms.verifyWhitelist('459798465498798432');
+// OR
+// This will verify the whitelist of the given API ID for server id 1 since I specified that
+instance.cms.verifyWhitelist({
+  apiId: '459798465498798432',
+  serverId: 1
+});
+// OR
+// This will verify the whitelist of the given account ID for server id 1 since I specified that
+instance.cms.verifyWhitelist({
+  accId: 'd5663516-ee35-11e9-9714-5600023b2434',
+  serverId: 1
+});
+```
+
+## 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).

package/src/constants.ts

@@ -1,249 +1,249 @@
-import { Collection } from '@discordjs/collection';
-import { CADDispatchOriginEnums, CADDispatchStatusEnums } from './libs/rest/src';
-import { DataManager } from './managers/DataManager';
-import { CADActiveUnitsManager } from './managers/CADActiveUnitsManager';
-import { CADActiveUnit } from './structures/CADActiveUnit';
-
-export enum productEnums {
-  CAD,
-  CMS
-}
-
-export interface CADNewDispatchBuilderOptions {
-	serverId?: number;
-	origin?: CADDispatchOriginEnums;
-	status?: CADDispatchStatusEnums;
-	priority?: 1 | 2 | 3;
-	block?: string;
-	address?: string;
-	postal?: string;
-	title?: string;
-	code?: string;
-	primary?: number;
-	trackPrimary?: boolean;
-	description?: string;
-	metaData?: Record<string, string>;
-	units?: string[];
-}
-
-export type Constructable<T> = abstract new (...args: any[]) => T;
-
-export interface Caches {
-	CADActiveUnitsManager: [manager: typeof CADActiveUnitsManager, holds: CADActiveUnit];
-}
-
-export type CacheConstructors = {
-  [K in keyof Caches]: Caches[K][0] & { name: K };
-};
-
-export type CacheFactory = (
-  manager: CacheConstructors[keyof Caches],
-  holds: Caches[typeof manager['name']][1],
-) => typeof manager['prototype'] extends DataManager<infer K, infer V, any> ? Collection<K, V> : never;
-
-export interface CADActiveUnitFetchOptions {
-	id?: number | number[];
-	accId?: string | string[];
-	apiId?: string | string[];
-}
-
-export enum CADSubscriptionVersionEnum {
-	FREE = 0,
-	STARTER = 1,
-	STANDARD = 2,
-	PLUS = 3,
-	PRO = 4,
-	ONE = 6
-}
-
-export enum CMSSubscriptionVersionEnum {
-	FREE = 0,
-	STARTER = 1,
-	STANDARD = 2,
-	PLUS = 3,
-	PRO = 4,
-	ONE = 6
-}
-
-export type Mutable<T> = {
-	-readonly [k in keyof T]: T[k];
-};
-
-export interface CMSVerifyWhitelistPromiseResult {
-	success: boolean;
-	reason?: string;
-}
-
-export interface CMSGetFullWhitelistPromiseResult {
-	success: boolean;
-	reason?: string;
-	data?: {
-		name: string;
-		apiIds: string[];
-	}[];
-}
-
-export interface CMSGetAccountRanksPromiseResult {
-	success: boolean;
-	reason?: string;
-	data?: string[];
-}
-
-export interface CMSGetComAccountPromiseResult {
-	success: boolean;
-	reason?: string;
-	data?: {
-		accId: string;
-		sysStatus: boolean;
-		comStatus: boolean;
-		joinDate: string;
-		lastLogin: string;
-		owner: boolean;
-		banned: boolean;
-		activeApiIds: string[];
-		primaryIdentifier: string;
-		secondaryIdentifiers: {
-			identifiers: { id: string; label: string; }[];
-		}
-		primaryRank: string;
-		secondaryRanks: string[];
-		primaryDepartment: string;
-		secondaryDepartments: string[];
-	}
-}
-
-export const uuidRegex = /[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}/i;
-
-export interface CMSClockInOutPromiseResult {
-	success: boolean;
-	reason?: string;
-	clockedIn?: boolean;
-}
-
-export interface CMSClockInOutParams {
-	accId?: string;
-	apiId?: string;
-	forceClockIn?: boolean;
-}
-
-export interface CMSCheckComApiIdPromiseResult {
-	success: boolean;
-	reason?: string;
-	username?: string;
-}
-
-export interface CMSGetDepartmentsPromiseResult {
-	success: boolean;
-	reason?: string;
-	data?: CMSDepartment[];
-}
-
-export interface CMSSetAccountRanksPromiseResult {
-	success: boolean;
-	reason?: string;
-	data?: {
-		accId: string;
-		sysStatus: boolean;
-		comStatus: boolean;
-		joinDate: string;
-		lastLogin: string;
-		owner: boolean;
-		banned: boolean;
-		activeApiIds: string[];
-		primaryIdentifier: string;
-		secondaryIdentifiers: {
-			identifiers: { id: string; label: string; }[];
-		}
-		primaryRank: string;
-		secondaryRanks: string[];
-		primaryDepartment: string;
-		secondaryDepartments: string[];
-	}
-}
-
-export interface CMSSetAccountRanksChangesObject {
-	set?: {
-		primary?: string | null;
-		secondary?: string[];
-	}
-	add: string[];
-	remove: string[];
-}
-
-export interface CMSDepartment {
-	uuid: string;
-	label: string;
-	labelTwo: string;
-	ranks: {
-		id: string;
-		label: string;
-		primaryOnly: boolean;
-		secondaryOnly: boolean;
-	}[];
-}
-
-export interface CADGetAccountPromiseResult {
-	success: boolean;
-	reason?: string;
-	data?: {
-		uuid: string;
-		username: string;
-		status: number;
-		joined: string;
-		lastLogin: string;
-		permissions: {
-			civilian: boolean;
-			lawyer: boolean;
-			dmv: boolean;
-			police: boolean;
-			fire: boolean;
-			ems: boolean;
-			dispatch: boolean;
-			admin: boolean;
-			polRecAdd: boolean;
-			polRecEdit: boolean;
-			polRecRemove: boolean;
-			polSuper: boolean;
-			polEditUnit: boolean;
-			polEditOtherUnit: boolean;
-			selfDispatch: boolean;
-			liveMap: boolean;
-			medRecAdd: boolean;
-			medRecEdit: boolean;
-			medRecRemove: boolean;
-			medSuper: boolean;
-			fireRecAdd: boolean;
-			fireRecEdit: boolean;
-			fireRecRemove: boolean;
-			fireSuper: boolean;
-			dmvRecAdd: boolean;
-			dmvRecEdit: boolean;
-			dmvRecRemove: boolean;
-			dmvSuper: boolean;
-			modifyStreetSigns: boolean;
-			lawRecAdd: boolean;
-			lawRecEdit: boolean;
-			lawRecRemove: boolean;
-			lawSuper: boolean;
-			adminAccounts: boolean;
-			adminPermissionKeys: boolean;
-			adminCustomization: boolean;
-			adminDepartments: boolean;
-			adminTenCodes: boolean;
-			adminPenalCodes: boolean;
-			adminInGameIntegration: boolean;
-			adminDiscordIntegration: boolean;
-			adminLimits: boolean;
-			adminLogs: boolean;
-		},
-		apiIds: string[];
-	}
-}
-
-export interface clockInOutRequest {
-	id: number;
-	notes: any[];
-	endTime: string;
-	completed: boolean;
-	startTime: string;
+import { Collection } from '@discordjs/collection';
+import { CADDispatchOriginEnums, CADDispatchStatusEnums } from './libs/rest/src';
+import { DataManager } from './managers/DataManager';
+import { CADActiveUnitsManager } from './managers/CADActiveUnitsManager';
+import { CADActiveUnit } from './structures/CADActiveUnit';
+
+export enum productEnums {
+  CAD,
+  CMS
+}
+
+export interface CADNewDispatchBuilderOptions {
+	serverId?: number;
+	origin?: CADDispatchOriginEnums;
+	status?: CADDispatchStatusEnums;
+	priority?: 1 | 2 | 3;
+	block?: string;
+	address?: string;
+	postal?: string;
+	title?: string;
+	code?: string;
+	primary?: number;
+	trackPrimary?: boolean;
+	description?: string;
+	metaData?: Record<string, string>;
+	units?: string[];
+}
+
+export type Constructable<T> = abstract new (...args: any[]) => T;
+
+export interface Caches {
+	CADActiveUnitsManager: [manager: typeof CADActiveUnitsManager, holds: CADActiveUnit];
+}
+
+export type CacheConstructors = {
+  [K in keyof Caches]: Caches[K][0] & { name: K };
+};
+
+export type CacheFactory = (
+  manager: CacheConstructors[keyof Caches],
+  holds: Caches[typeof manager['name']][1],
+) => typeof manager['prototype'] extends DataManager<infer K, infer V, any> ? Collection<K, V> : never;
+
+export interface CADActiveUnitFetchOptions {
+	id?: number | number[];
+	accId?: string | string[];
+	apiId?: string | string[];
+}
+
+export enum CADSubscriptionVersionEnum {
+	FREE = 0,
+	STARTER = 1,
+	STANDARD = 2,
+	PLUS = 3,
+	PRO = 4,
+	ONE = 6
+}
+
+export enum CMSSubscriptionVersionEnum {
+	FREE = 0,
+	STARTER = 1,
+	STANDARD = 2,
+	PLUS = 3,
+	PRO = 4,
+	ONE = 6
+}
+
+export type Mutable<T> = {
+	-readonly [k in keyof T]: T[k];
+};
+
+export interface CMSVerifyWhitelistPromiseResult {
+	success: boolean;
+	reason?: string;
+}
+
+export interface CMSGetFullWhitelistPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: {
+		name: string;
+		apiIds: string[];
+	}[];
+}
+
+export interface CMSGetAccountRanksPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: string[];
+}
+
+export interface CMSGetComAccountPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: {
+		accId: string;
+		sysStatus: boolean;
+		comStatus: boolean;
+		joinDate: string;
+		lastLogin: string;
+		owner: boolean;
+		banned: boolean;
+		activeApiIds: string[];
+		primaryIdentifier: string;
+		secondaryIdentifiers: {
+			identifiers: { id: string; label: string; }[];
+		}
+		primaryRank: string;
+		secondaryRanks: string[];
+		primaryDepartment: string;
+		secondaryDepartments: string[];
+	}
+}
+
+export const uuidRegex = /[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}/i;
+
+export interface CMSClockInOutPromiseResult {
+	success: boolean;
+	reason?: string;
+	clockedIn?: boolean;
+}
+
+export interface CMSClockInOutParams {
+	accId?: string;
+	apiId?: string;
+	forceClockIn?: boolean;
+}
+
+export interface CMSCheckComApiIdPromiseResult {
+	success: boolean;
+	reason?: string;
+	username?: string;
+}
+
+export interface CMSGetDepartmentsPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: CMSDepartment[];
+}
+
+export interface CMSSetAccountRanksPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: {
+		accId: string;
+		sysStatus: boolean;
+		comStatus: boolean;
+		joinDate: string;
+		lastLogin: string;
+		owner: boolean;
+		banned: boolean;
+		activeApiIds: string[];
+		primaryIdentifier: string;
+		secondaryIdentifiers: {
+			identifiers: { id: string; label: string; }[];
+		}
+		primaryRank: string;
+		secondaryRanks: string[];
+		primaryDepartment: string;
+		secondaryDepartments: string[];
+	}
+}
+
+export interface CMSSetAccountRanksChangesObject {
+	set?: {
+		primary?: string | null;
+		secondary?: string[];
+	}
+	add: string[];
+	remove: string[];
+}
+
+export interface CMSDepartment {
+	uuid: string;
+	label: string;
+	labelTwo: string;
+	ranks: {
+		id: string;
+		label: string;
+		primaryOnly: boolean;
+		secondaryOnly: boolean;
+	}[];
+}
+
+export interface CADGetAccountPromiseResult {
+	success: boolean;
+	reason?: string;
+	data?: {
+		uuid: string;
+		username: string;
+		status: number;
+		joined: string;
+		lastLogin: string;
+		permissions: {
+			civilian: boolean;
+			lawyer: boolean;
+			dmv: boolean;
+			police: boolean;
+			fire: boolean;
+			ems: boolean;
+			dispatch: boolean;
+			admin: boolean;
+			polRecAdd: boolean;
+			polRecEdit: boolean;
+			polRecRemove: boolean;
+			polSuper: boolean;
+			polEditUnit: boolean;
+			polEditOtherUnit: boolean;
+			selfDispatch: boolean;
+			liveMap: boolean;
+			medRecAdd: boolean;
+			medRecEdit: boolean;
+			medRecRemove: boolean;
+			medSuper: boolean;
+			fireRecAdd: boolean;
+			fireRecEdit: boolean;
+			fireRecRemove: boolean;
+			fireSuper: boolean;
+			dmvRecAdd: boolean;
+			dmvRecEdit: boolean;
+			dmvRecRemove: boolean;
+			dmvSuper: boolean;
+			modifyStreetSigns: boolean;
+			lawRecAdd: boolean;
+			lawRecEdit: boolean;
+			lawRecRemove: boolean;
+			lawSuper: boolean;
+			adminAccounts: boolean;
+			adminPermissionKeys: boolean;
+			adminCustomization: boolean;
+			adminDepartments: boolean;
+			adminTenCodes: boolean;
+			adminPenalCodes: boolean;
+			adminInGameIntegration: boolean;
+			adminDiscordIntegration: boolean;
+			adminLimits: boolean;
+			adminLogs: boolean;
+		},
+		apiIds: string[];
+	}
+}
+
+export interface clockInOutRequest {
+	id: number;
+	notes: any[];
+	endTime: string;
+	completed: boolean;
+	startTime: string;
 }