[DOC] - Documentation for @signalwire/client (Call Fabric ONLY SDK) #496
Description
Describe the requested update
We need new SDK documentation for https://github.com/signalwire/cloud-product/issues/15568#issuecomment-3174859824
Reason for the request
The new SDK will replace(deprecate) the old @signalwire/js (Video and Call Fabric SDK)
Sections to be updated
Complete Documentation, but the changes are very focused
Additional context
The evolution of the "CF SDK" required some breaking changes that conflicted with "Video SDK" versioning.
A dedicated package also allows the codebase to reflect better the new "PUC paradigm," where we move away from the RoomSession CallSession to a new AddressSession abstraction, where developers can create WebRTC calls to any Signalwire resource with a valid Address using a unified API.
We also want to include in the first release these 2 new API changes
- Adding event listeners to the
dial()parameters - Add optional listen param to dial() to support starting calls using a single method. signalwire-js#1289) - A SDK Client Factory Utility to manage profile credentials - Client Factory - Multi-Instance Management System signalwire-js#1291
Important
Developers not using Video SDK, PubSub, Chat, Voice Call Fabric Chat or Conversations APIs, and not using TypeScript @signalwire/client, are a 100% compatible replacement.
Developer using Call Fabric Chat or Conversations APIs, and/or TypeScript
Minimal migration is required
Developers using Video SDK, PubSub, Chat, Voice should continue using the deprecated @signalwire/js package.