@sonoransoftware/sonoran.js 1.0.2 → 1.0.5

package/src/builders/cad/DispatchCall.ts

@@ -1,159 +1,159 @@
-import { CADNewDispatchBuilderOptions } from '../../constants';
-import { CADDispatchOriginEnums, CADDispatchStatusEnums } from '../../libs/rest/src';
-
-/**
- * Represents a constructed dispatch call for API requests
- */
-export class DispatchCallBuilder {
-  public readonly data: CADNewDispatchBuilderOptions;
-
-  /**
-   * Dispatch Call Builder used for API calls with Sonoran CAD to create a new dispatch call.
-   * @param data Data Options (CADNewDispatchBuilderOptions) used to build the new dispatch call
-   */
-  public constructor(data: CADNewDispatchBuilderOptions = {}) {
-    this.data = { ...data };
-  }
-
-  /**
-	 * Sets the origin for this dispatch call
-   * @param origin Origin enum used for this dispatch call for information purposes
-	 */
-  public setOrigin(origin: CADDispatchOriginEnums): this {
-    this.data.origin = origin;
-    return this;
-  }
-
-  /**
-	 * Sets the status for this dispatch call
-   * @param status Status enum used for the dispatch call for information purposes
-	 */
-  public setStatus(status: CADDispatchStatusEnums): this {
-    this.data.status = status;
-    return this;
-  }
-
-  /**
-	 * Sets the priority level for this dispatch call
-   * @param priority Priority level used for the dispatch call for information purposes
-	 */
-  public setPriority(priority: 1 | 2 | 3): this {
-    this.data.priority = priority;
-    return this;
-  }
-
-  /**
-	 * Sets the block for this dispatch call
-   * @param block Block used for the dispatch call for information purposes
-	 */
-  public setBlock(block: string): this {
-    this.data.block = block;
-    return this;
-  }
-
-  /**
-	 * Sets the address for this dispatch call
-   * @param address Address used for the dispatch call for information purposes
-	 */
-  public setAddress(address: string): this {
-    this.data.address = address;
-    return this;
-  }
-
-  /**
-	 * Sets the postal for this dispatch call
-   * @param postal Postal used for the dispatch call for information purposes
-	 */
-  public setPostal(postal: string): this {
-    this.data.postal = postal;
-    return this;
-  }
-
-  /**
-	 * Sets the title for this dispatch call
-   * @param title Title used for the dispatch call for information purposes
-	 */
-  public setTitle(title: string): this {
-    this.data.title = title;
-    return this;
-  }
-
-  /**
-	 * Sets the code for this dispatch call
-   * @param code Code used for the dispatch call for information purposes
-	 */
-  public setCode(code: string): this {
-    this.data.code = code;
-    return this;
-  }
-
-  /**
-	 * Sets the primary tracking preference for this dispatch call
-   * @param primaryUnit Primary unit identifier
-	 */
-  public setPrimary(primaryUnit: number): this {
-    this.data.primary = primaryUnit;
-    return this;
-  }
-
-  /**
-	 * Sets the track primary preference for this dispatch call
-   * @param preference Preference for tracking primary
-	 */
-  public setTrackPrimaryPreference(preference: boolean): this {
-    this.data.trackPrimary = preference;
-    return this;
-  }
-
-  /**
-	 * Sets the description for this dispatch call
-   * @param description Description for a dispatch call
-	 */
-  public setDescription(description: string): this {
-    this.data.description = description;
-    return this;
-  }
-
-  /**
-	 * Sets metadata for this dispatch call that can be used later on
-   * @param metaData Dictionary of metadata to store with a dispatch call, can be used later on
-	 */
-  public setMetadata(metaData: Record<string, string>): this {
-    this.data.metaData = metaData;
-    return this;
-  }
-
-  /**
-	 * Sets specified units for this dispatch call
-   * @param units Units to be removed from a call
-	 */
-  public setUnits(units: string[]): this {
-    this.data.units = units;
-    return this;
-  }
-
-  /**
-	 * Adds specified units from this dispatch call
-   * @param units Units to be removed from a call
-	 */
-  public addUnits(...units: string[]): this {
-    this.data.units?.push(...units);
-    return this;
-  }
-
-  /**
-	 * Removes specified units from this dispatch call
-   * @param units Units to be removed from a call
-	 */
-  public removeUnits(...units: string[]): this {
-    this.data.units?.filter((unit) => !units.includes(unit));
-    return this;
-  }
-
-  /**
-	 * Transforms the dispatch call to a plain object
-	 */
-  public toJSON(): CADNewDispatchBuilderOptions{
-    return { ...this.data };
-  }
+import { CADNewDispatchBuilderOptions } from '../../constants';
+import { CADDispatchOriginEnums, CADDispatchStatusEnums } from '../../libs/rest/src';
+
+/**
+ * Represents a constructed dispatch call for API requests
+ */
+export class DispatchCallBuilder {
+  public readonly data: CADNewDispatchBuilderOptions;
+
+  /**
+   * Dispatch Call Builder used for API calls with Sonoran CAD to create a new dispatch call.
+   * @param data Data Options (CADNewDispatchBuilderOptions) used to build the new dispatch call
+   */
+  public constructor(data: CADNewDispatchBuilderOptions = {}) {
+    this.data = { ...data };
+  }
+
+  /**
+	 * Sets the origin for this dispatch call
+   * @param origin Origin enum used for this dispatch call for information purposes
+	 */
+  public setOrigin(origin: CADDispatchOriginEnums): this {
+    this.data.origin = origin;
+    return this;
+  }
+
+  /**
+	 * Sets the status for this dispatch call
+   * @param status Status enum used for the dispatch call for information purposes
+	 */
+  public setStatus(status: CADDispatchStatusEnums): this {
+    this.data.status = status;
+    return this;
+  }
+
+  /**
+	 * Sets the priority level for this dispatch call
+   * @param priority Priority level used for the dispatch call for information purposes
+	 */
+  public setPriority(priority: 1 | 2 | 3): this {
+    this.data.priority = priority;
+    return this;
+  }
+
+  /**
+	 * Sets the block for this dispatch call
+   * @param block Block used for the dispatch call for information purposes
+	 */
+  public setBlock(block: string): this {
+    this.data.block = block;
+    return this;
+  }
+
+  /**
+	 * Sets the address for this dispatch call
+   * @param address Address used for the dispatch call for information purposes
+	 */
+  public setAddress(address: string): this {
+    this.data.address = address;
+    return this;
+  }
+
+  /**
+	 * Sets the postal for this dispatch call
+   * @param postal Postal used for the dispatch call for information purposes
+	 */
+  public setPostal(postal: string): this {
+    this.data.postal = postal;
+    return this;
+  }
+
+  /**
+	 * Sets the title for this dispatch call
+   * @param title Title used for the dispatch call for information purposes
+	 */
+  public setTitle(title: string): this {
+    this.data.title = title;
+    return this;
+  }
+
+  /**
+	 * Sets the code for this dispatch call
+   * @param code Code used for the dispatch call for information purposes
+	 */
+  public setCode(code: string): this {
+    this.data.code = code;
+    return this;
+  }
+
+  /**
+	 * Sets the primary tracking preference for this dispatch call
+   * @param primaryUnit Primary unit identifier
+	 */
+  public setPrimary(primaryUnit: number): this {
+    this.data.primary = primaryUnit;
+    return this;
+  }
+
+  /**
+	 * Sets the track primary preference for this dispatch call
+   * @param preference Preference for tracking primary
+	 */
+  public setTrackPrimaryPreference(preference: boolean): this {
+    this.data.trackPrimary = preference;
+    return this;
+  }
+
+  /**
+	 * Sets the description for this dispatch call
+   * @param description Description for a dispatch call
+	 */
+  public setDescription(description: string): this {
+    this.data.description = description;
+    return this;
+  }
+
+  /**
+	 * Sets metadata for this dispatch call that can be used later on
+   * @param metaData Dictionary of metadata to store with a dispatch call, can be used later on
+	 */
+  public setMetadata(metaData: Record<string, string>): this {
+    this.data.metaData = metaData;
+    return this;
+  }
+
+  /**
+	 * Sets specified units for this dispatch call
+   * @param units Units to be removed from a call
+	 */
+  public setUnits(units: string[]): this {
+    this.data.units = units;
+    return this;
+  }
+
+  /**
+	 * Adds specified units from this dispatch call
+   * @param units Units to be removed from a call
+	 */
+  public addUnits(...units: string[]): this {
+    this.data.units?.push(...units);
+    return this;
+  }
+
+  /**
+	 * Removes specified units from this dispatch call
+   * @param units Units to be removed from a call
+	 */
+  public removeUnits(...units: string[]): this {
+    this.data.units?.filter((unit) => !units.includes(unit));
+    return this;
+  }
+
+  /**
+	 * Transforms the dispatch call to a plain object
+	 */
+  public toJSON(): CADNewDispatchBuilderOptions{
+    return { ...this.data };
+  }
 }

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

@@ -74,26 +74,41 @@ export interface CMSVerifyWhitelistPromiseResult {
 	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;
-		active: boolean;
-		accName: string;
-		comName: string;
+		sysStatus: boolean;
+		comStatus: boolean;
+		joinDate: string;
+		lastLogin: string;
+		owner: boolean;
+		banned: boolean;
+		activeApiIds: string[];
 		primaryIdentifier: string;
-		secondaryIdentifiers: string[];
+		secondaryIdentifiers: {
+			identifiers: { id: string; label: string; }[];
+		}
 		primaryRank: string;
 		secondaryRanks: string[];
 		primaryDepartment: string;
 		secondaryDepartments: string[];
-		joinDate: string;
-		totalRankPower: number;
-		comOwner: boolean;
-		isBanned: boolean;
-		lastLogin: string;
-		activeApiIds: string[];
 	}
 }
 
