@ya-modbus/transport 0.7.3 → 0.8.0

package/dist/esm/src/index.js

@@ -9,6 +9,7 @@ export { createRTUTransport } from './rtu-transport.js';
 export { createTCPTransport } from './tcp-transport.js';
 export { createModbusTransport } from './create-modbus-transport.js';
 export { withRetry, MAX_RETRIES, RETRY_DELAY_MS } from './retry.js';
+export { normalizeModbusError } from './normalize-error.js';
 export { TransportManager } from './manager.js';
 export { MutexTransport } from './mutex-transport.js';
 export { SlaveTransport } from './slave-transport.js';

package/dist/esm/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,eAAe,EAAwB,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAkB,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,kBAAkB,EAAkB,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,cAAc,EAAoB,MAAM,YAAY,CAAA;AACrF,OAAO,EAAE,gBAAgB,EAAuB,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,eAAe,EAAwB,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAkB,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,kBAAkB,EAAkB,MAAM,oBAAoB,CAAA;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,cAAc,EAAoB,MAAM,YAAY,CAAA;AACrF,OAAO,EAAE,oBAAoB,EAAoB,MAAM,sBAAsB,CAAA;AAC7E,OAAO,EAAE,gBAAgB,EAAuB,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA"}

package/dist/esm/src/normalize-error.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Error normalization for modbus-serial failures
+ */
+/**
+ * Error with the diagnostic properties that modbus-serial attaches to failures
+ */
+export interface ModbusError extends Error {
+    /** Node.js error code (e.g., 'ECONNREFUSED' from a TCP socket) */
+    code?: string | undefined;
+    /** Error number or name (e.g., 'ETIMEDOUT' for a response timeout, -111 from a TCP socket) */
+    errno?: string | number | undefined;
+    /** Modbus exception code returned by the device (e.g., 2 = illegal data address) */
+    modbusCode?: number | undefined;
+}
+/**
+ * Convert anything thrown by modbus-serial into an Error
+ *
+ * modbus-serial rejects with plain objects that do not extend Error
+ * (e.g., `{ name: 'TransactionTimedOutError', message: 'Timed out', errno: 'ETIMEDOUT' }`).
+ * Converting them with `String()` gives "[object Object]" and loses errno.
+ * This keeps message, name, errno, code and modbusCode, and sets the original
+ * value as `cause`. Error instances are returned unchanged.
+ *
+ * @param error - Value that was thrown or used to reject a promise
+ * @returns Error instance with the diagnostic properties of the original
+ */
+export declare function normalizeModbusError(error: unknown): ModbusError;
+//# sourceMappingURL=normalize-error.d.ts.map

package/dist/esm/src/normalize-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-error.d.ts","sourceRoot":"","sources":["../../../src/normalize-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,KAAK;IACxC,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;IACnC,oFAAoF;IACpF,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAChC;AAMD;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,WAAW,CAkChE"}

package/dist/esm/src/normalize-error.js

