mediasoup-client 3.20.0 → 3.22.0

package/npm-scripts.mjs

@@ -4,22 +4,23 @@ import * as fs from 'node:fs';
 import { execSync } from 'node:child_process';
 import pkg from './package.json' with { type: 'json' };
 
-const MAYOR_VERSION = pkg.version.split('.')[0];
+// Main Git branch is 'v' concatenated with the major SEMVER number of the
+// "version" field in package.json.
+const MAIN_BRANCH = `v${pkg.version.split('.')[0]}`;
 
-// Paths for ESLint to check. Converted to string for convenience.
+// Paths for ESLint to check.
 const ESLINT_PATHS = [
 	'eslint.config.mjs',
 	'jest.config.mjs',
 	'npm-scripts.mjs',
 	'src',
-].join(' ');
+];
 
-// Paths for ESLint to ignore. Converted to string argument for convenience.
-const ESLINT_IGNORE_PATTERN_ARGS = []
-	.map(entry => `--ignore-pattern ${entry}`)
-	.join(' ');
+// Paths for ESLint to ignore.
+const ESLINT_IGNORE_PATHS = [];
 
-// Paths for Prettier to check/write. Converted to string for convenience.
+// Paths for Prettier to check/write.
+// NOTE: Prettier ignores paths in .gitignore.
 const PRETTIER_PATHS = [
 	'README.md',
 	'eslint.config.mjs',
@@ -28,12 +29,12 @@ const PRETTIER_PATHS = [
 	'package.json',
 	'tsconfig.json',
 	'src',
-].join(' ');
+];
 
 const task = process.argv[2];
 const taskArgs = process.argv.slice(3).join(' ');
 
