@sonoransoftware/sonoran.js 1.0.2 → 1.0.5

package/src/managers/CADManager.ts

@@ -1,59 +1,59 @@
-import { Instance } from '../instance/Instance';
-import { CADSubscriptionVersionEnum } from '../constants';
-import { APIError, DefaultCADRestOptions, REST } from '../libs/rest/src';
-import { BaseManager } from './BaseManager';
-import * as globalTypes from '../constants';
-import type { Mutable } from '../constants';
-import { CADServerManager } from './CADServerManager';
-
-/**
- * Manages all Sonoran CAD data and methods to interact with the public API.
- */
-export class CADManager extends BaseManager {
-  public readonly version: CADSubscriptionVersionEnum = 0;
-  public rest: REST | undefined;
-  public servers: CADServerManager | undefined;
-
-  constructor(instance: Instance) {
-    super(instance);
-
-    this.rest = new REST(instance, this, globalTypes.productEnums.CAD, DefaultCADRestOptions);
-    this.buildManager(instance);
-  }
-
-  protected async buildManager(instance: Instance) {
-    try {
-      const versionResp: any = await this.rest?.request('GET_VERSION');
-      const mutableThis = this as Mutable<CADManager>;
-      mutableThis.version = Number.parseInt(versionResp.replace(/(^\d+)(.+$)/i,'$1'));
-      if (this.version >= globalTypes.CADSubscriptionVersionEnum.STANDARD) {
-        this.servers = new CADServerManager(instance, this);
-      }
-      instance.isCADSuccessful = true;
-    } catch (err) {
-      console.log(err);
-    }
-  }
-
-  /**
-   * Gets a community account by `accId` or `apiId`.
-   * @param {Object} params The object that contains parameters to get a community account.
-   * @param {string} [data.accId] The account id to find a community account.
-   * @param {string} [data.apiId] The api id to find a community account.
-   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed and the account data object if found.
-   */
-  public async getAccount(params: { apiId?: string, username?: string }): Promise<globalTypes.CADGetAccountPromiseResult> {
-    return new Promise(async (resolve, reject) => {
-      try {
-        const getAccountRequest: any = await this.rest?.request('GET_ACCOUNT', params.apiId, params.username);
-        resolve({ success: true, data: getAccountRequest });
-      } catch (err) {
-        if (err instanceof APIError) {
-          resolve({ success: false, reason: err.response });
-        } else {
-          reject(err);
-        }
-      }
-    });
-  }
+import { Instance } from '../instance/Instance';
+import { CADSubscriptionVersionEnum } from '../constants';
+import { APIError, DefaultCADRestOptions, REST } from '../libs/rest/src';
+import { BaseManager } from './BaseManager';
+import * as globalTypes from '../constants';
+import type { Mutable } from '../constants';
+import { CADServerManager } from './CADServerManager';
+
+/**
+ * Manages all Sonoran CAD data and methods to interact with the public API.
+ */
+export class CADManager extends BaseManager {
+  public readonly version: CADSubscriptionVersionEnum = 0;
+  public rest: REST | undefined;
+  public servers: CADServerManager | undefined;
+
+  constructor(instance: Instance) {
+    super(instance);
+
+    this.rest = new REST(instance, this, globalTypes.productEnums.CAD, DefaultCADRestOptions);
+    this.buildManager(instance);
+  }
+
+  protected async buildManager(instance: Instance) {
+    try {
+      const versionResp: any = await this.rest?.request('GET_VERSION');
+      const mutableThis = this as Mutable<CADManager>;
+      mutableThis.version = Number.parseInt(versionResp.replace(/(^\d+)(.+$)/i,'$1'));
+      if (this.version >= globalTypes.CADSubscriptionVersionEnum.STANDARD) {
+        this.servers = new CADServerManager(instance, this);
+      }
+      instance.isCADSuccessful = true;
+    } catch (err) {
+      console.log(err);
+    }
+  }
+
+  /**
+   * Gets a community account by `accId` or `apiId`.
+   * @param {Object} params The object that contains parameters to get a community account.
+   * @param {string} [data.accId] The account id to find a community account.
+   * @param {string} [data.apiId] The api id to find a community account.
+   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed and the account data object if found.
+   */
+  public async getAccount(params: { apiId?: string, username?: string }): Promise<globalTypes.CADGetAccountPromiseResult> {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const getAccountRequest: any = await this.rest?.request('GET_ACCOUNT', params.apiId, params.username);
+        resolve({ success: true, data: getAccountRequest });
+      } catch (err) {
+        if (err instanceof APIError) {
+          resolve({ success: false, reason: err.response });
+        } else {
+          reject(err);
+        }
+      }
+    });
+  }
 }

