strtok3 7.1.0 → 7.1.1

package/README.md

@@ -1,4 +1,5 @@
-![Node.js CI](https://github.com/Borewit/strtok3/workflows/Node.js%20CI/badge.svg)
+[![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)
+[![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)
 [![DeepScan grade](https://deepscan.io/api/teams/5165/projects/8526/branches/103329/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=5165&pid=8526&bid=103329)
@@ -32,7 +33,7 @@ npm install strtok3
 
 Module: version 7 migrated from [CommonJS](https://en.wikipedia.org/wiki/CommonJS) to [pure ECMAScript Module (ESM)](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
 JavaScript is compliant with [ECMAScript 2019 (ES10)](https://en.wikipedia.org/wiki/ECMAScript#10th_Edition_%E2%80%93_ECMAScript_2019).
-Requires Node.js ≥ 14.16 engine.
+Requires Node.js ≥ 16 engine.
 
 ## API
 

package/lib/FileTokenizer.d.ts

@@ -1,8 +1,9 @@
 import { AbstractTokenizer } from './AbstractTokenizer.js';
 import { IFileInfo, IReadChunkOptions } from './types.js';
+import { FileHandle } from 'node:fs/promises';
 export declare class FileTokenizer extends AbstractTokenizer {
-    private fd;
-    constructor(fd: number, fileInfo: IFileInfo);
+    private fileHandle;
+    constructor(fileHandle: FileHandle, fileInfo: IFileInfo);
     /**
      * Read buffer from file
      * @param uint8Array - Uint8Array to write result to

package/lib/FileTokenizer.js

@@ -1,10 +1,10 @@
 import { AbstractTokenizer } from './AbstractTokenizer.js';
 import { EndOfStreamError } from 'peek-readable';
-import * as fs from './FsPromise.js';
+import { open as fsOpen } from 'node:fs/promises';
 export class FileTokenizer extends AbstractTokenizer {
-    constructor(fd, fileInfo) {
+    constructor(fileHandle, fileInfo) {
         super(fileInfo);
-        this.fd = fd;
+        this.fileHandle = fileHandle;
     }
     /**
      * Read buffer from file
@@ -15,7 +15,7 @@ export class FileTokenizer extends AbstractTokenizer {
     async readBuffer(uint8Array, options) {
         const normOptions = this.normalizeOptions(uint8Array, options);
         this.position = normOptions.position;
-        const res = await fs.read(this.fd, uint8Array, normOptions.offset, normOptions.length, normOptions.position);
+        const res = await this.fileHandle.read(uint8Array, normOptions.offset, normOptions.length, normOptions.position);
         this.position += res.bytesRead;
         if (res.bytesRead < normOptions.length && (!options || !options.mayBeLess)) {
             throw new EndOfStreamError();
@@ -30,21 +30,18 @@ export class FileTokenizer extends AbstractTokenizer {
      */
     async peekBuffer(uint8Array, options) {
         const normOptions = this.normalizeOptions(uint8Array, options);
-        const res = await fs.read(this.fd, uint8Array, normOptions.offset, normOptions.length, normOptions.position);
+        const res = await this.fileHandle.read(uint8Array, normOptions.offset, normOptions.length, normOptions.position);
         if ((!normOptions.mayBeLess) && res.bytesRead < normOptions.length) {
             throw new EndOfStreamError();
         }
         return res.bytesRead;
     }
     async close() {
-        return fs.close(this.fd);
+        return this.fileHandle.close();
     }
 }
 export async function fromFile(sourceFilePath) {
-    const stat = await fs.stat(sourceFilePath);
-    if (!stat.isFile) {
-        throw new Error(`File not a file: ${sourceFilePath}`);
-    }
-    const fd = await fs.open(sourceFilePath, 'r');
-    return new FileTokenizer(fd, { path: sourceFilePath, size: stat.size });
+    const fileHandle = await fsOpen(sourceFilePath, 'r');
+    const stat = await fileHandle.stat();
+    return new FileTokenizer(fileHandle, { path: sourceFilePath, size: stat.size });
 }

package/lib/core.d.ts

@@ -1,8 +1,8 @@
 import { ReadStreamTokenizer } from './ReadStreamTokenizer.js';
-import { Readable } from 'node:stream';
 import { BufferTokenizer } from './BufferTokenizer.js';
 import { IFileInfo } from './types.js';
 import type { ReadableStream } from 'node:stream/web';
+import type { Readable } from 'node:stream';
 export { EndOfStreamError } from 'peek-readable';
 export { ITokenizer, IFileInfo } from './types.js';
 export { IToken, IGetToken } from '@tokenizer/token';

package/lib/core.js

@@ -1,6 +1,6 @@
 import { ReadStreamTokenizer } from './ReadStreamTokenizer.js';
 import { BufferTokenizer } from './BufferTokenizer.js';
-import { StreamReader, WebStreamReader } from "peek-readable";
+import { StreamReader, WebStreamReader } from 'peek-readable';
 export { EndOfStreamError } from 'peek-readable';
 /**
  * Construct ReadStreamTokenizer from given Stream.

package/lib/index.js

@@ -1,4 +1,4 @@
-import * as fs from './FsPromise.js';
+import { stat as fsStat } from 'node:fs/promises';
 import * as core from './core.js';
 export { fromFile } from './FileTokenizer.js';
 export { EndOfStreamError, fromBuffer, fromWebStream } from './core.js';
@@ -12,7 +12,7 @@ export { EndOfStreamError, fromBuffer, fromWebStream } from './core.js';
 export async function fromStream(stream, fileInfo) {
     fileInfo = fileInfo ? fileInfo : {};
     if (stream.path) {
-        const stat = await fs.stat(stream.path);
+        const stat = await fsStat(stream.path);
         fileInfo.path = stream.path;
         fileInfo.size = stat.size;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strtok3",
-  "version": "7.1.0",
+  "version": "7.1.1",
   "description": "A promise based streaming tokenizer",
   "author": {
     "name": "Borewit",
@@ -16,7 +16,7 @@
     "compile-test": "tsc -p test",
     "compile": "npm run compile-src && npm run compile-test",
     "build": "npm run clean && npm run compile",
-    "eslint": "eslint lib test --ext .ts --ignore-pattern *.d.ts",
+    "eslint": "eslint lib test",
     "lint-md": "remark -u preset-lint-recommended .",
     "lint": "npm run lint-md && npm run eslint",
     "fix": "eslint lib test --ext .ts --ignore-pattern *.d.ts --fix",
@@ -26,7 +26,7 @@
     "start": "npm run compile && npm run lint && npm run cover-test"
   },
   "engines": {
-    "node": ">=14.16"
+    "node": ">=16"
   },
   "repository": {
     "type": "git",
@@ -50,22 +50,26 @@
     "url": "https://github.com/Borewit/strtok3/issues"
   },
   "devDependencies": {
+    "@eslint/compat": "^1.1.1",
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.7.0",
     "@types/chai": "^4.3.16",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10.0.7",
-    "@types/node": "^20.14.9",
-    "@typescript-eslint/eslint-plugin": "^7.15.0",
-    "@typescript-eslint/parser": "^7.15.0",
+    "@types/node": "^20.14.10",
+    "@typescript-eslint/eslint-plugin": "^7.16.1",
+    "@typescript-eslint/parser": "^7.16.1",
     "c8": "^10.1.2",
     "chai": "^5.1.1",
     "del-cli": "^5.1.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint": "^9.7.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-jsdoc": "^46.8.2",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^48.7.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-unicorn": "^54.0.0",
+    "global": "^4.4.0",
     "mocha": "^10.6.0",
     "remark-cli": "^12.0.1",
     "remark-preset-lint-recommended": "^7.0.0",
@@ -76,7 +80,7 @@
   },
   "dependencies": {
     "@tokenizer/token": "^0.3.0",
-    "peek-readable": "^5.1.1"
+    "peek-readable": "^5.1.3"
   },
   "keywords": [
     "tokenizer",
@@ -91,5 +95,6 @@
     "uint",
     "stream",
     "streaming"
-  ]
+  ],
+  "packageManager": "yarn@4.3.1"
 }

package/lib/FsPromise.d.ts

@@ -1,17 +0,0 @@
-/**
- * Module convert fs functions to promise based functions
- */
-import fs from 'node:fs';
-export interface IReadResult {
-    bytesRead: number;
-    buffer: Uint8Array;
-}
-export declare const pathExists: typeof fs.existsSync;
-export declare const createReadStream: typeof fs.createReadStream;
-export declare function stat(path: fs.PathLike): Promise<fs.Stats>;
-export declare function close(fd: number): Promise<void>;
-export declare function open(path: fs.PathLike, mode: fs.Mode): Promise<number>;
-export declare function read(fd: number, buffer: Uint8Array, offset: number, length: number, position: number): Promise<IReadResult>;
-export declare function writeFile(path: fs.PathLike, data: Uint8Array | string, options?: fs.WriteFileOptions): Promise<void>;
-export declare function writeFileSync(path: fs.PathLike, data: Uint8Array | string): void;
-export declare function readFile(path: fs.PathLike): Promise<Uint8Array>;

package/lib/FsPromise.js

@@ -1,69 +0,0 @@
-/**
- * Module convert fs functions to promise based functions
- */
-import fs from 'node:fs';
-export const pathExists = fs.existsSync;
-export const createReadStream = fs.createReadStream;
-export async function stat(path) {
-    return new Promise((resolve, reject) => {
-        fs.stat(path, (err, stats) => {
-            if (err)
-                reject(err);
-            else
-                resolve(stats);
-        });
-    });
-}
-export async function close(fd) {
-    return new Promise((resolve, reject) => {
-        fs.close(fd, err => {
-            if (err)
-                reject(err);
-            else
-                resolve();
-        });
-    });
-}
-export async function open(path, mode) {
-    return new Promise((resolve, reject) => {
-        fs.open(path, mode, (err, fd) => {
-            if (err)
-                reject(err);
-            else
-                resolve(fd);
-        });
-    });
-}
-export async function read(fd, buffer, offset, length, position) {
-    return new Promise((resolve, reject) => {
-        fs.read(fd, buffer, offset, length, position, (err, bytesRead, _buffer) => {
-            if (err)
-                reject(err);
-            else
-                resolve({ bytesRead, buffer: _buffer });
-        });
-    });
-}
-export async function writeFile(path, data, options = null) {
-    return new Promise((resolve, reject) => {
-        fs.writeFile(path, data, options, err => {
-            if (err)
-                reject(err);
-            else
-                resolve();
-        });
-    });
-}
-export function writeFileSync(path, data) {
-    fs.writeFileSync(path, data);
-}
-export async function readFile(path) {
-    return new Promise((resolve, reject) => {
-        fs.readFile(path, (err, buffer) => {
-            if (err)
-                reject(err);
-            else
-                resolve(buffer);
-        });
-    });
-}