hotstaq 0.5.24

package/build/src/Hot.d.ts

@@ -0,0 +1,167 @@
+import { HotFile } from "./HotFile";
+import { HotPage } from "./HotPage";
+import { HotAPI } from "./HotAPI";
+import { HotTestElement } from "./HotTestElement";
+import Cookies from "js-cookie";
+/**
+ * The available developer modes.
+ */
+export declare enum DeveloperMode {
+    /**
+     * The default developer mode. No tests will be executed and
+     * any test related data will be ignored.
+     */
+    Production = 0,
+    /**
+     * For use during development/debugging. All test data will
+     * be collected and executed if necessary.
+     */
+    Development = 1
+}
+/**
+ * A CSS object to embed.
+ */
+export interface CSSObject {
+    /**
+     * The url to the CSS file to embed.
+     */
+    url: string;
+    /**
+     * The integrity hash to generate during initial compilation.
+     */
+    integrityHash: string;
+}
+/**
+ * The api used during processing.
+ */
+export declare class Hot {
+    /**
+     * The currently generated page being displayed. This is cleared between every file processed.
+     */
+    static CurrentPage: HotPage;
+    /**
+     * The arguments passed.
+     */
+    static Arguments: any;
+    /**
+     * The mode in which this application is running. If it's set to development mode, all testing
+     * related data will be collected, parsed, and executed if necessary.
+     */
+    static DeveloperMode: typeof DeveloperMode;
+    /**
+     * The mode in which this application is running. If it's set to development mode, all testing
+     * related data will be collected, parsed, and executed if necessary.
+     */
+    static HotTestElement: typeof HotTestElement;
+    /**
+     * The mode in which this application is running. If it's set to development mode, all testing
+     * related data will be collected, parsed, and executed if necessary.
+     */
+    static Mode: DeveloperMode;
+    /**
+     *The current API used on this page. This is cleared between every file processed.
+     */
+    static API: HotAPI;
+    /**
+     * The API being used by the tester.
+     */
+    static TesterAPI: HotAPI;
+    /**
+     * Contains the buffer to output. This is cleared between every file processed.
+     */
+    static Output: string;
+    /**
+     * The data to share across all the different files and pages. This data will be public.
+     */
+    static Data: any;
+    /**
+     * The cookies to use between pages.
+     */
+    static Cookies: Cookies.CookiesStatic;
+    /**
+     * Any secrets that can be shown publicly. These can be passed from HotSite.json.
+     */
+    static PublicSecrets: any;
+    /**
+     * The CSS string to use when echoing out the CSS files.
+     */
+    static cssStr: string;
+    /**
+     * The CSS files to use in the current page being generated.
+     *
+     * @todo Make this a "string | CSSObject" data type so it can also include
+     * the integrity hashes as well.
+     */
+    static CSS: string[];
+    /**
+     * The JavaScript files to use in the current page being generated.
+     *
+     * @todo Make this a "string | JSFileObject" data type so it can also include
+     * the integrity hashes as well.
+     */
+    static JSFiles: any[];
+    /**
+     * The JavaScript inline code to use in the current page being generated.
+     */
+    static JSScripts: any[];
+    /**
+     * The JavaScript string to use when echoing out the Scripts files.
+     */
+    static jsFileStr: string;
+    /**
+     * The JavaScript string to use when echoing out the Scripts files.
+     */
+    static jsScriptsStr: string;
+    /**
+     * Retrieve a file and echo out it's contents.
+     */
+    static include(file: HotFile | string, args?: any[]): Promise<void>;
+    /**
+     * Run an already loaded file and echo out it's contents.
+     */
+    static runFile(fileName: string, args?: any[]): Promise<void>;
+    /**
+     * Get the content of a file.
+     */
+    static getFile(path: HotFile | string, args?: any[]): Promise<string>;
+    /**
+     * Make an api call.
+     */
+    static apiCall(route: string, data?: any, httpMethod?: string): Promise<any>;
+    /**
+     * Make a HTTP JSON request.
+     *
+     * @param url The full url to make the HTTP call.
+     * @param data The data to JSON.stringify and send.
+     * @param httpMethod The HTTP method to use to send the data.
+     *
+     * @returns The parsed JSON object.
+     */
+    static jsonRequest(url: string, data?: any, httpMethod?: string): Promise<any>;
+    /**
+     * Make a HTTP request. This is basically just a wrapper for fetch.
+     *
+     * @param url The full url to make the HTTP call.
+     * @param requestInit The request parameters to send.
+     *
+     * @returns The HTTP response.
+     */
+    static httpRequest(url: string, requestInit?: RequestInit): Promise<Response>;
+    /**
+     * Echo out some output.
+     */
+    static echo(message: string): void;
+    /**
+     * Echo out the CSS for the current page being generated.
+     */
+    static displayCSS(): void;
+    /**
+     * Echo out the JS files for the current page being generated.
+     */
+    static displayJSFiles(): void;
+    /**
+     * Echo out the JS scripts for the current page being generated.
+     */
+    static displayJSScripts(): void;
+}
+//# sourceMappingURL=Hot.d.ts.map

