split-frames 2.5.1 → 2.6.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2024, Sébastien Vidal
+Copyright (c) 2026, Sébastien Vidal
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/README.md

@@ -1,13 +1,18 @@
 # split-frames
 Split Buffer frames from streams
 
-[![Build Status](https://api.travis-ci.org/Psychopoulet/split-frames.svg?branch=master)](https://travis-ci.org/Psychopoulet/split-frames)
-[![Coverage Status](https://coveralls.io/repos/github/Psychopoulet/split-frames/badge.svg?branch=master)](https://coveralls.io/github/Psychopoulet/split-frames)
-[![Dependency Status](https://david-dm.org/Psychopoulet/split-frames/status.svg)](https://david-dm.org/Psychopoulet/split-frames)
-[![Dev dependency Status](https://david-dm.org/Psychopoulet/split-frames/dev-status.svg)](https://david-dm.org/Psychopoulet/split-frames?type=dev)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_split-frames&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_split-frames)
 [![Issues](https://img.shields.io/github/issues/Psychopoulet/split-frames.svg)](https://github.com/Psychopoulet/split-frames/issues)
 [![Pull requests](https://img.shields.io/github/issues-pr/Psychopoulet/split-frames.svg)](https://github.com/Psychopoulet/split-frames/pulls)
 
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_split-frames&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_split-frames)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_split-frames&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_split-frames)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_split-frames&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_split-frames)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_split-frames&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_split-frames)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Psychopoulet_split-frames&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Psychopoulet_split-frames)
+
+[![Known Vulnerabilities](https://snyk.io/test/github/Psychopoulet/split-frames/badge.svg)](https://snyk.io/test/github/Psychopoulet/split-frames)
+
 ## Installation
 
 ```bash

package/lib/cjs/SplitFrames.d.ts

@@ -33,7 +33,7 @@ export default class SplitFrames extends Transform {
     protected _controlBits: iConf["controlBits"];
     protected _digester: (enc?: BufferEncoding) => void;
     constructor(options?: iOptions);
-    _transform(chunk: Buffer, enc: BufferEncoding, cb: (err?: Error | null, data?: any) => void): void;
+    _transform(chunk: Buffer, enc: BufferEncoding, cb: (err?: Error | null, data?: unknown) => void): void;
     protected _chooseDigester(): (enc?: BufferEncoding) => void;
     protected _digest(enc?: BufferEncoding): void;
     private _digestNoStartNoEnd;

package/lib/cjs/SplitFrames.js

@@ -1,15 +1,34 @@
 "use strict";
-// deps
+/*
+    eslint-disable no-unmodified-loop-condition
+*/
+// => no-unmodified-loop-condition is disabled to allow data generation in a loop (_digestStartAndEnd)
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+// deps
 // natives
 const node_stream_1 = require("node:stream");
 // locals
 const initData_1 = __importDefault(require("./checkers/initData"));
 // module
 class SplitFrames extends node_stream_1.Transform {
+    // attributes
+    // protected
+    _frame;
+    _digesting;
+    _timeoutDigest;
+    // from params
+    _startWith;
+    _startTimeout;
+    _endWith;
+    _escapeWith;
+    _escaped;
+    _specifics;
+    _controlBits;
+    // dynamic digester
+    _digester;
     // constructor
     constructor(options) {
         super();
@@ -41,20 +60,16 @@ class SplitFrames extends node_stream_1.Transform {
     }
     // protected
     _chooseDigester() {
-        let digester = undefined;
         if (undefined === this._startWith && undefined === this._endWith) {
-            digester = this._digestNoStartNoEnd;
+            return this._digestNoStartNoEnd.bind(this);
         }
         else if (undefined !== this._startWith && undefined === this._endWith) {
-            digester = this._digestStartOnly;
+            return this._digestStartOnly.bind(this);
         }
         else if (undefined === this._startWith && undefined !== this._endWith) {
-            digester = this._digestEndOnly;
-        }
-        else {
-            digester = this._digestStartAndEnd;
+            return this._digestEndOnly.bind(this);
         }
-        return digester;
+        return this._digestStartAndEnd.bind(this);
     }
     _digest(enc) {
         if (!this._frame.length) {
@@ -166,7 +181,8 @@ class SplitFrames extends node_stream_1.Transform {
                 this._frame = Buffer.from(this._frame.slice(size, this._frame.length));
             }
         });
-        if (found) {
+        // disabled due to malfunction
+        if (found) { // eslint-disable-line @typescript-eslint/no-unnecessary-condition
             this._extractSpecifics();
         }
     }
@@ -206,7 +222,7 @@ class SplitFrames extends node_stream_1.Transform {
                 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) {
+                for (let i = 0; i < KEYS.length; ++i) {
                     if (-1 < this._searchTags(this._specifics[KEYS[i]])) {
                         foundSpecific = true;
                         break;
@@ -359,8 +375,7 @@ class SplitFrames extends node_stream_1.Transform {
             for (let i = 0; i < tags.length; ++i) {
                 // number | Buffer
                 if ("number" === typeof tags[i]
-                    || ("object" === typeof tags[i]
-                        && tags[i] instanceof Buffer)) {
+                    || ("object" === typeof tags[i] && tags[i] instanceof Buffer)) {
                     const _foundAt = this._frame.indexOf(tags[i], beginAt);
                     if (-1 < _foundAt && (-1 >= foundAt || _foundAt < foundAt)) {
                         foundAt = _foundAt;

package/lib/cjs/checkers/checkTagsValidity.js

@@ -9,10 +9,12 @@ function checkTagsValidity(tags) {
         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;
+        for (const tag of tags) {
+            if ("number" !== typeof tag) {
+                if ("object" !== typeof tag || !(tag instanceof Buffer)) {
+                    result = false;
+                    break;
+                }
             }
         }
     }

package/lib/cjs/checkers/initData.js

@@ -15,75 +15,80 @@ const ALLOWED_CONTROL_BITS_OPTIONS = [
 ];
 // module
 function initData(options) {
-    const result = {
-        "startWith": undefined,
-        "startTimeout": 200,
-        "endWith": undefined,
-        "escapeWith": undefined,
-        "escaped": [],
-        "specifics": {},
-        "controlBits": "none"
-    };
-    if ("undefined" !== typeof options) {
-        if ("object" !== typeof options) {
-            throw new TypeError("parameter sended is not an object");
-        }
-        else if ("undefined" !== typeof options.startWith && !(0, checkTagsValidity_1.default)(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 && !(0, checkTagsValidity_1.default)(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("\", \"") + "\" ]");
+    if ("undefined" === typeof options) {
+        return {
+            "startTimeout": 200,
+            "escaped": [],
+            "specifics": {},
+            "controlBits": "none"
+        };
+    }
+    if ("object" !== typeof options) {
+        throw new TypeError("parameter is not an object");
+    }
+    else if ("undefined" !== typeof options.startWith && !(0, checkTagsValidity_1.default)(options.startWith)) {
+        throw new TypeError("startWith parameter 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 is not a number");
+    }
+    else if ("undefined" !== typeof options.endWith && !(0, checkTagsValidity_1.default)(options.endWith)) {
+        throw new TypeError("endWith parameter 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 is not a number");
+    }
+    else if ("undefined" !== typeof options.escaped) {
+        if (!(0, checkTagsValidity_1.default)(options.escaped)) {
+            throw new TypeError("escaped parameter is not a number, Buffer, or an Array of numbers");
         }
-        else {
-            result.startWith = "undefined" !== typeof options.startWith ? options.startWith : undefined;
-            result.endWith = "undefined" !== typeof options.endWith ? options.endWith : undefined;
-            if ("undefined" !== typeof options.startTimeout) {
-                result.startTimeout = options.startTimeout;
-            }
-            result.escapeWith = "undefined" !== typeof options.escapeWith ? options.escapeWith : undefined;
-            if ("undefined" !== typeof options.escaped) {
-                result.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 (Array.isArray(options.escaped)) {
+            for (let i = 0; i < options.escaped.length; ++i) {
+                if ("number" !== typeof options.escaped[i]) {
+                    throw new TypeError("escaped parameter n°" + i + " is not a number");
                 }
             }
-            if ("object" === typeof options.specifics) {
-                const specifics = options.specifics;
-                Object.keys(specifics).forEach((key) => {
-                    if ("undefined" !== typeof specifics[key]) {
-                        if (!(0, checkTagsValidity_1.default)(specifics[key])) {
-                            throw new Error("\"" + specifics[key] + "\" specifics option"
-                                + " sended is not a number, or an Array of numbers");
-                        }
-                        else if (undefined !== specifics[key]
-                            && undefined !== result.startWith
-                            && undefined === result.endWith) {
-                            throw new Error("If you want to use \"" + 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";
         }
     }
+    else if ("undefined" !== typeof options.specifics && "object" !== typeof options.specifics) {
+        throw new TypeError("specifics parameter is not an object");
+    }
+    else if ("undefined" !== typeof options.controlBits && "string" !== typeof options.controlBits) {
+        throw new TypeError("controlBits parameter is not a string");
+    }
+    else if ("undefined" !== typeof options.controlBits && !ALLOWED_CONTROL_BITS_OPTIONS.includes(options.controlBits)) {
+        throw new Error("controlBits option is not in [ \"" + ALLOWED_CONTROL_BITS_OPTIONS.join("\", \"") + "\" ]");
+    }
+    const result = {
+        "startTimeout": options.startTimeout ?? 200,
+        "escaped": options.escaped ?? [],
+        "specifics": options.specifics ?? {},
+        "controlBits": options.controlBits ?? "none"
+    };
+    if ("undefined" !== typeof options.startWith) {
+        result.startWith = options.startWith;
+    }
+    if ("undefined" !== typeof options.endWith) {
+        result.endWith = options.endWith;
+    }
+    if ("undefined" !== typeof options.escapeWith) {
+        result.escapeWith = options.escapeWith;
+    }
+    if ("object" === typeof options.specifics) {
+        const specifics = options.specifics;
+        Object.keys(specifics).forEach((key) => {
+            if ("undefined" !== typeof specifics[key]) {
+                if (!(0, checkTagsValidity_1.default)(specifics[key])) {
+                    throw new Error("\"" + String(specifics[key]) + "\" specifics option"
+                        + " is not a number, or an Array of numbers");
+                }
+                else if ("undefined" !== typeof result.startWith
+                    && "undefined" === typeof result.endWith) {
+                    throw new Error("If you want to use \"" + String(specifics[key]) + "\" specific option,"
+                        + " you have to use \"endWith\" option");
+                }
+            }
+        });
+    }
     return result;
 }

package/package.json

@@ -1,9 +1,12 @@
 {
+
   "name": "split-frames",
-  "version": "2.5.1",
-  "description": "Split Buffer frames from streams",
+  "version": "2.6.0",
+  "description": "Split Buffer frames from streams.",
+
   "type": "commonjs",
   "typings": "./lib/cjs/main.d.cts",
+
   "main": "./lib/cjs/main.cjs",
   "exports": {
     ".": {
@@ -13,43 +16,54 @@
       }
     }
   },
+
   "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"
+
+    "prepare": "npx husky || true",
+
+    "lint-back": "npx eslint --config .eslintrc-back.js --ext .ts,.cts,.mts ./lib/src/**/*",
+    "lint-tests": "npx eslint --config .eslintrc-tests.js --ext .js,.cjs,.mjs ./test/**/*",
+    "lint": "npm run lint-back && npm run lint-tests",
+
+    "clean-back": "npx rimraf ./lib/cjs",
+    "clean": "npm run clean-back",
+
+    "build-back": "npm run clean-back && npx tsc --project ./tsconfig.json",
+    "build": "npm run build-back",
+
+    "check-requires": "npx used-deps-analyzer ./package.json ./lib/src --no-dev",
+    "check-updates": "npx check-version-modules --no-fail-at-major --fail-at-minor --fail-at-patch",
+    "unit-tests": "npm run build && npx nyc --reporter=html --reporter=text mocha",
+
+    "tests": "npm run lint && npm run check-requires && npm run check-updates && npm run unit-tests"
+
   },
+
   "files": [
-    "/bin",
-    "/lib/cjs",
-    "/public"
+    "lib/cjs"
   ],
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=22.22.0"
   },
+
   "dependencies": {},
   "devDependencies": {
-    "@types/node": "22.7.8",
-    "check-version-modules": "2.1.2",
+    "@types/node": "25.5.0",
+    "check-version-modules": "2.2.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"
+    "husky": "9.1.7",
+    "mocha": "11.7.5",
+    "nyc": "18.0.0",
+    "rimraf": "6.1.3",
+    "typescript": "5.9.3",
+    "used-deps-analyzer": "0.2.0"
   },
-  "optionalDependencies": {},
+
   "husky": {
     "hooks": {
-      "pre-commit": "npm run-script lint",
-      "pre-push": "npm run-script unit-tests",
-      "pre-receive": "npm run-script tests"
+      "pre-commit": "npm run lint",
+      "pre-push": "npm run unit-tests"
     }
   },
   "keywords": [
@@ -84,12 +98,14 @@
     }
   ],
   "license": "ISC",
+
   "homepage": "https://github.com/Psychopoulet/split-frames#readme",
   "repository": {
     "type": "git",
-    "url": "git://github.com/Psychopoulet/split-frames"
+    "url": "git://github.com/Psychopoulet/split-frames.git"
   },
   "bugs": {
     "url": "https://github.com/Psychopoulet/split-frames/issues"
   }
+
 }