-run();
+void run();
 
 async function run() {
 	logInfo(taskArgs ? `[args:"${taskArgs}"]` : '');
@@ -53,20 +54,24 @@ async function run() {
 		// So here we compile TypeScript to JavaScript.
 		case 'prepare': {
 			buildTypescript({ force: false });
-			replaceVersion();
+
+			break;
+		}
+
+		case 'prepublishOnly': {
+			prepublishOnly();
 
 			break;
 		}
 
 		case 'typescript:build': {
-			buildTypescript({ force: true });
-			replaceVersion();
+			buildTypescript({ force: true, args: taskArgs });
 
 			break;
 		}
 
 		case 'typescript:watch': {
-			watchTypescript();
+			watchTypescript({ args: taskArgs });
 
 			break;
 		}
@@ -84,15 +89,19 @@ async function run() {
 		}
 
 		case 'test': {
-			replaceVersion();
 			test();
 
 			break;
 		}
 
 		case 'coverage': {
-			replaceVersion();
-			coverage();
+			coverage({ args: taskArgs });
+
+			break;
+		}
+
+		case 'publish:dry-run': {
+			publishDryRun();
 
 			break;
 		}
@@ -104,7 +113,7 @@ async function run() {
 		}
 
 		case 'release': {
-			release();
+			await release({ args: taskArgs });
 
 			break;
 		}
@@ -149,7 +158,8 @@ function deleteLib() {
 	fs.rmSync('lib', { recursive: true, force: true });
 }
 
-function buildTypescript({ force }) {
+function buildTypescript({ force, args = '' }) {
+	// Skip JavaScript code generation if the output already exists, unless forced.
 	if (!force && fs.existsSync('lib')) {
 		return;
 	}
@@ -159,15 +169,15 @@ function buildTypescript({ force }) {
 	deleteLib();
 
 	// Generate .js CommonJS code and .d.ts TypeScript declaration files in lib/.
-	executeCmd(`tsc ${taskArgs}`);
+	executeCmd(`tsc ${args}`);
 }
 
-function watchTypescript() {
+function watchTypescript({ args = '' } = {}) {
 	logInfo('watchTypescript()');
 
 	deleteLib();
 
-	executeCmd(`tsc --watch ${taskArgs}`);
+	executeCmd(`tsc --watch ${args}`);
 }
 
 function lint() {
@@ -177,29 +187,40 @@ function lint() {
 	// rules.
 	executeCmd('eslint-config-prettier eslint.config.mjs');
 
+	const eslintIgnorePatternArgs = ESLINT_IGNORE_PATHS.map(
+		entry => `--ignore-pattern ${entry}`
+	).join(' ');
+	const eslintFiles = ESLINT_PATHS.join(' ');
+
 	executeCmd(
-		`eslint -c eslint.config.mjs --max-warnings 0 ${ESLINT_IGNORE_PATTERN_ARGS} ${ESLINT_PATHS}`
+		`eslint -c eslint.config.mjs --max-warnings 0 ${eslintIgnorePatternArgs} ${eslintFiles}`
 	);
 
-	executeCmd(`prettier --check ${PRETTIER_PATHS}`);
+	const prettierFiles = PRETTIER_PATHS.join(' ');
+
+	executeCmd(`prettier --check ${prettierFiles}`);
+
+	executeCmd('knip --config knip.config.mjs --treat-config-hints-as-errors');
 }
 
 function format() {
 	logInfo('format()');
 
-	executeCmd(`prettier --write ${PRETTIER_PATHS}`);
+	const prettierFiles = PRETTIER_PATHS.join(' ');
+
+	executeCmd(`prettier --write ${prettierFiles}`);
 }
 
-function test() {
+function test({ args = '' } = {}) {
 	logInfo('test()');
 
-	executeCmd(`jest --silent false --detectOpenHandles ${taskArgs}`);
+	executeCmd(`jest --silent false --detectOpenHandles ${args}`);
 }
 
-function coverage() {
+function coverage({ args = '' } = {}) {
 	logInfo('coverage()');
 
-	executeCmd(`jest --coverage ${taskArgs}`);
+	executeCmd(`jest --coverage ${args}`);
 	executeCmd('open-cli coverage/lcov-report/index.html');
 }
 
@@ -216,25 +237,124 @@ function installDeps() {
 	executeCmd('npm audit --omit dev');
 }
 
+/**
+ * `prepublishOnly` is run by NPM only on `npm publish` (not on `npm pack`,
+ * `npm install` or `npm ci`). We use it to forbid publishing mediasoup-client
+ * from a local machine. The package must only be published by the
+ * `mediasoup-client-npm-publish` workflow, which runs inside GitHub Actions
+ * (where GITHUB_ACTIONS environment variable is set to 'true') and uses OIDC
+ * trusted publishing.
+ */
+function prepublishOnly() {
+	logInfo('prepublishOnly()');
+
+	if (process.env.GITHUB_ACTIONS !== 'true') {
+		logError(
+			"prepublishOnly() | refusing to 'npm publish' outside of GitHub Actions: mediasoup-client is published only by the mediasoup-client-npm-publish workflow (triggered by pushing a release tag via 'npm run release')"
+		);
+
+		exitWithError();
+	}
+}
+
+function publishDryRun() {
+	logInfo('publishDryRun()');
+
+	// NOTE: We use `npm pack --dry-run` rather than `npm publish --dry-run`
+	// because the latter contacts the registry and fails with "You cannot
+	// publish over the previously published versions" whenever the version in
+	// package.json is already published (which is the usual state between
+	// releases), making it useless in CI.
+	//
+	// `npm pack --dry-run` still runs the `prepare` script (TypeScript build)
+	// and assembles the tarball exactly as a real publish would, reporting its
+	// contents without writing any file or contacting the registry. Useful to
+	// validate the `files` list in package.json and that the package builds
+	// before tagging a release.
+	executeCmd('npm pack --dry-run --loglevel warn');
+}
+
 function checkRelease() {
 	logInfo('checkRelease()');
 
 	installDeps();
 	buildTypescript({ force: true });
-	replaceVersion();
 	lint();
 	test();
+	// Validate packaging (the `files` list in package.json) before the
+	// irreversible release steps (git push, GitHub release, npm publish).
+	publishDryRun();
 }
 
-function release() {
+async function release({ args = '' } = {}) {
 	logInfo('release()');
 
+	const version = args.trim();
+
+	if (!/^\d+\.\d+\.\d+$/.test(version)) {
+		logError(
+			`release() | a SEMVER 'x.y.z' argument is required, but got '${version}'`
+		);
+
+		exitWithError();
+	}
+
+	// Must be on the main branch.
+	const branch = execSync('git rev-parse --abbrev-ref HEAD', {
+		encoding: 'utf-8',
+	}).trim();
+
+	if (branch !== MAIN_BRANCH) {
+		logError(
+			`release() | must be on '${MAIN_BRANCH}' branch, but it is on '${branch}' branch`
+		);
+
+		exitWithError();
+	}
+
+	// Clean working tree required before bumping the version.
+	checkGitClean();
+
+	// Lint, test, build, publish dry-run.
 	checkRelease();
-	executeCmd(`git commit -am '${pkg.version}'`);
-	executeCmd(`git tag -a ${pkg.version} -m '${pkg.version}'`);
-	executeCmd(`git push origin v${MAYOR_VERSION}`);
-	executeCmd(`git push origin '${pkg.version}'`);
-	executeInteractiveCmd('npm publish');
+
+	// Bump the version in package.json + package-lock.json.
+	executeCmd(`npm version ${version} --no-git-tag-version`);
+
+	// Also replace the version in the transpiled JS.
+	replaceVersion();
+
+	// Commit the bump, tag it, and push both. The pushed tag triggers
+	// `mediasoup-client-npm-publish` workflow, which checks, creates the GitHub
+	// release and publishes to NPM.
+	//
+	// The commit message carries a "[no-ci]" marker so the regular branch CI
+	// workflow skips this commit.
+	//
+	// NOTE: "[no-ci]" (with a hyphen) is a custom marker, NOT GitHub's native
+	// "[skip ci]"/"[no ci]" (which would also skip `mediasoup-client-npm-publish`
+	// workflow, since the tag push shares this same commit).
+	executeCmd(`git commit -am 'release ${version} [no-ci]'`);
+	executeCmd(`git tag -a ${version} -m '${version}'`);
+	executeCmd(`git push origin ${MAIN_BRANCH}`);
+	executeCmd(`git push origin '${version}'`);
+}
+
+function checkGitClean() {
+	logInfo('checkGitClean()');
+
+	const status = execSync('git status --porcelain', {
+		encoding: 'utf-8',
+		stdio: ['ignore', 'pipe', 'ignore'],
+	});
+
+	if (status.trim()) {
+		logError(
+			'checkGitClean() | Git working tree is not clean, commit or stash your changes first'
+		);
+
+		exitWithError();
+	}
 }
 
 function executeCmd(command) {
@@ -249,6 +369,7 @@ function executeCmd(command) {
 	}
 }
 
+// eslint-disable-next-line no-unused-vars
 function executeInteractiveCmd(command) {
 	logInfo(`executeInteractiveCmd(): ${command}`);
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mediasoup-client",
-	"version": "3.20.0",
+	"version": "3.22.0",
 	"description": "mediasoup client side TypeScript library",
 	"contributors": [
 		"Iñaki Baz Castillo <ibc@aliax.net> (https://inakibaz.me)",
@@ -61,41 +61,43 @@
 	],
 	"scripts": {
 		"prepare": "node npm-scripts.mjs prepare",
+		"prepublishOnly": "node npm-scripts.mjs prepublishOnly",
 		"typescript:build": "node npm-scripts.mjs typescript:build",
 		"typescript:watch": "node npm-scripts.mjs typescript:watch",
 		"lint": "node npm-scripts.mjs lint",
 		"format": "node npm-scripts.mjs format",
 		"test": "node npm-scripts.mjs test",
 		"coverage": "node npm-scripts.mjs coverage",
+		"publish:dry-run": "node npm-scripts.mjs publish:dry-run",
 		"release:check": "node npm-scripts.mjs release:check",
 		"release": "node npm-scripts.mjs release"
 	},
 	"dependencies": {
 		"@types/debug": "^4.1.13",
 		"@types/events-alias": "npm:@types/events@^3.0.3",
-		"awaitqueue": "^3.3.0",
+		"awaitqueue": "^3.3.1",
 		"debug": "^4.4.3",
 		"events-alias": "npm:events@^3.3.0",
 		"fake-mediastreamtrack": "^2.2.1",
-		"h264-profile-level-id": "^2.3.2",
+		"h264-profile-level-id": "^2.3.3",
 		"sdp-transform": "^3.0.0",
-		"supports-color": "^10.2.2"
+		"supports-color": "^11.0.0"
 	},
 	"devDependencies": {
 		"@eslint/js": "^10.0.1",
 		"@types/jest": "^30.0.0",
-		"@types/sdp-transform": "^2.15.0",
-		"@types/ua-parser-js": "^0.7.39",
-		"eslint": "^10.2.1",
+		"@types/sdp-transform": "^3.0.0",
+		"eslint": "^10.8.1",
 		"eslint-config-prettier": "^10.1.8",
-		"eslint-plugin-jest": "^29.15.2",
-		"eslint-plugin-prettier": "^5.5.5",
-		"globals": "^17.5.0",
-		"jest": "^30.3.0",
+		"eslint-plugin-jest": "^29.16.1",
+		"eslint-plugin-prettier": "^5.5.6",
+		"globals": "^17.11.0",
+		"jest": "^30.4.2",
+		"knip": "^6.32.2",
 		"open-cli": "^9.0.0",
-		"prettier": "^3.8.3",
-		"ts-jest": "^29.4.9",
-		"typescript": "^5.9.3",
-		"typescript-eslint": "^8.59.1"
+		"prettier": "^3.9.6",
+		"ts-jest": "^29.4.12",
+		"typescript": "^6.0.3",
+		"typescript-eslint": "^8.67.0"
 	}
 }

package/lib/handlers/sdp/MediaSection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MediaSection.d.ts","sourceRoot":"","sources":["../../../src/handlers/sdp/MediaSection.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,YAAY,MAAM,eAAe,CAAC;AAEnD,OAAO,KAAK,EACX,aAAa,EACb,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,kBAAkB,EAClB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EACX,SAAS,EACT,aAAa,EAGb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,8BAAsB,YAAY;IAEjC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,gBAAgB,CAAC;gBAEnD,EACX,aAAa,EACb,aAAa,EACb,cAAc,GACd,EAAE;QACF,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;QAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;KAChC;IAmDD,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAE1C,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,SAAS,IAAI,YAAY,CAAC,gBAAgB;IAI1C,gBAAgB,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAKpD,KAAK,IAAI,IAAI;IAIb,QAAQ,CAAC,MAAM,IAAI,IAAI;IAEvB,OAAO,IAAI,IAAI;IAIf,KAAK,IAAI,IAAI;CAuBb;AAED,qBAAa,kBAAmB,SAAQ,YAAY;gBACvC,EACX,aAAa,EACb,aAAa,EACb,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,GACZ,EAAE;QACF,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;QAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;QACxC,gBAAgB,EAAE,YAAY,CAAC,gBAAgB,CAAC;QAChD,kBAAkB,CAAC,EAAE,aAAa,CAAC;QACnC,mBAAmB,CAAC,EAAE,aAAa,CAAC;QACpC,YAAY,CAAC,EAAE,oBAAoB,CAAC;KACpC;IAiQD,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAsBjC,MAAM,IAAI,IAAI;IAId,mBAAmB,CAAC,SAAS,EAAE,wBAAwB,EAAE,GAAG,IAAI;CA6BhE;AAED,qBAAa,iBAAkB,SAAQ,YAAY;gBACtC,EACX,aAAa,EACb,aAAa,EACb,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,GAAG,EACH,IAAI,EACJ,kBAAkB,EAClB,QAAQ,EACR,OAAO,GACP,EAAE;QACF,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;QAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;QACxC,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,SAAS,GAAG,aAAa,CAAC;QAEhC,kBAAkB,CAAC,EAAE,aAAa,CAAC;QACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB;IA8ID,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAKjC,MAAM,IAAI,IAAI;CAGd"}