@fishjam-cloud/react-client 0.5.0 → 0.5.2

package/readme.md

@@ -1,3 +1,7 @@
+[![NPM Version](https://img.shields.io/npm/v/@fishjam-cloud/react-client)](https://www.npmjs.com/package/@fishjam-cloud/react-client)
+[![TypeScript Strict](https://badgen.net/badge/TS/Strict)](https://www.typescriptlang.org)
+[![TypeDoc](https://img.shields.io/badge/TypeDoc-8A2BE2)](https://fishjam-cloud.github.io/web-client-sdk/modules/_fishjam_dev_react_client.html)
+
 # Fishjam React Client
 
 React client library for [Fishjam Cloud](https://cloud.fishjam.stream).
@@ -6,7 +10,7 @@ the [TS client](../ts-client/README.md).
 
 ## Documentation
 
-Documentation is available [here](https://fishjam-cloud.github.io/web-client-sdk/modules/_fishjam_dev_react_client.html or you can generate it locally:
+Documentation is available [here](https://fishjam-cloud.github.io/web-client-sdk/modules/_fishjam_dev_react_client.html) or you can generate it locally:
 
 ```bash
 yarn run docs
@@ -14,26 +18,23 @@ yarn run docs
 
 ## Installation
 
-You can install the library using `npm` or `yarn:
+You can install this package using `npm`:
 
 ```bash
 npm install @fishjam-cloud/react-client
 ```
 
+or `yarn`:
+
 ```bash
-yarn add @fishjam-cloud/react-client
+yarn @fishjam-cloud/react-client
 ```
 
-It was tested with `nodejs` version mentioned in [`.tool-versions`](./.tool-versions) file.
-
 ## Usage
 
-For pure TypeScript usage,
-see [TS client](../ts-client/README.md).
-
 Prerequisites:
 
-- Account on Fishjam Cloud with App configured.
+- Account on [Fishjam Cloud](https://cloud.fishjam.stream) with App configured.
 - Created room and token of peer in that room.
   You can use Room Manager to create room and peer token.
 
@@ -133,11 +134,6 @@ export const App = () => {
 };
 ```
 
-### Releasing new versions
-
-To release a new version of the package, go to `Actions` > `Release package` workflow and trigger it with the chosen release type.
-The workflow will bump the package version in `package.json`, release the package to NPM, create a new git tag and a GitHub release.
-
 ## Examples
 
 For examples, see [examples](../../examples/react-client/) folder.

package/dist/ScreenShareManager.d.ts

@@ -1,57 +0,0 @@
-import type TypedEmitter from "typed-emitter";
-import type { DeviceError, DevicesStatus } from "./types";
-import type { TrackKind } from "@fishjam-cloud/ts-client";
-export type TrackType = TrackKind | "audiovideo";
-export type MediaDeviceType = "displayMedia" | "userMedia";
-export type DisplayMediaManagerEvents = {
-    deviceReady: (event: {
-        type: TrackType;
-    }, state: ScreenShareDeviceState) => void;
-    deviceStopped: (event: {
-        type: TrackType;
-    }, state: ScreenShareDeviceState) => void;
-    deviceEnabled: (event: {
-        type: TrackType;
-    }, state: ScreenShareDeviceState) => void;
-    deviceDisabled: (event: {
-        type: TrackType;
-    }, state: ScreenShareDeviceState) => void;
-    error: (event: {
-        type: TrackType;
-        error: DeviceError | null;
-        rawError: any;
-    }, state: ScreenShareDeviceState) => void;
-};
-export interface ScreenShareManagerConfig {
-    audioTrackConstraints?: boolean | MediaTrackConstraints;
-    videoTrackConstraints?: boolean | MediaTrackConstraints;
-}
-export type ScreenShareMedia = {
-    stream: MediaStream | null;
-    track: MediaStreamTrack | null;
-    enabled: boolean;
-};
-export type ScreenShareDeviceState = {
-    status: DevicesStatus;
-    audioMedia: ScreenShareMedia | null;
-    videoMedia: ScreenShareMedia | null;
-    error: DeviceError | null;
-};
-declare const ScreenShareManager_base: new () => TypedEmitter<DisplayMediaManagerEvents>;
-export declare class ScreenShareManager extends ScreenShareManager_base {
-    private readonly defaultConfig?;
-    private config?;
-    private data;
-    getSnapshot(): ScreenShareDeviceState;
-    constructor(defaultConfig?: ScreenShareManagerConfig);
-    setConfig(config: ScreenShareManagerConfig): void;
-    private getType;
-    getMedia: () => ScreenShareMedia | null;
-    start(config?: ScreenShareManagerConfig): Promise<void>;
-    private setupOnEndedCallback;
-    private onTrackEnded;
-    stop(type: TrackType): Promise<void>;
-    setEnable(type: TrackType, value: boolean): void;
-}
-export {};
-//# sourceMappingURL=ScreenShareManager.d.ts.map

package/dist/ScreenShareManager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ScreenShareManager.d.ts","sourceRoot":"","sources":["../src/ScreenShareManager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,YAAY,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAE1D,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,YAAY,CAAC;AACjD,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,WAAW,CAAC;AAE3D,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,EAAE,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;IACjF,aAAa,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,EAAE,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;IACnF,aAAa,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,EAAE,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;IACnF,cAAc,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,EAAE,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAC;IACpF,KAAK,EAAE,CACL,KAAK,EAAE;QACL,IAAI,EAAE,SAAS,CAAC;QAChB,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;QAC1B,QAAQ,EAAE,GAAG,CAAC;KACf,EACD,KAAK,EAAE,sBAAsB,KAC1B,IAAI,CAAC;CACX,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,qBAAqB,CAAC,EAAE,OAAO,GAAG,qBAAqB,CAAC;IACxD,qBAAqB,CAAC,EAAE,OAAO,GAAG,qBAAqB,CAAC;CACzD;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC/B,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,aAAa,CAAC;IACtB,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpC,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACpC,KAAK,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B,CAAC;iDAEiE,YAAY,CAAC,yBAAyB,CAAC;AAA1G,qBAAa,kBAAmB,SAAQ,uBAAmE;IACzG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAA2B;IAC1D,OAAO,CAAC,MAAM,CAAC,CAA2B;IAE1C,OAAO,CAAC,IAAI,CAKV;IAGK,WAAW,IAAI,sBAAsB;gBAIhC,aAAa,CAAC,EAAE,wBAAwB;IAK7C,SAAS,CAAC,MAAM,EAAE,wBAAwB;IAIjD,OAAO,CAAC,OAAO;IAOR,QAAQ,gCAA8B;IAEhC,KAAK,CAAC,MAAM,CAAC,EAAE,wBAAwB;IA0CpD,OAAO,CAAC,oBAAoB;IAgB5B,OAAO,CAAC,YAAY,CAKlB;IAEW,IAAI,CAAC,IAAI,EAAE,SAAS;IA2B1B,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO;CAwBjD"}

package/dist/ScreenShareManager.js

@@ -1,135 +0,0 @@
-import EventEmitter from "events";
-import { parseUserMediaError } from "./utils/errors";
-export class ScreenShareManager extends EventEmitter {
-    defaultConfig;
-    config;
-    data = {
-        audioMedia: null,
-        videoMedia: null,
-        status: "Not requested",
-        error: null,
-    };
-    // todo add nested read only
-    getSnapshot() {
-        return this.data;
-    }
-    constructor(defaultConfig) {
-        super();
-        this.defaultConfig = defaultConfig;
-    }
-    setConfig(config) {
-        this.config = config;
-    }
-    getType(options) {
-        if (options.audio && options.video)
-            return "audiovideo";
-        if (options.audio)
-            return "audio";
-        if (options.video)
-            return "video";
-        return null;
-    }
-    getMedia = () => this.data.videoMedia;
-    async start(config) {
-        const options = {
-            video: config?.videoTrackConstraints ??
-                this.config?.videoTrackConstraints ??
-                this.defaultConfig?.videoTrackConstraints,
-            audio: config?.audioTrackConstraints ??
-                this.config?.audioTrackConstraints ??
-                this.defaultConfig?.audioTrackConstraints,
-        };
-        const type = this.getType(options);
-        if (!type)
-            return;
-        try {
-            const newStream = await navigator.mediaDevices.getDisplayMedia(options);
-            this.data = {
-                error: null,
-                videoMedia: {
-                    enabled: true,
-                    stream: newStream,
-                    track: newStream?.getVideoTracks()[0] ?? null,
-                },
-                audioMedia: {
-                    enabled: true,
-                    stream: newStream,
-                    track: newStream?.getAudioTracks()[0] ?? null,
-                },
-                status: "OK",
-            };
-            this.setupOnEndedCallback();
-            this.emit("deviceReady", { type: type }, this.data);
-        }
-        catch (error) {
-            const parsedError = parseUserMediaError(error);
-            this.emit("error", { type, error: parsedError, rawError: error }, this.data);
-        }
-    }
-    setupOnEndedCallback() {
-        if (this.data.videoMedia?.track) {
-            this.data.videoMedia.track.addEventListener("ended", async (event) => await this.onTrackEnded("video", event.target.id));
-        }
-        if (this.data.audioMedia?.track) {
-            this.data.audioMedia.track.addEventListener("ended", async (event) => await this.onTrackEnded("audio", event.target.id));
-        }
-    }
-    onTrackEnded = async (kind, trackId) => {
-        const mediaType = kind === "video" ? "videoMedia" : "audioMedia";
-        if (trackId === this?.data[mediaType]?.track?.id) {
-            await this.stop("audiovideo");
-        }
-    };
-    async stop(type) {
-        if (type === "video") {
-            for (const track of this.data?.videoMedia?.stream?.getTracks() ?? []) {
-                track.stop();
-            }
-            this.data.videoMedia = null;
-        }
-        else if (type === "audio") {
-            // todo test it
-            for (const track of this.data?.audioMedia?.stream?.getTracks() ?? []) {
-                track.stop();
-            }
-            this.data.audioMedia = null;
-        }
-        else {
-            for (const track of this.data?.videoMedia?.stream?.getTracks() ?? []) {
-                track.stop();
-            }
-            this.data.videoMedia = null;
-            for (const track of this.data?.audioMedia?.stream?.getTracks() ?? []) {
-                track.stop();
-            }
-            this.data.audioMedia = null;
-        }
-        this.emit("deviceStopped", { type }, this.data);
-    }
-    setEnable(type, value) {
-        if (type === "video" && this.data.videoMedia?.track) {
-            this.data.videoMedia.track.enabled = value;
-            this.data.videoMedia.enabled = value;
-        }
-        else if (type === "audio" && this.data.audioMedia?.track) {
-            this.data.audioMedia.track.enabled = value;
-            this.data.audioMedia.enabled = value;
-        }
-        else {
-            if (this.data.videoMedia?.track) {
-                this.data.videoMedia.track.enabled = value;
-                this.data.videoMedia.enabled = value;
-            }
-            if (this.data.audioMedia?.track) {
-                this.data.audioMedia.track.enabled = value;
-                this.data.audioMedia.enabled = value;
-            }
-        }
-        if (value) {
-            this.emit("deviceEnabled", { type }, this.data);
-        }
-        else {
-            this.emit("deviceDisabled", { type }, this.data);
-        }
-    }
-}