@iebh/tera-fy 2.3.7 → 2.3.9

package/lib/syncro/syncro.ts

@@ -21,16 +21,24 @@ import {
 // @ts-expect-error No declaration file for marshal
 import marshal from '@momsfriendlydevco/marshal';
 import {nanoid} from 'nanoid';
+import PromiseThrottle from 'p-throttle';
 import PromiseRetry from 'p-retry';
 import {FirebaseApp, FirebaseError} from 'firebase/app';
 import { BoundSupabaseyFunction } from '@iebh/supabasey';
+import type { PostgresSql } from './entities.js';
 
+interface ThrottleOptions<T = any> {
+	limit: number,
+	interval: number,
+	strict: boolean,
+}
 
 interface ReactiveWrapper<T = any> {
 	doc: T;
 	setState: (newState: T) => void;
 	getState: () => T;
 	watch: (cb: (newState: T) => void) => void;
+	throttle?: ThrottleOptions | true,
 }
 
 interface PathSplitResult {
@@ -74,6 +82,14 @@ export default class Syncro {
 	static supabasey: BoundSupabaseyFunction;
 
 
+	/**
+	* Postgres SQL instance in use (injected by the Cloudflare Worker runtime via Hyperdrive)
+	*
+	* @type {PostgresSql}
+	*/
+	static db: PostgresSql;
+
+
 	/**
 	* The current user session, should be unique for the user + browser tab
 	* Used by the heartbeat system
@@ -169,7 +185,7 @@ export default class Syncro {
 	* @param {*...} [msg] The message to output
 	*/
 	debugError(...msg: any[]) {
-		console.log(`[Syncro ${this.path}]`, ...msg);
+		console.warn(`[Syncro ${this.path}]`, ...msg);
 	}
 
 
@@ -202,9 +218,10 @@ export default class Syncro {
 	*/
 	destroy(): Promise<any[]> {
 		this.debug('Destroy!');
-		return Promise.all(this._destroyActions
-			.map(fn => fn())
-		)
+		return Promise.resolve()
+			.then(()=> Promise.all(this._destroyActions // eslint-disable @typescript-eslint/await-thenable
+				.map(fn => fn())
+			))
 			.then(()=> this._destroyActions = []) // Reset list of actions to perform when terminating
 	}
 
@@ -213,7 +230,7 @@ export default class Syncro {
 	* Actions to preform when we are destroying this instance
 	* This is an array of function callbacks to execute in parallel when `destroy()` is called
 	*
-	* @type {Array<function>}
+	* @type {Array<Function<Promise>>}
 	*/
 	_destroyActions: Array<() => void> = [];
 
@@ -531,6 +548,25 @@ export default class Syncro {
 				// Construct a reactive component
 				reactive = this.getReactive(initialState);
 				if (!reactive.doc || !reactive.setState || !reactive.getState || !reactive.watch) throw new Error('Syncro.getReactive() requires a returned `doc`, `setState()`, `getState()` + `watch()`');
+
+				// Accept throttling for reactiveWrapper if present
+				if (reactive.throttle) { // Wanting to throttle - handed either truthy or an object of throttle settings
+					let throttleSettings = {
+						limit: 2,
+						interval: 100, // i.e. 2 calls within 100ms, otherwise throttle
+						strict: false,
+						...(typeof reactive.throttle == 'object' && reactive.throttle), // Import throttle settings if any
+					};
+
+					// Wrap original reactive.setState() in a throttle function
+					let originalSetState = reactive.setState;
+					reactive.setState = PromiseThrottle({
+						limit: throttleSettings.limit,
+						interval: throttleSettings.interval,
+						onDelay: ()=> this.debug('Throttling excessive Syncro.setState() writes'),
+					})(originalSetState);
+				}
+
 				this.value = doc = reactive.doc;
 
 				this.debug('Initial state', {doc});
@@ -562,7 +598,7 @@ export default class Syncro {
 				reactive.watch(throttle((newState: any) => {
 					this.debug('Local change', {newState});
 					this.markDirty();
-					this.setFirestoreState(newState, {method: 'merge'});
+					this.setFirestoreState(newState, {method: 'merge'}); // eslint-disable-line @typescript-eslint/no-floating-promises
 				}, this.throttle));
 
 				await this.setHeartbeat(true, {
@@ -656,7 +692,7 @@ export default class Syncro {
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {Boolean} [options.immediate=false] Fire a heartbeat as soon as this function is called, this is only really useful on mount
-	* @returns Promise that resolves to void or void
+	* @returns {Promise|Void} A promise that resolves when completed (if `{immediate:true}`) or void
 	*/
 	setHeartbeat(enable: boolean = true, options?: any): Promise<void> | void {
 		const settings = {
@@ -673,7 +709,7 @@ export default class Syncro {
 				await this.heartbeat();
 
 				// If we're enabled - schedule the next heartbeat timer
-				if (enable) this.setHeartbeat(true); // Reschedule
+				if (enable) this.setHeartbeat(true); // eslint-disable-line @typescript-eslint/no-floating-promises
 			};
 
 			this._heartbeatTimer = setTimeout(heartbeatAction, this.config.heartbeatInterval);

package/lib/terafy.client.ts

@@ -68,7 +68,6 @@ export default class TeraFy {
 	* Event emitter subscription endpoint
 	* @type {Mitt}
 	*/
-	// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 	// @ts-ignore - Because mitt is exported as cjs typescript has trouble resolving default export
 	events = Mitt();
 

package/lib/terafy.server.ts

@@ -619,7 +619,7 @@ export default class TeraFyServer {
 				await app.service('$projects').refresh();
 				return;
 			} catch (e: any) {
-				throw new Error(`Failed to decode local dev state - ${e.toString()}`);
+				throw new Error(`Failed to decode local dev state - ${e.toString()}`, {cause: e});
 			}
 		}
 
@@ -1000,7 +1000,6 @@ export default class TeraFyServer {
 				.then(()=> pathTools.get(target, path));
 		} else { // Called as (value, options?) - Populate entire project layout
 			actualValue = path; // The first argument is the value
-			settings = { ...value }; // The second argument holds the options
 			pathTools.defaults(target, actualValue);
 			this.debug('INFO', 1, 'setProjectStateDefaults', {
 				defaults: actualValue,
@@ -1360,7 +1359,7 @@ export default class TeraFyServer {
 		} catch (error: any) {
 			this.debug('ERROR', 1, `Error during project file move from "${sourceStoragePath}" to "${targetStoragePath}":`, error);
 			// Re-throw a more specific error or the original error for the caller to handle.
-			throw new Error(`Failed to move project file "${sourceId}" to "${newName}": ${error.message || String(error)}`);
+			throw new Error(`Failed to move project file "${sourceId}" to "${newName}": ${error.message || String(error)}`, {cause: error});
 		}
 	}
 
@@ -1397,7 +1396,7 @@ export default class TeraFyServer {
 	*/
 	setProjectFileContents(id: string | any | null, contents: any, options?: any): Promise<null> {
 		// Argument Mangling Logic (Simplified)
-		let fileId: string | null = null;
+		let fileId: string | null = null; // eslint-disable-line no-useless-assignment
 		let fileContents: any;
 		let mergedOptions: any;
 
@@ -1527,7 +1526,7 @@ export default class TeraFyServer {
 			this.debug('INFO', 2, `Project folder "${cleanFolderPath}" ensured/created via placeholder at "${relativePlaceholderPath}".`);
 		} catch (error: any) {
 			this.debug('ERROR', 1, `Failed to create/ensure project folder "${cleanFolderPath}" via placeholder "${relativePlaceholderPath}"`, error);
-			throw new Error(`Failed to create project folder "${cleanFolderPath}": ${error.message || String(error)}`);
+			throw new Error(`Failed to create project folder "${cleanFolderPath}": ${error.message || String(error)}`, {cause: error});
 		}
 	}
 
@@ -1602,7 +1601,7 @@ export default class TeraFyServer {
 			this.debug('INFO', 2, `Project folder "${cleanFolderPath}" (prefix "${pathPrefix}") and its ${filesToDelete.length} contents deleted.`);
 		} catch (error: any) {
 			this.debug('ERROR', 1, `Failed to delete contents of project folder "${cleanFolderPath}" (prefix "${pathPrefix}")`, error);
-			throw new Error(`Failed to delete project folder "${cleanFolderPath}": ${error.message || String(error)}`);
+			throw new Error(`Failed to delete project folder "${cleanFolderPath}": ${error.message || String(error)}`, {cause: error});
 		}
 		return null;
 	}
@@ -1728,7 +1727,7 @@ export default class TeraFyServer {
 	*/
 	setProjectLibrary(id: string | any | null, refs?: any, options?: any): Promise<null> {
 		// Argument Mangling Logic (Simplified)
-		let fileId: string | null = null;
+		let fileId: string | null = null; // eslint-disable-line no-useless-assignment
 		let libraryRefs: any;
 		let mergedOptions: any;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "2.3.7",
+  "version": "2.3.9",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.ts --outfile=dist/terafy.js --minify --serve --servedir=.",
@@ -15,7 +15,7 @@
     "build:docs:markdown": "documentation build lib/terafy.client.ts lib/projectFile.ts --format md --markdown-toc --output api.md",
     "lint": "eslint",
     "release": "release-it",
-    "watch": "nodemon --watch lib --watch plugins --exec \"npm run build\""
+    "watch": "nodemon --watch lib --watch plugins --ext ts --exec \"npm run build\""
   },
   "type": "module",
   "imports": {
@@ -113,11 +113,12 @@
     "mitt": "^3.0.1",
     "nanoid": "^5.1.6",
     "p-retry": "^7.1.1",
+    "p-throttle": "^8.1.0",
     "release-it": "^19.2.4",
     "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "@momsfriendlydevco/eslint-config": "^2.4.1",
+    "@momsfriendlydevco/eslint-config": "^2.4.2",
     "@release-it/conventional-changelog": "^10.0.5",
     "@types/detect-port": "^2.0.0",
     "@types/http-proxy": "^1.17.17",

package/plugins/vue2.ts

@@ -59,11 +59,10 @@ export default class TeraFyPluginVue2 extends TeraFyPluginFirebase {
 	/**
 	* Install into Vue@2
 	*
-	* @param {Object} options Additional options to mutate behaviour, see TeraFyPluginFirebase
+	* @param {Object} options Additional options to mutate behaviour, see TeraFyPluginFirebase for additional options
 	* @param {Object} options.app Root level Vue app to bind against
 	* @param {Vue} options.Vue Vue@2 instance to bind against
 	* @param {String} [options.globalName='$tera'] Global property to allocate this service as within Vue2
-	* @param {*...} [options...] see TeraFyPluginFirebase
 	*
 	* @returns {Promise} A Promise which will resolve when the init process has completed
 	*/
@@ -117,4 +116,4 @@ export default class TeraFyPluginVue2 extends TeraFyPluginFirebase {
 		};
 	}
 
-}
+}

package/plugins/vue3.ts

@@ -39,8 +39,7 @@ export default class TeraFyPluginVue3 extends TeraFyPluginFirebase {
 	/**
 	* Init the project including create a reactive mount for the active project
 	*
-	* @param {Object} options Additional options to mutate behaviour
-	* @param {*} [options...] see TeraFyPluginFirebase
+	* @param {Object} options Additional options to mutate behaviour, see TeraFyPluginFirebase
 	*/
 	async init(options: Record<string, any>) {
 		await super.init(options); // Initalize parent class Firebase functionality
@@ -103,5 +102,4 @@ export default class TeraFyPluginVue3 extends TeraFyPluginFirebase {
 
 		};
 	}
-
-}
+}

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "target": "ES2022",
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
     "declaration": true,
@@ -25,6 +25,6 @@
    ],
   "exclude": [
     "node_modules",
-    "dist",
+    "dist"
   ]
-}
+}