@iebh/tera-fy 1.0.8 → 1.0.9

package/lib/terafy.client.js

@@ -64,6 +64,9 @@ export default class TeraFy {
 		'getProjectState', 'applyProjectStatePatch',
 		// bindProjectState() - See below
 
+		// Project files
+		'getProjectFiles',
+
 		// Project Libraries
 		'getProjectLibrary', 'setProjectLibrary',
 	];

package/lib/terafy.server.js

@@ -434,6 +434,63 @@ export default class TeraFyServer {
 		this.debug('Applying sever state patch', {patch});
 	}
 
+
+
+	/**
+	* Subscribers to server project state changes
+	* @type {Array<Object>}}
+	* @property {String} id A unique ID for this subscriber state
+	* @property {String} source The human readable source for each subscriber
+	* @property {Function} sendPatch Function used to send a patch to a subscriber
+	* @property {Function} unsubscribe Function to release the client subscription
+	*/
+	projectStateSubscribers = [];
+	// }}}
+
+	// Project files - getProjectFiles() {{{
+
+	/**
+	* Data structure for a project file
+	* @class ProjectFile
+	*
+	* @property {String} id A UUID string representing the unique ID of the file
+	* @property {String} name Relative name path (can contain prefix directories) for the human readable file name
+	* @property {Object} parsedName An object representing meta file parts of a file name
+	* @property {String} parsedName.basename The filename + extention (i.e. everything without directory name)
+	* @property {String} parsedName.filename The file portion of the name (basename without the extension)
+	* @property {String} parsedName.ext The extension portion of the name (always lower case)
+	* @property {String} parsedName.dirName The directory path portion of the name
+	* @property {Date} created A date representing when the file was created
+	* @property {Date} modified A date representing when the file was created
+	* @property {Date} accessed A date representing when the file was last accessed
+	* @property {Number} size Size, in bytes, of the file
+	* @property {String} mime The associated mime type for the file
+	*/
+
+
+	/**
+	* Fetch the files associated with a given project
+	*
+	* @param {Object} options Options which mutate behaviour
+	* @param {Boolean} [options.autoRequire=true] Run `requireProject()` automatically before continuing
+	* @param {Boolean} [options.meta=true] Pull meta information for each file entity
+	*
+	* @returns {Promise<ProjectFile>} A collection of project files for the given project
+	*/
+	getProjectFiles(options) {
+		let settings = {
+			autoRequire: true,
+			meta: true,
+			...options,
+		};
+
+		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,
+			}))
+	}
 	// }}}
 
 	// Project Libraries - getProjectLibrary(), setProjectLibrary() {{{
@@ -441,24 +498,47 @@ export default class TeraFyServer {
 	/**
 	* Fetch the active projects citation library
 	*
+	* @param {String} [path] Optional file path to use, if omitted the contents of `options` are used to guess at a suitable file
 	* @param {Object} [options] Additional options to mutate behaviour
 	* @param {Boolean} [options.autoRequire=true] Run `requireProject()` automatically before continuing
 	* @param {Boolean} [options.multiple=false] Allow selection of multiple libraries
+	* @param {Function} [options.filter] Optional async file filter, called each time as `(File:ProjectFile)`
+	* @param {Function} [options.find] Optional async final stage file filter to reduce all candidates down to one subject file
 	* @param {String|Array<String>} [options.hint] Hints to identify the library to select in array order of preference. Generally corresponds to the previous stage - e.g. 'deduped', 'review1', 'review2', 'dedisputed'
 	*
-	* @returns {Promise<Array<RefLibRef>>} Collection of references for the selected library
+	* @returns {Promise<Array<ProjectFile>>} Collection of references for the selected library matching the given hint + filter, this could be a zero length array
 	*/
-	getProjectLibrary(options) {
+	getProjectLibrary(path, options) {
 		let settings = {
+			path,
 			autoRequire: true,
 			multiple: false,
 			hint: null,
-			...options,
+			filter: file => true,
+			find: files => files.at(0),
+			...(typeof path == 'string' ? {path, ...options} : path),
 		};
 
 		return Promise.resolve()
-			.then(()=> settings.autoRequire && this.requireProject())
-			// FIXME: Stub
+			.then(()=> {
+				if (settings.path) { // Already have a file name picked
+					if (!settings.path.startsWith('/')) throw new Error('All file names must start with a forward slash');
+					return settings.path;
+				} else { // Try to guess the file from the options structure
+					return this.getProjectFiles({
+						autoRequire: settings.autoRequire,
+					})
+					.then(files => files.filter(file =>
+						settings.filter(file)
+					))
+					.then(files => settings.find(files))
+					.then(file => file.path)
+				}
+			})
+			.then(filePath => app.service('$supabase').fileGet(filePath, {
+				json: true,
+				toast: false,
+			}))
 	}
 
 

package/package.json

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