New Client SDK

[jpsantosbh]

Description

Introduce @signalwire/client Package - Call Fabric SDK Refactoring

Type of change

• Internal refactoring
• Bug fix (bugfix - non-breaking)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

🎯 Overview

This PR introduces the new @signalwire/client package, which represents a major refactoring of the Call Fabric SDK from the existing @signalwire/js package. The new package provides a focused, cleaner API specifically for unified communication applications while maintaining backward compatibility through the original package.

🔧 Motivation

The original @signalwire/js package has grown to include multiple SDKs (Video, Chat, PubSub, and Call Fabric), leading to:

• Increased bundle sizes for applications that only need Call Fabric functionality
• Confusion between Room-based terminology (suited for video conferences) and Call-based terminology (better for unified communications)
• Complex type inference and poor IDE experience with deeply nested types
• Mixing of concerns between different SDK functionalities

📋 Key Changes

1. Package Structure

• Created new @signalwire/client package focused exclusively on Call Fabric SDK
• Removed Chat, PubSub, and Video SDK components from the new package
• Maintained shared components (BaseRoomSession, RoomSessionDevice, etc.) for compatibility

2. Terminology Refactoring: Room → Call

All Fabric-prefixed classes and types have been renamed to use Call terminology:

// Before (@signalwire/js)
FabricRoomSession → CallSession
FabricRoomSessionMember → CallSessionMember
FabricRoomSessionConnection → CallSessionConnection
FabricRoomSessionContract → CallSessionContract
FabricRoomSessionEvents → CallSessionEvents

// Function renames
createFabricRoomSessionValidateProxy → createCallSessionValidateProxy
isFabricRoomSession → isCallSession

3. Type System Improvements

Type Aliasing with TypeScript Hack

Implemented a workaround to prevent TypeScript from resolving aliases back to original types:

// Prevents IDE from showing FabricMemberEntity
export type CallMemberEntity = FabricMemberEntity & {
  tshack?: undefined
}

Prettify Utility for Clean External Types

All exported types now use the Prettify<> utility for better IDE experience:

type ExternalCallMemberEntity = Prettify<CallMemberEntity>
export { ExternalCallMemberEntity as CallMemberEntity }

4. Simplified API Surface

• Removed legacy helpers: createClient.ts, createRoomObject.ts, joinRoom.ts
• Focused exports on Call Fabric functionality only
• Removed advanced video features (recording, streaming workers)
• Cleaner namespace structure without redundant paths

💔 Breaking Changes

For @signalwire/js Users

No breaking changes - the original package maintains all existing functionality and exports.

For Early @signalwire/client Adopters

1. All Fabric* prefixed types and classes are now Call* prefixed
2. No direct access to Video SDK components (use @signalwire/js instead)
3. Chat and PubSub namespaces are not available

📚 Migration Guide

Migrating from @signalwire/js Fabric SDK to @signalwire/client

// Same call setup
import { SignalWire } from '@signalwire/client'
const client = await SignalWire({ token })
const call = await client.dial({ to: '...' })
call.on('member.joined', (e: CallMemberJoinedEventParams) => {})

Type Migration

// Type mappings
FabricRoomSession → CallSession
FabricRoomSessionMember → CallSessionMember
FabricMemberEntity → CallMemberEntity
FabricMemberJoinedEventParams → CallMemberJoinedEventParams
FabricMemberUpdatedEventParams → CallMemberUpdatedEventParams
FabricLayoutChangedEventParams → CallLayoutChangedEventParams

✅ Testing

• All existing tests have been updated to use new terminology
• Type inference tests added to ensure aliases work correctly
• E2E tests updated for both packages
• Backward compatibility tests for @signalwire/js

📊 Bundle Size Impact

Expected improvements for Call Fabric-only applications:

• ~40% reduction in bundle size by excluding Video SDK components
• ~25% reduction by excluding Chat and PubSub functionality
• Cleaner tree-shaking with focused exports

🔮 Future Work

• Extract common components to @signalwire/browser-common package
• Deprecate fabric exports from @signalwire/js with migration warnings

📝 Documentation Updates

• Update API documentation with new Call terminology
• Create migration guide for existing Fabric SDK users
• Update example applications
• Add TypeScript usage examples with improved types

🔍 Review Checklist

• All tests passing (apart from conversations API)
• No regression in @signalwire/js functionality
• Type exports properly aliased with tshack
• Bundle size analysis completed
• Migration guide reviewed

📸 Screenshots

---

This refactoring sets the foundation for a cleaner, more maintainable SDK architecture while providing a better developer experience through improved naming conventions and type definitions.

[changeset-bot]

🦋 Changeset detected

Latest commit: 738d498

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@signalwire/client	Patch
@signalwire/webrtc	Patch
@sw-internal/e2e-client	Patch
@signalwire/js	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[LittorWired]

@jpsantosbh looks like the build is failing

[iAmmar7]

As requested, I have removed the changes from the JS package. @jpsantosbh

[iAmmar7]

Can we investigate why? Shouldn't it work if the e2e-js works?

[iAmmar7]

Are we sure these are all the types that we export from the CF SDK?

[jpsantosbh]

These are the types emitted by the events, right?

callSession.on('member.talking', (params) =>