hotstaq 0.5.3

package/build/src/HotPage.js

@@ -0,0 +1,178 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HotPage = void 0;
+var Hot_1 = require("./Hot");
+var HotStaq_1 = require("./HotStaq");
+/**
+ * A page to preprocess.
+ */
+var HotPage = /** @class */ (function () {
+    function HotPage(copy) {
+        if (copy instanceof HotStaq_1.HotStaq) {
+            this.processor = copy;
+            this.name = "";
+            this.testerName = "";
+            this.testerMap = "";
+            this.route = "";
+            this.files = [];
+            this.testElements = {};
+            this.testPaths = {};
+        }
+        else {
+            this.processor = copy.processor;
+            this.name = copy.name || "";
+            this.testerName = copy.testerName || "";
+            this.testerMap = copy.testerMap || "";
+            this.route = copy.route || "";
+            this.files = copy.files || [];
+            this.testElements = copy.testElements || {};
+            this.testPaths = copy.testPaths || {};
+        }
+    }
+    /**
+     * Add a file to process. It's recommend to load the file prior to
+     * adding it to a page if it's about to be used.
+     */
+    HotPage.prototype.addFile = function (file) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                file.page = this;
+                this.files.push(file);
+                return [2 /*return*/];
+            });
+        });
+    };
+    /**
+     * Get the API associated with this page.
+     */
+    HotPage.prototype.getAPI = function () {
+        return (this.processor.api);
+    };
+    /**
+     * Get the tester API associated with this page.
+     */
+    HotPage.prototype.getTesterAPI = function () {
+        return (this.processor.testerAPI);
+    };
+    /**
+     * Add all files in the page. Could decrease page loading performance.
+     * It's recommend to load the file prior to adding it to a page.
+     */
+    HotPage.prototype.load = function (file) {
+        return __awaiter(this, void 0, void 0, function () {
+            var iIdx, file_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        iIdx = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(iIdx < this.files.length)) return [3 /*break*/, 4];
+                        file_1 = this.files[iIdx];
+                        return [4 /*yield*/, file_1.load()];
+                    case 2:
+                        _a.sent();
+                        _a.label = 3;
+                    case 3:
+                        iIdx++;
+                        return [3 /*break*/, 1];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Process a page and get the result.
+     */
+    HotPage.prototype.process = function (args) {
+        if (args === void 0) { args = null; }
+        return __awaiter(this, void 0, void 0, function () {
+            var output, iIdx, file, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        output = "";
+                        iIdx = 0;
+                        _b.label = 1;
+                    case 1:
+                        if (!(iIdx < this.files.length)) return [3 /*break*/, 4];
+                        file = this.files[iIdx];
+                        Hot_1.Hot.Output = "";
+                        file.page = this;
+                        _a = output;
+                        return [4 /*yield*/, file.process(args)];
+                    case 2:
+                        output = _a + _b.sent();
+                        _b.label = 3;
+                    case 3:
+                        iIdx++;
+                        return [3 /*break*/, 1];
+                    case 4: return [2 /*return*/, (output)];
+                }
+            });
+        });
+    };
+    /**
+     * Add a test element.
+     */
+    HotPage.prototype.addTestElement = function (elm) {
+        if (this.testElements[elm.name] != null)
+            throw new Error("Test element ".concat(elm.name, " already exists!"));
+        this.testElements[elm.name] = elm;
+    };
+    /**
+     * Get a test element.
+     */
+    HotPage.prototype.getTestElement = function (name) {
+        if (this.testElements[name] == null)
+            throw new Error("Test element ".concat(name, " doest not exist!"));
+        return (this.testElements[name]);
+    };
+    /**
+     * Create a test path.
+     */
+    HotPage.prototype.createTestPath = function (pathName, driverFunc) {
+        if (this.testPaths[pathName] != null)
+            throw new Error("Test path ".concat(pathName, " already exists!"));
+        this.testPaths[pathName] = driverFunc;
+    };
+    return HotPage;
+}());
+exports.HotPage = HotPage;
+//# sourceMappingURL=HotPage.js.map

