Merge latest changes

.github/workflows/janode-docs.yml

@@ -0,0 +1,39 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+      - test-docs
+    tags:
+      - v1.*
+jobs:
+  build-and-deploy:
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    runs-on: ubuntu-24.04
+    env:
+      REF_NAME: ${{ github.ref_name }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/jod
+      - run: npm ci
+      - run: npm run build-docs
+      - name: Add git reference to docs path
+        run: |
+          mkdir -p site/docs/$REF_NAME
+          cp -a docs/. site/docs/$REF_NAME
+      - name: Update "latest" docs for tagged versions
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          cp -a docs/. site/docs/latest
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          keep_files: true

.github/workflows/janode-lint.yml

@@ -0,0 +1,22 @@
+name: Lint Janode code
+
+on:
+  push:
+    branches:
+      - master
+      - test-lint
+  pull_request:
+    branches:
+      - master
+permissions:
+  contents: read
+jobs:
+  build-and-lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/jod
+      - run: npm ci
+      - run: npm run lint

.gitignore

@@ -1,6 +1,8 @@
 node_modules
 build
 out
+docs
+.vscode
 
 config.js
 bundle.js
@@ -12,3 +14,4 @@ bundle.js
 !.eslintrc.json
 !package.json
 !package-lock.json
+!jsdoc.json

README.md

@@ -6,15 +6,20 @@ Internally uses WebSockets or Unix DGRAM Sockets to connect to Janus.
 
 The library wraps the Janus core API, the Janus Admin API and some of the most popular plugins APIs.
 
-The supported Janus plugins currently are:
+The supported Janus plugins are:
 
 - EchoTest
 - AudioBridge
 - Streaming
 - VideoRoom
+- SIP
+- Record&Play
+- TextRoom (Janus API only)
 
 The library is available on [npm](https://www.npmjs.com/package/janode) and the source code is on [github](https://github.com/meetecho/janode).
 
+Online documentation can be found at [https://meetecho.github.io/janode](https://meetecho.github.io/janode).
+
 ## Example of usage
 
 This is just a pretty simple hello world for the echotest plugin.
@@ -141,3 +146,19 @@ You need to create a bundle with the core library and the needed plugins using a
 
 If you get the code from the repo, you can find a `rollup` bundling sample in the `bundle.sh` script under `examples/browser/`.
 The output will be a `bundle.js` script that defines an `App` global object with the members `Janode` and `EchoTestPlugin`.
+
+## How to build documentation
+
+First install the dev dependecies:
+
+```bash
+npm install
+```
+
+Then use the npm script:
+
+```bash
+npm run build-docs
+```
+
+Documentation in HTML format will be built under the `docs` folder.

eslint.config.js

@@ -0,0 +1,60 @@
+import { defineConfig } from 'eslint/config';
+import js from '@eslint/js';
+import globals from 'globals';
+
+export default defineConfig([
+  {
+    files: [
+      '*.js',
+      'src/**/*.js',
+      'examples/**/*.js'
+    ],
+    ignores: [
+      'examples/browser/**/*'
+    ],
+    plugins: {
+      js
+    },
+    extends: ['js/recommended'],
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.browser,
+        ...globals.node
+      }
+    },
+    rules: {
+      'no-unused-vars': [
+        'warn',
+        {
+          'args': 'all',
+          'vars': 'all',
+          'caughtErrors': 'all',
+          'argsIgnorePattern': '^_',
+          'varsIgnorePattern': '^_',
+          'caughtErrorsIgnorePattern': '^_'
+        }
+      ],
+      'no-empty': 'off',
+      // deprecated rules
+      'no-trailing-spaces': 'warn',
+      'indent': [
+        'warn',
+        2,
+        {
+          'SwitchCase': 1
+        }
+      ],
+      'quotes': [
+        'warn',
+        'single'
+      ],
+      'semi': [
+        'warn',
+        'always'
+      ],
+      'multiline-comment-style': 1
+    }
+  }
+]);

examples/audiobridge/html/audiobridge-client.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-sparse-arrays */
 /* global io */
 
 'use strict';
@@ -10,6 +9,7 @@ let pendingOfferMap = new Map();
 const myRoom = getURLParameter('room') ? parseInt(getURLParameter('room')) : (getURLParameter('room_str') || 1234);
 const randName = ('John_Doe_' + Math.floor(10000 * Math.random()));
 const myName = getURLParameter('name') || randName;
+let myFeed;
 const skipJoin = getURLParameter('skipjoin') || false;
 const skipOffer = getURLParameter('skipoffer') || false;
 
@@ -26,6 +26,7 @@ function getId() {
 }
 
 function getURLParameter(name) {
+  // eslint-disable-next-line no-sparse-arrays
   return decodeURIComponent((new RegExp('[?|&]' + name + '=' + '([^&;]+?)(&|#|;|$)').exec(location.search) || [, ''])[1].replace(/\+/g, '%20')) || null;
 }
 
@@ -50,11 +51,12 @@ const socket = io({
   reconnection: false,
 });
 
-function join({ room = myRoom, display = myName, muted = false, token = null, rtp_participant = null, group = null } = {}) {
+function join({ room = myRoom, display = myName, muted = false, suspended = false, token = null, rtp_participant = null, group = null } = {}) {
   const joinData = {
     room,
     display,
     muted,
+    suspended,
     token,
     rtp_participant,
     group,
@@ -251,6 +253,32 @@ function _listForward({ room = myRoom, secret = 'adminpwd' } = {}) {
   });
 }
 
+function _mutePeer({ room = myRoom, feed = myFeed, secret = 'adminpwd' } = {}) {
+  let muteData = {
+    room,
+    feed,
+    secret,
+  };
+
+  socket.emit('mute-peer', {
+    data: muteData,
+    _id: getId(),
+  });
+}
+
+function _unmutePeer({ room = myRoom, feed = myFeed, secret = 'adminpwd' } = {}) {
+  let unmuteData = {
+    room,
+    feed,
+    secret,
+  };
+
+  socket.emit('unmute-peer', {
+    data: unmuteData,
+    _id: getId(),
+  });
+}
+
 function _muteRoom({ room = myRoom, secret = 'adminpwd' } = {}) {
   let muteData = {
     room,
@@ -275,6 +303,35 @@ function _unmuteRoom({ room = myRoom, secret = 'adminpwd' } = {}) {
   });
 }
 
+function _suspend({ room = myRoom, feed = myFeed, stop_record = false, secret = 'adminpwd' } = {}) {
+  let suspendData = {
+    room,
+    feed,
+    stop_record,
+    secret,
+  };
+
+  socket.emit('suspend-peer', {
+    data: suspendData,
+    _id: getId(),
+  });
+}
+
+function _resume({ room = myRoom, feed = myFeed, record = false, filename, secret = 'adminpwd' } = {}) {
+  let resumeData = {
+    room,
+    feed,
+    record,
+    secret,
+  };
+  if (filename) resumeData.filename = filename;
+
+  socket.emit('resume-peer', {
+    data: resumeData,
+    _id: getId(),
+  });
+}
+
 socket.on('connect', () => {
   console.log('socket connected');
   socket.sendBuffer = [];
@@ -305,6 +362,7 @@ socket.on('audiobridge-error', ({ error, _id }) => {
 
 socket.on('joined', async ({ data }) => {
   console.log('you have joined to room', data);
+  myFeed = data.feed;
   removeAllAudioElements();
   closePC();
   setAudioElement(null, data.feed, data.display, data.room);
@@ -381,6 +439,14 @@ socket.on('peer-talking', ({ data }) => {
   console.log('peer talking notify', data);
 });
 
+socket.on('peer-suspended', ({ data }) => {
+  console.log('peer suspended notify', data);
+});
+
+socket.on('peer-resumed', ({ data }) => {
+  console.log('peer resumed notify', data);
+});
+
 socket.on('exists', ({ data }) => {
   console.log('room exists', data);
 });
@@ -420,6 +486,14 @@ socket.on('rtp-fwd-list', ({ data }) => {
   console.log('rtp forwarders list', data);
 });
 
+socket.on('peer-muted', ({ data }) => {
+  console.log('peer muted', data);
+});
+
+socket.on('peer-unmuted', ({ data }) => {
+  console.log('peer unmuted', data);
+});
+
 socket.on('room-muted', ({ data }) => {
   console.log('room muted', data);
 });