@4players/odin-common 2.16.1 → 2.17.1

package/eslint.config.mjs

@@ -0,0 +1,30 @@
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config({
+  plugins: { '@typescript-eslint': tseslint.plugin },
+  languageOptions: {
+    parser: tseslint.parser,
+    parserOptions: { ecmaVersion: 12, sourceType: 'module' },
+  },
+  files: ['**/src/*.ts'],
+  ignores: ['**/lib/*.ts', '**/lib/**/*.ts'],
+  rules: {
+    camelcase: 'off',
+    'comma-dangle': [
+      'error',
+      {
+        arrays: 'always-multiline',
+        objects: 'always-multiline',
+        imports: 'always-multiline',
+        exports: 'always-multiline',
+        functions: 'never',
+      },
+    ],
+    'no-unused-vars': 'off',
+    'no-use-before-define': 'off',
+    'space-before-function-paren': [
+      'error',
+      { anonymous: 'always', named: 'never', asyncArrow: 'always' },
+    ],
+  },
+});

package/lib/cjs/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.zod = void 0;
+exports.zod = require("zod");
 __exportStar(require("./schema/serialization"), exports);
 __exportStar(require("./schema/token"), exports);
 __exportStar(require("./schema/room"), exports);
@@ -26,6 +27,7 @@ __exportStar(require("./rpc/commands"), exports);
 __exportStar(require("./rpc/notifications"), exports);
 __exportStar(require("./utility/base64"), exports);
 __exportStar(require("./utility/bytearray"), exports);
+__exportStar(require("./utility/codec"), exports);
 __exportStar(require("./utility/iterable"), exports);
 __exportStar(require("./utility/environment"), exports);
 __exportStar(require("./utility/json"), exports);
@@ -39,4 +41,3 @@ __exportStar(require("./utility/uuid"), exports);
 __exportStar(require("./utility/validation"), exports);
 __exportStar(require("./utility/log"), exports);
 __exportStar(require("./plugin/api"), exports);
-exports.zod = require("zod");

package/lib/cjs/tsconfig.cjs.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/index.ts","../../src/plugin/api.ts","../../src/rpc/commands.ts","../../src/rpc/notifications.ts","../../src/schema/media.ts","../../src/schema/message.ts","../../src/schema/peer.ts","../../src/schema/room.ts","../../src/schema/serialization.ts","../../src/schema/token.ts","../../src/schema/webrtc.ts","../../src/utility/base64.spec.ts","../../src/utility/base64.ts","../../src/utility/bytearray.spec.ts","../../src/utility/bytearray.ts","../../src/utility/environment.spec.ts","../../src/utility/environment.ts","../../src/utility/iterable.spec.ts","../../src/utility/iterable.ts","../../src/utility/json.spec.ts","../../src/utility/json.ts","../../src/utility/log.spec.ts","../../src/utility/log.ts","../../src/utility/msgpack.spec.ts","../../src/utility/msgpack.ts","../../src/utility/result.spec.ts","../../src/utility/result.ts","../../src/utility/selector.spec.ts","../../src/utility/selector.ts","../../src/utility/sleep.spec.ts","../../src/utility/sleep.ts","../../src/utility/strand.spec.ts","../../src/utility/strand.ts","../../src/utility/url.spec.ts","../../src/utility/url.ts","../../src/utility/uuid.spec.ts","../../src/utility/uuid.ts","../../src/utility/validation.spec.ts","../../src/utility/validation.ts"],"version":"5.6.3"}
+{"root":["../../src/index.ts","../../src/plugin/api.ts","../../src/rpc/commands.ts","../../src/rpc/notifications.ts","../../src/schema/media.ts","../../src/schema/message.ts","../../src/schema/peer.ts","../../src/schema/room.ts","../../src/schema/serialization.ts","../../src/schema/token.ts","../../src/schema/webrtc.ts","../../src/utility/base64.spec.ts","../../src/utility/base64.ts","../../src/utility/bytearray.spec.ts","../../src/utility/bytearray.ts","../../src/utility/codec.spec.ts","../../src/utility/codec.ts","../../src/utility/environment.spec.ts","../../src/utility/environment.ts","../../src/utility/iterable.spec.ts","../../src/utility/iterable.ts","../../src/utility/json.spec.ts","../../src/utility/json.ts","../../src/utility/log.spec.ts","../../src/utility/log.ts","../../src/utility/msgpack.spec.ts","../../src/utility/msgpack.ts","../../src/utility/result.spec.ts","../../src/utility/result.ts","../../src/utility/selector.spec.ts","../../src/utility/selector.ts","../../src/utility/sleep.spec.ts","../../src/utility/sleep.ts","../../src/utility/strand.spec.ts","../../src/utility/strand.ts","../../src/utility/url.spec.ts","../../src/utility/url.ts","../../src/utility/uuid.spec.ts","../../src/utility/uuid.ts","../../src/utility/validation.spec.ts","../../src/utility/validation.ts"],"version":"5.6.3"}