package/build/src/Hot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Hot.d.ts","sourceRoot":"","sources":["../../src/Hot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,OAAO,MAAM,WAAW,CAAC;AAGhC;;GAEG;AACH,oBAAY,aAAa;IAExB;;;OAGG;IACH,UAAU,IAAA;IACV;;;OAGG;IACH,WAAW,IAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IAEzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,GAAG;IAEf;;OAEG;IACH,MAAM,CAAC,WAAW,EAAE,OAAO,CAAQ;IACnC;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,GAAG,CAAQ;IAC7B;;;OAGG;IACH,MAAM,CAAC,aAAa,uBAAiB;IACrC;;;OAGG;IACH,MAAM,CAAC,cAAc,wBAAkB;IACvC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,aAAa,CAA4B;IACtD;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,CAAQ;IAC1B;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,CAAQ;IAChC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;IAC3B;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,GAAG,CAAM;IACtB;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAW;IAChD;;OAEG;IACH,MAAM,CAAC,aAAa,EAAE,GAAG,CAAM;IAC/B;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAqD;IAC1E;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,CAAM;IAC1B;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,GAAG,EAAE,CAAM;IAC3B;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,CAAM;IAC7B;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,CAAkE;IAC1F;;OAEG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,CAAyD;IAEpF;;OAEG;WACU,OAAO,CAAE,IAAI,EAAE,OAAO,GAAG,MAAM,EAAE,IAAI,GAAE,GAAG,EAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBhF;;OAEG;WACU,OAAO,CAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE,GAAG,EAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAa1E;;OAEG;WACU,OAAO,CAAE,IAAI,EAAE,OAAO,GAAG,MAAM,EAAE,IAAI,GAAE,GAAG,EAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAwBlF;;OAEG;WACU,OAAO,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,GAAU,EAAE,UAAU,GAAE,MAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBjG;;;;;;;;OAQG;WACU,WAAW,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,GAAU,EAAE,UAAU,GAAE,MAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IA0BnG;;;;;;;OAOG;WACU,WAAW,CAAE,GAAG,EAAE,MAAM,EAAE,WAAW,GAAE,WAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO/F;;OAEG;IACH,MAAM,CAAC,IAAI,CAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAKnC;;OAEG;IACH,MAAM,CAAC,UAAU,IAAK,IAAI;IAa1B;;OAEG;IACH,MAAM,CAAC,cAAc,IAAK,IAAI;IAa9B;;OAEG;IACH,MAAM,CAAC,gBAAgB,IAAK,IAAI;CAYhC"}

package/build/src/Hot.js

