@ya-modbus/driver-loader 0.8.0 → 0.8.1

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.8.1](https://github.com/groupsky/ya-modbus/compare/@ya-modbus/driver-loader@0.8.0...@ya-modbus/driver-loader@0.8.1) (2026-10-12)
+
+### Bug Fixes
+
+- **cli:** read CLI versions from package.json in ESM and CJS builds ([#539](https://github.com/groupsky/ya-modbus/issues/539)) ([f3275f3](https://github.com/groupsky/ya-modbus/commit/f3275f3ab3c0f4019304ca7abb0f0fdecc6faf11)), closes [#256](https://github.com/groupsky/ya-modbus/issues/256)
+
 # [0.8.0](https://github.com/groupsky/ya-modbus/compare/@ya-modbus/driver-loader@0.7.2...@ya-modbus/driver-loader@0.8.0) (2026-10-12)
 
 - feat!: drop Node.js 20 support (#516) ([70002ab](https://github.com/groupsky/ya-modbus/commit/70002ab28155432e0984c67a70d1469fc5be7cb3)), closes [#516](https://github.com/groupsky/ya-modbus/issues/516)

package/README.md

@@ -167,6 +167,31 @@ await loadDriver({ driverPackage: 'my-driver' })
 console.log(getDriverCacheStats()) // { hits: 1, misses: 1, size: 1 }
 ```
 
+### `getCallerPackageInfo(): PackageInfo`
+
+Returns the `version` and `description` from the package.json of the package that contains the calling module. CLIs use it to report their own version without hardcoding it.
+
+It finds the caller from the call stack, so it works the same in the ESM and CommonJS builds of a package.
+
+It does not work when the caller and driver-loader are bundled into one file, because both then appear as the same file on the call stack.
+
+**Returns:**
+
+- `PackageInfo` object containing:
+  - `version`: Version from the closest package.json that has one
+  - `description`: Description from that package.json (empty string if missing)
+
+**Throws:**
+
+- Error if the calling module cannot be determined
+- Error if no package.json with a version is found above the calling module
+
+```typescript
+import { getCallerPackageInfo } from '@ya-modbus/driver-loader'
+
+program.version(getCallerPackageInfo().version)
+```
+
 ## Testing Utilities
 
 The package provides testing utilities for applications using driver-loader.

package/dist/cjs/src/index.d.ts

@@ -2,4 +2,6 @@ export { loadDriver, clearDriverCache, getDriverCacheStats } from './loader.js';
 export type { LoadedDriver, LoadDriverOptions, SystemDependencies, DriverCacheStats, Logger, } from './loader.js';
 export { validateDefaultConfig, validateSupportedConfig, validateDevices, crossValidateConfigs, } from './config-validator.js';
 export { ValidationError, DriverNotFoundError, PackageJsonError } from './errors.js';
+export { getCallerPackageInfo } from './package-info.js';
+export type { PackageInfo } from './package-info.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAC/E,YAAY,EACV,YAAY,EACZ,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,MAAM,GACP,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,oBAAoB,GACrB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAC/E,YAAY,EACV,YAAY,EACZ,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,MAAM,GACP,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,oBAAoB,GACrB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AACpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AACxD,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/cjs/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PackageJsonError = exports.DriverNotFoundError = exports.ValidationError = exports.crossValidateConfigs = exports.validateDevices = exports.validateSupportedConfig = exports.validateDefaultConfig = exports.getDriverCacheStats = exports.clearDriverCache = exports.loadDriver = void 0;
+exports.getCallerPackageInfo = exports.PackageJsonError = exports.DriverNotFoundError = exports.ValidationError = exports.crossValidateConfigs = exports.validateDevices = exports.validateSupportedConfig = exports.validateDefaultConfig = exports.getDriverCacheStats = exports.clearDriverCache = exports.loadDriver = void 0;
 var loader_js_1 = require("./loader.js");
 Object.defineProperty(exports, "loadDriver", { enumerable: true, get: function () { return loader_js_1.loadDriver; } });
 Object.defineProperty(exports, "clearDriverCache", { enumerable: true, get: function () { return loader_js_1.clearDriverCache; } });
@@ -14,4 +14,6 @@ var errors_js_1 = require("./errors.js");
 Object.defineProperty(exports, "ValidationError", { enumerable: true, get: function () { return errors_js_1.ValidationError; } });
 Object.defineProperty(exports, "DriverNotFoundError", { enumerable: true, get: function () { return errors_js_1.DriverNotFoundError; } });
 Object.defineProperty(exports, "PackageJsonError", { enumerable: true, get: function () { return errors_js_1.PackageJsonError; } });
+var package_info_js_1 = require("./package-info.js");
+Object.defineProperty(exports, "getCallerPackageInfo", { enumerable: true, get: function () { return package_info_js_1.getCallerPackageInfo; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAA+E;AAAtE,uGAAA,UAAU,OAAA;AAAE,6GAAA,gBAAgB,OAAA;AAAE,gHAAA,mBAAmB,OAAA;AAQ1D,6DAK8B;AAJ5B,4HAAA,qBAAqB,OAAA;AACrB,8HAAA,uBAAuB,OAAA;AACvB,sHAAA,eAAe,OAAA;AACf,2HAAA,oBAAoB,OAAA;AAEtB,yCAAoF;AAA3E,4GAAA,eAAe,OAAA;AAAE,gHAAA,mBAAmB,OAAA;AAAE,6GAAA,gBAAgB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAA+E;AAAtE,uGAAA,UAAU,OAAA;AAAE,6GAAA,gBAAgB,OAAA;AAAE,gHAAA,mBAAmB,OAAA;AAQ1D,6DAK8B;AAJ5B,4HAAA,qBAAqB,OAAA;AACrB,8HAAA,uBAAuB,OAAA;AACvB,sHAAA,eAAe,OAAA;AACf,2HAAA,oBAAoB,OAAA;AAEtB,yCAAoF;AAA3E,4GAAA,eAAe,OAAA;AAAE,gHAAA,mBAAmB,OAAA;AAAE,6GAAA,gBAAgB,OAAA;AAC/D,qDAAwD;AAA/C,uHAAA,oBAAoB,OAAA"}

package/dist/cjs/src/package-info.d.ts

@@ -0,0 +1,43 @@
+export interface PackageInfo {
+    version: string;
+    description: string;
+}
+type ReadTextFile = (path: string) => string;
+/**
+ * Read the version and description from the closest package.json above a file
+ *
+ * package.json files without a version are skipped. This passes over the
+ * `{"type": "module"}` and `{"type": "commonjs"}` markers in `dist/esm` and `dist/cjs`.
+ *
+ * @param file - Path or `file:` URL of a module inside the package
+ * @param readFile - Reads a file as text and throws if it does not exist (replaceable in tests)
+ * @throws Error if no package.json with a version is found
+ */
+export declare function readPackageInfo(file: string, readFile?: ReadTextFile): PackageInfo;
+/**
+ * Pick the calling module from the file names of a stack, innermost first
+ *
+ * The first frame is this module. The caller is the first frame from another file that is a
+ * real module path or `file:` URL, which skips frames such as `node:internal/timers`.
+ *
+ * @throws Error if the stack has no such frame
+ */
+export declare function findCallerFile(files: ReadonlyArray<string | undefined>): string;
+/**
+ * Get the version and description of the package that contains the calling module
+ *
+ * Lets a CLI report its own package.json values without hardcoding them. The caller's
+ * location comes from the call stack, so it works the same in ES module and CommonJS
+ * builds, where `import.meta.url` and `__dirname` are each available in only one.
+ *
+ * @example
+ * ```typescript
+ * const { version } = getCallerPackageInfo()
+ * program.version(version)
+ * ```
+ *
+ * @throws Error if the calling module cannot be determined or has no package.json with a version
+ */
+export declare function getCallerPackageInfo(): PackageInfo;
+export {};
+//# sourceMappingURL=package-info.d.ts.map

package/dist/cjs/src/package-info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-info.d.ts","sourceRoot":"","sources":["../../../src/package-info.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;CACpB;AAwBD,KAAK,YAAY,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;AAiB5C;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,GAAE,YAA2B,GAAG,WAAW,CAehG;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,MAAM,CAY/E;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,oBAAoB,IAAI,WAAW,CAIlD"}

package/dist/cjs/src/package-info.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readPackageInfo = readPackageInfo;
+exports.findCallerFile = findCallerFile;
+exports.getCallerPackageInfo = getCallerPackageInfo;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const node_url_1 = require("node:url");
+const MIN_STACK_TRACE_LIMIT = 10;
+/**
+ * Call sites of the current stack, innermost first.
+ *
+ * V8 formats `stack` lazily, so it must be read while the formatter is replaced.
+ */
+function getCallSites() {
+    // eslint-disable-next-line @typescript-eslint/unbound-method -- only restored, never called
+    const originalPrepare = Error.prepareStackTrace;
+    const originalLimit = Error.stackTraceLimit;
+    try {
+        Error.prepareStackTrace = (_error, callSites) => callSites;
+        // An application can lower the limit so far that the caller is not on the stack
+        Error.stackTraceLimit = Math.max(originalLimit, MIN_STACK_TRACE_LIMIT);
+        return new Error().stack;
+    }
+    finally {
+        Error.prepareStackTrace = originalPrepare;
+        Error.stackTraceLimit = originalLimit;
+    }
+}
+const readUtf8File = (path) => (0, node_fs_1.readFileSync)(path, 'utf-8');
+function readPackageJson(path, readFile) {
+    let content;
+    try {
+        content = readFile(path);
+    }
+    catch {
+        return undefined;
+    }
+    return JSON.parse(content);
+}
+/**
+ * Read the version and description from the closest package.json above a file
+ *
+ * package.json files without a version are skipped. This passes over the
+ * `{"type": "module"}` and `{"type": "commonjs"}` markers in `dist/esm` and `dist/cjs`.
+ *
+ * @param file - Path or `file:` URL of a module inside the package
+ * @param readFile - Reads a file as text and throws if it does not exist (replaceable in tests)
+ * @throws Error if no package.json with a version is found
+ */
+function readPackageInfo(file, readFile = readUtf8File) {
+    const path = file.startsWith('file:') ? (0, node_url_1.fileURLToPath)(file) : file;
+    for (let dir = (0, node_path_1.dirname)(path);; dir = (0, node_path_1.dirname)(dir)) {
+        const packageJson = readPackageJson((0, node_path_1.join)(dir, 'package.json'), readFile);
+        if (typeof packageJson?.version === 'string') {
+            return {
+                version: packageJson.version,
+                description: typeof packageJson.description === 'string' ? packageJson.description : '',
+            };
+        }
+        if ((0, node_path_1.dirname)(dir) === dir) {
+            throw new Error(`No package.json with a version found for ${path}`);
+        }
+    }
+}
+/**
+ * Pick the calling module from the file names of a stack, innermost first
+ *
+ * The first frame is this module. The caller is the first frame from another file that is a
+ * real module path or `file:` URL, which skips frames such as `node:internal/timers`.
+ *
+ * @throws Error if the stack has no such frame
+ */
+function findCallerFile(files) {
+    const [ownFile] = files;
+    const callerFile = files.find((file) => file !== undefined && file !== ownFile && (file.startsWith('file:') || (0, node_path_1.isAbsolute)(file)));
+    if (callerFile === undefined) {
+        throw new Error('Cannot determine the calling module');
+    }
+    return callerFile;
+}
+/**
+ * Get the version and description of the package that contains the calling module
+ *
+ * Lets a CLI report its own package.json values without hardcoding them. The caller's
+ * location comes from the call stack, so it works the same in ES module and CommonJS
+ * builds, where `import.meta.url` and `__dirname` are each available in only one.
+ *
+ * @example
+ * ```typescript
+ * const { version } = getCallerPackageInfo()
+ * program.version(version)
+ * ```
+ *
+ * @throws Error if the calling module cannot be determined or has no package.json with a version
+ */
+function getCallerPackageInfo() {
+    const files = getCallSites().map((callSite) => callSite.getFileName() ?? undefined);
+    return readPackageInfo(findCallerFile(files));
+}
+//# sourceMappingURL=package-info.js.map

package/dist/cjs/src/package-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-info.js","sourceRoot":"","sources":["../../../src/package-info.ts"],"names":[],"mappings":";;AA0DA,0CAeC;AAUD,wCAYC;AAiBD,oDAIC;AApHD,qCAAsC;AACtC,yCAAqD;AACrD,uCAAwC;AAOxC,MAAM,qBAAqB,GAAG,EAAE,CAAA;AAEhC;;;;GAIG;AACH,SAAS,YAAY;IACnB,4FAA4F;IAC5F,MAAM,eAAe,GAAG,KAAK,CAAC,iBAAiB,CAAA;IAC/C,MAAM,aAAa,GAAG,KAAK,CAAC,eAAe,CAAA;IAC3C,IAAI,CAAC;QACH,KAAK,CAAC,iBAAiB,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,CAAA;QAC1D,gFAAgF;QAChF,KAAK,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,qBAAqB,CAAC,CAAA;QACtE,OAAO,IAAI,KAAK,EAAE,CAAC,KAAqC,CAAA;IAC1D,CAAC;YAAS,CAAC;QACT,KAAK,CAAC,iBAAiB,GAAG,eAAe,CAAA;QACzC,KAAK,CAAC,eAAe,GAAG,aAAa,CAAA;IACvC,CAAC;AACH,CAAC;AAID,MAAM,YAAY,GAAiB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,sBAAY,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;AAExE,SAAS,eAAe,CACtB,IAAY,EACZ,QAAsB;IAEtB,IAAI,OAAe,CAAA;IACnB,IAAI,CAAC;QACH,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAgD,CAAA;AAC3E,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,eAAe,CAAC,IAAY,EAAE,WAAyB,YAAY;IACjF,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAElE,KAAK,IAAI,GAAG,GAAG,IAAA,mBAAO,EAAC,IAAI,CAAC,GAAI,GAAG,GAAG,IAAA,mBAAO,EAAC,GAAG,CAAC,EAAE,CAAC;QACnD,MAAM,WAAW,GAAG,eAAe,CAAC,IAAA,gBAAI,EAAC,GAAG,EAAE,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAA;QACxE,IAAI,OAAO,WAAW,EAAE,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC7C,OAAO;gBACL,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,WAAW,EAAE,OAAO,WAAW,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;aACxF,CAAA;QACH,CAAC;QACD,IAAI,IAAA,mBAAO,EAAC,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,4CAA4C,IAAI,EAAE,CAAC,CAAA;QACrE,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,KAAwC;IACrE,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAA;IACvB,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAC3B,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,IAAA,sBAAU,EAAC,IAAI,CAAC,CAAC,CAC3F,CAAA;IAED,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,oBAAoB;IAClC,MAAM,KAAK,GAAG,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,SAAS,CAAC,CAAA;IAEnF,OAAO,eAAe,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAA;AAC/C,CAAC"}