Recording rev alt

.eslintrc.cjs

@@ -0,0 +1,97 @@
+module.exports = {
+    extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:node/recommended",
+        "plugin:prettier/recommended"
+    ],
+    parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: "module",
+        project: "./tsconfig.json",
+        tsconfigRootDir: __dirname
+    },
+    env: {
+        node: true,
+        browser: false,
+        es2022: true
+    },
+    parser: "@typescript-eslint/parser",
+    plugins: ["@typescript-eslint"],
+    overrides: [
+        {
+            files: [".eslintrc.cjs", "jest.config.cjs"],
+            parserOptions: {
+                project: null
+            }
+        },
+        {
+            files: ["tests/utils/*.ts", "tests/*.ts"],
+            plugins: ["jest", "import"],
+            env: {
+                jest: true,
+                "jest/globals": true
+            },
+            extends: ["plugin:jest/recommended"]
+        },
+        {
+            files: ["src/client.ts"],
+            env: {
+                browser: true,
+                node: false
+            }
+        },
+        {
+            files: ["src/shared/*.ts"],
+            env: {
+                browser: true,
+                node: true
+            }
+        }
+    ],
+    ignorePatterns: "dist/*",
+    rules: {
+        "prettier/prettier": [
+            "error",
+            {
+                tabWidth: 4,
+                semi: true,
+                singleQuote: false,
+                printWidth: 100,
+                endOfLine: "auto",
+                trailingComma: "none"
+            }
+        ],
+        "node/no-unsupported-features/es-syntax": "off",
+        "node/no-missing-import": "off",
+        "comma-dangle": "off",
+        "no-console": "error",
+        "no-undef": "error",
+        "no-restricted-globals": ["error", "event", "self"],
+        "no-const-assign": ["error"],
+        "no-debugger": ["error"],
+        "no-dupe-class-members": ["error"],
+        "no-dupe-keys": ["error"],
+        "no-dupe-args": ["error"],
+        "no-dupe-else-if": ["error"],
+        "no-unsafe-negation": ["error"],
+        "no-duplicate-imports": ["error"],
+        "valid-typeof": ["error"],
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            { vars: "all", args: "none", ignoreRestSiblings: false, caughtErrors: "all" }
+        ],
+        curly: ["error", "all"],
+        "no-restricted-syntax": ["error", "PrivateIdentifier"],
+        "prefer-const": [
+            "error",
+            {
+                destructuring: "all",
+                ignoreReadBeforeAssign: true
+            }
+        ]
+    },
+    globals: {
+        NodeJS: "readonly"
+    }
+};

README.md

@@ -11,6 +11,7 @@ the SFU and a [client bundle/library](#client-api-bundle) to connect to it.
 
 ## Prerequisites
 - [Node.js 22.16.0 (LTS)](https://nodejs.org/en/download)
+- [FFmpeg 8](https://ffmpeg.org/download.html) (if using the recording feature)
 
 ## Before deployment
 
@@ -53,6 +54,8 @@ The available environment variables are:
 - **MAX_BITRATE_OUT**: if set, limits the outgoing bitrate per session (user), defaults to 10mbps
 - **MAX_VIDEO_BITRATE**: if set, defines the `maxBitrate` of the highest encoding layer (simulcast), defaults to 4mbps
 - **CHANNEL_SIZE**: the maximum amount of users per channel, defaults to 100
+- **RECORDING**: enables the recording feature, defaults to false
+- **RECORDING_PATH**: the path where the recordings will be saved, defaults to `${tmpDir}/recordings`.
 - **WORKER_LOG_LEVEL**: "none" | "error" | "warn" | "debug", will only work if `DEBUG` is properly set.
 - **LOG_LEVEL**: "none" | "error" | "warn" | "info" | "debug" | "verbose"
 - **LOG_TIMESTAMP**: adds a timestamp to the log lines, defaults to true, to disable it, set to "disable", "false", "none", "no" or "0"

jest.config.cjs

@@ -6,5 +6,5 @@ module.exports = {
     maxWorkers: 4,
     preset: "ts-jest",
     testEnvironment: "node",
-    extensionsToTreatAsEsm: [".ts"],
+    extensionsToTreatAsEsm: [".ts"]
 };