@@ -0,0 +1,365 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hot = exports.DeveloperMode = void 0;
+var HotFile_1 = require("./HotFile");
+var HotStaq_1 = require("./HotStaq");
+var HotTestElement_1 = require("./HotTestElement");
+var js_cookie_1 = __importDefault(require("js-cookie"));
+var cross_fetch_1 = __importDefault(require("cross-fetch"));
+/**
+ * The available developer modes.
+ */
+var DeveloperMode;
+(function (DeveloperMode) {
+    /**
+     * The default developer mode. No tests will be executed and
+     * any test related data will be ignored.
+     */
+    DeveloperMode[DeveloperMode["Production"] = 0] = "Production";
+    /**
+     * For use during development/debugging. All test data will
+     * be collected and executed if necessary.
+     */
+    DeveloperMode[DeveloperMode["Development"] = 1] = "Development";
+})(DeveloperMode = exports.DeveloperMode || (exports.DeveloperMode = {}));
+/**
+ * The api used during processing.
+ */
+var Hot = /** @class */ (function () {
+    function Hot() {
+    }
+    /**
+     * Retrieve a file and echo out it's contents.
+     */
+    Hot.include = function (file, args) {
+        if (args === void 0) { args = null; }
+        return __awaiter(this, void 0, void 0, function () {
+            var lowerFile, _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (HotStaq_1.HotStaq.isWeb === true) {
+                            if (typeof (file) === "string") {
+                                lowerFile = file.toLowerCase();
+                                // If the file to be included does not have a nahfam, add it. This 
+                                // will ensure the server sends only the file content.
+                                if (lowerFile.indexOf(".hott") > -1) {
+                                    if (lowerFile.indexOf("nahfam") < 0)
+                                        file += "?hpserve=nahfam";
+                                }
+                            }
+                        }
+                        _b = (_a = Hot).echo;
+                        return [4 /*yield*/, Hot.getFile(file, args)];
+                    case 1:
+                        _b.apply(_a, [_c.sent()]);
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Run an already loaded file and echo out it's contents.
+     */
+    Hot.runFile = function (fileName, args) {
+        if (args === void 0) { args = null; }
+        return __awaiter(this, void 0, void 0, function () {
+            var file, tempFile, content;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        file = Hot.CurrentPage.processor.getFile(fileName);
+                        tempFile = file;
+                        tempFile.page = this.CurrentPage;
+                        return [4 /*yield*/, tempFile.process(args)];
+                    case 1:
+                        content = _a.sent();
+                        Hot.echo(content);
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Get the content of a file.
+     */
+    Hot.getFile = function (path, args) {
+        if (args === void 0) { args = null; }
+        return __awaiter(this, void 0, void 0, function () {
+            var tempFile, content;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        tempFile = null;
+                        if (typeof (path) === "string") {
+                            tempFile = new HotFile_1.HotFile();
+                            if (HotStaq_1.HotStaq.isWeb === true)
+                                tempFile.url = path;
+                            else
+                                tempFile.localFile = path;
+                        }
+                        else
+                            tempFile = path;
+                        return [4 /*yield*/, tempFile.load()];
+                    case 1:
+                        _a.sent();
+                        tempFile.page = this.CurrentPage;
+                        return [4 /*yield*/, tempFile.process(args)];
+                    case 2:
+                        content = _a.sent();
+                        return [2 /*return*/, (content)];
+                }
+            });
+        });
+    };
+    /**
+     * Make an api call.
+     */
+    Hot.apiCall = function (route, data, httpMethod) {
+        if (data === void 0) { data = null; }
+        if (httpMethod === void 0) { httpMethod = "POST"; }
+        return __awaiter(this, void 0, void 0, function () {
+            var result;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        result = null;
+                        if (Hot.CurrentPage == null)
+                            throw new Error("Current page is null!");
+                        if (Hot.CurrentPage.processor == null)
+                            throw new Error("Current page's processor is null!");
+                        if (Hot.CurrentPage.processor.api == null)
+                            throw new Error("Current page's processor api is null!");
+                        if (!(Hot.CurrentPage.processor.api != null)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, Hot.CurrentPage.processor.api.call(route, data, httpMethod)];
+                    case 1:
+                        result = _a.sent();
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, (result)];
+                }
+            });
+        });
+    };
+    /**
+     * Make a HTTP JSON request.
+     *
+     * @param url The full url to make the HTTP call.
+     * @param data The data to JSON.stringify and send.
+     * @param httpMethod The HTTP method to use to send the data.
+     *
+     * @returns The parsed JSON object.
+     */
+    Hot.jsonRequest = function (url, data, httpMethod) {
+        if (data === void 0) { data = null; }
+        if (httpMethod === void 0) { httpMethod = "POST"; }
+        return __awaiter(this, void 0, void 0, function () {
+            var res, result, ex_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 3, , 4]);
+                        return [4 /*yield*/, (0, cross_fetch_1.default)(url, {
+                                "method": httpMethod,
+                                "headers": {
+                                    "Accept": "application/json",
+                                    "Content-Type": "application/json"
+                                },
+                                "body": JSON.stringify(data)
+                            })];
+                    case 1:
+                        res = _a.sent();
+                        if (res.ok === false)
+                            throw new Error("".concat(res.status, ": ").concat(res.statusText));
+                        return [4 /*yield*/, res.json()];
+                    case 2:
+                        result = _a.sent();
+                        return [2 /*return*/, (result)];
+                    case 3:
+                        ex_1 = _a.sent();
+                        return [2 /*return*/, (JSON.stringify({ "error": "".concat(ex_1.message, " - Could not fetch ").concat(url) }))];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Make a HTTP request. This is basically just a wrapper for fetch.
+     *
+     * @param url The full url to make the HTTP call.
+     * @param requestInit The request parameters to send.
+     *
+     * @returns The HTTP response.
+     */
+    Hot.httpRequest = function (url, requestInit) {
+        if (requestInit === void 0) { requestInit = undefined; }
+        return __awaiter(this, void 0, void 0, function () {
+            var res;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, cross_fetch_1.default)(url, requestInit)];
+                    case 1:
+                        res = _a.sent();
+                        return [2 /*return*/, (res)];
+                }
+            });
+        });
+    };
+    /**
+     * Echo out some output.
+     */
+    Hot.echo = function (message) {
+        Hot.Output += message;
+    };
+    /**
+     * Echo out the CSS for the current page being generated.
+     */
+    Hot.displayCSS = function () {
+        for (var iIdx = 0; iIdx < Hot.CSS.length; iIdx++) {
+            var cssFile = Hot.CSS[iIdx];
+            var cssOut = Hot.cssStr;
+            cssOut = cssOut.replace(/\%CSS_FILE\%/g, cssFile);
+            Hot.echo(cssOut);
+        }
+    };
+    /**
+     * Echo out the JS files for the current page being generated.
+     */
+    Hot.displayJSFiles = function () {
+        for (var iIdx = 0; iIdx < Hot.JSFiles.length; iIdx++) {
+            var jsFile = Hot.JSFiles[iIdx];
+            var jsFileOut = Hot.jsFileStr;
+            jsFileOut = jsFileOut.replace(/\%JS_FILE\%/g, jsFile);
+            Hot.echo(jsFileOut);
+        }
+    };
+    /**
+     * Echo out the JS scripts for the current page being generated.
+     */
+    Hot.displayJSScripts = function () {
+        for (var iIdx = 0; iIdx < Hot.JSScripts.length; iIdx++) {
+            var jsScript = Hot.JSScripts[iIdx];
+            var jsScriptOut = Hot.jsScriptsStr;
+            jsScriptOut = jsScriptOut.replace(/\%JS_CODE\%/g, jsScript);
+            Hot.echo(jsScriptOut);
+        }
+    };
+    /**
+     * The currently generated page being displayed. This is cleared between every file processed.
+     */
+    Hot.CurrentPage = null;
+    /**
+     * The arguments passed.
+     */
+    Hot.Arguments = null;
+    /**
+     * The mode in which this application is running. If it's set to development mode, all testing
+     * related data will be collected, parsed, and executed if necessary.
+     */
+    Hot.DeveloperMode = DeveloperMode;
+    /**
+     * The mode in which this application is running. If it's set to development mode, all testing
+     * related data will be collected, parsed, and executed if necessary.
+     */
+    Hot.HotTestElement = HotTestElement_1.HotTestElement;
+    /**
+     * The mode in which this application is running. If it's set to development mode, all testing
+     * related data will be collected, parsed, and executed if necessary.
+     */
+    Hot.Mode = DeveloperMode.Production;
+    /**
+     *The current API used on this page. This is cleared between every file processed.
+     */
+    Hot.API = null;
+    /**
+     * The API being used by the tester.
+     */
+    Hot.TesterAPI = null;
+    /**
+     * Contains the buffer to output. This is cleared between every file processed.
+     */
+    Hot.Output = "";
+    /**
+     * The data to share across all the different files and pages. This data will be public.
+     */
+    Hot.Data = {};
+    /**
+     * The cookies to use between pages.
+     */
+    Hot.Cookies = js_cookie_1.default;
+    /**
+     * Any secrets that can be shown publicly. These can be passed from HotSite.json.
+     */
+    Hot.PublicSecrets = {};
+    /**
+     * The CSS string to use when echoing out the CSS files.
+     */
+    Hot.cssStr = "<link rel = \"stylesheet\" href = \"%CSS_FILE%\" />";
+    /**
+     * The CSS files to use in the current page being generated.
+     *
+     * @todo Make this a "string | CSSObject" data type so it can also include
+     * the integrity hashes as well.
+     */
+    Hot.CSS = [];
+    /**
+     * The JavaScript files to use in the current page being generated.
+     *
+     * @todo Make this a "string | JSFileObject" data type so it can also include
+     * the integrity hashes as well.
+     */
+    Hot.JSFiles = [];
+    /**
+     * The JavaScript inline code to use in the current page being generated.
+     */
+    Hot.JSScripts = [];
+    /**
+     * The JavaScript string to use when echoing out the Scripts files.
+     */
+    Hot.jsFileStr = "<script type = \"text/javascript\" src = \"%JS_FILE%\"></script>";
+    /**
+     * The JavaScript string to use when echoing out the Scripts files.
+     */
+    Hot.jsScriptsStr = "<script type = \"text/javascript\">%JS_CODE%</script>";
+    return Hot;
+}());
+exports.Hot = Hot;
+//# sourceMappingURL=Hot.js.map

