@iebh/reflib 2.3.1 → 2.3.3

package/.vscode/launch.json

@@ -0,0 +1,37 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "Run npm test:browser",
+			"runtimeExecutable": "/home/connor/.nvm/versions/node/v20.12.2/bin/npm",
+			"runtimeArgs": [
+				"run",
+				"test:browser"
+			],
+			"console": "integratedTerminal"
+		},
+		{
+			"name": "Launch Chrome against localhost",
+			"type": "chrome",
+			"request": "launch",
+			"url": "http://localhost:3000",
+			"webRoot": "${workspaceFolder}/test/browser"
+		},
+		{
+			"name": "Attach to Vite Server",
+			"type": "node",
+			"request": "attach",
+			"port": 9229,
+			"address": "localhost",
+			"restart": true,
+			"skipFiles": [
+				"<node_internals>/**"
+			]
+		}
+	]
+}

package/modules/endnoteXml.js

@@ -1,19 +1,8 @@
 import camelCase from '../shared/camelCase.js';
 import Emitter from '../shared/emitter.js';
 
-// Only import WritableStream on node
-// This is needed even with the "browser" field of package.json
-let XMLParser;
-if (typeof window === 'undefined') {
-	// We are in node env
-	import('htmlparser2/lib/WritableStream').then(module => {
-		XMLParser = module.WritableStream;
-	});
-} else {
-	// Handle or ignore in browser environment
-	console.log("WritableStream not loaded in browser.");
-}
-
+// This import is overwritten by the 'browser' field in package.json with the shimmed version
+import { WritableStream as XMLParser } from 'htmlparser2/lib/WritableStream';
 
 /**
 * @see modules/inhterface.js
@@ -42,59 +31,6 @@ export function readStream(stream) {
 	*/
 	let textAppend = false;
 
-	class XMLParserBrowser {
-		constructor(passedParserOptions) {
-			// Stores XML in text form once read
-			this.text = "";
-			this.emitter = emitter;
-			// Add event listeners to mimic htmlparser2 behavior in the browser
-			this.emitter.on('opentag', passedParserOptions.onopentag);
-			this.emitter.on('closetag', passedParserOptions.onclosetag);
-			this.emitter.on('text', passedParserOptions.ontext);
-		}
-
-		write(data) {
-			// CF: TODO: Parse data as it comes in chunks for better memory efficiency
-			this.text += data;
-		}
-
-		end() {
-			this.parseXML(this.text);
-			// Free memory
-			this.text = ''
-			this.emitter.emit('end');
-		}
-
-		parseXML(xmlString) {
-			let parser = new DOMParser();
-			let doc = parser.parseFromString(xmlString, 'application/xml');
-			this.traverseNode(doc.documentElement);
-		}
-
-		traverseNode(node) {
-			if (node.nodeType === Node.ELEMENT_NODE) {
-				let name = camelCase(node.nodeName);
-				let attrs = Array.from(node.attributes).reduce((acc, attr) => {
-					acc[attr.name] = attr.value;
-					return acc;
-				}, {});
-
-				this.emitter.emit('opentag', name, attrs);
-
-				for (let child of node.childNodes) {
-					this.traverseNode(child);
-				}
-
-				this.emitter.emit('closetag', name);
-			} else if (node.nodeType === Node.TEXT_NODE) {
-				let text = node.nodeValue.trim();
-				if (text) {
-					this.emitter.emit('text', text);
-				}
-			}
-		}
-	}
-
 	/**
 	 * The options/callbacks for the parser
 	 * @type {Object}
@@ -168,18 +104,7 @@ export function readStream(stream) {
 	// Queue up the parser in the next tick (so we can return the emitter first)
 	setTimeout(() => {
 
-		if (stream.isBrowser === true) {
-			// We are on the node.js client
-			console.log('Loading EndNote library as node.js')
-			let parser = new XMLParserBrowser(parserOptions);
-			stream.on('data', ()=> emitter.emit('progress', stream.bytesRead))
-			stream.pipe(parser)
-			return;
-		}
-
-		else if (typeof stream.pipe === 'function') {
-			// We are on the node.js client
-			console.log('Loading EndNote library as node.js')
+		if (typeof stream.pipe === 'function') {
 			let parser = new XMLParser(parserOptions);
 			stream.on('data', ()=> emitter.emit('progress', stream.bytesRead))
 			stream.pipe(parser)
@@ -187,7 +112,7 @@ export function readStream(stream) {
 		}
 
 		else {
-			console.error('Error determining if on browser or node')
+			console.error('Error with stream, check "streamEmitter.js" if on browser')
 		}
 
 	})

package/modules/json.js

@@ -1,45 +1,7 @@
 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';
 
-class BrowserJSONStream {
-	constructor() {
-			this.text = '';
-			this.emitter = Emitter();
-	}
-
-	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):
-			jsonArray.forEach(ref => {
-				this.emitter.emit('ref', {
-					recNumber: this.recNumber++,
-					...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);
-	}
-}
-
 /**
 * @see modules/interface.js
 */
