@xloon/xms-client 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+xms-client (@xloon/xms-client) -- browser SDK for xloon_media_server (XMS)
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+No third-party code is bundled; the package has no runtime dependencies.

package/README.md

@@ -0,0 +1,97 @@
+# @xloon/xms-client
+
+Browser SDK for the Xloon Media Server (XMS). Framework-free, no runtime dependencies, ES modules
+with TypeScript types. Implements the client side of the XMS signaling protocol (`docs/protocol.md`
+in the XMS repository).
+
+## Setup
+
+```sh
+npm install @xloon/xms-client
+```
+
+Your **backend** creates the room and mints a token for each user with its API key (protocol.md
+sections 2-3); the browser only receives `{roomId, token}`.
+
+Use it from a bundler (`import { XmsRoom } from '@xloon/xms-client'`) or, without one, copy the
+package's `dist/` folder to your site and import it from a plain page:
+
+```html
+<script type="module">
+  import { XmsRoom } from '/js/xms-client/index.js';
+</script>
+```
+
+## Usage
+
+```js
+const room = await XmsRoom.join({
+  url: 'wss://media.example.com/ws/signaling',
+  roomId,
+  token,                       // from your backend
+});
+
+// Remote media. One event per track; tracks arrive and end independently.
+room.on('track', ({ participantId, trackId, kind, track }) => { /* attach to a <video>/<audio> */ });
+room.on('trackEnded', ({ participantId, trackId }) => { /* remove it */ });
+room.on('participantJoined', (p) => console.log(p.identity, p.displayName, p.metadata));
+room.on('trackMuted', ({ participantId, trackId, muted }) => { /* show a mute icon */ });
+
+// Publish camera + mic (video goes out as 3 simulcast layers).
+const stream = await navigator.mediaDevices.getUserMedia({ audio: true, video: true });
+await room.publish(stream);
+
+await room.setMuted('audio', true);              // quick toggle, announced to the room
+await room.replaceTrack('video', screenTrack);    // switch camera <-> screen, no renegotiation
+await room.unpublishTrack('video');               // stop sending video altogether
+await room.publish(await navigator.mediaDevices.getUserMedia({ video: true })); // ...and back
+
+await room.leave();
+```
+
+By default every publisher is subscribed to automatically (all tracks, highest layer). For large
+rooms, webinars, or audio-only clients, turn that off and choose:
+
+```js
+const room = await XmsRoom.join({ url, roomId, token, autoSubscribe: false });
+room.on('publisherAdded', (p) => {
+  const audio = p.tracks.filter((t) => t.kind === 'AUDIO').map((t) => t.trackId);
+  room.subscribe(p.participantId, { trackIds: audio });
+});
+await room.setLayer(participantId, videoTrackId, 'l');   // thumbnail quality
+await room.unsubscribe(participantId);
+```
+
+`room.peerConnections()` exposes the underlying `RTCPeerConnection`s for `getStats()` diagnostics.
+
+## Reconnection
+
+If the connection drops (network change, Wi-Fi blip, laptop waking up), the room is rejoined
+automatically: retries after 1, 2, 4, 8, 16 s and then every 30 s, up to 10 attempts. Your
+published tracks are published again (mute state kept), and your subscriptions are restored.
+XMS has no session resume, so you rejoin as a new participant: `localParticipantId` changes, and
+the others see you leave and join again.
+
+```js
+room.on('reconnecting', ({ attempt }) => showBanner('Reconnecting…'));  // remote tracks have ended
+room.on('reconnected', ({ participantId }) => hideBanner());             // new `track` events follow
+room.on('disconnected', ({ reason }) => showRejoinButton(reason));      // after leave(), or gave up
+```
+
+Rejoining gives up on errors retrying won't fix (the room was closed, the token was rejected) and
+then emits `disconnected`. Join tokens expire (60 minutes by default), so pass `getToken` to fetch a
+fresh one from your backend when the server rejects the old one:
+
+```js
+const room = await XmsRoom.join({ url, roomId, token, getToken: () => fetchJoinToken(roomId) });
+```
+
+A media connection that never connected (e.g. UDP blocked and no TURN server) is reported as an
+`error` but not retried, since a rejoin would fail the same way.
+
+## Development
+
+```sh
+npm test         # unit tests
+npm run build    # emits dist/ (ES modules + .d.ts)
+```

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { XmsRoom } from './room.js';
+export type { JoinOptions, PublishOptions, RemoteParticipant, RemoteTrack, RoomEvents, SubscribeOptions, } from './room.js';
+export { SignalingClient } from './signaling.js';
+export type { ConnectionState, WebSocketFactory, WebSocketLike } from './signaling.js';
+export type * from './protocol.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+export { XmsRoom } from './room.js';
+export { SignalingClient } from './signaling.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AASpC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/protocol.d.ts