package/lib/cjs/utility/codec.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VideoCodec = void 0;
+const sdp_transform_1 = require("sdp-transform");
+const result_1 = require("./result");
+const validCodecs = ['VP8', 'VP9', 'AV1', 'H264'];
+class VideoCodec {
+    constructor(codec) {
+        this.codec = codec;
+        this.channels = 0;
+        this.clockRate = 90000;
+    }
+    valid() {
+        return validCodecs.includes(this.codec);
+    }
+    supported() {
+        var _a, _b, _c;
+        if (typeof RTCRtpReceiver === 'undefined' ||
+            typeof RTCRtpReceiver.getCapabilities === 'undefined') {
+            return false;
+        }
+        const expectedMimeType = (0, result_1.unwrapOr)(this.mimeType(), '').toLowerCase();
+        const expectedFmtpLine = new Set((0, result_1.unwrapOr)(this.sdpFmtpLine(), '')
+            .split(';')
+            .map((arg) => arg.trim().toLowerCase()));
+        return ((_c = (_b = (_a = RTCRtpReceiver.getCapabilities('video')) === null || _a === void 0 ? void 0 : _a.codecs) === null || _b === void 0 ? void 0 : _b.some((c) => {
+            var _a;
+            const actualMimeType = c.mimeType.toLowerCase();
+            const actualFmtpLine = new Set(((_a = c.sdpFmtpLine) !== null && _a !== void 0 ? _a : '')
+                .split(';')
+                .map((arg) => arg.trim().toLowerCase()));
+            console.log(actualMimeType, actualFmtpLine);
+            if (expectedMimeType !== actualMimeType)
+                return false;
+            if (expectedFmtpLine.size !== actualFmtpLine.size)
+                return false;
+            for (let item of expectedFmtpLine) {
+                if (!actualFmtpLine.has(item))
+                    return false;
+            }
+            return true;
+        })) !== null && _c !== void 0 ? _c : false);
+    }
+    filterSdp(description) {
+        if (!this.valid()) {
+            return description;
+        }
+        const sdp = (0, sdp_transform_1.parse)(description);
+        const payload = (0, result_1.unwrap)(this.payloadType());
+        const config = (0, result_1.unwrap)(this.sdpFmtpLine());
+        sdp.media = sdp.media.map((media) => {
+            media.payloads = '';
+            media.rtp = [];
+            media.fmtp = [];
+            media.rtcpFb = [];
+            media.payloads = String(payload);
+            media.rtp.push({ payload, codec: this.codec, rate: this.clockRate });
+            if (this.sdpFmtpLine()) {
+                media.fmtp.push({ payload, config });
+            }
+            media.rtcpFb.push({ payload, type: 'goog-remb' });
+            media.rtcpFb.push({ payload, type: 'transport-cc' });
+            media.rtcpFb.push({ payload, type: 'ccm', subtype: 'fir' });
+            media.rtcpFb.push({ payload, type: 'nack' });
+            media.rtcpFb.push({ payload, type: 'nack', subtype: 'pli' });
+            return media;
+        });
+        return (0, sdp_transform_1.write)(sdp);
+    }
+    payloadType() {
+        switch (this.codec) {
+            case 'VP8':
+                return (0, result_1.success)(96);
+            case 'VP9':
+                return (0, result_1.success)(98);
+            case 'AV1':
+                return (0, result_1.success)(41);
+            case 'H264':
+                return (0, result_1.success)(102);
+            default:
+                return (0, result_1.failure)('invalid video codec');
+        }
+    }
+    mimeType() {
+        switch (this.codec) {
+            case 'VP8':
+                return (0, result_1.success)('video/VP8');
+            case 'VP9':
+                return (0, result_1.success)('video/VP9');
+            case 'AV1':
+                return (0, result_1.success)('video/AV1');
+            case 'H264':
+                return (0, result_1.success)('video/H264');
+            default:
+                return (0, result_1.failure)('invalid video codec');
+        }
+    }
+    sdpFmtpLine() {
+        switch (this.codec) {
+            case 'VP8':
+                return (0, result_1.success)('');
+            case 'VP9':
+                return (0, result_1.success)(
+                // using high-bit-depth variant profile
+                'profile-id=2');
+            case 'AV1':
+                return (0, result_1.success)(
+                // using baseline profile (https://aomediacodec.github.io/av1-rtp-spec/#72-sdp-parameters)
+                'level-idx=5;profile=0;tier=0');
+            case 'H264':
+                return (0, result_1.success)(
+                // using baseline profile
+                'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=42e01f');
+            default:
+                return (0, result_1.failure)('invalid video codec');
+        }
+    }
+}
+exports.VideoCodec = VideoCodec;

