@iebh/reflib 2.1.4 → 2.2.1

package/lib/browser.js

@@ -1,9 +1,27 @@
-import {identifyFormat} from './identifyFormat.js';
+import {downloadFile} from './downloadFile.js';
 import {formats} from './formats.js';
 import {getModule} from './getModule.js';
+import {identifyFormat} from './identifyFormat.js';
 import {readStream} from './readStream.js';
 import {uploadFile} from './uploadFile.js';
 import {writeStream} from './writeStream.js';
 
-export {identifyFormat, formats, getModule, readStream, uploadFile, writeStream};
-export default {identifyFormat, formats, getModule, readStream, uploadFile, writeStream};
+export {
+	downloadFile,
+	formats,
+	getModule,
+	identifyFormat,
+	readStream,
+	uploadFile,
+	writeStream,
+};
+
+export default {
+	downloadFile,
+	formats,
+	getModule,
+	identifyFormat,
+	readStream,
+	uploadFile,
+	writeStream,
+};

package/lib/default.js

@@ -6,5 +6,22 @@ import {readFile} from './readFile.js';
 import {writeStream} from './writeStream.js';
 import {writeFile} from './writeFile.js';
 
-export {identifyFormat, formats, getModule, readStream, readFile, writeStream, writeFile};
-export default {identifyFormat, formats, getModule, readStream, readFile, writeStream, writeFile};
+export {
+	formats,
+	getModule,
+	identifyFormat,
+	readFile,
+	readStream,
+	writeFile,
+	writeStream,
+};
+
+export default {
+	formats,
+	getModule,
+	identifyFormat,
+	readFile,
+	readStream,
+	writeFile,
+	writeStream,
+};

package/lib/downloadFile.js

@@ -0,0 +1,94 @@
+import {identifyFormat} from './identifyFormat.js';
+import {writeStream} from './writeStream.js';
+
+/**
+* Prompt the user for a file to save as and Write a given array of citations
+*
+* @param {Array<Ref>} Collection of references to write
+*
+* @param {Object} [options] Additional options when prompting the user
+* @param {String} [options.filename='References.xml'] The filename to download
+* @param {Object} [options.writeStreamOptions] Additional options for the subsequent `writeStream` internal call
+* @param {Object} [options.promptDownload=true] Prompt the user to save the file, if falsy this returns the Blob file content instead of asking the user where to save it
+*
+* @returns {Promise|Promise<Blob>} A promise which will resolve when the file download has completed or (if `!promptDownload`) with the blob contents
+*/
+export function downloadFile(refs, options) {
+	let settings = {
+		filename: 'References.xml',
+		writeStreamOptions: {},
+		promptDownload: true,
+		...options,
+	};
+
+	return Promise.resolve()
+		// Identify module from filename {{{
+		.then(()=> {
+			let module = identifyFormat(settings.filename);
+			if (!module) throw new Error(`Unsupported Reflib filename "${settings.filename}"`);
+			return module;
+		})
+		// }}}
+		// Create stream {{{
+		.then(async (module) => {
+			let blobData = [];
+			let writableStream = new WritableStream({
+				write(chunk) {
+					blobData.push(chunk);
+				},
+			});
+
+			let writer = writableStream.getWriter();
+
+			// Map end->close to keep browser compatibility with Node
+			writer.end = async (cb) => {
+				await writer.close();
+				cb();
+			};
+
+			let streamer = await writeStream(module.id, writer, settings.writeStreamOptions);
+
+			return {blobData, streamer};
+		})
+		// }}}
+		// Flush all references into the stream {{{
+		.then(async ({blobData, streamer}) => {
+			// Start stream
+			await streamer.start();
+
+			// Write all references as a promise chain
+			await refs.reduce((promiseChain, ref) =>
+				promiseChain.then(()=>
+					streamer.write(ref)
+				)
+			, Promise.resolve());
+
+			// End stream
+			await streamer.end();
+
+			return blobData;
+		})
+		// }}}
+		// Convert blobData array to a Blob {{{
+		.then(blobData => {
+			return new Blob(blobData);
+		})
+		// }}}
+		// Download Blob
+		.then(blob => {
+			if (!settings.promptDownload) return blob;
+
+			let url = URL.createObjectURL(blob);
+			let aEl = document.createElement('a');
+			aEl.href = url;
+			aEl.download = settings.filename;
+			document.body.appendChild(aEl);
+			aEl.click();
+
+			// Clean up DOM
+			document.body.removeChild(aEl);
+			URL.revokeObjectURL(url);
+			// }}}
+		})
+		// }}}
+}

package/lib/uploadFile.js

@@ -8,7 +8,7 @@ import StreamEmitter from '../shared/streamEmitter.js';
 * @param {Object} [options] Additional options when prompting the user
 * @param {File} [options.file] The File object to process, omitting this will prompt the user to select a file
 * @param {function} [options.onStart] Async function called as `(File)` when starting the read stage
-* @param {function} [options.onProgress] Function called as `(position, totalSize)` when processing the file
+* @param {function} [options.onProgress] Function called as `(position, totalSize, refCount)` when processing the file
 * @param {function} [options.onEnd] Async function called as `()` when the read stage has completed
 * @param {*} [options.*] Additional settings to pass to `readStream()`
 * @returns {Promise} A promise which will resolve with an array of extracted citations
@@ -17,6 +17,7 @@ export function uploadFile(options) {
 	let settings = {...options};
 
 	if (!settings.file) { // No file provided - prompt the user via the DOM
+		// Horrible kludge to create an upload element in the DOM + interact with it {{{
 		return new Promise(resolve => {
 			// Create hidden layer we will use to wrap the actual file upload input box
 			let fileWrapper = document.createElement('div');
@@ -40,6 +41,7 @@ export function uploadFile(options) {
 			fileWrapper.appendChild(uploader);
 			uploader.dispatchEvent(new MouseEvent('click'));
 		});
+		// }}}
 	} else { // Read the File object and return an emitter
 		if (!(settings.file instanceof File)) throw new Error('Expected "file" setting to uploadFile() to be a File type');
 		let identifiedType = identifyFormat(settings.file.name);
@@ -49,7 +51,6 @@ export function uploadFile(options) {
 		return Promise.resolve()
 			.then(()=> settings.onStart && settings.onStart(settings.file))
 			.then(()=> new Promise((resolve, reject) => {
-
 				let streamer = readStream(
 					identifiedType.id,
 					StreamEmitter(settings.file.stream()),

package/lib/writeFile.js

@@ -4,9 +4,12 @@ import {writeStream} from './writeStream.js';
 
 /**
 * Write a file to disk via the appropriate module
+*
 * @param {string} path The file path to write, the module to use will be determined from this
+* @param {Array<Ref>} Collection of references to write
 * @param {Object} [options] Additional options to pass to the file writer
 * @param {string} [options.module] The module to use if overriding from the file path
+*
 * @returns {Promise} A promise which resolves when the operation has completed
 */
 export function writeFile(path, refs, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/reflib",
-  "version": "2.1.4",
+  "version": "2.2.1",
   "description": "Reference / Citation reference library utilities",
   "scripts": {
     "lint": "eslint lib modules shared test",