PubSub and Chat namespace with new interface

[iAmmar7]

Description

New interface for the Chat and PubSub APIs.

ref: https://github.com/signalwire/cloud-product/issues/7185

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)

Code snippets

The new interface contains a single SW client with Chat and PubSub namespaces

import { SignalWire } from '@signalwire/realtime-api'

(async () => {
  const client = await SignalWire({
    host: process.env.HOST,
    project: process.env.PROJECT,
    token: process.env.TOKEN,
  })

  // Attach pubSub listeners
  const unsubHomePubSubListener = await client.pubSub.listen({
      channels: ['home'],
      onMessageReceived: (message) => {
        console.log('Message received under the "home" channel', message)
      },
    })

  // Publish on home channel
  await client.pubsub.publish({
      content: 'Hello There',
      channel: 'home',
      meta: {
        fooId: 'randomValue',
      },
  })
  
  // Attach chat listeners
  const unsubOfficeChatListener = await client.chat.listen({
      channels: ['office'],
      onMessageReceived: (message) => {
        console.log('Message received on "office" channel', message)
      },
      onMmemberJoined: (member) => {
        console.log('Member joined on "office" channel', member)
      },
      onMmemberUpdated: (member) => {
        console.log('Member updated on "office" channel', member)
      },
      onMmemberLeft: (member) => {
        console.log('Member left on "office" channel', member)
      },
    })

  // Publish a chat message on the office channel
  const pubRes = await client.chat.publish({
      content: 'Hello There',
      channel: 'office',
  })

  // Get channel messages
  const messagesResult = await client.chat.getMessages({
      channel: 'office',
  })

  // Get channel members
  const getMembersResult = await client.chat.getMembers({ channel: 'office' })
  
  // Unsubscribe pubSub listener
  await unsubHomePubSubListener()

  // Unsubscribe chat listener
  await unsubOfficeChatListener()

  // Disconnect the client
  client.disconnect()
})();

[changeset-bot]

🦋 Changeset detected

Latest commit: e408070

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

This PR includes changesets to release 6 packages

Name	Type
@signalwire/realtime-api	Major
@signalwire/core	Major
@signalwire/node	Patch
@signalwire/js	Patch
@signalwire/web-api	Patch
@signalwire/webrtc	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

[edolix]

Note: i'd like to have .disconnect() to be async in the new interface

[edolix]

Looks good! 💯

[edolix]

Thank for great work @iAmmar7 ! 🥇