feat: VoIP freeswitch UI hooks

[aleksandernsilva]

❗❗DO NOT MERGE BEFORE #33005❗❗

Proposed changes (including videos or screenshots)

This PR adds the mais React hooks used by the UI for voice calls. Each hook has it's own responsibility and informations is extracted from the VoIPClient.

Here's a description of each hook and it's responsibilities:

useVoiceCallState

Provides information is regards to the state of the VoIPClient and VoiceCallSession. Ex.: isReady, isRegistered, isError, isIncoming, isOngoing, isOutgoing

useVoiceCallAPI

Provides access to VoIPClient actions not necessarily related to the current VoiceCallSession. Ex.: register, unregister, transferCall, makeCall, endCall.

useVoiceCallSession

Provides access to the state and actions available for the established voice call.
A VoiceCallSession can be INCOMING, ONGOING, OUTGOING and ERROR. Each session type provides a group of methods (Ex.: mute; hold) and relevant information (Ex.: contact; transferedBy).

useVoiceCall

This is a convenience hook that combines state, api and session in a single result.

useVoiceCallDialer

Provides the state of the dialer, whether it's open and a close method.

-- The following hooks are used mostly as support for the previous hooks

useVoiceCallEvent

Listens for events coming from the VoIPClient, stores and returns the payload as a result.

useVoiceCallEffect

Listens for stateChanged emitted by VoIPClient and calls a callback with the updated VoIPClient. The callback's return is the result.

Issue(s)

VOIP-48

Steps to test or reproduce

N/A

Further comments

[dionisio-bot]

Looks like this PR is not ready to merge, because of the following issues:

• This PR is missing the 'stat: QA assured' label

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

[changeset-bot]

⚠️ No Changeset found

Latest commit: e764573

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.39%. Comparing base (4057c92) to head (e764573).
Report is 1 commits behind head on feat/voip-freeswitch-ui-internals.

Additional details and impacted files

@@                        Coverage Diff                         @@
##           feat/voip-freeswitch-ui-internals   #33006   +/-   ##
==================================================================
  Coverage                              59.39%   59.39%           
==================================================================
  Files                                   2549     2549           
  Lines                                  63332    63332           
  Branches                               14253    14253           
==================================================================
  Hits                                   37617    37617           
  Misses                                 22996    22996           
  Partials                                2719     2719           

Flag	Coverage Δ
unit	75.78% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.