@@ -0,0 +1,44 @@
+/**
+ * Error normalization for modbus-serial failures
+ */
+function nonEmptyString(value) {
+    return typeof value === 'string' && value !== '' ? value : undefined;
+}
+/**
+ * Convert anything thrown by modbus-serial into an Error
+ *
+ * modbus-serial rejects with plain objects that do not extend Error
+ * (e.g., `{ name: 'TransactionTimedOutError', message: 'Timed out', errno: 'ETIMEDOUT' }`).
+ * Converting them with `String()` gives "[object Object]" and loses errno.
+ * This keeps message, name, errno, code and modbusCode, and sets the original
+ * value as `cause`. Error instances are returned unchanged.
+ *
+ * @param error - Value that was thrown or used to reject a promise
+ * @returns Error instance with the diagnostic properties of the original
+ */
+export function normalizeModbusError(error) {
+    if (error instanceof Error) {
+        return error;
+    }
+    if (typeof error !== 'object' || error === null) {
+        return new Error(String(error), { cause: error });
+    }
+    const fields = error;
+    const name = nonEmptyString(fields.name);
+    const code = nonEmptyString(fields.code);
+    const errno = typeof fields.errno === 'string' || typeof fields.errno === 'number' ? fields.errno : undefined;
+    const modbusCode = typeof fields.modbusCode === 'number' ? fields.modbusCode : undefined;
+    const normalized = new Error(nonEmptyString(fields.message) ??
+        code ??
+        (errno === undefined ? 'Unknown error' : String(errno)), { cause: error });
+    if (name !== undefined)
+        normalized.name = name;
+    if (code !== undefined)
+        normalized.code = code;
+    if (errno !== undefined)
+        normalized.errno = errno;
+    if (modbusCode !== undefined)
+        normalized.modbusCode = modbusCode;
+    return normalized;
+}
+//# sourceMappingURL=normalize-error.js.map

package/dist/esm/src/normalize-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-error.js","sourceRoot":"","sources":["../../../src/normalize-error.ts"],"names":[],"mappings":"AAAA;;GAEG;AAcH,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;AACtE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,MAAM,GAAG,KAMd,CAAA;IACD,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACxC,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACxC,MAAM,KAAK,GACT,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IACjG,MAAM,UAAU,GAAG,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAA;IAExF,MAAM,UAAU,GAAgB,IAAI,KAAK,CACvC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC;QAC5B,IAAI;QACJ,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EACzD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAA;IACD,IAAI,IAAI,KAAK,SAAS;QAAE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAA;IAC9C,IAAI,IAAI,KAAK,SAAS;QAAE,UAAU,CAAC,IAAI,GAAG,IAAI,CAAA;IAC9C,IAAI,KAAK,KAAK,SAAS;QAAE,UAAU,CAAC,KAAK,GAAG,KAAK,CAAA;IACjD,IAAI,UAAU,KAAK,SAAS;QAAE,UAAU,CAAC,UAAU,GAAG,UAAU,CAAA;IAEhE,OAAO,UAAU,CAAA;AACnB,CAAC"}

package/dist/esm/src/retry.d.ts

@@ -1,6 +1,7 @@
 /**
  * Retry configuration and utilities for Modbus transport operations
  */
+import { type ModbusError } from './normalize-error.js';
 /** Maximum number of retry attempts for failed operations */
 export declare const MAX_RETRIES = 3;
 /** Delay between retry attempts in milliseconds */
@@ -11,7 +12,7 @@ export declare const RETRY_DELAY_MS = 100;
  * @param attempt - The attempt number (1-indexed)
  * @param error - The error that caused the retry
  */
-export type RetryLogger = (attempt: number, error: Error) => void;
+export type RetryLogger = (attempt: number, error: ModbusError) => void;
 /**
  * Retry a function with fixed delay between attempts
  *
@@ -19,7 +20,8 @@ export type RetryLogger = (attempt: number, error: Error) => void;
  * @param maxRetries - Maximum number of attempts (default: MAX_RETRIES)
  * @param logger - Optional callback to log retry attempts
  * @returns Promise resolving to the function's return value
- * @throws The last error encountered if all retries are exhausted
+ * @throws The last error encountered if all retries are exhausted, as an Error
+ *   with the diagnostic properties of the original (see normalizeModbusError)
  */
 export declare function withRetry<T>(fn: () => Promise<T>, maxRetries?: number, logger?: RetryLogger): Promise<T>;
 //# sourceMappingURL=retry.d.ts.map

