split-frames 2.4.5 → 2.5.1

package/package.json

@@ -1,96 +1,95 @@
-{
-
-  "name": "split-frames",
-  "version": "2.4.5",
-  "description": "Split Buffer frames from streams",
-
-  "type": "commonjs",
-  "main": "lib/main.js",
-  "typings": "lib/index.d.ts",
-
-  "exports": {
-    ".": {
-      "require": {
-        "types": "./lib/index.d.ts",
-        "default": "./lib/main.js"
-      }
-    }
-  },
-
-  "scripts": {
-
-    "build": "npx tsc --project \"./tsconfig.json\"",
-
-    "lint": "npx eslint ./lib/**/*.js ./test/**/*.js",
-    "check-requires": "npx used-deps-analyzer \"./package.json\" \"./lib\" --no-dev --overkill \"fs-extra\" \"node-promfs\"",
-    "check-updates": "npx check-version-modules",
-    "unit-tests": "npx nyc --reporter=html --reporter=text mocha",
-
-    "tests": "npm run-script lint && npm run check-requires && npm run-script check-updates && npm run-script unit-tests",
-    "ci": "npm run-script tests && npx nyc report --reporter=text-lcov | coveralls"
-
-  },
-
-  "files": [
-    "/lib"
-  ],
-  "engines": {
-    "node": ">=16.0.0"
-  },
-
-  "dependencies": {},
-  "devDependencies": {
-    "@types/node": "20.5.0",
-    "check-version-modules": "1.4.1",
-    "coveralls": "3.1.1",
-    "eslint": "8.47.0",
-    "husky": "8.0.3",
-    "mocha": "10.2.0",
-    "nyc": "15.1.0",
-    "used-deps-analyzer": "0.1.6"
-  },
-  "optionalDependencies": {},
-
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run-script lint",
-      "pre-push": "npm run-script tests"
-    }
-  },
-  "keywords": [
-    "frame",
-    "Buffer",
-    "buffer",
-    "split",
-    "formate",
-    "parse",
-    "escape",
-    "bit",
-    "stream",
-    "Transform",
-    "transform",
-    "STX",
-    "ETX",
-    "ACK",
-    "WAK",
-    "NAK",
-    "DLE",
-    "industrial",
-    "protocol",
-    "LRC",
-    "MSB",
-    "LSB"
-  ],
-  "author": "Sébastien VIDAL",
-  "license": "ISC",
-
-  "homepage": "https://github.com/Psychopoulet/split-frames#readme",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/Psychopoulet/split-frames"
-  },
-  "bugs": {
-    "url": "https://github.com/Psychopoulet/split-frames/issues"
-  }
-
-}
+{
+  "name": "split-frames",
+  "version": "2.5.1",
+  "description": "Split Buffer frames from streams",
+  "type": "commonjs",
+  "typings": "./lib/cjs/main.d.cts",
+  "main": "./lib/cjs/main.cjs",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./lib/cjs/main.d.cts",
+        "default": "./lib/cjs/main.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "prepare": "husky",
+    "clean": "npx rimraf lib/cjs",
+    "build": "npm run-script clean && npx tsc --project \"./tsconfig.json\"",
+    "lint": "npx eslint --config .eslintrc-src.js --ext .cts,.ts ./lib/src/**/* && npx eslint --config .eslintrc-tests.js ./bin/*.js ./test/**/*.js",
+    "check-requires": "npx used-deps-analyzer \"./package.json\" \"./lib/src\" --no-dev --overkill \"fs-extra\" \"node-promfs\"",
+    "check-updates": "npx check-version-modules",
+    "unit-tests": "npm run-script build && npx nyc --reporter=html --reporter=text mocha",
+    "tests": "npm run-script lint && npm run-script check-requires && npm run-script check-updates && npm run-script unit-tests"
+  },
+  "files": [
+    "/bin",
+    "/lib/cjs",
+    "/public"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "22.7.8",
+    "check-version-modules": "2.1.2",
+    "colors": "1.4.0",
+    "eslint-plugin-personnallinter": "git+ssh://git@github.com/Psychopoulet/eslint-plugin-personnallinter",
+    "husky": "9.1.6",
+    "mocha": "10.7.3",
+    "nyc": "17.1.0",
+    "rimraf": "6.0.1",
+    "typescript": "5.6.3",
+    "used-deps-analyzer": "0.1.8"
+  },
+  "optionalDependencies": {},
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run-script lint",
+      "pre-push": "npm run-script unit-tests",
+      "pre-receive": "npm run-script tests"
+    }
+  },
+  "keywords": [
+    "frame",
+    "Buffer",
+    "buffer",
+    "split",
+    "formate",
+    "parse",
+    "escape",
+    "bit",
+    "stream",
+    "Transform",
+    "transform",
+    "STX",
+    "ETX",
+    "ACK",
+    "WAK",
+    "NAK",
+    "DLE",
+    "industrial",
+    "protocol",
+    "LRC",
+    "MSB",
+    "LSB"
+  ],
+  "author": "Sébastien VIDAL",
+  "contributors": [
+    {
+      "name": "07ke",
+      "url": "https://github.com/07ke"
+    }
+  ],
+  "license": "ISC",
+  "homepage": "https://github.com/Psychopoulet/split-frames#readme",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Psychopoulet/split-frames"
+  },
+  "bugs": {
+    "url": "https://github.com/Psychopoulet/split-frames/issues"
+  }
+}

