@iebh/reflib 2.2.0 → 2.2.1

package/lib/downloadFile.js

@@ -9,13 +9,15 @@ import {writeStream} from './writeStream.js';
 * @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} A promise which will resolve when the file download has completed
+* @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,
 	};
 
@@ -74,6 +76,8 @@ export function downloadFile(refs, options) {
 		// }}}
 		// Download Blob
 		.then(blob => {
+			if (!settings.promptDownload) return blob;
+
 			let url = URL.createObjectURL(blob);
 			let aEl = document.createElement('a');
 			aEl.href = 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/package.json

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