@@ -117,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;
@@ -142,6 +207,7 @@ export interface CADGetAccountPromiseResult {
 			polEditUnit: boolean;
 			polEditOtherUnit: boolean;
 			selfDispatch: boolean;
+			liveMap: boolean;
 			medRecAdd: boolean;
 			medRecEdit: boolean;
 			medRecRemove: boolean;
@@ -154,6 +220,7 @@ export interface CADGetAccountPromiseResult {
 			dmvRecEdit: boolean;
 			dmvRecRemove: boolean;
 			dmvSuper: boolean;
+			modifyStreetSigns: boolean;
 			lawRecAdd: boolean;
 			lawRecEdit: boolean;
 			lawRecRemove: boolean;
@@ -171,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,12 +1,4 @@
-export * from './instance/Instance';
-export * from './builders';
-export * from './libs/rest/src';
-
-import { productEnums, CADNewDispatchBuilderOptions, CADSubscriptionVersionEnum, CMSSubscriptionVersionEnum } from './constants';
-
-export {
-  productEnums,
-  CADNewDispatchBuilderOptions,
-  CADSubscriptionVersionEnum,
-  CMSSubscriptionVersionEnum
-}
+export * from './instance/Instance';
+export * from './builders';
+export * from './libs/rest/src';
+export { productEnums, CADNewDispatchBuilderOptions, CADSubscriptionVersionEnum, CMSSubscriptionVersionEnum } from './constants';