@iebh/reflib 2.7.2 → 2.8.1

package/modules/interface.js

@@ -1,47 +1,47 @@
-/**
-* Generic module interface
-* This file serves no purpose other than to document the methods that each module can itself expose
-*/
-/* eslint-disable jsdoc/require-returns-check, no-unused-vars */
-
-
-/**
-* Provide the low-level function for a module to read a stream and emit refs
-* @param {stream.Readable} stream Input stream to read from
-* @param {Object} [options] Additional options to use when parsing
-* @returns {EventEmitter} EventEmitter(-like) that should emit the below events
-*
-* @emits ref Emitted with a single ref object when found
-* @emits end Emitted when parsing has completed
-* @emits error Emitted when an error has been raised
-* @emits progress Emitted as (bytesRead) when reading a stream
-*/
-export function readStream(stream, options) {
-	// Stub
-}
-
-
-/**
-* Provide the low-level function for a module to write a stream
-* @param {stream.Writable} stream Output stream to write to
-* @param {array<Object>} refs Collection of refs to write
-* @param {Object} [options] Additional options to use when writing
-*
-* @returns {Object} An object which exposes methods to call to start, write and end the writing process. All methods MUST return a Promise
-* @property {function<Promise>} start Function to call when beginning to write
-* @property {function<Promise>} write Function called as `(ref)` when writing a single ref
-* @property {function<promise>} [middle] Function to call after `write()` for each reference if the reference is NOT last, this works similar to `Array.prototype.join()`
-* @property {function<Promise>} end Function to call when finishing writing, must resolve its Promise when the stream has closed successfully
-*/
-export function writeStream(stream, refs, options) {
-	// Stub
-}
-
-
-/**
-* Function to run to set up any additional data before the module is needed
-* This is generally used by worker functions which construct maps from collections for efficiency purposes
-*/
-export function setup() {
-	// Stub
-}
+/**
+* Generic module interface
+* This file serves no purpose other than to document the methods that each module can itself expose
+*/
+/* eslint-disable jsdoc/require-returns-check, no-unused-vars */
+
+
+/**
+* Provide the low-level function for a module to read a stream and emit refs
+* @param {stream.Readable} stream Input stream to read from
+* @param {Object} [options] Additional options to use when parsing
+* @returns {EventEmitter} EventEmitter(-like) that should emit the below events
+*
+* @emits ref Emitted with a single ref object when found
+* @emits end Emitted when parsing has completed
+* @emits error Emitted when an error has been raised
+* @emits progress Emitted as (bytesRead) when reading a stream
+*/
+export function readStream(stream, options) {
+	// Stub
+}
+
+
+/**
+* Provide the low-level function for a module to write a stream
+* @param {stream.Writable} stream Output stream to write to
+* @param {array<Object>} refs Collection of refs to write
+* @param {Object} [options] Additional options to use when writing
+*
+* @returns {Object} An object which exposes methods to call to start, write and end the writing process. All methods MUST return a Promise
+* @property {function<Promise>} start Function to call when beginning to write
+* @property {function<Promise>} write Function called as `(ref)` when writing a single ref
+* @property {function<promise>} [middle] Function to call after `write()` for each reference if the reference is NOT last, this works similar to `Array.prototype.join()`
+* @property {function<Promise>} end Function to call when finishing writing, must resolve its Promise when the stream has closed successfully
+*/
+export function writeStream(stream, refs, options) {
+	// Stub
+}
+
+
+/**
+* Function to run to set up any additional data before the module is needed
+* This is generally used by worker functions which construct maps from collections for efficiency purposes
+*/
+export function setup() {
+	// Stub
+}

package/modules/json.js

