@ya-modbus/driver-loader 0.9.0 → 0.11.0

package/dist/esm/src/local-package.d.ts

@@ -0,0 +1,19 @@
+import type { SystemDependencies } from './loader.js';
+/**
+ * A driver package found in the current directory
+ */
+export interface LocalPackage {
+    /** Name from package.json */
+    name: string;
+    /** Absolute path of the file that importing the package loads */
+    entryPoint: string;
+}
+/**
+ * Auto-detect local driver package from package.json
+ *
+ * @param deps - System dependencies
+ * @returns Package name and entry file if valid driver package
+ * @throws Error if not a valid driver package
+ */
+export declare function detectLocalPackage(deps: Pick<SystemDependencies, 'getCwd' | 'readFile'>): Promise<LocalPackage>;
+//# sourceMappingURL=local-package.d.ts.map

package/dist/esm/src/local-package.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-package.d.ts","sourceRoot":"","sources":["../../../src/local-package.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAErD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,GAAG,UAAU,CAAC,GACpD,OAAO,CAAC,YAAY,CAAC,CAkDvB"}

package/dist/esm/src/local-package.js

@@ -0,0 +1,47 @@
+import { extname, join } from 'node:path';
+import { resolvePackageEntry } from './entry-point.js';
+import { PackageJsonError } from './errors.js';
+/**
+ * Auto-detect local driver package from package.json
+ *
+ * @param deps - System dependencies
+ * @returns Package name and entry file if valid driver package
+ * @throws Error if not a valid driver package
+ */
+export async function detectLocalPackage(deps) {
+    try {
+        const cwd = deps.getCwd();
+        const packageJsonContent = await deps.readFile(join(cwd, 'package.json'), 'utf-8');
+        const packageJson = JSON.parse(packageJsonContent);
+        const keywords = packageJson.keywords ?? [];
+        if (!keywords.includes('ya-modbus-driver')) {
+            throw new PackageJsonError('Current package is not a ya-modbus driver. ' +
+                'Add "ya-modbus-driver" to keywords in package.json');
+        }
+        const name = packageJson.name;
+        if (!name) {
+            throw new PackageJsonError('package.json must have a "name" field');
+        }
+        const entry = resolvePackageEntry(packageJson);
+        if (entry === undefined) {
+            throw new PackageJsonError('package.json "exports" has no entry for "." that can be imported. ' +
+                'Add an "import" or "default" condition to exports["."]');
+        }
+        if (extname(entry) === '') {
+            throw new PackageJsonError(`The entry point "${entry}" in package.json has no file extension. ` +
+                'Name the built file, for example "./dist/index.js"');
+        }
+        return { name, entryPoint: join(cwd, entry) };
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            throw new PackageJsonError('package.json not found in current directory. ' +
+                'Run this command from a driver package directory or specify --driver');
+        }
+        if (error instanceof SyntaxError) {
+            throw new PackageJsonError('Failed to parse package.json: invalid JSON');
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=local-package.js.map

package/dist/esm/src/local-package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-package.js","sourceRoot":"","sources":["../../../src/local-package.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAEzC,OAAO,EAAE,mBAAmB,EAA2B,MAAM,kBAAkB,CAAA;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAa9C;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,IAAqD;IAErD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;QACzB,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE,OAAO,CAAC,CAAA;QAClF,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAGhD,CAAA;QAED,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,IAAI,EAAE,CAAA;QAC3C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,gBAAgB,CACxB,6CAA6C;gBAC3C,oDAAoD,CACvD,CAAA;QACH,CAAC;QAED,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAA;QAC7B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,gBAAgB,CAAC,uCAAuC,CAAC,CAAA;QACrE,CAAC;QAED,MAAM,KAAK,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAA;QAC9C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,gBAAgB,CACxB,oEAAoE;gBAClE,wDAAwD,CAC3D,CAAA;QACH,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;YAC1B,MAAM,IAAI,gBAAgB,CACxB,oBAAoB,KAAK,2CAA2C;gBAClE,oDAAoD,CACvD,CAAA;QACH,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAA;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAK,KAA+B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvD,MAAM,IAAI,gBAAgB,CACxB,+CAA+C;gBAC7C,sEAAsE,CACzE,CAAA;QACH,CAAC;QACD,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,IAAI,gBAAgB,CAAC,4CAA4C,CAAC,CAAA;QAC1E,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC"}

package/dist/esm/src/module-errors.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Check if an import failed because the package itself is not installed
+ *
+ * A package that is installed but fails to load (syntax error, missing dependency)
+ * is not reported as missing, so the real problem is not hidden by a later candidate.
+ * Node names the package in quotes, in both the ESM and the CommonJS wording.
+ */
+export declare function isMissingPackageError(error: unknown, packageName: string): boolean;
+/** Why a driver cannot be loaded as built JavaScript */
+export type NotBuiltCause = 
+/** A file of the driver is missing, such as the entry file when there is no `dist` directory */
+'missing-file'
+/** The driver is TypeScript source and Node does not run it, because it is too old or has type stripping off */
+ | 'typescript'
+/** Node strips types, but the TypeScript uses syntax or imports that type stripping cannot run */
+ | 'typescript-unsupported'
+/** Node does not run TypeScript from `node_modules` */
+ | 'typescript-in-node-modules';
+/**
+ * Find out if an import failed because the driver is not built
+ *
+ * A missing file counts when Node names it by its absolute path. A package that is not
+ * installed, or a missing dependency, is named by its package name, so neither matches.
+ * With `entryPoint` (a local driver) only the entry file itself counts. Another missing
+ * file of a built driver is a bug in the driver, which building does not fix, unless
+ * TypeScript source asks for it (importing `./x.js` when only `x.ts` exists).
+ *
+ * @param error - What the import threw
+ * @param entryPoint - Absolute path of the entry file, if it is known
+ * @returns The cause, or undefined if the error is about something else
+ */
+export declare function getNotBuiltCause(error: unknown, entryPoint?: string): NotBuiltCause | undefined;
+//# sourceMappingURL=module-errors.d.ts.map

package/dist/esm/src/module-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-errors.d.ts","sourceRoot":"","sources":["../../../src/module-errors.ts"],"names":[],"mappings":"AAaA;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAYlF;AAED,wDAAwD;AACxD,MAAM,MAAM,aAAa;AACvB,gGAAgG;AAC9F,cAAc;AAChB,gHAAgH;GAC9G,YAAY;AACd,kGAAkG;GAChG,wBAAwB;AAC1B,uDAAuD;GACrD,4BAA4B,CAAA;AAEhC;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAiC/F"}

package/dist/esm/src/module-errors.js

@@ -0,0 +1,73 @@
+const NOT_FOUND_CODES = new Set(['ERR_MODULE_NOT_FOUND', 'MODULE_NOT_FOUND']);
+/** Node does not know TypeScript files: too old, or type stripping is off */
+const UNKNOWN_TYPESCRIPT = /Unknown file extension "\.[cm]?ts"/;
+/**
+ * What Node could not find (a package name, or the absolute path of a file on POSIX or
+ * Windows), and the file that wanted it (not in the CommonJS wording)
+ */
+const MISSING_TARGET = /Cannot find (?:module|package) '([^']+)'(?: imported from ([^\n]+))?/;
+const ABSOLUTE_PATH = /^(?:[/\\]|[A-Za-z]:)/;
+const TYPESCRIPT_FILE = /\.[cm]?tsx?$/;
+/**
+ * Check if an import failed because the package itself is not installed
+ *
+ * A package that is installed but fails to load (syntax error, missing dependency)
+ * is not reported as missing, so the real problem is not hidden by a later candidate.
+ * Node names the package in quotes, in both the ESM and the CommonJS wording.
+ */
+export function isMissingPackageError(error, packageName) {
+    if (typeof error !== 'object' || error === null) {
+        return false;
+    }
+    const { code, message } = error;
+    return (typeof code === 'string' &&
+        NOT_FOUND_CODES.has(code) &&
+        typeof message === 'string' &&
+        message.includes(`'${packageName}'`));
+}
+/**
+ * Find out if an import failed because the driver is not built
+ *
+ * A missing file counts when Node names it by its absolute path. A package that is not
+ * installed, or a missing dependency, is named by its package name, so neither matches.
+ * With `entryPoint` (a local driver) only the entry file itself counts. Another missing
+ * file of a built driver is a bug in the driver, which building does not fix, unless
+ * TypeScript source asks for it (importing `./x.js` when only `x.ts` exists).
+ *
+ * @param error - What the import threw
+ * @param entryPoint - Absolute path of the entry file, if it is known
+ * @returns The cause, or undefined if the error is about something else
+ */
+export function getNotBuiltCause(error, entryPoint) {
+    if (typeof error !== 'object' || error === null) {
+        return undefined;
+    }
+    const { code, message } = error;
+    if (code === 'ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING') {
+        return 'typescript-in-node-modules';
+    }
+    if (code === 'ERR_UNSUPPORTED_TYPESCRIPT_SYNTAX') {
+        return 'typescript-unsupported';
+    }
+    if (typeof code !== 'string' || typeof message !== 'string') {
+        return undefined;
+    }
+    if (code === 'ERR_UNKNOWN_FILE_EXTENSION') {
+        if (!UNKNOWN_TYPESCRIPT.test(message)) {
+            return undefined;
+        }
+        return message.includes('node_modules') ? 'typescript-in-node-modules' : 'typescript';
+    }
+    if (!NOT_FOUND_CODES.has(code)) {
+        return undefined;
+    }
+    const [, missing, importer = ''] = MISSING_TARGET.exec(message) ?? [];
+    if (missing === undefined || !ABSOLUTE_PATH.test(missing)) {
+        return undefined;
+    }
+    if (TYPESCRIPT_FILE.test(importer)) {
+        return 'typescript-unsupported';
+    }
+    return entryPoint === undefined || missing === entryPoint ? 'missing-file' : undefined;
+}
+//# sourceMappingURL=module-errors.js.map

