@iebh/tera-fy 1.7.3 → 1.8.0

package/lib/terafy.client.js

@@ -84,6 +84,7 @@ export default class TeraFy {
 	methods = [
 		// Messages
 		'handshake',
+		'setServerVerbosity',
 
 		// Session
 		'getUser',
@@ -130,6 +131,7 @@ export default class TeraFy {
 
 		// UI
 		'uiAlert',
+		'uiProgress',
 		'uiSplat',
 		'uiWindow',
 	];
@@ -186,6 +188,11 @@ export default class TeraFy {
 			if (this.settings.mode == 'parent') {
 				window.parent.postMessage(payload, this.settings.restrictOrigin);
 			} else if (this.settings.mode == 'child') {
+				console.log('SEND DOWN', {
+					target: this.dom.iframe.contentWindow,
+					payload,
+					restrictOrigin: this.settings.restrictOrigin,
+				});
 				this.dom.iframe.contentWindow.postMessage(payload, this.settings.restrictOrigin);
 			} else if (this.settings.mode == 'popup') {
 				this.dom.popup.postMessage(payload, this.settings.restrictOrigin);
@@ -335,34 +342,43 @@ export default class TeraFy {
 
 		const context = this;
 		return this.init.promise = Promise.resolve()
-			.then(()=> this.debug('INFO', 4, '[0/5] Init using server', this.settings.siteUrl))
+			.then(()=> this.debug('INFO', 4, '[0/6] Init using server', this.settings.siteUrl))
 			.then(()=> this.detectMode())
 			.then(mode => {
-				this.debug('INFO', 4, '[1/5] Setting client mode to', mode);
+				this.debug('INFO', 4, '[1/6] Setting client mode to', mode);
 				this.settings.mode = mode;
 			})
-			.then(()=> this.debug('INFO', 4, '[2/5] Injecting comms + styles + methods'))
+			.then(()=> this.debug('INFO', 4, '[2/6] Injecting comms + styles + methods'))
 			.then(()=> Promise.all([
 				// Init core functions async
 				this.injectComms(),
 				this.injectStylesheet(),
 				this.injectMethods(),
 			]))
-			.then(()=> this.debug('INFO', 4, '[3/5] Set server mode'))
+			.then(()=> {
+				if (this.settings.verbosity <=1) {
+					this.debug('INFO', 4, '[3/6] Skip - Server verbosity is already at 1');
+					return;
+				} else {
+					this.debug('INFO', 4, `[3/6] Set server verbosity to ${this.settings.verbosity}`);
+					return this.rpc('setServerVerbsity', this.settings.verbosity);
+				}
+			})
+			.then(()=> this.debug('INFO', 4, `[4/6] Set server mode to "${this.settings.mode}"`))
 			.then(()=> this.rpc('setServerMode', // Tell server what mode its in
 				this.settings.mode == 'child' ? 'embedded'
 				: this.settings.mode == 'parent' ? 'frame'
 				: this.settings.mode == 'popup' ? 'popup'
 				: (()=> { throw(`Unknown server mode "${this.settings.mode}"`) })()
 			))
-			.then(()=> this.debug('INFO', 4, '[4/5] Run client plugins'))
+			.then(()=> this.debug('INFO', 4, '[5/6] Run client plugins'))
 			.then(()=> Promise.all( // Init all plugins (with this outer module as the context)
 				this.plugins.map(plugin =>
 					plugin.init.call(context, this.settings)
 				)
 			))
-			.then(()=> this.debug('INFO', 4, '[5/5] Init complete'))
-			.catch(e => this.debug('WARN', 0, 'Init caught error', e))
+			.then(()=> this.debug('INFO', 4, '[6/6] Init complete'))
+			.catch(e => this.debug('WARN', 0, 'Init process fault', e))
 	}
 
 
@@ -573,11 +589,20 @@ export default class TeraFy {
 	* @param {String|Object} key Either a single setting key to set or an object to merge
 	* @param {*} value The value to set if `key` is a string
 	*
+	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {Boolean} [options.ignoreNullish=true] If falsy, this forces the setting of undefined or null values rather than ignoring them when specifying values by string
+	*
 	* @returns {TeraFy} This chainable terafy instance
 	*/
-	set(key, value) {
+	set(key, value, options) {
+		let settings = {
+			ignoreNullish: true,
+			...options,
+		};
+
 		if (typeof key == 'string') {
-			this.settings[key] = value;
+			if (!settings.ignoreNullish || (value !== null && value !== undefined))
+				this.settings[key] = value;
 		} else {
 			Object.assign(this.settings, key);
 		}
@@ -592,12 +617,13 @@ export default class TeraFy {
 	* @see set()
 	* @param {String|Object} key Either a single setting key to set or an object to merge
 	* @param {*} value The value to set if `key` is a string
+	* @param {Object} [options] Additional options to mutate behaviour
 	*
 	* @returns {TeraFy} This chainable terafy instance
 	*/
-	setIfDev(key, value) {
+	setIfDev(key, value, options) {
 		if (!this.settings.devMode || value === undefined) return this;
-		return this.set(key, value);
+		return this.set(key, value, options);
 	}
 
 
@@ -645,15 +671,27 @@ export default class TeraFy {
 
 	/**
 	* Set or toggle devMode
+	* This function also accepts meta values:
+	*
+	*     'toggle' - Set dev mode to whatever the opposing value of the current mode
+	*     'proxy'  - Optimize for using a loopback proxy
 	*
-	* @param {String|Boolean} [devModeEnabled='toggle'] Optional boolean to force dev mode
+	* @param {'toggle'|'proxy'|Boolean} [devModeEnabled='toggle'] Optional boolean to force dev mode or specify other behaviour
 	*
 	* @returns {TeraFy} This chainable terafy instance
 	*/
 	toggleDevMode(devModeEnabled = 'toggle') {
-		this.settings.devMode = devModeEnabled === 'toggle'
-			? !this.settings.devMode
-			: devModeEnabled;
+		if (devModeEnabled === 'toggle') {
+			this.settings.devMode = !this.settings.devMode;
+		} else if (devModeEnabled === 'proxy') {
+			Object.assign(this.settings, {
+				devMode: true,
+				siteUrl: 'http://localhost:7334/embed',
+				mode: 'child',
+			});
+		} else {
+			this.settings.devMode = !! devModeEnabled;
+		}
 
 		if (this.dom.el) // Have we actually set up yet?
 			this.dom.el.classList.toggle('dev-mode', this.settings.devMode);
@@ -684,6 +722,14 @@ export default class TeraFy {
 	*/
 
 
+	/**
+	* RPC callback to set the server verbostiy level
+	*
+	* @function setServerVerbosity
+	* @param {Number} verbosity The desired server verbosity level
+	*/
+
+
 	/**
 	* User / active session within TERA
 	*
@@ -931,6 +977,7 @@ export default class TeraFy {
 	*
 	* @param {Object} options Options which mutate behaviour
 	* @param {Boolean} [options.autoRequire=true] Run `requireProject()` automatically before continuing
+	* @param {Boolean} [options.lazy=true] If true, use the fastest method to retrieve the file list such as the cache. If false, force a refresh each time
 	* @param {Boolean} [options.meta=true] Pull meta information for each file entity
 	*
 	* @returns {Promise<Array<ProjectFile>>} A collection of project files for the given project
@@ -1109,14 +1156,20 @@ export default class TeraFy {
 
 
 	/**
-	* Display HTML content full-screen within TERA
-	* This function is ideally called within a requestFocus() wrapper
-	*
-	* @function uiSplat
-	* @param {DOMElement|String|false} content Either a prepared DOM element or string to compile, set to falsy to remove existing content
-	*
-	* @param {Object} [options] Additional options to mutate behaviour
-	* @param {Boolean|String} [options.logo=false] Add a logo to the output, if boolean true the Tera-tools logo is used otherwise specify a path or URL
+	* Display, update or dispose of windows for long running tasks
+	* All options are cumulative - i.e. they are merged with other options previously provided
+	*
+	* @function uiProgress
+	* @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
+	* @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
 	*/
 
 
@@ -1135,5 +1188,17 @@ export default class TeraFy {
 	* @returns {WindowProxy} The opened window object (if `noopener` is not set in permissions)
 	*/
 
+
+	/**
+	* Display HTML content full-screen within TERA
+	* This function is ideally called within a requestFocus() wrapper
+	*
+	* @function uiSplat
+	* @param {DOMElement|String|false} content Either a prepared DOM element or string to compile, set to falsy to remove existing content
+	*
+	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {Boolean|String} [options.logo=false] Add a logo to the output, if boolean true the Tera-tools logo is used otherwise specify a path or URL
+	*/
+
 	// }}}
 }

package/lib/terafy.proxy.js

@@ -0,0 +1,81 @@
+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
+	*
+	* @returns {VitePlugin}
+	*/
+	settings = {
+		autoStart: true,
+		force: false,
+		host: '0.0.0.0',
+		port: 7334,
+		targetProtocol: 'https',
+		targetHost: 'tera-tools.com',
+		targetPort: 443,
+	}
+
+
+	/**
+	* Eventual proxy server when the plugin has booted
+	* @type {ProxyServer}
+	*/
+	proxyServer;
+
+
+	/**
+	* Boot the proxy
+	*/
+	start() {
+		if (this.proxyServer && !this.settings.force) return; // Server already running skip
+
+		// Create proxy pass-thru
+		this.proxyServer = Proxy.createProxyServer({
+			changeOrigin: true,
+			target: {
+				protocol: this.settings.targetProtocol + ':',
+				host: this.settings.targetHost,
+				port: this.settings.targetPort,
+			},
+		});
+
+		this.proxyServer.listen(this.settings.port, ()=> {
+			console.log('Routing TERA traffic from', `http://${this.settings.host}:${this.settings.port}`, '→', `${this.settings.targetProtocol}://${this.settings.targetHost}:${this.settings.targetPort}`);
+		});
+	}
+
+
+	/**
+	* Stop the proxy server
+	* @returns {Promise} A promise which will resolve when the close operation has completed
+	*/
+	async stop() {
+		if (this.proxyServer) await 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() {{{
@@ -968,6 +979,7 @@ export default class TeraFyServer {
 	*
 	* @param {Object} options Options which mutate behaviour
 	* @param {Boolean} [options.autoRequire=true] Run `requireProject()` automatically before continuing
+	* @param {Boolean} [options.lazy=true] If true, use the fastest method to retrieve the file list such as the cache. If false, force a refresh each time
 	* @param {Boolean} [options.meta=true] Pull meta information for each file entity
 	*
 	* @returns {Promise<Array<ProjectFile>>} A collection of project files for the given project
@@ -975,6 +987,7 @@ export default class TeraFyServer {
 	getProjectFiles(options) {
 		let settings = {
 			autoRequire: true,
+			lazy: true,
 			meta: true,
 			...options,
 		};
@@ -982,9 +995,14 @@ export default class TeraFyServer {
 		return Promise.resolve()
 			.then(()=> app.service('$projects').promise())
 			.then(()=> settings.autoRequire && this.requireProject())
-			.then(project => app.service('$supabase').fileList(`/projects/${project.id}`, {
-				meta: settings.meta,
-			}))
+			.then(()=>
+				app.service('$projects').activeFiles.length == 0 // If we have no files in the cache
+				|| !settings.lazy // OR lazy/cache use is disabled
+				? app.service('$projects').refreshFiles({ // Go refresh files first
+					lazy: false,
+				})
+				: app.service('$projects').activeFiles // Otherwise use file cache
+			)
 	}
 
 
@@ -1338,7 +1356,7 @@ export default class TeraFyServer {
 	}
 	// }}}
 
-	// UI - uiAlert() {{{
+	// UI - uiAlert(), uiProgress(), uiWindow(), uiSplat() {{{
 	/**
 	* Display simple text within TERA
 	*
@@ -1373,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.3",
+  "version": "1.8.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/*"
@@ -69,6 +70,7 @@
   },
   "dependencies": {
     "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