@iebh/reflib 2.4.2 → 2.4.3

package/lib/default.js

@@ -1,27 +1,27 @@
-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';
-
-export {
-	formats,
-	getModule,
-	identifyFormat,
-	readFile,
-	readStream,
-	writeFile,
-	writeStream,
-};
-
-export default {
-	formats,
-	getModule,
-	identifyFormat,
-	readFile,
-	readStream,
-	writeFile,
-	writeStream,
-};
+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';
+
+export {
+	formats,
+	getModule,
+	identifyFormat,
+	readFile,
+	readStream,
+	writeFile,
+	writeStream,
+};
+
+export default {
+	formats,
+	getModule,
+	identifyFormat,
+	readFile,
+	readStream,
+	writeFile,
+	writeStream,
+};

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<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);
-			// }}}
-		})
-		// }}}
-}
+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);
+			// }}}
+		})
+		// }}}
+}

package/lib/fields.js

@@ -1,158 +1,158 @@
-/**
-* Field definitions for Reflib citations
-* @type {Object} An object lookup where each key represents a field within a citation
-* @property {string} type A TypeScript compatible type for that field
-* @property {array<string>} [value] Possible values if the type is restricted
-*/
-export let fields = {
-	recNumber: {
-		type: 'string',
-	},
-	type: {
-		type: 'string',
-		values: [
-			'aggregatedDatabase',
-			'ancientText',
-			'artwork',
-			'audioVisualMaterial',
-			'bill',
-			'blog',
-			'book',
-			'bookSection',
-			'case',
-			'catalog',
-			'chartOrTable',
-			'classicalWork',
-			'computerProgram',
-			'conferencePaper',
-			'conferenceProceedings',
-			'dataset',
-			'dictionary',
-			'editedBook',
-			'electronicArticle',
-			'electronicBook',
-			'electronicBookSection',
-			'encyclopedia',
-			'equation',
-			'figure',
-			'filmOrBroadcast',
-			'generic',
-			'governmentDocument',
-			'grant',
-			'hearing',
-			'journalArticle',
-			'legalRuleOrRegulation',
-			'agazineArticle',
-			'manuscript',
-			'map',
-			'music',
-			'newspaperArticle',
-			'onlineDatabase',
-			'onlineMultimedia',
-			'pamphlet',
-			'patent',
-			'personalCommunication',
-			'report',
-			'serial',
-			'standard',
-			'statute',
-			'thesis',
-			'unknown',
-			'unpublished',
-			'web',
-		],
-	},
-	title: {
-		type: 'string',
-	},
-	journal: {
-		type: 'string',
-	},
-	authors: {
-		type: 'array<string>',
-	},
-	date: {
-		type: 'string',
-	},
-	urls: {
-		type: 'array<string>',
-	},
-	pages: {
-		type: 'string',
-	},
-	volume: {
-		type: 'string',
-	},
-	number: {
-		type: 'string',
-	},
-	isbn: {
-		type: 'string',
-	},
-	abstract: {
-		type: 'string',
-	},
-	label: {
-		type: 'string',
-	},
-	caption: {
-		type: 'string',
-	},
-	notes: {
-		type: 'string',
-	},
-	address: {
-		type: 'string',
-	},
-	researchNotes: {
-		type: 'string',
-	},
-	keywords: {
-		type: 'array<string>',
-	},
-	accessDate: {
-		type: 'string',
-	},
-	accession: {
-		type: 'string',
-	},
-	doi: {
-		type: 'string',
-	},
-	section: {
-		type: 'string',
-	},
-	language: {
-		type: 'string',
-	},
-	databaseProvider: {
-		type: 'string',
-	},
-	database: {
-		type: 'string',
-	},
-	workType: {
-		type: 'string',
-	},
-	custom1: {
-		type: 'string',
-	},
-	custom2: {
-		type: 'string',
-	},
-	custom3: {
-		type: 'string',
-	},
-	custom4: {
-		type: 'string',
-	},
-	custom5: {
-		type: 'string',
-	},
-	custom6: {
-		type: 'string',
-	},
-	custom7: {
-		type: 'string',
-	},
-};
+/**
+* Field definitions for Reflib citations
+* @type {Object} An object lookup where each key represents a field within a citation
+* @property {string} type A TypeScript compatible type for that field
+* @property {array<string>} [value] Possible values if the type is restricted
+*/
+export let fields = {
+	recNumber: {
+		type: 'string',
+	},
+	type: {
+		type: 'string',
+		values: [
+			'aggregatedDatabase',
+			'ancientText',
+			'artwork',
+			'audioVisualMaterial',
+			'bill',
+			'blog',
+			'book',
+			'bookSection',
+			'case',
+			'catalog',
+			'chartOrTable',
+			'classicalWork',
+			'computerProgram',
+			'conferencePaper',
+			'conferenceProceedings',
+			'dataset',
+			'dictionary',
+			'editedBook',
+			'electronicArticle',
+			'electronicBook',
+			'electronicBookSection',
+			'encyclopedia',
+			'equation',
+			'figure',
+			'filmOrBroadcast',
+			'generic',
+			'governmentDocument',
+			'grant',
+			'hearing',
+			'journalArticle',
+			'legalRuleOrRegulation',
+			'agazineArticle',
+			'manuscript',
+			'map',
+			'music',
+			'newspaperArticle',
+			'onlineDatabase',
+			'onlineMultimedia',
+			'pamphlet',
+			'patent',
+			'personalCommunication',
+			'report',
+			'serial',
+			'standard',
+			'statute',
+			'thesis',
+			'unknown',
+			'unpublished',
+			'web',
+		],
+	},
+	title: {
+		type: 'string',
+	},
+	journal: {
+		type: 'string',
+	},
+	authors: {
+		type: 'array<string>',
+	},
+	date: {
+		type: 'string',
+	},
+	urls: {
+		type: 'array<string>',
+	},
+	pages: {
+		type: 'string',
+	},
+	volume: {
+		type: 'string',
+	},
+	number: {
+		type: 'string',
+	},
+	isbn: {
+		type: 'string',
+	},
+	abstract: {
+		type: 'string',
+	},
+	label: {
+		type: 'string',
+	},
+	caption: {
+		type: 'string',
+	},
+	notes: {
+		type: 'string',
+	},
+	address: {
+		type: 'string',
+	},
+	researchNotes: {
+		type: 'string',
+	},
+	keywords: {
+		type: 'array<string>',
+	},
+	accessDate: {
+		type: 'string',
+	},
+	accession: {
+		type: 'string',
+	},
+	doi: {
+		type: 'string',
+	},
+	section: {
+		type: 'string',
+	},
+	language: {
+		type: 'string',
+	},
+	databaseProvider: {
+		type: 'string',
+	},
+	database: {
+		type: 'string',
+	},
+	workType: {
+		type: 'string',
+	},
+	custom1: {
+		type: 'string',
+	},
+	custom2: {
+		type: 'string',
+	},
+	custom3: {
+		type: 'string',
+	},
+	custom4: {
+		type: 'string',
+	},
+	custom5: {
+		type: 'string',
+	},
+	custom6: {
+		type: 'string',
+	},
+	custom7: {
+		type: 'string',
+	},
+};

