njs-modbus 3.1.1 → 3.2.0

package/dist/src/utils/isUint8.d.ts

@@ -1,8 +0,0 @@
-/**
- * Returns true when `n` is an integer in the unsigned-byte range [0, 255].
- *
- * Used for byte-level Modbus payload validation (function-code values, raw
- * byte arrays in FC17/FC43 responses) — rejects negative, fractional, NaN,
- * Infinity, and out-of-range values uniformly.
- */
-export declare function isUint8(n: number): boolean;

package/dist/src/utils/lrc.d.ts

@@ -1 +0,0 @@
-export declare function lrc(data: Uint8Array): number;

package/dist/src/utils/predictRtuFrameLength.d.ts

@@ -1,17 +0,0 @@
-/** Sentinel: caller needs to feed more bytes before length can be determined. */
-export declare const PREDICT_NEED_MORE = 0;
-/** Sentinel: function code is not in the standard tables. */
-export declare const PREDICT_UNKNOWN = -1;
-/**
- * Predict the total RTU frame length (PDU + 2-byte CRC) given the leading bytes.
- *
- * Returns a sentinel-encoded number to avoid per-call object allocation on the
- * RTU decode hot path:
- * - Positive integer (>= 4): total frame length, function code is known.
- * - {@link PREDICT_NEED_MORE} (0): function code is known but more bytes are
- *   required (typically waiting on the byteCount byte).
- * - {@link PREDICT_UNKNOWN} (-1): function code is not in the standard tables —
- *   the framing layer must defer to a registered `CustomFunctionCode` or treat
- *   this as a framing error.
- */
-export declare function predictRtuFrameLength(buffer: Buffer, isResponse: boolean): number;

package/dist/src/utils/promisify-cb.d.ts

@@ -1,4 +0,0 @@
-/**
- * Convert a callback-style `(cb: (err?) => void) => void` call into a Promise.
- */
-export declare function promisifyCb(fn: (cb: (err?: Error | null) => void) => void): Promise<void>;

package/dist/src/utils/rtu-timing.d.ts

@@ -1,63 +0,0 @@
-/**
- * RTU timing parameter — accepts either:
- * - a bare `number` in milliseconds (`0` to disable the timer entirely)
- * - `{ unit: 'ms', value: N }` — explicit milliseconds (equivalent to bare `N`)
- * - `{ unit: 'bit', value: N }` — bit-time approximation, derived from `baudRate`
- *
- * The bare-number form is the recommended default; the object form exists for
- * specs that quote bit-time. Pass `0` (or `{ unit: 'ms', value: 0 }`) to disable
- * the timer; either form short-circuits the baudRate-derived fallback.
- */
-export type RtuTimingValue = number | {
-    unit: 'bit' | 'ms';
-    value: number;
-};
-/** User-facing RTU protocol options (supports both bit and ms units). */
-export interface RtuProtocolOptions {
-    /**
-     * Inter-frame silence (Modbus RTU t3.5).
-     *
-     * - `20` or `{ unit: 'ms', value: 20 }` — 20 ms
-     * - `{ unit: 'bit', value: 38.5 }` — spec bit-time approximation (default when `baudRate` is provided)
-     * - `0` — disable t3.5 timing (immediate parse on every chunk; useful for
-     *   lossless transports such as RTU-over-TCP or PTY-based tests where the
-     *   wire's silence semantics do not apply)
-     *
-     * Per Modbus V1.02 §2.5.1.1, at baud rates > 19200 a fixed 1.75 ms is used
-     * regardless of the bit value.
-     */
-    intervalBetweenFrames?: RtuTimingValue;
-    /**
-     * Inter-character timeout (Modbus RTU t1.5). Opt-in; **disabled** by default.
-     *
-     * - `1` or `{ unit: 'ms', value: 1 }` — 1 ms
-     * - `{ unit: 'bit', value: 21 }` — bit-time approximation (~1.5 char times)
-     * - `0` — disable explicitly
-     *
-     * Per Modbus V1.02 §2.5.1.1, at baud rates > 19200 a fixed 0.75 ms is used
-     * regardless of the bit value.
-     */
-    interCharTimeout?: RtuTimingValue;
-    /**
-     * Buffer pool size per connection (bytes). Defaults to `MAX_FRAME_LENGTH * 2`
-     * (512 bytes). Increase this if you expect frames larger than 256 bytes or
-     * heavy pipelining on a single connection.
-     */
-    poolSize?: number;
-}
-/** Resolved RTU timing values in milliseconds. */
-export interface ResolvedRtuTiming {
-    intervalBetweenFrames: number;
-    interCharTimeout: number;
-}
-/**
- * Resolve Modbus RTU timing parameters from user options into milliseconds.
- *
- * - `intervalBetweenFrames` (t3.5): if omitted and `baudRate` is present,
- *   defaults to 38.5 bits per Modbus V1.02 §2.5.1.1. Pass `0` to disable.
- * - `interCharTimeout` (t1.5): opt-in; only resolved when explicitly provided.
- *
- * Per the spec, at baud rates > 19200 fixed values are used
- * (1.75 ms for t3.5, 0.75 ms for t1.5) regardless of the bit value.
- */
-export declare function resolveRtuTiming(opts?: RtuProtocolOptions, baudRate?: number): ResolvedRtuTiming;

