@sonoransoftware/sonoran.js 1.0.3 → 1.0.5

package/src/builders/index.ts

@@ -1,3 +1,3 @@
-export * from './cad';
-// export * from './cms';
+export * from './cad';
+// export * from './cms';
 // export * from './global';

package/src/constants.ts

@@ -132,6 +132,56 @@ export interface CMSCheckComApiIdPromiseResult {
 	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;
@@ -188,4 +238,12 @@ export interface CADGetAccountPromiseResult {
 		},
 		apiIds: string[];
 	}
+}
+
+export interface clockInOutRequest {
+	id: number;
+	notes: any[];
+	endTime: string;
+	completed: boolean;
+	startTime: string;
 }

package/src/errors/LibraryErrors.ts

@@ -1,43 +1,43 @@
-const messages = new Map();
-
-export class GenericError extends Error {
-  private readonly errCode: string;
-  constructor(key: string, ...args: Array<any>) {
-    super(GenericError.message(key, args));
-    this.errCode = key;
-    if (Error.captureStackTrace) Error.captureStackTrace(this, GenericError);
-  }
-
-  get name(): string {
-    return `${super.name} [${this.errCode}]`;
-  }
-
-  get code(): string {
-    return this.errCode;
-  }
-
-  /**
-   * Format the message for an error.
-   * @param {string} key Error key
-   * @param {Array<any>} args Arguments to pass for util format or as function args
-   * @returns {string} Formatted string
-   */
-  private static message(key: string, args: Array<any>): string {
-    if (typeof key !== 'string') throw new Error('Error message key must be a string');
-    const msg = messages.get(key);
-    if (!msg) throw new Error(`An invalid error message key was used: ${key}.`);
-    if (typeof msg === 'function') return msg(...args);
-    if (!args?.length) return msg;
-    args.unshift(msg);
-    return String(...args);
-  }
-}
-
-/**
- * Register an error code and message.
- * @param {string} sym Unique name for the error
- * @param {*} val Value of the error
- */
-export function register(sym: symbol, val: any): void {
-  messages.set(sym, typeof val === 'function' ? val : String(val));
+const messages = new Map();
+
+export class GenericError extends Error {
+  private readonly errCode: string;
+  constructor(key: string, ...args: Array<any>) {
+    super(GenericError.message(key, args));
+    this.errCode = key;
+    if (Error.captureStackTrace) Error.captureStackTrace(this, GenericError);
+  }
+
+  get name(): string {
+    return `${super.name} [${this.errCode}]`;
+  }
+
+  get code(): string {
+    return this.errCode;
+  }
+
+  /**
+   * Format the message for an error.
+   * @param {string} key Error key
+   * @param {Array<any>} args Arguments to pass for util format or as function args
+   * @returns {string} Formatted string
+   */
+  private static message(key: string, args: Array<any>): string {
+    if (typeof key !== 'string') throw new Error('Error message key must be a string');
+    const msg = messages.get(key);
+    if (!msg) throw new Error(`An invalid error message key was used: ${key}.`);
+    if (typeof msg === 'function') return msg(...args);
+    if (!args?.length) return msg;
+    args.unshift(msg);
+    return String(...args);
+  }
+}
+
+/**
+ * Register an error code and message.
+ * @param {string} sym Unique name for the error
+ * @param {*} val Value of the error
+ */
+export function register(sym: symbol, val: any): void {
+  messages.set(sym, typeof val === 'function' ? val : String(val));
 }

package/src/errors/Messages.ts

@@ -1,7 +1,7 @@
-import { register } from './LibraryErrors';
-
-const Messages: Record<string | number | symbol, any> = {
-  NOT_IMPLEMENTED: (what: string, name: string) => `Method ${what} not implemented on ${name}.`
-};
-
+import { register } from './LibraryErrors';
+
+const Messages: Record<string | number | symbol, any> = {
+  NOT_IMPLEMENTED: (what: string, name: string) => `Method ${what} not implemented on ${name}.`
+};
+
 for (const [name, message] of Object.entries(Messages)) register(Symbol(name), message);

package/src/errors/index.ts

@@ -1,2 +1,2 @@
-export * from './LibraryErrors';
+export * from './LibraryErrors';
 export * from './Messages';

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from './instance/Instance';
-export * from './builders';
-export * from './libs/rest/src';
+export * from './instance/Instance';
+export * from './builders';
+export * from './libs/rest/src';
 export { productEnums, CADNewDispatchBuilderOptions, CADSubscriptionVersionEnum, CMSSubscriptionVersionEnum } from './constants';

package/src/instance/Instance.ts

@@ -1,118 +1,118 @@
-import EventEmitter from 'events';
-
-import * as globalTypes from '../constants';
-import * as InstanceTypes from './instance.types';
-import { CADManager } from '../managers/CADManager';
-import { CMSManager } from '../managers/CMSManager';
-import { debugLog } from '../utils';
-
-export class Instance extends EventEmitter {
-  public cadCommunityId: string | undefined;
-  public cadApiKey: string | undefined;
-  public cadApiUrl: string = 'https://api.sonorancad.com';
-  public cadDefaultServerId: number = 1;
-  public isCADSuccessful: boolean = false;
-  public cmsCommunityId: string | undefined;
-  public cmsApiKey: string | undefined;
-  public cmsApiUrl: string = 'https://api.sonorancms.com';
-  public cmsDefaultServerId: number = 1;
-  public isCMSSuccessful: boolean = false;
-
-  public cad: CADManager | undefined;
-  public cms: CMSManager | undefined;
-
-  public debug: boolean = false;
-
-  constructor(options: InstanceTypes.InstanceOptions) {
-    super({ captureRejections: true });
-    if (options.debug) {
-      this.debug = options.debug;
-    }
-    if (Object.prototype.hasOwnProperty.call(options, 'apiKey') && Object.prototype.hasOwnProperty.call(options, 'communityId')) {
-      if (Object.prototype.hasOwnProperty.call(options, 'product')) {
-        switch (options.product) {
-          case globalTypes.productEnums.CAD: {
-            this.cadCommunityId = options.communityId;
-            this.cadApiKey = options.apiKey;
-            if (options.serverId !== undefined) {
-              this._debugLog(`Overriding default server id... ${options.serverId}`);
-              this.cadDefaultServerId = options.serverId;
-            }
-            if (Object.prototype.hasOwnProperty.call(options, 'cadApiUrl') && typeof options.cadApiUrl === 'string') {
-              this._debugLog(`Overriding CAD API Url... ${options.cadApiUrl}`);
-              this.cadApiUrl = options.cadApiUrl;
-            }
-            this._debugLog('About to initialize instance.');
-            this.initialize();
-            break;
-          }
-          case globalTypes.productEnums.CMS: {
-            this.cmsCommunityId = options.communityId;
-            this.cmsApiKey = options.apiKey;
-            if (options.serverId !== undefined) {
-              this._debugLog(`Overriding default server id... ${options.serverId}`);
-              this.cmsDefaultServerId = options.serverId;
-            }
-            if (Object.prototype.hasOwnProperty.call(options, 'cmsApiUrl') && typeof options.cmsApiUrl === 'string') {
-              this._debugLog(`Overriding CMS API URL... ${options.cmsApiUrl}`);
-              this.cmsApiUrl = options.cmsApiUrl;
-            }
-            this.initialize();
-            break;
-          }
-          default: {
-            throw new Error('Invalid product enum given for constructor.');
-          }
-        }
-      } else {
-        throw new Error('No product enum given when instancing.');
-      }
-    } else {
-      this.cadCommunityId = options.cadCommunityId;
-      this.cadApiKey = options.cadApiKey;
-      this.cmsCommunityId = options.cmsCommunityId;
-      this.cmsApiKey = options.cmsApiKey;
-
-      if (options.cadDefaultServerId !== undefined) {
-        this._debugLog(`Overriding default CAD server id... ${options.serverId}`);
-        this.cadDefaultServerId = options.cadDefaultServerId;
-      }
-      if (options.cmsDefaultServerId !== undefined) {
-        this._debugLog(`Overriding default CMS server id... ${options.serverId}`);
-        this.cmsDefaultServerId = options.cmsDefaultServerId;
-      }
-      if (Object.prototype.hasOwnProperty.call(options, 'cadApiUrl') && typeof options.cadApiUrl === 'string') {
-        this._debugLog(`Overriding CAD API Url... ${options.cadApiUrl}`);
-        this.cadApiUrl = options.cadApiUrl;
-      }
-      if (Object.prototype.hasOwnProperty.call(options, 'cmsApiUrl') && typeof options.cmsApiUrl === 'string') {
-        this._debugLog(`Overriding CMS API URL... ${options.cmsApiUrl}`);
-        this.cmsApiUrl = options.cmsApiUrl;
-      }
-      this.initialize();
-    }
-  }
-
-
-
-  private initialize() {
-    if (this.cadCommunityId && this.cadApiKey && this.cadApiUrl) {
-      this._debugLog('About to initialize CAD Manager');
-      this.cad = new CADManager(this);
-    } else {
-      this._debugLog('Not initializing CAD Manager due to a missing community id, api key, or api url.');
-    }
-    if (this.cmsCommunityId && this.cmsApiKey && this.cmsApiUrl) {
-      this._debugLog('About to initialize CMS Manager');
-      this.cms = new CMSManager(this);
-    } else {
-      this._debugLog('Not initializing CMS Manager due to a missing community id, api key, or api url.');
-    }
-  }
-
-  public _debugLog(message: string): void {
-    if (this.debug) {
-      debugLog(message);
-    }
-  }
+import EventEmitter from 'events';
+
+import * as globalTypes from '../constants';
+import * as InstanceTypes from './instance.types';
+import { CADManager } from '../managers/CADManager';
+import { CMSManager } from '../managers/CMSManager';
+import { debugLog } from '../utils';
+
+export class Instance extends EventEmitter {
+  public cadCommunityId: string | undefined;
+  public cadApiKey: string | undefined;
+  public cadApiUrl: string = 'https://api.sonorancad.com';
+  public cadDefaultServerId: number = 1;
+  public isCADSuccessful: boolean = false;
+  public cmsCommunityId: string | undefined;
+  public cmsApiKey: string | undefined;
+  public cmsApiUrl: string = 'https://api.sonorancms.com';
+  public cmsDefaultServerId: number = 1;
+  public isCMSSuccessful: boolean = false;
+
+  public cad: CADManager | undefined;
+  public cms: CMSManager | undefined;
+
+  public debug: boolean = false;
+
+  constructor(options: InstanceTypes.InstanceOptions) {
+    super({ captureRejections: true });
+    if (options.debug) {
+      this.debug = options.debug;
+    }
+    if (Object.prototype.hasOwnProperty.call(options, 'apiKey') && Object.prototype.hasOwnProperty.call(options, 'communityId')) {
+      if (Object.prototype.hasOwnProperty.call(options, 'product')) {
+        switch (options.product) {
+          case globalTypes.productEnums.CAD: {
+            this.cadCommunityId = options.communityId;
+            this.cadApiKey = options.apiKey;
+            if (options.serverId !== undefined) {
+              this._debugLog(`Overriding default server id... ${options.serverId}`);
+              this.cadDefaultServerId = options.serverId;
+            }
+            if (Object.prototype.hasOwnProperty.call(options, 'cadApiUrl') && typeof options.cadApiUrl === 'string') {
+              this._debugLog(`Overriding CAD API Url... ${options.cadApiUrl}`);
+              this.cadApiUrl = options.cadApiUrl;
+            }
+            this._debugLog('About to initialize instance.');
+            this.initialize();
+            break;
+          }
+          case globalTypes.productEnums.CMS: {
+            this.cmsCommunityId = options.communityId;
+            this.cmsApiKey = options.apiKey;
+            if (options.serverId !== undefined) {
+              this._debugLog(`Overriding default server id... ${options.serverId}`);
+              this.cmsDefaultServerId = options.serverId;
+            }
+            if (Object.prototype.hasOwnProperty.call(options, 'cmsApiUrl') && typeof options.cmsApiUrl === 'string') {
+              this._debugLog(`Overriding CMS API URL... ${options.cmsApiUrl}`);
+              this.cmsApiUrl = options.cmsApiUrl;
+            }
+            this.initialize();
+            break;
+          }
+          default: {
+            throw new Error('Invalid product enum given for constructor.');
+          }
+        }
+      } else {
+        throw new Error('No product enum given when instancing.');
+      }
+    } else {
+      this.cadCommunityId = options.cadCommunityId;
+      this.cadApiKey = options.cadApiKey;
+      this.cmsCommunityId = options.cmsCommunityId;
+      this.cmsApiKey = options.cmsApiKey;
+
+      if (options.cadDefaultServerId !== undefined) {
+        this._debugLog(`Overriding default CAD server id... ${options.serverId}`);
+        this.cadDefaultServerId = options.cadDefaultServerId;
+      }
+      if (options.cmsDefaultServerId !== undefined) {
+        this._debugLog(`Overriding default CMS server id... ${options.serverId}`);
+        this.cmsDefaultServerId = options.cmsDefaultServerId;
+      }
+      if (Object.prototype.hasOwnProperty.call(options, 'cadApiUrl') && typeof options.cadApiUrl === 'string') {
+        this._debugLog(`Overriding CAD API Url... ${options.cadApiUrl}`);
+        this.cadApiUrl = options.cadApiUrl;
+      }
+      if (Object.prototype.hasOwnProperty.call(options, 'cmsApiUrl') && typeof options.cmsApiUrl === 'string') {
+        this._debugLog(`Overriding CMS API URL... ${options.cmsApiUrl}`);
+        this.cmsApiUrl = options.cmsApiUrl;
+      }
+      this.initialize();
+    }
+  }
+
+
+
+  private initialize() {
+    if (this.cadCommunityId && this.cadApiKey && this.cadApiUrl) {
+      this._debugLog('About to initialize CAD Manager');
+      this.cad = new CADManager(this);
+    } else {
+      this._debugLog('Not initializing CAD Manager due to a missing community id, api key, or api url.');
+    }
+    if (this.cmsCommunityId && this.cmsApiKey && this.cmsApiUrl) {
+      this._debugLog('About to initialize CMS Manager');
+      this.cms = new CMSManager(this);
+    } else {
+      this._debugLog('Not initializing CMS Manager due to a missing community id, api key, or api url.');
+    }
+  }
+
+  public _debugLog(message: string): void {
+    if (this.debug) {
+      debugLog(message);
+    }
+  }
 }

package/src/instance/instance.types.ts

@@ -1,17 +1,17 @@
-import * as globalTypes from '../constants';
-
-export type InstanceOptions = {
-  communityId?: string;
-  apiKey?: string;
-  product?: globalTypes.productEnums;
-  serverId?: number;
-  cadCommunityId?: string;
-  cadApiKey?: string;
-  cadApiUrl?: string;
-  cadDefaultServerId?: number;
-  cmsCommunityId?: string;
-  cmsApiKey?: string;
-  cmsApiUrl?: string;
-  cmsDefaultServerId?: number;
-  debug?: boolean;
+import * as globalTypes from '../constants';
+
+export type InstanceOptions = {
+  communityId?: string;
+  apiKey?: string;
+  product?: globalTypes.productEnums;
+  serverId?: number;
+  cadCommunityId?: string;
+  cadApiKey?: string;
+  cadApiUrl?: string;
+  cadDefaultServerId?: number;
+  cmsCommunityId?: string;
+  cmsApiKey?: string;
+  cmsApiUrl?: string;
+  cmsDefaultServerId?: number;
+  debug?: boolean;
 };

package/src/libs/rest/src/index.ts

@@ -1,6 +1,6 @@
-export * from './lib/errors/APIError';
-export * from './lib/errors/HTTPError';
-export * from './lib/errors/RateLimitError';
-export * from './lib/RequestManager';
-export * from './lib/REST';
+export * from './lib/errors/APIError';
+export * from './lib/errors/HTTPError';
+export * from './lib/errors/RateLimitError';
+export * from './lib/RequestManager';
+export * from './lib/REST';
 export * from './lib/utils/constants';

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

@@ -183,7 +183,16 @@ export class REST extends EventEmitter {
 				return {
 					apiId: args[0],
 					username: args[1],
-					accId: args[2]
+					accId: args[2],
+					discord: args[3]
+				};
+			}
+			case 'GET_ACCOUNT_RANKS': {
+				return {
+					apiId: args[0],
+					username: args[1],
+					accId: args[2],
+					discord: args[3]
 				};
 			}
 			case 'CLOCK_IN_OUT': {
@@ -198,6 +207,14 @@ export class REST extends EventEmitter {
 					apiId: args[0]
 				};
 			}
+			case 'SET_ACCOUNT_RANKS': {
+				return {
+					accountId: args[0],
+					set: args[1].set,
+					add: args[1].add,
+					remove: args[1].remove,
+				};
+			}
 			default: {
 				return args;
 			}