@cjser/get-port 7.2.0-cjser.2

package/dist-cjser/index.cjs

@@ -0,0 +1,186 @@
+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 __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/get-port.tmp-26-1778150857313/index.js
+var index_exports = {};
+__export(index_exports, {
+  clearLockedPorts: () => clearLockedPorts,
+  default: () => getPorts,
+  portNumbers: () => portNumbers
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_net = __toESM(require("node:net"), 1);
+var import_node_os = __toESM(require("node:os"), 1);
+var Locked = class extends Error {
+  constructor(port) {
+    super(`${port} is locked`);
+  }
+};
+var lockedPorts = {
+  old: /* @__PURE__ */ new Set(),
+  young: /* @__PURE__ */ new Set()
+};
+var releaseOldLockedPortsIntervalMs = 1e3 * 15;
+var reservedPorts = /* @__PURE__ */ new Set();
+var minPort = 1024;
+var maxPort = 65535;
+var timeout;
+var getLocalHosts = () => {
+  const interfaces = import_node_os.default.networkInterfaces();
+  const results = /* @__PURE__ */ new Set([void 0, "0.0.0.0"]);
+  for (const _interface of Object.values(interfaces)) {
+    for (const config of _interface) {
+      results.add(config.address);
+    }
+  }
+  return results;
+};
+var checkAvailablePort = (options) => new Promise((resolve, reject) => {
+  const server = import_node_net.default.createServer();
+  server.unref();
+  server.on("error", reject);
+  server.listen(options, () => {
+    const { port } = server.address();
+    server.close(() => {
+      resolve(port);
+    });
+  });
+});
+var getAvailablePort = async (options, hosts) => {
+  if (options.host || options.port === 0) {
+    return checkAvailablePort(options);
+  }
+  for (const host of hosts) {
+    try {
+      await checkAvailablePort({ port: options.port, host });
+    } catch (error) {
+      if (!["EADDRNOTAVAIL", "EINVAL"].includes(error.code)) {
+        throw error;
+      }
+    }
+  }
+  return options.port;
+};
+var isLockedPort = (port) => lockedPorts.old.has(port) || lockedPorts.young.has(port) || reservedPorts.has(port);
+var portCheckSequence = function* (ports) {
+  if (ports) {
+    yield* ports;
+  }
+  yield 0;
+};
+async function getPorts(options) {
+  let ports;
+  let exclude = /* @__PURE__ */ new Set();
+  if (options) {
+    if (options.port) {
+      ports = typeof options.port === "number" ? [options.port] : options.port;
+    }
+    if (options.exclude) {
+      const excludeIterable = options.exclude;
+      if (typeof excludeIterable[Symbol.iterator] !== "function") {
+        throw new TypeError("The `exclude` option must be an iterable.");
+      }
+      for (const element of excludeIterable) {
+        if (typeof element !== "number") {
+          throw new TypeError("Each item in the `exclude` option must be a number corresponding to the port you want excluded.");
+        }
+        if (!Number.isSafeInteger(element)) {
+          throw new TypeError(`Number ${element} in the exclude option is not a safe integer and can't be used`);
+        }
+      }
+      exclude = new Set(excludeIterable);
+    }
+  }
+  const { reserve, ...netOptions } = options ?? {};
+  if (timeout === void 0) {
+    timeout = setTimeout(() => {
+      timeout = void 0;
+      lockedPorts.old = lockedPorts.young;
+      lockedPorts.young = /* @__PURE__ */ new Set();
+    }, releaseOldLockedPortsIntervalMs);
+    if (timeout.unref) {
+      timeout.unref();
+    }
+  }
+  const hosts = getLocalHosts();
+  for (const port of portCheckSequence(ports)) {
+    try {
+      if (exclude.has(port)) {
+        continue;
+      }
+      let availablePort = await getAvailablePort({ ...netOptions, port }, hosts);
+      while (isLockedPort(availablePort)) {
+        if (port !== 0) {
+          throw new Locked(port);
+        }
+        availablePort = await getAvailablePort({ ...netOptions, port }, hosts);
+      }
+      if (reserve) {
+        reservedPorts.add(availablePort);
+      } else {
+        lockedPorts.young.add(availablePort);
+      }
+      return availablePort;
+    } catch (error) {
+      if (!["EADDRINUSE", "EACCES"].includes(error.code) && !(error instanceof Locked)) {
+        throw error;
+      }
+    }
+  }
+  throw new Error("No available ports found");
+}
+function portNumbers(from, to) {
+  if (!Number.isInteger(from) || !Number.isInteger(to)) {
+    throw new TypeError("`from` and `to` must be integer numbers");
+  }
+  if (from < minPort || from > maxPort) {
+    throw new RangeError(`'from' must be between ${minPort} and ${maxPort}`);
+  }
+  if (to < minPort || to > maxPort) {
+    throw new RangeError(`'to' must be between ${minPort} and ${maxPort}`);
+  }
+  if (from > to) {
+    throw new RangeError("`to` must be greater than or equal to `from`");
+  }
+  const generator = function* (from2, to2) {
+    for (let port = from2; port <= to2; port++) {
+      yield port;
+    }
+  };
+  return generator(from, to);
+}
+function clearLockedPorts() {
+  lockedPorts.old.clear();
+  lockedPorts.young.clear();
+  reservedPorts.clear();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  clearLockedPorts,
+  portNumbers
+});

package/index.d.ts

@@ -0,0 +1,111 @@
+import {type ListenOptions} from 'node:net';
+
+export type Options = {
+	/**
+	A preferred port or an iterable of preferred ports to use.
+	*/
+	readonly port?: number | Iterable<number>;
+
+	/**
+	Ports that should not be returned.
+
+	You could, for example, pass it the return value of the `portNumbers()` function.
+	*/
+	readonly exclude?: Iterable<number>;
+
+	/**
+	Reserve the port so that it's locked for the lifetime of the process instead of the default 15-30 seconds.
+
+	This is useful when there is a long delay between getting the port and actually binding to it, such as in long-running test suites.
+
+	Reserved ports are locked globally by port number for the current process, even if you looked them up with a specific `host` or `ipv6Only` option.
+
+	Use {@link clearLockedPorts} to release reserved ports.
+
+	@default false
+
+	@example
+	```
+	import getPort from '@cjser/get-port';
+
+	const port = await getPort({reserve: true});
+	// `port` will not be returned again by get-port for the lifetime of the process
+	```
+	*/
+	readonly reserve?: boolean;
+
+	/**
+	The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.
+
+	By default, it checks availability on all local addresses defined in [OS network interfaces](https://nodejs.org/api/os.html#os_os_networkinterfaces). If this option is set, it will only check the given host.
+	*/
+	readonly host?: string;
+} & Omit<ListenOptions, 'port'>;
+
+/**
+Get an available TCP port number.
+
+@returns Port number.
+
+@example
+```
+import getPort from '@cjser/get-port';
+
+console.log(await getPort());
+//=> 51402
+
+// Pass in a preferred port
+console.log(await getPort({port: 3000}));
+// Will use 3000 if available, otherwise fall back to a random port
+
+// Pass in an array of preferred ports
+console.log(await getPort({port: [3000, 3001, 3002]}));
+// Will use any element in the preferred ports array if available, otherwise fall back to a random port
+```
+*/
+export default function getPort(options?: Options): Promise<number>;
+
+/**
+Generate port numbers in the given range `from`...`to`.
+
+@param from - The first port of the range. Must be in the range `1024`...`65535`.
+@param to - The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`.
+@returns The port numbers in the range.
+
+@example
+```
+import getPort, {portNumbers} from '@cjser/get-port';
+
+console.log(await getPort({port: portNumbers(3000, 3100)}));
+// Will use any port from 3000 to 3100, otherwise fall back to a random port
+```
+*/
+export function portNumbers(from: number, to: number): Iterable<number>;
+
+/**
+Clear the internal cache of locked ports, including any ports locked with the {@link Options.reserve reserve} option.
+
+This can be useful when you want the results to be unaffected by previous calls.
+
+Please note that clearing the cache removes protection against [in-process race conditions](https://github.com/sindresorhus/get-port#beware).
+
+@example
+```
+import getPort, {clearLockedPorts} from '@cjser/get-port';
+
+const port = [3000, 3001, 3002];
+
+console.log(await getPort({port}));
+//=> 3000
+
+console.log(await getPort({port}));
+//=> 3001
+
+// If you want the results to be unaffected by previous calls, clear the cache.
+clearLockedPorts();
+
+console.log(await getPort({port}));
+//=> 3000
+```
+*/
+export function clearLockedPorts(): void;

package/index.js

@@ -0,0 +1,199 @@
+import net from 'node:net';
+import os from 'node:os';
+
+class Locked extends Error {
+	constructor(port) {
+		super(`${port} is locked`);
+	}
+}
+
+const lockedPorts = {
+	old: new Set(),
+	young: new Set(),
+};
+
+// On this interval, the old locked ports are discarded,
+// the young locked ports are moved to old locked ports,
+// and a new young set for locked ports are created.
+const releaseOldLockedPortsIntervalMs = 1000 * 15;
+
+// Keep `reserve` deliberately process-wide by port number.
+// It is meant to avoid in-process races, not to model every possible
+// IPv4/IPv6 or host-specific bind combination.
+const reservedPorts = new Set();
+
+const minPort = 1024;
+const maxPort = 65_535;
+
+// Lazily create timeout on first use
+let timeout;
+
+const getLocalHosts = () => {
+	const interfaces = os.networkInterfaces();
+
+	// Add undefined value for createServer function to use default host,
+	// and default IPv4 host in case createServer defaults to IPv6.
+	const results = new Set([undefined, '0.0.0.0']);
+
+	for (const _interface of Object.values(interfaces)) {
+		for (const config of _interface) {
+			results.add(config.address);
+		}
+	}
+
+	return results;
+};
+
+const checkAvailablePort = options =>
+	new Promise((resolve, reject) => {
+		const server = net.createServer();
+		server.unref();
+		server.on('error', reject);
+
+		server.listen(options, () => {
+			const {port} = server.address();
+			server.close(() => {
+				resolve(port);
+			});
+		});
+	});
+
+const getAvailablePort = async (options, hosts) => {
+	if (options.host || options.port === 0) {
+		return checkAvailablePort(options);
+	}
+
+	for (const host of hosts) {
+		try {
+			await checkAvailablePort({port: options.port, host}); // eslint-disable-line no-await-in-loop
+		} catch (error) {
+			if (!['EADDRNOTAVAIL', 'EINVAL'].includes(error.code)) {
+				throw error;
+			}
+		}
+	}
+
+	return options.port;
+};
+
+const isLockedPort = port => lockedPorts.old.has(port) || lockedPorts.young.has(port) || reservedPorts.has(port);
+
+const portCheckSequence = function * (ports) {
+	if (ports) {
+		yield * ports;
+	}
+
+	yield 0; // Fall back to 0 if anything else failed
+};
+
+export default async function getPorts(options) {
+	let ports;
+	let exclude = new Set();
+
+	if (options) {
+		if (options.port) {
+			ports = typeof options.port === 'number' ? [options.port] : options.port;
+		}
+
+		if (options.exclude) {
+			const excludeIterable = options.exclude;
+
+			if (typeof excludeIterable[Symbol.iterator] !== 'function') {
+				throw new TypeError('The `exclude` option must be an iterable.');
+			}
+
+			for (const element of excludeIterable) {
+				if (typeof element !== 'number') {
+					throw new TypeError('Each item in the `exclude` option must be a number corresponding to the port you want excluded.');
+				}
+
+				if (!Number.isSafeInteger(element)) {
+					throw new TypeError(`Number ${element} in the exclude option is not a safe integer and can't be used`);
+				}
+			}
+
+			exclude = new Set(excludeIterable);
+		}
+	}
+
+	const {reserve, ...netOptions} = options ?? {};
+
+	if (timeout === undefined) {
+		timeout = setTimeout(() => {
+			timeout = undefined;
+
+			lockedPorts.old = lockedPorts.young;
+			lockedPorts.young = new Set();
+		}, releaseOldLockedPortsIntervalMs);
+
+		// Does not exist in some environments (Electron, Jest jsdom env, browser, etc).
+		if (timeout.unref) {
+			timeout.unref();
+		}
+	}
+
+	const hosts = getLocalHosts();
+
+	for (const port of portCheckSequence(ports)) {
+		try {
+			if (exclude.has(port)) {
+				continue;
+			}
+
+			let availablePort = await getAvailablePort({...netOptions, port}, hosts); // eslint-disable-line no-await-in-loop
+			while (isLockedPort(availablePort)) {
+				if (port !== 0) {
+					throw new Locked(port);
+				}
+
+				availablePort = await getAvailablePort({...netOptions, port}, hosts); // eslint-disable-line no-await-in-loop
+			}
+
+			if (reserve) {
+				reservedPorts.add(availablePort);
+			} else {
+				lockedPorts.young.add(availablePort);
+			}
+
+			return availablePort;
+		} catch (error) {
+			if (!['EADDRINUSE', 'EACCES'].includes(error.code) && !(error instanceof Locked)) {
+				throw error;
+			}
+		}
+	}
+
+	throw new Error('No available ports found');
+}
+
+export function portNumbers(from, to) {
+	if (!Number.isInteger(from) || !Number.isInteger(to)) {
+		throw new TypeError('`from` and `to` must be integer numbers');
+	}
+
+	if (from < minPort || from > maxPort) {
+		throw new RangeError(`'from' must be between ${minPort} and ${maxPort}`);
+	}
+
+	if (to < minPort || to > maxPort) {
+		throw new RangeError(`'to' must be between ${minPort} and ${maxPort}`);
+	}
+
+	if (from > to) {
+		throw new RangeError('`to` must be greater than or equal to `from`');
+	}
+
+	const generator = function * (from, to) {
+		for (let port = from; port <= to; port++) {
+			yield port;
+		}
+	};
+
+	return generator(from, to);
+}
+
+export function clearLockedPorts() {
+	lockedPorts.old.clear();
+	lockedPorts.young.clear();
+	reservedPorts.clear();
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@cjser/get-port",
+  "version": "7.2.0-cjser.2",
+  "description": "Get an available port",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    "types": "./index.d.ts",
+    "require": "./dist-cjser/index.cjs",
+    "default": "./index.js"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "dist-cjser"
+  ],
+  "keywords": [
+    "port",
+    "find",
+    "finder",
+    "portfinder",
+    "free",
+    "available",
+    "connection",
+    "connect",
+    "open",
+    "net",
+    "tcp",
+    "scan",
+    "random",
+    "preferred",
+    "chosen"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.2.5",
+    "ava": "^5.3.0",
+    "tsd": "^0.28.1",
+    "xo": "^0.54.2"
+  },
+  "types": "./index.d.ts",
+  "main": "./dist-cjser/index.cjs",
+  "cjser": {
+    "sourceVersion": "7.2.0",
+    "cjserVersion": 2,
+    "original": {
+      "name": "get-port",
+      "version": "7.2.0",
+      "exports": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "repository": "sindresorhus/get-port",
+      "files": [
+        "index.js",
+        "index.d.ts"
+      ],
+      "scripts": {
+        "test": "xo && ava && tsd"
+      }
+    }
+  }
+}

