@iebh/reflib 2.1.0 → 2.1.2

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Institute for Evidence-Based Healthcare
+Copyright (c) 2022 Bond University Institute for Evidence-Based Healthcare
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/LICENSES.md

@@ -0,0 +1,97 @@
+# @iebh/reflib (MIT)
+
+## [JSONStream](https://github.com/dominictarr/JSONStream)
+```
+Apache License, Version 2.0
+
+Copyright (c) 2011 Dominic Tarr
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+```
+
+## [htmlparser2](https://github.com/fb55/htmlparser2)
+```
+Copyright 2010, 2011, Chris Winberry <chris@winberry.net>. All rights reserved.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+ 
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+```
+
+## [mitt](https://github.com/developit/mitt)
+```
+MIT License
+
+Copyright (c) 2021 Jason Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+```
+
+## [vite-plugin-replace](https://github.com/leanupjs/leanup)
+```
+MIT License
+
+Copyright (c) 2021 leanupjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+```
+
+

package/README.md

@@ -4,8 +4,7 @@ Reference library processing for Node.
 
 This library provides various read/write functionality to process citation libraries and handle individual references (henceforth "Refs").
 
-**NOTE: THIS LIBRARY IS STILL UNDER CONSTRUCTION**
-**Please use [Version 1](https://github.com/hash-bang/Reflib-Node) ([NPM](https://www.npmjs.com/package/reflib)) until this message is removed**
+This module forms part of the [Systematic Review Accelerator](https://sr-accelerator.com)
 
 
 Compatibility

package/modules/endnoteXml.js

@@ -3,6 +3,7 @@ import Emitter from '../shared/emitter.js';
 
 // TODO: CF: Don't need to import both, it depends if we are on browser or node
 import * as htmlparser2 from "htmlparser2";
+// FIXME: CF: Browsers freak out without pollyfills if this is imported
 import {WritableStream as XMLParser} from 'htmlparser2/lib/WritableStream';
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iebh/reflib",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "Reference / Citation reference library utilities",
   "scripts": {
     "lint": "eslint lib modules shared test",
@@ -17,7 +17,10 @@
     "citations",
     "library"
   ],
-  "author": "Matt Carter <m@ttcarter.com>",
+  "author": [
+    "Matt Carter <m@ttcarter.com> (https://github.com/hash-bang)",
+    "Connor Forbes <cforbes.software@gmail.com> (https://github.com/connorf25)"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/IEBH/RefLib/issues"
@@ -40,13 +43,13 @@
     "eslint": "^8.15.0",
     "mocha": "^10.0.0",
     "mocha-logger": "^1.0.8",
-    "temp": "^0.9.4"
+    "temp": "^0.9.4",
+    "vite-plugin-replace": "^0.1.1"
   },
   "dependencies": {
     "htmlparser2": "^8.0.1",
     "JSONStream": "^1.3.5",
-    "mitt": "^3.0.0",
-    "vite-plugin-replace": "^0.1.1"
+    "mitt": "^3.0.0"
   },
   "eslintConfig": {
     "extends": "eslint:recommended",

package/shared/streamEmitter.js

@@ -11,8 +11,50 @@ import Emitter from '../shared/emitter.js';
 * @emits error Emitted as `(Error)` on any read error
 */
 export default function streamEmitter(inStream) {
-	// FIXME: Need to examine inStream and multiplex
-	//        inStream.pipeTo - a browser stream - passthru
-	//        !inStream.pipeTo - probably Node stream - need to glue pipeTo as a promiseable
-	return 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, {
+			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;
+	}
 }