@ya-modbus/driver-sdk 0.4.1-refactor-scope-driver-packages.0

package/dist/errors.js

@@ -0,0 +1,20 @@
+/**
+ * Error formatting utilities for consistent validation error messages
+ */
+export function formatRangeError(name, ...args) {
+    if (args.length === 2) {
+        const [min, max] = args;
+        return `Invalid ${name}: must be between ${min} and ${max}`;
+    }
+    const [value, min, max] = args;
+    return `Invalid ${name}: received ${String(value)}, must be between ${min} and ${max}`;
+}
+export function formatEnumError(name, ...args) {
+    if (args.length === 1) {
+        const [values] = args;
+        return `Invalid ${name}: must be one of ${values.join(', ')}`;
+    }
+    const [value, values] = args;
+    return `Invalid ${name}: received ${String(value)}, must be one of ${values.join(', ')}`;
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAiCH,MAAM,UAAU,gBAAgB,CAC9B,IAAY,EACZ,GAAG,IAAkD;IAErD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;QACvB,OAAO,WAAW,IAAI,qBAAqB,GAAG,QAAQ,GAAG,EAAE,CAAA;IAC7D,CAAC;IACD,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IAC9B,OAAO,WAAW,IAAI,cAAc,MAAM,CAAC,KAAK,CAAC,qBAAqB,GAAG,QAAQ,GAAG,EAAE,CAAA;AACxF,CAAC;AA+BD,MAAM,UAAU,eAAe,CAC7B,IAAY,EACZ,GAAG,IAA0D;IAE7D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAA;QACrB,OAAO,WAAW,IAAI,oBAAoB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;IAC/D,CAAC;IACD,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;IAC5B,OAAO,WAAW,IAAI,cAAc,MAAM,CAAC,KAAK,CAAC,oBAAoB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;AAC1F,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Runtime SDK for ya-modbus device drivers
+ *
+ * Provides utilities for common driver development tasks:
+ * - Buffer encoding/decoding for scaled register values
+ * - Configuration validation with type narrowing
+ * - Consistent error message formatting
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   readScaledUInt16BE,
+ *   createEnumValidator,
+ *   formatEnumError,
+ * } from '@ya-modbus/driver-sdk'
+ *
+ * // Read scaled temperature value
+ * const buffer = await transport.readInputRegisters(1, 1)
+ * const temperature = readScaledUInt16BE(buffer, 0, 10)
+ *
+ * // Validate baud rate
+ * const isValidBaudRate = createEnumValidator([9600, 14400, 19200] as const)
+ * if (!isValidBaudRate(value)) {
+ *   throw new Error(formatEnumError('baud rate', [9600, 14400, 19200]))
+ * }
+ * ```
+ */
+export * from './codec.js';
+export * from './validators.js';
+export * from './errors.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAGH,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,32 @@
+/**
+ * Runtime SDK for ya-modbus device drivers
+ *
+ * Provides utilities for common driver development tasks:
+ * - Buffer encoding/decoding for scaled register values
+ * - Configuration validation with type narrowing
+ * - Consistent error message formatting
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   readScaledUInt16BE,
+ *   createEnumValidator,
+ *   formatEnumError,
+ * } from '@ya-modbus/driver-sdk'
+ *
+ * // Read scaled temperature value
+ * const buffer = await transport.readInputRegisters(1, 1)
+ * const temperature = readScaledUInt16BE(buffer, 0, 10)
+ *
+ * // Validate baud rate
+ * const isValidBaudRate = createEnumValidator([9600, 14400, 19200] as const)
+ * if (!isValidBaudRate(value)) {
+ *   throw new Error(formatEnumError('baud rate', [9600, 14400, 19200]))
+ * }
+ * ```
+ */
+// Re-export all utilities
+export * from './codec.js';
+export * from './validators.js';
+export * from './errors.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,0BAA0B;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA"}

package/dist/validators.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Validation utilities for driver configuration values
+ *
+ * These utilities provide type-safe validation with proper TypeScript
+ * type narrowing for common configuration values like baud rates,
+ * device addresses, and numeric ranges.
+ */
+/**
+ * Create a type-safe enum validator function
+ *
+ * Returns a type guard function that validates if a value is one of
+ * the allowed enum values. The returned function properly narrows
+ * TypeScript types.
+ *
+ * @param values - Readonly array of valid enum values
+ * @returns Type guard function that validates enum membership
+ *
+ * @example
+ * ```typescript
+ * import { createEnumValidator } from '@ya-modbus/driver-sdk'
+ *
+ * const VALID_BAUD_RATES = [9600, 14400, 19200] as const
+ * type ValidBaudRate = (typeof VALID_BAUD_RATES)[number]
+ *
+ * const isValidBaudRate = createEnumValidator(VALID_BAUD_RATES)
+ *
+ * if (isValidBaudRate(value)) {
+ *   // value is now typed as ValidBaudRate
+ *   const encoded = encodeBaudRate(value)
+ * }
+ * ```
+ */
+export declare function createEnumValidator<T extends readonly unknown[]>(values: T): (value: unknown) => value is T[number];
+/**
+ * Create a numeric range validator function
+ *
+ * Returns a function that validates if a value is a finite number
+ * within the specified range (inclusive).
+ *
+ * @param min - Minimum valid value (inclusive)
+ * @param max - Maximum valid value (inclusive)
+ * @returns Validator function that checks range membership
+ *
+ * @example
+ * ```typescript
+ * import { createRangeValidator } from '@ya-modbus/driver-sdk'
+ *
+ * const isValidAddress = createRangeValidator(1, 247)
+ *
+ * if (isValidAddress(value)) {
+ *   // value is a finite number between 1 and 247
+ *   await writeAddress(value)
+ * }
+ * ```
+ */
+export declare function createRangeValidator(min: number, max: number): (value: unknown) => value is number;
+/**
+ * Validate that a value is a finite integer
+ *
+ * Checks if a value is a number, finite, and has no fractional part.
+ *
+ * @param value - Value to validate
+ * @returns True if value is a finite integer
+ *
+ * @example
+ * ```typescript
+ * import { isValidInteger } from '@ya-modbus/driver-sdk'
+ *
+ * if (!isValidInteger(value)) {
+ *   throw new Error('Device address must be an integer')
+ * }
+ * ```
+ */
+export declare function isValidInteger(value: unknown): value is number;
+//# sourceMappingURL=validators.d.ts.map