package/lib/checkers/checkTagsValidity.js

@@ -1,26 +0,0 @@
-"use strict";
-
-module.exports = (tags) => {
-
-	let result = true;
-
-		if (
-			"number" !== typeof tags && "object" !== typeof tags && !(tags instanceof Array || tags instanceof Buffer)
-		) {
-			result = false;
-		}
-		else if ("object" === typeof tags && tags instanceof Array) {
-
-			for (let i = 0; i < tags.length; ++i) {
-
-				if ("number" !== typeof tags[i] && "object" !== typeof tags[i] && !(tags[i] instanceof Buffer)) {
-					result = false; break;
-				}
-
-			}
-
-		}
-
-	return result;
-
-};

package/lib/checkers/initData.js

@@ -1,123 +0,0 @@
-/*
-	eslint complexity: [ "error", { "max": 30 } ]
-*/
-
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("node:path");
-
-	// locals
-	const checkTagsValidity = require(join(__dirname, "checkTagsValidity.js"));
-
-// consts
-
-	const ALLOWED_CONTROL_BITS_OPTIONS = [ "none", "end+1", "end+2" ];
-
-// module
-
-module.exports = (options) => {
-
-	const result = {
-		"startWith": null,
-		"startTimeout": null,
-		"endWith": null,
-		"escapeWith": null,
-		"escaped": [],
-		"specifics": {},
-		"controlBits": ""
-	};
-
-		if ("undefined" !== typeof options) {
-
-			if ("object" !== typeof options) {
-				throw new TypeError("parameter sended is not an object");
-			}
-
-			else if ("undefined" !== typeof options.startWith && !checkTagsValidity(options.startWith)) {
-				throw new TypeError("startWith parameter sended is not a number, Buffer, or an Array of numbers");
-			}
-			else if ("undefined" !== typeof options.startTimeout && "number" !== typeof options.startTimeout) {
-				throw new TypeError("startTimeout parameter sended is not a number");
-			}
-			else if ("undefined" !== typeof options.endWith && !checkTagsValidity(options.endWith)) {
-				throw new TypeError("endWith parameter sended is not a number, Buffer, or an Array of numbers");
-			}
-
-			else if ("undefined" !== typeof options.escapeWith && "number" !== typeof options.escapeWith) {
-				throw new TypeError("escapeWith parameter sended is not a number");
-			}
-
-			else if ("undefined" !== typeof options.specifics && "object" !== typeof options.specifics) {
-				throw new TypeError("escapeWith parameter sended is not an object");
-			}
-
-			else if ("undefined" !== typeof options.controlBits && "string" !== typeof options.controlBits) {
-				throw new TypeError("controlBits parameter sended is not a string");
-			}
-
-				else if ("undefined" !== typeof options.controlBits && !ALLOWED_CONTROL_BITS_OPTIONS.includes(options.controlBits)) {
-					throw new Error("controlBits option sended is not in [ \"" + ALLOWED_CONTROL_BITS_OPTIONS.join("\", \"") + "\" ]");
-				}
-
-			else {
-
-				result.startWith = "undefined" !== typeof options.startWith ? options.startWith : null;
-				result.startTimeout = "undefined" !== typeof options.startTimeout ? options.startTimeout : 200;
-				result.endWith = "undefined" !== typeof options.endWith ? options.endWith : null;
-
-				result.escapeWith = "undefined" !== typeof options.escapeWith ? options.escapeWith : null;
-				result.escaped = "undefined" !== typeof options.escaped ? options.escaped : [];
-
-				for (let i = 0; i < result.escaped.length; ++i) {
-
-					if ("number" !== typeof result.escaped[i]) {
-						throw new TypeError("escaped parameter n°" + i + " sended is not a number");
-					}
-
-				}
-
-				if ("object" === typeof options.specifics) {
-
-					Object.keys(options.specifics).forEach((key) => {
-
-						if ("undefined" !== typeof options.specifics[key]) {
-
-							if (!checkTagsValidity(options.specifics[key])) {
-
-								throw new Error(
-									"\"" + options.specifics[key] + "\" specifics option" +
-									" sended is not a number, or an Array of numbers"
-								);
-
-							}
-							else if (
-								null !== options.specifics[key] &&
-								null !== result.startWith && null === result.endWith
-							) {
-
-								throw new Error(
-									"If you want to use \"" + options.specifics[key] + "\" specific option," +
-									" you have to use \"endWith\" option"
-								);
-
-							}
-
-						}
-
-					});
-
-				}
-
-				result.specifics = "undefined" !== typeof options.specifics ? options.specifics : {};
-				result.controlBits = "undefined" !== typeof options.controlBits ? options.controlBits : "none";
-
-			}
-
-		}
-
-	return result;
-
-};