package/src/managers/CADServerManager.ts

@@ -1,27 +1,27 @@
-import { Instance } from '../instance/Instance';
-import { CADServerAPIStruct } from '../libs/rest/src';
-import { CADServer } from '../structures/CADServer';
-import { CacheManager } from './CacheManager';
-import { CADManager } from './CADManager';
-
-export class CADServerManager extends CacheManager<number, CADServer, CADServerAPIStruct> {
-  constructor(instance: Instance, manager: CADManager) {
-    super(instance, CADServer, []);
-
-    (async () => {
-      try {
-        const serversRes: any = await manager.rest?.request('GET_SERVERS');
-        const servers = JSON.parse(serversRes).servers;
-        servers.forEach((server: CADServerAPIStruct) => {
-          const serverStruct = {
-            id: server.id,
-            config: server
-          };
-          this._add(serverStruct, true, server.id);
-        });
-      } catch (err) {
-        throw new Error(String(err));
-      }
-    })();
-  }
+import { Instance } from '../instance/Instance';
+import { CADServerAPIStruct } from '../libs/rest/src';
+import { CADServer } from '../structures/CADServer';
+import { CacheManager } from './CacheManager';
+import { CADManager } from './CADManager';
+
+export class CADServerManager extends CacheManager<number, CADServer, CADServerAPIStruct> {
+  constructor(instance: Instance, manager: CADManager) {
+    super(instance, CADServer, []);
+
+    (async () => {
+      try {
+        const serversRes: any = await manager.rest?.request('GET_SERVERS');
+        const servers = JSON.parse(serversRes).servers;
+        servers.forEach((server: CADServerAPIStruct) => {
+          const serverStruct = {
+            id: server.id,
+            config: server
+          };
+          this._add(serverStruct, true, server.id);
+        });
+      } catch (err) {
+        throw new Error(String(err));
+      }
+    })();
+  }
 }

package/src/managers/CMSManager.ts

@@ -3,7 +3,6 @@ import { CMSSubscriptionVersionEnum } from '../constants';
 import { APIError, DefaultCMSRestOptions, REST } from '../libs/rest/src';
 import { BaseManager } from './BaseManager';
 import * as globalTypes from '../constants';
-import type { Mutable } from '../constants';
 import { CMSServerManager } from './CMSServerManager';
 
 /**
@@ -25,12 +24,16 @@ export class CMSManager extends BaseManager {
   protected async buildManager(instance: Instance) {
     try {
       const versionResp: any = await this.rest?.request('GET_SUB_VERSION');
-      const mutableThis = this as Mutable<CMSManager>;
-      mutableThis.version = Number.parseInt(versionResp.replace(/(^\d+)(.+$)/i,'$1'));
-      if (this.version >= globalTypes.CMSSubscriptionVersionEnum.STANDARD) {
+      const version = Number.parseInt(versionResp.replace(/(^\d+)(.+$)/i,'$1'));
+      const mutableThis = this as globalTypes.Mutable<CMSManager>;
+      if (version >= globalTypes.CMSSubscriptionVersionEnum.STANDARD) {
         this.servers = new CMSServerManager(instance, this);
       }
       mutableThis.ready = true;
+      mutableThis.version = version;
+      console.log(mutableThis.version);
+      console.log(this.version);
+      console.log(version);
       instance.isCMSSuccessful = true;
       instance.emit('CMS_SETUP_SUCCESSFUL');
     } catch (err) {
@@ -67,6 +70,26 @@ export class CMSManager extends BaseManager {
     });
   }
 
+  /**
+   * Gets a full whitelist allowed list for a specific server.
+   * @param {number} serverId (Optional) Server ID to get the whole allow list for, if not specified it will grab the default server ID that is set.
+   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed and the account data object if found.
+   */
+  public async getFullWhitelist(serverId?: number): Promise<globalTypes.CMSGetFullWhitelistPromiseResult> {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const getFullWhitelistRequest: any = await this.rest?.request('FULL_WHITELIST', serverId ?? this.instance.cmsDefaultServerId);
+        resolve({ success: true, data: getFullWhitelistRequest });
+      } catch (err) {
+        if (err instanceof APIError) {
+          resolve({ success: false, reason: err.response });
+        } else {
+          reject(err);
+        }
+      }
+    });
+  }
+
   /**
    * Gets a community account by `accId`, `apiId`, or `username`.
    * @param {Object} params The object that contains parameters to get a community account.
@@ -75,10 +98,10 @@ export class CMSManager extends BaseManager {
    * @param {string} [data.username] The username to find a community account.
    * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed and the account data object if found.
    */
