@sonoransoftware/sonoran.js 1.0.0

package/.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: ['plugin:@typescript-eslint/recommended', 'prettier'],
+  parserOptions: {
+    sourceType: 'module',
+  },
+  rules: {
+    'prettier/prettier': 'error',
+  },
+  plugins: ['@typescript-eslint', 'prettier'],
+}

package/.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'es6',
+  arrowParens: 'always',
+  printWidth: 80,
+}

package/docs/CAD-Methods-and-Usage.md

@@ -0,0 +1,59 @@
+# Sonoran CAD Specific Methods & Usage
+The following methods can be accessed from the `cad` property of an instance.
+
+## Basic General Usage
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CAD
+});
+
+
+const whitelist = await instance.cad.getAccount('459798465498798432');
+```
+
+## getAccount(params)
+| Parameter   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| params.username | Yes | String | Must have at least apiId or accId |
+| params.apiId | Yes | String | Must have at least apiId or accId |
+
+Returns *accountResult*;
+| Property   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| accountResult.success | No | Boolean | Wether the whitelist verification was successful |
+| accountResult.account | Yes | Object | Object of the account data |
+| accountResult.reason | Yes | String | Fail reason if success is falsy |
+
+### Example Code
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS,
+  serverId: 2
+});
+
+// This will verify the whitelist of the given API ID or account ID for server id 2 as specified above
+const verification = await instance.cad.getAccount('459798465498798432');
+// This will verify the whitelist of the given API ID for server id 1 since I specified that
+const verification = await instance.cad.getAccount({
+  apiId: '459798465498798432',
+  serverId: 1
+});
+// OR
+// This will verify the whitelist of the given account ID for server id 1 since I specified that
+const verification = await instance.cad.getAccount({
+  accId: 'd5663516-ee35-11e9-9714-5600023b2434',
+  serverId: 1
+});
+
+if (verification.success) {
+  console.log('Success!', verification.reason);
+} else {
+  console.log('Unsuccessful', verfication.reason); // Log the reason it was unsuccessful.
+}
+```

package/docs/CMS-Methods-and-Usage.md