package/lib/digesters/digestEndOnly.js

@@ -1,73 +0,0 @@
-/*
-	eslint no-invalid-this: 0, no-implicit-globals: 0
-*/
-
-"use strict";
-
-// private
-
-	// method
-
-		/**
-		* Extract specific tags
-		* @param {SplitFrames} self : pointer
-		* @returns {void}
-		*/
-		function _extractSpecifics (self) {
-
-			let found = false;
-
-				Object.keys(self._specifics).forEach((key) => {
-
-					if (0 === self._frame.indexOf(self._specifics[key])) {
-
-						found = true;
-
-						const size = "object" === typeof self._specifics[key] && self._specifics[key] instanceof Buffer ?
-							self._specifics[key].length : 1;
-
-						self.emit(key);
-
-						self._frame = Buffer.from(self._frame.slice(size, self._frame.length));
-
-					}
-
-				});
-
-			if (found) {
-				_extractSpecifics(self);
-			}
-
-		}
-
-module.exports = function digestEndOnly () {
-
-	_extractSpecifics(this);
-
-	const firstEnd = this._searchFirstEnd();
-
-	// no end tag detected
-	if (!firstEnd) {
-		this._digesting = false;
-	}
-
-	// first end tag detected
-	else {
-
-		// extract first frame
-		this.push(Buffer.from(this._frame.slice(0, firstEnd.end)));
-
-		// remove extracted frame from main one
-		this._frame = Buffer.from(this._frame.slice(firstEnd.end, this._frame.length));
-
-		// second full frame detected
-		if (-1 < this._searchTags(this._endWith)) {
-			this._digest();
-		}
-		else {
-			this._digesting = false;
-		}
-
-	}
-
-};

package/lib/digesters/digestNoStartNoEnd.js

@@ -1,38 +0,0 @@
-/*
-	eslint no-invalid-this: 0
-*/
-
-"use strict";
-
-module.exports = function digestNoStartNoEnd () {
-
-	const KEYS = Object.keys(this._specifics);
-
-	if (KEYS.length) {
-
-		KEYS.forEach((key) => {
-
-			const size = "object" === typeof this._specifics[key] && this._specifics[key] instanceof Buffer ? this._specifics[key].length : 1;
-
-			for (let foundAt = this._searchTags(this._specifics[key]); -1 < foundAt; foundAt = this._searchTags(this._specifics[key])) {
-
-				this.emit(key);
-
-				this._frame = Buffer.from(Buffer.concat([
-					this._frame.slice(0, foundAt),
-					this._frame.slice(foundAt + size, this._frame.length)
-				]));
-
-			}
-
-		});
-
-	}
-
-	this.push(Buffer.from(this._frame));
-
-	this._frame = Buffer.from([]);
-
-	this._digesting = false;
-
-};

package/lib/digesters/digestStartAndEnd.js