package/build/src/Hot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Hot.js","sourceRoot":"","sources":["../../src/Hot.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoC;AAEpC,qCAAoC;AAEpC,mDAAkD;AAElD,wDAAgC;AAChC,4DAAgC;AAEhC;;GAEG;AACH,IAAY,aAYX;AAZD,WAAY,aAAa;IAExB;;;OAGG;IACH,6DAAU,CAAA;IACV;;;OAGG;IACH,+DAAW,CAAA;AACZ,CAAC,EAZW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAYxB;AAiBD;;GAEG;AACH;IAAA;IAkRA,CAAC;IAlMA;;OAEG;IACU,WAAO,GAApB,UAAsB,IAAsB,EAAE,IAAkB;QAAlB,qBAAA,EAAA,WAAkB;;;;;;wBAE/D,IAAI,iBAAO,CAAC,KAAK,KAAK,IAAI,EAC1B;4BACC,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,EAC9B;gCACO,SAAS,GAAW,IAAI,CAAC,WAAW,EAAG,CAAC;gCAE9C,mEAAmE;gCACnE,sDAAsD;gCACtD,IAAI,SAAS,CAAC,OAAO,CAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EACpC;oCACC,IAAI,SAAS,CAAC,OAAO,CAAE,QAAQ,CAAC,GAAG,CAAC;wCACnC,IAAI,IAAI,iBAAiB,CAAC;iCAC3B;6BACD;yBACD;wBAED,KAAA,CAAA,KAAA,GAAG,CAAA,CAAC,IAAI,CAAA;wBAAE,qBAAM,GAAG,CAAC,OAAO,CAAE,IAAI,EAAE,IAAI,CAAC,EAAA;;wBAAxC,cAAU,SAA8B,EAAC,CAAC;;;;;KAC1C;IAED;;OAEG;IACU,WAAO,GAApB,UAAsB,QAAgB,EAAE,IAAkB;QAAlB,qBAAA,EAAA,WAAkB;;;;;;wBAErD,IAAI,GAAY,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,OAAO,CAAE,QAAQ,CAAC,CAAC;wBAG7D,QAAQ,GAAY,IAAI,CAAC;wBAE7B,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;wBACX,qBAAM,QAAQ,CAAC,OAAO,CAAE,IAAI,CAAC,EAAA;;wBAA/C,OAAO,GAAW,SAA6B;wBAEnD,GAAG,CAAC,IAAI,CAAE,OAAO,CAAC,CAAC;;;;;KACnB;IAED;;OAEG;IACU,WAAO,GAApB,UAAsB,IAAsB,EAAE,IAAkB;QAAlB,qBAAA,EAAA,WAAkB;;;;;;wBAE3D,QAAQ,GAAY,IAAI,CAAC;wBAE7B,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,QAAQ,EAC9B;4BACC,QAAQ,GAAG,IAAI,iBAAO,EAAG,CAAC;4BAE1B,IAAI,iBAAO,CAAC,KAAK,KAAK,IAAI;gCACzB,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC;;gCAEpB,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;yBAC3B;;4BAEA,QAAQ,GAAG,IAAI,CAAC;wBAEjB,qBAAM,QAAQ,CAAC,IAAI,EAAG,EAAA;;wBAAtB,SAAsB,CAAC;wBAEvB,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;wBACX,qBAAM,QAAQ,CAAC,OAAO,CAAE,IAAI,CAAC,EAAA;;wBAA/C,OAAO,GAAW,SAA6B;wBAEnD,sBAAO,CAAC,OAAO,CAAC,EAAC;;;;KACjB;IAED;;OAEG;IACU,WAAO,GAApB,UAAsB,KAAa,EAAE,IAAgB,EAAE,UAA2B;QAA7C,qBAAA,EAAA,WAAgB;QAAE,2BAAA,EAAA,mBAA2B;;;;;;wBAE7E,MAAM,GAAQ,IAAI,CAAC;wBAEvB,IAAI,GAAG,CAAC,WAAW,IAAI,IAAI;4BAC1B,MAAM,IAAI,KAAK,CAAE,uBAAuB,CAAC,CAAC;wBAE3C,IAAI,GAAG,CAAC,WAAW,CAAC,SAAS,IAAI,IAAI;4BACpC,MAAM,IAAI,KAAK,CAAE,mCAAmC,CAAC,CAAC;wBAEvD,IAAI,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,IAAI;4BACxC,MAAM,IAAI,KAAK,CAAE,uCAAuC,CAAC,CAAC;6BAEvD,CAAA,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,IAAI,CAAA,EAArC,wBAAqC;wBAC/B,qBAAM,GAAG,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAE,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,EAAA;;wBAA3E,MAAM,GAAG,SAAkE,CAAC;;4BAE7E,sBAAO,CAAC,MAAM,CAAC,EAAC;;;;KAChB;IAED;;;;;;;;OAQG;IACU,eAAW,GAAxB,UAA0B,GAAW,EAAE,IAAgB,EAAE,UAA2B;QAA7C,qBAAA,EAAA,WAAgB;QAAE,2BAAA,EAAA,mBAA2B;;;;;;;wBAI9D,qBAAM,IAAA,qBAAK,EAAE,GAAG,EAAE;gCACpC,QAAQ,EAAE,UAAU;gCACpB,SAAS,EAAE;oCACT,QAAQ,EAAE,kBAAkB;oCAC5B,cAAc,EAAE,kBAAkB;iCAClC;gCACF,MAAM,EAAE,IAAI,CAAC,SAAS,CAAE,IAAI,CAAC;6BAC7B,CAAC,EAAA;;wBAPC,GAAG,GAAa,SAOjB;wBAEH,IAAI,GAAG,CAAC,EAAE,KAAK,KAAK;4BACnB,MAAM,IAAI,KAAK,CAAE,UAAG,GAAG,CAAC,MAAM,eAAK,GAAG,CAAC,UAAU,CAAE,CAAC,CAAC;wBAEpC,qBAAM,GAAG,CAAC,IAAI,EAAG,EAAA;;wBAA/B,MAAM,GAAQ,SAAiB;wBAEnC,sBAAO,CAAC,MAAM,CAAC,EAAC;;;wBAIhB,sBAAO,CAAC,IAAI,CAAC,SAAS,CAAE,EAAE,OAAO,EAAE,UAAG,IAAE,CAAC,OAAO,gCAAsB,GAAG,CAAE,EAAE,CAAC,CAAC,EAAC;;;;;KAEjF;IAED;;;;;;;OAOG;IACU,eAAW,GAAxB,UAA0B,GAAW,EAAE,WAAoC;QAApC,4BAAA,EAAA,uBAAoC;;;;;4BAEtD,qBAAM,IAAA,qBAAK,EAAE,GAAG,EAAE,WAAW,CAAC,EAAA;;wBAA9C,GAAG,GAAa,SAA8B;wBAElD,sBAAO,CAAC,GAAG,CAAC,EAAC;;;;KACb;IAED;;OAEG;IACI,QAAI,GAAX,UAAa,OAAe;QAE3B,GAAG,CAAC,MAAM,IAAI,OAAO,CAAC;IACvB,CAAC;IAED;;OAEG;IACI,cAAU,GAAjB;QAEC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,EAChD;YACC,IAAI,OAAO,GAAW,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,MAAM,GAAW,GAAG,CAAC,MAAM,CAAC;YAEhC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAE,eAAe,EAAE,OAAO,CAAC,CAAC;YAEnD,GAAG,CAAC,IAAI,CAAE,MAAM,CAAC,CAAC;SAClB;IACF,CAAC;IAED;;OAEG;IACI,kBAAc,GAArB;QAEC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,EACpD;YACC,IAAI,MAAM,GAAW,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACvC,IAAI,SAAS,GAAW,GAAG,CAAC,SAAS,CAAC;YAEtC,SAAS,GAAG,SAAS,CAAC,OAAO,CAAE,cAAc,EAAE,MAAM,CAAC,CAAC;YAEvD,GAAG,CAAC,IAAI,CAAE,SAAS,CAAC,CAAC;SACrB;IACF,CAAC;IAED;;OAEG;IACI,oBAAgB,GAAvB;QAEC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,EACtD;YACC,IAAI,QAAQ,GAAW,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,WAAW,GAAW,GAAG,CAAC,YAAY,CAAC;YAE3C,WAAW,GAAG,WAAW,CAAC,OAAO,CAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;YAE7D,GAAG,CAAC,IAAI,CAAE,WAAW,CAAC,CAAC;SACvB;IACF,CAAC;IA/QD;;OAEG;IACI,eAAW,GAAY,IAAI,CAAC;IACnC;;OAEG;IACI,aAAS,GAAQ,IAAI,CAAC;IAC7B;;;OAGG;IACI,iBAAa,GAAG,aAAa,CAAC;IACrC;;;OAGG;IACI,kBAAc,GAAG,+BAAc,CAAC;IACvC;;;OAGG;IACI,QAAI,GAAkB,aAAa,CAAC,UAAU,CAAC;IACtD;;OAEG;IACI,OAAG,GAAW,IAAI,CAAC;IAC1B;;OAEG;IACI,aAAS,GAAW,IAAI,CAAC;IAChC;;OAEG;IACI,UAAM,GAAW,EAAE,CAAC;IAC3B;;OAEG;IACI,QAAI,GAAQ,EAAE,CAAC;IACtB;;OAEG;IACI,WAAO,GAA0B,mBAAO,CAAC;IAChD;;OAEG;IACI,iBAAa,GAAQ,EAAE,CAAC;IAC/B;;OAEG;IACI,UAAM,GAAW,qDAAiD,CAAC;IAC1E;;;;;OAKG;IACI,OAAG,GAAa,EAAE,CAAC;IAC1B;;;;;OAKG;IACI,WAAO,GAAU,EAAE,CAAC;IAC3B;;OAEG;IACI,aAAS,GAAU,EAAE,CAAC;IAC7B;;OAEG;IACI,aAAS,GAAW,kEAA8D,CAAC;IAC1F;;OAEG;IACI,gBAAY,GAAW,uDAAqD,CAAC;IAoMrF,UAAC;CAAA,AAlRD,IAkRC;AAlRY,kBAAG"}

