@iebh/reflib 2.8.0 → 2.8.2

package/app.js

@@ -1,85 +1,87 @@
-#!/usr/bin/node
-
-import parseArgs from './shared/parseArgs.js';
-import packageInfo from './package.json' with {type: 'json'};
-import reflib from './lib/default.js';
-
-let help = `
-
-Usage: reflib -i INPUT_FILE [-f FORMAT] [-o -|OUTPUT_FILE]
-
-
--i, --input <file>             Input file to process
-
--o, --output <file>            Output file to save. Use '-' for STDOUT
-
--f, --format <reflib-format>   Override or set the file output type (if omitted the outfile filename
-                               is used to determine the format)
-
--v, --verbose                  Be verbose when processing
-
---version                      Print CLI version and exit
-
--h, --help                     This help screen
-`;
-
-// Parse args {{{
-let args = parseArgs.parse();
-args = parseArgs.expand(args, {
-	'h': 'help',
-	'i': 'input',
-	'o': 'output',
-	'f': 'format',
-	'v': 'verbose',
-});
-// }}}
-
-// Action: Version {{{
-if (args.version) {
-	console.log(`Version: ${packageInfo.version}`);
-	process.exit(0);
-}
-// }}}
-// Action: Convert (if --input) {{{
-if (args.input) {
-	if (args.verbose) console.log('Reading', args.input);
-	let refs = await reflib.readFile(args.input);
-	if (args.verbose) console.log('Read', refs.length, 'refs');
-
-	if (!args.output) {
-		if (args.verbose) console.log('No output file specified - assuming STDOUT JSON');
-		console.log(JSON.stringify(refs, null, 2));
-	} else if (args.output == '-' || args.output === true) {
-		if (!args.format) {
-			if (args.verbose) console.log('No STDOUT format specified - assuming JSON');
-			console.log(JSON.stringify(refs, null, 2));
-		} else {
-			if (args.verbose) console.log(`Raw output to STDOUT using "${args.format}" format`);
-
-			let stream = reflib.writeStream(args.format, process.stdout);
-			await stream.start();
-			await Array.fromAsync(refs, ref =>
-				stream.write(ref)
-			);
-			await stream.end();
-		}
-	} else if (args.output) {
-		if (args.verbose) console.log('Writing', args.output);
-		await reflib.writeFile(args.output, refs);
-	}
-
-	if (args.verbose) console.log('All done');
-	process.exit(0);
-}
-// }}}
-// Action: Help {{{
-if (args.help) {
-	console.log(help);
-	process.exit(0);
-}
-// }}}
-// Action: Unknown {{{
-console.warn('Nothing to do');
-console.log(help);
-process.exit(1);
-// }}}
+#!/usr/bin/node
+
+import parseArgs from './shared/parseArgs.js';
+import packageInfo from './package.json' with {type: 'json'};
+import reflib from './lib/default.js';
+
+let help = `
+
+Usage: reflib -i INPUT_FILE [-f FORMAT] [-o -|OUTPUT_FILE]
+
+
+-i, --input <file>             Input file to process
+
+-o, --output <file>            Output file to save. Use '-' for STDOUT
+
+-f, --format <reflib-format>   Override or set the file output type (if omitted the outfile filename
+                               is used to determine the format)
+
+-v, --verbose                  Be verbose when processing
+
+--version                      Print CLI version and exit
+
+-h, --help                     This help screen
+`;
+
+// Parse args {{{
+let args = parseArgs.parse();
+args = parseArgs.expand(args, {
+	'h': 'help',
+	'i': 'input',
+	'o': 'output',
+	'f': 'format',
+	'v': 'verbose',
+});
+args.format ||= 'json';
+// }}}
+
+// Action: Version {{{
+if (args.version) {
+	console.log(`Version: ${packageInfo.version}`);
+	process.exit(0);
+}
+// }}}
+// Action: Convert (if --input) {{{
+if (args.input) {
+	if (args.verbose) console.log('Reading', args.input);
+	let refs = await reflib.readFile(args.input);
+	if (args.verbose) console.log('Read', refs.length, 'refs');
+
+	if (
+		!args.output // No output file specified
+		|| args.output == '-' // OR use STDOUT
+		|| args.output === true // OR output is just specified as a flag with no rider
+	) {
+		if (args.verbose) console.log(`Raw output to STDOUT using "${args.format}" format`);
+
+		let stream = reflib.writeStream(
+			args.format,
+			process.stdout,
+			args.format == 'json' ? {indent:'\t'} : {},
+		);
+		await stream.start();
+		await Array.fromAsync(refs, (ref, refIndex) => Promise.resolve()
+			.then(()=> stream.write(ref))
+			.then(()=> refIndex < refs.length && stream.middle && stream.middle(ref))
+		);
+		await stream.end();
+	} else if (args.output) {
+		if (args.verbose) console.log('Writing', args.output);
+		await reflib.writeFile(args.output, refs);
+	}
+
+	if (args.verbose) console.log('All done');
+	process.exit(0);
+}
+// }}}
+// Action: Help {{{
+if (args.help) {
+	console.log(help);
+	process.exit(0);
+}
+// }}}
+// Action: Unknown {{{
+console.warn('Nothing to do');
+console.log(help);
+process.exit(1);
+// }}}

