hotstaq 0.8.21 → 0.8.23

package/build-web/HotStaq.min.js

@@ -90,7 +90,7 @@ void 0,void 0,function*(){for(;!1===y.isReadyForTesting;)yield y.wait(10);null!=
 (h+='<script type = "text/javascript">\nfunction hotstaq_isDocumentReady ()\n{\nif (window["Hot"] != null)\n{\nif (Hot.Mode === HotStaqWeb.DeveloperMode.Development)\n{\nlet func = function ()\n\t{\n\t\tif (Hot.TesterAPI != null)\n\t\t{\n\t\t\tlet testPaths = {};\n\t\t\tlet testElements = JSON.stringify (Hot.CurrentPage.testElements);\n\t\t\tlet testMaps = JSON.stringify (Hot.CurrentPage.testMaps);\n\n\t\t\tfor (let key in Hot.CurrentPage.testPaths)\n\t\t\t{\n\t\t\t\tlet testPath = Hot.CurrentPage.testPaths[key];\n\n\t\t\t\ttestPaths[key] = testPath.toString ();\n\t\t\t}\n\n\t\t\tlet testPathsStr = JSON.stringify (testPaths);\n\n\t\t\tHot.TesterAPI.tester.pageLoaded ({\n\t\t\t\t\ttesterName: Hot.CurrentPage.testerName,\n\t\t\t\t\ttesterMap: Hot.CurrentPage.testerMap,\n\t\t\t\t\tpageName: Hot.CurrentPage.name,\n\t\t\t\t\ttestElements: testElements,\n\t\t\t\t\ttestPaths: testPathsStr\n\t\t\t\t}).then (function (resp)\n\t\t\t\t\t{\n\t\t\t\t\t\tif (resp.error != null)\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tif (resp.error !== "")\n\t\t\t\t\t\t\t\tthrow new Error (resp.error);\n\t\t\t\t\t\t}\n\n\t\t\t\t\t\tHotStaqWeb.HotStaq.isReadyForTesting = true;\n\t\t\t\t\t});\n\t\t}\n\t};\n\nif ((document.readyState === "complete") || (document.readyState === "interactive"))\n\tfunc ();\nelse\n\tdocument.addEventListener ("DOMContentLoaded", func);\n}\n}\n}\n\nhotstaq_isDocumentReady ();\n\x3c/script>'),
 h}static displayUrl(b,h=null,t=null,x=null){return A(this,void 0,void 0,function*(){return new Promise((H,I)=>{y.onReady(()=>A(this,void 0,void 0,function*(){var C={url:""};C.name=null==h?"string"==typeof b?b:b.name:h;""===C.name&&(C.name="string"==typeof b?b:b.name);"string"==typeof b?C.url=b:(C.url=b.url,null==t&&null!=b.processor&&(t=b.processor),null==x&&null!=b.args&&(x=b.args),null!=b.testerMap&&(C.testerMap=b.testerMap),null!=b.testerName&&(C.testerName=b.testerName),null!=b.testerAPIBaseUrl&&
 (C.testerAPIBaseUrl=b.testerAPIBaseUrl));null==t&&(t=new y);y.setupTesters(t,C);C.processor=t;C.args=x;0>C.url.indexOf("hstqserve")&&(C.url+="?hstqserve=nahfam");C=yield y.processUrl(C);C+=y.setupClientTesters(t);yield y.useOutput(C);H(t)}))})})}static displayContent(b,h=null,t=null,x=null){return A(this,void 0,void 0,function*(){return new Promise((H,I)=>{y.onReady(()=>A(this,void 0,void 0,function*(){var C={content:""};C.name=null==h?"string"==typeof b?"":b.name:h;""===C.name&&(C.name="string"==
-typeof b?"":b.name);"string"==typeof b?C.content=b:(C.content=b.content,null==t&&null!=b.processor&&(t=b.processor),null==x&&null!=b.args&&(x=b.args),null!=b.testerMap&&(C.testerMap=b.testerMap),null!=b.testerName&&(C.testerName=b.testerName),null!=b.testerAPIBaseUrl&&(C.testerAPIBaseUrl=b.testerAPIBaseUrl));null==t&&(t=new y);y.setupTesters(t,C);C.processor=t;C.args=x;C=yield y.processContent(C);yield y.useOutput(C);H(t)}))})})}}u.HotStaq=y;y.version="0.8.21";y.isWeb=!1;y.isReadyForTesting=!1;y.onReadyForTesting=
+typeof b?"":b.name);"string"==typeof b?C.content=b:(C.content=b.content,null==t&&null!=b.processor&&(t=b.processor),null==x&&null!=b.args&&(x=b.args),null!=b.testerMap&&(C.testerMap=b.testerMap),null!=b.testerName&&(C.testerName=b.testerName),null!=b.testerAPIBaseUrl&&(C.testerAPIBaseUrl=b.testerAPIBaseUrl));null==t&&(t=new y);y.setupTesters(t,C);C.processor=t;C.args=x;C=yield y.processContent(C);yield y.useOutput(C);H(t)}))})})}}u.HotStaq=y;y.version="0.8.23";y.isWeb=!1;y.isReadyForTesting=!1;y.onReadyForTesting=
 null;y.errors={};"undefined"!=typeof document&&window.addEventListener("load",p.hotStaqWebStart)},638:(G,u,p)=>{Object.defineProperty(u,"__esModule",{value:!0});u.registerComponent=void 0;const m=p(732),v=p(260),A=p(243),g=p(507);u.registerComponent=function(e,n){if(null==e||""===e)throw Error("All components must have a tag!");if(void 0===customElements.get(e)){var l=this.components;customElements.define(e,class extends HTMLElement{constructor(){super();var c=l[e];if(this.component=new c.componentType(c.processor,
 c.api),this.hotComponent=this.component,this.component.htmlElements=[this],this.component.inner=this.innerHTML,null!=this.component.handleAttributes)this.component.handleAttributes(this.attributes);else for(c=0;c<this.attributes.length;c++){var a=this.attributes[c],f=a.name.toLowerCase();a=a.value;if("id"===f&&(this.component.name=a),"name"===f&&(this.component.name=a),"value"===f&&(this.component.value=a),-1<f.indexOf("hot-"))f=f.substring(4),this.component[f]=a}if(null==this.component.onPreOutput||
 !1!==this.component.onPreOutput())for(f=this.component.output(),null!=this.component.onPostOutput&&(f=this.component.onPostOutput(f)),c=[],"string"==typeof f?c.push({html:f}):c=f instanceof Array?f:[f],f=0;f<c.length;f++){a=c[f];var d=a.html,k="";null!=a.addFunctionsTo&&(k=a.addFunctionsTo);d=m.HotFile.parseContent(d,!0,{outputCommands:!1});null!=this.component.onParsed&&(d=this.component.onParsed(d));var r={fixedStr:"",querySelector:""};r=null!=this.component.onFixHTML?this.component.onFixHTML(d):

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hotstaq",
-  "version": "0.8.21",
+  "version": "0.8.23",
   "description": "A friendly web framework that fits nicely into devops and CI/CD pipelines.",
   "bin": {
     "hotstaq": "./bin/hotstaq"

package/src/HotCLI.ts

@@ -1256,7 +1256,7 @@ export class HotCLI
 			{
 				testerSettings.remoteServer = remoteServer;
 			}, "");
-		runCmd.option (`--accept-websocket-connections`, 
+		runCmd.option (`--ws, --accept-websocket-connections`, 
 			`This will allow the all servers to accept websocket connections.`, 
 			(remoteServer: string, previous: any) =>
 			{

package/src/HotFile.ts

@@ -4,7 +4,6 @@ import fetch from "node-fetch";
 
 import { DeveloperMode, Hot } from "./Hot";
 import { HotPage } from "./HotPage";
-import { HotTestElement } from "./HotTestElement";
 
 /**
  * A file to process.

package/src/HotGenerator.ts

@@ -130,6 +130,9 @@ export class HotGenerator
 				res.json ({ "status": "ok" });
 			});
 
+		if (server.api.onPreRegister != null)
+			await server.api.onPreRegister ();
+
 		//server.serverType = "API Server";
 		//await server.listen ();
 
@@ -368,6 +371,7 @@ export class HotGenerator
 				if (this.generateType.indexOf ("openapi-3.0.0") > -1)
 					jsonObj.openapi = "3.0.0";
 
+				let filename: string = `${libraryName}_${apiName}_${this.generateType}`;
 				jsonObj.info = {};
 				jsonObj.info.title = hotsite.name;
 				jsonObj.info.version = hotsite.name;
@@ -387,6 +391,8 @@ export class HotGenerator
 					if (route.description != null)
 						routeDescription = route.description;
 
+					this.logger.verbose (`Generating Route ${routeName}...`);
+
 					for (let iJdx = 0; iJdx < route.methods.length; iJdx++)
 					{
 						let method: HotRouteMethod = route.methods[iJdx];
@@ -398,10 +404,13 @@ export class HotGenerator
 							};
 						let component: any = null;
 						let componentName: string = "";
+
+						this.logger.verbose (`Generating method ${methodName} at path ${path}`);
+
 						let getChildParameters = (param: HotRouteMethodParameter): any =>
 							{
 								let createdObj: any = {
-										type: param.type,
+										type: param.type || "string",
 										description: param.description || "",
 										properties: {}
 									};
@@ -433,8 +442,8 @@ export class HotGenerator
 										else
 										{
 											createdObj.properties[key3] = {
-													type: tempParam.type,
-													description: tempParam.description
+													type: tempParam.type || "string",
+													description: tempParam.description || ""
 												};
 										}
 									}
@@ -451,7 +460,7 @@ export class HotGenerator
 							if (method.returns.type === "object")
 							{
 								returnsDescription = {
-										description: method.returns.description,
+										description: method.returns.description || "",
 										content: {
 											"application/json": {
 												schema: getChildParameters (method.returns)
@@ -462,12 +471,12 @@ export class HotGenerator
 							else
 							{
 								returnsDescription = {
-										description: method.returns.description,
+										description: method.returns.description || "",
 										content: {
 											"application/json": {
 													schema: {
 														type: "string", 
-														description: method.returns.description
+														description: method.returns.description || ""
 													}
 												}
 										}
@@ -489,7 +498,6 @@ export class HotGenerator
 							{
 								components[`${routeName}_${methodName}`] = {
 									type: "object",
-									required: [],
 									properties: {}
 								};
 								component = components[`${routeName}_${methodName}`];
@@ -505,13 +513,18 @@ export class HotGenerator
 								else
 								{
 									component.properties[key3] = {
-											type: param.type,
-											description: param.description
+											type: param.type || "string",
+											description: param.description || ""
 										};
 								}
 
 								if (param.required === true)
+								{
+									if (component.required == null)
+										component.required = [];
+
 									component.required.push (key3);
+								}
 							}
 						}
 
@@ -535,7 +548,7 @@ export class HotGenerator
 					schemas: components
 				};
 
-				const outputFile: string = ppath.normalize (`${outputDir}/${jsonObj.info.title}`);
+				const outputFile: string = ppath.normalize (`${outputDir}/${filename}`);
 				let outputFileExtension: string = ".json";
 				let fileContent: string = "";
 
@@ -552,6 +565,7 @@ export class HotGenerator
 					fileContent = yamldoc.toString ();
 				}
 
+				this.logger.verbose (`Writing to file ${outputFile}${outputFileExtension}`);
 				await HotIO.writeTextFile (`${outputFile}${outputFileExtension}`, fileContent);
 
 				this.logger.info (`Finished generating API Documentation "${key}" from HotSite "${hotsite.name}"...`);
@@ -833,7 +847,7 @@ class ${data.routeName}
 							else
 							{
 								outputParams += `
-	 * @property {${tempParam.type}} ${key3} ${tempParam.description}`;
+	 * @property {${tempParam.type || "string"}} ${key3} ${tempParam.description || ""}`;
 							}
 						}
 					}
@@ -859,7 +873,7 @@ class ${data.routeName}
 					else
 					{
 						paramsToOutput += `
-	 * @property {${param.type}} ${key} ${param.description}`;
+	 * @property {${param.type || "string"}} ${key} ${param.description || ""}`;
 					}
 				}
 
@@ -891,13 +905,13 @@ class ${data.routeName}
 	`;
 					jsonReturnOutput = `
 	 * 
-	 * @returns {${returnObjType}} ${method.returns.description}`;
+	 * @returns {${returnObjType}} ${method.returns.description || ""}`;
 				}
 				else
 				{
 					jsonReturnOutput = `
 	 * 
-	 * @returns {${method.returns.type}} ${method.returns.description}`;
+	 * @returns {${method.returns.type}} ${method.returns.description || ""}`;
 				}
 			}
 

package/src/HotHTTPServer.ts

@@ -172,6 +172,43 @@ export class HotHTTPServer extends HotServer
 	 * If set to true, worker threads will be used. NOT WORKING YET. DO NOT USE.
 	 */
 	useWorkerThreads: boolean;
+	/**
+	 * The options to use when a new client has made a request.
+	 */
+	options: {
+			/**
+			 * Executes when the new client has requested the headers.
+			 */
+			onCall: (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<void>;
+			/**
+			 * The headers to send with the response. Default:
+			 * [
+			 *	 { type: "Access-Control-Allow-Origin", value: "*" },
+			 *	 { type: "Access-Control-Allow-Methods", value: "GET,HEAD,PUT,PATCH,POST,DELETE" },
+			 *	 { type: "Access-Control-Allow-Headers", value: "Origin, X-Requested-With, Content-Type, Accept" }
+			 * ]
+			 */
+			headers: HTTPHeader[];
+		};
+	/**
+	 * The CORS settings. By default the origin will be open to all.
+	 * The CORS settings that are set here will also be used for the 
+	 * websocket server as well.
+	 */
+	cors: {
+			/**
+			 * Executed when a CORS call has been made.
+			 */
+			onCORSCall: (req: express.Request, res: express.Response, next: express.NextFunction) => Promise<void>;
+			/**
+			 * The allowed CORS origins. Default: *
+			 */
+			origin: string;
+			/**
+			 * The allowed headers. Default: ["Origin", "X-Requested-With", "Content-Type", "Accept"]
+			 */
+			allowedHeaders: string[];
+		};
 	/**
 	 * The function to execute when handling 404 errors.
 	 */
@@ -207,6 +244,19 @@ export class HotHTTPServer extends HotServer
 				afterUploadIdUse: true
 			};
 		this.useWorkerThreads = false;
+		this.options = {
+				onCall: null,
+				headers: [
+					{ type: "Access-Control-Allow-Origin", value: "*" },
+					{ type: "Access-Control-Allow-Methods", value: "GET,HEAD,PUT,PATCH,POST,DELETE" },
+					{ type: "Access-Control-Allow-Headers", value: "Origin, X-Requested-With, Content-Type, Accept" }
+				]
+			};
+		this.cors = {
+			onCORSCall: null,
+			origin: "*",
+			allowedHeaders: ["Origin", "X-Requested-With", "Content-Type", "Accept"]
+		};
 		this.handle404 = null;
 		this.handleOther = null;
 
@@ -263,20 +313,37 @@ export class HotHTTPServer extends HotServer
 				JSONLimit = process.env.JSON_LIMIT;
 		}
 
-		this.expressApp.options ("*", (req: express.Request, res: express.Response, next: express.NextFunction) =>
+		this.expressApp.options ("*", async (req: express.Request, res: express.Response, next: express.NextFunction) =>
 			{
-				res.header ("Access-Control-Allow-Origin", "*");
-				res.header ("Access-Control-Allow-Methods", "GET,HEAD,PUT,PATCH,POST,DELETE");
-				res.header ("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
+				if (this.options.onCall != null)
+				{
+					await this.options.onCall (req, res, next);
+
+					return;
+				}
+
+				for (let iIdx = 0; iIdx < this.options.headers.length; iIdx++)
+				{
+					let header: HTTPHeader = this.options.headers[iIdx];
+
+					res.header (header.type, header.value);
+				}
 
 				res.statusCode = 204;
 				res.setHeader ("Content-Length", "0");
 				res.end ();
 			});
-		this.expressApp.use ((req: express.Request, res: express.Response, next: express.NextFunction) =>
+		this.expressApp.use (async (req: express.Request, res: express.Response, next: express.NextFunction) =>
 			{
-				res.header ("Access-Control-Allow-Origin", "*");
-				res.header ("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
+				if (this.cors.onCORSCall != null)
+				{
+					await this.cors.onCORSCall (req, res, next);
+
+					return;
+				}
+
+				res.header ("Access-Control-Allow-Origin", this.cors.origin);
+				res.header ("Access-Control-Allow-Headers", this.cors.allowedHeaders);
 
 				next ();
 			});

package/src/HotHTTPServerProcessRequest.ts

@@ -182,7 +182,7 @@ export async function processRequest (server: HotHTTPServer,
 			}
 			catch (ex)
 			{
-				logger.verbose (`Execution error: ${ex.message}`);
+				logger.error (`Execution error: ${ex.message}`);
 				return ({ error: ex.message });
 			}
 

package/src/HotStaq.ts

@@ -131,7 +131,7 @@ export class HotStaq implements IHotStaq
 	/**
 	 * The current version of HotStaq.
 	 */
-	static version: string = "0.8.21";
+	static version: string = "0.8.23";
 	/**
 	 * Indicates if this is a web build.
 	 */

package/src/HotWebSocketClient.ts

@@ -15,11 +15,16 @@ export class HotWebSocketClient
 	 * The connected socket.
 	 */
 	socket: Socket;
+	/**
+	 * Any data that this client socket should contain.
+	 */
+	persistentData: any;
 
 	constructor (webSocketServer: HotWebSocketServer, socket: Socket)
 	{
 		this.webSocketServer = webSocketServer;
 		this.socket = socket;
+		this.persistentData = {};
 	}
 
 	/**

package/src/HotWebSocketServer.ts

@@ -77,12 +77,22 @@ export class HotWebSocketServer
 	{
 		if (this.connection.httpsListener != null)
 		{
-			this.io = new Server (this.connection.httpsListener);
+			this.io = new Server (this.connection.httpsListener, {
+					"cors": {
+						"origin": this.connection.cors.origin,
+						"allowedHeaders": this.connection.cors.allowedHeaders
+					}
+				});
 			this.logger.info (`Secure WebSocket server listening...`);
 		}
 		else
 		{
-			this.io = new Server (this.connection.httpListener);
+			this.io = new Server (this.connection.httpListener, {
+					"cors": {
+						"origin": this.connection.cors.origin,
+						"allowedHeaders": this.connection.cors.allowedHeaders
+					}
+				});
 			this.logger.info (`WebSocket server listening...`);
 		}
 
@@ -183,6 +193,8 @@ export class HotWebSocketServer
 											"jsonObj": jsonObj,
 											"wsSocket": wsSocket
 										});
+
+									socket.data.wsSocket = wsSocket;
 					
 									let result: any = await method.onServerExecute.call (this, request);
 					
@@ -193,7 +205,7 @@ export class HotWebSocketServer
 								}
 								catch (ex)
 								{
-									this.logger.verbose (`Execution error: ${ex.message}`);
+									this.logger.error (`Execution error: ${ex.message}`);
 									socket.emit (`sub/${routeName}/${method.name}`, { error: ex.message });
 								}
 							});