serial-core 0.2.4 → 0.3.0

package/dist/core/QueueManager.d.ts

@@ -1,68 +0,0 @@
-/**
- * QueueManager acts as an intermediate buffer.
- * It prevents serial port saturation and guarantees messages
- * leave in the order they arrived (FIFO).
- */
-export declare class QueueManager {
-    private queue;
-    private isProcessing;
-    private _currentAlias;
-    private waitingForResponse;
-    private currentTimeoutTimer;
-    private currentItem;
-    private writeHandler;
-    /**
-     * Initializes the QueueManager with a write handler function.
-     * @param writeHandler - Function to execute when writing data to the port
-     */
-    constructor(writeHandler: (data: Buffer | string) => Promise<void>);
-    /**
-     * Adds a command to the queue and returns a promise that resolves when processed.
-     * @param data - The data to queue (string or Buffer)
-     * @param options - Optional queue item configuration
-     * @param options.alias - Command identifier for response correlation
-     * @param options.timeout - Maximum time to wait for operation/response in milliseconds
-     * @param options.waitResponse - If true, block queue until response is received
-     * @returns Promise that resolves when the command has been processed
-     */
-    add(data: Buffer | string, options?: {
-        alias?: string;
-        timeout?: number;
-        waitResponse?: boolean;
-    }): Promise<void>;
-    /**
-     * Gets the alias of the command currently processing or just processed.
-     * Useful for correlating received responses with sent commands.
-     * @returns The alias of the current command, or undefined if none
-     */
-    get currentAlias(): string | undefined;
-    /**
-     * Clears all pending items from the queue.
-     * Useful when handling abrupt disconnections.
-     * All pending items will be rejected with a disconnection error.
-     */
-    clear(): void;
-    /**
-     * Notifies the queue that a response has been received.
-     * If waiting for a response, this triggers resolution of the current command
-     * and processes the next item in the queue.
-     */
-    notifyResponse(): void;
-    /**
-     * Processes the queue recursively, executing items one by one.
-     * Handles timeouts and response waiting when configured.
-     * @private
-     */
-    private process;
-    /**
-     * Handles timeout when waiting for a response to a sent command.
-     * @private
-     * @param item - The queue item that timed out
-     */
-    private handleResponseTimeout;
-    /**
-     * Checks if the queue is idle (no pending items, not processing, not waiting for response).
-     * @returns True if the queue has no pending operations
-     */
-    isIdle(): boolean;
-}

package/dist/types.d.cts

@@ -1,42 +0,0 @@
-export declare const SerialStatus: {
-    readonly DISCONNECTED: "DISCONNECTED";
-    readonly SCANNING: "SCANNING";
-    readonly CONNECTING: "CONNECTING";
-    readonly CONNECTED: "CONNECTED";
-    readonly RECONNECTING: "RECONNECTING";
-};
-export type SerialStatus = (typeof SerialStatus)[keyof typeof SerialStatus];
-export interface SerialConfig {
-    baudRate: number;
-    path?: string;
-    vendorId?: string;
-    productId?: string;
-    reconnectInterval: number;
-    autoConnect: boolean;
-    parser?: NodeJS.ReadWriteStream;
-    handshake?: {
-        command: string | Buffer;
-        pattern: string | RegExp;
-        timeout: number;
-        hexPattern?: boolean;
-        callback?: ((data: Buffer | string) => boolean) | null;
-    };
-}
-export interface QueueItem {
-    data: Buffer | string;
-    alias?: string;
-    timeout?: number;
-    waitResponse?: boolean;
-    resolve: () => void;
-    reject: (err: Error) => void;
-}
-export interface SerialEvents {
-    status: (status: SerialStatus) => void;
-    data: (data: Buffer | string, alias?: string) => void;
-    error: (err: Error) => void;
-    connected: (info: {
-        path: string;
-        baudRate: number;
-    }) => void;
-    disconnected: (reason: string) => void;
-}

package/dist/types.d.ts