package/lib/browser.js

@@ -1,30 +1,30 @@
-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';
-import { getRefDoi } from './getRefDoi.js';
-
-export {
-	downloadFile,
-	formats,
-	getModule,
-	identifyFormat,
-	readStream,
-	uploadFile,
-	writeStream,
-	getRefDoi
-};
-
-export default {
-	downloadFile,
-	formats,
-	getModule,
-	identifyFormat,
-	readStream,
-	uploadFile,
-	writeStream,
-	getRefDoi
-};
+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';
+import { getRefDoi } from './getRefDoi.js';
+
+export {
+	downloadFile,
+	formats,
+	getModule,
+	identifyFormat,
+	readStream,
+	uploadFile,
+	writeStream,
+	getRefDoi
+};
+
+export default {
+	downloadFile,
+	formats,
+	getModule,
+	identifyFormat,
+	readStream,
+	uploadFile,
+	writeStream,
+	getRefDoi
+};

package/lib/default.js

@@ -1,30 +1,30 @@
-import {identifyFormat} from './identifyFormat.js';
-import {formats} from './formats.js';
-import {getModule} from './getModule.js';
-import {readStream} from './readStream.js';
-import {readFile} from './readFile.js';
-import {writeStream} from './writeStream.js';
-import {writeFile} from './writeFile.js';
-import { getRefDoi } from './getRefDoi.js';
-
-export {
-	formats,
-	getModule,
-	identifyFormat,
-	readFile,
-	readStream,
-	writeFile,
-	writeStream,
-	getRefDoi
-};
-
-export default {
-	formats,
-	getModule,
-	identifyFormat,
-	readFile,
-	readStream,
-	writeFile,
-	writeStream,
-	getRefDoi
-};
+import {identifyFormat} from './identifyFormat.js';
+import {formats} from './formats.js';
+import {getModule} from './getModule.js';
+import {readStream} from './readStream.js';
+import {readFile} from './readFile.js';
+import {writeStream} from './writeStream.js';
+import {writeFile} from './writeFile.js';
+import { getRefDoi } from './getRefDoi.js';
+
+export {
+	formats,
+	getModule,
+	identifyFormat,
+	readFile,
+	readStream,
+	writeFile,
+	writeStream,
+	getRefDoi
+};
+
+export default {
+	formats,
+	getModule,
+	identifyFormat,
+	readFile,
+	readStream,
+	writeFile,
+	writeStream,
+	getRefDoi
+};

package/lib/downloadFile.js

@@ -1,94 +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<ReflibRef>} refs 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);
-			// }}}
-		})
-		// }}}
-}
+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<ReflibRef>} refs 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, refIndex, refs) =>
+				promiseChain
+					.then(()=> streamer.write(ref))
+					.then(()=> refIndex < refs.length && streamer.middle && streamer.middle(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);
+			// }}}
+		})
+		// }}}
+}