@iebh/tera-fy 1.9.0 → 1.10.0

package/lib/terafy.server.js

@@ -5,6 +5,7 @@ import {nanoid} from 'nanoid';
 import pathTools from '#utils/pathTools';
 import promiseDefer from '#utils/pDefer';
 import Reflib from '@iebh/reflib';
+import {reactive} from 'vue';
 
 /**
 * Server-side functions available to the Tera-Fy client library
@@ -335,8 +336,8 @@ export default class TeraFyServer {
 	* @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);
+		this.settings.verbosity = +verbosity;
+		this.debug('INFO', 1, 'Server verbosity set to', this.settings.verbosity);
 	}
 	// }}}
 
@@ -1042,6 +1043,28 @@ export default class TeraFyServer {
 	}
 
 
+	/**
+	* Fetch the raw contents of a file by its ID
+	*
+	* @param {String} [id] File ID to retrieve the contents of
+	* @param {Object} [options] Additioanl options to mutate behaviour
+	* @param {'blob'|'json'} [options.format='blob'] The format to retrieve the file in. If `json` the raw output is run via JSON.parse() first
+	*
+	* @returns {*} The file contents in the requested format
+	*/
+	getProjectFileContents(id, options) {
+		let settings = {
+			format: 'blob',
+			...options,
+		};
+
+		return app.service('$supabase').fileGet(app.service('$projects').decodeFilePath(id), {
+			json: settings.format == 'json',
+			toast: false,
+		});
+	}
+
+
 	/**
 	* Create a new file
 	* This creates an empty file which can then be written to
@@ -1086,15 +1109,60 @@ export default class TeraFyServer {
 	/**
 	* Replace a project files contents
 	*
-	* @param {String} id File to overwrite
+	* @param {String} [id] File ID to save back to, if omitted a file will be prompted for
 	* @param {File|Blob|FormData|Object|Array} contents The new file contents
+	* @param {Object} [options] Additional options to mutate behaviour
+	* @param {String} [options.id] Alternate method to specify the file ID to save as, if omitted one will be prompted for
+	* @param {Boolean} [options.autoRequire=true] Run `requireProject()` automatically before continuing
+	* @param {String|Array<String>} [options.hint] Hint(s) to store against the library. Generally corresponds to the current operation being performed - e.g. 'deduped'
+	* @param {String} [options.filename] Suggested filename if `id` is unspecified
+	* @param {String} [options.title='Save citation library'] Dialog title if `id` is unspecified and a prompt is necessary
+	* @param {Object} [options.meta] Optional meta data to merge into the file data
+	*
 	* @returns {Promise} A promise which will resolve when the write operation has completed
 	*/
-	setProjectFile(id, contents) {
-		return app.service('$supabase').fileSet(app.service('$projects').decodeFilePath(id), contents, {
-			overwrite: true,
-			toast: false,
-		});
+	setProjectFile(id, contents, options) {
+		// Argument mangling {{{
+		// TODO: Horrible kludge to detect ID is "not a JSON blob"
+		if (typeof id == 'string' && !id.startsWith('{') && contents && options) { // Called as `(id, contents, options)`
+			// Pass
+		} else if (typeof id != 'string' && !options) { // Called as `(contents, options)`
+			[id, contents, options] = [null, id, contents];
+		} else {
+			throw new Error('Unknown function signature. Requires (id:String?, contents:*, options:Object?)');
+		}
+		// }}}
+
+		let settings = {
+			id,
+			autoRequire: true,
+			hint: null,
+			filename: null,
+			title: 'Save file',
+			meta: null,
+			...options,
+		};
+
+		return Promise.resolve()
+			.then(()=> settings.autoRequire && this.requireProject())
+			.then(()=> {
+				if (settings.id) return; // We already have a file ID specified - skip
+
+				// Prompt for a save filename
+				return this.selectProjectFile({
+					title: settings.title,
+					save: true,
+					hint: settings.hint,
+					saveFilename: settings.filename,
+					autoRequire: false, // Handled above anyway
+				})
+					.then(file => settings.id = file.id)
+			})
+			.then(()=> app.service('$supabase').fileSet(app.service('$projects').decodeFilePath(settings.id), contents, {
+				overwrite: true,
+				toast: false,
+			}))
+			.then(()=> null)
 	}
 	// }}}
 
@@ -1235,7 +1303,7 @@ export default class TeraFyServer {
 
 				// Prompt for a save filename
 				return this.selectProjectFile({
-					title: 'Save citation library',
+					title: settings.title,
 					save: true,
 					hint: settings.hint,
 					saveFilename: settings.filename,
@@ -1284,6 +1352,7 @@ export default class TeraFyServer {
 				overwrite: true,
 				mode: 'encoded',
 			}))
+			.then(()=> null)
 	}
 
 	// }}}
@@ -1397,54 +1466,52 @@ export default class TeraFyServer {
 	*
 	* @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 {String} [options.body=''] Window body text
+	* @param {Boolean} [options.bodyHtml=false] If truthy, treat the body 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
+	* @param {Number} [options.progress] The current progress of the task being conducted, this is assumed to be a value less than `progressMax`
+	* @param {Number} [options.progressMax] 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 = {
+		if (options === false) options = {close: true}; // Shorthand to close existing ui progress window
+
+		if (this.uiProgressOptions === null) { // New uiProgress window
+			this.uiProgressOptions = reactive({
 				title: 'TERA',
 				body: '',
 				bodyHtml: false,
 				close: false,
+				progress: 0,
+				progressMax: 0,
 				...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
+		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;
 				})
+		} else if (!this.uiProgressPromise) { // Not created the dialog yet
+			this.uiProgressPromise = this.requestFocus(()=>
+				app.service('$prompt').dialog({
+					title: this.uiProgressOptions.title,
+					component: 'uiProgress',
+					componentProps: this.uiProgressOptions,
+					closeable: false,
+					keyboard: false,
+				})
+			);
+			return Promise.resolve();
 		}
 	}
 
-	uiProgressOptions;
+	uiProgressOptions = null;
 	uiProgressPromise;
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",
@@ -85,6 +85,9 @@
     "documentation": "^14.0.2",
     "esbuild": "^0.19.5"
   },
+  "peerDependencies": {
+    "vue": "^3.0.0"
+  },
   "optionalDependencies": {
     "@iebh/reflib": "^2.2.2",
     "just-diff-apply": "^5.5.0",