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

@intershare/hooks.web-rtc-local-share

v0.0.19

Published

The `webRTCLocalShare` component is a robust solution for managing WebRTC connections and file sharing within React applications. It's part of the `@intershare/hooks.web-rtc-local-share` library and integrates seamlessly with `@intershare/hooks.secure-con

Downloads

8

Readme

webRTCLocalShare Component Documentation

The webRTCLocalShare component is a robust solution for managing WebRTC connections and file sharing within React applications. It's part of the @intershare/hooks.web-rtc-local-share library and integrates seamlessly with @intershare/hooks.secure-connect-manager and @intershare/hooks.indexdb for comprehensive WebSocket management and local data storage, respectively.

Key Features

  • Dynamic WebRTC Connection Handling: Manages multiple WebRTC connections per WebSocket, allowing for scalable peer-to-peer interactions.
  • File Sharing Mechanism: Coordinates the sharing and receiving of files, handling file data and status updates.
  • Data Channel Configuration: Sets up and manages data channels for each WebRTC connection, facilitating file transfer operations.
  • Client Discovery and Mapping: Regularly discovers new clients and maps them for connection establishment.

Initialization

To initialize webRTCLocalShare, first import necessary modules and set up the component. Ensure that dependencies like @intershare/hooks.secure-connect-manager and @intershare/hooks.indexdb are also initialized.

Initializing webRTCLocalShare

import React, { useEffect, useState } from 'react'
import { webRTCLocalShare } from '@intershare/hooks.web-rtc-local-share'
import { secureConnectManager } from '@intershare/hooks.secure-connect-manager'
import { indexDbStore } from '@intershare/hooks.indexdb'

export const InitializeWebRTCLocalShare: React.FC = () => {
  const [apiKey, setApiKey] = useState('')
  const [status, setStatus] = useState({
    webRTCLocalShare: 'Not initialized',
    secureConnect: 'Not initialized',
    indexDb: 'Not initialized',
  })
  const { init: initSecureConnectManager, intervalId } = secureConnectManager()
  const { init: initWebRTCLocalShare } = webRTCLocalShare()
  const { initIndexedDb } = indexDbStore()

  useEffect(() => {
    if (intervalId) {
      setStatus((prev) => ({ ...prev, secureConnect: 'Initialized' }))
    } else {
      setStatus((prev) => ({ ...prev, secureConnect: 'Not initialized' }))
    }
  }, [intervalId])

  const initializeAllModules = async () => {
    initIndexedDb('myDatabase')
      .then(() => setStatus((prev) => ({ ...prev, indexDb: 'Initialized' })))
      .catch((error) => console.error('Error initializing IndexedDB', error))

    // Inicialización de secureConnectManager con la API key
    initSecureConnectManager({
      api: apiKey,
      discoveryInterval: 60000, // Intervalo de descubrimiento en milisegundos
    })

    // Inicialización de webRTCLocalShare
    initWebRTCLocalShare({
      discoveryInterval: 1000, // Intervalo de descubrimiento para WebRTC
    })
    setStatus((prev) => ({ ...prev, webRTCLocalShare: 'Initialized' }))
  }
  return (
    <div>
      <h3>Initialize WebRTC Local Share</h3>
      <input
        type="text"
        value={apiKey}
        onChange={(e) => setApiKey(e.target.value)}
        placeholder="Enter API Key for SecureConnectManager"
      />
      <button onClick={initializeAllModules}>Initialize</button>
      <div>
        <p>IndexDB Status: {status.indexDb}</p>
        <p>SecureConnectManager Status: {status.secureConnect}</p>
        <p>WebRTCLocalShare Status: {status.webRTCLocalShare}</p>
      </div>
    </div>
  )
}

Notes

  • The init function of webRTCLocalShare configures the discovery interval for WebRTC connections.
  • secureConnectManager and indexDbStore are used for managing WebSocket connections and local data storage, respectively.

Usage

Show Peer Connection Information

The following example demonstrates how to display information about connected peers:

import React from 'react'
import { webRTCLocalShare } from '../src/web-rtc-local-share'

export const ShowPeerConnectedInfo: React.FC = () => {
  const { webRTCConnections } = webRTCLocalShare()

  return (
    <>
      <h1>Connected Peers</h1>
      {webRTCConnections.map((connection, i) => (
        <div key={i}>
          <div>Local Peer ID: {connection.localPeerId}</div>
          <div>Remote Peer ID: {connection.remotePeerId}</div>
          <div>dataChannelID: {connection.dataChannel?.id}</div>
          <div>Establishing: {connection.isEstablishing ? 'Yes' : 'No'}</div>
          <div>
            Files Shared CID:
            <ul>
              {connection.filesShared.map((cid) => (
                <li>{cid}</li>
              ))}
            </ul>
          </div>
          <div>
            Files Received CID:
            <ul>
              {connection.filesReceived.map((cid) => (
                <li>{cid}</li>
              ))}
            </ul>
          </div>
        </div>
      ))}
    </>
  )
}

Notes

  • webRTCConnections provides details about each connected peer, including IDs, data channel status, and file sharing information.

Types

  • Tconfig: Configuration type for setting up the discovery interval.
  • WebRTCConnectionInfo: Contains detailed information about each WebRTC connection, including peer IDs, connection status, and associated data channels.
  • TClientsMap: Maps new clients for connection establishment.
  • TWebRTCLocalShare: Main type of the webRTCLocalShare component, encapsulating all functionalities and configurations.

Contributing

Contributions to enhance webRTCLocalShare are welcome. If you have ideas for improvements, bug fixes, or additional features, please submit a pull request or open an issue on the GitHub repository. Your contributions help in making webRTCLocalShare more efficient and versatile for React-based applications.