package/build/src/HotAPI.d.ts

@@ -0,0 +1,130 @@
+import { HotServer } from "./HotServer";
+import { HotRoute } from "./HotRoute";
+import { HotClient } from "./HotClient";
+import { HotRouteMethod, ServerAuthorizationFunction } from "./HotRouteMethod";
+import { HotDB } from "./HotDB";
+import { HotDBSchema } from "./schemas/HotDBSchema";
+/**
+ * The type of object to use during event executions.
+ */
+export declare enum EventExecutionType {
+    HotRoute = 0,
+    HotMethod = 1,
+    HotAPI = 2
+}
+/**
+ * The API to use.
+ */
+export declare abstract class HotAPI {
+    /**
+     * The server connection.
+     */
+    connection: HotServer | HotClient;
+    /**
+     * The base url for the server.
+     */
+    baseUrl: string;
+    /**
+     * If set, this will create the route variables and functions for
+     * easy client/server calling.
+     */
+    createFunctions: boolean;
+    /**
+     * The database connection.
+     */
+    executeEventsUsing: EventExecutionType;
+    /**
+     * The database connection.
+     */
+    db: HotDB;
+    /**
+     * The authorization credentials to use throughout the application.
+     */
+    authCredentials: any;
+    /**
+     * The function used for user authentication.
+     */
+    userAuth: ServerAuthorizationFunction;
+    /**
+     * The database connection.
+     */
+    routes: {
+        [name: string]: HotRoute;
+    };
+    /**
+     * Executed when the API is about to start registering routes. If
+     * this function returns false, the server will not start.
+     */
+    onPreRegister: () => Promise<boolean>;
+    /**
+     * Executed when the API has finished registering routes. If
+     * this function returns false, the server will not start.
+     */
+    onPostRegister: () => Promise<boolean>;
+    constructor(baseUrl: string, connection?: HotServer | HotClient, db?: HotDB);
+    /**
+     * Set the database schema for use.
+     */
+    setDBSchema(schema: HotDBSchema): void;
+    /**
+     * Get the database being used.
+     */
+    getDB(): HotDB;
+    /**
+     * Get the database schema being used.
+     */
+    getDBSchema(): HotDBSchema;
+    /**
+     * Add a route. If this.createFunctions is set to true, this will take the incoming
+     * route and create an object in this HotAPI object using the name of the route. If there's
+     * any HotRouteMethods inside of the incoming HotRoute, it will create the methods
+     * and attach them to the newly created HotRoute object.
+     *
+     * Example:
+     * ```
+     * export class Users extends HotRoute
+     * {
+     * 		constructor (api: FreeLightAPI)
+     * 		{
+     * 			super (api.connection, "user");
+     *
+     * 			this.addMethod ("create", this._create, HTTPMethod.POST);
+     * 		}
+     *
+     * 		protected async _create (req: any, res: any, authorizedValue: any, jsonObj: any, queryObj: any): Promise<any>
+     * 		{
+     * 			return (true);
+     * 		}
+     * }
+     * ```
+     *
+     * This in turn could be used like so:
+     * ```
+     * Hot.API.user.create ({});
+     * ```
+     *
+     * Additionally it would create the endpoint: ```http://127.0.0.1:8080/v1/user/create```
+     *
+     * @param route The route to add. Can be either a full HotRoute object, or just
+     * the route's name. If a HotRoute object is supplied, the rest of the parameters
+     * will be ignored.
+     * @param routeMethod The route's method to add. If the route parameter is a string,
+     * it will be interpreted as the route's name, and this will be the method added to
+     * the new route.
+     * @param executeFunction The function to execute when routeMethod is called by the API.
+     */
+    addRoute(route: HotRoute | string, routeMethod?: HotRouteMethod | string, executeFunction?: (req: any, res: any, authorizedValue: any, jsonObj: any, queryObj: any) => Promise<any>): void;
+    /**
+     * Register a route with the server.
+     */
+    registerRoute(route: HotRoute): Promise<void>;
+    /**
+     * Register all routes with the server.
+     */
+    registerRoutes(): Promise<void>;
+    /**
+     * Make a call to the API.
+     */
+    call(route: string, data: any, httpMethod?: string): Promise<any>;
+}
+//# sourceMappingURL=HotAPI.d.ts.map

