fix(client): Correctly type state returned by client to subscribers

boardgameio · Oct 20, 2020 · 9fcbed7 · 9fcbed7
1 parent 051c43f
commit 9fcbed7
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/src/client/client.ts b/src/client/client.ts
@@ -28,6 +28,7 @@ import {
   CredentialedActionShape,
   FilteredMetadata,
   Game,
+  LogEntry,
   PlayerID,
   Reducer,
   State,
@@ -116,6 +117,14 @@ export interface ClientOpts<
   enhancer?: StoreEnhancer;
 }
 
+export type ClientState<G extends any = any> =
+  | null
+  | (State<G> & {
+      isActive: boolean;
+      isConnected: boolean;
+      log: LogEntry[];
+    });
+
 /**
  * Implementation of Client (see below).
  */
@@ -359,7 +368,7 @@ export class _ClientImpl<G extends any = any> {
     this.manager.unregister(this);
   }
 
-  subscribe(fn: (state: State<G>) => void) {
+  subscribe(fn: (state: ClientState<G>) => void) {
     const id = Object.keys(this.subscribers).length;
     this.subscribers[id] = fn;
     this.transport.subscribe(() => this.notifySubscribers());
@@ -378,7 +387,7 @@ export class _ClientImpl<G extends any = any> {
     return this.initialState;
   }
 
-  getState() {
+  getState(): ClientState<G> {
     let state = this.store.getState();
 
     if (this.gameStateOverride !== null) {

diff --git a/src/client/react.tsx b/src/client/react.tsx
@@ -8,7 +8,12 @@
 
 import React from 'react';
 import PropTypes from 'prop-types';
-import { Client as RawClient, ClientOpts, _ClientImpl } from './client';
+import {
+  Client as RawClient,
+  ClientOpts,
+  ClientState,
+  _ClientImpl,
+} from './client';
 
 type WrappedBoardDelegates = 'matchID' | 'playerID' | 'credentials';
 
@@ -17,7 +22,6 @@ export type WrappedBoardProps = Pick<
   WrappedBoardDelegates | 'debug'
 >;
 
-type ClientState<G extends any = any> = ReturnType<_ClientImpl<G>['getState']>;
 type ExposedClientProps<G extends any = any> = Pick<
   _ClientImpl<G>,
   | 'log'