@@ -1,79 +1,109 @@
-import Emitter from '../shared/emitter.js';
-// This import is overwritten by the 'browser' field in package.json with the shimmed version
-import JSONStream from 'JSONStream';
-
-/**
-* Read a JSON stream and emit references
-* @see modules/interface.js
-*
-* @param {Stream} stream Stream primative to encapsulate
-*
-* @returns {Object} A readable stream analogue defined in `modules/interface.js`
-*/
-export function readStream(stream) {
-	let recNumber = 1;
-	let emitter = Emitter();
-
-	// Queue up the parser in the next tick (so we can return the emitter first)
-	setTimeout(()=> {
-		stream.on('data', ()=> emitter.emit('progress', stream.bytesRead));
-
-		if (typeof stream.pipe === 'function') {
-			// On node.js
-			const nodeJSONStream = JSONStream.parse('*')
-			nodeJSONStream.on('data', ref => emitter.emit('ref', {
-					recNumber: recNumber++,
-					...ref,
-				}))
-			nodeJSONStream.on('end', ()=> emitter.emit('end'))
-			nodeJSONStream.on('error', emitter.emit.bind('error'));
-			stream.pipe(nodeJSONStream)
-		}
-
-		else {
-			console.error('Error with stream, check "streamEmitter.js" if on browser')
-		}
-	});
-
-	return emitter;
-}
-
-
-/**
-* Write to a stream object
-*
-* @see modules/interface.js
-*
-* @param {Steam} [stream] The stream to write to
-* @param {Object} [options] Additional options to use when parsing
-* @param {string} [options.lineSuffix='\n'] Optional line suffix for each output line of JSON
-*
-* @returns {Object} A writable stream analogue defined in `modules/interface.js`
-*/
-export function writeStream(stream, options) {
-	let settings = {
-		lineSuffix: '\n',
-		...options,
-	};
-
-	let lastRef; // Hold last refrence string in memory so we know when we've reached the end (last item shoulnd't have a closing comma)
-
-	return {
-		start: ()=> {
-			stream.write('[\n');
-			return Promise.resolve();
-		},
-		write: ref => {
-			if (lastRef) stream.write(lastRef + ',' + settings.lineSuffix); // Flush last reference to disk with comma
-			lastRef = JSON.stringify(ref);
-			return Promise.resolve();
-		},
-		end: ()=> {
-			if (lastRef) stream.write(lastRef + settings.lineSuffix); // Flush final reference to disk without final comma
-			stream.write(']');
-			return new Promise((resolve, reject) =>
-				stream.end(err => err ? reject(err) : resolve())
-		);
-	},
-};
-}
+import Emitter from '../shared/emitter.js';
+// This import is overwritten by the 'browser' field in package.json with the shimmed version
+import JSONStream from 'JSONStream';
+import sortKeys from '@momsfriendlydevco/sort-keys';
+
+/**
+* Read a JSON stream and emit references
+* @see modules/interface.js
+*
+* @param {Stream} stream Stream primative to encapsulate
+*
+* @returns {Object} A readable stream analogue defined in `modules/interface.js`
+*/
+export function readStream(stream) {
+	let recNumber = 1;
+	let emitter = Emitter();
+
+	// Queue up the parser in the next tick (so we can return the emitter first)
+	setTimeout(()=> {
+		stream.on('data', ()=> emitter.emit('progress', stream.bytesRead));
+
+		if (typeof stream.pipe === 'function') {
+			// On node.js
+			const nodeJSONStream = JSONStream.parse('*')
+			nodeJSONStream.on('data', ref => emitter.emit('ref', {
+					recNumber: recNumber++,
+					...ref,
+				}))
+			nodeJSONStream.on('end', ()=> emitter.emit('end'))
+			nodeJSONStream.on('error', emitter.emit.bind('error'));
+			stream.pipe(nodeJSONStream)
+		}
+
+		else {
+			console.error('Error with stream, check "streamEmitter.js" if on browser')
+		}
+	});
+
+	return emitter;
+}
+
+
+/**
+* Write to a stream object
+*
+* @see modules/interface.js
+*
+* @param {Steam} [stream] The stream to write to
+* @param {Object} [options] Additional options to use when parsing
+* @param {String} [options.indent=2] The Indentation option, specify number of space indents or the literal string to indent by (i.e. `\t`)
+* @param {String} [options.lineSuffix='\n'] Optional line suffix for each output line of JSON
+* @param {Object} [options.sortKeys] Optional options object passed to `sort-keys` to tidy up the output. If omitted the reference is used as is
+*
+* @returns {Object} A writable stream analogue defined in `modules/interface.js`
+*/
+export function writeStream(stream, options) {
+	let settings = {
+		lineSuffix: '\n',
+		indent: 2,
+		sortKeys: {
+			keys: {
+				'recNumber': 1,
+				'type': 5,
+				'title': 13,
+				'journal': 14,
+				'authors': 15,
+				'isbn': 16,
+				'doi': 17,
+				'edition': 21,
+				'number': 22,
+				'pages': 23,
+				'language': 70,
+				'custom1': 81,
+				'custom2': 82,
+				'custom3': 83,
+				'custom4': 84,
+				'custom5': 85,
+				'custom6': 86,
+				'custom7': 87,
+				'researchNotes': 91,
+				'notes': 92,
+				'abstract': 93,
+			},
+		},
+		...options,
+	};
+
+	let lastRef; // Hold last refrence string in memory so we know when we've reached the end (last item shoulnd't have a closing comma)
+
+	return {
+		start: ()=> {
+			stream.write('[\n');
+			return Promise.resolve();
+		},
+		write: rawRef => {
+			let ref = settings.sortKeys ? sortKeys(rawRef, settings.sortKeys) : rawRef;
+			if (lastRef) stream.write(lastRef + ',' + settings.lineSuffix); // Flush last reference to disk with comma
+			lastRef = JSON.stringify(ref, null, settings.indent);
+			return Promise.resolve();
+		},
+		end: ()=> {
+			if (lastRef) stream.write(lastRef + settings.lineSuffix); // Flush final reference to disk without final comma
+			stream.write(']');
+			return new Promise((resolve, reject) =>
+				stream.end(err => err ? reject(err) : resolve())
+		);
+	},
+};
+}