@@ -0,0 +1,212 @@
+# Sonoran CMS Specific Methods & Usage
+The following methods can be accessed from the `cms` property of an instance.
+
+## Basic General Usage
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS
+});
+
+
+const whitelist = await instance.cms.verifyWhitelist('459798465498798432');
+```
+
+## verifyWhitelist(whitelistOptions)
+| Parameter   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| whitelistOptions | Yes | String | May just be a string if you'd like to not specify any additional options such as serverId to which will default to the 1 as default or whatever was instanciated with the instance. |
+| whitelistOptions.apiId | Yes | String | Must have at least apiId or accId |
+| whitelistOptions.accId | Yes | String | Must have at least apiId or accId |
+| whitelistOptions.serverId | Yes | Number | Checks whitelist of specific server Id instead of default or set server ID at instance initialization.. |
+
+Returns *whitelistResult*;
+| Property   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| whitelistResult.success | No | Boolean | Wether the whitelist verification was successful |
+| whitelistResult.reason | Yes | String | Username if success is truthy, fail reason if success is falsy |
+
+### Example Code
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS,
+  serverId: 2
+});
+
+// This will verify the whitelist of the given API ID or account ID for server id 2 as specified above
+const verification = await instance.cms.verifyWhitelist('459798465498798432');
+// This will verify the whitelist of the given API ID for server id 1 since I specified that
+const verification = await 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
+const verification = await instance.cms.verifyWhitelist({
+  accId: 'd5663516-ee35-11e9-9714-5600023b2434',
+  serverId: 1
+});
+
+if (verification.success) {
+  console.log('Success!', verification.reason);
+} else {
+  console.log('Unsuccessful', verfication.reason); // Log the reason it was unsuccessful.
+}
+```
+
+## getComAccount(params)
+| Parameter   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| params.accId | Yes | String | Must have at least apiId, username or accId |
+| params.username | Yes | String | Must have at least apiId, username or accId |
+| params.apiId | Yes | String | Must have at least apiId, username or accId |
+
+Returns *accountResult*;
+| Property   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| accountResult.success | No | Boolean | Wether the whitelist verification was successful |
+| accountResult.account | Yes | Object | Object of the account data |
+| accountResult.reason | Yes | String | Fail reason if success is falsy |
+
+### Example Account Data Object
+```js
+{
+  accId: '67ceebae-ee63-43c1-a6a6-5234b2210abf',
+  active: true,
+  username: 'Dawson G.',
+  comName: 'Dawson G.',
+  primaryIdentifier: '1A-1',
+  secondaryIdentifiers: [],
+  primaryRank: 'fc2c3825-df41-4485-ad9a-6c2ac900b4f4', // Rank UUID
+  secondaryRanks: [
+    '331d4ece-b582-4c9c-885b-7060341cf482' // Rank UUID
+  ],
+  primaryDepartment: '00116ef0-9d22-491e-964c-1eb1b6ffd167', // Department UUID
+  secondaryDepartments: [
+    '7dbedb0e-4df2-4405-b241-cb5dee253ab8' // Department UUID
+  ],
+  joinDate: '2022-02-22 20:28:40.000 -0800',
+  totalRankPower: 100,
+  comOwner: true,
+  isBanned: false,
+  lastLogin: '2022-02-22 22:43:46.000 -0800',
+  activeApiIds: [
+    '235947056630333440'
+  ]
+}
+
+```
+
+### Example Code
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS
+});
+
+// This will get the community account with the given API ID if there's one found
+const comAccount = await instance.cms.getComAccount({
+  apiId: '235947056630333440'
+});
+// OR
+// This will get the community account with the given username if there's one found
+const comAccount = await instance.cms.getComAccount({
+  username: 'Dawson G.'
+});
+// OR
+// This will get the community account with the given account ID if there's one found
+const comAccount = await instance.cms.getComAccount({
+  accId: '67ceebae-ee63-43c1-a6a6-5234b2210abf'
+});
+
+if (comAccount.success) {
+  console.log('Success! Account data:', comAccount.data);
+} else {
+  console.log('Unsuccessful', comAccount.reason);
+}
+```
+
+## clockInOut(data)
+| Parameter   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| data.apiId | Yes | String | Must have at least apiId or accId |
+| data.accId | Yes | String | Must have at least apiId or accId |
+| data.forceClockIn | Yes | Boolean | Will start a new clock in and overrite any current clock in |
+
+Returns *clockResult*;
+| Property   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| clockResult.success | No | Boolean | Wether the whitelist verification was successful |
+| clockResult.clockedIn | Yes | Boolean | Wether the account was clocked in or out if success is truthy |
+| clockResult.reason | Yes | String | Fail reason if success is falsy |
+
+### Example Code
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS
+});
+
+// This will override any current clock in and will start a new one on the community account found by the specified API ID if found
+const clockResult = await instance.cms.clockInOut({
+  apiId: '235947056630333440',
+  forceClockIn: true
+});
+// OR
+// This will either clock in or out the community account found by the specified API ID if found.
+// Will determine to clock in or out depending on what is pending.
+const clockResult = await instance.cms.clockInOut({
+  apiId: '235947056630333440'
+});
+// OR
+// This will either clock in or out the community account found by the specified accId if found.
+// Will determine to clock in or out depending on what is pending.
+const clockResult = await instance.cms.clockInOut({
+  accId: '67ceebae-ee63-43c1-a6a6-5234b2210abf'
+});
+
+if (clockResult.success) {
+  console.log(`Success! Clocked in? ${clockResult.clockedIn ? 'Yes!' : 'No!'}`);
+} else {
+  console.log('Unsuccessful', comAccount.reason);
+}
+```
+
+## checkComApiId(apiId)
+| Parameter   |      Optional      |  Type |
+|----------|:-------------:|------:|
+| apiId | Yes | String |
+
+Returns *checkResult*;
+| Property   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| checkResult.success | No | Boolean | Wether the whitelist verification was successful |
+| checkResult.username | Yes | String | Username for the account found with the API ID given |
+| checkResult.reason | Yes | String | Fail reason if success is falsy |
+
+### Example Code
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS
+});
+
+const checkResult = await instance.cms.checkComApiId('235947056630333440');
+
+if (checkResult.success) {
+  console.log(`Success! Account found: ${checkResult.username}`);
+} else {
+  console.log('Unsuccessful', checkResult.reason);
+}
+```

package/docs/REST-Methods-and-Usage.md

@@ -0,0 +1,47 @@
+# REST Methods & Usage
+The following methods can be accessed from the `rest` property of an CAD Manager & CMS Manager.
+
+## Basic General Usage
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS
+});
+
+try {
+  const subVersion = await instance.cms.rest.request('GET_SUB_VERSION');
+  console.log(`Community version is: ${subVersion}`);
+} catch (err) {
+  console.log(err);
+}
+```
+
+## request(type, [...args])
+| Parameter   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| type | No | String | Must be a valid Sonoran API type (AllAPITypesType) |
+| ...args | Yes | Any | Arguments based on the type given to construct a proper API request |
+
+returns *requestResult*;
+| Parameter   |      Optional      |  Type | Note |
+|----------|:-------------:|------:|-----:|
+| requestResult | No | Any | Response body from given API request |
+
+### Example Code
+```js
+const Sonoran = require('sonoran.js');
+const instance = Sonoran.instance({
+  communityId: 'mycommunity',
+  apiKey: 'e6ba9d68-ca7a-4e59-a9e2-93e275b4e0bf',
+  product: Sonoran.productEnums.CMS
+});
+
+try {
+  const responseData = await instance.cms.rest.request('VERIFY_WHITELIST', '235947056630333440', undefined, instance.defaultServerId);
+  console.log(responseData);
+} catch (err) {
+  console.log(err);
+}
+```

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@sonoransoftware/sonoran.js",
+  "version": "1.0.0",
+  "description": "Sonoran.js is a library that allows you to interact with the Sonoran CAD and Sonoran CMS API. Based off of and utilizes several Discord.js library techniques for ease of use.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "ts-node src/index.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Sonoran-Software/Sonoran.js.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^17.0.21",
+    "@types/node-fetch": "^2.6.1",
+    "eslint": "^8.10.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "^2.5.1",
+    "ts-loader": "^9.2.7",
+    "ts-node": "^10.7.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.6.2"
+  },
+  "engines": {
+    "node": ">=16.9.0"
+  },
+  "nodemonConfig": {
+    "ext": "*.ts, *.json"
+  },
+  "dependencies": {
+    "@discordjs/collection": "^0.5.0",
+    "@sapphire/async-queue": "^1.3.0",
+    "@sapphire/snowflake": "^3.2.0",
+    "node-fetch": "^2.6.5"
+  }
+}

package/readme.md

@@ -0,0 +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
+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/builders/cad/DispatchCall.ts

@@ -0,0 +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 };
+  }
+}

package/src/builders/cad/index.ts

@@ -0,0 +1 @@
+export * from './DispatchCall';

package/src/builders/index.ts

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