@@ -1,92 +0,0 @@
-/*
-	eslint no-unmodified-loop-condition:0, no-invalid-this: 0
-*/
-
-"use strict";
-
-module.exports = function digestStartAndEnd () {
-
-	const KEYS = Object.keys(this._specifics);
-
-	if (KEYS.length) {
-
-		KEYS.forEach((key) => {
-
-			const firstStart = this._searchFirstStart();
-
-			const size = "object" === typeof this._specifics[key] && this._specifics[key] instanceof Buffer ? this._specifics[key].length : 1;
-
-			for (
-				let foundAt = this._searchTags(this._specifics[key]), i = 0;
-				-1 < foundAt && (!firstStart || foundAt < firstStart.start - i);
-				foundAt = this._searchTags(this._specifics[key]), i += size
-			) {
-
-				this.emit(key);
-
-				this._frame = Buffer.from(Buffer.concat([
-					this._frame.slice(0, foundAt),
-					this._frame.slice(foundAt + size, this._frame.length)
-				]));
-
-			}
-
-		});
-
-	}
-
-	const firstStart = this._searchFirstStart();
-
-	// no start tag detected
-	if (!firstStart) {
-
-		this._frame = Buffer.from([]);
-		this._digesting = false;
-
-	}
-
-	// start tag detected
-	else {
-
-		const firstEnd = this._searchFirstEnd();
-
-		// end tag not detected
-		if (!firstEnd) {
-
-			// remove useless bits
-			this._frame = 0 < firstStart.start ? Buffer.from(this._frame.slice(firstStart.start, this._frame.length)) : this._frame;
-			this._digesting = false;
-
-		}
-
-		// end tag detected
-		else {
-
-			this.push(Buffer.from(this._frame.slice(firstStart.start, firstEnd.end)));
-
-			// remove extracted frame from main one
-			this._frame = Buffer.from(this._frame.slice(firstEnd.end, this._frame.length));
-
-			// search specifics
-			let foundSpecific = false;
-			for (let i = 0; i < KEYS.length && !foundSpecific; ++i) {
-
-				if (-1 < this._searchTags(this._specifics[KEYS[i]])) {
-					foundSpecific = true; break;
-				}
-
-			}
-
-			// specific detected or second start detected (force minimal data length)
-			if (foundSpecific || -1 < this._searchTags(this._startWith, 1)) {
-				this._digest();
-			}
-			else {
-				this._digesting = false;
-			}
-
-		}
-
-	}
-
-};

package/lib/digesters/digestStartOnly.js

@@ -1,71 +0,0 @@
-/*
-	eslint no-invalid-this: 0
-*/
-
-"use strict";
-
-module.exports = function digestStartOnly () {
-
-	if (this._timeoutDigest) {
-		clearTimeout(this._timeoutDigest);
-		this._timeoutDigest = null;
-	}
-
-	const firstStart = this._searchFirstStart();
-
-	// no start tag detected
-	if (!firstStart) {
-
-		this._frame = Buffer.from([]);
-		this._digesting = false;
-
-	}
-
-	// first start tag detected
-	else {
-
-		const nextStartAt = this._searchTags(this._startWith, firstStart.end);
-
-		// second start tag not detected
-		if (-1 >= nextStartAt) {
-
-			// remove useless bits
-			this._frame = 0 < firstStart.start ? Buffer.from(this._frame.slice(firstStart.start, this._frame.length)) : this._frame;
-			this._digesting = false;
-
-			this._timeoutDigest = setTimeout(() => {
-
-				clearTimeout(this._timeoutDigest);
-				this._timeoutDigest = null;
-
-				this.push(Buffer.from(this._frame.slice(firstStart.start, this._frame.length)));
-
-				this._frame = Buffer.from([]);
-				this._digesting = false;
-
-			}, this._startTimeout);
-
-		}
-
-		// second start tag detected
-		else {
-
-			// extract first frame
-			this.push(Buffer.from(this._frame.slice(firstStart.start, nextStartAt)));
-
-			// remove extracted frame from main one
-			this._frame = Buffer.from(this._frame.slice(nextStartAt, this._frame.length));
-
-			// second full frame detected (force minimal data length)
-			if (-1 < this._searchTags(this._startWith, 1)) {
-				this._digest();
-			}
-			else {
-				this._digesting = false;
-			}
-
-		}
-
-	}
-
-};

package/lib/index.d.ts

@@ -1,55 +0,0 @@
-/// <reference types="node" />
-
-declare module "split-frames" {
-
-	import { Transform } from "node:stream";
-
-	type ControlBits = "none" | "end+1" | "end+2";
-	type Tag = number | Buffer | Array<number>;
-
-	interface SearchedBits {
-		"start": number;
-		"end": number;
-	}
-
-	interface iOptions {
-		"startWith"?: Tag;
-		"startTimeout"?: number;
-		"endWith"?: Tag;
-		"escapeWith"?: Tag;
-		"escaped"?: Array<number>;
-		"specifics"?: { [key:string]: Tag };
-		"controlBits"?: ControlBits;
-	}
-
-	class Splitter extends Transform {
-
-		protected _frame: Buffer;
-		protected _digesting: boolean;
-
-		// from params
-		protected _startWith: Tag;
-		protected _startTimeout: number;
-		protected _endWith: Tag;
-		protected _escapeWith: number;
-		protected _escaped: Array<number>;
-		protected _specifics: object;
-		protected _controlBits: ControlBits;
-
-		// constructor
-
-		constructor (params?: iOptions);
-
-		// methods
-		protected _searchFirstTag(tag: Tag, beginWith?: number): SearchedBits;
-		protected _searchFirstStart(): SearchedBits;
-		protected _searchFirstEnd(): SearchedBits;
-		protected _searchTags(tag: Tag, beginWith?: number): number;
-		protected _digest(): void;
-		protected _digester(): void;
-
-	}
-
-	export = Splitter;
-
-}