hotstaq 0.5.24

package/src/HotClient.ts

@@ -0,0 +1,40 @@
+import { HotStaq } from "./HotStaq";
+import { HotAPI } from "./HotAPI";
+import { HotServerType } from "./HotServer";
+import { HotLog } from "./HotLog";
+
+/**
+ * A client connected to a server.
+ */
+export class HotClient
+{
+	/**
+	 * The processor to use.
+	 */
+	processor: HotStaq;
+	/**
+	 * The API to use.
+	 */
+	api: HotAPI;
+	/**
+	 * The tester API to use.
+	 */
+	testerAPI: HotAPI;
+	/**
+	 * The type of server.
+	 */
+	type: HotServerType;
+	/**
+	 * The logger.
+	 */
+	logger: HotLog;
+
+	constructor (processor: HotStaq)
+	{
+		this.processor = processor;
+		this.api = null;
+		this.testerAPI = null;
+		this.type = HotServerType.HTTP;
+		this.logger = processor.logger;
+	}
+}

package/src/HotComponent.ts

@@ -0,0 +1,158 @@
+import { HotAPI } from "./HotAPI";
+import { HotStaq } from "./HotStaq";
+
+/**
+ * A component to preprocess.
+ */
+export interface IHotComponent
+{
+	/**
+	 * The processor to use.
+	 */
+	processor: HotStaq;
+	/**
+	 * The associated HTMLElement.
+	 */
+	htmlElement?: HTMLElement;
+	/**
+	 * The name of the page.
+	 */
+	name?: string;
+	/**
+	 * The name of the tag.
+	 */
+	tag?: string;
+	/**
+	 * The connected API.
+	 */
+	api?: HotAPI;
+	/**
+	 * The options to include with registering this component.
+	 */
+	elementOptions?: ElementDefinitionOptions;
+	/**
+	 * The type of component.
+	 */
+	type?: string;
+	/**
+	 * The value of the component.
+	 */
+	value?: any;
+	/**
+	 * The events to trigger.
+	 */
+	events?: {
+			[name: string]: {
+				type: string;
+				func: Function;
+				options?: any;
+			}
+		};
+}
+
+/**
+ * A component to preprocess.
+ */
+export abstract class HotComponent implements IHotComponent
+{
+	/**
+	 * The processor to use.
+	 */
+	processor: HotStaq;
+	/**
+	 * The associated HTMLElement.
+	 */
+	htmlElement: HTMLElement;
+	/**
+	 * The name of the component.
+	 */
+	name: string;
+	/**
+	 * The name of the tag.
+	 */
+	tag: string;
+	/**
+	 * The connected API.
+	 */
+	api: HotAPI;
+	/**
+	 * The options to include with registering this component.
+	 */
+	elementOptions: ElementDefinitionOptions;
+	/**
+	 * The type of component.
+	 */
+	type: string;
+	/**
+	 * The value of the component.
+	 */
+	value: any;
+	/**
+	 * The events to trigger.
+	 */
+	events: {
+		[name: string]: {
+				type: string;
+				func: Function;
+				options: any;
+			}
+		};
+
+	constructor (copy: IHotComponent | HotStaq, api: HotAPI = null)
+	{
+		if (copy instanceof HotStaq)
+		{
+			this.processor = copy;
+			this.htmlElement = null;
+			this.name = "";
+			this.tag = "";
+			this.api = null;
+			this.elementOptions = undefined;
+			this.type = "";
+			this.value = null;
+			this.events = {};
+		}
+		else
+		{
+			this.processor = copy.processor;
+			this.htmlElement = copy.htmlElement || null;
+			this.name = copy.name || "";
+			this.tag = copy.tag || this.name;
+			this.api = copy.api || null;
+			this.elementOptions = copy.elementOptions || undefined;
+			this.type = copy.type || "";
+			this.value = copy.value || null;
+			this.events = {};
+		}
+
+		if (api != null)
+			this.api = api;
+	}
+
+	/**
+	 * Event that's called when this component is created. This is 
+	 * called before output is called. Right after this is called, 
+	 * the attributes from the HTMLElement will be processed. If 
+	 * the functionality of the attributes processing need to be 
+	 * overwritten, use the handleAttributes method to handle them.
+	 */
+	async onCreated (element: HTMLElement): Promise<any>
+	{
+		return (element);
+	}
+
+	/**
+	 * Handle the attributes manually.
+	 */
+	async handleAttributes? (attributes: NamedNodeMap): Promise<void>;
+
+	/**
+	 * Handle a click event.
+	 */
+	abstract click (): Promise<void>;
+
+	/**
+	 * Output the component.
+	 */
+	abstract output (): Promise<string>;
+}

