react-jssip-kit 0.7.9 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 1.0.0
+- Breaking: API surface is now explicitly fixed at package root exports (`src/index.ts`). Internal `core/*` modules are not part of the public contract.
+- Breaking: `SipContext` is no longer exported from package root; use `SipProvider` + hooks (`useSipKernel`, etc.).
+- Breaking: `createSipKernel()` no longer accepts injected `client`/`eventManager`; kernel composition is internal-only.
+- Breaking: video-related API and state were removed (`switchCamera`, `enableVideo`, `disableVideo`, `remoteVideoEnabled`, video track surface).
+- Breaking: platform/jssip-lib transitional structure was removed; architecture is consolidated into `core`.
+- Added: `docs/MODULES.md` with module-level architecture map and ownership notes.
+- Docs: README updated with explicit public API contract and internal boundary.
+
+## 0.8.0
+- Breaking: `SipProvider` is now kernel-only and requires `kernel` prop.
+- Added `createSipKernel()` and `SipKernel` as the primary composition API.
+- Added `useSipKernel()` hook for explicit direct kernel access.
+- Hooks migrated internally to kernel interfaces (`store`, `commands`, `events`).
+- Added new core module skeleton (`core/contracts`, `core/modules`, `core/kernel`) for modular architecture.
+- Restored missing `src/jssip-lib/core/sipErrorHandler.ts` to align source with published typings/build output.
+
 ## 0.4.0
 - Breaking: public client control methods now require an explicit `sessionId` as the first argument (`answer`, `hangup`, mute/hold toggles, DTMF/transfer helpers).
 - Added exports for client-facing types (events, options, RTCSession/UA maps) from the package entrypoint for easier consumption.

package/README.md

@@ -1,6 +1,6 @@
 # react-jssip-kit
 
-React provider and hooks that wrap [JsSIP](https://jssip.net/) so you can manage SIP/WebRTC calls with idiomatic React state.
+React provider and hooks around [JsSIP](https://jssip.net/) for SIP/WebRTC calls with idiomatic React state.
 
 ## Installation
 
@@ -16,50 +16,138 @@ Peer deps: `react >=18 <20` and `react-dom >=18 <20`.
 import React from "react";
 import {
   SipProvider,
+  useSipKernel,
+  useActiveSipSession,
   useSipState,
   useSipActions,
-  createSipClientInstance,
+  createSipKernel,
   WebSocketInterface,
 } from "react-jssip-kit";
 
-const client = createSipClientInstance();
+const kernel = createSipKernel();
 
-client.connect("sip:alice@example.com", "supersecret", {
-  sockets: [new WebSocketInterface("wss://example.com/ws")],
-  uri: "sip:example.com",
-  display_name: "Alice",
-});
+function SipBoot() {
+  const { commands } = useSipKernel();
+
+  React.useEffect(() => {
+    commands.connect("sip:alice@example.com", "supersecret", {
+      sockets: [new WebSocketInterface("wss://example.com/ws")],
+      uri: "sip:example.com",
+      display_name: "Alice",
+    });
+
+    return () => commands.disconnect();
+  }, [commands]);
+
+  return null;
+}
 
 function CallControls() {
-  const { sessions, sipStatus } = useSipState();
+  const { sipStatus } = useSipState();
+  const activeSession = useActiveSipSession();
   const { call, hangup, toggleMute } = useSipActions();
-  const active = sessions[0];
 
   return (
     <div>
       <div>Status: {sipStatus}</div>
       <button onClick={() => call("sip:bob@example.com")}>Call Bob</button>
-      <button onClick={() => hangup(active?.id)}>Hang up</button>
-      <button onClick={() => toggleMute(active?.id)}>Toggle mute</button>
+      <button onClick={() => hangup(activeSession?.id)}>Hang up</button>
+      <button onClick={() => toggleMute(activeSession?.id)}>Toggle mute</button>
     </div>
   );
 }
 
 export function App() {
   return (
-    <SipProvider client={client}>
+    <SipProvider kernel={kernel}>
+      <SipBoot />
       <CallControls />
     </SipProvider>
   );
 }
 ```
 
+## Migration
+
+`SipProvider` is kernel-only.
+
+```tsx
+// before
+<SipProvider client={client} />
+
+// after
+const kernel = createSipKernel();
+<SipProvider kernel={kernel} />
+```
+
+## Selector-first usage
+
+Use selector hooks for minimal re-renders.
+
+```tsx
+import { useSipSelector } from "react-jssip-kit";
+
+const sipStatus = useSipSelector((state) => state.sipStatus);
+const hasError = useSipSelector((state) => Boolean(state.error));
+```
+
+```tsx
+import { useSipSession, useActiveSipSession } from "react-jssip-kit";
+
+const active = useActiveSipSession();
+const current = useSipSession(active?.id);
+```
+
+```tsx
+import { useSessionMedia } from "react-jssip-kit";
+
+const { remoteStream, audioTracks } = useSessionMedia(sessionId);
+```
+
 ## API surface
 
-- `SipProvider` — supplies `SipClient` and `SipEventManager` to children.
-- Hooks: `useSip`, `useSipState`, `useSipActions`, `useSipEvent`, `useSipSessions`.
-- Components: `CallPlayer` (basic audio/video elements).
-- Utilities re-exported from bundled `jssip-lib`: `createSipClientInstance`, `createSipEventManager`, `WebSocketInterface`, status enums and types.
+- `SipProvider` provides `SipKernel` to children.
+- Hooks: `useSipKernel`, `useSipState`, `useSipSelector`, `useSipActions`, `useSipEvent`, `useSipSessionEvent`, `useSipSessions`, `useSipSession`, `useActiveSipSession`, `useSessionMedia`.
+- Components: `CallPlayer` (basic remote audio element).
+- Kernel utilities: `createSipKernel`, `createSipClientInstance`, `createSipEventManager`.
+- Kernel commands include:
+  - Call/session: `call`, `answer`, `hangup`, `hangupAll`, `toggleMute`, `toggleHold`, `sendDTMF`, `transfer`, `sendInfo`, `update`, `reinvite`.
+  - UA-level: `sendMessage`, `sendOptions`.
+- JsSIP utility: `WebSocketInterface`.
+
+## Public API Contract (1.0.0)
+
+The package has a single supported entrypoint: `react-jssip-kit`.
+
+Public and supported:
+- `SipProvider` and `SipProviderProps`
+- Hooks listed above
+- `CallPlayer`
+- `createSipKernel()`
+- `createSipClientInstance()`
+- `createSipEventManager()`
+- `SipStatus`, `CallStatus`, `CallDirection`
+- Public types exported from root (`SipKernel`, `SipState`, event/call option types)
+- Public state shape: `SipState = { sipStatus, error, sessions }`
+
+Internal (not part of public contract):
+- Direct imports from `src/core/*`
+- `SipContext` object
+- Internal normalized fields (`sessionsById`, `sessionIds`)
+- Any file not re-exported from package root
+
+## Architecture and Lifecycle
+
+Runtime flow (short):
+1. App creates kernel with `createSipKernel()`.
+2. `SipProvider` injects kernel into React tree.
+3. `commands.connect(...)` starts UA and state transitions.
+4. Session events are projected into public `SipState.sessions`.
+5. Media hooks (`useSessionMedia`) observe peer connection/remote tracks.
+6. `commands.disconnect()` stops UA and performs full cleanup.
+
+Detailed module map and full lifecycle:
+- `docs/MODULES.md`
 
 ## Build