@sonoransoftware/sonoran.js 1.0.18 → 1.0.20

package/dist/structures/CMSServer.d.ts

@@ -1,18 +1,18 @@
-import { Instance } from '../instance/Instance';
-import { Base } from './Base';
-export interface CMSServerData {
-    id: number;
-    config: CMSServerConfig;
-}
-export interface CMSServerConfig {
-    id: number;
-    name: string;
-    description: string;
-    allowedRanks: string[];
-    blockedRanks: string[];
-}
-export declare class CMSServer extends Base {
-    id: number;
-    config: CMSServerConfig;
-    constructor(instance: Instance, data: CMSServerData);
-}
+import { Instance } from '../instance/Instance';
+import { Base } from './Base';
+export interface CMSServerData {
+    id: number;
+    config: CMSServerConfig;
+}
+export interface CMSServerConfig {
+    id: number;
+    name: string;
+    description: string;
+    allowedRanks: string[];
+    blockedRanks: string[];
+}
+export declare class CMSServer extends Base {
+    id: number;
+    config: CMSServerConfig;
+    constructor(instance: Instance, data: CMSServerData);
+}

package/dist/structures/CMSServer.js

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CMSServer = void 0;
-const Base_1 = require("./Base");
-class CMSServer extends Base_1.Base {
-    constructor(instance, data) {
-        super(instance);
-        this.id = data.id;
-        this.config = data.config;
-    }
-}
-exports.CMSServer = CMSServer;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CMSServer = void 0;
+const Base_1 = require("./Base");
+class CMSServer extends Base_1.Base {
+    constructor(instance, data) {
+        super(instance);
+        this.id = data.id;
+        this.config = data.config;
+    }
+}
+exports.CMSServer = CMSServer;

package/dist/utils/index.d.ts

@@ -1 +1 @@
-export * from './utils';
+export * from './utils';

package/dist/utils/index.js

@@ -1,17 +1,17 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./utils"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./utils"), exports);

package/dist/utils/utils.d.ts

@@ -1,13 +1,13 @@
-export declare function mergeDefault(def: any, given: any): any;
-/**
- * Shallow-copies an object with its class/prototype intact.
- * @param {Object} obj Object to clone
- * @returns {Object}
- * @private
- */
-export declare function cloneObject(obj: any): any;
-export declare function flatten(obj: any, ...props: any[]): any;
-export declare function warnLog(message: string): void;
-export declare function infoLog(message: string): void;
-export declare function errorLog(message: string): void;
-export declare function debugLog(message: string): void;
+export declare function mergeDefault(def: any, given: any): any;
+/**
+ * Shallow-copies an object with its class/prototype intact.
+ * @param {Object} obj Object to clone
+ * @returns {Object}
+ * @private
+ */
+export declare function cloneObject(obj: any): any;
+export declare function flatten(obj: any, ...props: any[]): any;
+export declare function warnLog(message: string): void;
+export declare function infoLog(message: string): void;
+export declare function errorLog(message: string): void;
+export declare function debugLog(message: string): void;

package/dist/utils/utils.js