package/build/src/HotPage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HotPage.js","sourceRoot":"","sources":["../../src/HotPage.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAA4B;AAE5B,qCAAoC;AA6CpC;;GAEG;AACH;IAoCC,iBAAa,IAAwB;QAEpC,IAAI,IAAI,YAAY,iBAAO,EAC3B;YACC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YACtB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;YACpB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;YACvB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;SACpB;aAED;YACC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;YAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC;YACxC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;YACtC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC;YAC5C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC;SACtC;IACF,CAAC;IAED;;;OAGG;IACG,yBAAO,GAAb,UAAe,IAAa;;;gBAE3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;gBAEjB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAE,IAAI,CAAC,CAAC;;;;KACvB;IAED;;OAEG;IACH,wBAAM,GAAN;QAEC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,8BAAY,GAAZ;QAEC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACG,sBAAI,GAAV,UAAY,IAAa;;;;;;wBAEf,IAAI,GAAG,CAAC;;;6BAAE,CAAA,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;wBAEtC,SAAgB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAErC,qBAAM,MAAI,CAAC,IAAI,EAAG,EAAA;;wBAAlB,SAAkB,CAAC;;;wBAJyB,IAAI,EAAE,CAAA;;;;;;KAMnD;IAED;;OAEG;IACG,yBAAO,GAAb,UAAe,IAAgB;QAAhB,qBAAA,EAAA,WAAgB;;;;;;wBAE1B,MAAM,GAAW,EAAE,CAAC;wBAEf,IAAI,GAAG,CAAC;;;6BAAE,CAAA,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAA;wBAEtC,IAAI,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAErC,SAAG,CAAC,MAAM,GAAG,EAAE,CAAC;wBAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;wBAEjB,KAAA,MAAM,CAAA;wBAAI,qBAAM,IAAI,CAAC,OAAO,CAAE,IAAI,CAAC,EAAA;;wBAAnC,MAAM,GAAN,KAAU,SAAyB,CAAC;;;wBAPQ,IAAI,EAAE,CAAA;;4BAUnD,sBAAO,CAAC,MAAM,CAAC,EAAC;;;;KAChB;IAED;;OAEG;IACH,gCAAc,GAAd,UAAgB,GAAmB;QAElC,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI;YACtC,MAAM,IAAI,KAAK,CAAE,uBAAgB,GAAG,CAAC,IAAI,qBAAkB,CAAC,CAAC;QAE9D,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,gCAAc,GAAd,UAAgB,IAAY;QAE3B,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI;YAClC,MAAM,IAAI,KAAK,CAAE,uBAAgB,IAAI,sBAAmB,CAAC,CAAC;QAE3D,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,gCAAc,GAAd,UAAgB,QAAgB,EAAE,UAAuB;QAExD,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,IAAI;YACnC,MAAM,IAAI,KAAK,CAAE,oBAAa,QAAQ,qBAAkB,CAAC,CAAC;QAE3D,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC;IACvC,CAAC;IACF,cAAC;AAAD,CAAC,AA3JD,IA2JC;AA3JY,0BAAO"}

package/build/src/HotRoute.d.ts

