@iebh/reflib 2.7.2 → 2.8.1

package/modules/shims/JSONStream-browser.js

@@ -1,44 +1,44 @@
-import Emitter from '../../shared/emitter.js';
-
-export default class BrowserJSONStream {
-	constructor() {
-		this.text = '';
-		this.emitter = Emitter();
-		this.recNumber = 1;
-	}
-
-	write(data) {
-		// CF: TODO: Parse data as it comes in chunks for better memory efficiency
-		this.text += data;
-	}
-
-	end() {
-		try {
-			// Parse this.text as JSON
-			const jsonArray = JSON.parse(this.text);
-
-			// Free memory
-			this.text = '';
-
-			// For each entry in the json array (as ref):
-			if (Array.isArray(jsonArray))
-				jsonArray.forEach(ref => {
-					this.emitter.emit('data', ref);
-				});
-
-			// Finished
-			this.emitter.emit('end');
-		} catch (e) {
-			console.error('Error parsing final JSON:', e);
-			this.emitter.emit('error', e);
-		}
-	}
-
-	on(event, listener) {
-		this.emitter.on(event, listener);
-	}
-
-	static parse() {
-		return new BrowserJSONStream();
-	}
+import Emitter from '../../shared/emitter.js';
+
+export default class BrowserJSONStream {
+	constructor() {
+		this.text = '';
+		this.emitter = Emitter();
+		this.recNumber = 1;
+	}
+
+	write(data) {
+		// CF: TODO: Parse data as it comes in chunks for better memory efficiency
+		this.text += data;
+	}
+
+	end() {
+		try {
+			// Parse this.text as JSON
+			const jsonArray = JSON.parse(this.text);
+
+			// Free memory
+			this.text = '';
+
+			// For each entry in the json array (as ref):
+			if (Array.isArray(jsonArray))
+				jsonArray.forEach(ref => {
+					this.emitter.emit('data', ref);
+				});
+
+			// Finished
+			this.emitter.emit('end');
+		} catch (e) {
+			console.error('Error parsing final JSON:', e);
+			this.emitter.emit('error', e);
+		}
+	}
+
+	on(event, listener) {
+		this.emitter.on(event, listener);
+	}
+
+	static parse() {
+		return new BrowserJSONStream();
+	}
 }

package/modules/shims/WritableStream-browser.js

@@ -1,52 +1,52 @@
-import Emitter from '../../shared/emitter.js';
-import CacxParser from '@iebh/cacx';
-
-export class WritableStream {
-	constructor(passedParserOptions) {
-		this.emitter = Emitter();
-		this.parser = new CacxParser({
-			collect: false,
-			reAttrSegment: /(?<key>[a-zA-Z_:][-a-zA-Z0-9_:.]*)(?:\s*=\s*(?<escape>["'])(?<val>.*?)\k<escape>)?/ig,
-			onTagOpen: (node) => {
-				const name = node.tag;
-				const attrs = node.attrs || {};
-				this.emitter.emit('opentag', name, attrs);
-			},
-			onTagClose: (node) => {
-				const name = node.tag;
-				// Emit text event before closing the tag
-				if (node.text && node.text.trim()) {
-					this.emitter.emit('text', node.text.trim());
-				}
-				this.emitter.emit('closetag', name);
-			},
-			flattenText: false,
-			keyText: 'text',
-			keyAttrs: 'attrs',
-		});
-
-		// Add event listeners to mimic htmlparser2 behavior
-		this.emitter.on('opentag', passedParserOptions.onopentag);
-		this.emitter.on('closetag', passedParserOptions.onclosetag);
-		this.emitter.on('text', passedParserOptions.ontext);
-		this.emitter.on('end', passedParserOptions.onend);
-	}
-
-	write(data) {
-		this.parser.append(data).exec();
-	}
-
-	end() {
-		// Process any remaining data
-		this.parser.exec();
-
-		// Emit text event for the last node if it has text
-		const lastNode = this.parser.stack.at(-1);
-		if (lastNode && lastNode.text && lastNode.text.trim()) {
-			this.emitter.emit('text', lastNode.text.trim());
-		}
-
-		// Emit end event
-		this.emitter.emit('end');
-	}
-}
+import Emitter from '../../shared/emitter.js';
+import CacxParser from '@iebh/cacx';
+
+export class WritableStream {
+	constructor(passedParserOptions) {
+		this.emitter = Emitter();
+		this.parser = new CacxParser({
+			collect: false,
+			reAttrSegment: /(?<key>[a-zA-Z_:][-a-zA-Z0-9_:.]*)(?:\s*=\s*(?<escape>["'])(?<val>.*?)\k<escape>)?/ig,
+			onTagOpen: (node) => {
+				const name = node.tag;
+				const attrs = node.attrs || {};
+				this.emitter.emit('opentag', name, attrs);
+			},
+			onTagClose: (node) => {
+				const name = node.tag;
+				// Emit text event before closing the tag
+				if (node.text && node.text.trim()) {
+					this.emitter.emit('text', node.text.trim());
+				}
+				this.emitter.emit('closetag', name);
+			},
+			flattenText: false,
+			keyText: 'text',
+			keyAttrs: 'attrs',
+		});
+
+		// Add event listeners
+		this.emitter.on('opentag', passedParserOptions.onopentag);
+		this.emitter.on('closetag', passedParserOptions.onclosetag);
+		this.emitter.on('text', passedParserOptions.ontext);
+		this.emitter.on('end', passedParserOptions.onend);
+	}
+
+	write(data) {
+		this.parser.append(data).exec();
+	}
+
+	end() {
+		// Process any remaining data
+		this.parser.exec();
+
+		// Emit text event for the last node if it has text
+		const lastNode = this.parser.stack.at(-1);
+		if (lastNode && lastNode.text && lastNode.text.trim()) {
+			this.emitter.emit('text', lastNode.text.trim());
+		}
+
+		// Emit end event
+		this.emitter.emit('end');
+	}
+}

package/package.json

@@ -1,66 +1,68 @@
-{
-  "name": "@iebh/reflib",
-  "version": "2.7.2",
-  "description": "Reference / Citation reference library utilities",
-  "scripts": {
-    "lint": "eslint",
-    "test": "testa",
-    "test:browser": "cd test/browser && npm run dev",
-    "test:watch": "nodemon --exec npm run test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/IEBH/Reflib.git"
-  },
-  "keywords": [
-    "reflib",
-    "references",
-    "citations",
-    "library"
-  ],
-  "author": "Matt Carter <m@ttcarter.com> (https://github.com/hash-bang)",
-  "contributors": [
-    "Connor Forbes <cforbes.software@gmail.com> (https://github.com/connorf25)",
-    "Irene Priya Jose (https://github.com/s5333384)",
-    "Tian Liang (https://github.com/Octian)"
-  ],
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/IEBH/Reflib/issues"
-  },
-  "homepage": "https://github.com/IEBH/Reflib",
-  "enginesStrict": true,
-  "engines": {
-    "node": ">=16.6.0"
-  },
-  "type": "module",
-  "exports": {
-    ".": {
-      "browser": "./lib/browser.js",
-      "default": "./lib/default.js"
-    },
-    "./*": "./lib/*.js"
-  },
-  "browser": {
-    "htmlparser2/lib/WritableStream": "./modules/shims/WritableStream-browser.js",
-    "htmlparser2/lib/esm/WritableStream": "./modules/shims/WritableStream-browser.js",
-    "JSONStream": "./modules/shims/JSONStream-browser.js"
-  },
-  "dependencies": {
-    "@iebh/cacx": "^1.0.3",
-    "@zip.js/zip.js": "^2.7.57",
-    "htmlparser2": "^9.1.0",
-    "JSONStream": "^1.3.5",
-    "lodash-es": "^4.17.22",
-    "mitt": "^3.0.1",
-    "sql.js": "^1.12.0"
-  },
-  "devDependencies": {
-    "@momsfriendlydevco/eslint-config": "^2.3.1",
-    "@momsfriendlydevco/testa": "^1.1.2",
-    "eslint": "^9.31.0",
-    "nodemon": "^3.1.9",
-    "temp": "^0.9.4",
-    "vite-plugin-replace": "^0.1.1"
-  }
-}
+{
+  "name": "@iebh/reflib",
+  "version": "2.8.1",
+  "description": "Reference / Citation reference library utilities",
+  "bin": {
+    "reflib": "./app.js"
+  },
+  "scripts": {
+    "lint": "eslint",
+    "test": "testa",
+    "test:browser": "cd test/browser && npm run dev",
+    "test:watch": "nodemon --exec npm run test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/IEBH/Reflib.git"
+  },
+  "keywords": [
+    "reflib",
+    "references",
+    "citations",
+    "library"
+  ],
+  "author": "Matt Carter <m@ttcarter.com> (https://github.com/hash-bang)",
+  "contributors": [
+    "Connor Forbes <cforbes.software@gmail.com> (https://github.com/connorf25)",
+    "Irene Priya Jose (https://github.com/s5333384)",
+    "Tian Liang (https://github.com/Octian)"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/IEBH/Reflib/issues"
+  },
+  "homepage": "https://github.com/IEBH/Reflib",
+  "enginesStrict": true,
+  "engines": {
+    "node": ">=16.6.0"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "browser": "./lib/browser.js",
+      "default": "./lib/default.js"
+    },
+    "./*": "./lib/*.js"
+  },
+  "browser": {
+    "JSONStream": "./modules/shims/JSONStream-browser.js"
+  },
+  "dependencies": {
+    "@iebh/cacx": "^1.1.0",
+    "@momsfriendlydevco/sort-keys": "^1.0.0",
+    "@zip.js/zip.js": "^2.7.57",
+    "JSONStream": "^1.3.5",
+    "mitt": "^3.0.1",
+    "sql.js": "^1.12.0"
+  },
+  "devDependencies": {
+    "@momsfriendlydevco/eslint-config": "^2.3.1",
+    "@momsfriendlydevco/testa": "^1.2.0",
+    "eslint": "^9.31.0",
+    "execa": "^9.6.1",
+    "lodash-es": "^4.17.23",
+    "nodemon": "^3.1.9",
+    "temp": "^0.9.4",
+    "vite-plugin-replace": "^0.1.1"
+  }
+}

package/shared/camelCase.js

@@ -1,17 +1,17 @@
-/**
-* Camel case any input string
-* This is functionally the same as Lodash's camelCase() function
-*
-* @param {string} input The input string to camelize
-* @returns {string} The input string in camelCase format
-* @url https://github.com/MomsFriendlyDevCo/Nodash
-*/
-export default function(input) {
-	return input
-		.split(/[\s-]/)
-		.map((word, offset) => offset == 0
-			? word.toLowerCase()
-			: word.substr(0, 1).toUpperCase() + word.substr(1).toLowerCase()
-		)
-		.join('')
-}
+/**
+* Camel case any input string
+* This is functionally the same as Lodash's camelCase() function
+*
+* @param {string} input The input string to camelize
+* @returns {string} The input string in camelCase format
+* @url https://github.com/MomsFriendlyDevCo/Nodash
+*/
+export default function(input) {
+	return input
+		.split(/[\s-]/)
+		.map((word, offset) => offset == 0
+			? word.toLowerCase()
+			: word.substr(0, 1).toUpperCase() + word.substr(1).toLowerCase()
+		)
+		.join('')
+}

package/shared/emitter.js

@@ -1,23 +1,23 @@
-import Mitt from 'mitt';
-
-/**
-* Generic wrapper for an event emitter
-* This module returns a wrapped version of `mitt` stand-alone event emitter (+ support for method chaining)
-*
-* @returns {Object} A wrapped version of the NPM Mitt event emitter with chainable functionality
-*/
-export default function emitter() {
-	let emitter = Mitt();
-
-	// Add method chaining
-	emitter.mitt = {};
-	['on', 'off', 'emit'].forEach(f => {
-		emitter.mitt[f] = emitter[f]; // Backup old function into `.mitt.${F}`
-		emitter[f] = (...args) => {
-			emitter.mitt[f](...args);
-			return emitter;
-		};
-	});
-
-	return emitter;
-}
+import Mitt from 'mitt';
+
+/**
+* Generic wrapper for an event emitter
+* This module returns a wrapped version of `mitt` stand-alone event emitter (+ support for method chaining)
+*
+* @returns {Object} A wrapped version of the NPM Mitt event emitter with chainable functionality
+*/
+export default function emitter() {
+	let emitter = Mitt();
+
+	// Add method chaining
+	emitter.mitt = {};
+	['on', 'off', 'emit'].forEach(f => {
+		emitter.mitt[f] = emitter[f]; // Backup old function into `.mitt.${F}`
+		emitter[f] = (...args) => {
+			emitter.mitt[f](...args);
+			return emitter;
+		};
+	});
+
+	return emitter;
+}

package/shared/parseArgs.js

@@ -0,0 +1,104 @@
+/**
+* Attempt to parse an process.argv like array into extracted flags and their values
+*
+* Supported:
+*     `--flag` → `true`
+*     `--flag val` → `'val'`
+*     `--flag a b c` → `['a', 'b', 'c']` (variadic, stops at next flag)
+*     `-f` → `true`
+*     `-abc` → `{ a: true, b: true, c: true }`
+*     `-n 1 2 3` → `{ n: ['1', '2', '3'] }` (last short flag is variadic)
+*     `--` → remaining args go to `_`
+*     Bare positional args → `_` array
+*
+* @param {Array<String>} [argv=process.argv] `argv` like array to parse, If omitted `process.argv.slice(2)` is used
+* @returns {Object} An object with extracted flags
+*
+* @example Basic argv example
+* parseArgs([
+*   '--name', 'Alice', 'Bob', '--verbose', '-n', '42', '-xvf', 'file1', 'file2',
+* ]) //= {
+*   _: [],
+*   name: ['Alice', 'Bob'],
+*   verbose: true,
+*   	n: '42',
+*   	x: true,
+*   	v: true,
+*   	f: ['file1', 'file2']
+*   }
+*/
+export function parse(argv = process.argv.slice(2)) {
+	let result = { _: [] }
+	let i = 0
+
+	let collectValues = (args, start) => {
+		let values = []
+		let j = start
+		while (j < args.length && !args[j].startsWith('-')) {
+			values.push(args[j++])
+		}
+		return { values, next: j }
+	}
+
+	while (i < argv.length) {
+		let arg = argv[i]
+
+		if (arg.startsWith('--')) {
+			let key = arg.slice(2)
+			if (!key) { i++; break } // -- separator
+			let { values, next } = collectValues(argv, i + 1)
+			result[key] = values.length === 0 ? true
+				: values.length === 1 ? values[0]
+				: values
+			i = next
+		} else if (arg.startsWith('-')) {
+			let flags = arg.slice(1)
+			// Check if last char is the one collecting values
+			for (let f = 0; f < flags.length - 1; f++) {
+				result[flags[f]] = true
+			}
+			let lastFlag = flags.at(-1);
+			let { values, next } = collectValues(argv, i + 1);
+			result[lastFlag] = values.length === 0 ? true
+				: values.length === 1 ? values[0]
+				: values
+			i = next;
+		} else {
+			result._.push(arg)
+			i++
+		}
+	}
+
+	// Remaining after -- go to _
+	while (i < argv.length) result._.push(argv[i++])
+
+	return result
+}
+
+
+/**
+* Accept a parsed args object and expand short-flags into long-flags
+*
+* @param {Object} args Parsed arg object to process
+* @param {Object} argMap Object of `shortFlag:String => longFlag:String` translations to apply
+*
+* @returns {Object} The input `args` object with all short-flags translated to long-flags
+*/
+export function expand(args, argMap) {
+	let outArgs = {...args}; // Shallow copy of incoming args object we are going to mutate
+
+	Object.entries(argMap)
+		.filter(([shortFlag]) => args[shortFlag])
+		.map(([shortFlag, longFlag]) => {
+			outArgs[longFlag] = outArgs[shortFlag];
+			delete outArgs[shortFlag];
+		});
+
+	return outArgs;
+}
+
+
+export default {
+	expand,
+	parse,
+}

package/shared/streamEmitter.js

@@ -1,61 +1,61 @@
-import Emitter from '../shared/emitter.js';
-
-/**
-* Wrapper for streams which transforms a given input into an emitter pattern
-* This is designed to let regular `node:stream.Readable` objects pass through without alteration but browser based stream objects get wrapped
-* @param {stream.Readable|ReadableStream} inStream The input stream to wrap
-* @returns {stream.Readable|Emitter} Either the unedited node compatible stream or an event emitter with the same behaviour
-*
-* @emits data Emitted as `(chunk)` on each data chunk
-* @emits end Emitted as `()` when the input stream has closed
-* @emits error Emitted as `(Error)` on any read error
-*/
-export default function streamEmitter (inStream) {
-	if (inStream.getReader) { // Assume browser compatible ReadableStream
-		/**
-		* MC's tiny ReadableStream -> stream.Readable / Emitter pattern
-		* There is a non-zero chance that this is going to break at some future point
-		* This is really just a shiv for browser functionality to replicate Stream-a-like emitter pattern
-		* @date 2023-10-19
-		* @author Matt Carter <m@ttcarter.com>
-		*/
-		let reader = new Emitter();
-		Object.assign(reader, {
-			isBrowser: true, // Tells us we are in browser env
-			bytesRead: 0,
-			reader: inStream.getReader(),
-			textDecoder: new TextDecoder('utf-8'),
-			read() { // Read one chunk + trigger emitters
-				this.reader.read()
-					.then(({done, value}) => {
-						if (done) {
-							reader.emit('end');
-
-							if (this.pipeTarget)
-								this.pipeTarget.end();
-						} else if (value) {
-							let data = this.textDecoder.decode(value);
-							this.bytesRead += data.length;
-							reader.emit('data', data);
-
-							if (this.pipeTarget)
-								this.pipeTarget.write(data);
-
-							setTimeout(this.read.bind(this));
-						}
-					})
-					.catch(e => this.emit('error', e))
-			},
-			pipeTarget: null,
-			pipe(target) {
-				this.pipeTarget = target;
-				return this;
-			},
-		});
-
-		setTimeout(()=> reader.read());
-		return reader;
-	} else { // Assume Node native stream.Readable
-		return inStream;
-	}
-}
+import Emitter from '../shared/emitter.js';
+
+/**
+* Wrapper for streams which transforms a given input into an emitter pattern
+* This is designed to let regular `node:stream.Readable` objects pass through without alteration but browser based stream objects get wrapped
+* @param {stream.Readable|ReadableStream} inStream The input stream to wrap
+* @returns {stream.Readable|Emitter} Either the unedited node compatible stream or an event emitter with the same behaviour
+*
+* @emits data Emitted as `(chunk)` on each data chunk
+* @emits end Emitted as `()` when the input stream has closed
+* @emits error Emitted as `(Error)` on any read error
+*/
+export default function streamEmitter (inStream) {
+	if (inStream.getReader) { // Assume browser compatible ReadableStream
+		/**
+		* MC's tiny ReadableStream -> stream.Readable / Emitter pattern
+		* There is a non-zero chance that this is going to break at some future point
+		* This is really just a shiv for browser functionality to replicate Stream-a-like emitter pattern
+		* @date 2023-10-19
+		* @author Matt Carter <m@ttcarter.com>
+		*/
+		let reader = new Emitter();
+		Object.assign(reader, {
+			isBrowser: true, // Tells us we are in browser env
+			bytesRead: 0,
+			reader: inStream.getReader(),
+			textDecoder: new TextDecoder('utf-8'),
+			read() { // Read one chunk + trigger emitters
+				this.reader.read()
+					.then(({done, value}) => {
+						if (done) {
+							reader.emit('end');
+
+							if (this.pipeTarget)
+								this.pipeTarget.end();
+						} else if (value) {
+							let data = this.textDecoder.decode(value);
+							this.bytesRead += data.length;
+							reader.emit('data', data);
+
+							if (this.pipeTarget)
+								this.pipeTarget.write(data);
+
+							setTimeout(this.read.bind(this));
+						}
+					})
+					.catch(e => this.emit('error', e))
+			},
+			pipeTarget: null,
+			pipe(target) {
+				this.pipeTarget = target;
+				return this;
+			},
+		});
+
+		setTimeout(()=> reader.read());
+		return reader;
+	} else { // Assume Node native stream.Readable
+		return inStream;
+	}
+}