hotstaq 0.5.3

package/docs/interfaces/MySQLSchemaFieldResult.md

@@ -0,0 +1,75 @@
+[hotstaq](../README.md) / [Modules](../modules.md) / MySQLSchemaFieldResult
+
+# Interface: MySQLSchemaFieldResult
+
+The resulting data from a generated field.
+
+## Table of contents
+
+### Properties
+
+- [constraint](MySQLSchemaFieldResult.md#constraint)
+- [field](MySQLSchemaFieldResult.md#field)
+- [foreignKey](MySQLSchemaFieldResult.md#foreignkey)
+- [key](MySQLSchemaFieldResult.md#key)
+- [primaryKey](MySQLSchemaFieldResult.md#primarykey)
+
+## Properties
+
+### constraint
+
+• `Optional` **constraint**: `string`
+
+The constraint to be added.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:23](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L23)
+
+___
+
+### field
+
+• `Optional` **field**: `string`
+
+The field to be entered.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:11](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L11)
+
+___
+
+### foreignKey
+
+• `Optional` **foreignKey**: `string`
+
+The foreign key to be added.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:27](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L27)
+
+___
+
+### key
+
+• `Optional` **key**: `string`
+
+The key to be added.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:19](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L19)
+
+___
+
+### primaryKey
+
+• `Optional` **primaryKey**: `string`
+
+The primary key to be added.
+
+#### Defined in
+
+[schemas/mysql/MySQLSchemaField.ts:15](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/schemas/mysql/MySQLSchemaField.ts#L15)

package/docs/modules.md

@@ -0,0 +1,182 @@
+[hotstaq](README.md) / Modules
+
+# hotstaq
+
+## Table of contents
+
+### Enumerations
+
+- [ConnectionStatus](enums/ConnectionStatus.md)
+- [DeveloperMode](enums/DeveloperMode.md)
+- [EventExecutionType](enums/EventExecutionType.md)
+- [HTTPMethod](enums/HTTPMethod.md)
+- [HotDBGenerationType](enums/HotDBGenerationType.md)
+- [HotLogLevel](enums/HotLogLevel.md)
+
+### Classes
+
+- [Hot](classes/Hot.md)
+- [HotAPI](classes/HotAPI.md)
+- [HotClient](classes/HotClient.md)
+- [HotComponent](classes/HotComponent.md)
+- [HotDB](classes/HotDB.md)
+- [HotDBInflux](classes/HotDBInflux.md)
+- [HotDBMigration](classes/HotDBMigration.md)
+- [HotDBMySQL](classes/HotDBMySQL.md)
+- [HotDBSchema](classes/HotDBSchema.md)
+- [HotFile](classes/HotFile.md)
+- [HotHTTPServer](classes/HotHTTPServer.md)
+- [HotLog](classes/HotLog.md)
+- [HotPage](classes/HotPage.md)
+- [HotRoute](classes/HotRoute.md)
+- [HotRouteMethod](classes/HotRouteMethod.md)
+- [HotServer](classes/HotServer.md)
+- [HotStaq](classes/HotStaq.md)
+- [HotTestDestination](classes/HotTestDestination.md)
+- [HotTestDriver](classes/HotTestDriver.md)
+- [HotTestElement](classes/HotTestElement.md)
+- [HotTestElementOptions](classes/HotTestElementOptions.md)
+- [HotTestMap](classes/HotTestMap.md)
+- [HotTestSeleniumDriver](classes/HotTestSeleniumDriver.md)
+- [HotTester](classes/HotTester.md)
+- [HotTesterAPI](classes/HotTesterAPI.md)
+- [HotTesterMocha](classes/HotTesterMocha.md)
+- [HotTesterMochaSelenium](classes/HotTesterMochaSelenium.md)
+- [HotTesterServer](classes/HotTesterServer.md)
+- [InfluxSchema](classes/InfluxSchema.md)
+- [MySQLSchema](classes/MySQLSchema.md)
+- [MySQLSchemaField](classes/MySQLSchemaField.md)
+- [MySQLSchemaTable](classes/MySQLSchemaTable.md)
+
+### Interfaces
+
+- [HotDBConnectionInterface](interfaces/HotDBConnectionInterface.md)
+- [HotDestination](interfaces/HotDestination.md)
+- [HotSite](interfaces/HotSite.md)
+- [HotSiteMapPath](interfaces/HotSiteMapPath.md)
+- [HotSiteRoute](interfaces/HotSiteRoute.md)
+- [HotStartOptions](interfaces/HotStartOptions.md)
+- [HotTestPage](interfaces/HotTestPage.md)
+- [HotTestStop](interfaces/HotTestStop.md)
+- [IHotComponent](interfaces/IHotComponent.md)
+- [IHotStaq](interfaces/IHotStaq.md)
+- [IHotTestElement](interfaces/IHotTestElement.md)
+- [IHotTestElementOptions](interfaces/IHotTestElementOptions.md)
+- [MySQLResults](interfaces/MySQLResults.md)
+- [MySQLSchemaFieldResult](interfaces/MySQLSchemaFieldResult.md)
+
+### Type aliases
+
+- [APItoLoad](modules.md#apitoload)
+- [HotTestPath](modules.md#hottestpath)
+- [ServerAuthorizationFunction](modules.md#serverauthorizationfunction)
+- [ServerExecutionFunction](modules.md#serverexecutionfunction)
+
+## Type aliases
+
+### APItoLoad
+
+Ƭ **APItoLoad**: `Object`
+
+The API to load.
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `exportedClassName` | `string` |
+| `path` | `string` |
+
+#### Defined in
+
+[HotAPI.ts:14](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotAPI.ts#L14)
+
+___
+
+### HotTestPath
+
+Ƭ **HotTestPath**: (`driver`: [`HotTestDriver`](classes/HotTestDriver.md), ...`args`: `any`) => `Promise`<`any`\>
+
+#### Type declaration
+
+▸ (`driver`, ...`args`): `Promise`<`any`\>
+
+Create a test path for later execution.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `driver` | [`HotTestDriver`](classes/HotTestDriver.md) |
+| `...args` | `any` |
+
+##### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotTestMap.ts:8](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotTestMap.ts#L8)
+
+___
+
+### ServerAuthorizationFunction
+
+Ƭ **ServerAuthorizationFunction**: (`req`: `any`, `res`: `any`, `jsonObj`: `any`, `queryObj`: `any`) => `Promise`<`any`\>
+
+#### Type declaration
+
+▸ (`req`, `res`, `jsonObj`, `queryObj`): `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.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `req` | `any` |
+| `res` | `any` |
+| `jsonObj` | `any` |
+| `queryObj` | `any` |
+
+##### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotRouteMethod.ts:36](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotRouteMethod.ts#L36)
+
+___
+
+### ServerExecutionFunction
+
+Ƭ **ServerExecutionFunction**: (`req`: `any`, `res`: `any`, `authorizedValue`: `any`, `jsonObj`: `any`, `queryObj`: `any`) => `Promise`<`any`\>
+
+#### Type declaration
+
+▸ (`req`, `res`, `authorizedValue`, `jsonObj`, `queryObj`): `Promise`<`any`\>
+
+A function that will be executed by the server.
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `req` | `any` |
+| `res` | `any` |
+| `authorizedValue` | `any` |
+| `jsonObj` | `any` |
+| `queryObj` | `any` |
+
+##### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[HotRouteMethod.ts:23](https://github.com/OurFreeLight/HotStaq/blob/b031357/src/HotRouteMethod.ts#L23)

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "hotstaq",
+  "version": "0.5.3",
+  "description": "",
+  "bin": {
+    "hotstaq": "./bin/hotstaq"
+  },
+  "main": "./build/src/api.js",
+  "types": "./build/src/api.d.js",
+  "scripts": {
+    "test": "hotstaq --hotsite ./tests/hotsite/HotSite.json generate && mocha --timeout 999999 --colors ./build/tests/**/*.js",
+    "prepublishOnly": "npm run builddoc && npm run build && npm run buildweb",
+    "builddoc": "typedoc --theme markdown --tsconfig ./tsconfig.json --entryPoints './src/api.ts' --readme README.md --out ./docs/ ./src",
+    "build": "tsc --build ./tsconfig.json",
+    "buildweb": "webpack --mode=production && npx google-closure-compiler --js=./build-web/HotStaq.js --language_out=ECMASCRIPT_2018 --js_output_file=./build-web/HotStaq.min.js",
+    "buildwebdebug": "webpack --mode=development"
+  },
+  "bugs": {
+    "url": "https://github.com/OurFreeLight/HotStaq/issues"
+  },
+  "author": "FreeLight, Inc",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OurFreeLight/HotStaq.git"
+  },
+  "dependencies": {
+    "@influxdata/influxdb-client": "^1.20.0",
+    "chai": "^4.3.4",
+    "commander": "^6.2.1",
+    "cross-fetch": "^3.1.4",
+    "express": "^4.17.1",
+    "form-data": "^3.0.1",
+    "formidable": "^1.2.6",
+    "fs-extra": "^9.1.0",
+    "js-cookie": "^3.0.1",
+    "mocha": "^9.1.3",
+    "mysql": "^2.18.1",
+    "selenium-webdriver": "^4.0.0",
+    "validate-npm-package-name": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.2.21",
+    "@types/express": "^4.17.13",
+    "@types/formidable": "^1.2.4",
+    "@types/fs-extra": "^9.0.12",
+    "@types/js-cookie": "^2.2.7",
+    "@types/mocha": "^7.0.2",
+    "@types/mysql": "^2.15.19",
+    "@types/node": "^14.17.32",
+    "@types/selenium-webdriver": "^4.0.16",
+    "@types/validate-npm-package-name": "^3.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.3.1",
+    "@typescript-eslint/parser": "^5.3.1",
+    "eslint": "^8.2.0",
+    "gulp": "^4.0.2",
+    "nyc": "^15.1.0",
+    "ts-loader": "^7.0.5",
+    "typedoc": "^0.22.10",
+    "typedoc-plugin-markdown": "^3.11.3",
+    "typescript": "^4.5.4",
+    "webpack": "^4.46.0",
+    "webpack-cli": "^4.9.1"
+  }
+}

package/selenium-start.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+VERSION="3"
+
+docker rm -f selenium-hotstaq-tests 2>/dev/null || true
+
+docker run --name selenium-hotstaq-tests -d -p 4444:4444 --shm-size="2g" selenium/standalone-chrome:$VERSION

package/selenium-stop.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+docker rm -f selenium-hotstaq-tests

package/src/Hot.ts

@@ -0,0 +1,319 @@
+import { HotFile } from "./HotFile";
+import { HotPage } from "./HotPage";
+import { HotStaq } from "./HotStaq";
+import { HotAPI } from "./HotAPI";
+import { HotTestElement } from "./HotTestElement";
+
+import Cookies from "js-cookie";
+import fetch from "cross-fetch";
+
+/**
+ * The available developer modes.
+ */
+export enum DeveloperMode
+{
+	/**
+	 * The default developer mode. No tests will be executed and 
+	 * any test related data will be ignored.
+	 */
+	Production,
+	/**
+	 * For use during development/debugging. All test data will 
+	 * be collected and executed if necessary.
+	 */
+	Development
+}
+
+/**
+ * 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 class Hot
+{
+	/**
+	 * The currently generated page being displayed. This is cleared between every file processed.
+	 */
+	static CurrentPage: HotPage = null;
+	/**
+	 * The arguments passed.
+	 */
+	static Arguments: any = 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.
+	 */
+	static 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.
+	 */
+	static HotTestElement = 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 = DeveloperMode.Production;
+	/**
+	 *The current API used on this page. This is cleared between every file processed.
+	 */
+	static API: HotAPI = null;
+	/**
+	 * The API being used by the tester.
+	 */
+	static TesterAPI: HotAPI = null;
+	/**
+	 * 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 = Cookies;
+	/**
+	 * 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 = `<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.
+	 */
+	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 = `<script type = "text/javascript" src = "%JS_FILE%"></script>`;
+	/**
+	 * The JavaScript string to use when echoing out the Scripts files.
+	 */
+	static jsScriptsStr: string = `<script type = "text/javascript">%JS_CODE%</script>`;
+
+	/**
+	 * Retrieve a file and echo out it's contents.
+	 */
+	static async include (file: HotFile | string, args: any[] = null): Promise<void>
+	{
+		if (HotStaq.isWeb === true)
+		{
+			if (typeof (file) === "string")
+			{
+				const lowerFile: string = 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";
+				}
+			}
+		}
+
+		Hot.echo (await Hot.getFile (file, args));
+	}
+
+	/**
+	 * Run an already loaded file and echo out it's contents.
+	 */
+	static async runFile (fileName: string, args: any[] = null): Promise<void>
+	{
+		let file: HotFile = Hot.CurrentPage.processor.getFile (fileName);
+		/// @fixme Does the file need to be deep cloned first?
+		//let clonedFile: HotFile = new HotFile (Object.assign ({}, file));
+		let tempFile: HotFile = file;
+
+		tempFile.page = this.CurrentPage;
+		let content: string = await tempFile.process (args);
+
+		Hot.echo (content);
+	}
+
+	/**
+	 * Get the content of a file.
+	 */
+	static async getFile (path: HotFile | string, args: any[] = null): Promise<string>
+	{
+		let tempFile: HotFile = null;
+
+		if (typeof (path) === "string")
+		{
+			tempFile = new HotFile ();
+
+			if (HotStaq.isWeb === true)
+				tempFile.url = path;
+			else
+				tempFile.localFile = path;
+		}
+		else
+			tempFile = path;
+
+		await tempFile.load ();
+
+		tempFile.page = this.CurrentPage;
+		let content: string = await tempFile.process (args);
+
+		return (content);
+	}
+
+	/**
+	 * Make an api call.
+	 */
+	static async apiCall (route: string, data: any = null, httpMethod: string = "POST"): Promise<any>
+	{
+		let result: any = 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)
+			result = await Hot.CurrentPage.processor.api.makeCall (route, data, httpMethod);
+
+		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.
+	 */
+	static async jsonRequest (url: string, data: any = null, httpMethod: string = "POST"): Promise<any>
+	{
+		try
+		{
+			let res: Response = await fetch (url, {
+					"method": httpMethod,
+					"headers": {
+							"Accept": "application/json",
+							"Content-Type": "application/json"
+						},
+					"body": JSON.stringify (data)
+				});
+
+			if (res.ok === false)
+				throw new Error (`${res.status}: ${res.statusText}`);
+
+			let result: any = await res.json ();
+
+			return (result);
+		}
+		catch (ex)
+		{
+			return (JSON.stringify ({ "error": `${ex.message} - Could not fetch ${url}` }));
+		}
+	}
+
+	/**
+	 * 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 async httpRequest (url: string, requestInit: RequestInit = undefined): Promise<Response>
+	{
+		let res: Response = await fetch (url, requestInit);
+
+		return (res);
+	}
+
+	/**
+	 * Echo out some output.
+	 */
+	static echo (message: string): void
+	{
+		Hot.Output += message;
+	}
+
+	/**
+	 * Echo out the CSS for the current page being generated.
+	 */
+	static displayCSS (): void
+	{
+		for (let iIdx = 0; iIdx < Hot.CSS.length; iIdx++)
+		{
+			let cssFile: string = Hot.CSS[iIdx];
+			let cssOut: string = Hot.cssStr;
+
+			cssOut = cssOut.replace (/\%CSS_FILE\%/g, cssFile);
+
+			Hot.echo (cssOut);
+		}
+	}
+
+	/**
+	 * Echo out the JS files for the current page being generated.
+	 */
+	static displayJSFiles (): void
+	{
+		for (let iIdx = 0; iIdx < Hot.JSFiles.length; iIdx++)
+		{
+			let jsFile: string = Hot.JSFiles[iIdx];
+			let jsFileOut: string = Hot.jsFileStr;
+
+			jsFileOut = jsFileOut.replace (/\%JS_FILE\%/g, jsFile);
+
+			Hot.echo (jsFileOut);
+		}
+	}
+
+	/**
+	 * Echo out the JS scripts for the current page being generated.
+	 */
+	static displayJSScripts (): void
+	{
+		for (let iIdx = 0; iIdx < Hot.JSScripts.length; iIdx++)
+		{
+			let jsScript: string = Hot.JSScripts[iIdx];
+			let jsScriptOut: string = Hot.jsScriptsStr;
+
+			jsScriptOut = jsScriptOut.replace (/\%JS_CODE\%/g, jsScript);
+
+			Hot.echo (jsScriptOut);
+		}
+	}
+}