@@ -0,0 +1,82 @@
+import { HotServer } from "./HotServer";
+import { HotRouteMethod, HTTPMethod, ServerExecutionFunction, TestCaseFunction, TestCaseObject } from "./HotRouteMethod";
+import { HotClient } from "./HotClient";
+import { HotLog } from "./HotLog";
+/**
+ * The route to use.
+ */
+export declare class HotRoute {
+    /**
+     * The server that maintains the connections.
+     */
+    connection: HotServer | HotClient;
+    /**
+     * The associated logger.
+     */
+    logger: HotLog;
+    /**
+     * The route.
+     */
+    route: string;
+    /**
+     * The version.
+     */
+    version: string;
+    /**
+     * The prefix to add to the beginning of each route method.
+     */
+    prefix: string;
+    /**
+     * The authorization credentials to be used by the client
+     * when connecting to the server.
+     */
+    authCredentials: any;
+    /**
+     * The calls that can be made.
+     */
+    methods: HotRouteMethod[];
+    /**
+     * The errors and their JSON that can be thrown. Can be:
+     * * not_authorized
+     */
+    errors: {
+        [error: string]: any;
+    };
+    constructor(connection: HotServer | HotClient, route: string, methods?: HotRouteMethod[]);
+    /**
+     * Create an error JSON object.
+     */
+    static createError(message: string): any;
+    /**
+     * Add an API method to this route.
+     *
+     * @param method The name of the method to add. If a HotRouteMethod is supplied, the
+     * rest of the arguments supplied will be ignored.
+     */
+    addMethod(method: HotRouteMethod | string, executeFunction?: ServerExecutionFunction, type?: HTTPMethod, testCases?: (string | TestCaseFunction)[] | TestCaseFunction[] | TestCaseObject[]): void;
+    /**
+     * Get a method by it's name.
+     */
+    getMethod(name: string): HotRouteMethod;
+    /**
+     * Executes before all routes have been registered.
+     */
+    onPreRegister: () => Promise<void>;
+    /**
+     * Executes when first registering this route with Express. If
+     * this returns false, the route will not be registered.
+     */
+    onRegister: () => Promise<boolean>;
+    /**
+     * Executes after all routes have been registered.
+     */
+    onPostRegister: () => Promise<void>;
+    /**
+     * Executes when authorizing a called method.
+     * The value returned from here will be passed to onExecute in the
+     * called HotRouteMethod. Undefined returning from here will mean
+     * the authorization failed.
+     */
+    onAuthorizeUser: (req: any, res: any) => Promise<any>;
+}
+//# sourceMappingURL=HotRoute.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HotRoute.d.ts","sourceRoot":"","sources":["../../src/HotRoute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACzH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;GAEG;AACH,qBAAa,QAAQ;IAEpB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,eAAe,EAAE,GAAG,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B;;;OAGG;IACH,MAAM,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;gBAEpB,UAAU,EAAE,SAAS,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,cAAc,EAAO;IAqB7F;;OAEG;IACH,MAAM,CAAC,WAAW,CAAE,OAAO,EAAE,MAAM,GAAG,GAAG;IAKzC;;;;;OAKG;IACH,SAAS,CACR,MAAM,EAAE,cAAc,GAAG,MAAM,EAC/B,eAAe,GAAE,uBAA8B,EAC/C,IAAI,GAAE,UAA4B,EAClC,SAAS,GAAE,CAAC,MAAM,GAAG,gBAAgB,CAAC,EAAE,GAAG,gBAAgB,EAAE,GAAG,cAAc,EAAS,GACpF,IAAI;IAQR;;OAEG;IACH,SAAS,CAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAmBxC;;OAEG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAQ;IAC1C;;;OAGG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAQ;IAC1C;;OAEG;IACH,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAQ;IAE3C;;;;;OAKG;IACH,eAAe,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAQ;CAC7D"}

package/build/src/HotRoute.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HotRoute = void 0;
+var HotRouteMethod_1 = require("./HotRouteMethod");
+/**
+ * The route to use.
+ */
+var HotRoute = /** @class */ (function () {
+    function HotRoute(connection, route, methods) {
+        if (methods === void 0) { methods = []; }
+        /**
+         * Executes before all routes have been registered.
+         */
+        this.onPreRegister = null;
+        /**
+         * Executes when first registering this route with Express. If
+         * this returns false, the route will not be registered.
+         */
+        this.onRegister = null;
+        /**
+         * Executes after all routes have been registered.
+         */
+        this.onPostRegister = null;
+        /**
+         * Executes when authorizing a called method.
+         * The value returned from here will be passed to onExecute in the
+         * called HotRouteMethod. Undefined returning from here will mean
+         * the authorization failed.
+         */
+        this.onAuthorizeUser = null;
+        this.connection = connection;
+        this.logger = null;
+        if (this.connection != null) {
+            if (this.connection.processor != null)
+                this.logger = this.connection.processor.logger;
+        }
+        this.route = route;
+        this.version = "v1";
+        this.prefix = "";
+        this.authCredentials = null;
+        this.methods = methods;
+        this.errors = {
+            "not_authorized": HotRoute.createError("Not authorized.")
+        };
+    }
+    /**
+     * Create an error JSON object.
+     */
+    HotRoute.createError = function (message) {
+        return ({ error: message });
+    };
+    /**
+     * Add an API method to this route.
+     *
+     * @param method The name of the method to add. If a HotRouteMethod is supplied, the
+     * rest of the arguments supplied will be ignored.
+     */
+    HotRoute.prototype.addMethod = function (method, executeFunction, type, testCases) {
+        if (executeFunction === void 0) { executeFunction = null; }
+        if (type === void 0) { type = HotRouteMethod_1.HTTPMethod.POST; }
+        if (testCases === void 0) { testCases = null; }
+        if (typeof (method) === "string")
+            method = new HotRouteMethod_1.HotRouteMethod(this, method, executeFunction, type, null, null, null, testCases);
+        this.methods.push(method);
+    };
+    /**
+     * Get a method by it's name.
+     */
+    HotRoute.prototype.getMethod = function (name) {
+        var foundMethod = null;
+        for (var iIdx = 0; iIdx < this.methods.length; iIdx++) {
+            var method = this.methods[iIdx];
+            if (method.name === name) {
+                foundMethod = method;
+                break;
+            }
+        }
+        return (foundMethod);
+    };
+    return HotRoute;
+}());
+exports.HotRoute = HotRoute;
+//# sourceMappingURL=HotRoute.js.map