@@ -1,42 +0,0 @@
-export declare const SerialStatus: {
-    readonly DISCONNECTED: "DISCONNECTED";
-    readonly SCANNING: "SCANNING";
-    readonly CONNECTING: "CONNECTING";
-    readonly CONNECTED: "CONNECTED";
-    readonly RECONNECTING: "RECONNECTING";
-};
-export type SerialStatus = (typeof SerialStatus)[keyof typeof SerialStatus];
-export interface SerialConfig {
-    baudRate: number;
-    path?: string;
-    vendorId?: string;
-    productId?: string;
-    reconnectInterval: number;
-    autoConnect: boolean;
-    parser?: NodeJS.ReadWriteStream;
-    handshake?: {
-        command: string | Buffer;
-        pattern: string | RegExp;
-        timeout: number;
-        hexPattern?: boolean;
-        callback?: ((data: Buffer | string) => boolean) | null;
-    };
-}
-export interface QueueItem {
-    data: Buffer | string;
-    alias?: string;
-    timeout?: number;
-    waitResponse?: boolean;
-    resolve: () => void;
-    reject: (err: Error) => void;
-}
-export interface SerialEvents {
-    status: (status: SerialStatus) => void;
-    data: (data: Buffer | string, alias?: string) => void;
-    error: (err: Error) => void;
-    connected: (info: {
-        path: string;
-        baudRate: number;
-    }) => void;
-    disconnected: (reason: string) => void;
-}

package/dist/utils/buffers.d.cts

@@ -1,39 +0,0 @@
-/**
- * Optimized helpers for Buffer operations.
- * Designed to minimize unnecessary copies and validations where possible.
- */
-/**
- * Efficiently converts various input types to Buffer.
- * If input is already a Buffer, returns it as is (zero-copy).
- * @param data - The data to convert (string, number array, Uint8Array, or Buffer)
- * @returns A Buffer instance
- */
-export declare function toBuffer(data: string | number[] | Uint8Array | Buffer): Buffer;
-/**
- * Converts a Buffer to Uint8Array.
- * In Node.js, Buffers ARE Uint8Arrays, so this is ideally zero-copy.
- * @param buf - The buffer to convert
- * @returns The buffer as a Uint8Array
- */
-export declare function toUint8Array(buf: Buffer): Uint8Array;
-/**
- * Converts a Buffer to string with optional encoding (default utf8).
- * Wrapper alias for toString().
- * @param buf - The buffer to convert
- * @param encoding - The character encoding to use (default: 'utf8')
- * @returns The buffer contents as a string
- */
-export declare function toString(buf: Buffer, encoding?: BufferEncoding): string;
-/**
- * Converts a Buffer to ASCII string representation.
- * @param buf - The buffer to convert
- * @returns The buffer contents as an ASCII string
- */
-export declare function toAscii(buf: Buffer): string;
-/**
- * Converts a Buffer to an array of byte values.
- * Note: Using spread operator may be slow for very large buffers.
- * @param buf - The buffer to convert
- * @returns An array of numbers representing each byte
- */
-export declare function toArray(buf: Buffer): number[];

package/dist/utils/buffers.d.ts

@@ -1,39 +0,0 @@
-/**
- * Optimized helpers for Buffer operations.
- * Designed to minimize unnecessary copies and validations where possible.
- */
-/**
- * Efficiently converts various input types to Buffer.
- * If input is already a Buffer, returns it as is (zero-copy).
- * @param data - The data to convert (string, number array, Uint8Array, or Buffer)
- * @returns A Buffer instance
- */
-export declare function toBuffer(data: string | number[] | Uint8Array | Buffer): Buffer;
-/**
- * Converts a Buffer to Uint8Array.
- * In Node.js, Buffers ARE Uint8Arrays, so this is ideally zero-copy.
- * @param buf - The buffer to convert
- * @returns The buffer as a Uint8Array
- */
-export declare function toUint8Array(buf: Buffer): Uint8Array;
-/**
- * Converts a Buffer to string with optional encoding (default utf8).
- * Wrapper alias for toString().
- * @param buf - The buffer to convert
- * @param encoding - The character encoding to use (default: 'utf8')
- * @returns The buffer contents as a string
- */
-export declare function toString(buf: Buffer, encoding?: BufferEncoding): string;
-/**
- * Converts a Buffer to ASCII string representation.
- * @param buf - The buffer to convert
- * @returns The buffer contents as an ASCII string
- */
-export declare function toAscii(buf: Buffer): string;
-/**
- * Converts a Buffer to an array of byte values.
- * Note: Using spread operator may be slow for very large buffers.
- * @param buf - The buffer to convert
- * @returns An array of numbers representing each byte
- */
-export declare function toArray(buf: Buffer): number[];