diff --git a/.env b/.env index cc1cc7d..6f9dd1b 100644 --- a/.env +++ b/.env @@ -3,9 +3,11 @@ NODE_ENV=dev PORT=80 PORT_DEV=8080 -LOG_LEVEL=verbose -LOG_TARGET=file +LOG_LEVEL=0 +LOG_CONSOLE=true LOG_PATH=logs.log +LOG_NET_HOST=127.0.0.1 +LOG_NET_PORT=21 DATABASE_HOST=localhost DATABASE_PORT=5432 diff --git a/client/public/components/components.js b/client/public/components/components.js index 4464bdc..c951e3c 100644 --- a/client/public/components/components.js +++ b/client/public/components/components.js @@ -43,7 +43,7 @@ async function loadComponents() { // needs to be before the shadow dom is attatched component = component.replace('${innerText}', this.innerText); - const shadow = this.attachShadow({ mode: 'open '}); + const shadow = this.attachShadow({ mode: 'open' }); shadow.innerHTML = component; diff --git a/db/error.txt b/db/error.txt index 5494dd8..d36be23 100644 --- a/db/error.txt +++ b/db/error.txt @@ -1099,3 +1099,46 @@ https://img.bricklink.com/ItemImage/SL/9605-3.png https://img.bricklink.com/ItemImage/SL/6307625-1.png https://img.bricklink.com/ItemImage/SL/65152-1.png https://img.bricklink.com/ItemImage/SL/undefined.png +https://img.bricklink.com/ItemImage/PL/0011-2.png +https://img.bricklink.com/ItemImage/PL/0012-1.png +https://img.bricklink.com/ItemImage/PL/0013-1.png +https://img.bricklink.com/ItemImage/PL/0014-1.png +https://img.bricklink.com/ItemImage/PL/0015-1.png +https://img.bricklink.com/ItemImage/PL/0016-1.png +https://img.bricklink.com/ItemImage/PL/032-1.png +https://img.bricklink.com/ItemImage/PL/033-1.png +https://img.bricklink.com/ItemImage/PL/041-2.png +https://img.bricklink.com/ItemImage/PL/045-1.png +https://img.bricklink.com/ItemImage/PL/100-1.png +https://img.bricklink.com/ItemImage/PL/101-1.png +https://img.bricklink.com/ItemImage/PL/102-1.png +https://img.bricklink.com/ItemImage/PL/1023-1.png +https://img.bricklink.com/ItemImage/PL/1028-1.png +https://img.bricklink.com/ItemImage/PL/1029-1.png +https://img.bricklink.com/ItemImage/PL/103-1.png +https://img.bricklink.com/ItemImage/PL/1030-1.png +https://img.bricklink.com/ItemImage/PL/1031-1.png +https://img.bricklink.com/ItemImage/PL/1032-1.png +https://img.bricklink.com/ItemImage/PL/1033-1.png +https://img.bricklink.com/ItemImage/PL/1040-1.png +https://img.bricklink.com/ItemImage/PL/1041-1.png +https://img.bricklink.com/ItemImage/PL/1042-1.png +https://img.bricklink.com/ItemImage/PL/1043-1.png +https://img.bricklink.com/ItemImage/PL/1044-1.png +https://img.bricklink.com/ItemImage/PL/0011-2.png +https://img.bricklink.com/ItemImage/PL/0012-1.png +https://img.bricklink.com/ItemImage/PL/0013-1.png +https://img.bricklink.com/ItemImage/PL/0014-1.png +https://img.bricklink.com/ItemImage/PL/0015-1.png +https://img.bricklink.com/ItemImage/PL/0016-1.png +https://img.bricklink.com/ItemImage/PL/032-1.png +https://img.bricklink.com/ItemImage/PL/033-1.png +https://img.bricklink.com/ItemImage/PL/041-2.png +https://img.bricklink.com/ItemImage/PL/045-1.png +https://img.bricklink.com/ItemImage/PL/100-1.png +https://img.bricklink.com/ItemImage/PL/101-1.png +https://img.bricklink.com/ItemImage/PL/0011-2.png +https://img.bricklink.com/ItemImage/PL/0012-1.png +https://img.bricklink.com/ItemImage/PL/0013-1.png +https://img.bricklink.com/ItemImage/PL/0014-1.png +https://img.bricklink.com/ItemImage/PL/2339u.png diff --git a/db/imagestealer.js b/db/imagestealer.js index 9d5da40..5a60f89 100644 --- a/db/imagestealer.js +++ b/db/imagestealer.js @@ -5,7 +5,7 @@ const fs = require('fs'); const axios = require('axios'); // For sets make sets.txt -const parts = fs.readFileSync('res/Sets.txt', 'utf8').toString().split('\n').map((i) => i.split('\t')); +const parts = fs.readFileSync('res/Parts.txt', 'utf8').toString().split('\n').map((i) => i.split('\t')); async function timeout(ms) { return new Promise(resolve => setTimeout(resolve, ms)); @@ -15,10 +15,10 @@ async function downloadImage(url, filename) { try { const res = await axios.get(url, { method: 'GET', - headers: { 'User-Agent':'Chrome/96.0.4664.175' } , - responseType: 'stream' + headers: { 'User-Agent':'Chrome/96.0.4664.175' }, + responseType: 'stream', }); - + if (!res.data) { console.log(`${filename} failed to start downloading`); fs.appendFileSync('error.txt', `${url}\n`); @@ -31,19 +31,18 @@ async function downloadImage(url, filename) { console.log('downloaded file ' + filename); fs.appendFileSync('saved.txt', `${url}\n`); resolve(); - }) - + }); + res.data.on('error', () => { console.log('error downloading file ' + filename); fs.appendFileSync('error.txt', `${url}\n`); resolve(); - }) + }); }); } catch (e) { console.log(`${filename} failed to start downloading`); fs.appendFileSync('error.txt', `${url}\n`); - return; - } + } } async function main() { @@ -51,7 +50,8 @@ async function main() { const part = parts[i]; // for sets use https://img.bricklink.com/ItemImage/SL/${part[2]}.png // for for pieces use https://img.bricklink.com/ItemImage/PL/${part[2]}.png - const url = `https://img.bricklink.com/ItemImage/SL/${part[2]}.png`; + // https://img.bricklink.com/ItemImage/PL/3962a.png + const url = `https://img.bricklink.com/ItemImage/PL/${part[2]}.png`; const filename = `res/image/${part[2]}.png`; await downloadImage(url, filename); diff --git a/db/schema.sql b/db/schema.sql index 6e5dd07..adf8df6 100644 --- a/db/schema.sql +++ b/db/schema.sql @@ -90,3 +90,5 @@ CREATE TABLE IF NOT EXISTS set_descriptor ( FOREIGN KEY ( set_id ) REFERENCES lego_set( id ), FOREIGN KEY ( brick_id ) REFERENCES lego_brick( id ) ); + +past transactions diff --git a/docs/API.md b/docs/API.md new file mode 100644 index 0000000..8c2b127 --- /dev/null +++ b/docs/API.md @@ -0,0 +1,49 @@ +# API Documentation + +ALL API REQUESTS WILL BE PREFIXED WITH /api/ + +ALL AUTHENTICATION RELATED REQUESTS WILL BE PREFIXED WITH /api/auth/ +this is because the API has no state so middleware will authenticate +automatically every request + +## Routes + +| Type | Route | Queries | Auth? | Notes | +| --- | --- | --- | -- | --- | +| GET | /api/bricks/ | query, page | no | | +| GET | /api/sets/ | query, page | no | | +| GET | /api/brick/:id/ | | no | | +| GET | /api/set/:id/ | | no | | +| GET | /api/cdn/:id/ | | no | | +| PUT | /api/auth/login/ | | yes | | +| POST | /api/auth/signup/ | | yes | | +| GET | /api/auth/orders/ | | yes | | +| GET | /api/auth/basket/ | | yes | | +| PUT | /api/auth/basket/:id | quantity | yes | | +| POST | /api/auth/basket/:id | | yes | manipulate basket content | +| DEL | /api/auth/basket/:id | quantity | yes | if no id, delete whole | + +## Response Structure + +```js +{ + status: 200, + error: false + result: { + // defined in the response description for each route + } +} +``` + +## Error Structure + +```js +{ + status: 400, + error: { + short: "Error doing x", + long: "y needs to be z", + } +} +``` + diff --git a/jsdoc/Database.html b/jsdoc/Database.html deleted file mode 100644 index da415ce..0000000 --- a/jsdoc/Database.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - JSDoc: Class: Database - - - - - - - - - - -
- -

Class: Database

- - - - - - -
- -
- -

Database(connection)

- -

The Database class is used to create a database instance.

- - -
- -
-
- - - - -

Constructor

- - - -

new Database(connection)

- - - - - - - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
connection - - -object - - - -

An active instance of a psql database connection

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/jsdoc/Model.html b/jsdoc/Model.html deleted file mode 100644 index 2a43bcc..0000000 --- a/jsdoc/Model.html +++ /dev/null @@ -1,265 +0,0 @@ - - - - - JSDoc: Class: Model - - - - - - - - - - -
- -

Class: Model

- - - - - - -
- -
- -

Model(name, properties, dummy)

- -

The Model class is used to create a model instance.

- - -
- -
-
- - - - -

Constructor

- - - -

new Model(name, properties, dummy)

- - - - - - - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
name - - -string - - - -

The name of the model

properties - - -object - - - -

The properties of the model

dummy - - -boolean - - - -

Whether or not the model is a dummy model

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/jsdoc/entity-relationships.js.html b/jsdoc/entity-relationships.js.html deleted file mode 100644 index 6ef4075..0000000 --- a/jsdoc/entity-relationships.js.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - JSDoc: Source: entity-relationships.js - - - - - - - - - - -
- -

Source: entity-relationships.js

- - - - - - -
-
-
const Logger = require('../../logger.js');
-const DataTypes = require('./types.js');
-const DataConstraints = require('./relationships_constraints.js');
-const Model = require('./model.js');
-
-/**
- * In order to keep the models dynamic and flexible, we need to be able to add
- * new models to the database in whatever order the developer wants too. Without
- * them worrying about dependancies and such, we can just add them to the database
- * in the order they are defined. This class will handle that for us. As well as
- * keeping track of the models that have been added to the database.
- */
-
-
-/**
- * @class Database
- * @classdesc The Database class is used to create a database instance.
- * @param {object} connection - An active instance of a psql database connection
- */
-class PSQLObjectRelation {
-    constructor(psqlConnection) {
-        Logger.Database('ORM Loading...');
-        this.connection = psqlConnection;;
-        this.models = [];
-        // dummyModels are for models that have requested a model that doesn't exist
-        // the model that doesn't exist will be added here, and once it is added, the
-        // dummy dependancy will be resolved
-        this.dummyModels = [];
-    }
-
-    /**
-     * @function model
-     * @description Gets a model from the database stash
-     * @param {string} modelName - The name of the target model
-     */
-    model(modelName) {
-        // TODO: Resolve the dependancy if it dosen't exist and make a note of it
-        if (!this.models[modelName]) { 
-            Logger.Database(`Model ${modelName} does not exist, adding to dummyModels`);
-
-            if (this.dummyModels[modelName]) {
-                return this.dummyModels[modelName];
-            }
-
-            const dummy = new Model(modelName, {}, true);
-            this.dummyModels[modelName] = dummy;
-            return dummy;
-        }
-        return this.models[modelName];
-    }
-
-    /**
-     * @function addModel
-     * @description Adds a model to the database stash
-     * @param {string} name 
-     * @param {object} model
-     */
-    addModel(name, model) {
-        Logger.Database(`ORM Adding ${name}`);
-
-        if (this.models[name]) {
-            Logger.Error(`Redefinition of model ${name}, ignoring.`);
-            return;
-        }
-
-        const keys = Object.keys(model);
-
-        /**
-         * Make sure that every property has a type and a conatraints array
-         * If not, add it
-         * The structure should always look like:
-         * property: {
-         *   type: DataTypes.VARCHAR(50),
-         *   constraints: [ DataConstraints.PRIMARY_KEY, DataConstraints.NOT_NULL ]
-         * }
-         */
-        keys.forEach(key => {
-            if (typeof model[key] != 'object') {
-                const type = model[key];
-                model[key] = {
-                    type: type,
-                    constraints: []
-                };
-            }
-            if (!model[key].constraints) {
-                model[key].constraints = [];
-            }
-        });
-
-        this.models[name] = new Model(name, model);
-    }
-
-    /**
-     * @function resolveDependants
-     * @description Resolves all the dependancies for the models that have been added where properties weren't available when they were added
-     */
-    // TODO: Make this more maintainable
-    resolveDepends() {
-        for (const dummyModelName in this.dummyModels)
-        {
-            const dummyModel = this.dummyModels[dummyModelName];
-
-            if (!this.models[dummyModel.name]) {
-                Logger.Error(`Model ${dummyModel.name} does not exist, cannot resolve dependancies`);
-                continue;
-            }
-
-            for (const propertyName in dummyModel.properties)
-            {
-                const property = dummyModel.properties[propertyName];
-
-                if (property.type !== DataTypes.INHERET) {
-                    continue;
-                }
-
-                if (property.referers.length === 0 || property.referers[0] === '') {
-                    Logger.Error(`Model ${dummyModel.name} has a property ${propertyName} with no referers`);
-                    continue;
-                }
-
-                for (const referer of property.referers) {
-                    if (!this.models[referer]) {
-                        Logger.Error(`Model ${dummyModel.name} has a property ${propertyName} with a referer ${referer} that does not exist`);
-                        continue;
-                    }
-                    
-                    // TODO: Make more generic
-                    const relaventConstraints = this.models[referer].properties[dummyModelName].constraints;
-                    for (const constraint in relaventConstraints) {
-                        if (typeof relaventConstraints[constraint] === 'object') {
-                            this.models[referer].properties[dummyModelName].constraints[constraint] = DataConstraints.FOREIGN_KEY_REF(dummyModel.name);
-                            Logger.Database(`Model ${referer} has a property ${dummyModel.name} which was resolved to a foreign key`);
-                            break;
-                        }
-                    }
-
-                    this.dummyModels.splice(this.dummyModels.indexOf(dummyModel), 1);
-                }
-            }
-        }
-    }
-
-    /**
-     * @function syncModels
-     * @description Syncs the models to the database
-     * ONLY run this after all models are properly added
-     */
-    async syncModels() {
-        Logger.Database('ORM Syncing...');
-        this.resolveDepends();
-        console.log(this.models['lego_brick']);
-    }
-}
-
-module.exports = PSQLObjectRelation;
-
-
-
- - - - -
- - - -
- - - - - - - diff --git a/jsdoc/fonts/OpenSans-Bold-webfont.eot b/jsdoc/fonts/OpenSans-Bold-webfont.eot deleted file mode 100644 index 5d20d91..0000000 Binary files a/jsdoc/fonts/OpenSans-Bold-webfont.eot and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-Bold-webfont.svg b/jsdoc/fonts/OpenSans-Bold-webfont.svg deleted file mode 100644 index 3ed7be4..0000000 --- a/jsdoc/fonts/OpenSans-Bold-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/jsdoc/fonts/OpenSans-Bold-webfont.woff b/jsdoc/fonts/OpenSans-Bold-webfont.woff deleted file mode 100644 index 1205787..0000000 Binary files a/jsdoc/fonts/OpenSans-Bold-webfont.woff and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-BoldItalic-webfont.eot b/jsdoc/fonts/OpenSans-BoldItalic-webfont.eot deleted file mode 100644 index 1f639a1..0000000 Binary files a/jsdoc/fonts/OpenSans-BoldItalic-webfont.eot and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-BoldItalic-webfont.svg b/jsdoc/fonts/OpenSans-BoldItalic-webfont.svg deleted file mode 100644 index 6a2607b..0000000 --- a/jsdoc/fonts/OpenSans-BoldItalic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/jsdoc/fonts/OpenSans-BoldItalic-webfont.woff b/jsdoc/fonts/OpenSans-BoldItalic-webfont.woff deleted file mode 100644 index ed760c0..0000000 Binary files a/jsdoc/fonts/OpenSans-BoldItalic-webfont.woff and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-Italic-webfont.eot b/jsdoc/fonts/OpenSans-Italic-webfont.eot deleted file mode 100644 index 0c8a0ae..0000000 Binary files a/jsdoc/fonts/OpenSans-Italic-webfont.eot and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-Italic-webfont.svg b/jsdoc/fonts/OpenSans-Italic-webfont.svg deleted file mode 100644 index e1075dc..0000000 --- a/jsdoc/fonts/OpenSans-Italic-webfont.svg +++ /dev/null @@ -1,1830 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/jsdoc/fonts/OpenSans-Italic-webfont.woff b/jsdoc/fonts/OpenSans-Italic-webfont.woff deleted file mode 100644 index ff652e6..0000000 Binary files a/jsdoc/fonts/OpenSans-Italic-webfont.woff and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-Light-webfont.eot b/jsdoc/fonts/OpenSans-Light-webfont.eot deleted file mode 100644 index 1486840..0000000 Binary files a/jsdoc/fonts/OpenSans-Light-webfont.eot and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-Light-webfont.svg b/jsdoc/fonts/OpenSans-Light-webfont.svg deleted file mode 100644 index 11a472c..0000000 --- a/jsdoc/fonts/OpenSans-Light-webfont.svg +++ /dev/null @@ -1,1831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/jsdoc/fonts/OpenSans-Light-webfont.woff b/jsdoc/fonts/OpenSans-Light-webfont.woff deleted file mode 100644 index e786074..0000000 Binary files a/jsdoc/fonts/OpenSans-Light-webfont.woff and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-LightItalic-webfont.eot b/jsdoc/fonts/OpenSans-LightItalic-webfont.eot deleted file mode 100644 index 8f44592..0000000 Binary files a/jsdoc/fonts/OpenSans-LightItalic-webfont.eot and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-LightItalic-webfont.svg b/jsdoc/fonts/OpenSans-LightItalic-webfont.svg deleted file mode 100644 index 431d7e3..0000000 --- a/jsdoc/fonts/OpenSans-LightItalic-webfont.svg +++ /dev/null @@ -1,1835 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/jsdoc/fonts/OpenSans-LightItalic-webfont.woff b/jsdoc/fonts/OpenSans-LightItalic-webfont.woff deleted file mode 100644 index 43e8b9e..0000000 Binary files a/jsdoc/fonts/OpenSans-LightItalic-webfont.woff and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-Regular-webfont.eot b/jsdoc/fonts/OpenSans-Regular-webfont.eot deleted file mode 100644 index 6bbc3cf..0000000 Binary files a/jsdoc/fonts/OpenSans-Regular-webfont.eot and /dev/null differ diff --git a/jsdoc/fonts/OpenSans-Regular-webfont.svg b/jsdoc/fonts/OpenSans-Regular-webfont.svg deleted file mode 100644 index 25a3952..0000000 --- a/jsdoc/fonts/OpenSans-Regular-webfont.svg +++ /dev/null @@ -1,1831 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/jsdoc/fonts/OpenSans-Regular-webfont.woff b/jsdoc/fonts/OpenSans-Regular-webfont.woff deleted file mode 100644 index e231183..0000000 Binary files a/jsdoc/fonts/OpenSans-Regular-webfont.woff and /dev/null differ diff --git a/jsdoc/global.html b/jsdoc/global.html deleted file mode 100644 index aa0807b..0000000 --- a/jsdoc/global.html +++ /dev/null @@ -1,740 +0,0 @@ - - - - - JSDoc: Global - - - - - - - - - - -
- -

Global

- - - - - - -
- -
- -

- - -
- -
-
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - - - - - - - - - - - -

Methods

- - - - - - - -

addModel(name, model)

- - - - - - -
-

Adds a model to the database stash

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
name - - -string - - - -
model - - -object - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

model(modelName)

- - - - - - -
-

Gets a model from the database stash

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
modelName - - -string - - - -

The name of the target model

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

property(name)

- - - - - - -
-

Gets a property from the model

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
name - - -string - - - -

The name of the target property

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

resolveDependants()

- - - - - - -
-

Resolves all the dependancies for the models that have been added where properties weren't available when they were added

-
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

syncModels()

- - - - - - -
-

Syncs the models to the database -ONLY run this after all models are properly added

-
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/jsdoc/index.html b/jsdoc/index.html deleted file mode 100644 index 3013822..0000000 --- a/jsdoc/index.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - JSDoc: Home - - - - - - - - - - -
- -

Home

- - - - - - - - -

- - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/jsdoc/model.js.html b/jsdoc/model.js.html deleted file mode 100644 index a6f4093..0000000 --- a/jsdoc/model.js.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - - JSDoc: Source: model.js - - - - - - - - - - -
- -

Source: model.js

- - - - - - -
-
-
const Logger = require('../../logger.js');
-const DataTypes = require('./types.js');
-
-/**
- * @class Model
- * @classdesc The Model class is used to create a model instance.
- * @param {string} name - The name of the model
- * @param {object} properties - The properties of the model
- * @param {boolean} dummy - Whether or not the model is a dummy model
- */
-class Model {
-    constructor(name, properties, dummy = false) {
-        this.name = name;
-        this.properties = properties;
-        this.dummy = dummy;
-
-        if (dummy)
-            Logger.Database(`Model ${name} is dummy: ${dummy}`);
-        
-        Logger.Database(`Model ${name} created, with properties: ${JSON.stringify(properties)}`);
-    }
-
-    /**
-     * @function property
-     * @description Gets a property from the model
-     * @param {string} name - The name of the target property
-     */
-    property(name, referer = "") {
-        if (this.dummy)
-        {
-            if (this.properties[name]) {
-                this.properties[name].referers.push(referer);
-            }
-            this.properties[name] = {
-                type: DataTypes.INHERET,
-                referers: [referer],
-                constraints: [],
-                dummy: true
-            }
-            return "UNRESOVLED PROPERTY";
-        }
-        return this.property[name];
-    }
-}
-
-module.exports = Model;
-
-
-
- - - - -
- - - -
- - - - - - - diff --git a/jsdoc/scripts/linenumber.js b/jsdoc/scripts/linenumber.js deleted file mode 100644 index 4354785..0000000 --- a/jsdoc/scripts/linenumber.js +++ /dev/null @@ -1,25 +0,0 @@ -/*global document */ -(() => { - const source = document.getElementsByClassName('prettyprint source linenums'); - let i = 0; - let lineNumber = 0; - let lineId; - let lines; - let totalLines; - let anchorHash; - - if (source && source[0]) { - anchorHash = document.location.hash.substring(1); - lines = source[0].getElementsByTagName('li'); - totalLines = lines.length; - - for (; i < totalLines; i++) { - lineNumber++; - lineId = `line${lineNumber}`; - lines[i].id = lineId; - if (lineId === anchorHash) { - lines[i].className += ' selected'; - } - } - } -})(); diff --git a/jsdoc/scripts/prettify/Apache-License-2.0.txt b/jsdoc/scripts/prettify/Apache-License-2.0.txt deleted file mode 100644 index d645695..0000000 --- a/jsdoc/scripts/prettify/Apache-License-2.0.txt +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/jsdoc/scripts/prettify/lang-css.js b/jsdoc/scripts/prettify/lang-css.js deleted file mode 100644 index 041e1f5..0000000 --- a/jsdoc/scripts/prettify/lang-css.js +++ /dev/null @@ -1,2 +0,0 @@ -PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com", -/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]); diff --git a/jsdoc/scripts/prettify/prettify.js b/jsdoc/scripts/prettify/prettify.js deleted file mode 100644 index eef5ad7..0000000 --- a/jsdoc/scripts/prettify/prettify.js +++ /dev/null @@ -1,28 +0,0 @@ -var q=null;window.PR_SHOULD_USE_CONTINUATION=!0; -(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a= -[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m), -l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/, -q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/, -q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g, -"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a), -a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e} -for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"], -"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"], -H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"], -J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+ -I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]), -["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css", -/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}), -["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes", -hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b= -!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p th:last-child { border-right: 1px solid #ddd; } - -.ancestors, .attribs { color: #999; } -.ancestors a, .attribs a -{ - color: #999 !important; - text-decoration: none; -} - -.clear -{ - clear: both; -} - -.important -{ - font-weight: bold; - color: #950B02; -} - -.yes-def { - text-indent: -1000px; -} - -.type-signature { - color: #aaa; -} - -.name, .signature { - font-family: Consolas, Monaco, 'Andale Mono', monospace; -} - -.details { margin-top: 14px; border-left: 2px solid #DDD; } -.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; } -.details dd { margin-left: 70px; } -.details ul { margin: 0; } -.details ul { list-style-type: none; } -.details li { margin-left: 30px; padding-top: 6px; } -.details pre.prettyprint { margin: 0 } -.details .object-value { padding-top: 0; } - -.description { - margin-bottom: 1em; - margin-top: 1em; -} - -.code-caption -{ - font-style: italic; - font-size: 107%; - margin: 0; -} - -.source -{ - border: 1px solid #ddd; - width: 80%; - overflow: auto; -} - -.prettyprint.source { - width: inherit; -} - -.source code -{ - font-size: 100%; - line-height: 18px; - display: block; - padding: 4px 12px; - margin: 0; - background-color: #fff; - color: #4D4E53; -} - -.prettyprint code span.line -{ - display: inline-block; -} - -.prettyprint.linenums -{ - padding-left: 70px; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} - -.prettyprint.linenums ol -{ - padding-left: 0; -} - -.prettyprint.linenums li -{ - border-left: 3px #ddd solid; -} - -.prettyprint.linenums li.selected, -.prettyprint.linenums li.selected * -{ - background-color: lightyellow; -} - -.prettyprint.linenums li * -{ - -webkit-user-select: text; - -moz-user-select: text; - -ms-user-select: text; - user-select: text; -} - -.params .name, .props .name, .name code { - color: #4D4E53; - font-family: Consolas, Monaco, 'Andale Mono', monospace; - font-size: 100%; -} - -.params td.description > p:first-child, -.props td.description > p:first-child -{ - margin-top: 0; - padding-top: 0; -} - -.params td.description > p:last-child, -.props td.description > p:last-child -{ - margin-bottom: 0; - padding-bottom: 0; -} - -.disabled { - color: #454545; -} diff --git a/jsdoc/styles/prettify-jsdoc.css b/jsdoc/styles/prettify-jsdoc.css deleted file mode 100644 index 5a2526e..0000000 --- a/jsdoc/styles/prettify-jsdoc.css +++ /dev/null @@ -1,111 +0,0 @@ -/* JSDoc prettify.js theme */ - -/* plain text */ -.pln { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* string content */ -.str { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a keyword */ -.kwd { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a comment */ -.com { - font-weight: normal; - font-style: italic; -} - -/* a type name */ -.typ { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* a literal value */ -.lit { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* punctuation */ -.pun { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* lisp open bracket */ -.opn { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* lisp close bracket */ -.clo { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a markup tag name */ -.tag { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a markup attribute name */ -.atn { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a markup attribute value */ -.atv { - color: #006400; - font-weight: normal; - font-style: normal; -} - -/* a declaration */ -.dec { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* a variable name */ -.var { - color: #000000; - font-weight: normal; - font-style: normal; -} - -/* a function name */ -.fun { - color: #000000; - font-weight: bold; - font-style: normal; -} - -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { - margin-top: 0; - margin-bottom: 0; -} diff --git a/jsdoc/styles/prettify-tomorrow.css b/jsdoc/styles/prettify-tomorrow.css deleted file mode 100644 index b6f92a7..0000000 --- a/jsdoc/styles/prettify-tomorrow.css +++ /dev/null @@ -1,132 +0,0 @@ -/* Tomorrow Theme */ -/* Original theme - https://github.com/chriskempson/tomorrow-theme */ -/* Pretty printing styles. Used with prettify.js. */ -/* SPAN elements with the classes below are added by prettyprint. */ -/* plain text */ -.pln { - color: #4d4d4c; } - -@media screen { - /* string content */ - .str { - color: #718c00; } - - /* a keyword */ - .kwd { - color: #8959a8; } - - /* a comment */ - .com { - color: #8e908c; } - - /* a type name */ - .typ { - color: #4271ae; } - - /* a literal value */ - .lit { - color: #f5871f; } - - /* punctuation */ - .pun { - color: #4d4d4c; } - - /* lisp open bracket */ - .opn { - color: #4d4d4c; } - - /* lisp close bracket */ - .clo { - color: #4d4d4c; } - - /* a markup tag name */ - .tag { - color: #c82829; } - - /* a markup attribute name */ - .atn { - color: #f5871f; } - - /* a markup attribute value */ - .atv { - color: #3e999f; } - - /* a declaration */ - .dec { - color: #f5871f; } - - /* a variable name */ - .var { - color: #c82829; } - - /* a function name */ - .fun { - color: #4271ae; } } -/* Use higher contrast and text-weight for printable form. */ -@media print, projection { - .str { - color: #060; } - - .kwd { - color: #006; - font-weight: bold; } - - .com { - color: #600; - font-style: italic; } - - .typ { - color: #404; - font-weight: bold; } - - .lit { - color: #044; } - - .pun, .opn, .clo { - color: #440; } - - .tag { - color: #006; - font-weight: bold; } - - .atn { - color: #404; } - - .atv { - color: #060; } } -/* Style */ -/* -pre.prettyprint { - background: white; - font-family: Consolas, Monaco, 'Andale Mono', monospace; - font-size: 12px; - line-height: 1.5; - border: 1px solid #ccc; - padding: 10px; } -*/ - -/* Specify class=linenums on a pre to get line numbering */ -ol.linenums { - margin-top: 0; - margin-bottom: 0; } - -/* IE indents via margin-left */ -li.L0, -li.L1, -li.L2, -li.L3, -li.L4, -li.L5, -li.L6, -li.L7, -li.L8, -li.L9 { - /* */ } - -/* Alternate shading for lines */ -li.L1, -li.L3, -li.L5, -li.L7, -li.L9 { - /* */ } diff --git a/package.json b/package.json index 6de6d27..4e0c8de 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,6 @@ "test": "jest src/__test", "start": "node src/index.js", "dev": "nodemon src/index.js --watch src", - "gendoc": "jsdoc -r ./src/ ./client/ -c ./jsdoc.json -d ./jsdoc/", "lint": "eslint src --ext .js && eslint client --ext .js", "setup": "npm i" }, diff --git a/src/index.js b/src/index.js index e0a4772..e005720 100644 --- a/src/index.js +++ b/src/index.js @@ -6,9 +6,15 @@ const Databse = require('./database/database.js'); const ModelManager = require('./models/model-manager.js'); async function main() { - Logger.Info('Pre-Init Loading...'); - Logger.Init(); Config.Load(); + await Logger.Init({ + logLevel: process.env.LOG_LEVEL, + logToConsole: process.env.LOG_CONSOLE, + logFile: process.env.LOG_FILE, + networkHost: process.env.LOG_NET_HOST, + networkPort: process.env.LOG_NET_PORT, + }); + Logger.Info('Pre-Init Complete'); const Database = new Databse.IDatabase(); await Database.connect(); diff --git a/src/logger.js b/src/logger.js index e928807..c58c8e6 100644 --- a/src/logger.js +++ b/src/logger.js @@ -1,105 +1,168 @@ -// Better than Log4J 2021TM +// Better than Log4j2022 for now. -const clc = require('cli-color'); -const moment = require('moment'); +const net = require('net'); const fs = require('fs'); +const moment = require('moment'); +const clc = require('cli-color'); -let LogLevel = 0; -let logPath = 'logs.log'; -let dateFormat = 'DD-MM-YY HH:mm:ss' +const LEVEL_VERBOSE = 0; +const LEVEL_DEBUG = 1; +const LEVEL_INFO = 2; +const LEVEL_WARN = 3; +const LEVEL_STICK = 9; // regardless, will log -// must be ran after the config is initalised -// TODO: network logs -module.exports.Init = function (path) { - if (path) logPath = path; +let DoNetworkLogging = false; - // ALWAYS logs to console, others are aditionals - switch (process.env.LOG_TARGET) { - case 'console': - case 'file': - case 'network': - default: +// default values +let Options = { + logLevel: LEVEL_VERBOSE, + logToConsole: true, + logFile: null, + networkHost: null, + networkPort: null, +}; + +let Socket = null; + + +function getFormatedTimeString() { + return `[${moment().format('YYYY-MM-DD HH:mm:ss.SSS')}]`; +} + +// levelSource is the level that the source will log at ie, if levelSource is +// LEVEL_WARN, it will only log if the current level is at or above LEVEL_WARN. +function internalLog(type, message, cConsoleColour, levelSource) { + if (Options.logToConsole && (Options.logLevel <= levelSource)) { + console.log(`${getFormatedTimeString()} [${cConsoleColour(type)}] ${message}`); + } + const m = `${getFormatedTimeString()} [${type}] ${message}`; + if (Options.logFile) { + fs.appendFileSync(Options.logFile, m + '\n'); + } + if (Options.networkHost && DoNetworkLogging) { + Socket.write(m + '\n'); + } + if (type === 'PANIC') { + Destroy(); + process.exit(1); + } +} + +const Info = (...messages) => internalLog('INFO', messages.join(' '), clc.greenBright, LEVEL_INFO); +const Warn = (...messages) => internalLog('WARN', messages.join(' '), clc.yellowBright, LEVEL_WARN); +const Error = (...messages) => internalLog('ERROR', messages.join(' '), clc.redBright, LEVEL_STICK); +const Panic = (...messages) => internalLog('PANIC', messages.join(' '), clc.bgRedBright, LEVEL_STICK); +const Debug = (...messages) => internalLog('DEBUG', messages.join(' '), clc.cyanBright, LEVEL_DEBUG); +const Module = (module, ...messages) => internalLog('MODULE', `[${module}] ${messages.join(' ')}`, clc.blue, LEVEL_INFO); +const Database = (...messages) => internalLog('PSQL', `[DB] ${messages.join(' ')}`, clc.blue, LEVEL_INFO); +const ExpressLogger = (req, res, next) => { + internalLog('HTTP', `[${req.method}] ${req.originalUrl} FROM ${req.headers['x-forwarded-for'] || req.socket.remoteAddress}`, clc.magenta, LEVEL_VERBOSE); + next(); +}; + + +function startReconnection() { + const x = setInterval(async () => { + if (Options.networkHost && Options.networkPort && !DoNetworkLogging) { + const success = await initNetworkLogger(Options.networkHost, Options.networkPort); + if (success) { + clearInterval(x); + Info('Logger Reonnected'); + } + } + }, 30000); +} + +function initNetworkLogger(host, port) { + return new Promise((resolve) => { + Socket = net.connect({ + port, + host, + family: 4, + onread: { + // Reuses a 4KiB Buffer for every read from the socket. + buffer: Buffer.alloc(4 * 1024), + callback: function (nread, buf) { + Warn(`LogSocket: ${buf.toString('utf8', 0, nread)}`); + }, + }, + }, () => { + Info('Logger Connected to Network'); + DoNetworkLogging = true; + resolve(true); + }).on('error', (err) => { + Error('Logger Disconnected from Network: ', err); + DoNetworkLogging = false; + resolve(false); + }); + }); +} + +function postInit() { + Socket.on('close', () => { + Error('Logger Network Connection Closed'); + DoNetworkLogging = false; + startReconnection(); + }); + + Socket.on('error', (err) => { + Error('Logger Disconnected from Network: ', err); + DoNetworkLogging = false; + startReconnection(); + }); +} + +/** + * Initialises the logger + * Options: + * - logLevel: The level of logging to be used ONLY APPLIES TO CONSOLE. + * - logToConsole: Whether to log to the console. + * - logFile: The file to log to, if provided, will log. + * - networkHost: The address to log to, including port, if provided, will log. + * - networkPort: The port to log to, including port, if provided, will log. + * TODO: SSL + * @param {Object} options + */ +async function Init(options) { + Options = options; + + if (Options.logFile) { + fs.openSync(Options.logFile, 'w'); + fs.appendFileSync(Options.logFile, 'START OF SESSION' + '\n'); } - if (!fs.existsSync(logPath)) { - fs.writeFileSync(logPath, ''); + if (!Options.networkHost || !Options.networkPort) { + return; } - fs.appendFileSync(logPath, '[SYSTEM STARTING UP] \n'); + + await initNetworkLogger(Options.networkHost, Options.networkPort); + postInit(); } -module.exports.SetLevel = function(level) { - LogLevel = level; +function Destroy() { + if (Options.logFile) { + fs.appendFileSync(Options.logFile, 'END OF SESSION' + '\n'); + fs.closeSync(Options.logFile); + } + + if (Options.networkHost) { + Socket.destroy(); + } } -module.exports.SetDateFormat = function(format) { - dateFormat = format; -} - -module.exports.VERBOSE_LOGS = 0; -module.exports.DEBUG_LOGS = 1; -module.exports.INFO_LOGS = 2; -module.exports.WARN_LOGS = 3; - -module.exports.Middleware = function(origin, ...message) { - let d = moment().format(dateFormat); - fs.appendFileSync(logPath, `[${d.toLocaleString()}] [MIDDLEWARE: ${origin}] ${message} \n`); - if (LogLevel > 0) return; - console.log('[' + d.toLocaleString() + '] [' - + clc.yellow(`MIDDLEWARE: ${origin}`) + '] ' + message); -} - -module.exports.Database = function(...message) { - let d = moment().format(dateFormat); - fs.appendFileSync(logPath, `[${d.toLocaleString()}] [POSTGRES: SQL] ${message} \n`); - if (LogLevel > 0) return; - console.log('[' + d.toLocaleString() + '] [' - + clc.magentaBright(`POSTGRES: SQL`) + '] ' + message); -} - -module.exports.Debug = function(...message) { - let d = moment().format(dateFormat); - fs.appendFileSync(logPath, `[${d.toLocaleString()}] [DEBUG] ${message} \n`); - if (LogLevel > 1) return; - console.log('[' + d.toLocaleString() + '] [' - + clc.cyan('DEBUG') + '] ' + message); -} - -module.exports.Ready = function() { - let d = moment().format(dateFormat); - fs.appendFileSync(logPath, `[${d.toLocaleString()}] [READY] \n`); - console.log('[' + d.toLocaleString() + '] [' - + clc.rainbow('READY') + ']'); -} - -module.exports.Info = function(...message) { - let d = moment().format(dateFormat); - fs.appendFileSync(logPath, `[${d.toLocaleString()}] [INFO] ${message} \n`); - if (LogLevel > 2) return; - console.log('[' + d.toLocaleString() + '] [' - + clc.green('INFO') + '] ' + message); -} - -module.exports.Warn = function(...message) { - let d = moment().format(dateFormat); - fs.appendFileSync(logPath, `[${d.toLocaleString()}] [WARN] ${message} \n`); - if (LogLevel > 3) return; - console.warn('[' + d.toLocaleString() + '] [' - + clc.yellow('WARN') + '] ' + message); -} - -module.exports.Error = function(...message) { - let d = moment().format(dateFormat); - fs.appendFileSync(logPath, `[${d.toLocaleString()}] [ERROR] ${message} \n`); - console.error('[' + d.toLocaleString() + '] [' - + clc.red('ERROR') + '] ' + message); -} - -module.exports.Panic = function(...message) { - let d = moment().format(dateFormat); - fs.appendFileSync(logPath, `[${d.toLocaleString()}] [PANIC] ${message} \n`); - console.error('[' + d.toLocaleString() + '] [' - + clc.red('PANIC') + '] ' + message); - console.error('[' + d.toLocaleString() + '] [' - + clc.red('PANIC') + '] ABORTING...'); - process.exit(); -} \ No newline at end of file +module.exports = { + LEVEL_VERBOSE, + LEVEL_DEBUG, + LEVEL_INFO, + LEVEL_WARN, + Init, + Destroy, + Info, + Warn, + Error, + Panic, + Debug, + Module, + Database, + ExpressLogger, +}; diff --git a/src/routes/server.js b/src/routes/server.js index 86ed022..0597101 100644 --- a/src/routes/server.js +++ b/src/routes/server.js @@ -3,17 +3,12 @@ const Logger = require('../logger.js'); const express = require('express'); const app = express(); -function logRequest(req, res, next) { - Logger.Middleware('REQUEST', `${req.originalUrl} [${req.method}: ${req.headers['x-forwarded-for'] || req.socket.remoteAddress}]`); - next(); -} - function listen(port) { app.listen(port); Logger.Info(`Listening on ${port}...`); Logger.Info('Setting up basic middleware...'); - app.use(logRequest); + app.use(Logger.ExpressLogger); app.use(express.static('client/public/')); }