-  public async getComAccount(params: { accId?: string, apiId?: string, username?: string }): Promise<globalTypes.CMSGetComAccountPromiseResult> {
+  public async getComAccount(params: { accId?: string, apiId?: string, username?: string, discord?: string }): Promise<globalTypes.CMSGetComAccountPromiseResult> {
     return new Promise(async (resolve, reject) => {
       try {
-        const getAccountRequest: any = await this.rest?.request('GET_COM_ACCOUNT', params.apiId, params.username, params.accId);
+        const getAccountRequest: any = await this.rest?.request('GET_COM_ACCOUNT', params.apiId, params.username, params.accId, params.discord);
         resolve({ success: true, data: getAccountRequest });
       } catch (err) {
         if (err instanceof APIError) {
@@ -90,20 +113,44 @@ export class CMSManager extends BaseManager {
     });
   }
 
+  /**
+   * Gets a community account by `accId`, `apiId`, or `username`.
+   * @param {Object} params The object that contains parameters to get a community account.
+   * @param {string} [data.accId] (Optional) The account id to find a community account.
+   * @param {string} [data.apiId] (Optional) The api id to find a community account.
+   * @param {string} [data.username] (Optional) The username to find a community account.
+   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed and the account data object if found.
+   */
+  public async getAccountRanks(params: { accId?: string, apiId?: string, username?: string, discord?: string }): Promise<globalTypes.CMSGetAccountRanksPromiseResult> {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const getAccountRanksRequest: any = await this.rest?.request('GET_ACCOUNT_RANKS', params.apiId, params.username, params.accId, params.discord);
+        resolve({ success: true, data: getAccountRanksRequest });
+      } catch (err) {
+        if (err instanceof APIError) {
+          resolve({ success: false, reason: err.response });
+        } else {
+          reject(err);
+        }
+      }
+    });
+  }
+
   /**
    * Clocks in or out an account by `accId` or `apiId`.
    * @param {Object} data The object that contains critical data to clock in or out an account.
-   * @param {string} [data.accId] The account id to clock in or out.
-   * @param {string} [data.apiId] The api id to clock in or out.
+   * @param {string} [data.accId] (Optional) The account id to clock in or out.
+   * @param {string} [data.apiId] (Optional) The api id to clock in or out.
    * @param {boolean} [data.forceClockIn] If true, it will override any current clock in with a new clock in at the time of the request.
    * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
    */
   public async clockInOut(data: { accId?: string, apiId?: string, forceClockIn?: boolean }): Promise<globalTypes.CMSClockInOutPromiseResult> {
     return new Promise(async (resolve, reject) => {
       try {
-        const clockInOutRequest: any = await this.rest?.request('CLOCK_IN_OUT', data.apiId, data.accId, !!data.forceClockIn);
-        const clockInOutRequestString: string = clockInOutRequest as string;
-        resolve({ success: true, clockedIn: clockInOutRequestString.includes('CLOCKED IN') });
+        const clockInOutRequest = await this.rest?.request('CLOCK_IN_OUT', data.apiId, data.accId, !!data.forceClockIn);
+        const clockInOutResponse = clockInOutRequest as globalTypes.clockInOutRequest;
+        if (!clockInOutResponse) resolve({ success: false, reason: clockInOutRequest as string });
+        resolve({ success: true, clockedIn: clockInOutResponse.completed });
       } catch (err) {
         if (err instanceof APIError) {
           resolve({ success: false, reason: err.response });
@@ -133,4 +180,49 @@ export class CMSManager extends BaseManager {
       }
     });
   }
+
+  /**
+   * Gets all department information within the community CMS.
+   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+   */
+  public async getDepartments(): Promise<globalTypes.CMSGetDepartmentsPromiseResult> {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const getDepartmentsRequest: any = await this.rest?.request('GET_DEPARTMENTS');
+        resolve({ success: true, data: getDepartmentsRequest });
+      } catch (err) {
+        if (err instanceof APIError) {
+          resolve({ success: false, reason: err.response });
+        } else {
+          reject(err);
+        }
+      }
+    });
+  }
+
+  /**
+   * Sets a community account's ranks for the CMS community.
+   * @param {string} accountId The object that contains critical data to clock in or out an account.
+   * @param {Object} changes The object that contains change data for setting account ranks.
+   * @param {Object} [changes.set] (Optional) The object that contains primary and secondary data for setting account ranks.
+   * @param {string} [changes.set.primary] (Optional) The primary rank ID wanting to set to the account.
+   * @param {string} [changes.set.secondary] (Optional) The secondary rank ID(s) wanting to set to the account.
+   * @param {Array} [changes.add] (Optional) The secondary rank IDs wanting to add to the account.
+   * @param {Array} [changes.remove] (Optional) The secondary rank IDs wanting to remove to the account.
+   * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+   */
+  public async setAccountRanks(accountId: string, changes: globalTypes.CMSSetAccountRanksChangesObject): Promise<globalTypes.CMSSetAccountRanksPromiseResult> {
+    return new Promise(async (resolve, reject) => {
+      try {
+        const setAccountRanksRequest: any = await this.rest?.request('SET_ACCOUNT_RANKS', accountId, changes.set, changes.add, changes.remove);
+        resolve({ success: true, data: setAccountRanksRequest });
+      } catch (err) {
+        if (err instanceof APIError) {
+          resolve({ success: false, reason: err.response });
+        } else {
+          reject(err);
+        }
+      }
+    });
+  }
 }

