@iebh/reflib 2.7.2 → 2.8.1

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,85 +1,85 @@
-/**
-* 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 = {
-	bibtex: {
-		id: 'bibtex',
-		title: 'BibTeX',
-		titleShort: 'BibTeX',
-		ext: ['.bib'],
-		canRead: true,
-		canWrite: true,
-	},
-	csv: {
-		id: 'csv',
-		title: 'Comma Seperated Values',
-		titleShort: 'CSV',
-		ext: ['.csv'],
-		canRead: false,
-		canWrite: false,
-	},
-	endnoteEnl: {
-		id: 'endnoteEnl',
-		title: 'EndNote ENL',
-		titleShort: 'EndNote',
-		ext: ['.enl'],
-		canRead: true,
-		canWrite: true,
-	},
-	endnoteEnlX: {
-		id: 'endnoteEnlX',
-		title: 'EndNote ENLX',
-		titleShort: 'EndNote ENLX',
-		ext: ['.enlx'],
-		canRead: true,
-		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','.cgi'],
-		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 = {
+	bibtex: {
+		id: 'bibtex',
+		title: 'BibTeX',
+		titleShort: 'BibTeX',
+		ext: ['.bib'],
+		canRead: true,
+		canWrite: true,
+	},
+	csv: {
+		id: 'csv',
+		title: 'Comma Seperated Values',
+		titleShort: 'CSV',
+		ext: ['.csv'],
+		canRead: false,
+		canWrite: false,
+	},
+	endnoteEnl: {
+		id: 'endnoteEnl',
+		title: 'EndNote ENL',
+		titleShort: 'EndNote',
+		ext: ['.enl'],
+		canRead: true,
+		canWrite: true,
+	},
+	endnoteEnlX: {
+		id: 'endnoteEnlX',
+		title: 'EndNote ENLX',
+		titleShort: 'EndNote ENLX',
+		ext: ['.enlx'],
+		canRead: true,
+		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','.cgi'],
+		canRead: true,
+		canWrite: true,
+	},
+	tsv: {
+		id: 'tsv',
+		title: 'Tab Seperated Values',
+		titleShort: 'TSV',
+		ext: ['.tsv'],
+		canRead: false,
+		canWrite: false,
+	},
+}

package/lib/getModule.js

@@ -1,39 +1,39 @@
-import * as modules from '../modules/default.js';
-
-let hasSetup = new Set(); // Modules we have already setup
-
-/**
-* Simple wrapper which loads the named module as a keyed lirary of functions
-*
-* @param {string} module The module ID as per `lib/formats.js`
-* @param {Object} [options] Additional options to use when fetching the module
-* @param {boolean} [options.setup=true] Call the `setup()` function on any module requested before use
-*
-* @returns {Object} The loaded module as an object of standardised functionality
-*/
-export function getModule(module, options) {
-	// Sanity checking
-	if (!module) throw new Error('No module provided');
-
-	// Argument mangling
-	let settings = {
-		setup: true,
-		...options,
-	};
-
-	// Try to find the module
-	let mod = modules[module];
-	if (!mod) throw new Error(`Unknown module "${module}"`);
-
-	// Should setup and module exposes a setup function?
-	if (
-		mod.setup // We should set up...
-		&& settings.setup // AND the module has a function to do so...
-		&& !hasSetup.has(module) // AND we've not setup before
-	) {
-		hasSetup.add(module);
-		mod.setup();
-	}
-
-	return mod;
-}
+import * as modules from '../modules/default.js';
+
+let hasSetup = new Set(); // Modules we have already setup
+
+/**
+* Simple wrapper which loads the named module as a keyed lirary of functions
+*
+* @param {string} module The module ID as per `lib/formats.js`
+* @param {Object} [options] Additional options to use when fetching the module
+* @param {boolean} [options.setup=true] Call the `setup()` function on any module requested before use
+*
+* @returns {Object} The loaded module as an object of standardised functionality
+*/
+export function getModule(module, options) {
+	// Sanity checking
+	if (!module) throw new Error('No module provided');
+
+	// Argument mangling
+	let settings = {
+		setup: true,
+		...options,
+	};
+
+	// Try to find the module
+	let mod = modules[module];
+	if (!mod) throw new Error(`Unknown module "${module}"`);
+
+	// Should setup and module exposes a setup function?
+	if (
+		mod.setup // We should set up...
+		&& settings.setup // AND the module has a function to do so...
+		&& !hasSetup.has(module) // AND we've not setup before
+	) {
+		hasSetup.add(module);
+		mod.setup();
+	}
+
+	return mod;
+}

package/lib/getRefDoi.js

@@ -1,16 +1,16 @@
-// @returns {Object} The modified ref object with the updated DOI
-/**
-* Identify DOI in the format(eg: 'https://dx.doi.org/10.1186/s40504-020-00106-2'), extract DOI number only(eg:'10.1186/s40504-020-00106-2')and return the ref object
-* @param {Object} ref The input object to identify and change DOI format
-*@returns {string|null} The modified DOI or null if no DOI is available
-*/
-export function getRefDoi(ref) {
-    if (ref.doi) {
-        const doiPrefix = 'https://dx.doi.org/';
-        if (ref.doi.startsWith(doiPrefix)) {
-            ref.doi = ref.doi.slice(doiPrefix.length);
-        }
-        return ref.doi;
-    }
-    return null;
-}
+// @returns {Object} The modified ref object with the updated DOI
+/**
+* Identify DOI in the format(eg: 'https://dx.doi.org/10.1186/s40504-020-00106-2'), extract DOI number only(eg:'10.1186/s40504-020-00106-2')and return the ref object
+* @param {Object} ref The input object to identify and change DOI format
+*@returns {string|null} The modified DOI or null if no DOI is available
+*/
+export function getRefDoi(ref) {
+    if (ref.doi) {
+        const doiPrefix = 'https://dx.doi.org/';
+        if (ref.doi.startsWith(doiPrefix)) {
+            ref.doi = ref.doi.slice(doiPrefix.length);
+        }
+        return ref.doi;
+    }
+    return null;
+}

package/lib/identifyFormat.js

@@ -1,13 +1,13 @@
-import {formats} from '../lib/formats.js';
-
-/**
-* Identify and return the Reflib format (from ./formats) to use for the given file name / path
-* @param {string} path The input path to identify
-* @returns {Object} A matching entry from ./formats or null if no matching format was found
-*/
-export function identifyFormat(path) {
-	let ext = /^.*(?<ext>\..+?)$/.exec(path)?.groups.ext.toLowerCase();
-	if (!ext) return null;
-
-	return Object.values(formats).find(format => format.ext.includes(ext));
-}
+import {formats} from '../lib/formats.js';
+
+/**
+* Identify and return the Reflib format (from ./formats) to use for the given file name / path
+* @param {string} path The input path to identify
+* @returns {Object} A matching entry from ./formats or null if no matching format was found
+*/
+export function identifyFormat(path) {
+	let ext = /^.*(?<ext>\..+?)$/.exec(path)?.groups.ext.toLowerCase();
+	if (!ext) return null;
+
+	return Object.values(formats).find(format => format.ext.includes(ext));
+}