@badisi/latest-version 8.0.6 → 9.0.0

package/README.md

@@ -32,7 +32,11 @@
 ✅ Check if any `updates` are available<br/>
 ✅ Cache support to increase data retrieval performance<br/>
 ✅ Support public/private repositories and proxies<br/>
-✅ [Command line tool](#command-line-tool) that helps visualize packages updates<br/>
+✅ Dual build support (CJS/ESM)<br/>
+
+🚀 Check out 👉🏻 [@badisi/check-updates][checkupdates]<br/>
+✅ An interactive CLI to scan global or local dependencies and upgrade to wanted or latest versions !
+
 
 ## Installation
 
@@ -50,12 +54,12 @@ __Example__
 
 ```ts
 /** CommonJS */
-// const { readFileSync } = require('fs');
-// const latestVersion = require('@badisi/latest-version');
+// const { latestVersion } = require('@badisi/latest-version');
+// const { readFileSync } = require('node:fs');
 
 /** ESM / Typescript */
-import { readFileSync } from 'fs';
-import latestVersion from '@badisi/latest-version';
+import { latestVersion } from '@badisi/latest-version';
+import { readFileSync } from 'node:fs';
 
 (async () => {
     // Single package
@@ -177,23 +181,6 @@ interface LatestVersionOptions {
 ```
 
 
-## Command line tool
-
-The CLI utility will help you visualize any available updates for a given *package.json* file, a local *package.json* file or any provided package names.
-
-```sh
-$ latest-version <packageJson|packageName...>
-
-  Examples:
-    $ lv
-    $ latest-version path/to/package.json
-    $ latest-version package1 package2 package3 --skip-missing
-```
-
-![CLI utility preview][clipreview]
-
-
-
 ## Development
 
 See the [developer docs][developer].
@@ -214,7 +201,7 @@ Please read and follow the [Code of Conduct][codeofconduct] and help me keep thi
 
 
 
-[clipreview]: https://github.com/Badisi/latest-version/blob/main/cli_preview.png
+[checkupdates]: https://github.com/Badisi/check-updates
 [developer]: https://github.com/Badisi/latest-version/blob/main/DEVELOPER.md
 [contributing]: https://github.com/Badisi/latest-version/blob/main/CONTRIBUTING.md
 [codeofconduct]: https://github.com/Badisi/latest-version/blob/main/CODE_OF_CONDUCT.md

package/index.cjs

@@ -0,0 +1,229 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+//#endregion
+let global_dirs = require("global-dirs");
+let node_fs_promises = require("node:fs/promises");
+let node_path = require("node:path");
+let semver_functions_gt_js = require("semver/functions/gt.js");
+semver_functions_gt_js = __toESM(semver_functions_gt_js, 1);
+let semver_ranges_max_satisfying_js = require("semver/ranges/max-satisfying.js");
+semver_ranges_max_satisfying_js = __toESM(semver_ranges_max_satisfying_js, 1);
+let node_fs = require("node:fs");
+let node_os = require("node:os");
+let node_http = require("node:http");
+let node_https = require("node:https");
+let node_url = require("node:url");
+let registry_auth_token = require("registry-auth-token");
+registry_auth_token = __toESM(registry_auth_token, 1);
+let registry_auth_token_registry_url_js = require("registry-auth-token/registry-url.js");
+registry_auth_token_registry_url_js = __toESM(registry_auth_token_registry_url_js, 1);
+//#region src/cache.ts
+const ONE_DAY = 1e3 * 60 * 60 * 24;
+const getCacheDir = (name = "@badisi/latest-version") => {
+	const homeDir = (0, node_os.homedir)();
+	switch (process.platform) {
+		case "darwin": return (0, node_path.join)(homeDir, "Library", "Caches", name);
+		case "win32": return (0, node_path.join)(process.env["LOCALAPPDATA"] ?? (0, node_path.join)(homeDir, "AppData", "Local"), name, "Cache");
+		default: return (0, node_path.join)(process.env["XDG_CACHE_HOME"] ?? (0, node_path.join)(homeDir, ".cache"), name);
+	}
+};
+const saveMetadataToCache = (pkg) => {
+	const filePath = (0, node_path.join)(getCacheDir(), `${pkg.name}.json`);
+	if (!(0, node_fs.existsSync)((0, node_path.dirname)(filePath))) (0, node_fs.mkdirSync)((0, node_path.dirname)(filePath), { recursive: true });
+	(0, node_fs.writeFileSync)(filePath, JSON.stringify(pkg));
+};
+const getMetadataFromCache = (pkgName, options) => {
+	const maxAge = options?.cacheMaxAge ?? 864e5;
+	if (maxAge !== 0) {
+		const pkgCacheFilePath = (0, node_path.join)(getCacheDir(), `${pkgName}.json`);
+		if ((0, node_fs.existsSync)(pkgCacheFilePath)) {
+			const pkg = JSON.parse((0, node_fs.readFileSync)(pkgCacheFilePath).toString());
+			if (Date.now() - pkg.lastUpdateDate < maxAge) return pkg;
+		}
+	}
+};
+//#endregion
+//#region src/metadata.ts
+const downloadMetadata = (pkgName, options) => new Promise((resolve, reject) => {
+	const i = pkgName.indexOf("/");
+	const pkgScope = i !== -1 ? pkgName.slice(0, i) : "";
+	const registryUrl = options?.registryUrl ?? (0, registry_auth_token_registry_url_js.default)(pkgScope);
+	const pkgUrl = new node_url.URL(encodeURIComponent(pkgName).replace(/^%40/, "@"), registryUrl);
+	let requestOptions = {
+		headers: { accept: "application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*" },
+		host: pkgUrl.hostname,
+		path: pkgUrl.pathname,
+		port: pkgUrl.port
+	};
+	const authInfo = (0, registry_auth_token.default)(pkgUrl.toString(), { recursive: true });
+	if (authInfo && requestOptions.headers) requestOptions.headers.authorization = `${authInfo.type} ${authInfo.token}`;
+	if (options?.requestOptions) requestOptions = {
+		...requestOptions,
+		...options.requestOptions
+	};
+	const request = (pkgUrl.protocol === "https:" ? node_https.get : node_http.get)(requestOptions, (res) => {
+		if (res.statusCode === 200) {
+			let rawData = "";
+			res.setEncoding("utf8");
+			res.on("data", (chunk) => rawData += chunk);
+			res.once("error", (err) => {
+				res.removeAllListeners();
+				reject(/* @__PURE__ */ new Error(`Request error (${err.message}): ${pkgUrl.toString()}`));
+			});
+			res.once("end", () => {
+				res.removeAllListeners();
+				try {
+					const pkgMetadata = JSON.parse(rawData);
+					resolve({
+						name: pkgName,
+						lastUpdateDate: Date.now(),
+						versions: Object.keys(pkgMetadata["versions"]),
+						distTags: pkgMetadata["dist-tags"]
+					});
+					return;
+				} catch (error) {
+					if (typeof error === "string") reject(new Error(error));
+					else if (error instanceof Error) reject(error);
+					else reject(/* @__PURE__ */ new Error("Metadata extraction error"));
+					return;
+				}
+			});
+		} else {
+			res.removeAllListeners();
+			res.resume();
+			reject(/* @__PURE__ */ new Error(`Request error (${res.statusCode ?? "unknown"}): ${pkgUrl.toString()}`));
+			return;
+		}
+	});
+	const abort = (error) => {
+		request.destroy();
+		reject(typeof error === "string" ? new Error(error) : error);
+	};
+	request.once("timeout", () => {
+		abort(`Request timed out: ${pkgUrl.toString()}`);
+	});
+	request.once("error", (err) => {
+		abort(err);
+	});
+	request.once("close", () => {
+		request.removeAllListeners();
+	});
+});
+//#endregion
+//#region src/index.ts
+const isPackageJson = (obj) => obj.dependencies !== void 0 || obj.devDependencies !== void 0 || obj.peerDependencies !== void 0;
+const getRegistryVersions = async (pkgName, tagOrRange, options) => {
+	let pkgMetadata;
+	if (pkgName.length && options?.useCache) {
+		pkgMetadata = getMetadataFromCache(pkgName, options);
+		if (!pkgMetadata) {
+			pkgMetadata = await downloadMetadata(pkgName, options);
+			saveMetadataToCache(pkgMetadata);
+		}
+	} else if (pkgName.length) pkgMetadata = await downloadMetadata(pkgName, options);
+	const versions = {
+		latest: pkgMetadata?.distTags["latest"],
+		next: pkgMetadata?.distTags["next"]
+	};
+	if (tagOrRange && pkgMetadata?.distTags[tagOrRange]) versions.wanted = pkgMetadata.distTags[tagOrRange];
+	else if (tagOrRange && pkgMetadata?.versions.length) versions.wanted = (0, semver_ranges_max_satisfying_js.default)(pkgMetadata.versions, tagOrRange) ?? void 0;
+	return versions;
+};
+const getInstalledVersion = async (pkgName, location = "local") => {
+	try {
+		const readPackageJson = async (path) => JSON.parse(await (0, node_fs_promises.readFile)(path, "utf8"));
+		if (location === "globalNpm") return (await readPackageJson((0, node_path.join)(global_dirs.npm.packages, pkgName, "package.json"))).version;
+		else if (location === "globalYarn") {
+			if (!(pkgName in (await readPackageJson((0, node_path.resolve)(global_dirs.yarn.packages, "..", "package.json"))).dependencies)) return;
+			return (await readPackageJson((0, node_path.join)(global_dirs.yarn.packages, pkgName, "package.json"))).version;
+		} else {
+			/**
+			* Compute the local paths manually as require.resolve() and require.resolve.paths()
+			* cannot be trusted anymore.
+			* @see https://github.com/nodejs/node/issues/33460
+			* @see https://github.com/nodejs/loaders/issues/26
+			*/
+			const startPath = process.cwd();
+			const { root } = (0, node_path.parse)(startPath);
+			const findPackageVersion = async (path, rootPath, name) => {
+				const pkgPath = (0, node_path.join)(path, "node_modules", name, "package.json");
+				try {
+					return (await readPackageJson(pkgPath)).version;
+				} catch {}
+				if (path === rootPath) return;
+				return await findPackageVersion((0, node_path.dirname)(path), rootPath, name);
+			};
+			return await findPackageVersion(startPath, root, pkgName);
+		}
+	} catch {
+		return;
+	}
+};
+const getInfo = async (pkg, options) => {
+	const i = pkg.lastIndexOf("@");
+	let pkgInfo = {
+		name: i > 1 ? pkg.slice(0, i) : pkg,
+		wantedTagOrRange: i > 1 ? pkg.slice(i + 1) : "latest",
+		updatesAvailable: false
+	};
+	try {
+		pkgInfo = {
+			...pkgInfo,
+			local: await getInstalledVersion(pkgInfo.name, "local"),
+			globalNpm: await getInstalledVersion(pkgInfo.name, "globalNpm"),
+			globalYarn: await getInstalledVersion(pkgInfo.name, "globalYarn"),
+			...await getRegistryVersions(pkgInfo.name, pkgInfo.wantedTagOrRange, options)
+		};
+		const local = pkgInfo.local && pkgInfo.wanted ? (0, semver_functions_gt_js.default)(pkgInfo.wanted, pkgInfo.local) ? pkgInfo.wanted : false : false;
+		const globalNpm = pkgInfo.globalNpm && pkgInfo.wanted ? (0, semver_functions_gt_js.default)(pkgInfo.wanted, pkgInfo.globalNpm) ? pkgInfo.wanted : false : false;
+		const globalYarn = pkgInfo.globalYarn && pkgInfo.wanted ? (0, semver_functions_gt_js.default)(pkgInfo.wanted, pkgInfo.globalYarn) ? pkgInfo.wanted : false : false;
+		pkgInfo.updatesAvailable = local || globalNpm || globalYarn ? {
+			local,
+			globalNpm,
+			globalYarn
+		} : false;
+	} catch (err) {
+		if (typeof err === "string") pkgInfo.error = new Error(err);
+		else if (err instanceof Error) pkgInfo.error = err;
+		else pkgInfo.error = /* @__PURE__ */ new Error("Unknown error");
+	}
+	return pkgInfo;
+};
+const latestVersion = async (arg, options) => {
+	const pkgs = [];
+	if (typeof arg === "string") pkgs.push(arg);
+	else if (Array.isArray(arg)) pkgs.push(...arg);
+	else if (isPackageJson(arg)) {
+		const addDeps = (deps) => {
+			if (deps) pkgs.push(...Object.keys(deps).map((key) => `${key}@${deps[key]}`));
+		};
+		addDeps(arg.dependencies);
+		addDeps(arg.devDependencies);
+		addDeps(arg.peerDependencies);
+	}
+	const results = (await Promise.allSettled(pkgs.map((pkg) => getInfo(pkg, options)))).map((jobResult) => jobResult.value);
+	return typeof arg === "string" ? results[0] : results;
+};
+//#endregion
+exports.ONE_DAY = ONE_DAY;
+exports.latestVersion = latestVersion;

package/index.d.cts

@@ -0,0 +1,152 @@
+import { Agent } from "node:http";
+//#region src/cache.d.ts
+declare const ONE_DAY: number;
+//#endregion
+//#region src/index.d.ts
+interface RegistryVersions {
+  /**
+   * The latest version of the package found on the registry (if found).
+   */
+  latest?: string;
+  /**
+   * The next version of the package found on the registry (if found).
+   */
+  next?: string;
+  /**
+   * The latest version of the package found on the registry and satisfied by the wanted tag or version range.
+   */
+  wanted?: string;
+}
+interface InstalledVersions {
+  /**
+   * The current local installed version of the package (if installed).
+   */
+  local?: string;
+  /**
+   * The current npm global installed version of the package (if installed).
+   */
+  globalNpm?: string;
+  /**
+   * The current yarn global installed version of the package (if installed).
+   */
+  globalYarn?: string;
+}
+interface LatestVersionPackage extends InstalledVersions, RegistryVersions {
+  /**
+   * The name of the package.
+   */
+  name: string;
+  /**
+   * The tag or version range that was provided (if provided).
+   * @default "latest"
+   */
+  wantedTagOrRange?: string;
+  /**
+   * Whether the local or global installed versions (if any) could be upgraded or not, based on the wanted version.
+   */
+  updatesAvailable: {
+    local: string | false;
+    globalNpm: string | false;
+    globalYarn: string | false;
+  } | false;
+  /**
+   * Any error that might have occurred during the process.
+   */
+  error?: Error;
+}
+interface RequestOptions {
+  readonly ca?: string | Buffer | (string | Buffer)[];
+  readonly rejectUnauthorized?: boolean;
+  readonly agent?: Agent | boolean;
+  readonly timeout?: number;
+}
+interface LatestVersionOptions {
+  /**
+   * Awaiting the api to return might take time, depending on the network, and might impact your package loading performance.
+   * You can use the cache mechanism to improve load performance and reduce unnecessary network requests.
+   * If `useCache` is not supplied, the api will always check for updates and wait for every requests to return before returning itself.
+   * If `useCache` is used, the api will always returned immediately, with either (for each provided packages):
+   * 1) a latest/next version available if a cache was found
+   * 2) no latest/next version available if no cache was found - in such case updates will be fetched in the background and a cache will
+   * be created for each provided packages and made available for the next call to the api.
+   * @default false
+   */
+  readonly useCache?: boolean;
+  /**
+   * How long the cache for the provided packages should be used before being refreshed (in milliseconds).
+   * If `useCache` is not supplied, this option has no effect.
+   * If `0` is used, this will force the cache to refresh immediately:
+   * 1) The api will returned immediately (without any latest nor next version available for the provided packages)
+   * 2) New updates will be fetched in the background
+   * 3) The cache for each provided packages will be refreshed and made available for the next call to the api
+   * @default ONE_DAY
+   */
+  readonly cacheMaxAge?: number;
+  /**
+   * A JavaScript package registry url that implements the CommonJS Package Registry specification.
+   * @default "Looks at any registry urls in the .npmrc file or fallback to the default npm registry instead"
+   * @example <caption>.npmrc</caption>
+   * registry = 'https://custom-registry.com/'
+   * \@pkgscope:registry = 'https://custom-registry.com/'
+   */
+  readonly registryUrl?: string;
+  /**
+   * Set of options to be passed down to Node.js http/https request.
+   * @example <caption>Behind a proxy with self-signed certificate</caption>
+   * { ca: [ fs.readFileSync('proxy-cert.pem') ] }
+   * @example <caption>Bypassing certificate validation</caption>
+   * { rejectUnauthorized: false }
+   */
+  readonly requestOptions?: RequestOptions;
+}
+interface LatestVersion {
+  /**
+   * Get latest versions of packages from of a package json like object.
+   * @param {PackageJson} item - A package json like object (with dependencies, devDependencies and peerDependencies attributes).
+   * @example { dependencies: { 'npm': 'latest' }, devDependencies: { 'npm': '1.3.2' }, peerDependencies: { '@scope/name': '^5.0.2' } }
+   * @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
+   * If `useCache` is not supplied, the default of `false` is used.
+   * If `cacheMaxAge` is not supplied, the default of `one day` is used.
+   * If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the `npm registry url` instead.
+   * @returns {Promise<LatestVersionPackage[]>}
+   */
+  (item: PackageJson, options?: LatestVersionOptions): Promise<LatestVersionPackage[]>;
+  /**
+   * Get latest version of a single package.
+   * @param {Package} item - A single package object (represented by a string that should match the following format: `${'@' | ''}${string}@${string}`)
+   * @example 'npm', 'npm@1.3.2', '@scope/name@^5.0.2'
+   * @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
+   * If `useCache` is not supplied, the default of `false` is used.
+   * If `cacheMaxAge` is not supplied, the default of `one day` is used.
+   * If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the npm registry url instead.
+   * @returns {Promise<LatestVersionPackage>}
+   */
+  (item: Package, options?: LatestVersionOptions): Promise<LatestVersionPackage>;
+  /**
+   * Get latest versions of a collection of packages.
+   * @param {Package[]} items - A collection of package object (represented by a string that should match the following format: `${'@' | ''}${string}@${string}`)
+   * @example ['npm', 'npm@1.3.2', '@scope/name@^5.0.2']
+   * @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
+   * If `useCache` is not supplied, the default of `false` is used.
+   * If `cacheMaxAge` is not supplied, the default of `one day` is used.
+   * If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the npm registry url instead.
+   * @returns {Promise<LatestVersionPackage[]>}
+   */
+  (items: Package[], options?: LatestVersionOptions): Promise<LatestVersionPackage[]>;
+  (item: Package[] | PackageJson, options?: LatestVersionOptions): Promise<LatestVersionPackage[]>;
+}
+type PackageRange = `${"@" | ""}${string}@${string}`;
+type Package = PackageRange | string;
+type PackageJsonDependencies = Record<string, string>;
+type PackageJson = Record<string, unknown> & {
+  version?: string;
+} & ({
+  dependencies: PackageJsonDependencies;
+} | {
+  devDependencies: PackageJsonDependencies;
+} | {
+  peerDependencies: PackageJsonDependencies;
+});
+declare const latestVersion: LatestVersion;
+//#endregion
+export { type LatestVersion, type LatestVersionOptions, type LatestVersionPackage, ONE_DAY, type Package, type PackageJson, type PackageJsonDependencies, type PackageRange, type RegistryVersions, type RequestOptions, latestVersion };

package/index.d.mts

@@ -0,0 +1,152 @@
+import { Agent } from "node:http";
+//#region src/cache.d.ts
+declare const ONE_DAY: number;
+//#endregion
+//#region src/index.d.ts
+interface RegistryVersions {
+  /**
+   * The latest version of the package found on the registry (if found).
+   */
+  latest?: string;
+  /**
+   * The next version of the package found on the registry (if found).
+   */
+  next?: string;
+  /**
+   * The latest version of the package found on the registry and satisfied by the wanted tag or version range.
+   */
+  wanted?: string;
+}
+interface InstalledVersions {
+  /**
+   * The current local installed version of the package (if installed).
+   */
+  local?: string;
+  /**
+   * The current npm global installed version of the package (if installed).
+   */
+  globalNpm?: string;
+  /**
+   * The current yarn global installed version of the package (if installed).
+   */
+  globalYarn?: string;
+}
+interface LatestVersionPackage extends InstalledVersions, RegistryVersions {
+  /**
+   * The name of the package.
+   */
+  name: string;
+  /**
+   * The tag or version range that was provided (if provided).
+   * @default "latest"
+   */
+  wantedTagOrRange?: string;
+  /**
+   * Whether the local or global installed versions (if any) could be upgraded or not, based on the wanted version.
+   */
+  updatesAvailable: {
+    local: string | false;
+    globalNpm: string | false;
+    globalYarn: string | false;
+  } | false;
+  /**
+   * Any error that might have occurred during the process.
+   */
+  error?: Error;
+}
+interface RequestOptions {
+  readonly ca?: string | Buffer | (string | Buffer)[];
+  readonly rejectUnauthorized?: boolean;
+  readonly agent?: Agent | boolean;
+  readonly timeout?: number;
+}
+interface LatestVersionOptions {
+  /**
+   * Awaiting the api to return might take time, depending on the network, and might impact your package loading performance.
+   * You can use the cache mechanism to improve load performance and reduce unnecessary network requests.
+   * If `useCache` is not supplied, the api will always check for updates and wait for every requests to return before returning itself.
+   * If `useCache` is used, the api will always returned immediately, with either (for each provided packages):
+   * 1) a latest/next version available if a cache was found
+   * 2) no latest/next version available if no cache was found - in such case updates will be fetched in the background and a cache will
+   * be created for each provided packages and made available for the next call to the api.
+   * @default false
+   */
+  readonly useCache?: boolean;
+  /**
+   * How long the cache for the provided packages should be used before being refreshed (in milliseconds).
+   * If `useCache` is not supplied, this option has no effect.
+   * If `0` is used, this will force the cache to refresh immediately:
+   * 1) The api will returned immediately (without any latest nor next version available for the provided packages)
+   * 2) New updates will be fetched in the background
+   * 3) The cache for each provided packages will be refreshed and made available for the next call to the api
+   * @default ONE_DAY
+   */
+  readonly cacheMaxAge?: number;
+  /**
+   * A JavaScript package registry url that implements the CommonJS Package Registry specification.
+   * @default "Looks at any registry urls in the .npmrc file or fallback to the default npm registry instead"
+   * @example <caption>.npmrc</caption>
+   * registry = 'https://custom-registry.com/'
+   * \@pkgscope:registry = 'https://custom-registry.com/'
+   */
+  readonly registryUrl?: string;
+  /**
+   * Set of options to be passed down to Node.js http/https request.
+   * @example <caption>Behind a proxy with self-signed certificate</caption>
+   * { ca: [ fs.readFileSync('proxy-cert.pem') ] }
+   * @example <caption>Bypassing certificate validation</caption>
+   * { rejectUnauthorized: false }
+   */
+  readonly requestOptions?: RequestOptions;
+}
+interface LatestVersion {
+  /**
+   * Get latest versions of packages from of a package json like object.
+   * @param {PackageJson} item - A package json like object (with dependencies, devDependencies and peerDependencies attributes).
+   * @example { dependencies: { 'npm': 'latest' }, devDependencies: { 'npm': '1.3.2' }, peerDependencies: { '@scope/name': '^5.0.2' } }
+   * @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
+   * If `useCache` is not supplied, the default of `false` is used.
+   * If `cacheMaxAge` is not supplied, the default of `one day` is used.
+   * If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the `npm registry url` instead.
+   * @returns {Promise<LatestVersionPackage[]>}
+   */
+  (item: PackageJson, options?: LatestVersionOptions): Promise<LatestVersionPackage[]>;
+  /**
+   * Get latest version of a single package.
+   * @param {Package} item - A single package object (represented by a string that should match the following format: `${'@' | ''}${string}@${string}`)
+   * @example 'npm', 'npm@1.3.2', '@scope/name@^5.0.2'
+   * @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
+   * If `useCache` is not supplied, the default of `false` is used.
+   * If `cacheMaxAge` is not supplied, the default of `one day` is used.
+   * If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the npm registry url instead.
+   * @returns {Promise<LatestVersionPackage>}
+   */
+  (item: Package, options?: LatestVersionOptions): Promise<LatestVersionPackage>;
+  /**
+   * Get latest versions of a collection of packages.
+   * @param {Package[]} items - A collection of package object (represented by a string that should match the following format: `${'@' | ''}${string}@${string}`)
+   * @example ['npm', 'npm@1.3.2', '@scope/name@^5.0.2']
+   * @param {LatestVersionOptions} [options] - An object optionally specifying the use of the cache, the max age of the cache, the registry url and the http or https options.
+   * If `useCache` is not supplied, the default of `false` is used.
+   * If `cacheMaxAge` is not supplied, the default of `one day` is used.
+   * If `registryUrl` is not supplied, the default from `.npmrc` is used or a fallback to the npm registry url instead.
+   * @returns {Promise<LatestVersionPackage[]>}
+   */
+  (items: Package[], options?: LatestVersionOptions): Promise<LatestVersionPackage[]>;
+  (item: Package[] | PackageJson, options?: LatestVersionOptions): Promise<LatestVersionPackage[]>;
+}
+type PackageRange = `${"@" | ""}${string}@${string}`;
+type Package = PackageRange | string;
+type PackageJsonDependencies = Record<string, string>;
+type PackageJson = Record<string, unknown> & {
+  version?: string;
+} & ({
+  dependencies: PackageJsonDependencies;
+} | {
+  devDependencies: PackageJsonDependencies;
+} | {
+  peerDependencies: PackageJsonDependencies;
+});
+declare const latestVersion: LatestVersion;
+//#endregion
+export { type LatestVersion, type LatestVersionOptions, type LatestVersionPackage, ONE_DAY, type Package, type PackageJson, type PackageJsonDependencies, type PackageRange, type RegistryVersions, type RequestOptions, latestVersion };