strtok3 10.2.2 → 10.3.1

package/README.md

@@ -361,15 +361,7 @@ 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.
+Dependencies:
 - [@tokenizer/token](https://github.com/Borewit/tokenizer-token): Provides token definitions and utilities used by `strtok3` for interpreting binary data.
 
 ## Licence

package/lib/AbstractTokenizer.js

@@ -1,4 +1,4 @@
-import { EndOfStreamError } from 'peek-readable';
+import { EndOfStreamError } from './stream/index.js';
 /**
  * Core tokenizer
  */

package/lib/BlobTokenizer.d.ts

@@ -0,0 +1,29 @@
+import type { ITokenizerOptions, IReadChunkOptions, IRandomAccessFileInfo, IRandomAccessTokenizer } from './types.js';
+import { AbstractTokenizer } from './AbstractTokenizer.js';
+export declare class BlobTokenizer extends AbstractTokenizer implements IRandomAccessTokenizer {
+    private blob;
+    fileInfo: IRandomAccessFileInfo;
+    /**
+     * Construct BufferTokenizer
+     * @param blob - Uint8Array to tokenize
+     * @param options Tokenizer options
+     */
+    constructor(blob: Blob, options?: ITokenizerOptions);
+    /**
+     * Read buffer from tokenizer
+     * @param uint8Array - Uint8Array to tokenize
+     * @param options - Read behaviour options
+     * @returns {Promise<number>}
+     */
+    readBuffer(uint8Array: Uint8Array, options?: IReadChunkOptions): Promise<number>;
+    /**
+     * Peek (read ahead) buffer from tokenizer
+     * @param buffer
+     * @param options - Read behaviour options
+     * @returns {Promise<number>}
+     */
+    peekBuffer(buffer: Uint8Array, options?: IReadChunkOptions): Promise<number>;
+    close(): Promise<void>;
+    supportsRandomAccess(): boolean;
+    setPosition(position: number): void;
+}

package/lib/BlobTokenizer.js

@@ -0,0 +1,53 @@
+import { EndOfStreamError } from './stream/index.js';
+import { AbstractTokenizer } from './AbstractTokenizer.js';
+export class BlobTokenizer extends AbstractTokenizer {
+    /**
+     * Construct BufferTokenizer
+     * @param blob - Uint8Array to tokenize
+     * @param options Tokenizer options
+     */
+    constructor(blob, options) {
+        super(options);
+        this.blob = blob;
+        this.fileInfo = { ...options?.fileInfo ?? {}, ...{ size: blob.size, mimeType: blob.type } };
+    }
+    /**
+     * Read buffer from tokenizer
+     * @param uint8Array - Uint8Array to tokenize
+     * @param options - Read behaviour options
+     * @returns {Promise<number>}
+     */
+    async readBuffer(uint8Array, options) {
+        if (options?.position) {
+            this.position = options.position;
+        }
+        const bytesRead = await this.peekBuffer(uint8Array, options);
+        this.position += bytesRead;
+        return bytesRead;
+    }
+    /**
+     * Peek (read ahead) buffer from tokenizer
+     * @param buffer
+     * @param options - Read behaviour options
+     * @returns {Promise<number>}
+     */
+    async peekBuffer(buffer, options) {
+        const normOptions = this.normalizeOptions(buffer, options);
+        const bytes2read = Math.min(this.blob.size - normOptions.position, normOptions.length);
+        if ((!normOptions.mayBeLess) && bytes2read < normOptions.length) {
+            throw new EndOfStreamError();
+        }
+        const arrayBuffer = await this.blob.slice(normOptions.position, normOptions.position + bytes2read).arrayBuffer();
+        buffer.set(new Uint8Array(arrayBuffer));
+        return bytes2read;
+    }
+    close() {
+        return super.close();
+    }
+    supportsRandomAccess() {
+        return true;
+    }
+    setPosition(position) {
+        this.position = position;
+    }
+}

package/lib/BufferTokenizer.js

@@ -1,4 +1,4 @@
-import { EndOfStreamError } from 'peek-readable';
+import { EndOfStreamError } from './stream/index.js';
 import { AbstractTokenizer } from './AbstractTokenizer.js';
 export class BufferTokenizer extends AbstractTokenizer {
     /**

package/lib/FileTokenizer.js

@@ -1,5 +1,5 @@
 import { AbstractTokenizer } from './AbstractTokenizer.js';
-import { EndOfStreamError } from 'peek-readable';
+import { EndOfStreamError } from './stream/index.js';
 import { open as fsOpen } from 'node:fs/promises';
 export class FileTokenizer extends AbstractTokenizer {
     /**

package/lib/ReadStreamTokenizer.d.ts

@@ -1,5 +1,5 @@
 import { AbstractTokenizer } from './AbstractTokenizer.js';
-import { type IStreamReader } from 'peek-readable';
+import { type IStreamReader } from './stream/index.js';
 import type { IFileInfo, IReadChunkOptions, ITokenizerOptions } from './types.js';
 export declare class ReadStreamTokenizer extends AbstractTokenizer {
     private streamReader;

package/lib/ReadStreamTokenizer.js

@@ -1,5 +1,5 @@
 import { AbstractTokenizer } from './AbstractTokenizer.js';
-import { EndOfStreamError } from 'peek-readable';
+import { EndOfStreamError } from './stream/index.js';
 const maxBufferSize = 256000;
 export class ReadStreamTokenizer extends AbstractTokenizer {
     /**

package/lib/core.d.ts

@@ -1,9 +1,10 @@
 import type { Readable } from 'node:stream';
-import { type AnyWebByteStream } from 'peek-readable';
+import { type AnyWebByteStream } from './stream/index.js';
 import { ReadStreamTokenizer } from './ReadStreamTokenizer.js';
 import { BufferTokenizer } from './BufferTokenizer.js';
 import type { ITokenizerOptions } from './types.js';
-export { EndOfStreamError, AbortError, type AnyWebByteStream } from 'peek-readable';
+import { BlobTokenizer } from './BlobTokenizer.js';
+export { EndOfStreamError, AbortError, type AnyWebByteStream } from './stream/index.js';
 export type { ITokenizer, IRandomAccessTokenizer, IFileInfo, IRandomAccessFileInfo, ITokenizerOptions, IReadChunkOptions, OnClose } from './types.js';
 export type { IToken, IGetToken } from '@tokenizer/token';
 export { AbstractTokenizer } from './AbstractTokenizer.js';
@@ -30,3 +31,10 @@ export declare function fromWebStream(webStream: AnyWebByteStream, options?: ITo
  * @returns BufferTokenizer
  */
 export declare function fromBuffer(uint8Array: Uint8Array, options?: ITokenizerOptions): BufferTokenizer;
+/**
+ * Construct ReadStreamTokenizer from given Blob.
+ * @param blob - Uint8Array to tokenize
+ * @param options - Tokenizer options
+ * @returns BufferTokenizer
+ */
+export declare function fromBlob(blob: Blob, options?: ITokenizerOptions): BlobTokenizer;

package/lib/core.js

@@ -1,7 +1,8 @@
-import { StreamReader, makeWebStreamReader } from 'peek-readable';
+import { StreamReader, makeWebStreamReader } from './stream/index.js';
 import { ReadStreamTokenizer } from './ReadStreamTokenizer.js';
 import { BufferTokenizer } from './BufferTokenizer.js';
-export { EndOfStreamError, AbortError } from 'peek-readable';
+import { BlobTokenizer } from './BlobTokenizer.js';
+export { EndOfStreamError, AbortError } from './stream/index.js';
 export { AbstractTokenizer } from './AbstractTokenizer.js';
 /**
  * Construct ReadStreamTokenizer from given Stream.
@@ -50,3 +51,12 @@ export function fromWebStream(webStream, options) {
 export function fromBuffer(uint8Array, options) {
     return new BufferTokenizer(uint8Array, options);
 }
+/**
+ * Construct ReadStreamTokenizer from given Blob.
+ * @param blob - Uint8Array to tokenize
+ * @param options - Tokenizer options
+ * @returns BufferTokenizer
+ */
+export function fromBlob(blob, options) {
+    return new BlobTokenizer(blob, options);
+}

package/lib/stream/AbstractStreamReader.d.ts

@@ -0,0 +1,54 @@
+export interface IStreamReader {
+    /**
+     * Peak ahead (peek) from stream. Subsequent read or peeks will return the same data.
+     * @param uint8Array - Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - Allow the read to complete, without the buffer being fully filled (length may be smaller)
+     * @returns Number of bytes peeked. If `maybeLess` is set, this shall be the `uint8Array.length`.
+     */
+    peek(uint8Array: Uint8Array, mayBeLess?: boolean): Promise<number>;
+    /**
+     * Read from stream the stream.
+     * @param uint8Array - Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - Allow the read to complete, without the buffer being fully filled (length may be smaller)
+     * @returns Number of actually bytes read. If `maybeLess` is set, this shall be the `uint8Array.length`.
+     */
+    read(uint8Array: Uint8Array, mayBeLess?: boolean): Promise<number>;
+    close(): Promise<void>;
+    /**
+     * Abort any active asynchronous operation are active, abort those before they may have completed.
+     */
+    abort(): Promise<void>;
+}
+export declare abstract class AbstractStreamReader implements IStreamReader {
+    protected endOfStream: boolean;
+    protected interrupted: boolean;
+    /**
+     * Store peeked data
+     * @type {Array}
+     */
+    protected peekQueue: Uint8Array[];
+    peek(uint8Array: Uint8Array, mayBeLess?: boolean): Promise<number>;
+    read(buffer: Uint8Array, mayBeLess?: boolean): Promise<number>;
+    /**
+     * Read chunk from stream
+     * @param buffer - Target Uint8Array (or Buffer) to store data read from stream in
+     * @returns Number of bytes read
+     */
+    protected readFromPeekBuffer(buffer: Uint8Array): number;
+    readRemainderFromStream(buffer: Uint8Array, mayBeLess: boolean): Promise<number>;
+    /**
+     * Read from stream
+     * @param buffer - Target Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - If true, may fill the buffer partially
+     * @protected Bytes read
+     */
+    protected abstract readFromStream(buffer: Uint8Array, mayBeLess: boolean): Promise<number>;
+    /**
+     * abort synchronous operations
+     */
+    abstract close(): Promise<void>;
+    /**
+     * Abort any active asynchronous operation are active, abort those before they may have completed.
+     */
+    abstract abort(): Promise<void>;
+}

package/lib/stream/AbstractStreamReader.js

@@ -0,0 +1,71 @@
+import { EndOfStreamError, AbortError } from "./Errors.js";
+export class AbstractStreamReader {
+    constructor() {
+        this.endOfStream = false;
+        this.interrupted = false;
+        /**
+         * Store peeked data
+         * @type {Array}
+         */
+        this.peekQueue = [];
+    }
+    async peek(uint8Array, mayBeLess = false) {
+        const bytesRead = await this.read(uint8Array, mayBeLess);
+        this.peekQueue.push(uint8Array.subarray(0, bytesRead)); // Put read data back to peek buffer
+        return bytesRead;
+    }
+    async read(buffer, mayBeLess = false) {
+        if (buffer.length === 0) {
+            return 0;
+        }
+        let bytesRead = this.readFromPeekBuffer(buffer);
+        if (!this.endOfStream) {
+            bytesRead += await this.readRemainderFromStream(buffer.subarray(bytesRead), mayBeLess);
+        }
+        if (bytesRead === 0 && !mayBeLess) {
+            throw new EndOfStreamError();
+        }
+        return bytesRead;
+    }
+    /**
+     * Read chunk from stream
+     * @param buffer - Target Uint8Array (or Buffer) to store data read from stream in
+     * @returns Number of bytes read
+     */
+    readFromPeekBuffer(buffer) {
+        let remaining = buffer.length;
+        let bytesRead = 0;
+        // consume peeked data first
+        while (this.peekQueue.length > 0 && remaining > 0) {
+            const peekData = this.peekQueue.pop(); // Front of queue
+            if (!peekData)
+                throw new Error('peekData should be defined');
+            const lenCopy = Math.min(peekData.length, remaining);
+            buffer.set(peekData.subarray(0, lenCopy), bytesRead);
+            bytesRead += lenCopy;
+            remaining -= lenCopy;
+            if (lenCopy < peekData.length) {
+                // remainder back to queue
+                this.peekQueue.push(peekData.subarray(lenCopy));
+            }
+        }
+        return bytesRead;
+    }
+    async readRemainderFromStream(buffer, mayBeLess) {
+        let bytesRead = 0;
+        // Continue reading from stream if required
+        while (bytesRead < buffer.length && !this.endOfStream) {
+            if (this.interrupted) {
+                throw new AbortError();
+            }
+            const chunkLen = await this.readFromStream(buffer.subarray(bytesRead), mayBeLess);
+            if (chunkLen === 0)
+                break;
+            bytesRead += chunkLen;
+        }
+        if (!mayBeLess && bytesRead < buffer.length) {
+            throw new EndOfStreamError();
+        }
+        return bytesRead;
+    }
+}

package/lib/stream/Deferred.d.ts

@@ -0,0 +1,6 @@
+export declare class Deferred<T> {
+    promise: Promise<T>;
+    resolve: (value: T) => void;
+    reject: (reason: Error) => void;
+    constructor();
+}

package/lib/stream/Deferred.js

@@ -0,0 +1,10 @@
+export class Deferred {
+    constructor() {
+        this.resolve = () => null;
+        this.reject = () => null;
+        this.promise = new Promise((resolve, reject) => {
+            this.reject = reject;
+            this.resolve = resolve;
+        });
+    }
+}

package/lib/stream/Errors.d.ts

@@ -0,0 +1,10 @@
+export declare const defaultMessages = "End-Of-Stream";
+/**
+ * Thrown on read operation of the end of file or stream has been reached
+ */
+export declare class EndOfStreamError extends Error {
+    constructor();
+}
+export declare class AbortError extends Error {
+    constructor(message?: string);
+}

package/lib/stream/Errors.js

@@ -0,0 +1,16 @@
+export const defaultMessages = 'End-Of-Stream';
+/**
+ * Thrown on read operation of the end of file or stream has been reached
+ */
+export class EndOfStreamError extends Error {
+    constructor() {
+        super(defaultMessages);
+        this.name = "EndOfStreamError";
+    }
+}
+export class AbortError extends Error {
+    constructor(message = "The operation was aborted") {
+        super(message);
+        this.name = "AbortError";
+    }
+}

package/lib/stream/StreamReader.d.ts

@@ -0,0 +1,29 @@
+import type { Readable } from 'node:stream';
+import { AbstractStreamReader } from "./AbstractStreamReader.js";
+/**
+ * Node.js Readable Stream Reader
+ * Ref: https://nodejs.org/api/stream.html#readable-streams
+ */
+export declare class StreamReader extends AbstractStreamReader {
+    private s;
+    /**
+     * Deferred used for postponed read request (as not data is yet available to read)
+     */
+    private deferred;
+    constructor(s: Readable);
+    /**
+     * Read chunk from stream
+     * @param buffer Target Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - If true, may fill the buffer partially
+     * @returns Number of bytes read
+     */
+    protected readFromStream(buffer: Uint8Array, mayBeLess: boolean): Promise<number>;
+    /**
+     * Process deferred read request
+     * @param request Deferred read request
+     */
+    private readDeferred;
+    private reject;
+    abort(): Promise<void>;
+    close(): Promise<void>;
+}

package/lib/stream/StreamReader.js

@@ -0,0 +1,83 @@
+import { AbortError, } from './Errors.js';
+import { Deferred } from './Deferred.js';
+import { AbstractStreamReader } from "./AbstractStreamReader.js";
+/**
+ * Node.js Readable Stream Reader
+ * Ref: https://nodejs.org/api/stream.html#readable-streams
+ */
+export class StreamReader extends AbstractStreamReader {
+    constructor(s) {
+        super();
+        this.s = s;
+        /**
+         * Deferred used for postponed read request (as not data is yet available to read)
+         */
+        this.deferred = null;
+        if (!s.read || !s.once) {
+            throw new Error('Expected an instance of stream.Readable');
+        }
+        this.s.once('end', () => {
+            this.endOfStream = true;
+            if (this.deferred) {
+                this.deferred.resolve(0);
+            }
+        });
+        this.s.once('error', err => this.reject(err));
+        this.s.once('close', () => this.abort());
+    }
+    /**
+     * Read chunk from stream
+     * @param buffer Target Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - If true, may fill the buffer partially
+     * @returns Number of bytes read
+     */
+    async readFromStream(buffer, mayBeLess) {
+        if (buffer.length === 0)
+            return 0;
+        const readBuffer = this.s.read(buffer.length);
+        if (readBuffer) {
+            buffer.set(readBuffer);
+            return readBuffer.length;
+        }
+        const request = {
+            buffer,
+            mayBeLess,
+            deferred: new Deferred()
+        };
+        this.deferred = request.deferred;
+        this.s.once('readable', () => {
+            this.readDeferred(request);
+        });
+        return request.deferred.promise;
+    }
+    /**
+     * Process deferred read request
+     * @param request Deferred read request
+     */
+    readDeferred(request) {
+        const readBuffer = this.s.read(request.buffer.length);
+        if (readBuffer) {
+            request.buffer.set(readBuffer);
+            request.deferred.resolve(readBuffer.length);
+            this.deferred = null;
+        }
+        else {
+            this.s.once('readable', () => {
+                this.readDeferred(request);
+            });
+        }
+    }
+    reject(err) {
+        this.interrupted = true;
+        if (this.deferred) {
+            this.deferred.reject(err);
+            this.deferred = null;
+        }
+    }
+    async abort() {
+        this.reject(new AbortError());
+    }
+    async close() {
+        return this.abort();
+    }
+}

package/lib/stream/WebStreamByobReader.d.ts

@@ -0,0 +1,14 @@
+import { WebStreamReader } from './WebStreamReader.js';
+/**
+ * Read from a WebStream using a BYOB reader
+ * Reference: https://nodejs.org/api/webstreams.html#class-readablestreambyobreader
+ */
+export declare class WebStreamByobReader extends WebStreamReader {
+    /**
+     * Read from stream
+     * @param buffer - Target Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - If true, may fill the buffer partially
+     * @protected Bytes read
+     */
+    protected readFromStream(buffer: Uint8Array, mayBeLess: boolean): Promise<number>;
+}

package/lib/stream/WebStreamByobReader.js

@@ -0,0 +1,27 @@
+import { WebStreamReader } from './WebStreamReader.js';
+/**
+ * Read from a WebStream using a BYOB reader
+ * Reference: https://nodejs.org/api/webstreams.html#class-readablestreambyobreader
+ */
+export class WebStreamByobReader extends WebStreamReader {
+    /**
+     * Read from stream
+     * @param buffer - Target Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - If true, may fill the buffer partially
+     * @protected Bytes read
+     */
+    async readFromStream(buffer, mayBeLess) {
+        if (buffer.length === 0)
+            return 0;
+        // @ts-ignore
+        const result = await this.reader.read(new Uint8Array(buffer.length), { min: mayBeLess ? undefined : buffer.length });
+        if (result.done) {
+            this.endOfStream = result.done;
+        }
+        if (result.value) {
+            buffer.set(result.value);
+            return result.value.length;
+        }
+        return 0;
+    }
+}

package/lib/stream/WebStreamDefaultReader.d.ts

@@ -0,0 +1,19 @@
+import { AbstractStreamReader } from "./AbstractStreamReader.js";
+export declare class WebStreamDefaultReader extends AbstractStreamReader {
+    private reader;
+    private buffer;
+    constructor(reader: ReadableStreamDefaultReader<Uint8Array>);
+    /**
+     * Copy chunk to target, and store the remainder in this.buffer
+     */
+    private writeChunk;
+    /**
+     * Read from stream
+     * @param buffer - Target Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - If true, may fill the buffer partially
+     * @protected Bytes read
+     */
+    protected readFromStream(buffer: Uint8Array, mayBeLess: boolean): Promise<number>;
+    abort(): Promise<void>;
+    close(): Promise<void>;
+}

package/lib/stream/WebStreamDefaultReader.js

@@ -0,0 +1,62 @@
+import { EndOfStreamError } from './Errors.js';
+import { AbstractStreamReader } from "./AbstractStreamReader.js";
+export class WebStreamDefaultReader extends AbstractStreamReader {
+    constructor(reader) {
+        super();
+        this.reader = reader;
+        this.buffer = null; // Internal buffer to store excess data
+    }
+    /**
+     * Copy chunk to target, and store the remainder in this.buffer
+     */
+    writeChunk(target, chunk) {
+        const written = Math.min(chunk.length, target.length);
+        target.set(chunk.subarray(0, written));
+        // Adjust the remainder of the buffer
+        if (written < chunk.length) {
+            this.buffer = chunk.subarray(written);
+        }
+        else {
+            this.buffer = null;
+        }
+        return written;
+    }
+    /**
+     * Read from stream
+     * @param buffer - Target Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - If true, may fill the buffer partially
+     * @protected Bytes read
+     */
+    async readFromStream(buffer, mayBeLess) {
+        if (buffer.length === 0)
+            return 0;
+        let totalBytesRead = 0;
+        // Serve from the internal buffer first
+        if (this.buffer) {
+            totalBytesRead += this.writeChunk(buffer, this.buffer);
+        }
+        // Continue reading from the stream if more data is needed
+        while (totalBytesRead < buffer.length && !this.endOfStream) {
+            const result = await this.reader.read();
+            if (result.done) {
+                this.endOfStream = true;
+                break;
+            }
+            if (result.value) {
+                totalBytesRead += this.writeChunk(buffer.subarray(totalBytesRead), result.value);
+            }
+        }
+        if (!mayBeLess && totalBytesRead === 0 && this.endOfStream) {
+            throw new EndOfStreamError();
+        }
+        return totalBytesRead;
+    }
+    abort() {
+        this.interrupted = true;
+        return this.reader.cancel();
+    }
+    async close() {
+        await this.abort();
+        this.reader.releaseLock();
+    }
+}

package/lib/stream/WebStreamReader.d.ts

@@ -0,0 +1,14 @@
+import { AbstractStreamReader } from "./AbstractStreamReader.js";
+export declare abstract class WebStreamReader extends AbstractStreamReader {
+    protected reader: ReadableStreamDefaultReader | ReadableStreamBYOBReader;
+    constructor(reader: ReadableStreamDefaultReader | ReadableStreamBYOBReader);
+    /**
+     * Read from stream
+     * @param buffer - Target Uint8Array (or Buffer) to store data read from stream in
+     * @param mayBeLess - If true, may fill the buffer partially
+     * @protected Bytes read
+     */
+    protected abstract readFromStream(buffer: Uint8Array, mayBeLess: boolean): Promise<number>;
+    abort(): Promise<void>;
+    close(): Promise<void>;
+}

package/lib/stream/WebStreamReader.js

@@ -0,0 +1,13 @@
+import { AbstractStreamReader } from "./AbstractStreamReader.js";
+export class WebStreamReader extends AbstractStreamReader {
+    constructor(reader) {
+        super();
+        this.reader = reader;
+    }
+    async abort() {
+        return this.close();
+    }
+    async close() {
+        this.reader.releaseLock();
+    }
+}

package/lib/stream/WebStreamReaderFactory.d.ts

@@ -0,0 +1,5 @@
+import type { ReadableStream as NodeReadableStream } from 'node:stream/web';
+import { WebStreamByobReader } from './WebStreamByobReader.js';
+import { WebStreamDefaultReader } from './WebStreamDefaultReader.js';
+export type AnyWebByteStream = NodeReadableStream<Uint8Array> | ReadableStream<Uint8Array>;
+export declare function makeWebStreamReader(stream: AnyWebByteStream): WebStreamByobReader | WebStreamDefaultReader;

package/lib/stream/WebStreamReaderFactory.js

@@ -0,0 +1,19 @@
+import { WebStreamByobReader } from './WebStreamByobReader.js';
+import { WebStreamDefaultReader } from './WebStreamDefaultReader.js';
+export function makeWebStreamReader(stream) {
+    try {
+        const reader = stream.getReader({ mode: "byob" });
+        if (reader instanceof ReadableStreamDefaultReader) {
+            // Fallback to default reader in case `mode: byob` is ignored
+            return new WebStreamDefaultReader(reader);
+        }
+        return new WebStreamByobReader(reader);
+    }
+    catch (error) {
+        if (error instanceof TypeError) {
+            // Fallback to default reader in case `mode: byob` rejected by a `TypeError`
+            return new WebStreamDefaultReader(stream.getReader());
+        }
+        throw error;
+    }
+}

package/lib/stream/index.d.ts

@@ -0,0 +1,6 @@
+export { AbortError, EndOfStreamError } from './Errors.js';
+export { StreamReader } from './StreamReader.js';
+export { WebStreamByobReader } from './WebStreamByobReader.js';
+export { WebStreamDefaultReader } from './WebStreamDefaultReader.js';
+export type { IStreamReader } from './AbstractStreamReader.js';
+export { type AnyWebByteStream, makeWebStreamReader } from './WebStreamReaderFactory.js';

package/lib/stream/index.js

@@ -0,0 +1,5 @@
+export { AbortError, EndOfStreamError } from './Errors.js';
+export { StreamReader } from './StreamReader.js';
+export { WebStreamByobReader } from './WebStreamByobReader.js';
+export { WebStreamDefaultReader } from './WebStreamDefaultReader.js';
+export { makeWebStreamReader } from './WebStreamReaderFactory.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strtok3",
-  "version": "10.2.2",
+  "version": "10.3.1",
   "description": "A promise based streaming tokenizer",
   "author": {
     "name": "Borewit",
@@ -17,9 +17,9 @@
     "compile": "yarn run compile-src && yarn run compile-test",
     "build": "yarn run clean && yarn run compile",
     "eslint": "eslint lib test",
-    "lint-md": "remark -u preset-lint-recommended .",
-    "lint-ts": "biome check",
-    "lint": "yarn run lint-md && yarn run lint-ts",
+    "lint:md": "remark -u preset-lint-recommended .",
+    "lint:ts": "biome check",
+    "lint": "yarn run lint:md && yarn run lint:ts",
     "fix": "yarn run biome lint --write",
     "test": "mocha",
     "bun:test": "bun run --bun test",
@@ -52,27 +52,26 @@
     "url": "https://github.com/Borewit/strtok3/issues"
   },
   "dependencies": {
-    "@tokenizer/token": "^0.3.0",
-    "peek-readable": "^7.0.0"
+    "@tokenizer/token": "^0.3.0"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
-    "@types/chai": "^5.0.1",
-    "@types/chai-as-promised": "^8.0.1",
+    "@types/chai": "^5.2.2",
+    "@types/chai-as-promised": "^8.0.2",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.13.8",
+    "@types/node": "^22.15.21",
     "c8": "^10.1.3",
     "chai": "^5.2.0",
     "chai-as-promised": "^8.0.1",
     "del-cli": "^6.0.0",
-    "mocha": "^11.1.0",
+    "mocha": "^11.5.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.8.2",
+    "typescript": "^5.8.3",
     "uint8array-extras": "^1.4.0"
   },
   "keywords": [
@@ -89,5 +88,5 @@
     "stream",
     "streaming"
   ],
-  "packageManager": "yarn@4.6.0"
+  "packageManager": "yarn@4.9.1"
 }