package/build/src/HotRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HotRoute.js","sourceRoot":"","sources":["../../src/HotRoute.ts"],"names":[],"mappings":";;;AACA,mDAAyH;AAIzH;;GAEG;AACH;IAqCC,kBAAa,UAAiC,EAAE,KAAa,EAAE,OAA8B;QAA9B,wBAAA,EAAA,YAA8B;QAsE7F;;WAEG;QACH,kBAAa,GAAwB,IAAI,CAAC;QAC1C;;;WAGG;QACH,eAAU,GAA2B,IAAI,CAAC;QAC1C;;WAEG;QACH,mBAAc,GAAwB,IAAI,CAAC;QAE3C;;;;;WAKG;QACH,oBAAe,GAAyC,IAAI,CAAC;QAxF5D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QAEnB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAC3B;YACC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,IAAI,IAAI;gBACpC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC;SAChD;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG;YACZ,gBAAgB,EAAE,QAAQ,CAAC,WAAW,CAAE,iBAAiB,CAAC;SAC1D,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,oBAAW,GAAlB,UAAoB,OAAe;QAElC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,4BAAS,GAAT,UACC,MAA+B,EAC/B,eAA+C,EAC/C,IAAkC,EAClC,SAAuF;QAFvF,gCAAA,EAAA,sBAA+C;QAC/C,qBAAA,EAAA,OAAmB,2BAAU,CAAC,IAAI;QAClC,0BAAA,EAAA,gBAAuF;QAGvF,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ;YAC/B,MAAM,GAAG,IAAI,+BAAc,CAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;QAEhG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAE,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,4BAAS,GAAT,UAAW,IAAY;QAEtB,IAAI,WAAW,GAAmB,IAAI,CAAC;QAEvC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,EACrD;YACC,IAAI,MAAM,GAAmB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEhD,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,EACxB;gBACC,WAAW,GAAG,MAAM,CAAC;gBAErB,MAAM;aACN;SACD;QAED,OAAO,CAAC,WAAW,CAAC,CAAC;IACtB,CAAC;IAuBF,eAAC;AAAD,CAAC,AAhID,IAgIC;AAhIY,4BAAQ"}

package/build/src/HotRouteMethod.d.ts