@@ -1,79 +1,79 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.debugLog = exports.errorLog = exports.infoLog = exports.warnLog = exports.flatten = exports.cloneObject = exports.mergeDefault = void 0;
-const collection_1 = require("@discordjs/collection");
-const isObject = (d) => typeof d === 'object' && d !== null;
-function mergeDefault(def, given) {
-    if (!given)
-        return def;
-    for (const key in def) {
-        if (!Object.prototype.hasOwnProperty.call(given, key) || given[key] === undefined) {
-            given[key] = def[key];
-        }
-        else if (given[key] === Object(given[key])) {
-            given[key] = mergeDefault(def[key], given[key]);
-        }
-    }
-    return given;
-}
-exports.mergeDefault = mergeDefault;
-/**
- * Shallow-copies an object with its class/prototype intact.
- * @param {Object} obj Object to clone
- * @returns {Object}
- * @private
- */
-function cloneObject(obj) {
-    return Object.assign(Object.create(obj), obj);
-}
-exports.cloneObject = cloneObject;
-function flatten(obj, ...props) {
-    if (!isObject(obj))
-        return obj;
-    const objProps = Object.keys(obj)
-        .filter((k) => !k.startsWith('_'))
-        .map((k) => ({ [k]: true }));
-    props = objProps.length ? Object.assign([...objProps], ...props) : Object.assign({}, ...props); // eslint-disable-line
-    const out = {};
-    for (let [prop, newProp] of Object.entries(props)) {
-        if (!newProp)
-            continue;
-        newProp = newProp === true ? prop : newProp;
-        const element = obj[prop];
-        const elemIsObj = isObject(element);
-        const valueOf = elemIsObj && typeof element.valueOf === 'function' ? element.valueOf() : null;
-        // If it's a Collection, make the array of keys
-        if (element instanceof collection_1.Collection)
-            out[newProp] = Array.from(element.keys());
-        // If the valueOf is a Collection, use its array of keys
-        else if (valueOf instanceof collection_1.Collection)
-            out[newProp] = Array.from(valueOf.keys());
-        // If it's an array, flatten each element
-        else if (Array.isArray(element))
-            out[newProp] = element.map(e => flatten(e));
-        // If it's an object with a primitive `valueOf`, use that value
-        else if (typeof valueOf !== 'object')
-            out[newProp] = valueOf;
-        // If it's a primitive
-        else if (!elemIsObj)
-            out[newProp] = element;
-    }
-    return out;
-}
-exports.flatten = flatten;
-function warnLog(message) {
-    return console.log(`[Sonoran.js - DEBUG] ${message}`);
-}
-exports.warnLog = warnLog;
-function infoLog(message) {
-    return console.log(`[Sonoran.js - INFO] ${message}`);
-}
-exports.infoLog = infoLog;
-function errorLog(message) {
-    return console.log(`[Sonoran.js - ERROR] ${message}`);
-}
-exports.errorLog = errorLog;
-function debugLog(message) {
-    return console.log(`[Sonoran.js - DEBUG] ${message}`);
-}
-exports.debugLog = debugLog;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debugLog = exports.errorLog = exports.infoLog = exports.warnLog = exports.flatten = exports.cloneObject = exports.mergeDefault = void 0;
+const collection_1 = require("@discordjs/collection");
+const isObject = (d) => typeof d === 'object' && d !== null;
+function mergeDefault(def, given) {
+    if (!given)
+        return def;
+    for (const key in def) {
+        if (!Object.prototype.hasOwnProperty.call(given, key) || given[key] === undefined) {
+            given[key] = def[key];
+        }
+        else if (given[key] === Object(given[key])) {
+            given[key] = mergeDefault(def[key], given[key]);
+        }
+    }
+    return given;
+}
+exports.mergeDefault = mergeDefault;
+/**
+ * Shallow-copies an object with its class/prototype intact.
+ * @param {Object} obj Object to clone
+ * @returns {Object}
+ * @private
+ */
+function cloneObject(obj) {
+    return Object.assign(Object.create(obj), obj);
+}
+exports.cloneObject = cloneObject;
+function flatten(obj, ...props) {
+    if (!isObject(obj))
+        return obj;
+    const objProps = Object.keys(obj)
+        .filter((k) => !k.startsWith('_'))
+        .map((k) => ({ [k]: true }));
+    props = objProps.length ? Object.assign([...objProps], ...props) : Object.assign({}, ...props); // eslint-disable-line
+    const out = {};
+    for (let [prop, newProp] of Object.entries(props)) {
+        if (!newProp)
+            continue;
+        newProp = newProp === true ? prop : newProp;
+        const element = obj[prop];
+        const elemIsObj = isObject(element);
+        const valueOf = elemIsObj && typeof element.valueOf === 'function' ? element.valueOf() : null;
+        // If it's a Collection, make the array of keys
+        if (element instanceof collection_1.Collection)
+            out[newProp] = Array.from(element.keys());
+        // If the valueOf is a Collection, use its array of keys
+        else if (valueOf instanceof collection_1.Collection)
+            out[newProp] = Array.from(valueOf.keys());
+        // If it's an array, flatten each element
+        else if (Array.isArray(element))
+            out[newProp] = element.map(e => flatten(e));
+        // If it's an object with a primitive `valueOf`, use that value
+        else if (typeof valueOf !== 'object')
+            out[newProp] = valueOf;
+        // If it's a primitive
+        else if (!elemIsObj)
+            out[newProp] = element;
+    }
+    return out;
+}
+exports.flatten = flatten;
+function warnLog(message) {
+    return console.log(`[Sonoran.js - DEBUG] ${message}`);
+}
+exports.warnLog = warnLog;
+function infoLog(message) {
+    return console.log(`[Sonoran.js - INFO] ${message}`);
+}
+exports.infoLog = infoLog;
+function errorLog(message) {
+    return console.log(`[Sonoran.js - ERROR] ${message}`);
+}
+exports.errorLog = errorLog;
+function debugLog(message) {
+    return console.log(`[Sonoran.js - DEBUG] ${message}`);
+}
+exports.debugLog = debugLog;

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

@@ -1,59 +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.
-}
+# 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.
+}
 ```