package/lib/cjs/utility/log.js

@@ -1,6 +1,4 @@
 "use strict";
-/* eslint-disable no-dupe-class-members */
-/* eslint-disable no-redeclare */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogHandler = exports.PRETTY_FORMATTER = exports.DEFAULT_FORMATTER = exports.Logger = exports.LogFunctions = exports.LogSymbols = exports.LogLevelNames = exports.LogLevels = exports.LogVerbosity = void 0;
 exports.getLevelByName = getLevelByName;

package/lib/cjs/utility/result.js

@@ -1,11 +1,11 @@
 "use strict";
-/* eslint-disable no-redeclare */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.assert = assert;
 exports.fail = fail;
 exports.success = success;
 exports.failure = failure;
 exports.unwrap = unwrap;
+exports.unwrapOr = unwrapOr;
 function assert(condition, message) {
     if (!condition) {
         fail(message);
@@ -26,3 +26,6 @@ function unwrap(result) {
     }
     return result.value;
 }
+function unwrapOr(result, fallback) {
+    return result.type === 'Success' ? result.value : fallback;
+}

package/lib/cjs/utility/sleep.js

@@ -1,5 +1,4 @@
 "use strict";
-/* eslint-disable no-redeclare */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sleep = sleep;
 exports.abortableSleep = abortableSleep;

package/lib/esm/index.js

@@ -1,3 +1,5 @@
+import * as zod_1 from 'zod';
+export { zod_1 as zod };
 export * from './schema/serialization';
 export * from './schema/token';
 export * from './schema/room';
@@ -9,6 +11,7 @@ export * from './rpc/commands';
 export * from './rpc/notifications';
 export * from './utility/base64';
 export * from './utility/bytearray';
+export * from './utility/codec';
 export * from './utility/iterable';
 export * from './utility/environment';
 export * from './utility/json';
@@ -22,5 +25,3 @@ export * from './utility/uuid';
 export * from './utility/validation';
 export * from './utility/log';
 export * from './plugin/api';
-import * as zod_1 from 'zod';
-export { zod_1 as zod };

package/lib/esm/tsconfig.esm.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/index.ts","../../src/plugin/api.ts","../../src/rpc/commands.ts","../../src/rpc/notifications.ts","../../src/schema/media.ts","../../src/schema/message.ts","../../src/schema/peer.ts","../../src/schema/room.ts","../../src/schema/serialization.ts","../../src/schema/token.ts","../../src/schema/webrtc.ts","../../src/utility/base64.spec.ts","../../src/utility/base64.ts","../../src/utility/bytearray.spec.ts","../../src/utility/bytearray.ts","../../src/utility/environment.spec.ts","../../src/utility/environment.ts","../../src/utility/iterable.spec.ts","../../src/utility/iterable.ts","../../src/utility/json.spec.ts","../../src/utility/json.ts","../../src/utility/log.spec.ts","../../src/utility/log.ts","../../src/utility/msgpack.spec.ts","../../src/utility/msgpack.ts","../../src/utility/result.spec.ts","../../src/utility/result.ts","../../src/utility/selector.spec.ts","../../src/utility/selector.ts","../../src/utility/sleep.spec.ts","../../src/utility/sleep.ts","../../src/utility/strand.spec.ts","../../src/utility/strand.ts","../../src/utility/url.spec.ts","../../src/utility/url.ts","../../src/utility/uuid.spec.ts","../../src/utility/uuid.ts","../../src/utility/validation.spec.ts","../../src/utility/validation.ts"],"version":"5.6.3"}
+{"root":["../../src/index.ts","../../src/plugin/api.ts","../../src/rpc/commands.ts","../../src/rpc/notifications.ts","../../src/schema/media.ts","../../src/schema/message.ts","../../src/schema/peer.ts","../../src/schema/room.ts","../../src/schema/serialization.ts","../../src/schema/token.ts","../../src/schema/webrtc.ts","../../src/utility/base64.spec.ts","../../src/utility/base64.ts","../../src/utility/bytearray.spec.ts","../../src/utility/bytearray.ts","../../src/utility/codec.spec.ts","../../src/utility/codec.ts","../../src/utility/environment.spec.ts","../../src/utility/environment.ts","../../src/utility/iterable.spec.ts","../../src/utility/iterable.ts","../../src/utility/json.spec.ts","../../src/utility/json.ts","../../src/utility/log.spec.ts","../../src/utility/log.ts","../../src/utility/msgpack.spec.ts","../../src/utility/msgpack.ts","../../src/utility/result.spec.ts","../../src/utility/result.ts","../../src/utility/selector.spec.ts","../../src/utility/selector.ts","../../src/utility/sleep.spec.ts","../../src/utility/sleep.ts","../../src/utility/strand.spec.ts","../../src/utility/strand.ts","../../src/utility/url.spec.ts","../../src/utility/url.ts","../../src/utility/uuid.spec.ts","../../src/utility/uuid.ts","../../src/utility/validation.spec.ts","../../src/utility/validation.ts"],"version":"5.6.3"}

package/lib/esm/utility/codec.js

@@ -0,0 +1,115 @@
+import { parse, write } from 'sdp-transform';
+import { failure, success, unwrap, unwrapOr } from './result';
+const validCodecs = ['VP8', 'VP9', 'AV1', 'H264'];
+export class VideoCodec {
+    constructor(codec) {
+        this.codec = codec;
+        this.channels = 0;
+        this.clockRate = 90000;
+    }
+    valid() {
+        return validCodecs.includes(this.codec);
+    }
+    supported() {
+        var _a, _b, _c;
+        if (typeof RTCRtpReceiver === 'undefined' ||
+            typeof RTCRtpReceiver.getCapabilities === 'undefined') {
+            return false;
+        }
+        const expectedMimeType = unwrapOr(this.mimeType(), '').toLowerCase();
+        const expectedFmtpLine = new Set(unwrapOr(this.sdpFmtpLine(), '')
+            .split(';')
+            .map((arg) => arg.trim().toLowerCase()));
+        return ((_c = (_b = (_a = RTCRtpReceiver.getCapabilities('video')) === null || _a === void 0 ? void 0 : _a.codecs) === null || _b === void 0 ? void 0 : _b.some((c) => {
+            var _a;
+            const actualMimeType = c.mimeType.toLowerCase();
+            const actualFmtpLine = new Set(((_a = c.sdpFmtpLine) !== null && _a !== void 0 ? _a : '')
+                .split(';')
+                .map((arg) => arg.trim().toLowerCase()));
+            console.log(actualMimeType, actualFmtpLine);
+            if (expectedMimeType !== actualMimeType)
+                return false;
+            if (expectedFmtpLine.size !== actualFmtpLine.size)
+                return false;
+            for (let item of expectedFmtpLine) {
+                if (!actualFmtpLine.has(item))
+                    return false;
+            }
+            return true;
+        })) !== null && _c !== void 0 ? _c : false);
+    }
+    filterSdp(description) {
+        if (!this.valid()) {
+            return description;
+        }
+        const sdp = parse(description);
+        const payload = unwrap(this.payloadType());
+        const config = unwrap(this.sdpFmtpLine());
+        sdp.media = sdp.media.map((media) => {
+            media.payloads = '';
+            media.rtp = [];
+            media.fmtp = [];
+            media.rtcpFb = [];
+            media.payloads = String(payload);
+            media.rtp.push({ payload, codec: this.codec, rate: this.clockRate });
+            if (this.sdpFmtpLine()) {
+                media.fmtp.push({ payload, config });
+            }
+            media.rtcpFb.push({ payload, type: 'goog-remb' });
+            media.rtcpFb.push({ payload, type: 'transport-cc' });
+            media.rtcpFb.push({ payload, type: 'ccm', subtype: 'fir' });
+            media.rtcpFb.push({ payload, type: 'nack' });
+            media.rtcpFb.push({ payload, type: 'nack', subtype: 'pli' });
+            return media;
+        });
+        return write(sdp);
+    }
+    payloadType() {
+        switch (this.codec) {
+            case 'VP8':
+                return success(96);
+            case 'VP9':
+                return success(98);
+            case 'AV1':
+                return success(41);
+            case 'H264':
+                return success(102);
+            default:
+                return failure('invalid video codec');
+        }
+    }
+    mimeType() {
+        switch (this.codec) {
+            case 'VP8':
+                return success('video/VP8');
+            case 'VP9':
+                return success('video/VP9');
+            case 'AV1':
+                return success('video/AV1');
+            case 'H264':
+                return success('video/H264');
+            default:
+                return failure('invalid video codec');
+        }
+    }
+    sdpFmtpLine() {
+        switch (this.codec) {
+            case 'VP8':
+                return success('');
+            case 'VP9':
+                return success(
+                // using high-bit-depth variant profile
+                'profile-id=2');
+            case 'AV1':
+                return success(
+                // using baseline profile (https://aomediacodec.github.io/av1-rtp-spec/#72-sdp-parameters)
+                'level-idx=5;profile=0;tier=0');
+            case 'H264':
+                return success(
+                // using baseline profile
+                'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=42e01f');
+            default:
+                return failure('invalid video codec');
+        }
+    }
+}

package/lib/esm/utility/log.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-dupe-class-members */
-/* eslint-disable no-redeclare */
 import { failure, success, unwrap } from './result';
 import { isNumber } from './validation';
 export var LogVerbosity;

package/lib/esm/utility/result.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-redeclare */
 export function assert(condition, message) {
     if (!condition) {
         fail(message);
@@ -19,3 +18,6 @@ export function unwrap(result) {
     }
     return result.value;
 }
+export function unwrapOr(result, fallback) {
+    return result.type === 'Success' ? result.value : fallback;
+}

package/lib/esm/utility/sleep.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-redeclare */
 export function sleep(ms, value) {
     if (ms <= 0) {
         return Promise.resolve(value);

package/lib/index.d.ts

@@ -1,3 +1,4 @@
+export * as zod from 'zod';
 export * from './schema/serialization';
 export * from './schema/token';
 export * from './schema/room';
@@ -9,6 +10,7 @@ export * from './rpc/commands';
 export * from './rpc/notifications';
 export * from './utility/base64';
 export * from './utility/bytearray';
+export * from './utility/codec';
 export * from './utility/iterable';
 export * from './utility/environment';
 export * from './utility/json';
@@ -22,4 +24,3 @@ export * from './utility/uuid';
 export * from './utility/validation';
 export * from './utility/log';
 export * from './plugin/api';
-export * as zod from 'zod';

package/lib/utility/codec.d.ts

@@ -0,0 +1,16 @@
+import { Result } from './result';
+declare const validCodecs: readonly ["VP8", "VP9", "AV1", "H264"];
+export type Codec = (typeof validCodecs)[number];
+export declare class VideoCodec {
+    readonly codec: Codec;
+    readonly channels = 0;
+    readonly clockRate = 90000;
+    constructor(codec: Codec);
+    valid(): boolean;
+    supported(): boolean;
+    filterSdp(description: string): string;
+    payloadType(): Result<number>;
+    mimeType(): Result<string>;
+    sdpFmtpLine(): Result<string>;
+}
+export {};

package/lib/utility/result.d.ts

@@ -13,5 +13,6 @@ export declare function success<T>(value: T): Success<T>;
 export declare function success(value: void): Success<void>;
 export declare function failure(reason: string): Failure;
 export declare function unwrap<T>(result: Result<T>): T;
+export declare function unwrapOr<T>(result: Result<T>, fallback: T): T;
 export type Accept<T> = (result: T) => void;
 export type Reject = (reason: Error) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-common",
-  "version": "2.16.1",
+  "version": "2.17.1",
   "description": "A collection of commonly used type definitions and utility functions across ODIN web projects",
   "author": "Josho Bleicker <josho.bleicker@4players.io> (https://www.4players.io)",
   "homepage": "https://www.4players.io",
@@ -21,27 +21,27 @@
     "clean": "rimraf lib",
     "build": "tsc -b ./tsconfig.cjs.json ./tsconfig.esm.json",
     "format": "prettier 'src/**/*.ts' --write",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint .",
     "test": "testyts"
   },
   "dependencies": {
-    "@msgpack/msgpack": "~3.0.0-beta2",
+    "@msgpack/msgpack": "~3.0.0",
+    "sdp-transform": "~2.15.0",
     "uuid": "~11.0.0",
-    "zod": "~3.23.0"
+    "zod": "~3.24.0"
   },
   "devDependencies": {
-    "@types/node": "~22.10.0",
+    "@types/node": "~22.13.0",
+    "@types/sdp-transform": "~2.4.0",
     "@types/uuid": "~10.0.0",
-    "@typescript-eslint/eslint-plugin": "~8.17.0",
-    "@typescript-eslint/parser": "~8.17.0",
-    "eslint": "~8.57.0",
-    "eslint-config-semistandard": "~17.0.0",
+    "eslint": "~9.20.0",
     "eslint-plugin-import": "~2.31.0",
     "eslint-plugin-node": "~11.1.0",
-    "eslint-plugin-promise": "~6.6.0",
-    "prettier": "~3.4.0",
+    "eslint-plugin-promise": "~7.2.0",
+    "prettier": "~3.5.0",
     "rimraf": "~6.0.0",
     "testyts": "~1.5.0",
-    "typescript": "~5.6.0"
+    "typescript": "~5.6.0",
+    "typescript-eslint": "~8.24.0"
   }
 }