package/lib/formats.js

@@ -1,61 +1,61 @@
-/**
-* Lookup table of various citation file formats
-* @type {array<Object>} A collection of Reflib supported file formats
-* @property {string} title The long form title of the format
-* @property {string} titleShort Shorter title of the format
-* @property {string} input Input format required by parser
-* @property {string} output Output format required by formatter
-* @property {array>string>} ext File extensions of this format, the first entry is generally used as the output default
-* @property {boolean} canRead Whether the format is supported when reading a citation library
-* @property {boolean} canWrite Whether the format is supported when writing a citation library
-*/
-export let formats = {
-	csv: {
-		id: 'csv',
-		title: 'Comma Seperated Values',
-		titleShort: 'CSV',
-		ext: ['.csv'],
-		canRead: false,
-		canWrite: false,
-	},
-	endnoteXml: {
-		id: 'endnoteXml',
-		title: 'EndNoteXML',
-		titleShort: 'EndNoteXML',
-		ext: ['.xml'],
-		canRead: true,
-		canWrite: true,
-	},
-	json: {
-		id: 'json',
-		title: 'JSON',
-		titleShort: 'JSON',
-		ext: ['.json'],
-		canRead: true,
-		canWrite: true,
-	},
-	medline: {
-		id: 'medline',
-		title: 'MEDLINE / PubMed',
-		titleShort: 'MEDLINE',
-		ext: ['.nbib'],
-		canRead: true,
-		canWrite: true,
-	},
-	ris: {
-		id: 'ris',
-		title: 'RIS',
-		titleShort: 'RIS',
-		ext: ['.ris','.txt'],
-		canRead: true,
-		canWrite: true,
-	},
-	tsv: {
-		id: 'tsv',
-		title: 'Tab Seperated Values',
-		titleShort: 'TSV',
-		ext: ['.tsv'],
-		canRead: false,
-		canWrite: false,
-	},
-}
+/**
+* Lookup table of various citation file formats
+* @type {array<Object>} A collection of Reflib supported file formats
+* @property {string} title The long form title of the format
+* @property {string} titleShort Shorter title of the format
+* @property {string} input Input format required by parser
+* @property {string} output Output format required by formatter
+* @property {Array<String>} ext File extensions of this format, the first entry is generally used as the output default
+* @property {boolean} canRead Whether the format is supported when reading a citation library
+* @property {boolean} canWrite Whether the format is supported when writing a citation library
+*/
+export let formats = {
+	csv: {
+		id: 'csv',
+		title: 'Comma Seperated Values',
+		titleShort: 'CSV',
+		ext: ['.csv'],
+		canRead: false,
+		canWrite: false,
+	},
+	endnoteXml: {
+		id: 'endnoteXml',
+		title: 'EndNoteXML',
+		titleShort: 'EndNoteXML',
+		ext: ['.xml'],
+		canRead: true,
+		canWrite: true,
+	},
+	json: {
+		id: 'json',
+		title: 'JSON',
+		titleShort: 'JSON',
+		ext: ['.json'],
+		canRead: true,
+		canWrite: true,
+	},
+	medline: {
+		id: 'medline',
+		title: 'MEDLINE / PubMed',
+		titleShort: 'MEDLINE',
+		ext: ['.nbib'],
+		canRead: true,
+		canWrite: true,
+	},
+	ris: {
+		id: 'ris',
+		title: 'RIS',
+		titleShort: 'RIS',
+		ext: ['.ris','.txt'],
+		canRead: true,
+		canWrite: true,
+	},
+	tsv: {
+		id: 'tsv',
+		title: 'Tab Seperated Values',
+		titleShort: 'TSV',
+		ext: ['.tsv'],
+		canRead: false,
+		canWrite: false,
+	},
+}