package/src/managers/CMSServerManager.ts

@@ -9,6 +9,11 @@ export class CMSServerManager extends CacheManager<number, CMSServer, CMSServerA
     super(instance, CMSServer, []);
 
     (async () => {
+      while(!manager.ready) {
+        await new Promise((resolve) => {
+          setTimeout(resolve, 100);
+        });
+      } 
       try {
         const serversRes: any = await manager.rest?.request('GET_GAME_SERVERS');
         const servers = serversRes.servers;
@@ -19,6 +24,7 @@ export class CMSServerManager extends CacheManager<number, CMSServer, CMSServerA
           };
           this._add(serverStruct, true, server.id);
         });
+        console.log(`Found ${servers.length} servers`);
       } catch (err) {
         throw new Error(String(err));
       }

package/src/managers/CacheManager.ts

@@ -1,38 +1,38 @@
-import Collection from '@discordjs/collection';
-import { Instance } from '../instance/Instance';
-import { Constructable } from '../constants';
-import { DataManager } from './DataManager';
-
-export class CacheManager<K, Holds, R> extends DataManager<K, Holds, R> {
-  public _cache: Collection<any, any> | never;
-  protected constructor(instance: Instance, holds: Constructable<Holds>, iterable: Iterable<any>) {
-    super(instance, holds);
-    this._cache = new Collection();
-    if (iterable) {
-      for (const item of iterable) {
-        this._add(item);
-      }
-    }
-  }
-
-  get cache() {
-    return this._cache;
-  }
-
-  _add(data: any, cache: boolean = true, id?: K) {
-    const existing = this.cache.get(id ?? data.id);
-    if (existing) {
-      if (cache) {
-        existing._patch(data);
-        return existing;
-      }
-      const clone = existing._clone();
-      clone._patch(data);
-      return clone;
-    }
-
-    const entry = data;
-    if (cache) this.cache.set(id ?? entry.id, entry);
-    return entry;
-  }
+import Collection from '@discordjs/collection';
+import { Instance } from '../instance/Instance';
+import { Constructable } from '../constants';
+import { DataManager } from './DataManager';
+
+export class CacheManager<K, Holds, R> extends DataManager<K, Holds, R> {
+  public _cache: Collection<any, any> | never;
+  protected constructor(instance: Instance, holds: Constructable<Holds>, iterable: Iterable<any>) {
+    super(instance, holds);
+    this._cache = new Collection();
+    if (iterable) {
+      for (const item of iterable) {
+        this._add(item);
+      }
+    }
+  }
+
+  get cache() {
+    return this._cache;
+  }
+
+  _add(data: any, cache: boolean = true, id?: K) {
+    const existing = this.cache.get(id ?? data.id);
+    if (existing) {
+      if (cache) {
+        existing._patch(data);
+        return existing;
+      }
+      const clone = existing._clone();
+      clone._patch(data);
+      return clone;
+    }
+
+    const entry = data;
+    if (cache) this.cache.set(id ?? entry.id, entry);
+    return entry;
+  }
 }

package/src/managers/DataManager.ts

@@ -1,64 +1,64 @@
-import { Instance } from '../instance/Instance';
-import { BaseManager } from './BaseManager';
-import { GenericError } from '../errors';
-import { Constructable } from '../constants';
-
-import Collection from '@discordjs/collection';
-
-interface DataManagerInstanceObject {
-  id: string;
-}
-
-export class DataManager<_K, Holds, _R> extends BaseManager {
-  public holds: Constructable<Holds>;
-
-  constructor(instance: Instance, holds: any) {
-    super(instance);
-
-    /**
-     * The data structure belonging to this manager.
-     * @name DataManager#holds
-     * @type {Function}
-     * @private
-     * @readonly
-     */
-    this.holds = holds;
-  }
-
-  /**
-   * The cache of items for this manager.
-   * @type {Collection}
-   * @abstract
-   */
-  get cache(): Collection<any, any> {
-    throw new GenericError('NOT_IMPLEMENTED', 'get cache', this.constructor.name);
-  }
-
-  /**
-   * Resolves a data entry to a data Object.
-   * @param idOrInstance The id or instance of something in this Manager
-   * @returns {?Object} An instance from this Manager
-   */
-   public resolve(idOrInstance: string | object): object | null {
-    if (this.cache instanceof Collection) {
-      if (typeof idOrInstance === 'object') return idOrInstance;
-      if (typeof idOrInstance === 'string') return this.cache.get(idOrInstance) ?? null;
-    }
-    return null;
-  }
-
-  /**
-   * Resolves a data entry to an instance id.
-   * @param {string|Object} idOrInstance The id or instance of something in this Manager
-   * @returns {?Snowflake}
-   */
-  resolveId(idOrInstance: string | DataManagerInstanceObject): string | null {
-    if (typeof idOrInstance === 'object') return idOrInstance.id;
-    if (typeof idOrInstance === 'string') return idOrInstance;
-    return null;
-  }
-
-  valueOf() {
-    return this.cache;
-  }
+import { Instance } from '../instance/Instance';
+import { BaseManager } from './BaseManager';
+import { GenericError } from '../errors';
+import { Constructable } from '../constants';
+
+import Collection from '@discordjs/collection';
+
+interface DataManagerInstanceObject {
+  id: string;
+}
+
+export class DataManager<_K, Holds, _R> extends BaseManager {
+  public holds: Constructable<Holds>;
+
+  constructor(instance: Instance, holds: any) {
+    super(instance);
+
+    /**
+     * The data structure belonging to this manager.
+     * @name DataManager#holds
+     * @type {Function}
+     * @private
+     * @readonly
+     */
+    this.holds = holds;
+  }
+
+  /**
+   * The cache of items for this manager.
+   * @type {Collection}
+   * @abstract
+   */
+  get cache(): Collection<any, any> {
+    throw new GenericError('NOT_IMPLEMENTED', 'get cache', this.constructor.name);
+  }
+
+  /**
+   * Resolves a data entry to a data Object.
+   * @param idOrInstance The id or instance of something in this Manager
+   * @returns {?Object} An instance from this Manager
+   */
+   public resolve(idOrInstance: string | object): object | null {
+    if (this.cache instanceof Collection) {
+      if (typeof idOrInstance === 'object') return idOrInstance;
+      if (typeof idOrInstance === 'string') return this.cache.get(idOrInstance) ?? null;
+    }
+    return null;
+  }
+
+  /**
+   * Resolves a data entry to an instance id.
+   * @param {string|Object} idOrInstance The id or instance of something in this Manager
+   * @returns {?Snowflake}
+   */
+  resolveId(idOrInstance: string | DataManagerInstanceObject): string | null {
+    if (typeof idOrInstance === 'object') return idOrInstance.id;
+    if (typeof idOrInstance === 'string') return idOrInstance;
+    return null;
+  }
+
+  valueOf() {
+    return this.cache;
+  }
 }

package/src/structures/Base.ts

@@ -1,28 +1,28 @@
-import { Instance } from '../instance/Instance';
-import { flatten } from '../utils';
-
-export abstract class Base {
-  public instance: Instance;
-  constructor(instance: Instance) {
-    this.instance = instance;
-  }
-
-  public _clone() {
-    return Object.assign(Object.create(this), this);
-
-  }
-
-  public _patch(data: any) {
-    return data;
-  }
-
-  public _update(data: any) {
-    const clone = this._clone();
-    this._patch(data);
-    return clone;
-  }
-
-  public toJSON(...props: Record<string, boolean | string>[]): unknown {
-    return flatten(this, ...props);
-  }
+import { Instance } from '../instance/Instance';
+import { flatten } from '../utils';
+
+export abstract class Base {
+  public instance: Instance;
+  constructor(instance: Instance) {
+    this.instance = instance;
+  }
+
+  public _clone() {
+    return Object.assign(Object.create(this), this);
+
+  }
+
+  public _patch(data: any) {
+    return data;
+  }
+
+  public _update(data: any) {
+    const clone = this._clone();
+    this._patch(data);
+    return clone;
+  }
+
+  public toJSON(...props: Record<string, boolean | string>[]): unknown {
+    return flatten(this, ...props);
+  }
 }