@@ -0,0 +1,129 @@
+import { HotTestDriver } from "./HotTestDriver";
+import { HotRoute } from "./HotRoute";
+/**
+ * Available HTTP methods.
+ */
+export declare enum HTTPMethod {
+    GET = "get",
+    POST = "post"
+}
+/**
+ * A function that will be executed by the server when first registering with Express.
+ * If this returns false, this route method will not be registered.
+ */
+export declare type ServerRegistrationFunction = () => Promise<boolean>;
+/**
+ * A function that will be executed by the server.
+ */
+export declare type ServerExecutionFunction = (req: any, res: any, authorizedValue: any, jsonObj: any, queryObj: any) => Promise<any>;
+/**
+ * A function that will be executed by the client.
+ */
+export declare type ClientExecutionFunction = (...args: any[]) => Promise<any>;
+/**
+ * A function that will be executed by the server for authorization. Any value
+ * returned from this function will be passed to the ServerExecutionFunction.
+ * If an undefined value is returned, this indicates the server was not able
+ * to authenticate the user, so the ServerExecutionFunction will not be
+ * executed.
+ */
+export declare type ServerAuthorizationFunction = (req: any, res: any, jsonObj: any, queryObj: any) => Promise<any>;
+/**
+ * The test case function to execute.
+ */
+export declare type TestCaseFunction = ((driver: HotTestDriver) => Promise<any>) | ((driver: HotTestDriver) => any);
+/**
+ * The test case object to pass.
+ */
+export interface TestCaseObject {
+    /**
+     * The name of the test case.
+     */
+    name: string;
+    /**
+     * The function to execute.
+     */
+    func: TestCaseFunction;
+}
+/**
+ * An API method to make.
+ */
+export declare class HotRouteMethod {
+    /**
+     * The parent route.
+     */
+    parentRoute: HotRoute;
+    /**
+     * The api call name.
+     */
+    name: string;
+    /**
+     * The api call name.
+     */
+    type: HTTPMethod;
+    /**
+     * Has this method been registered with the server? This
+     * prevents the method from being reregistered.
+     */
+    isRegistered: boolean;
+    /**
+     * Has this method been registered with the server? This
+     * prevents the method from being reregistered.
+     */
+    executeSetup: boolean;
+    /**
+     * The authorization credentials to be used by the client
+     * when connecting to the server.
+     */
+    authCredentials: any;
+    /**
+     * The test case objects to execute during tests.
+     */
+    testCases: {
+        [name: string]: TestCaseObject;
+    };
+    constructor(route: HotRoute, name: string, onExecute?: ServerExecutionFunction | ClientExecutionFunction, type?: HTTPMethod, onServerAuthorize?: ServerAuthorizationFunction, onRegister?: ServerRegistrationFunction, authCredentials?: any, testCases?: (string | TestCaseFunction)[] | TestCaseFunction[] | TestCaseObject[]);
+    /**
+     * Executes before all routes have been registered.
+     */
+    onPreRegister?: () => Promise<void>;
+    /**
+     * Executes when first registering this method with Express. If
+     * this returns false, the method will not be registered.
+     */
+    onRegister?: ServerRegistrationFunction;
+    /**
+     * Executes after all routes have been registered.
+     */
+    onPostRegister?: () => Promise<void>;
+    /**
+     * Executes when authorizing a called method. If this method
+     * is set, this will not call onAuthorize for the parent HotRoute.
+     * The value returned from here will be passed to onExecute.
+     * Undefined returning from here will mean the authorization failed.
+     * If any exceptions are thrown from this function, they will be sent
+     * to the server as an { error: string; } object with the exception
+     * message as the error.
+     */
+    onServerAuthorize?: ServerAuthorizationFunction;
+    /**
+     * Executes when executing a called method from the server side.
+     * This will stringify any JSON object and send it as a JSON response.
+     * If undefined is returned no response will be sent to the server.
+     * So the developer would have to send a response using "res".
+     * If any exceptions are thrown from this function, they will be sent
+     * to the server as an { error: string; } object with the exception
+     * message as the error.
+     */
+    onServerExecute?: ServerExecutionFunction;
+    /**
+     * Executes when executing a called method from the client side.
+     * @fixme Is this necessary?
+     */
+    onClientExecute?: ClientExecutionFunction;
+    /**
+     * Add a new test case.
+     */
+    addTestCase(newTestCase: TestCaseObject | string | TestCaseFunction, testCaseFunction?: TestCaseFunction): void;
+}
+//# sourceMappingURL=HotRouteMethod.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HotRouteMethod.d.ts","sourceRoot":"","sources":["../../src/HotRouteMethod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;GAEG;AACH,oBAAY,UAAU;IAErB,GAAG,QAAQ;IACX,IAAI,SAAS;CACb;AAED;;;GAGG;AACH,oBAAY,0BAA0B,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;AAChE;;GAEG;AACH,oBAAY,uBAAuB,GAClC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AACzF;;GAEG;AACH,oBAAY,uBAAuB,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AACvE;;;;;;GAMG;AACH,oBAAY,2BAA2B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAC5G;;GAEG;AACH,oBAAY,gBAAgB,GAAG,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,GAAG,CAAC,CAAC;AAC5G;;GAEG;AACH,MAAM,WAAW,cAAc;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,cAAc;IAE1B;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IACjB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,eAAe,EAAE,GAAG,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE;QACT,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC;KAC/B,CAAC;gBAEU,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EACzC,SAAS,GAAE,uBAAuB,GAAG,uBAA8B,EACnE,IAAI,GAAE,UAA4B,EAAE,iBAAiB,GAAE,2BAAkC,EACzF,UAAU,GAAE,0BAAiC,EAAE,eAAe,GAAE,GAAU,EAC1E,SAAS,GAAE,CAAC,MAAM,GAAG,gBAAgB,CAAC,EAAE,GAAG,gBAAgB,EAAE,GAAG,cAAc,EAAS;IAwCxF;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,0BAA0B,CAAC;IACxC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,2BAA2B,CAAC;IAEhD;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC;IAC1C;;;OAGG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAE,WAAW,EAAE,cAAc,GAAG,MAAM,GAAG,gBAAgB,EAClE,gBAAgB,GAAE,gBAAuB,GAAG,IAAI;CAgClD"}

