feat(realtime): add return values in adapters (#12)

* feat(realtime): add return values in adapters

* fix(realtime): fix bindings filter, remove return type in realtime

Author: GuzekAlan

packages/core/realtime-js/src/RealtimeChannel.ts

@@ -200,7 +200,7 @@ export default class RealtimeChannel {
     return this.channelAdapter.joinPush
   }
 
-  get rejoinTimer(): Timer {
+  get rejoinTimer() {
     return this.channelAdapter.rejoinTimer
   }
 
@@ -756,9 +756,9 @@ export default class RealtimeChannel {
 
   /** @internal */
   private _updateFilterMessage() {
-    this.channelAdapter.updateFilterMessage((event, payload: any, messageRef, phoenixBind) => {
-      const typeLower = event.toLocaleLowerCase()
-      const bind = this.bindings[typeLower]?.find((bind) => bind.ref === phoenixBind.ref)
+    this.channelAdapter.updateFilterBindings((binding, payload: any, ref) => {
+      const typeLower = binding.event.toLocaleLowerCase()
+      const bind = this.bindings[typeLower]?.find((bind) => bind.ref === binding.ref)
 
       if (!bind) {
         return true

packages/core/realtime-js/src/RealtimeClient.ts

@@ -107,57 +107,57 @@ export default class RealtimeClient {
 
   serializer: Serializer = new Serializer()
 
-  get endPoint(): string {
+  get endPoint() {
     return this.socketAdapter.endPoint
   }
 
-  get timeout(): number {
+  get timeout() {
     return this.socketAdapter.timeout
   }
 
-  get transport(): WebSocketLikeConstructor {
+  get transport() {
     return this.socketAdapter.transport
   }
 
-  get heartbeatCallback(): HeartbeatCallback {
+  get heartbeatCallback() {
     return this.socketAdapter.heartbeatCallback
   }
 
-  get heartbeatIntervalMs(): number {
+  get heartbeatIntervalMs() {
     return this.socketAdapter.heartbeatIntervalMs
   }
 
-  get heartbeatTimer(): HeartbeatTimer {
+  get heartbeatTimer() {
     if (this.worker) {
       return this._workerHeartbeatTimer
     }
     return this.socketAdapter.heartbeatTimer
   }
 
-  get pendingHeartbeatRef(): string | null {
+  get pendingHeartbeatRef() {
     if (this.worker) {
       return this._pendingWorkerHeartbeatRef
     }
     return this.socketAdapter.pendingHeartbeatRef
   }
 
-  get vsn(): string {
+  get vsn() {
     return this.socketAdapter.vsn
   }
 
-  get encode(): Function {
+  get encode() {
     return this.socketAdapter.encode
   }
 
-  get decode(): Function {
+  get decode() {
     return this.socketAdapter.decode
   }
 
-  get reconnectAfterMs(): (tries: number) => number {
+  get reconnectAfterMs() {
     return this.socketAdapter.reconnectAfterMs
   }
 
-  get sendBuffer(): Function[] {
+  get sendBuffer() {
     return this.socketAdapter.sendBuffer
   }
 

packages/core/realtime-js/src/phoenix/channelAdapter.ts

@@ -6,7 +6,11 @@ import type {
   ChannelBindingCallback,
   ChannelOnMessage,
   ChannelOnErrorCallback,
+  ChannelFilterBindings,
   Params,
+  ChannelState,
+  Push,
+  Timer,
 } from './types'
 
 export default class ChannelAdapter {
@@ -19,39 +23,39 @@ export default class ChannelAdapter {
     this.socket = socket
   }
 
-  get state() {
+  get state(): ChannelState {
     return this.channel.state
   }
 
-  set state(state) {
+  set state(state: ChannelState) {
     this.channel.state = state
   }
 
-  get joinedOnce() {
+  get joinedOnce(): boolean {
     return this.channel.joinedOnce
   }
 
-  get joinPush() {
+  get joinPush(): Push {
     return this.channel.joinPush
   }
 
-  get rejoinTimer() {
+  get rejoinTimer(): Timer {
     return this.channel.rejoinTimer
   }
 
-  on(event: string, callback: ChannelBindingCallback) {
+  on(event: string, callback: ChannelBindingCallback): number {
     return this.channel.on(event, callback)
   }
 
   off(event: string, refNumber?: number) {
     this.channel.off(event, refNumber)
   }
 
-  subscribe(timeout?: number) {
+  subscribe(timeout?: number): Push {
     return this.channel.join(timeout)
   }
 
-  unsubscribe(timeout?: number) {
+  unsubscribe(timeout?: number): Push {
     return this.channel.leave(timeout)
   }
 
@@ -63,11 +67,11 @@ export default class ChannelAdapter {
     this.channel.onClose(callback)
   }
 
-  onError(callback: ChannelOnErrorCallback) {
+  onError(callback: ChannelOnErrorCallback): number {
     return this.channel.onError(callback)
   }
 
-  push(event: string, payload: { [key: string]: any }, timeout?: number) {
+  push(event: string, payload: { [key: string]: any }, timeout?: number): Push {
     try {
       return this.channel.push(event, payload, timeout)
     } catch (error) {
@@ -79,7 +83,7 @@ export default class ChannelAdapter {
     this.channel.joinPush.payload = () => payload
   }
 
-  joinRef() {
+  joinRef(): string {
     if (!this.channel.joinPush.ref) {
       throw new Error('Join push reference not found')
     }
@@ -107,16 +111,8 @@ export default class ChannelAdapter {
     return this.state === CHANNEL_STATES.leaving
   }
 
-  updateFilterMessage(
-    filterMessage: (
-      event: string,
-      payload: object,
-      ref: number | undefined,
-      bind: { event: string; ref: number }
-    ) => boolean
-  ) {
-    // @ts-ignore - it does not exist yet in phoenix
-    this.channel.filterMessage = filterMessage
+  updateFilterBindings(filterBindings: ChannelFilterBindings) {
+    this.channel.filterBindings = filterBindings
   }
 
   updatePayloadTransform(callback: ChannelOnMessage) {

packages/core/realtime-js/src/phoenix/socketAdapter.ts

@@ -6,6 +6,10 @@ import type {
   SocketOnOpen,
   SocketOnError,
   SocketOptions,
+  SocketStateChangeCallbacks,
+  Vsn,
+  Encode,
+  Decode,
   HeartbeatCallback,
 } from './types'
 import { CONNECTION_STATE, ConnectionState } from '../lib/constants'
@@ -18,59 +22,59 @@ export default class SocketAdapter {
     this.socket = new Socket(endPoint, options)
   }
 
-  get timeout() {
+  get timeout(): number {
     return this.socket.timeout
   }
 
-  get endPoint() {
+  get endPoint(): string {
     return this.socket.endPoint
   }
 
-  get transport() {
+  get transport(): WebSocketLikeConstructor {
     return this.socket.transport as WebSocketLikeConstructor
   }
 
-  get heartbeatIntervalMs() {
+  get heartbeatIntervalMs(): number {
     return this.socket.heartbeatIntervalMs
   }
 
-  get heartbeatCallback() {
+  get heartbeatCallback(): HeartbeatCallback {
     return this.socket.heartbeatCallback
   }
 
   set heartbeatCallback(callback: HeartbeatCallback) {
     this.socket.heartbeatCallback = callback
   }
 
-  get heartbeatTimer() {
-    return this.socket.heartbeatTimer as HeartbeatTimer
+  get heartbeatTimer(): HeartbeatTimer {
+    return this.socket.heartbeatTimer
   }
 
-  get pendingHeartbeatRef() {
+  get pendingHeartbeatRef(): string | null {
     return this.socket.pendingHeartbeatRef
   }
 
-  get vsn() {
+  get vsn(): Vsn {
     return this.socket.vsn
   }
 
-  get encode() {
+  get encode(): Encode<void> {
     return this.socket.encode
   }
 
-  get decode() {
+  get decode(): Decode<void> {
     return this.socket.decode
   }
 
-  get reconnectAfterMs() {
+  get reconnectAfterMs(): (tries: number) => number {
     return this.socket.reconnectAfterMs
   }
 
-  get sendBuffer() {
+  get sendBuffer(): (() => void)[] {
     return this.socket.sendBuffer
   }
 
-  get stateChangeCallbacks() {
+  get stateChangeCallbacks(): SocketStateChangeCallbacks {
     return this.socket.stateChangeCallbacks
   }
 
@@ -99,7 +103,7 @@ export default class SocketAdapter {
     this.socket.log(kind, msg, data)
   }
 
-  makeRef() {
+  makeRef(): string {
     return this.socket.makeRef()
   }
 
@@ -136,12 +140,12 @@ export default class SocketAdapter {
     return this.socket.connectionState()
   }
 
-  endPointURL() {
+  endPointURL(): string {
     return this.socket.endPointURL()
   }
 
   sendHeartbeat() {
-    return this.socket.sendHeartbeat()
+    this.socket.sendHeartbeat()
   }
 
   /**

packages/core/realtime-js/src/phoenix/types.ts

@@ -6,16 +6,22 @@ export type {
   SocketOnError,
   SocketOnMessage,
   SocketOnClose,
+  SocketStateChangeCallbacks,
   Channel,
   ChannelState,
   ChannelEvent,
   ChannelBindingCallback,
+  ChannelFilterBindings,
   ChannelOnMessage,
   ChannelOnErrorCallback,
   PresenceState,
   Message,
   Params,
   Transport,
+  Timer,
+  Vsn,
+  Encode,
+  Decode,
   HeartbeatCallback,
   HeartbeatStatus,
 } from 'phoenix'