fix(types): playerID in playerView can be string or null (#990)

Co-authored-by: delucis <[email protected]>

Author: ben196888

docs/documentation/secret-state.md

@@ -1,7 +1,7 @@
 # Secret State
 
 In some games you might need to hide information from
-players. For example, you might not want to reveal the
+players or spectators. For example, you might not want to reveal the
 hands of opponents in card games.
 
 This is easily accomplished at the UI layer (by not
@@ -18,6 +18,7 @@ from that specific player.
 ```js
 const game = {
   // ...
+  // `playerID` could also be null or undefined for spectators.
   playerView: (G, ctx, playerID) => {
     return StripSecrets(G, playerID);
   },

src/core/player-view.test.ts

@@ -21,21 +21,26 @@ test('secret', () => {
   expect(newG).toEqual({});
 });
 
-test('players', () => {
+describe('players', () => {
   const G = {
     players: {
       '0': {},
       '1': {},
     },
   };
 
-  {
+  test('playerID: "0"', () => {
     const newG = PlayerView.STRIP_SECRETS(G, {} as Ctx, '0');
     expect(newG.players).toEqual({ '0': {} });
-  }
+  });
 
-  {
+  test('playerID: "1"', () => {
     const newG = PlayerView.STRIP_SECRETS(G, {} as Ctx, '1');
     expect(newG.players).toEqual({ '1': {} });
-  }
+  });
+
+  test('playerID: null', () => {
+    const newG = PlayerView.STRIP_SECRETS(G, {} as Ctx, null);
+    expect(newG.players).toEqual({});
+  });
 });

src/core/player-view.ts

@@ -19,17 +19,19 @@ export const PlayerView = {
    * removes all the keys in `players`, except for the one
    * corresponding to the current playerID.
    */
-  STRIP_SECRETS: (G: any, ctx: Ctx, playerID: PlayerID) => {
+  STRIP_SECRETS: (G: any, ctx: Ctx, playerID: PlayerID | null) => {
     const r = { ...G };
 
     if (r.secret !== undefined) {
       delete r.secret;
     }
 
     if (r.players) {
-      r.players = {
-        [playerID]: r.players[playerID],
-      };
+      r.players = playerID
+        ? {
+            [playerID]: r.players[playerID],
+          }
+        : {};
     }
 
     return r;

src/master/filter-player-view.ts

@@ -5,7 +5,7 @@ import type { TransportData, IntermediateTransportData } from './master';
 
 const applyPlayerView = (
   game: Game,
-  playerID: string,
+  playerID: string | null,
   state: State
 ): State => ({
   ...state,
@@ -19,7 +19,10 @@ const applyPlayerView = (
 /** Gets a function that filters the TransportData for a given player and game. */
 export const getFilterPlayerView =
   (game: Game) =>
-  (playerID: string, payload: IntermediateTransportData): TransportData => {
+  (
+    playerID: string | null,
+    payload: IntermediateTransportData
+  ): TransportData => {
     switch (payload.type) {
       case 'patch': {
         const [matchID, stateID, prevState, state] = payload.args;
@@ -69,7 +72,7 @@ export const getFilterPlayerView =
  * @param {String} playerID - The playerID that this log is
  *                            to be sent to.
  */
-export function redactLog(log: LogEntry[], playerID: PlayerID) {
+export function redactLog(log: LogEntry[], playerID: PlayerID | null) {
   if (log === undefined) {
     return log;
   }

src/types.ts

@@ -311,7 +311,7 @@ export interface Game<
   };
   endIf?: (G: G, ctx: CtxWithPlugins) => any;
   onEnd?: (G: G, ctx: CtxWithPlugins) => any;
-  playerView?: (G: G, ctx: CtxWithPlugins, playerID: PlayerID) => any;
+  playerView?: (G: G, ctx: CtxWithPlugins, playerID: PlayerID | null) => any;
   plugins?: Array<Plugin<any, any, G>>;
   ai?: {
     enumerate: (