package/dist/esm/src/retry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"retry.d.ts","sourceRoot":"","sources":["../../../src/retry.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,6DAA6D;AAC7D,eAAO,MAAM,WAAW,IAAI,CAAA;AAE5B,mDAAmD;AACnD,eAAO,MAAM,cAAc,MAAM,CAAA;AAYjC;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;AAEjE;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACpB,UAAU,GAAE,MAAoB,EAChC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,CAAC,CAAC,CAqBZ"}
+{"version":3,"file":"retry.d.ts","sourceRoot":"","sources":["../../../src/retry.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAwB,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAE7E,6DAA6D;AAC7D,eAAO,MAAM,WAAW,IAAI,CAAA;AAE5B,mDAAmD;AACnD,eAAO,MAAM,cAAc,MAAM,CAAA;AAYjC;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;AAEvE;;;;;;;;;GASG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACpB,UAAU,GAAE,MAAoB,EAChC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,CAAC,CAAC,CAqBZ"}

package/dist/esm/src/retry.js

@@ -1,6 +1,7 @@
 /**
  * Retry configuration and utilities for Modbus transport operations
  */
+import { normalizeModbusError } from './normalize-error.js';
 /** Maximum number of retry attempts for failed operations */
 export const MAX_RETRIES = 3;
 /** Delay between retry attempts in milliseconds */
@@ -21,7 +22,8 @@ function sleep(ms) {
  * @param maxRetries - Maximum number of attempts (default: MAX_RETRIES)
  * @param logger - Optional callback to log retry attempts
  * @returns Promise resolving to the function's return value
- * @throws The last error encountered if all retries are exhausted
+ * @throws The last error encountered if all retries are exhausted, as an Error
+ *   with the diagnostic properties of the original (see normalizeModbusError)
  */
 export async function withRetry(fn, maxRetries = MAX_RETRIES, logger) {
     let lastError = new Error('No retry attempts were made');
@@ -30,7 +32,7 @@ export async function withRetry(fn, maxRetries = MAX_RETRIES, logger) {
             return await fn();
         }
         catch (error) {
-            lastError = error instanceof Error ? error : new Error(String(error));
+            lastError = normalizeModbusError(error);
             // Don't retry on the last attempt
             if (attempt < maxRetries) {
                 // Log the retry attempt if logger is provided

package/dist/esm/src/retry.js.map

@@ -1 +1 @@
-{"version":3,"file":"retry.js","sourceRoot":"","sources":["../../../src/retry.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,6DAA6D;AAC7D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAA;AAE5B,mDAAmD;AACnD,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,CAAA;AAEjC;;;;;GAKG;AACH,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;AAC1D,CAAC;AAUD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,EAAoB,EACpB,aAAqB,WAAW,EAChC,MAAoB;IAEpB,IAAI,SAAS,GAAU,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;IAE/D,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,EAAE,CAAA;QACnB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,SAAS,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;YAErE,kCAAkC;YAClC,IAAI,OAAO,GAAG,UAAU,EAAE,CAAC;gBACzB,8CAA8C;gBAC9C,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;gBAC5B,CAAC;gBACD,MAAM,KAAK,CAAC,cAAc,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,SAAS,CAAA;AACjB,CAAC"}
+{"version":3,"file":"retry.js","sourceRoot":"","sources":["../../../src/retry.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAoB,MAAM,sBAAsB,CAAA;AAE7E,6DAA6D;AAC7D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAA;AAE5B,mDAAmD;AACnD,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,CAAA;AAEjC;;;;;GAKG;AACH,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;AAC1D,CAAC;AAUD;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,EAAoB,EACpB,aAAqB,WAAW,EAChC,MAAoB;IAEpB,IAAI,SAAS,GAAgB,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;IAErE,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,EAAE,CAAA;QACnB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,SAAS,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAA;YAEvC,kCAAkC;YAClC,IAAI,OAAO,GAAG,UAAU,EAAE,CAAC;gBACzB,8CAA8C;gBAC9C,IAAI,MAAM,EAAE,CAAC;oBACX,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;gBAC5B,CAAC;gBACD,MAAM,KAAK,CAAC,cAAc,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,SAAS,CAAA;AACjB,CAAC"}