package/build/src/HotRouteMethod.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HotRouteMethod = exports.HTTPMethod = void 0;
+var Hot_1 = require("./Hot");
+var HotServer_1 = require("./HotServer");
+/**
+ * Available HTTP methods.
+ */
+var HTTPMethod;
+(function (HTTPMethod) {
+    HTTPMethod["GET"] = "get";
+    HTTPMethod["POST"] = "post";
+})(HTTPMethod = exports.HTTPMethod || (exports.HTTPMethod = {}));
+/**
+ * An API method to make.
+ */
+var HotRouteMethod = /** @class */ (function () {
+    function HotRouteMethod(route, name, onExecute, type, onServerAuthorize, onRegister, authCredentials, testCases) {
+        if (onExecute === void 0) { onExecute = null; }
+        if (type === void 0) { type = HTTPMethod.POST; }
+        if (onServerAuthorize === void 0) { onServerAuthorize = null; }
+        if (onRegister === void 0) { onRegister = null; }
+        if (authCredentials === void 0) { authCredentials = null; }
+        if (testCases === void 0) { testCases = null; }
+        this.parentRoute = route;
+        this.name = name;
+        this.type = type;
+        this.isRegistered = false;
+        this.executeSetup = false;
+        this.authCredentials = authCredentials;
+        this.onServerAuthorize = onServerAuthorize;
+        this.onRegister = onRegister;
+        this.testCases = {};
+        if (this.parentRoute.connection.processor.mode === Hot_1.DeveloperMode.Development) {
+            if (testCases != null) {
+                for (var iIdx = 0; iIdx < testCases.length; iIdx++) {
+                    var obj = testCases[iIdx];
+                    if (typeof (obj) === "string") {
+                        var name_1 = obj;
+                        var func = testCases[iIdx + 1];
+                        this.addTestCase(name_1, func);
+                        iIdx++;
+                    }
+                    else
+                        this.addTestCase(obj);
+                }
+            }
+        }
+        if (this.parentRoute.connection instanceof HotServer_1.HotServer)
+            this.onServerExecute = onExecute;
+        //else
+        //this.onClientExecute = onExecute;
+    }
+    /**
+     * Add a new test case.
+     */
+    HotRouteMethod.prototype.addTestCase = function (newTestCase, testCaseFunction) {
+        if (testCaseFunction === void 0) { testCaseFunction = null; }
+        if (typeof (newTestCase) === "string") {
+            var name_2 = newTestCase;
+            var func = testCaseFunction;
+            this.testCases[name_2] = {
+                name: name_2,
+                func: func
+            };
+            return;
+        }
+        if (typeof (newTestCase) === "function") {
+            var testCaseId = Object.keys(this.testCases).length;
+            var name_3 = "".concat(this.parentRoute.route, "/").concat(this.name, " test case ").concat(testCaseId);
+            var func = newTestCase;
+            this.testCases[name_3] = {
+                name: name_3,
+                func: func
+            };
+            return;
+        }
+        var testCase = newTestCase;
+        this.testCases[testCase.name] = testCase;
+    };
+    return HotRouteMethod;
+}());
+exports.HotRouteMethod = HotRouteMethod;
+//# sourceMappingURL=HotRouteMethod.js.map

