@iebh/tera-fy 1.4.4 → 1.6.0

package/lib/terafy.server.js

@@ -757,10 +757,15 @@ export default class TeraFyServer {
 	* @param {String|Array<String>} [path] The sub-path within the project state to set, if unspecifed the entire target is used as a target and a save operation is forced
 	* @param {*} value The value to set as the default structure
 	* @param {Object} [options] Additional options to mutate behaviour, see setProjectState() for the full list of supported options
+	* @param {Boolean} [options.flush=true] Force a re-read from the server after setting, prevents race conditions with large objects. Calls `setProjectStateFlush()` after applying defaults
 	*
 	* @returns {Promise<*>} A promise which resolves to the eventual input value after defaults have been applied
 	*/
 	setProjectStateDefaults(path, value, options) {
+		let settings = {
+			flush: true,
+			...options,
+		};
 		if (!app.service('$projects').active) throw new Error('No active project');
 
 		let target = app.service('$projects').active;
@@ -771,18 +776,52 @@ export default class TeraFyServer {
 				value,
 				{
 					strategy: 'defaults',
-					...options,
+					...settings,
 				},
 			)
+				.then(()=> settings.flush && this.setProjectStateFlush())
 				.then(()=> pathTools.get(target, path));
 		} else { // Called as (value) - Populate entire project layout
 			pathTools.defaults(target, path);
+			this.debug('INFO', 1, 'setProjectStateDefaults', {
+				defaults: path,
+				newState: cloneDeep(target),
+			});
 			return this.saveProjectState()
+				.then(()=> settings.flush && this.setProjectStateFlush())
 				.then(()=> target);
 		}
 	}
 
 
+	/**
+	* Force copying local changes to the server
+	* This is only ever needed when saving large quantities of data that need to be immediately available
+	*
+	* @returns {Promise} A promise which resolves when the operation has completed
+	*/
+	setProjectStateFlush() {
+		this.debug('INFO', 1, 'Force project state flush!');
+		if (!app.service('$projects').active) throw new Error('No active project');
+		return app.service('$projects').active.$touchLocal()
+			.then(()=> null)
+	}
+
+
+	/**
+	* Force refetching the remote project state into local
+	*
+	* @returns {Promise} A promise which resolves when the operation has completed
+	*/
+	setProjectStateRefresh() {
+		this.debug('INFO', 1, 'Force project state refresh!');
+		if (!app.service('$projects').active) throw new Error('No active project');
+		return app.service('$projects').active.$read({force: true})
+			.then(()=> this.debug('INFO', 2, 'Forced project state refresh!', {state: app.service('$projects').active}))
+			.then(()=> null)
+	}
+
+
 	/**
 	* Force-Save the currently active project state
 	*
@@ -1192,10 +1231,28 @@ export default class TeraFyServer {
 	* @param {String} url The URL to restore on next refresh
 	*/
 	setPageUrl(url) {
-		debugger; // FIXME: Untested
-		console.info('FIXME: Unsupported setPageUrl(', url, ')');
+		if (!url.startsWith('/')) throw new Error('All pageURLs must be a relative path starting with a slash');
+
+		let $routeMatched = app.service('$route').matched[0];
+		if (!$routeMatched?.name) throw new Error('No active route');
+		if ($routeMatched?.path == '/embed') return this.debug('INFO', 2, 'Ignoring setPageUrl(', url, ') on when in embed mode');
+		if (!$routeMatched?.path.endsWith('/:toolPath(.*)?')) return this.debug('INFO', 2, 'Ignoring setPageUrl(', url, ') - no active tool anyway');
+
+		app.router.push({
+			path: $routeMatched.path.replace(/\/:toolPath\(\.\*\)\?$/, url),
+		});
 	}
 
+
+	/**
+	* Set the active page title
+	* This is usually called by a tool nested within the tera-tools.com embed
+	*
+	* @param {String} [title] The current page title. Set to a falsy value to revert back to the default page title
+	*/
+	setPageTitle(title) {
+		app.root.setPageTitle(title);
+	}
 	// }}}
 
 	// Init - constructor(), init() {{{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "1.4.4",
+  "version": "1.6.0",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",
@@ -12,7 +12,7 @@
     "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",
     "release": "release-it",
-    "watch": "nodemon --watch lib --exec npm run build"
+    "watch": "nodemon --watch lib --watch plugins --exec npm run build"
   },
   "type": "module",
   "imports": {
@@ -109,7 +109,10 @@
     },
     "hooks": {
       "before:init": "git reset HEAD -- api.md docs/ dist/",
-      "after:bump": "npm run build && git add api.md docs/ dist/"
+      "before:bump": [
+        "npm run build",
+        "git add api.md docs/ dist/"
+      ]
     },
     "plugins": {
       "@release-it/conventional-changelog": {

package/plugins/vue2.js

@@ -1,4 +1,4 @@
-import {cloneDeep} from 'lodash-es';
+import {cloneDeep, isPlainObject} from 'lodash-es';
 import TeraFyPluginBase from './base.js';
 
 /**
@@ -93,6 +93,7 @@ export default class TeraFyPluginVue2 extends TeraFyPluginBase {
 				if (settings.read) {
 					this.events.on(`update:projects/${stateObservable.id}`, newState => {
 						skipUpdate++; // Skip next update as we're updating our own state anyway
+						this.debug('INFO', 5, 'Update Vue2 Remote->Local', {new: newState, old: stateObservable});
 						this.merge(stateObservable, newState);
 					});
 				}
@@ -114,6 +115,7 @@ export default class TeraFyPluginVue2 extends TeraFyPluginBase {
 								return;
 							}
 
+							this.debug('INFO', 5, 'Update Vue2 Local->Remote', {new: newVal, old: oldVal});
 							this.createProjectStatePatch(newVal, oldVal);
 							oldVal = cloneDeep(snapshot);
 						},
@@ -140,9 +142,9 @@ export default class TeraFyPluginVue2 extends TeraFyPluginBase {
 		payload.forEach(pl =>
 			Object.keys(pl)
 				.forEach(k => {
-					if (typeof pl[k] == 'object') { // Setting sub-objects - need to recurse these in Vue2
+					if (isPlainObject(pl[k])) { // Setting sub-objects - we need to recurse these in Vue2 in case a sub-key gets glued on
 						if (!(k in target)) // Destination to merge doesn't exist yet - create it
-							this.Vue.set(target, k, Array.isArray(pl[k]) ? [] : {});
+							this.Vue.set(target, k, {});
 
 						this.merge(target[k], pl[k]);
 					} else {