@device-portal/react 0.0.7 → 0.0.10

package/README.md

@@ -14,6 +14,8 @@ npm install @device-portal/react
 
 It is expected that the package will be used on two different devices. Create for them two separate pages or apps. Let's call them App A and App B. Both apps will be linked by same `room` (e.g. `'my-test-room'`).
 
+> **Note:** The example signaling server `wss://device-portal.filipchalupa.cz` is running on a free instance of render.com, so expect slower startup times if it has been inactive.
+
 ### One-way Data Flow
 
 This is the simplest use case where a `Provider` sends data to one or more `Consumer`s.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@device-portal/react",
-	"version": "0.0.7",
+	"version": "0.0.10",
 	"description": "Simple WebRTC data channel for React.",
 	"type": "module",
 	"main": "./dist/index.js",
@@ -18,8 +18,7 @@
 		"dev:package": "rollup -c -w",
 		"build:package": "rollup -c",
 		"dev:storybook": "storybook dev -p 6006",
-		"build:storybook": "storybook build",
-		"prepare": "npm run build:package"
+		"build:storybook": "storybook build"
 	},
 	"repository": {
 		"type": "git",
@@ -39,7 +38,7 @@
 		"react": "18 || 19"
 	},
 	"dependencies": {
-		"@device-portal/client": "^0.0.7"
+		"@device-portal/client": "^0.0.10"
 	},
 	"devDependencies": {
 		"@babel/core": "^7.24.0",

package/dist/client/src/delay.d.ts

@@ -1 +0,0 @@
-export declare const delay: (milliseconds: number) => Promise<unknown>;

package/dist/client/src/index.d.ts

@@ -1,7 +0,0 @@
-export * from './webrtc/Peer';
-export * from './webrtc/Initiator';
-export * from './webrtc/Responder';
-export * from './webrtc/PeerId';
-export * from './settings';
-export * from './delay';
-export * from './utilities/Brand';

package/dist/client/src/settings.d.ts

@@ -1,9 +0,0 @@
-export declare const settings: {
-    readonly channel: {
-        readonly label: "data";
-    };
-    readonly defaultWebsocketSignalingServer: "wss://device-portal.filipchalupa.cz";
-    readonly iceServers: {
-        urls: string[];
-    }[];
-};

package/dist/client/src/utilities/Brand.d.ts

@@ -1,5 +0,0 @@
-declare const brandKey: "__brand";
-export type Brand<Value, BrandName extends string> = Value & {
-    [brandKey]: BrandName;
-};
-export {};

package/dist/client/src/webrtc/Initiator.d.ts

@@ -1,41 +0,0 @@
-import { Peer } from './Peer';
-import { PeerId } from './PeerId';
-type ClientConnection = {
-    connection: RTCPeerConnection;
-    channel: RTCDataChannel;
-    candidatesQueue: RTCIceCandidateInit[];
-    value?: {
-        value: string;
-    };
-};
-export declare class Initiator extends Peer {
-    protected role: "initiator";
-    protected connections: Map<PeerId, ClientConnection>;
-    protected waitingPeers: Set<PeerId>;
-    protected readonly maxClients: number;
-    protected peerListeners: Map<PeerId, Set<(value: string) => void>>;
-    protected onPeersChange: ((peers: PeerId[]) => void) | undefined;
-    protected readonly onMessage: ((value: string, peerId: PeerId) => void) | undefined;
-    constructor(room: string, options?: {
-        onMessage?: (value: string, peerId: PeerId) => void;
-        onPeersChange?: (peers: PeerId[]) => void;
-        sendLastValueOnConnectAndReconnect?: boolean;
-        websocketSignalingServer?: string;
-        iceServers?: Array<RTCIceServer>;
-        maxClients?: number;
-    });
-    get peers(): PeerId[];
-    addPeerListener(peerId: PeerId, listener: (value: string) => void): () => void;
-    protected onConnected(): void;
-    protected handlePeerJoined(peerId: PeerId): Promise<void>;
-    protected handlePeerLeft(peerId: PeerId): void;
-    protected processWaitingPeers(): Promise<void>;
-    protected createAndSendOffer(toPeerId: PeerId): Promise<void>;
-    protected handleOffer(offer: RTCSessionDescriptionInit, fromPeerId: PeerId): void;
-    protected handleAnswer(answer: RTCSessionDescriptionInit, fromPeerId: PeerId): Promise<void>;
-    protected handleIceCandidate(candidate: RTCIceCandidateInit, fromPeerId?: PeerId): Promise<void>;
-    send(value: string): void;
-    sendToPeer(peerId: PeerId, value: string): void;
-    destroy(): void;
-}
-export {};

package/dist/client/src/webrtc/Peer.d.ts

@@ -1,40 +0,0 @@
-import { PeerId } from './PeerId';
-export declare abstract class Peer {
-    protected readonly room: string;
-    protected isDestroyed: boolean;
-    protected connection: RTCPeerConnection | null;
-    protected channel: RTCDataChannel | null;
-    protected abstract role: 'initiator' | 'responder';
-    protected value: {
-        value: string;
-    } | null;
-    protected readonly onMessage: ((value: string, peerId: PeerId) => void) | undefined;
-    protected readonly sendLastValueOnConnectAndReconnect: boolean;
-    protected readonly websocketSignalingServer: string;
-    protected readonly iceServers: Array<RTCIceServer>;
-    protected socket: WebSocket | null;
-    protected candidatesQueue: RTCIceCandidateInit[];
-    protected peerId: PeerId | null;
-    constructor(room: string, options?: {
-        websocketSignalingServer?: string;
-        onMessage?: (value: string, peerId: PeerId) => void;
-        sendLastValueOnConnectAndReconnect?: boolean;
-        iceServers?: Array<RTCIceServer>;
-    });
-    protected run(): Promise<void>;
-    protected connect(): Promise<void>;
-    protected abstract handleOffer(offer: RTCSessionDescriptionInit, fromPeerId: PeerId): void;
-    protected abstract handleAnswer(answer: RTCSessionDescriptionInit, fromPeerId: PeerId): void;
-    protected abstract handlePeerJoined(peerId: PeerId): void;
-    protected abstract handlePeerLeft(peerId: PeerId): void;
-    protected abstract onConnected(): void;
-    protected handleIceCandidate(candidate: RTCIceCandidateInit, fromPeerId?: PeerId): Promise<void>;
-    protected processCandidatesQueue(): Promise<void>;
-    protected close(): void;
-    destroy(): void;
-    protected sendMessage(type: string, data: any, to?: PeerId): void;
-    protected setAndShareLocalDescription(description: RTCSessionDescriptionInit, toPeerId?: PeerId): Promise<void>;
-    protected shareNewIceCandidate(event: RTCPeerConnectionIceEvent, toPeerId?: PeerId): void;
-    send(value: string): void;
-    protected initializeConnectionAndChannel(): void;
-}

package/dist/client/src/webrtc/PeerId.d.ts

@@ -1,2 +0,0 @@
-import { Brand } from '../utilities/Brand';
-export type PeerId = Brand<string, 'PeerId'>;

package/dist/client/src/webrtc/Responder.d.ts

@@ -1,14 +0,0 @@
-import { Peer } from './Peer';
-import { PeerId } from './PeerId';
-export declare class Responder extends Peer {
-    protected role: "responder";
-    private reconnectTimeout;
-    protected onConnected(): void;
-    protected handlePeerJoined(peerId: PeerId): void;
-    protected handlePeerLeft(peerId: PeerId): void;
-    private startReconnectionTimer;
-    private stopReconnectionTimer;
-    protected handleOffer(offer: RTCSessionDescriptionInit, fromPeerId: PeerId): Promise<void>;
-    destroy(): void;
-    protected handleAnswer(answer: RTCSessionDescriptionInit, fromPeerId: PeerId): void;
-}