@iebh/tera-fy 1.7.4 → 1.9.0

package/lib/terafy.proxy.js

@@ -0,0 +1,115 @@
+import {create as createDomain} from 'node:domain';
+import detectPort from 'detect-port';
+import Proxy from 'http-proxy';
+
+export class TeraProxy {
+	/**
+	* Setup a local loopback proxy for TERA-tools.com
+	*
+	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {Boolean} [options.force=false] Restart the server even if its apparently running
+	* @param {Boolean} [options.autoStart=true] Automatically start the proxy without calling `Plugin.start()`
+	* @param {String} [options.host='0.0.0.0'] Host IP to listen on
+	* @param {Number} [options.port=7334] Host port to listen on
+	* @param {String} [options.targetProtocol='https'] Target protocol to forward to
+	* @param {String} [options.targetHost='tera-tools.com'] Target host to forward to
+	* @param {Number} [options.targetPort=443] Target port to forward to
+	* @param {'ignore'|'throw'} [options.portConflict='ignore'] Action to take when something is already listening on the allocated port
+	* @param {Function} [options.onLog=console.log] Function to call with any logging output. Defaults to using console.log. Called as `(level:'INFO|'WARN', ...msg:any)`
+	*
+	* @returns {VitePlugin}
+	*/
+	settings = {
+		autoStart: true,
+		force: false,
+		host: '0.0.0.0',
+		port: 7334,
+		targetProtocol: 'https',
+		targetHost: 'tera-tools.com',
+		targetPort: 443,
+		portConflict: 'ignore',
+		onLog: (level, ...msg) => console.log(...msg),
+	}
+
+
+	/**
+	* Eventual proxy server when the plugin has booted
+	* @type {ProxyServer}
+	*/
+	proxyServer;
+
+
+	/**
+	* Boot the proxy
+	*
+	* @returns {Promise} A promise which resolves when the operation has completed
+	*/
+	start() {
+		if (this.proxyServer && !this.settings.force) return Promise.resolve(); // Server already running skip
+
+		return Promise.resolve()
+			.then(()=> detectPort(this.settings.port))
+			.then(gotPort => gotPort != this.settings.port && Promise.reject('PORT-CONFLICT'))
+			.then(() => this.proxyServer = Proxy.createProxyServer({ // Create proxy pass-thru
+				changeOrigin: true,
+				target: {
+					protocol: this.settings.targetProtocol + ':',
+					host: this.settings.targetHost,
+					port: this.settings.targetPort,
+				},
+			}))
+			.then(()=> new Promise((resolve, reject) => {
+				// Wrap listener in a domain so we can correctly catch EADDRINUSE
+				let domain = createDomain();
+				domain.on('error', err => {
+					if (err.code == 'EADDRINUSE') {
+						throw 'PORT-CONFLICT';
+					} else {
+						throw err;
+					}
+				});
+				this.proxyServer.listen(this.settings.port, ()=> {
+					this.settings.onLog('INFO', 'Routing TERA traffic from', `http://${this.settings.host}:${this.settings.port}`, '→', `${this.settings.targetProtocol}://${this.settings.targetHost}:${this.settings.targetPort}`);
+					resolve();
+				})
+			}))
+			.catch(e => {
+				if (e === 'PORT-CONFLICT') {
+					if (this.settings.portConflict == 'ignore') {
+						this.settings.onLog('WARN', 'Port', this.settings.port, 'is already allocated - assuming TERA is already running locally and skipping proxy');
+						return false; // Do nothing
+					} else {
+						throw err;
+					}
+				} else {
+					throw e; // Re-throw everything else
+				}
+			})
+	}
+
+
+	/**
+	* Stop the proxy server
+	* @returns {Promise} A promise which will resolve when the close operation has completed
+	*/
+	stop() {
+		return Promise.resolve()
+			.then(()=> this.proxyServer && new Promise(resolve => this.proxyServer.close(()=> resolve())))
+	}
+
+
+	constructor(options) {
+		if (options) Object.assign(this.settings, options);
+
+		// Auto start?
+		if (options?.autoStart ?? true) this.start();
+	}
+}
+
+
+/**
+* Utility function to return a new TeraProxy instance
+*/
+export default function(options) {
+	return new TeraProxy(options);
+}

package/lib/terafy.server.js

@@ -327,6 +327,17 @@ export default class TeraFyServer {
 			payload: args,
 		});
 	}
+
+
+	/**
+	* RPC callback to set the server verbostiy level
+	*
+	* @param {Number} verbosity The desired server verbosity level
+	*/
+	setServerVerbosity(verbosity) {
+		this.settinigs.verbosity = +verbosity;
+		this.debug('INFO', 1, 'Server verbosity set to', this.settinigs.verbosity);
+	}
 	// }}}
 
 	// Session / User - getUser(), requireUser() {{{
@@ -1345,7 +1356,7 @@ export default class TeraFyServer {
 	}
 	// }}}
 
