@rowanmanning/node-versions 1.0.5 → 2.0.0

package/README.md

@@ -46,20 +46,20 @@ An array of strings (`string[]`) that contains every released versions of Node.j
 A function to list the Node.js versions that a `package.json` file claims to support. This function has the following signature:
 
 ```ts
-(path: string, options?: object) => Promise<string[]>
+(packageJson: PackageJson, options?: object) => string[]
 ```
 
-The `path` argument is required and must be an accessible folder that contains a `package.json` file _or_ the path to a `package.json` file itself.
+`PackageJson` must be a JavaScript object that is a valid `package.json` or `package-lock.json` file. We recommend using [@rowanmanning/package-json](../package-json#readme) or [@npmcli/package-json](https://github.com/npm/package-json#readme).
 
 The `options` argument is optional and can be used to change the way the method works. The following options are available:
 
   * `majorsOnly`: A `boolean` option defaulting to `false`. If this is set to `true` then the returned versions will have any minor/patch versions removed. E.g. `20.0.0` becomes `20`
 
 ```js
-const versions = await getPackageNodeVersions('/path/to/my/repo');
+const versions = getPackageNodeVersions(require('./package.json'));
 // ["v22.5.1", "v20.16.0", "v18.20.4", ...]
 
-const versions = await getPackageNodeVersions('/path/to/my/repo', { majorsOnly: true });
+const versions = await getPackageNodeVersions(require('./package.json'), { majorsOnly: true });
 // ["22", "20", "18", ...]
 ```
 

package/index.d.ts

@@ -1,3 +1,5 @@
+import type { AnyPackageLock, PackageJson } from '@rowanmanning/package-json';
+
 declare module '@rowanmanning/node-versions' {
 	export interface Options {
 		majorsOnly?: boolean | undefined;
@@ -11,7 +13,7 @@ declare module '@rowanmanning/node-versions' {
 	): string[];
 
 	export function getPackageNodeVersions(
-		path: string,
+		packageJson: Partial<PackageJson> | Partial<AnyPackageLock>,
 		options?: Options | undefined
-	): Promise<string[]>;
+	): string[];
 }

package/index.js

@@ -1,6 +1,5 @@
 'use strict';
 
-const { loadPackage } = require('./lib/load-package');
 const possibleNodeVersions = require('./data/versions.json');
 const semver = require('semver');
 
@@ -38,10 +37,19 @@ exports.getEnginesNodeVersions = function getEnginesNodeVersions(engines, option
 };
 
 /** @type {nodeVersions['getPackageNodeVersions']} */
-exports.getPackageNodeVersions = async function getPackageNodeVersions(path, options) {
-	const packageJson = await loadPackage(path);
-	if (typeof packageJson.engines?.node !== 'string') {
+exports.getPackageNodeVersions = function getPackageNodeVersions(packageJson, options) {
+	/** @type {any} */
+	let engines;
+
+	// We can only extract engines data from a v2+ lockfile
+	if (typeof packageJson?.lockfileVersion === 'number' && packageJson.lockfileVersion > 1) {
+		engines = packageJson?.packages?.['']?.engines?.node;
+	} else {
+		engines = packageJson?.engines?.node;
+	}
+
+	if (typeof engines !== 'string') {
 		return [];
 	}
-	return exports.getEnginesNodeVersions(packageJson.engines.node, options);
+	return exports.getEnginesNodeVersions(engines, options);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rowanmanning/node-versions",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "description": "Get the Node.js versions that a repo says it supports",
   "keywords": [],
   "author": "Rowan Manning (https://rowanmanning.com/)",
@@ -22,7 +22,9 @@
   "main": "index.js",
   "types": "index.d.ts",
   "dependencies": {
-    "@npmcli/package-json": "^5.2.0",
     "semver": "^7.6.3"
+  },
+  "devDependencies": {
+    "@rowanmanning/package-json": "^1.0.0"
   }
 }

package/lib/load-package.js

@@ -1,29 +0,0 @@
-'use strict';
-
-const PackageJson = require('@npmcli/package-json');
-
-/**
- * @param {string} path
- * @returns {Promise<PackageJson.Content>}
- */
-exports.loadPackage = async function loadPackage(path) {
-	try {
-		const pkg = await PackageJson.load(path);
-		return pkg.content;
-	} catch (/** @type {any} */ cause) {
-		if (cause.code === 'ENOENT') {
-			throw Object.assign(new Error(`No package.json file found at ${path}`, { cause }), {
-				code: 'PACKAGE_JSON_MISSING'
-			});
-		}
-		if (cause.code === 'EJSONPARSE') {
-			throw Object.assign(
-				new Error(`Invalid package.json file found at ${path}`, { cause }),
-				{
-					code: 'PACKAGE_JSON_INVALID'
-				}
-			);
-		}
-		throw cause;
-	}
-};