package/build/src/HotAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HotAPI.d.ts","sourceRoot":"","sources":["../../src/HotAPI.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD;;GAEG;AACH,oBAAY,kBAAkB;IAE7B,QAAQ,IAAA;IACR,SAAS,IAAA;IACT,MAAM,IAAA;CACN;AAED;;GAEG;AACH,8BAAsB,MAAM;IAE3B;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,kBAAkB,EAAE,kBAAkB,CAAC;IACvC;;OAEG;IACH,EAAE,EAAE,KAAK,CAAC;IACV;;OAEG;IACH,eAAe,EAAE,GAAG,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,2BAA2B,CAAC;IACtC;;OAEG;IACH,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAC;IACrC;;;OAGG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC;;;OAGG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;gBAE1B,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,SAAS,GAAG,SAAgB,EAAE,EAAE,GAAE,KAAY;IAcxF;;OAEG;IACH,WAAW,CAAE,MAAM,EAAE,WAAW,GAAG,IAAI;IAWvC;;OAEG;IACH,KAAK,IAAK,KAAK;IAQf;;OAEG;IACH,WAAW,IAAK,WAAW;IAQ3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,QAAQ,CACP,KAAK,EAAE,QAAQ,GAAG,MAAM,EACxB,WAAW,GAAE,cAAc,GAAG,MAAa,EAC3C,eAAe,GAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAQ,GAC5G,IAAI;IAmJR;;OAEG;IACG,aAAa,CAAE,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpD;;OAEG;IACG,cAAc,IAAK,OAAO,CAAC,IAAI,CAAC;IAUtC;;OAEG;IACG,IAAI,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,GAAE,MAAe,GAAG,OAAO,CAAC,GAAG,CAAC;CA2ChF"}