package/src/HotCreator.ts

@@ -0,0 +1,482 @@
+import * as ppath from "path";
+const util = require ("util");
+const asyncExec = util.promisify (require ("child_process").exec);
+
+import { HotIO } from "./HotIO";
+import { HotStaq, HotSite } from "./HotStaq";
+import { HotLog } from "./HotLog";
+
+/**
+ * Creates stuff for the CLI.
+ */
+export class HotCreator
+{
+	/**
+	 * The name of the app to create.
+	 */
+	name: string;
+	/**
+	 * The type of project to create. Can be:
+	 * * web
+	 * * web-api
+	 * * api
+	 */
+	type: string;
+	/**
+	 * The language to use when creating. Default is "ts". Can be:
+	 * * ts
+	 */
+	language: string;
+	/**
+	 * The output directory.
+	 */
+	outputDir: string;
+	/**
+	 * The logger.
+	 */
+	logger: HotLog;
+	/**
+	 * The commands used while creating the app.
+	 */
+	createCommands: {
+			/**
+			 * The init command to use after the project has been created.
+			 */
+			init: string;
+			/**
+			 * The transpile command to use after the project has been initialized.
+			 */
+			transpileTS: string;
+		};
+	/**
+	 * The NPM commands used.
+	 */
+	npmCommands: {
+			/**
+			 * The start command to use.
+			 */
+			start: string;
+			/**
+			 * The dev start command to use.
+			 */
+			dev: string;
+			/**
+			 * The test command to use.
+			 */
+			test: string;
+			/**
+			 * The build command to use.
+			 */
+			build: string;
+			/**
+			 * The web api build command to use.
+			 */
+			buildWebAPI: string;
+			/**
+			 * The debug web api build command to use.
+			 */
+			buildWebAPIDebug: string;
+		};
+
+	constructor (name: string = "", logger: HotLog = new HotLog ())
+	{
+		this.name = name;
+		this.type = "web-api";
+		this.language = "ts";
+		this.outputDir = "";
+		this.logger = logger;
+		this.createCommands = {
+				init: "git init && npm install",
+				transpileTS: "npm run build"
+			};
+		this.npmCommands = {
+				start: "",
+				dev: "",
+				test: "hotstaq test",
+				build: "",
+				buildWebAPI: "",
+				buildWebAPIDebug: ""
+			};
+	}
+
+	/**
+	 * Execute a command.
+	 */
+	protected static async exec (cmd: string): Promise<string>
+	{
+		let output = await asyncExec (cmd);
+
+		return (output.stdout);
+	}
+
+	/**
+	 * Copy the libraries over to a new location.
+	 */
+	async copyLibraries (location: string): Promise<void>
+	{
+		const buildWebDir: string = ppath.normalize (`${__dirname}/../../build-web`);
+
+		await HotIO.copyFiles (buildWebDir, ppath.normalize (location));
+	}
+
+	/**
+	 * Create an app.
+	 */
+	async create (): Promise<void>
+	{
+		this.logger.info (`Creating "${this.name}" of type ${this.type} for language ${this.language}...`);
+
+		HotStaq.checkHotSiteName (this.name, true);
+
+		this.outputDir = ppath.normalize (`${this.outputDir}`);
+		await HotIO.mkdir (ppath.join (this.outputDir, "/public/js/"));
+		await HotIO.mkdir (ppath.join (this.outputDir, "/.vscode/"));
+		await HotIO.mkdir (ppath.join (this.outputDir, "/src/"));
+
+		let readMeBuildSteps: string = "";
+
+		if (this.language === "ts")
+		{
+			readMeBuildSteps = `
+	npm run build
+
+This will transpile the TypeScript into ES6 JavaScript by default. After this is done building, enter: 
+			`;
+		}
+
+		let packageJSON: any = {
+				"name": this.name,
+				"description": "",
+				"version": "1.0.0",
+				"main": "index.js",
+				"scripts": {
+				},
+				"keywords": [],
+				"author": "",
+				"license": "ISC",
+				"dependencies": {
+					"hotstaq": "^0.5.23",
+					"copy-webpack-plugin": "^6.0.3"
+				}
+			};
+
+		if (this.npmCommands.start === "")
+			this.npmCommands.start = `hotstaq --hotsite ./HotSite.json run --server-type ${this.type}`;
+
+		if (this.npmCommands.start !== "")
+			packageJSON.scripts["start"] = this.npmCommands.start;
+
+		if (this.npmCommands.dev === "")
+			this.npmCommands.dev = `hotstaq --hotsite ./HotSite.json --development-mode run --server-type ${this.type} --web-http-port 8080`;
+
+		if (this.npmCommands.dev !== "")
+			packageJSON.scripts["dev"] = this.npmCommands.dev;
+
+		if (this.npmCommands.test !== "")
+			packageJSON.scripts["test"] = this.npmCommands.test;
+
+		if (this.npmCommands.build === "")
+		{
+			if (this.language === "ts")
+				this.npmCommands.build = "tsc --build ./tsconfig.json";
+		}
+
+		if (this.npmCommands.build !== "")
+			packageJSON.scripts["build"] = this.npmCommands.build;
+
+		if (this.npmCommands.buildWebAPI === "")
+		{
+			if (this.language === "ts")
+				this.npmCommands.buildWebAPI = "webpack --mode=production --config ./webpack-api.config.js";
+		}
+
+		if (this.npmCommands.buildWebAPI !== "")
+			packageJSON.scripts["build-web"] = this.npmCommands.buildWebAPI;
+
+		if (this.npmCommands.buildWebAPIDebug === "")
+		{
+			if (this.language === "ts")
+				this.npmCommands.buildWebAPIDebug = "webpack --mode=development --debug --config ./webpack-api.config.js";
+		}
+
+		if (this.npmCommands.buildWebAPIDebug !== "")
+			packageJSON.scripts["build-web-debug"] = this.npmCommands.buildWebAPIDebug;
+
+		// If this is a web only build, remove the build web scripts from packageJSON.
+		if (this.type === "web")
+		{
+			if (packageJSON.scripts["build-web"] != null)
+				delete packageJSON.scripts["build-web"];
+
+			if (packageJSON.scripts["build-web-debug"] != null)
+				delete packageJSON.scripts["build-web-debug"];
+		}
+
+		if (this.language === "ts")
+			packageJSON.main = "build/AppAPI.js";
+
+		let packageJSONstr: string = JSON.stringify (packageJSON, null, 2);
+		await HotIO.writeTextFile (ppath.normalize (`${this.outputDir}/package.json`), packageJSONstr);
+
+		let hotSiteJSON: HotSite = {
+				name: this.name,
+				server: {
+					globalApi: "AppAPI",
+					serveDirectories: [{
+							route: "/",
+							localPath: "./public/"
+						}]
+				},
+				testing: {
+					web: {
+						tester: "HotTesterMochaSelenium",
+						testerAPIUrl: "http://127.0.0.1:8183"
+					}
+				}
+			};
+
+		if (this.language === "ts")
+		{
+			if ((this.type === "web-api") || (this.type === "api"))
+			{
+				hotSiteJSON.apis = {};
+				hotSiteJSON.apis["AppAPI"] = {
+						"jsapi": `./js/${this.name}.js`,
+						"libraryName": `${this.name}Web`,
+						"apiName": "AppAPI",
+						"filepath": "./build/AppAPI.js"
+					};
+			}
+		}
+
+		let hotSiteJSONstr: string = JSON.stringify (hotSiteJSON, null, "\t");
+		await HotIO.writeTextFile (ppath.normalize (`${this.outputDir}/HotSite.json`), hotSiteJSONstr);
+
+		this.logger.info (`Copying files...`);
+
+		const projectDir: string = ppath.normalize (`${__dirname}/../../creator/project`);
+		await HotIO.copyFiles (projectDir, ppath.normalize (`${this.outputDir}/`));
+		await HotIO.moveFile (`${this.outputDir}/gitignore`, `${this.outputDir}/.gitignore`);
+		await HotIO.moveFile (`${this.outputDir}/npmignore`, `${this.outputDir}/.npmignore`);
+
+		await this.replaceKeysInFile (ppath.normalize (`${this.outputDir}/README.md`), {
+				"APPNAME": this.name,
+				"BUILDSTEPS": readMeBuildSteps
+			});
+
+		if ((this.type === "web") || (this.type === "web-api"))
+		{
+			const publicDir: string = ppath.normalize (`${__dirname}/../../creator/public`);
+			await HotIO.copyFiles (publicDir, ppath.normalize (`${this.outputDir}/public/`));
+		}
+
+		if (this.language === "ts")
+		{
+			if ((this.type === "web-api") || (this.type === "api"))
+			{
+				const filesDir: string = ppath.normalize (`${__dirname}/../../creator/ts`);
+				await HotIO.copyFiles (filesDir, ppath.normalize (`${this.outputDir}/`));
+
+				await this.replaceKeysInFile (ppath.normalize (`${this.outputDir}/webpack-api.config.js`), {
+						"APPNAME": this.name
+					});
+			}
+		}
+
+		this.logger.info (`Finished copying files...`);
+
+		this.logger.info (`Copying HotStaq JS files...`);
+		const buildWebDir: string = ppath.normalize (`${__dirname}/../../build-web`);
+
+		await HotIO.copyFiles (buildWebDir, ppath.normalize (`${this.outputDir}/public/js/`));
+		this.logger.info (`Finished copying public files...`);
+
+		this.logger.info (`Creating VSCode files...`);
+
+		let launchJSON: any = {
+				"version": "0.2.0",
+				"configurations": [
+					{
+						"type": "node",
+						"request": "launch",
+						"name": "Debug Web Server",
+						"program": "${workspaceFolder}/node_modules/hotstaq/build/src/cli.js",
+						"skipFiles": [
+							"<node_internals>/**"
+						],
+						"outputCapture": "std",
+						"args": [
+							"--development-mode",
+							"--hotsite",
+							"./HotSite.json",
+							"run",
+							"--web-http-port",
+							"8080"
+						],
+						"env": {
+						}
+					}
+				]
+			};
+
+		if (this.language === "ts")
+		{
+			if ((this.type === "web-api") || (this.type === "api"))
+			{
+				launchJSON["configurations"].push (
+					{
+						"type": "node",
+						"request": "launch",
+						"name": "Debug Web/API Server",
+						"program": "${workspaceFolder}/node_modules/hotstaq/build/src/cli.js",
+						"skipFiles": [
+							"<node_internals>/**"
+						],
+						"outputCapture": "std",
+						"args": [
+							"--development-mode",
+							"--hotsite",
+							"./HotSite.json",
+							"run",
+							"--server-type",
+							"web-api",
+							"--web-http-port",
+							"8080",
+							"--api-http-port",
+							"8081"
+						],
+						"env": {
+						}
+					},
+					{
+						"type": "node",
+						"request": "launch",
+						"name": "Debug API Server",
+						"program": "${workspaceFolder}/node_modules/hotstaq/build/src/cli.js",
+						"skipFiles": [
+							"<node_internals>/**"
+						],
+						"outputCapture": "std",
+						"args": [
+							"--development-mode",
+							"--hotsite",
+							"./HotSite.json",
+							"run",
+							"--server-type",
+							"api",
+							"--api-http-port",
+							"8081"
+						],
+						"env": {
+						}
+					});
+			}
+		}
+
+		launchJSON["configurations"].push (
+			{
+				"type": "node",
+				"request": "launch",
+				"name": "Run Web Tests",
+				"skipFiles": [
+					"<node_internals>/**"
+				],
+				"program": "${workspaceFolder}/node_modules/hotstaq/build/src/cli.js",
+				"args": [
+					"--development-mode",
+					"--hotsite",
+					"./HotSite.json",
+					"test",
+					"--web-http-port",
+					"8080"
+				],
+				"env": {
+				}
+			});
+		launchJSON["configurations"].push (
+			{
+				"type": "pwa-node",
+				"request": "attach",
+				"name": "Remote Debugger",
+				"skipFiles": [
+					"<node_internals>/**"
+				],
+				"localRoot": "${workspaceFolder}",
+				"address": "127.0.0.1",
+				"port": 9229,
+				"remoteRoot": `/app/${this.name}`
+			});
+
+		let launchJSONstr: string = JSON.stringify (launchJSON, null, "\t");
+		await HotIO.writeTextFile (ppath.normalize (`${this.outputDir}/.vscode/launch.json`), launchJSONstr);
+		let tasksJSON: any = {
+				"version": "2.0.0",
+				"tasks": []
+			};
+
+		if (this.language === "ts")
+		{
+			if ((this.type === "web-api") || (this.type === "api"))
+			{
+				tasksJSON["tasks"].push (
+					{
+						"type": "shell",
+						"group": "build",
+						"runOptions": {
+							"instanceLimit": 1
+						},
+						"problemMatcher": [],
+						"label": "Build Web API Debug",
+						"command": "npx webpack --mode=development --config=webpack-api.config.js --debug --watch"
+					},
+					{
+						"type": "typescript",
+						"tsconfig": "tsconfig.json",
+						"option": "watch",
+						"problemMatcher": [
+							"$tsc-watch"
+						],
+						"group": "build",
+						"runOptions": {
+							"instanceLimit": 1
+						},
+						"label": "Build Server"
+					});
+			}
+		}
+
+		let tasksJSONstr: string = JSON.stringify (tasksJSON, null, "\t");
+		await HotIO.writeTextFile (ppath.normalize (`${this.outputDir}/.vscode/tasks.json`), tasksJSONstr);
+		this.logger.info (`Finished creating VSCode files...`);
+
+		this.logger.info (`Creating git repo and installing modules...`);
+		await HotCreator.exec (`cd ${this.outputDir} && ${this.createCommands.init}`);
+		this.logger.info (`Finished creating git repo and installing modules...`);
+
+		if (this.language === "ts")
+		{
+			this.logger.info (`Transpiling TypeScript...`);
+			await HotCreator.exec (`cd ${this.outputDir} && ${this.createCommands.transpileTS}`);
+			this.logger.info (`Finished transpiling TypeScript...`);
+		}
+
+		this.logger.info (`Finished creating "${this.name}"...`);
+	}
+
+	/**
+	 * Replace keys in a file.
+	 */
+	protected async replaceKeysInFile (filepath: string, keys: { [name: string]: string; }): Promise<void>
+	{
+		let contents: string = await HotIO.readTextFile (filepath);
+
+		for (let key in keys)
+		{
+			let value: string = keys[key];
+
+			contents = HotStaq.replaceKey (contents, key, value);
+		}
+
+		await HotIO.writeTextFile (filepath, contents);
+	}
+}