package/dist/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,SAAS,OAAO,EAAE,EAC9D,MAAM,EAAE,CAAC,GACR,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAIxC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,MAAM,CAIrC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE9D"}

package/dist/validators.js

@@ -0,0 +1,85 @@
+/**
+ * Validation utilities for driver configuration values
+ *
+ * These utilities provide type-safe validation with proper TypeScript
+ * type narrowing for common configuration values like baud rates,
+ * device addresses, and numeric ranges.
+ */
+/**
+ * Create a type-safe enum validator function
+ *
+ * Returns a type guard function that validates if a value is one of
+ * the allowed enum values. The returned function properly narrows
+ * TypeScript types.
+ *
+ * @param values - Readonly array of valid enum values
+ * @returns Type guard function that validates enum membership
+ *
+ * @example
+ * ```typescript
+ * import { createEnumValidator } from '@ya-modbus/driver-sdk'
+ *
+ * const VALID_BAUD_RATES = [9600, 14400, 19200] as const
+ * type ValidBaudRate = (typeof VALID_BAUD_RATES)[number]
+ *
+ * const isValidBaudRate = createEnumValidator(VALID_BAUD_RATES)
+ *
+ * if (isValidBaudRate(value)) {
+ *   // value is now typed as ValidBaudRate
+ *   const encoded = encodeBaudRate(value)
+ * }
+ * ```
+ */
+export function createEnumValidator(values) {
+    return (value) => {
+        return values.includes(value);
+    };
+}
+/**
+ * Create a numeric range validator function
+ *
+ * Returns a function that validates if a value is a finite number
+ * within the specified range (inclusive).
+ *
+ * @param min - Minimum valid value (inclusive)
+ * @param max - Maximum valid value (inclusive)
+ * @returns Validator function that checks range membership
+ *
+ * @example
+ * ```typescript
+ * import { createRangeValidator } from '@ya-modbus/driver-sdk'
+ *
+ * const isValidAddress = createRangeValidator(1, 247)
+ *
+ * if (isValidAddress(value)) {
+ *   // value is a finite number between 1 and 247
+ *   await writeAddress(value)
+ * }
+ * ```
+ */
+export function createRangeValidator(min, max) {
+    return (value) => {
+        return typeof value === 'number' && Number.isFinite(value) && value >= min && value <= max;
+    };
+}
+/**
+ * Validate that a value is a finite integer
+ *
+ * Checks if a value is a number, finite, and has no fractional part.
+ *
+ * @param value - Value to validate
+ * @returns True if value is a finite integer
+ *
+ * @example
+ * ```typescript
+ * import { isValidInteger } from '@ya-modbus/driver-sdk'
+ *
+ * if (!isValidInteger(value)) {
+ *   throw new Error('Device address must be an integer')
+ * }
+ * ```
+ */
+export function isValidInteger(value) {
+    return typeof value === 'number' && Number.isFinite(value) && Number.isInteger(value);
+}
+//# sourceMappingURL=validators.js.map

package/dist/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAS;IAET,OAAO,CAAC,KAAc,EAAsB,EAAE;QAC5C,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAkB,CAAC,CAAA;IAC5C,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,oBAAoB,CAClC,GAAW,EACX,GAAW;IAEX,OAAO,CAAC,KAAc,EAAmB,EAAE;QACzC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,GAAG,IAAI,KAAK,IAAI,GAAG,CAAA;IAC5F,CAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;AACvF,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@ya-modbus/driver-sdk",
+  "version": "0.4.1-refactor-scope-driver-packages.0",
+  "description": "Runtime SDK for ya-modbus device drivers with transformation utilities and helpers",
+  "keywords": [
+    "modbus",
+    "driver",
+    "sdk",
+    "runtime"
+  ],
+  "author": "Geno Roupsky <geno@roupsky.name>",
+  "license": "GPL-3.0-or-later",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/groupsky/ya-modbus.git",
+    "directory": "packages/driver-sdk"
+  },
+  "homepage": "https://github.com/groupsky/ya-modbus/tree/main/packages/driver-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/groupsky/ya-modbus/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rm -rf dist",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@ya-modbus/driver-types": "^0.4.1-refactor-scope-driver-packages.0"
+  },
+  "gitHead": "b55d909d67dfff46fb79951e68a2d47ac3fab267"
+}