@iebh/tera-fy 1.6.0 → 1.7.0

package/lib/terafy.server.js

@@ -868,7 +868,7 @@ export default class TeraFyServer {
 	}
 	// }}}
 
-	// Project files - selectProjectFile(), getProjectFiles(), getProjectFile(), setProjectFile() {{{
+	// Project files - selectProjectFile(), getProjectFiles(), getProjectFile(), createProjectFile(), deleteProjectFile(), setProjectFile() {{{
 
 	/**
 	* Data structure for a project file
@@ -914,7 +914,7 @@ export default class TeraFyServer {
 	* @param {Boolean} [options.autoRequire=true] Run `requireProject()` automatically before continuing
 	* @param {FileFilters} [options.filter] Optional file filters
 	*
-	* @returns {Promise<ProjectFile>} The eventually selected file
+	* @returns {Promise<ProjectFile>} The eventually selected file, if in save mode new files are created as stubs
 	*/
 	selectProjectFile(options) {
 		let settings = {
@@ -949,8 +949,8 @@ export default class TeraFyServer {
 						filters: settings.filters,
 					},
 					componentEvents: {
-						fileSave(filePath) {
-							app.service('$prompt').close(true, filePath);
+						fileSave(file) {
+							app.service('$prompt').close(true, file);
 						},
 						fileSelect(file) {
 							app.service('$prompt').close(true, file);
@@ -989,26 +989,91 @@ export default class TeraFyServer {
 
 
 	/**
-	* Fetch a project file
-	* @param {String} path File path to read
-	* @returns {Promise<Blob>} The eventual fetched file as a blob
+	* Fetch a project file by its name
+	*
+	* @param {String} name The name + relative directory path component
+	*
+	* @param {Object|String} [options] Additional options to mutate behaviour, if a string is given `options.subkey` is assumed
+	* @param {String} [options.subkey] If specified only the extracted subkey is returned rather than the full object
+	* @param {Boolean} [options.cache=true] Use the existing file cache if possible, set to false to force a refresh of files from the server first
+	*
+	* @returns {Promise<ProjectFile>} The eventual fetched ProjectFile (or requested subkey)
 	*/
-	getProjectFile(path) {
-		return app.service('$supabase').fileGet(path, {
-			toast: false,
-		});
+	getProjectFile(name, options) {
+		let settings = {
+			subkey: null,
+			cache: true,
+			...(typeof options == 'string' ? {subkey: options} : options),
+		};
+
+		return Promise.resolve()
+			.then(()=>
+				app.service('$projects').activeFiles.length == 0 // If we have no files in the cache
+				|| !settings.cache // OR caching is disabled
+				? app.service('$projects').refreshFiles({ // Go refresh files first
+					lazy: false,
+				})
+				: app.service('$projects').activeFiles // Otherwise use file cache
+			)
+			.then(files =>
+				files.find(file =>
+					file.name == name
+				)
+			)
+			.then(file => file && settings.subkey ? file[settings.subkey] : file) // Provide subkey if asked
+	}
+
+
+	/**
+	* Create a new file
+	* This creates an empty file which can then be written to
+	* This function also forces a local file list cache update
+	*
+	* @param {String} name The name + relative directory path component
+	* @returns {Promise<ProjectFile>} The eventual ProjectFile created
+	*/
+	createProjectFile(name) {
+		return Promise.resolve()
+			.then(()=> app.service('$supabase').fileUpload(app.service('$projects').convertRelativePath(name), {
+				file: new Blob([''], {type: 'text/plain'}),
+				mode: 'encoded',
+				overwrite: false,
+				multiple: false,
+				toast: false,
+				transcoders: false,
+			}))
+			.then(()=> this.getProjectFile(name, {
+				cache: false, // Force cache to update, as this is a new file
+			}))
+			.then(file => file || Promise.reject(`Could not create new file "${name}"`))
+	}
+
+
+	/**
+	* Remove a project file by its ID
+	*
+	* @param {String} id The File ID to remove
+	*
+	* @returns {Promise} A promise which resolves when the operation has completed
+	*/
+	deleteProjectFile(id) {
+		return app.service('$supabase').fileRemove(app.service('$projects').decodeFilePath(id))
+			.then(()=> app.service('$projects').refreshFiles({ // Force a local file list update
+				lazy: false,
+			}))
+			.then(()=> null)
 	}
 
 
 	/**
 	* Replace a project files contents
 	*
-	* @param {String} path File path to write
+	* @param {String} id File to overwrite
 	* @param {File|Blob|FormData|Object|Array} contents The new file contents
 	* @returns {Promise} A promise which will resolve when the write operation has completed
 	*/
-	setProjectFile(path, contents) {
-		return app.service('$supabase').fileSet(path, contents, {
+	setProjectFile(id, contents) {
+		return app.service('$supabase').fileSet(app.service('$projects').decodeFilePath(id), contents, {
 			overwrite: true,
 			toast: false,
 		});
@@ -1051,14 +1116,14 @@ export default class TeraFyServer {
 
 		return app.service('$projects').promise()
 			.then(()=> this.selectProjectFile(settings))
-			.then(selectedFile => this.getProjectLibrary(selectedFile.path, settings))
+			.then(selectedFile => this.getProjectLibrary(selectedFile.id, settings))
 	}
 
 
 	/**
 	* Fetch + convert a project file into a library of citations
 	*
-	* @param {String} path File path to read, if omitted the contents of `options` are used to guess at a suitable file
+	* @param {String} id File ID to read
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {String} [options.format='json'] Format for the file. ENUM: 'pojo' (return a parsed JS collection), 'blob' (raw JS Blob object), 'file' (named JS File object)
@@ -1068,7 +1133,7 @@ export default class TeraFyServer {
 	*
 	* @returns {Promise<Array<Ref>>|Promise<*>} A collection of references (default bevahiour) or a whatever format was requested
 	*/
-	getProjectLibrary(path, options) {
+	getProjectLibrary(id, options) {
 		let settings = {
 			format: 'pojo',
 			autoRequire: true,
@@ -1077,9 +1142,11 @@ export default class TeraFyServer {
 			...options,
 		};
 
+		let filePath = app.service('$projects').decodeFilePath(id);
+
 		return Promise.resolve()
 			.then(()=> settings.autoRequire && this.requireProject())
-			.then(()=> app.service('$supabase').fileGet(path, {
+			.then(()=> app.service('$supabase').fileGet(filePath, {
 				toast: false,
 			}))
 			.then(blob => {
@@ -1089,7 +1156,7 @@ export default class TeraFyServer {
 						return Reflib.uploadFile({
 							file: new File(
 								[blob],
-								app.service('$supabase')._parsePath(path).basename,
+								app.service('$supabase')._parsePath(filePath).basename,
 							),
 						});
 					case 'blob':
@@ -1097,7 +1164,7 @@ export default class TeraFyServer {
 					case 'file':
 						return new File(
 							[blob],
-							app.service('$supabase')._parsePath(path).basename,
+							app.service('$supabase')._parsePath(filePath).basename,
 						);
 					default:
 						throw new Error(`Unsupported library format "${settings.format}"`);
@@ -1109,23 +1176,23 @@ export default class TeraFyServer {
 	/**
 	* Save back a citation library from some input
 	*
-	* @param {String} [path] File path to save back to, if omitted one will be prompted for
+	* @param {String} [id] File ID to save back to, if omitted a file will be prompted for
 	* @param {Array<RefLibRef>|Blob|File} [refs] Collection of references for the selected library or the raw Blob/File
 	*
 	* @param {Object} [options] Additional options to mutate behaviour
-	* @param {String} [options.path] Alternate method to specify the path to save as, if omitted one will be prompted for
+	* @param {String} [options.id] Alternate method to specify the file ID to save as, if omitted one will be prompted for
 	* @param {Array<RefLibRef>|Blob|File} [options.refs] Alternate method to specify the refs to save as an array or raw Blob/File
 	* @param {String} [options.format='auto'] Input format used. ENUM: 'auto' (try to figure it out from context), 'pojo' (JS array of RefLib references), 'blob' (raw JS Blob object), 'file' (named JS File object)
 	* @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 path is unspecified
-	* @param {String} [options.title='Save citation library'] Dialog title if path is unspecified and we need to prompt
+	* @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 {Boolean} [options.overwrite=true] Allow existing file upsert
 	* @param {Object} [options.meta] Optional meta data to merge into the file data
 	*
 	* @returns {Promise} A promise which resolves when the save operation has completed
 	*/
-	setProjectLibrary(path, refs, options) {
+	setProjectLibrary(id, refs, options) {
 		let settings = {
 			format: 'auto',
 			autoRequire: true,
@@ -1135,17 +1202,18 @@ export default class TeraFyServer {
 			overwrite: true,
 			meta: null,
 			...(
-				typeof path == 'string' && Array.isArray(refs) ? {path, refs, ...options} // Called as (path, refs, options?)
-				: Array.isArray(path) || refs instanceof Blob || refs instanceof File ? {refs: path, ...refs} // Called as (refs, options?)
-				: path // Called as (options?)
+				typeof id == 'string' && Array.isArray(refs) ? {id, refs, ...options} // Called as (id, refs, options?)
+				: Array.isArray(id) || refs instanceof Blob || refs instanceof File ? {refs: id, ...refs} // Called as (refs, options?)
+				: id // Called as (options?)
 			)
 		};
 		if (!settings.refs) throw new Error('No refs to save');
 
+		let filePath; // Eventual Supabase path to use
 		return Promise.resolve()
 			.then(()=> settings.autoRequire && this.requireProject())
 			.then(()=> {
-				if (settings.path) return; // We already have a file path specified - skip
+				if (settings.id) return; // We already have a file ID specified - skip
 
 				// Prompt for a save filename
 				return this.selectProjectFile({
@@ -1158,14 +1226,10 @@ export default class TeraFyServer {
 					},
 					autoRequire: false, // Handled above anyway
 				})
-					.then(path => settings.path = path)
+					.then(file => settings.id = file.id)
 			})
-			.then(()=> { // Correct filename to a full path if needed
-				if (!/^\/.+\/.+/.test(settings.path)) { // Not already a qualified full path for a project
-					settings.path = `/projects/${app.service('$projects').active.id}/${settings.path}`;
-				}
-
-				this.debug('INFO', 2, 'Save citation library as', path);
+			.then(()=> { // Compute filePath
+				filePath = app.service('$projects').decodeFilePath(settings.id);
 			})
 			.then(()=> {
 				// Mutate settings.ref -> Blob or File format needed by Supabase
@@ -1184,12 +1248,12 @@ export default class TeraFyServer {
 
 						// Get Reflib to encode the POJO into a Blob/File
 						return Reflib.downloadFile(settings.refs, {
-							filename: settings.path,
+							filename: app.service('$supabase')._parsePath(filePath).basename,
 							promptDownload: false, // Just return the fileBlob we hand to Supabase
 						})
 					case 'blob':
 						if (!(settings.refs instanceof Blob)) throw new Error("setProjectLibrary({format: 'blob'} but non-Blob provided as `refs`");
-						return new File([settings.refs], app.service('$supabase')._parsePath(settings.path).basename);
+						return new File([settings.refs], app.service('$supabase')._parsePath(filePath).basename);
 					case 'file':
 						if (!(settings.ref instanceof File)) throw new Error("setProjectLibrary({format: 'file'} but non-File provided as `refs`");
 						return settings.refs;
@@ -1197,12 +1261,10 @@ export default class TeraFyServer {
 						throw new Error(`Unsupported library format "${settings.format}"`);
 				}
 			})
-			.then(fileBlob => app.service('$supabase').fileUpload(settings.path, {
+			.then(fileBlob => app.service('$supabase').fileUpload(filePath, {
 				file: fileBlob,
-				mode: 'encoded',
 				overwrite: true,
-				meta: settings.meta,
-				transcoders: false, // We can skip transcoders as we are supplying the meta information above anyway
+				mode: 'encoded',
 			}))
 	}
 
@@ -1222,7 +1284,7 @@ export default class TeraFyServer {
 	}
 	// }}}
 
-	// Webpages - setPageUrl() {{{
+	// Webpages - setPageUrl(), setPageTitle {{{
 
 	/**
 	* Set an active tools URL (or path) so that it survives a refresh
@@ -1430,6 +1492,5 @@ export default class TeraFyServer {
 			...msg,
 		);
 	}
-
 	// }}}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/tera-fy",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "TERA website worker",
   "scripts": {
     "dev": "esbuild --platform=browser --format=esm --bundle lib/terafy.client.js --outfile=dist/terafy.js --minify --serve --servedir=.",