@@ -0,0 +1,197 @@
+export interface ProtocolError {
+    code: string;
+    message: string;
+}
+export interface IceCandidateInit {
+    candidate: string;
+    sdpMid: string | null;
+    sdpMLineIndex: number | null;
+}
+export interface IceServerInfo {
+    urls: string | string[];
+    username?: string;
+    credential?: string;
+}
+export interface TrackInfo {
+    /** The publisher's m-section id (mid) for this track. */
+    trackId: string;
+    kind: 'AUDIO' | 'VIDEO';
+    simulcast: boolean;
+    /** Simulcast encodings a subscriber can choose between, lowest quality first by convention. */
+    rids: string[];
+    muted: boolean;
+}
+export interface PublisherInfo {
+    publisherId: string;
+    tracks: TrackInfo[];
+}
+export interface ParticipantInfo {
+    participantId: string;
+    /** The app's own user id (the join token's subject). */
+    identity: string | null;
+    displayName: string;
+    /** Opaque app data from the join token. */
+    metadata: string | null;
+}
+/** Identifies a transport in trickle/trickleComplete: the publish transport by role, or a
+ *  subscription by the transportId its subscribe.offer returned. */
+export type TransportTarget = {
+    transport: 'publisher';
+} | {
+    transportId: string;
+};
+export interface MethodParams {
+    'session.hello': {
+        authToken: string;
+    };
+    /** displayName is only used when the token carries no name. */
+    'room.join': {
+        roomId: string;
+        authToken: string;
+        displayName?: string;
+    };
+    'room.leave': Record<string, never>;
+    'publish.offer': {
+        sdp: string;
+    };
+    'publish.stop': Record<string, never>;
+    'track.setMuted': {
+        trackId: string;
+        muted: boolean;
+    };
+    'subscribe.offer': {
+        publisherId?: string;
+        trackIds?: string[];
+        layers?: Record<string, string>;
+    };
+    'subscribe.answer': {
+        transportId: string;
+        sdp: string;
+    };
+    'subscribe.close': {
+        transportId: string;
+    };
+    'subscribe.setLayer': {
+        transportId: string;
+        trackId: string;
+        rid: string;
+    };
+    trickle: TransportTarget & {
+        candidate: IceCandidateInit;
+    };
+    trickleComplete: TransportTarget;
+    'chat.send': {
+        text: string;
+    };
+    /** App-defined type (1-64 chars); payload: any JSON, at most 16 KB; to: participantIds (default: everyone else). */
+    'data.send': {
+        type: string;
+        payload: unknown;
+        to?: string[];
+    };
+}
+export type MethodName = keyof MethodParams;
+export interface OfferResult {
+    transportId: string;
+    sdp: string;
+    publisherId: string;
+}
+export interface MethodResult {
+    'session.hello': {
+        serverTime: number;
+    };
+    'room.join': {
+        participantId: string;
+        iceServers: IceServerInfo[];
+        existingPublishers: PublisherInfo[];
+        existingParticipants: ParticipantInfo[];
+    };
+    'room.leave': Record<string, never>;
+    /** sdp is the server's answer. */
+    'publish.offer': OfferResult;
+    'publish.stop': Record<string, never>;
+    'track.setMuted': Record<string, never>;
+    /** sdp is the server's offer. */
+    'subscribe.offer': OfferResult;
+    'subscribe.answer': Record<string, never>;
+    'subscribe.close': Record<string, never>;
+    'subscribe.setLayer': Record<string, never>;
+    trickle: Record<string, never>;
+    trickleComplete: Record<string, never>;
+    'chat.send': Record<string, never>;
+    'data.send': Record<string, never>;
+}
+export interface RequestMessage<M extends MethodName = MethodName> {
+    type: 'request';
+    id: string;
+    method: M;
+    params: MethodParams[M];
+}
+export interface ResponseSuccess<M extends MethodName = MethodName> {
+    type: 'response';
+    id: string;
+    ok: true;
+    result: MethodResult[M];
+}
+export interface ResponseFailure {
+    type: 'response';
+    id: string;
+    ok: false;
+    error: ProtocolError;
+}
+export type ResponseMessage = ResponseSuccess | ResponseFailure;
+export interface EventData {
+    'participant.joined': ParticipantInfo;
+    'participant.left': {
+        participantId: string;
+        reason: string;
+    };
+    'publisher.added': {
+        participantId: string;
+        displayName: string;
+        identity: string | null;
+        tracks: TrackInfo[];
+    };
+    'publisher.updated': {
+        participantId: string;
+        tracks: TrackInfo[];
+    };
+    'publisher.removed': {
+        participantId: string;
+    };
+    'track.muted': {
+        participantId: string;
+        trackId: string;
+        muted: boolean;
+    };
+    'chat.message': {
+        fromParticipantId: string;
+        text: string;
+        timestampMillis: number;
+    };
+    'data.message': {
+        fromParticipantId: string;
+        type: string;
+        payload: unknown;
+        timestampMillis: number;
+    };
+    'recording.started': {
+        recordingId: string;
+        status: string;
+    };
+    'recording.stopped': {
+        recordingId: string;
+        status: string;
+    };
+    /** A transport-scoped failure, e.g. ICE_FAILED; transportId says which transport. */
+    error: ProtocolError & {
+        transportId?: string | null;
+    };
+}
+export type EventName = keyof EventData;
+export interface EventMessage<E extends EventName = EventName> {
+    type: 'event';
+    event: E;
+    data: EventData[E];
+}
+export type ServerMessage = ResponseMessage | EventMessage;

package/dist/protocol.js

@@ -0,0 +1,4 @@
+// Wire types for the XMS signaling protocol (docs/protocol.md). Every shape here mirrors a
+// signaling-api DTO exactly; keep the two in step.
+export {};
+//# sourceMappingURL=protocol.js.map

package/dist/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,mDAAmD"}