package/readme.md

@@ -0,0 +1,158 @@
+# get-port
+
+> Get an available [TCP port](https://en.wikipedia.org/wiki/Port_(computer_networking)).
+
+## Install
+
+```sh
+npm install get-port
+```
+
+## Usage
+
+```js
+import getPort from 'get-port';
+
+console.log(await getPort());
+//=> 51402
+```
+
+Pass in a preferred port:
+
+```js
+import getPort from 'get-port';
+
+console.log(await getPort({port: 3000}));
+// Will use 3000 if available, otherwise fall back to a random port
+```
+
+Pass in an array of preferred ports:
+
+```js
+import getPort from 'get-port';
+
+console.log(await getPort({port: [3000, 3001, 3002]}));
+// Will use any element in the preferred ports array if available, otherwise fall back to a random port
+```
+
+Use the `portNumbers()` helper in case you need a port in a certain range:
+
+```js
+import getPort, {portNumbers} from 'get-port';
+
+console.log(await getPort({port: portNumbers(3000, 3100)}));
+// Will use any port from 3000 to 3100, otherwise fall back to a random port
+```
+
+## API
+
+### getPort(options?)
+
+Returns a `Promise` for a port number.
+
+#### options
+
+Type: `object`
+
+##### port
+
+Type: `number | Iterable<number>`
+
+A preferred port or an iterable of preferred ports to use.
+
+##### exclude
+
+Type: `Iterable<number>`
+
+Ports that should not be returned.
+
+You could, for example, pass it the return value of the `portNumbers()` function.
+
+##### reserve
+
+Type: `boolean`\
+Default: `false`
+
+Reserve the port so that it's locked for the lifetime of the process instead of the default 15-30 seconds.
+
+This is useful when there is a long delay between getting the port and actually binding to it, such as in long-running test suites.
+
+Reserved ports are locked globally by port number for the current process, even if you looked them up with a specific `host` or `ipv6Only` option.
+
+Use [`clearLockedPorts()`](#clearlockedports) to release reserved ports.
+
+##### host
+
+Type: `string`
+
+The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.
+
+By default, it checks availability on all local addresses defined in [OS network interfaces](https://nodejs.org/api/os.html#os_os_networkinterfaces). If this option is set, it will only check the given host.
+
+### portNumbers(from, to)
+
+Generate port numbers in the given range `from`...`to`.
+
+Returns an `Iterable` for port numbers in the given range.
+
+```js
+import getPort, {portNumbers} from 'get-port';
+
+console.log(await getPort({port: portNumbers(3000, 3100)}));
+// Will use any port from 3000 to 3100, otherwise fall back to a random port
+```
+
+#### from
+
+Type: `number`
+
+The first port of the range. Must be in the range `1024`...`65535`.
+
+#### to
+
+Type: `number`
+
+The last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`.
+
+### clearLockedPorts()
+
+Clear the internal cache of locked ports, including any ports locked with the [`reserve`](#reserve) option.
+
+This can be useful when you want the results to be unaffected by previous calls.
+
+Please note that clearing the cache removes protection against [in-process race conditions](#beware).
+
+```js
+import getPort, {clearLockedPorts} from 'get-port';
+
+const port = [3000, 3001, 3002];
+
+console.log(await getPort({port}));
+//=> 3000
+
+console.log(await getPort({port}));
+//=> 3001
+
+// If you want the results to be unaffected by previous calls, clear the cache.
+clearLockedPorts();
+
+console.log(await getPort({port}));
+//=> 3000
+```
+
+## Beware
+
+There is a very tiny chance of a race condition if another process starts using the same port number as you in between the time you get the port number and you actually start using it.
+
+**In-process race conditions** (such as when running parallel Jest tests) are completely eliminated by a lightweight locking mechanism where returned ports are held for 15-30 seconds before being eligible for reuse. If the delay between getting a port and binding to it may exceed this window (for example, in long-running test suites), use the [`reserve`](#reserve) option to lock the port for the lifetime of the process.
+
+**Multi-process race conditions** are extremely rare and will result in an immediate `EADDRINUSE` error when attempting to bind to the port, allowing your application to retry.
+
+## Related
+
+- [get-port-cli](https://github.com/sindresorhus/get-port-cli) - CLI for this module
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/sindresorhus/get-port