-	// UI - uiAlert() {{{
+	// UI - uiAlert(), uiProgress(), uiWindow(), uiSplat() {{{
 	/**
 	* Display simple text within TERA
 	*
@@ -1380,6 +1391,63 @@ export default class TeraFyServer {
 	}
 
 
+	/**
+	* Display, update or dispose of windows for long running tasks
+	* All options are cumulative - i.e. they are merged with other options previously provided
+	*
+	* @param {Object|Boolean} [options] Additional options to mutate behaviour, if boolean false `{close: true}` is assumed
+	* @param {String} [options.title='TERA'] Window title, can only be set on the initial call
+	* @param {String} [options.body=''] Window body text, can only be set on the initial call
+	* @param {Boolean} [options.bodyHtml=false] Treat body text as HTML
+	* @param {Boolean} [options.close=false] Close the existing dialog, if true the dialog is disposed and options reset
+	*
+	* @FIXME None of the below have been implemented yet
+	* @param {String} [options.text] The text of the task being conducted
+	* @param {Number} [options.progress] The current progress of the task being conducted, this is assumed to be a value less than `maxProgress`
+	* @param {Number} [options.maxProgress] The maximum value that the progress can be
+	*
+	* @returns {Promise} A promise which resolves when the dialog has been updated
+	*/
+	uiProgress(options) {
+		if (options === false) { // Close existing ui progress window
+			uiProgressOptions.close = true;
+		} else if (!this.uiProgressOptions) { // New uiProgress window
+			this.uiProgressOptions = {
+				title: 'TERA',
+				body: '',
+				bodyHtml: false,
+				close: false,
+				...options,
+			};
+		} else { // Merge options with existing uiProgress window
+			Object.assign(this.uiProgressOptions, options);
+		}
+
+		console.log('FIXME: UI PROGRESS - is unfinished', {options: this.uiProgressOptions});
+
+		if (!this.uiProgressPromise && !this.uiProgressOptions.close) { // Not created the dialog yet
+			this.uiProgressPromise = this.requestFocus(()=>
+				app.service('$prompt').dialog({
+					title: this.uiProgressOptions.title,
+					body: this.uiProgressOptions.body,
+					isHtml: this.uiProgressOptions.bodyHtml,
+				})
+			);
+			return Promise.resolve();
+		} else if (!this.uiProgressOptions.close) { // Asked to close the dialog
+			return Promise.resolve()
+				.then(()=> this.uiProgressPromise && app.service('$prompt').close(true)) // Close the dialog if its open
+				.then(()=> { // Release state
+					this.uiProgressOptions = {};
+					this.uiProgressPromise = null;
+				})
+		}
+	}
+
+	uiProgressOptions;
+	uiProgressPromise;
+
+
 	/**
 	* Open a popup window containing a new site
 	*

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "1.7.4",
+  "version": "1.9.0",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",
     "build": "concurrently 'npm:build:*'",
     "build:client": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify",
     "build:client:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle lib/terafy.client.js --outfile=dist/terafy.es2019.js --minify",
-    "build:plugins-vue2:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle plugins/vue2.js --outfile=dist/plugin.vue2.es2019.js --minify",
+    "build:plugins:vue2:es2019": "esbuild --platform=browser --format=esm --target=es2019 --bundle plugins/vue2.js --outfile=dist/plugin.vue2.es2019.js --minify",
     "build:docs:api": "documentation build lib/terafy.client.js lib/projectFile.js --format html --config documentation.yml --output docs/",
     "build:docs:markdown": "documentation build lib/terafy.client.js lib/projectFile.js --format md --markdown-toc --output api.md",
     "lint": "eslint lib plugins utils widgets",
@@ -28,6 +28,7 @@
     },
     "./dist/*": "./dist/*",
     "./projectFile": "./lib/projectFile.js",
+    "./proxy": "./lib/terafy.proxy.js",
     "./server": "./lib/terafy.server.js",
     "./plugins/*": "./plugins/*.js",
     "./widgets/*": "./widgets/*"
@@ -68,7 +69,9 @@
     "node": ">=18"
   },
   "dependencies": {
+    "detect-port": "^1.6.1",
     "filesize": "^10.1.1",
+    "http-proxy": "^1.18.1",
     "just-diff": "^6.0.2",
     "lodash-es": "^4.17.21",
     "mitt": "^3.0.1",

package/plugins/vite.js

@@ -0,0 +1,18 @@
+import TeraProxy from '../lib/terafy.proxy.js';
+
+/**
+* Setup a Vite local loopback
+*
+* @see lib/terafy.proxy.js
+*
+* @returns {VitePlugin}
+*/
+export default function vitePluginTeraFy(options) {
+	TeraProxy(options);
+
+	// Vite output
+	return {
+		name: 'tera-fy',
+		apply: 'dev', // Only run on dev-serve-mode rather than each build
+	}
+}

package/plugins/vue2.js

@@ -17,7 +17,7 @@ import TeraFyPluginBase from './base.js';
 * import TerafyVue from '@iebh/tera-fy/plugins/vue2';
 * let terafy = new TeraFy()
 *   .set('devMode', true) // Uncomment this line if you want TeraFy to be chatty
-*   .set('siteUrl', 'http://localhost:8000/embed') // Uncomment this line if running TERA locally
+*   .set('siteUrl', 'http://localhost:7334/embed') // Uncomment this line if running TERA locally
 *   .use(TerafyVue, { // Add the Vue plugin
 *   	vue: window.Vue, // Assumes Vue is available on the window object
 *   })

package/plugins/vue3.js

@@ -14,7 +14,7 @@ import {reactive, watch} from 'vue';
 * import TerafyVue from '@iebh/tera-fy/plugins/vue';
 * let terafy = new TeraFy()
 *   .set('devMode', import.meta.env.DEV)
-*   .set('siteUrl', 'http://localhost:8000/embed') // Uncomment this line if running TERA locally
+*   .set('siteUrl', 'http://localhost:7334/embed') // Uncomment this line if running TERA locally
 *   .use(TerafyVue) // Add the Vue plugin
 *
 * terafy.init(); // Initialize everything