@@ -51,34 +13,21 @@ export function readStream(stream) {
 	setTimeout(()=> {
 		stream.on('data', ()=> emitter.emit('progress', stream.bytesRead));
 
-		if (stream.isBrowser === true) {
-			// On browser
-			console.log('Parsing JSON natively in browser');
-			const browserJSONStream = new BrowserJSONStream();
-			browserJSONStream.on('ref', (data) => {
-					emitter.emit('ref', data);
-			});
-			browserJSONStream.on('end', () => emitter.emit('end'));
-			browserJSONStream.on('error', (error) => emitter.emit('error', error));
-			stream.pipe(browserJSONStream);
-	}
-
-		else if (typeof stream.pipe === 'function') {
+		if (typeof stream.pipe === 'function') {
 			// On node.js
 			console.log('Parsing JSON with node.js library')
 			const nodeJSONStream = JSONStream.parse('*')
-			nodeJSONStream
-			.on('data', ref => emitter.emit('ref', {
-				recNumber: recNumber++,
-				...ref,
-			}))
-			.on('end', ()=> emitter.emit('end'))
-			.on('error', emitter.emit.bind('error'));
+			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 determining if on browser or node')
+			console.error('Error with stream, check "streamEmitter.js" if on browser')
 		}
 	});
 

package/modules/shims/JSONStream-browser.js

@@ -0,0 +1,42 @@
+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):
+			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

@@ -0,0 +1,57 @@
+import camelCase from '../../shared/camelCase.js';
+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,
+			onTagOpen: (node) => {
+				const name = camelCase(node.tag);
+				const attrs = node.attrs || {};
+				this.emitter.emit('opentag', name, attrs);
+			},
+			onTagClose: (node) => {
+				const name = camelCase(node.tag);
+				this.emitter.emit('closetag', name);
+			},
+			onAttr: (key, val/*, options*/) => {
+				// This method is called for each attribute, so we don't need to do anything here
+				return { [key]: val };
+			},
+			flattenText: true,
+			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();
+
+		// Emit text events for any text nodes
+		const currentNode = this.parser.stack.at(-1);
+		if (currentNode && currentNode.text) {
+			const text = currentNode.text.trim();
+			if (text) {
+				this.emitter.emit('text', text);
+			}
+			// Clear the text to avoid emitting it multiple times
+			currentNode.text = '';
+		}
+	}
+
+	end() {
+		// Process any remaining data
+		this.parser.exec();
+
+		// Emit end event
+		this.emitter.emit('end');
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/reflib",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "Reference / Citation reference library utilities",
   "scripts": {
     "lint": "eslint lib modules shared test",
@@ -39,9 +39,9 @@
     "./*": "./lib/*.js"
   },
   "browser": {
-    "htmlparser2/lib/WritableStream": false,
-    "htmlparser2/lib/esm/WritableStream": false,
-    "JSONStream": false
+    "htmlparser2/lib/WritableStream": "./modules/shims/WritableStream-browser.js",
+    "htmlparser2/lib/esm/WritableStream": "./modules/shims/WritableStream-browser.js",
+    "JSONStream": "./modules/shims/JSONStream-browser.js"
   },
   "devDependencies": {
     "@momsfriendlydevco/eslint-config": "^1.0.9",
@@ -53,6 +53,7 @@
     "vite-plugin-replace": "^0.1.1"
   },
   "dependencies": {
+    "@iebh/cacx": "^1.0.0",
     "htmlparser2": "^9.0.0",
     "JSONStream": "^1.3.5",
     "mitt": "^3.0.1"