package/dist/esm/src/module-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-errors.js","sourceRoot":"","sources":["../../../src/module-errors.ts"],"names":[],"mappings":"AAAA,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAAC,CAAA;AAE7E,6EAA6E;AAC7E,MAAM,kBAAkB,GAAG,oCAAoC,CAAA;AAE/D;;;GAGG;AACH,MAAM,cAAc,GAAG,sEAAsE,CAAA;AAC7F,MAAM,aAAa,GAAG,sBAAsB,CAAA;AAC5C,MAAM,eAAe,GAAG,cAAc,CAAA;AAEtC;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAc,EAAE,WAAmB;IACvE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAA8C,CAAA;IACxE,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC;QACzB,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI,WAAW,GAAG,CAAC,CACrC,CAAA;AACH,CAAC;AAaD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc,EAAE,UAAmB;IAClE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAA8C,CAAA;IACxE,IAAI,IAAI,KAAK,6CAA6C,EAAE,CAAC;QAC3D,OAAO,4BAA4B,CAAA;IACrC,CAAC;IACD,IAAI,IAAI,KAAK,mCAAmC,EAAE,CAAC;QACjD,OAAO,wBAAwB,CAAA;IACjC,CAAC;IACD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC5D,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,IAAI,KAAK,4BAA4B,EAAE,CAAC;QAC1C,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACtC,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,OAAO,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,YAAY,CAAA;IACvF,CAAC;IACD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,EAAE,OAAO,EAAE,QAAQ,GAAG,EAAE,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAA;IACrE,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1D,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,wBAAwB,CAAA;IACjC,CAAC;IACD,OAAO,UAAU,KAAK,SAAS,IAAI,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAA;AACxF,CAAC"}