fix(plugins): Don’t pass api to isInvalid

`isInvalid` is always called *after* `flush`, so a plugin’s API shouldn’t be available.
boardgameio · Aug 2, 2021 · 1078b13 · 1078b13
1 parent 1e435c2
commit 1078b13
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/src/plugins/main.ts b/src/plugins/main.ts
@@ -261,7 +261,6 @@ const IsInvalid = (
         G: state.G,
         ctx: state.ctx,
         game: opts.game,
-        api: pluginState && pluginState.api,
         data: pluginState && pluginState.data,
       });
 

diff --git a/src/types.ts b/src/types.ts
@@ -144,7 +144,9 @@ export interface Plugin<
 > {
   name: string;
   noClient?: (context: PluginContext<API, Data, G>) => boolean;
-  isInvalid?: (context: PluginContext<API, Data, G>) => false | string;
+  isInvalid?: (
+    context: Omit<PluginContext<API, Data, G>, 'api'>
+  ) => false | string;
   setup?: (setupCtx: { G: G; ctx: Ctx; game: Game<G, Ctx> }) => Data;
   action?: (data: Data, payload: ActionShape.Plugin['payload']) => Data;
   api?: (context: {