add plugin types to ctx interface (#579)

* add plugin types to ctx interface

* extract plugin interfaces into corresponding plugin files

* add missing state field in PlayerAPI interface

* fix type errors in player plugin api()

* use events return type void

Co-authored-by: Nicolo John Davis <[email protected]>

Author: janKir

src/plugins/plugin-events.ts

@@ -8,6 +8,17 @@
 
 import { Events } from './events/events';
 
+export interface EventsAPI {
+  endGame?(...args: any[]): void;
+  endPhase?(...args: any[]): void;
+  endStage?(...args: any[]): void;
+  endTurn?(...args: any[]): void;
+  pass?(...args: any[]): void;
+  setActivePlayers?(...args: any[]): void;
+  setPhase?(...args: any[]): void;
+  setStage?(...args: any[]): void;
+}
+
 export default {
   name: 'events',
 

src/plugins/plugin-player.js src/plugins/plugin-player.tssrc/plugins/plugin-player.js renamed to src/plugins/plugin-player.ts

@@ -6,6 +6,18 @@
  * https://opensource.org/licenses/MIT.
  */
 
+export interface PlayerAPI {
+  state: {
+    [playerId: string]: object;
+  };
+  get(): any;
+  set(value: any): any;
+  opponent?: {
+    get(): any;
+    set(value: any): any;
+  };
+}
+
 /**
  * Plugin that maintains state for each player in G.players.
  * During a turn, G.player will contain the object for the current player.
@@ -20,19 +32,18 @@ export default {
     return { players: api.state };
   },
 
-  api: ({ ctx, data }) => {
+  api: ({ ctx, data }): PlayerAPI => {
     let state = data.players;
-    let result = { state };
 
     const get = () => {
       return data.players[ctx.currentPlayer];
     };
-    result.get = get;
 
     const set = value => {
       return (state[ctx.currentPlayer] = value);
     };
-    result.set = set;
+
+    let result: PlayerAPI = { state, get, set };
 
     if (ctx.numPlayers === 2) {
       const other = ctx.currentPlayer === '0' ? '1' : '0';

src/plugins/plugin-random.ts

@@ -8,6 +8,23 @@
 
 import { Random } from './random/random';
 
+export interface RandomAPI {
+  D4(): number;
+  D4(diceCount: number): number[];
+  D6(): number;
+  D6(diceCount: number): number[];
+  D10(): number;
+  D10(diceCount: number): number[];
+  D12(): number;
+  D12(diceCount: number): number[];
+  D20(): number;
+  D20(diceCount: number): number[];
+  Die(spotvalue?: number): number;
+  Die(spotvalue: number, diceCount: number): number[];
+  Number(): number;
+  Shuffle<T>(deck: T[]): T[];
+}
+
 export default {
   name: 'random',
 

src/types.ts

@@ -2,6 +2,9 @@ import { Object } from 'ts-toolbelt';
 import * as ActionCreators from './core/action-creators';
 import { Flow } from './core/flow';
 import * as StorageAPI from './server/db/base';
+import { EventsAPI } from './plugins/plugin-events';
+import { PlayerAPI } from './plugins/plugin-player';
+import { RandomAPI } from './plugins/plugin-random';
 
 export { StorageAPI };
 
@@ -42,6 +45,12 @@ export interface Ctx {
   _random?: {
     seed: string | number;
   };
+  // enhanced by events plugin
+  events?: EventsAPI;
+  // enhanced by player plugin
+  player?: PlayerAPI;
+  // enhanced by random plugin
+  random?: RandomAPI;
 }
 
 export interface PluginState {