package/dist/src/utils/whitelist.d.ts

@@ -1,11 +0,0 @@
-/**
- * Normalize an IP address by stripping the IPv4-mapped IPv6 prefix.
- * This ensures consistent comparison of addresses like `::ffff:192.168.1.1`.
- */
-export declare function normalizeAddress(address?: string): string;
-/**
- * Check whether a remote address is allowed by the given whitelist.
- * IPv4-mapped IPv6 addresses are normalized before comparison.
- * Returns `true` when whitelist is absent or empty.
- */
-export declare function isWhitelisted(address: string | undefined, whitelist: string[] | undefined): boolean;

package/dist/src/vars.d.ts

@@ -1,49 +0,0 @@
-/**
- * Standard Modbus function codes (V1.1b3 §6).
- */
-export declare enum FunctionCode {
-    READ_COILS = 1,
-    READ_DISCRETE_INPUTS = 2,
-    READ_HOLDING_REGISTERS = 3,
-    READ_INPUT_REGISTERS = 4,
-    WRITE_SINGLE_COIL = 5,
-    WRITE_SINGLE_REGISTER = 6,
-    WRITE_MULTIPLE_COILS = 15,
-    WRITE_MULTIPLE_REGISTERS = 16,
-    REPORT_SERVER_ID = 17,
-    MASK_WRITE_REGISTER = 22,
-    READ_WRITE_MULTIPLE_REGISTERS = 23,
-    READ_DEVICE_IDENTIFICATION = 43
-}
-/** Exception response FC = request FC | EXCEPTION_OFFSET (V1.1b3 §7). */
-export declare const EXCEPTION_OFFSET = 128;
-/** Coil value encoding for FC 5 / FC 15 (V1.1b3 §6.5/§6.11). */
-export declare const COIL_ON = 65280;
-export declare const COIL_OFF = 0;
-/** FC 0x2B MEI sub-function selecting Read Device Identification (V1.1b3 §6.21). */
-export declare const MEI_READ_DEVICE_ID = 14;
-/** Read Device ID code values inside an FC 0x2B / MEI 0x0E request. */
-export declare enum ReadDeviceIDCode {
-    BASIC_STREAM = 1,
-    REGULAR_STREAM = 2,
-    EXTENDED_STREAM = 3,
-    SPECIFIC_ACCESS = 4
-}
-/** Conformity level reported in an FC 0x2B / MEI 0x0E response. */
-export declare enum ConformityLevel {
-    BASIC = 129,
-    REGULAR = 130,
-    EXTENDED = 131
-}
-/** Shared empty Buffer to avoid repeated allocations. */
-export declare const EMPTY_BUFFER: Buffer<ArrayBuffer>;
-/** Modbus V1.1b3 PDU quantity limits. */
-export declare const LIMITS: {
-    readonly READ_COILS_MIN: 1;
-    readonly READ_COILS_MAX: 2000;
-    readonly READ_REGISTERS_MIN: 1;
-    readonly READ_REGISTERS_MAX: 125;
-    readonly WRITE_COILS_MAX: 1968;
-    readonly WRITE_REGISTERS_MAX: 123;
-    readonly RW_REGISTERS_WRITE_MAX: 121;
-};