@afosecure/meshsdk 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 AFOLABI MUBARAK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,373 @@
+# 📹 MESHSDK
+
+A lightweight React SDK for building peer-to-peer video conferencing applications using WebRTC Mesh networking. The SDK provides a modern React API, built-in meeting state management, screen sharing, chat, waiting room support, and flexible WebSocket signaling.
+
+---
+
+## Features
+
+- Peer-to-peer WebRTC Mesh architecture
+- HD audio and video
+- Screen sharing
+- Waiting room with host approval
+- Public and private in-meeting chat
+- Participant presence and media state
+- Automatic ICE restart & reconnection
+- STUN/TURN support
+- React Hooks API
+- Full TypeScript support
+- Lightweight with zero UI dependencies
+
+---
+
+## Installation
+
+```bash
+npm install @afosecure/meshsdk
+```
+
+or
+
+```bash
+pnpm add @afosecure/meetingsdk
+```
+
+or
+
+```bash
+yarn add @afosecure/meetingsdk
+```
+
+---
+
+# Quick Start
+
+## Create the SDK
+
+```tsx
+import { useState } from "react";
+import { MeetingProvider, VideoSDKCore } from "@afosecure/meetingsdk";
+
+export default function App() {
+  const [sdk] = useState(
+    () =>
+      new VideoSDKCore({
+        onUserJoined: console.log,
+        onUserLeft: console.log,
+        onTrack: console.log,
+      }),
+  );
+
+  return (
+    <MeetingProvider core={sdk}>
+      <Meeting />
+    </MeetingProvider>
+  );
+}
+```
+
+---
+
+## Join a Meeting
+
+```tsx
+import { useMeeting } from "@afosecure/meetingsdk";
+
+export default function Meeting() {
+  const { joinMeeting, startLocalStream, leaveMeeting } = useMeeting();
+
+  const join = async () => {
+    await startLocalStream(videoRef.current!, "John");
+
+    await joinMeeting({
+      roomId: "room-123",
+      name: "John",
+    });
+  };
+
+  return (
+    <>
+      <button onClick={join}>Join</button>
+
+      <button onClick={leaveMeeting}>Leave</button>
+    </>
+  );
+}
+```
+
+---
+
+# React Hooks
+
+## useMeeting()
+
+Provides meeting actions and local participant state.
+
+```ts
+const {
+  joinMeeting,
+  leaveMeeting,
+  toggleMic,
+  toggleCam,
+  startScreenShare,
+  stopScreenShare,
+  sendChatMessage,
+  participants,
+  localParticipant,
+  presenterId,
+} = useMeeting();
+```
+
+---
+
+## useParticipants()
+
+Returns all remote participants.
+
+```ts
+const participants = useParticipants();
+```
+
+---
+
+## useLocalParticipant()
+
+```ts
+const participant = useLocalParticipant();
+```
+
+---
+
+## useChat()
+
+```ts
+const { messages, sendChatMessage } = useChat();
+```
+
+---
+
+## useMeetingState()
+
+Subscribe to the underlying reactive meeting state.
+
+```ts
+const meeting = useMeetingState();
+```
+
+---
+
+# Meeting Events
+
+```ts
+const sdk = new VideoSDKCore({
+  onTrack(stream, participantId) {},
+
+  onUserJoined(participant) {},
+
+  onUserLeft(participantId) {},
+
+  onChatMessage(message) {},
+
+  onScreenShareStarted(id, stream) {},
+
+  onScreenShareStopped(id) {},
+
+  onMicToggled(id, enabled) {},
+
+  onCamToggled(id, enabled) {},
+
+  onMeetingLeft() {},
+
+  onError(error) {},
+});
+```
+
+---
+
+# Features
+
+## Audio & Video
+
+- Camera
+- Microphone
+- Mute / Unmute
+- Camera On / Off
+
+---
+
+## Screen Sharing
+
+```ts
+await startScreenShare();
+
+stopScreenShare();
+```
+
+Supports:
+
+- Presenter detection
+- Automatic renegotiation
+- Browser stop-share handling
+
+---
+
+## Waiting Room
+
+Supports:
+
+- Join requests
+- Host approval
+- Host rejection
+- Rejoin after approval
+
+Events:
+
+```ts
+onEntryRequested();
+
+onEntryResponded();
+```
+
+---
+
+## Chat
+
+Supports:
+
+- Public messages
+- Private messages
+- Replies
+- Optimistic updates
+
+```ts
+sendChatMessage({
+  message: "Hello everyone!",
+});
+```
+
+---
+
+# Architecture
+
+```
+Participant A
+       │
+       │
+   WebSocket
+(Signaling Only)
+       │
+Participant B
+
+Media
+──────────────►
+Direct WebRTC
+Peer Connection
+```
+
+Media never passes through the signaling server.
+
+The WebSocket server is only responsible for:
+
+- room management
+- participant discovery
+- signaling
+- waiting room
+- ICE exchange
+
+---
+
+# Server Requirements
+
+Your signaling server should support the following messages.
+
+## Client → Server
+
+- JOIN
+- LEAVE
+- OFFER
+- ANSWER
+- ICE
+- CHAT_MESSAGE
+- MEDIA_STATE
+- SCREEN_SHARE_START
+- SCREEN_SHARE_STOP
+- JOIN_APPROVE
+- JOIN_REJECT
+- PING
+
+---
+
+## Server → Client
+
+- JOINED
+- EXISTING_USERS
+- USER_JOINED
+- USER_LEFT
+- OFFER
+- ANSWER
+- ICE
+- CHAT_MESSAGE
+- MEDIA_STATE_CHANGE
+- SCREEN_SHARE_START
+- SCREEN_SHARE_STOP
+- JOIN_PENDING
+- JOIN_APPROVED
+- JOIN_REJECTED
+- ERROR
+- PONG
+
+---
+
+# STUN & TURN
+
+The SDK expects the signaling server to provide ICE servers during the JOIN flow.
+
+Example:
+
+```json
+{
+  "iceServers": [
+    {
+      "urls": ["stun:stun.l.google.com:19302"]
+    },
+    {
+      "urls": ["turn:turn.example.com:3478"],
+      "username": "...",
+      "credential": "..."
+    }
+  ]
+}
+```
+
+---
+
+# Browser Support
+
+- Chrome
+- Edge
+- Firefox
+- Safari
+
+---
+
+# Mesh Networking
+
+This SDK uses a Mesh topology.
+
+Every participant establishes a direct WebRTC connection with every other participant.
+
+Best suited for:
+
+- One-to-one calls
+- Interviews
+- Online consultations
+- Small meetings
+- Team discussions
+
+For larger meetings (10+ participants), an SFU architecture is recommended.
+
+---
+
+# License
+
+MIT

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@afosecure/meshsdk",
+  "version": "0.1.1",
+  "description": "A modern, lightweight React SDK for building peer-to-peer video communication applications. Built on WebRTC with a clean, composable rust API.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "require": "./dist/react.js",
+      "import": "./dist/react.mjs"
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --watch"
+  },
+  "keywords": [
+    "afosecure",
+    "call",
+    "react",
+    "meeting",
+    "video",
+    "mesh",
+    "peer",
+    "webrtc",
+    "sdk",
+    "rust",
+    "sdk",
+    "typescript",
+    "videosdk"
+  ],
+  "author": "Afolabi Mubarak",
+  "license": "MIT",
+  "homepage": "https://github.com/Megabyte-webdev/meshsdk",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Megabyte-webdev/meshsdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Megabyte-webdev/meshsdk/issues"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "dependencies": {
+    "uuid": "^14.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.14",
+    "@types/ws": "^8.18.1",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.2"
+  }
+}