beeping-react-native

⚛️ Beeping SDK for React Native — Nitro Modules bridge to beeping-core (C++20) via beeping-ios + beeping-android. TypeScript strict, instance-based BeepingClient, idiomatic hooks, dual mode (Local / Cloud), Detox E2E, npm provenance.

📦 Will publish as @beeping/react-native once Phase 12 is closed (with npm provenance).

---

✨ Highlights

• 🚀 New Architecture only — RN 0.76+ with Fabric + TurboModules + Hermes
• 🧰 Nitro Modules — codegen C++ from TS specs, no JSON bridge, type-safe end-to-end
• 🪝 Idiomatic hooks — useBeepingListen() and useBeepingSend() as first-class citizens
• 🎭 Dual mode — LocalStrategy (offline audio steganography) or CloudStrategy (HTTP via beepbox-server)
• 🪵 Cross-stack tracing — trace-IDs flow JS → native → core → server; Sentry sink optional
• 🔒 Privacy-first — telemetry opt-in by default, no PII, no device fingerprinting

---

📦 Installation

⚠️ Not published yet — Phase 12 in development. The block below previews the final UX.

pnpm add @beeping/react-native
# or
npm install @beeping/react-native

iOS

cd ios && pod install

Android

No extra steps — autolinking handles it.

---

🚀 Usage

Send

import { BeepingClient } from '@beeping/react-native';

const client = new BeepingClient({ mode: 'local', telemetry: false });

await client.send({ payload: 'hello' });

Listen

import { useBeepingListen } from '@beeping/react-native';

export function MyScreen() {
  const { lastReceived, error, isListening } = useBeepingListen({ mode: 'local' });
  return <Text>{lastReceived?.payload ?? 'waiting…'}</Text>;
}

See the example/ Expo app for an end-to-end working setup with debug console.

---

🧪 Tests & lint

pnpm test         # Jest + React Native Testing Library + fast-check
pnpm lint         # ESLint strict
pnpm typecheck    # tsc --noEmit
pnpm e2e:ios      # Detox iOS simulator
pnpm e2e:android  # Detox Android emulator

---

📚 Docs

• docs/PRODUCTO.md — product spec (20 sections)
• docs/ROADMAP.md — Phase 12 timeline & milestones
• docs/ROADMAP_CHANGELOG.md — historical changes to the roadmap
• docs/IDEAS.md — exploratory ideas (💡)
• docs/PENDING.md — pending work without slot (⏳)

---

🔗 Ecosystem

This SDK is part of the Beeping platform — open-source local-mesh communication via audio steganography.

• beeping-core — C++20 audio steganography core
• beeping-ios — Swift 6 wrapper
• beeping-android — Kotlin 2.0 wrapper
• beeping_flutter — Flutter plugin
• beeping-react-native — this repo
• beeping-cli — Rust CLI
• beepbox-server — Cloud mode HTTP server

---

📄 License

Apache-2.0 — see LICENSE.