package/build/src/HotRouteMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HotRouteMethod.js","sourceRoot":"","sources":["../../src/HotRouteMethod.ts"],"names":[],"mappings":";;;AAAA,6BAAsC;AAGtC,yCAAwC;AAExC;;GAEG;AACH,IAAY,UAIX;AAJD,WAAY,UAAU;IAErB,yBAAW,CAAA;IACX,2BAAa,CAAA;AACd,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AA2CD;;GAEG;AACH;IAoCC,wBAAa,KAAe,EAAE,IAAY,EACzC,SAAmE,EACnE,IAAkC,EAAE,iBAAqD,EACzF,UAA6C,EAAE,eAA2B,EAC1E,SAAuF;QAHvF,0BAAA,EAAA,gBAAmE;QACnE,qBAAA,EAAA,OAAmB,UAAU,CAAC,IAAI;QAAE,kCAAA,EAAA,wBAAqD;QACzF,2BAAA,EAAA,iBAA6C;QAAE,gCAAA,EAAA,sBAA2B;QAC1E,0BAAA,EAAA,gBAAuF;QAEvF,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,mBAAa,CAAC,WAAW,EAC5E;YACC,IAAI,SAAS,IAAI,IAAI,EACrB;gBACC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,EAClD;oBACC,IAAI,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;oBAE1B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAC7B;wBACC,IAAM,MAAI,GAAW,GAAG,CAAC;wBACzB,IAAM,IAAI,GAAwC,SAAS,CAAC,IAAI,GAAG,CAAC,CAAE,CAAC;wBAEvE,IAAI,CAAC,WAAW,CAAE,MAAI,EAAE,IAAI,CAAC,CAAC;wBAC9B,IAAI,EAAE,CAAC;qBACP;;wBAEA,IAAI,CAAC,WAAW,CAAE,GAAG,CAAC,CAAC;iBACxB;aACD;SACD;QAED,IAAI,IAAI,CAAC,WAAW,CAAC,UAAU,YAAY,qBAAS;YACnD,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QAClC,MAAM;QACL,mCAAmC;IACrC,CAAC;IA2CD;;OAEG;IACH,oCAAW,GAAX,UAAa,WAAuD,EAClE,gBAAyC;QAAzC,iCAAA,EAAA,uBAAyC;QAE1C,IAAI,OAAO,CAAC,WAAW,CAAC,KAAK,QAAQ,EACrC;YACC,IAAM,MAAI,GAAW,WAAW,CAAC;YACjC,IAAM,IAAI,GAAqB,gBAAgB,CAAC;YAEhD,IAAI,CAAC,SAAS,CAAC,MAAI,CAAC,GAAG;gBACrB,IAAI,EAAE,MAAI;gBACV,IAAI,EAAE,IAAI;aACV,CAAC;YAEH,OAAO;SACP;QAED,IAAI,OAAO,CAAC,WAAW,CAAC,KAAK,UAAU,EACvC;YACC,IAAM,UAAU,GAAW,MAAM,CAAC,IAAI,CAAE,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC;YAC/D,IAAM,MAAI,GAAW,UAAG,IAAI,CAAC,WAAW,CAAC,KAAK,cAAI,IAAI,CAAC,IAAI,wBAAc,UAAU,CAAE,CAAC;YACtF,IAAM,IAAI,GAAwC,WAAY,CAAC;YAE/D,IAAI,CAAC,SAAS,CAAC,MAAI,CAAC,GAAG;gBACrB,IAAI,EAAE,MAAI;gBACV,IAAI,EAAE,IAAI;aACV,CAAC;YAEH,OAAO;SACP;QAED,IAAM,QAAQ,GAAoC,WAAY,CAAC;QAC/D,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;IAC1C,CAAC;IACF,qBAAC;AAAD,CAAC,AA7JD,IA6JC;AA7JY,wCAAc"}