npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

simple-p2p-webrtc

v1.1.0

Published

Simple WebRTC peer-to-peer connections in both React Native and React apps.

Downloads

20

Readme

Simple Peer 2 Peer WebRTC for React and React Native

This package provides a WebRTC wrapper implementation for both React(tested w/ Next) and React Native applications, enabling peer-to-peer (P2P) data communication. It abstracts the WebRTC integration into React-based projects, both cjs and mjs available.

Features

  • Cross-platform support (React and React Native)
  • Simplified WebRTC setup process
  • Hooks for React and React Native
  • Single data channel support (for now)
  • TypeScript support

Installation

npm install simple-p2p-webrtc 
# or
yarn add simple-p2p-webrtc

Usage

There are both hook and class implementations for React and React Native apps, same interface with dependency injection under the hood.

To make the connection process smoother you can use a signaling server.

Example React-Native Usage

For simplicity below example acts as a counterpart to the following application in Next.js. It initiates the p2p connection. The offer is then provided to the next app.

import { useEffect, useState } from 'react';
import { Button, Keyboard, StyleSheet, Text, TextInput, View } from 'react-native';
import { usePeer } from 'simple-p2p-webrtc/react-native';

const UPDATE_INTERVAL = 300; // optional
const RTC_CONF = { iceServers: [{ urls: 'stun:stun.l.google.com:19302' }] }; // you have to provide stun servers
const CHAN = "data"; // channel descriptor to be used

export default function App() {
    // creating peer
    const peer = usePeer(RTC_CONF, undefined, UPDATE_INTERVAL); // second argument is the msg callback
                                                                // update interval is optional
    const { dataChannelState, connectionState } = peer; // destructure

    const [answer, setAnswer] = useState('');
    const [offer, setOffer] = useState('');
    const [ice, setIce] = useState<RTCIceCandidate[]>([]);

    useEffect(() => {
        if (dataChannelState === "open") {
            try {
                peer.send("PING"); // ping once connected
            } catch (e) {
                console.log('Connection severed'); // you dont have to log errors but can handle them
            }
        }
    }, [dataChannelState]);

    const handleCreateOffer = async () => {
        try {
            peer.createDataChannel(CHAN);
            const offer = await peer.createOffer();
            setOffer(offer);
        } catch (e) {
            console.error("Error creating offer", e);
        }
    };

    const handleSetIceCandidates = async () => {
        try {
            for (const iceCand of ice) {
                await peer.addRemoteIceCandidate(iceCand);
            }
        } catch (e) {
            console.error("Error setting ICE candidates", e);
        }
    };

    const handleSetRemoteDescription = async () => {
        try {
            await peer.setRemoteDescription(answer);
        } catch (e) {
            console.error("Error setting remote description", e);
        }
    };

    return (
        <View style={styles.container}>
            <Text> Connect</Text>
            <Text>Connection state: {connectionState}</Text>
            <Text>Data channel state: {dataChannelState}</Text>
            {["closed", "create"].includes(dataChannelState) ?
                <>
                    <Button title="Create Offer" onPress={handleCreateOffer} />
                    {offer && <TextInput
                        returnKeyType="done"
                        onSubmitEditing={() => Keyboard.dismiss()}
                        value={offer}
                        multiline
                        style={styles.input}
                    />}

                    <TextInput
                        returnKeyType="done"
                        onSubmitEditing={() => Keyboard.dismiss()}
                        value={answer}
                        onChangeText={setAnswer}
                        placeholder="Paste Answer"
                        style={styles.input}
                    />
                    <Button title="Set Remote Description" onPress={handleSetRemoteDescription} />

                    <TextInput
                        returnKeyType="done"
                        onSubmitEditing={() => Keyboard.dismiss()}
                        value={JSON.stringify(ice)}
                        onChangeText={(s) => setIce(JSON.parse(s))}
                        placeholder="Paste Ice Candidates"
                        style={styles.input}
                    />
                    <Button title="Set Ice Candidates" onPress={handleSetIceCandidates} />
                </> :
                <Text>Data is being sent to the web client!</Text>}
        </View>
    );
}

const styles = StyleSheet.create({
    container: {
        flex: 1,
        paddingTop: 100,
        backgroundColor: '#fff',
        alignItems: 'center',
    },
    input: {
        height: 40,
        borderColor: 'gray',
        borderWidth: 1,
        marginVertical: 10,
        width: '80%',
        padding: 10,
    },
});

Example React/ Next Usage

The Next.js app receives an offer and generates an answer along with providing ice candidates for connection. Both the answer and the ice candidates need to be fed back to the react native app, typically this is done through a signaling server.

"use client" // we need to be a client component/ page

import { useEffect, useState } from "react";
import { usePeer } from "simple-p2p-webrtc";

const RTC_CONF = { iceServers: [{ urls: 'stun:stun.l.google.com:19302' }] }; // stun servers
const UPDATE_INTERVAL = 300; // optional

export default function Home() {
    const [data, setData] = useState<string>('');
    const [offer, setOffer] = useState<string>('');
    const [answer, setAnswer] = useState<string>('');
    const peer = usePeer(RTC_CONF, (msg) => {
        setData(msg); // message callback
                      // data will be ping
                      // set once
    }, UPDATE_INTERVAL);
    const { connectionState, dataChannelState, iceCandidates } = peer;

    return (
        <div className="min-h-screen w-full flex flex-col items-center justify-center bg-gray-100 p-4 text-black">
            <p className="mb-4">Connection status: {connectionState}</p>
            <p className="mb-4">Data chan status: {dataChannelState}</p>

            {(dataChannelState == 'closed') ? // automatically set to closed when initialized with msgCallback because we are looking for a dataChannel
                <>
                    <form onSubmit={async (e) => {
                        e.preventDefault();
                        try {
                            setAnswer((await peer.createAnswer(offer))); // an answer to the offer is created and shown
                        } catch (e) {
                            console.error(e);
                        }
                    }} className="mb-4 flex flex-col">
                        <textarea
                            value={offer}
                            onChange={(e: React.ChangeEvent<HTMLTextAreaElement>) => setOffer(e.target.value)}
                            placeholder="Paste the offer from the React Native app here"
                            className="w-64 h-32 p-2 border rounded"
                        />
                        <button type="submit" className="mt-2 px-4 py-2 bg-blue-500 text-white rounded">
                            Connect
                        </button>
                    </form>
                    {(answer && peer) && (
                        <div className="mb-4">
                            <h2 className="text-lg font-semibold">Answer & Ice Candidates:</h2>
                            <textarea
                                value={answer}
                                readOnly
                                className="w-64 h-32 p-2 border rounded"
                            />
                            <textarea
                                value={JSON.stringify(iceCandidates)}
                                readOnly
                                className="w-64 h-32 p-2 border rounded"
                            />
                        </div>
                    )}
                </> :
                <>
                    <p>Receiving data</p>
                </>
            }
        </div>
    );
};

Other

License is MIT. Feel free to contribute.