strtok3 10.2.0 → 10.2.2

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2025 Borewit
+
+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

@@ -1,4 +1,4 @@
-[![Node.js CI](https://github.com/Borewit/strtok3/actions/workflows/nodejs-ci.yml/badge.svg?branch=master)](https://github.com/Borewit/strtok3/actions/workflows/nodejs-ci.yml?query=branch%3Amaster)
+[![Node.js CI](https://github.com/Borewit/strtok3/actions/workflows/ci.yml/badge.svg)](https://github.com/Borewit/strtok3/actions/workflows/ci.yml)
 [![CodeQL](https://github.com/Borewit/strtok3/actions/workflows/codeql.yml/badge.svg?branch=master)](https://github.com/Borewit/strtok3/actions/workflows/codeql.yml)
 [![NPM version](https://badge.fury.io/js/strtok3.svg)](https://npmjs.org/package/strtok3)
 [![npm downloads](http://img.shields.io/npm/dm/strtok3.svg)](https://npmcharts.com/compare/strtok3,token-types?start=1200&interval=30)
@@ -35,7 +35,7 @@ npm install strtok3
 Starting with version 7, the module has migrated from [CommonJS](https://en.wikipedia.org/wiki/CommonJS) to [pure ECMAScript Module (ESM)](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
 The distributed JavaScript codebase is compliant with the [ECMAScript 2020 (11th Edition)](https://en.wikipedia.org/wiki/ECMAScript_version_history#11th_Edition_%E2%80%93_ECMAScript_2020) standard.
 
-Requires a modern browser or Node.js ≥ 18 engine.
+Requires a modern browser, Node.js (V8) ≥ 18 engine or Bun (JavaScriptCore) ≥ 1.2.
 
 For TypeScript CommonJs backward compatibility, you can use [load-esm](https://github.com/Borewit/load-esm).
 
@@ -57,12 +57,12 @@ If you find this project useful and would like to support its development, consi
 ### strtok3 methods
 
 Use one of the methods to instantiate an [*abstract tokenizer*](#tokenizer-object):
-- [fromFile](#fromfile-function)[^1]
-- [fromStream](#fromstream-function)[^1]
+- [fromFile](#fromfile-function)*
+- [fromStream](#fromstream-function)*
 - [fromWebStream](#fromwebstream-function)
 - [fromBuffer](#frombuffer-function)
 
-[^1]: Only available when importing this module with Node.js
+> **_NOTE:_**  * `fromFile` and `fromStream`  only available when importing this module with Node.js
 
 All methods return a [`Tokenizer`](#tokenizer-object), either directly or via a promise.
 
@@ -362,23 +362,16 @@ import { ReadableWebToNodeStream } from 'readable-web-to-node-stream';
 ## Dependencies
 
 The diagram below illustrates the primary dependencies of `strtok3`:
+
 ```mermaid
 graph TD;
   S(strtok3)-->P(peek-readable)
   S(strtok3)-->TO("@tokenizer/token")
 ```
-- 
+ 
 - [peek-readable](https://github.com/Borewit/peek-readable): Manages reading operations with peeking capabilities, allowing data to be previewed without advancing the read pointer.
 - [@tokenizer/token](https://github.com/Borewit/tokenizer-token): Provides token definitions and utilities used by `strtok3` for interpreting binary data.
 
 ## Licence
 
-(The MIT License)
-
-Copyright (c) 2024 Borewit
-
-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.
+This project is licensed under the [MIT License](LICENSE.txt). Feel free to use, modify, and distribute as needed.

package/lib/ReadStreamTokenizer.js

@@ -31,7 +31,7 @@ export class ReadStreamTokenizer extends AbstractTokenizer {
         if (normOptions.length === 0) {
             return 0;
         }
-        const bytesRead = await this.streamReader.read(uint8Array, 0, normOptions.length);
+        const bytesRead = await this.streamReader.read(uint8Array.subarray(0, normOptions.length), normOptions.mayBeLess);
         this.position += bytesRead;
         if ((!options || !options.mayBeLess) && bytesRead < normOptions.length) {
             throw new EndOfStreamError();
@@ -61,7 +61,7 @@ export class ReadStreamTokenizer extends AbstractTokenizer {
         }
         if (normOptions.length > 0) {
             try {
-                bytesRead = await this.streamReader.peek(uint8Array, 0, normOptions.length);
+                bytesRead = await this.streamReader.peek(uint8Array.subarray(0, normOptions.length), normOptions.mayBeLess);
             }
             catch (err) {
                 if (options?.mayBeLess && err instanceof EndOfStreamError) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strtok3",
-  "version": "10.2.0",
+  "version": "10.2.2",
   "description": "A promise based streaming tokenizer",
   "author": {
     "name": "Borewit",
@@ -22,6 +22,7 @@
     "lint": "yarn run lint-md && yarn run lint-ts",
     "fix": "yarn run biome lint --write",
     "test": "mocha",
+    "bun:test": "bun run --bun test",
     "test-coverage": "c8 yarn run test",
     "send-codacy": "c8 report --reporter=text-lcov | codacy-coverage",
     "start": "yarn run compile && yarn run lint && yarn run cover-test"
@@ -50,29 +51,30 @@
   "bugs": {
     "url": "https://github.com/Borewit/strtok3/issues"
   },
+  "dependencies": {
+    "@tokenizer/token": "^0.3.0",
+    "peek-readable": "^7.0.0"
+  },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
     "@types/chai": "^5.0.1",
     "@types/chai-as-promised": "^8.0.1",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.12.0",
+    "@types/node": "^22.13.8",
     "c8": "^10.1.3",
-    "chai": "^5.1.2",
+    "chai": "^5.2.0",
     "chai-as-promised": "^8.0.1",
     "del-cli": "^6.0.0",
     "mocha": "^11.1.0",
+    "node-readable-to-web-readable-stream": "^0.4.2",
     "remark-cli": "^12.0.1",
     "remark-preset-lint-recommended": "^7.0.1",
     "token-types": "^6.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.3",
+    "typescript": "^5.8.2",
     "uint8array-extras": "^1.4.0"
   },
-  "dependencies": {
-    "@tokenizer/token": "^0.3.0",
-    "peek-readable": "^6.1.0"
-  },
   "keywords": [
     "tokenizer",
     "reader",

package/LICENSE

@@ -1,15 +0,0 @@
-Copyright (c) 2017, Borewit
-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.