realtime-api Chat/PubSub: remove updateToken and session.expiring

.changeset/friendly-teachers-look.md

@@ -0,0 +1,5 @@
+---
+'@signalwire/realtime-api': patch
+---
+
+remove `updateToken` and `session.expiring` event from realtime-api Chat and PubSub

internal/stack-tests/src/pubSub/app.ts

@@ -18,7 +18,6 @@ async function run() {
  tap.ok(pubSub.publish, 'pubSub.publish is defined')
  tap.ok(pubSub.subscribe, 'pubSub.subscribe is defined')
  tap.ok(pubSub.unsubscribe, 'pubSub.unsubscribe is defined')
- tap.ok(pubSub.updateToken, 'pubSub.updateToken is defined')
 
  process.exit(0)
  } catch (error) {

packages/core/src/pubSub/BasePubSub.ts

@@ -201,6 +201,9 @@ export class BasePubSubConsumer<
  })
  }
 
+ // Currently only `js` supports this features and it's
+ // being ignored (filtered at the Proxy level) within
+ // `realtime-api`
  updateToken(token: string): Promise<void> {
  return new Promise((resolve, reject) => {
  // @ts-expect-error

packages/realtime-api/src/chat/ChatClient.ts

@@ -5,12 +5,14 @@ import {
  Chat as ChatNamespace,
 } from '@signalwire/core'
 import { clientConnect, setupClient, RealtimeClient } from '../client/index'
+import type { RealTimeChatApiEventsHandlerMapping } from '../types/chat'
 
-export interface ChatClientApiEvents extends ChatNamespace.BaseChatApiEvents {}
+export interface ChatClientApiEvents
+ extends ChatNamespace.BaseChatApiEvents<RealTimeChatApiEventsHandlerMapping> {}
 
 export interface ClientFullState extends ChatClient {}
 interface ChatClient
- extends Omit<ChatContract, 'getAllowedChannels'>,
+ extends Omit<ChatContract, 'getAllowedChannels' | 'updateToken'>,
  Omit<ConsumerContract<ChatClientApiEvents, ClientFullState>, 'subscribe'> {
  new (opts: ChatClientOptions): this
 
@@ -31,7 +33,7 @@ const INTERCEPTED_METHODS: ClientMethods[] = [
  'getMemberState',
  'setMemberState',
 ]
-const UNSUPPORTED_METHODS = ['getAllowedChannels']
+const UNSUPPORTED_METHODS = ['getAllowedChannels', 'updateToken']
 
 /**
  * You can use instances of this class to control the chat and subscribe to its

packages/realtime-api/src/pubSub/PubSubClient.ts

@@ -5,13 +5,14 @@ import {
  PubSubContract,
 } from '@signalwire/core'
 import { clientConnect, setupClient, RealtimeClient } from '../client/index'
+import type { RealTimePubSubApiEventsHandlerMapping } from '../types/pubSub'
 
 export interface PubSubClientApiEvents
- extends PubSubNamespace.BasePubSubApiEvents {}
+ extends PubSubNamespace.BasePubSubApiEvents<RealTimePubSubApiEventsHandlerMapping> {}
 
 export interface ClientFullState extends PubSubClient {}
 interface PubSubClient
- extends Omit<PubSubContract, 'getAllowedChannels'>,
+ extends Omit<PubSubContract, 'getAllowedChannels' | 'updateToken'>,
  Omit<
  ConsumerContract<PubSubClientApiEvents, ClientFullState>,
  'subscribe'
@@ -29,7 +30,7 @@ interface PubSubClientOptions
 
 type ClientMethods = Exclude<keyof PubSubClient, '_session'>
 const INTERCEPTED_METHODS: ClientMethods[] = ['subscribe', 'publish']
-const UNSUPPORTED_METHODS = ['getAllowedChannels']
+const UNSUPPORTED_METHODS = ['getAllowedChannels', 'updateToken']
 
 /**
  * Creates a new PubSub client.

packages/realtime-api/src/types/chat.ts

@@ -0,0 +1,12 @@
+import type {
+ ChatMember,
+ ChatMemberEventNames,
+ ChatMessage,
+ ChatMessageEventName,
+} from '@signalwire/core'
+
+export type RealTimeChatApiEventsHandlerMapping = Record<
+ ChatMessageEventName,
+ (message: ChatMessage) => void
+> &
+ Record<ChatMemberEventNames, (member: ChatMember) => void>

packages/realtime-api/src/types/pubSub.ts

@@ -0,0 +1,6 @@
+import type { PubSubMessage, PubSubMessageEventName } from '@signalwire/core'
+
+export type RealTimePubSubApiEventsHandlerMapping = Record<
+ PubSubMessageEventName,
+ (message: PubSubMessage) => void
+>