@lsdsoftware/janus-client-node 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 LSD Software
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,2 @@
1
+ # janus-client-node
2
+ Janus WebSocket client for Node, built on RxJS observables
package/dist/client.js ADDED
@@ -0,0 +1,60 @@
1
+ import { connect } from "@service-broker/websocket";
2
+ import assert from "assert";
3
+ import * as rxjs from "rxjs";
4
+ import { JanusError } from "./types.js";
5
+ export function createClient(websocketUrl, websocketOpts) {
6
+ return connect(websocketUrl, websocketOpts, 'janus-protocol').pipe(rxjs.map(conn => {
7
+ const requestSubject = new rxjs.Subject();
8
+ const pendingRequests = new Map();
9
+ return {
10
+ requestSubject,
11
+ send$: requestSubject.pipe(rxjs.concatMap(request => {
12
+ const txId = String(Math.random());
13
+ request.message.transaction = txId;
14
+ return new rxjs.Observable(subscriber => conn.send(JSON.stringify(request.message), err => {
15
+ if (err) {
16
+ subscriber.next(new Error('JanusClient sendMessage fail', { cause: err }));
17
+ subscriber.complete();
18
+ }
19
+ else {
20
+ subscriber.complete();
21
+ pendingRequests.set(txId, request);
22
+ }
23
+ }));
24
+ }), rxjs.share()),
25
+ receive$: conn.message$.pipe(rxjs.concatMap(event => {
26
+ try {
27
+ assert(typeof event.data == 'string');
28
+ const message = JSON.parse(event.data);
29
+ if (message.janus == 'event' && typeof message.transaction == 'undefined') {
30
+ return rxjs.of(message);
31
+ }
32
+ else {
33
+ const request = pendingRequests.get(message.transaction);
34
+ if (request) {
35
+ pendingRequests.delete(message.transaction);
36
+ if (message.janus == 'error') {
37
+ const { code, reason } = message.error;
38
+ request.reject(new JanusError(code, reason));
39
+ }
40
+ else {
41
+ request.fulfill(message);
42
+ }
43
+ return rxjs.EMPTY;
44
+ }
45
+ else {
46
+ throw new Error('Stray');
47
+ }
48
+ }
49
+ }
50
+ catch (err) {
51
+ if (err instanceof Error)
52
+ err.cause = event.data;
53
+ return rxjs.of(new Error('JanusClient processMessage fail', { cause: err }));
54
+ }
55
+ }), rxjs.share()),
56
+ close$: conn.close$,
57
+ close: conn.close.bind(conn)
58
+ };
59
+ }));
60
+ }
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ export * from "./types.js";
2
+ export * from "./client.js";
3
+ export * from "./session.js";
4
+ export * from "./plugin-handle.js";
5
+ export * from "./util.js";
@@ -0,0 +1,39 @@
1
+ import { afterEverything, describe, expect, Expectation } from "@service-broker/test-utils";
2
+ import assert from "assert";
3
+ import * as rxjs from "rxjs";
4
+ import { createClient, createPluginHandle, createSession, JanusError, request } from "./index.js";
5
+ const requestSubject = new rxjs.ReplaySubject();
6
+ const shutdownSubject = new rxjs.Subject();
7
+ assert(process.env.JANUS_URL, 'Missing env JANUS_URL');
8
+ createClient(process.env.JANUS_URL).pipe(rxjs.tap(() => console.info('JanusClient connected')),
9
+ //rxjs.retry({ delay: 15_000 }),
10
+ //rxjs.repeat({ delay: 1_000 }),
11
+ rxjs.exhaustMap(client => rxjs.merge(client.send$, client.receive$, createSession(client).pipe(rxjs.tap(() => console.info('JanusSession created')), rxjs.exhaustMap(session => rxjs.merge(session.send$, session.keepAlive$, createPluginHandle(session, 'janus.plugin.videoroom').pipe(rxjs.tap(() => console.info('JanusPluginHandle attached')), rxjs.exhaustMap(handle => rxjs.merge(handle.send$, requestSubject.pipe(rxjs.concatMap(request => {
12
+ handle.requestSubject.next(request);
13
+ return rxjs.EMPTY;
14
+ }))).pipe(rxjs.finalize(() => handle.detach()))))).pipe(rxjs.finalize(() => session.destroy()))))).pipe(rxjs.takeUntil(client.close$), rxjs.finalize(() => client.close()))), rxjs.takeUntil(shutdownSubject)).subscribe({
15
+ next(event) {
16
+ if (event instanceof Error)
17
+ console.error(event);
18
+ else if (event instanceof JanusError)
19
+ console.error('JanusError', event);
20
+ else
21
+ console.info('Unhandled', event);
22
+ },
23
+ error(err) {
24
+ console.error('FATAL', err);
25
+ }
26
+ });
27
+ afterEverything(() => shutdownSubject.next());
28
+ function req(message) {
29
+ return rxjs.firstValueFrom(request(requestSubject, message));
30
+ }
31
+ describe('main', ({ test }) => {
32
+ test('first', async () => {
33
+ const result = await req({ request: 'list' });
34
+ expect(result, {
35
+ videoroom: 'success',
36
+ list: new Expectation('is', 'array', actual => assert(Array.isArray(actual)))
37
+ });
38
+ });
39
+ });
@@ -0,0 +1,41 @@
1
+ import * as rxjs from "rxjs";
2
+ import { JanusError } from "./types.js";
3
+ import { request } from "./util.js";
4
+ export function createPluginHandle(session, plugin) {
5
+ return request(session.requestSubject, { janus: "attach", plugin }).pipe(rxjs.map(({ data: { id: handleId } }) => {
6
+ const requestSubject = new rxjs.Subject();
7
+ return {
8
+ requestSubject,
9
+ send$: requestSubject.pipe(rxjs.concatMap(request => {
10
+ session.requestSubject.next({
11
+ message: {
12
+ janus: "message",
13
+ handle_id: handleId,
14
+ body: request.message
15
+ },
16
+ fulfill(response) {
17
+ const { data } = response.plugindata;
18
+ if (data.error) {
19
+ const { error, error_code } = data;
20
+ request.reject(new JanusError(error_code, error));
21
+ }
22
+ else {
23
+ request.fulfill(data);
24
+ }
25
+ },
26
+ reject(err) {
27
+ request.reject(err);
28
+ }
29
+ });
30
+ return rxjs.EMPTY;
31
+ })),
32
+ detach() {
33
+ session.requestSubject.next({
34
+ message: { janus: "detach" },
35
+ fulfill: rxjs.noop,
36
+ reject: err => console.error('JanusPluginHandle detach fail', handleId, err)
37
+ });
38
+ }
39
+ };
40
+ }));
41
+ }
@@ -0,0 +1,32 @@
1
+ import * as rxjs from "rxjs";
2
+ import { request } from "./util.js";
3
+ export function createSession(client, { keepAliveInterval = 45_000 } = {}) {
4
+ return request(client.requestSubject, { janus: 'create' }).pipe(rxjs.map(({ data: { id: sessionId } }) => {
5
+ const requestSubject = new rxjs.Subject();
6
+ return {
7
+ requestSubject,
8
+ send$: requestSubject.pipe(rxjs.concatMap(request => {
9
+ request.message.session_id = sessionId;
10
+ client.requestSubject.next(request);
11
+ return rxjs.EMPTY;
12
+ })),
13
+ keepAlive$: requestSubject.pipe(rxjs.switchMap(() => rxjs.interval(keepAliveInterval).pipe(rxjs.switchMap(() => new rxjs.Observable(subscriber => client.requestSubject.next({
14
+ message: { janus: "keepalive", session_id: sessionId },
15
+ fulfill() {
16
+ subscriber.complete();
17
+ },
18
+ reject(err) {
19
+ subscriber.next(err);
20
+ subscriber.complete();
21
+ }
22
+ })))))),
23
+ destroy() {
24
+ client.requestSubject.next({
25
+ message: { janus: 'destroy' },
26
+ fulfill: rxjs.noop,
27
+ reject: err => console.error('JanusSession destroy fail', sessionId, err)
28
+ });
29
+ }
30
+ };
31
+ }));
32
+ }
package/dist/types.js ADDED
@@ -0,0 +1,8 @@
1
+ export class JanusError {
2
+ code;
3
+ reason;
4
+ constructor(code, reason) {
5
+ this.code = code;
6
+ this.reason = reason;
7
+ }
8
+ }
package/dist/util.js ADDED
@@ -0,0 +1,13 @@
1
+ import * as rxjs from "rxjs";
2
+ export function request(requestSubject, message) {
3
+ return new rxjs.Observable(subscriber => requestSubject.next({
4
+ message,
5
+ fulfill(response) {
6
+ subscriber.next(response);
7
+ subscriber.complete();
8
+ },
9
+ reject(err) {
10
+ subscriber.error(err);
11
+ }
12
+ }));
13
+ }
package/package.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "name": "@lsdsoftware/janus-client-node",
3
+ "version": "1.0.0",
4
+ "description": "Janus WebSocket client for Node, built on RxJS observables",
5
+ "keywords": [
6
+ "janus",
7
+ "janus-client",
8
+ "janus-gateway",
9
+ "websocket",
10
+ "rxjs"
11
+ ],
12
+ "homepage": "https://github.com/lsdsoftware/janus-client-node#readme",
13
+ "bugs": {
14
+ "url": "https://github.com/lsdsoftware/janus-client-node/issues"
15
+ },
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "git+https://github.com/lsdsoftware/janus-client-node.git"
19
+ },
20
+ "license": "MIT",
21
+ "author": "Hai Phan <hai.phan@gmail.com>",
22
+ "type": "module",
23
+ "main": "dist/index.js",
24
+ "scripts": {
25
+ "build": "tsc",
26
+ "test": "node dist/index.test.js"
27
+ },
28
+ "dependencies": {
29
+ "@service-broker/websocket": "^1.1.0"
30
+ },
31
+ "devDependencies": {
32
+ "@service-broker/test-utils": "^1.1.2",
33
+ "typescript": "^5.9.3"
34
+ }
35
+ }
package/src/client.ts ADDED
@@ -0,0 +1,67 @@
1
+ import { connect } from "@service-broker/websocket"
2
+ import assert from "assert"
3
+ import { ClientRequestArgs } from "http"
4
+ import * as rxjs from "rxjs"
5
+ import { ClientOptions } from "ws"
6
+ import { JanusError, JanusMessage, JanusRequest } from "./types.js"
7
+
8
+ export function createClient(websocketUrl: string, websocketOpts?: ClientOptions | ClientRequestArgs) {
9
+ return connect(websocketUrl, websocketOpts, 'janus-protocol').pipe(
10
+ rxjs.map(conn => {
11
+ const requestSubject = new rxjs.Subject<JanusRequest>()
12
+ const pendingRequests = new Map<unknown, JanusRequest>()
13
+ return {
14
+ requestSubject,
15
+ send$: requestSubject.pipe(
16
+ rxjs.concatMap(request => {
17
+ const txId = String(Math.random())
18
+ request.message.transaction = txId
19
+ return new rxjs.Observable<Error>(subscriber =>
20
+ conn.send(JSON.stringify(request.message), err => {
21
+ if (err) {
22
+ subscriber.next(new Error('JanusClient sendMessage fail', { cause: err }))
23
+ subscriber.complete()
24
+ } else {
25
+ subscriber.complete()
26
+ pendingRequests.set(txId, request)
27
+ }
28
+ })
29
+ )
30
+ }),
31
+ rxjs.share()
32
+ ),
33
+ receive$: conn.message$.pipe(
34
+ rxjs.concatMap(event => {
35
+ try {
36
+ assert(typeof event.data == 'string')
37
+ const message = JSON.parse(event.data) as JanusMessage
38
+ if (message.janus == 'event' && typeof message.transaction == 'undefined') {
39
+ return rxjs.of(message)
40
+ } else {
41
+ const request = pendingRequests.get(message.transaction)
42
+ if (request) {
43
+ pendingRequests.delete(message.transaction)
44
+ if (message.janus == 'error') {
45
+ const { code, reason } = message.error as { code: number, reason: string }
46
+ request.reject(new JanusError(code, reason))
47
+ } else {
48
+ request.fulfill(message)
49
+ }
50
+ return rxjs.EMPTY
51
+ } else {
52
+ throw new Error('Stray')
53
+ }
54
+ }
55
+ } catch (err) {
56
+ if (err instanceof Error) err.cause = event.data
57
+ return rxjs.of(new Error('JanusClient processMessage fail', { cause: err }))
58
+ }
59
+ }),
60
+ rxjs.share()
61
+ ),
62
+ close$: conn.close$,
63
+ close: conn.close.bind(conn)
64
+ }
65
+ })
66
+ )
67
+ }
@@ -0,0 +1,80 @@
1
+ import { afterEverything, describe, expect, Expectation } from "@service-broker/test-utils"
2
+ import assert from "assert"
3
+ import * as rxjs from "rxjs"
4
+ import { createClient, createPluginHandle, createSession, JanusError, JanusRequest, request } from "./index.js"
5
+
6
+ const requestSubject = new rxjs.ReplaySubject<JanusRequest>()
7
+ const shutdownSubject = new rxjs.Subject<void>()
8
+
9
+ assert(process.env.JANUS_URL, 'Missing env JANUS_URL')
10
+
11
+ createClient(process.env.JANUS_URL).pipe(
12
+ rxjs.tap(() => console.info('JanusClient connected')),
13
+ //rxjs.retry({ delay: 15_000 }),
14
+ //rxjs.repeat({ delay: 1_000 }),
15
+ rxjs.exhaustMap(client =>
16
+ rxjs.merge(
17
+ client.send$,
18
+ client.receive$,
19
+ createSession(client).pipe(
20
+ rxjs.tap(() => console.info('JanusSession created')),
21
+ rxjs.exhaustMap(session =>
22
+ rxjs.merge(
23
+ session.send$,
24
+ session.keepAlive$,
25
+ createPluginHandle(session, 'janus.plugin.videoroom').pipe(
26
+ rxjs.tap(() => console.info('JanusPluginHandle attached')),
27
+ rxjs.exhaustMap(handle =>
28
+ rxjs.merge(
29
+ handle.send$,
30
+ requestSubject.pipe(
31
+ rxjs.concatMap(request => {
32
+ handle.requestSubject.next(request)
33
+ return rxjs.EMPTY
34
+ })
35
+ )
36
+ ).pipe(
37
+ rxjs.finalize(() => handle.detach())
38
+ )
39
+ )
40
+ )
41
+ ).pipe(
42
+ rxjs.finalize(() => session.destroy())
43
+ )
44
+ )
45
+ ),
46
+ ).pipe(
47
+ rxjs.takeUntil(client.close$),
48
+ rxjs.finalize(() => client.close())
49
+ )
50
+ ),
51
+ rxjs.takeUntil(shutdownSubject)
52
+ ).subscribe({
53
+ next(event) {
54
+ if (event instanceof Error) console.error(event)
55
+ else if (event instanceof JanusError) console.error('JanusError', event)
56
+ else console.info('Unhandled', event)
57
+ },
58
+ error(err) {
59
+ console.error('FATAL', err)
60
+ }
61
+ })
62
+
63
+ afterEverything(() => shutdownSubject.next())
64
+
65
+ function req(message: Record<string, unknown>) {
66
+ return rxjs.firstValueFrom(
67
+ request(requestSubject, message)
68
+ )
69
+ }
70
+
71
+
72
+ describe('main', ({ test }) => {
73
+ test('first', async () => {
74
+ const result = await req({ request: 'list' })
75
+ expect(result, {
76
+ videoroom: 'success',
77
+ list: new Expectation('is', 'array', actual => assert(Array.isArray(actual)))
78
+ })
79
+ })
80
+ })
package/src/index.ts ADDED
@@ -0,0 +1,5 @@
1
+ export * from "./types.js"
2
+ export * from "./client.js"
3
+ export * from "./session.js"
4
+ export * from "./plugin-handle.js"
5
+ export * from "./util.js"
@@ -0,0 +1,45 @@
1
+ import * as rxjs from "rxjs"
2
+ import { JanusError, JanusRequest } from "./types.js"
3
+ import { request } from "./util.js"
4
+
5
+ export function createPluginHandle(session: { requestSubject: rxjs.Subject<JanusRequest> }, plugin: string) {
6
+ return request<{ data: { id: number } }>(session.requestSubject, { janus: "attach", plugin }).pipe(
7
+ rxjs.map(({ data: { id: handleId }}) => {
8
+ const requestSubject = new rxjs.Subject<JanusRequest>()
9
+ return {
10
+ requestSubject,
11
+ send$: requestSubject.pipe(
12
+ rxjs.concatMap(request => {
13
+ session.requestSubject.next({
14
+ message: {
15
+ janus: "message",
16
+ handle_id: handleId,
17
+ body: request.message
18
+ },
19
+ fulfill(response) {
20
+ const { data } = response.plugindata as { data: Record<string, unknown> }
21
+ if (data.error) {
22
+ const { error, error_code } = data as { error: string, error_code: number }
23
+ request.reject(new JanusError(error_code, error))
24
+ } else {
25
+ request.fulfill(data)
26
+ }
27
+ },
28
+ reject(err) {
29
+ request.reject(err)
30
+ }
31
+ })
32
+ return rxjs.EMPTY
33
+ })
34
+ ),
35
+ detach() {
36
+ session.requestSubject.next({
37
+ message: { janus: "detach" },
38
+ fulfill: rxjs.noop,
39
+ reject: err => console.error('JanusPluginHandle detach fail', handleId, err)
40
+ })
41
+ }
42
+ }
43
+ })
44
+ )
45
+ }
package/src/session.ts ADDED
@@ -0,0 +1,50 @@
1
+ import * as rxjs from "rxjs"
2
+ import { JanusError, JanusRequest } from "./types.js"
3
+ import { request } from "./util.js"
4
+
5
+ export function createSession(client: { requestSubject: rxjs.Subject<JanusRequest> }, { keepAliveInterval = 45_000 }: {
6
+ keepAliveInterval?: number
7
+ } = {}) {
8
+ return request<{ data: { id: number } }>(client.requestSubject, { janus: 'create' }).pipe(
9
+ rxjs.map(({ data: { id: sessionId } }) => {
10
+ const requestSubject = new rxjs.Subject<JanusRequest>()
11
+ return {
12
+ requestSubject,
13
+ send$: requestSubject.pipe(
14
+ rxjs.concatMap(request => {
15
+ request.message.session_id = sessionId
16
+ client.requestSubject.next(request)
17
+ return rxjs.EMPTY
18
+ })
19
+ ),
20
+ keepAlive$: requestSubject.pipe(
21
+ rxjs.switchMap(() =>
22
+ rxjs.interval(keepAliveInterval).pipe(
23
+ rxjs.switchMap(() =>
24
+ new rxjs.Observable<JanusError>(subscriber =>
25
+ client.requestSubject.next({
26
+ message: { janus: "keepalive", session_id: sessionId },
27
+ fulfill() {
28
+ subscriber.complete()
29
+ },
30
+ reject(err) {
31
+ subscriber.next(err)
32
+ subscriber.complete()
33
+ }
34
+ })
35
+ )
36
+ )
37
+ )
38
+ )
39
+ ),
40
+ destroy() {
41
+ client.requestSubject.next({
42
+ message: { janus: 'destroy' },
43
+ fulfill: rxjs.noop,
44
+ reject: err => console.error('JanusSession destroy fail', sessionId, err)
45
+ })
46
+ }
47
+ }
48
+ })
49
+ )
50
+ }
package/src/types.ts ADDED
@@ -0,0 +1,12 @@
1
+
2
+ export type JanusMessage = Record<string, unknown>
3
+
4
+ export class JanusError {
5
+ constructor(readonly code: number, readonly reason: string) {}
6
+ }
7
+
8
+ export interface JanusRequest {
9
+ readonly message: JanusMessage
10
+ fulfill(response: JanusMessage): void
11
+ reject(err: JanusError): void
12
+ }
package/src/util.ts ADDED
@@ -0,0 +1,20 @@
1
+ import * as rxjs from "rxjs"
2
+ import { JanusMessage, JanusRequest } from "./types.js"
3
+
4
+ export function request<T extends JanusMessage>(
5
+ requestSubject: rxjs.Subject<JanusRequest>,
6
+ message: JanusMessage
7
+ ) {
8
+ return new rxjs.Observable<T>(subscriber =>
9
+ requestSubject.next({
10
+ message,
11
+ fulfill(response) {
12
+ subscriber.next(response as T)
13
+ subscriber.complete()
14
+ },
15
+ reject(err) {
16
+ subscriber.error(err)
17
+ }
18
+ })
19
+ )
20
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,14 @@
1
+ {
2
+ "compilerOptions": {
3
+ "module": "nodenext",
4
+ "target": "es2022",
5
+ "moduleResolution": "nodenext",
6
+ "strict": true,
7
+ "newLine": "lf",
8
+ "rootDir": "src",
9
+ "outDir": "dist"
10
+ },
11
+ "include": [
12
+ "src/**/*"
13
+ ]
14
+ }