feat(interfaces): fix devtools command typing

Author: blakebyrnes

client/lib/Agent.ts

@@ -336,13 +336,6 @@ export default class Agent extends AwaitedEventTarget<{ close: void }> {
       throw err;
     }
   }
-
-  public toJSON(): any {
-    // return empty so we can
-    return {
-      type: 'Agent',
-    };
-  }
 }
 
 // This class will lazily connect to core on first access of the tab properties

client/lib/FrameEnvironment.ts

@@ -185,13 +185,6 @@ export default class FrameEnvironment {
     const coreFrame = await getCoreFrameEnvironment(this);
     await coreFrame.waitForLocation(trigger, options);
   }
-
-  public toJSON(): any {
-    // return empty so we can
-    return {
-      type: 'FrameEnvironment',
-    };
-  }
 }
 
 export function getFrameState(object: any): IState {

client/lib/Tab.ts

@@ -221,13 +221,6 @@ export default class Tab extends AwaitedEventTarget<IEventType> {
     connection.closeTab(this);
     return coreTab.then(x => x.close());
   }
-
-  public toJSON(): any {
-    // return empty so we can
-    return {
-      type: 'Tab',
-    };
-  }
 }
 
 async function getOrCreateFrameEnvironment(

interfaces/AllowedNames.ts

@@ -9,4 +9,4 @@ type FilterOutFlags<Base, Condition> = {
 type OnlyProperties<Base> = FilterOutFlags<Base, (...args: any[]) => any>[keyof Base];
 type AllowedNames<Base, Condition> = FilterFlags<Base, Condition>[keyof Base];
 
-export { FilterFlags, AllowedNames, OnlyProperties };
+export { FilterOutFlags, FilterFlags, AllowedNames, OnlyProperties };

interfaces/IDevtoolsSession.ts

@@ -1,10 +1,28 @@
 import { ProtocolMapping } from 'devtools-protocol/types/protocol-mapping';
+import ITypedEventEmitter from './ITypedEventEmitter';
+import { FilterFlags, FilterOutFlags } from './AllowedNames';
 
-export default interface IDevtoolsSession {
+export declare type DevtoolsEvents = {
+  [Key in keyof ProtocolMapping.Events]: ProtocolMapping.Events[Key][0];
+} & { disconnected: void };
+
+type DevtoolsCommandParams = {
+  [Key in keyof ProtocolMapping.Commands]: ProtocolMapping.Commands[Key]['paramsType'][0];
+};
+type OptionalParamsCommands = keyof FilterFlags<DevtoolsCommandParams, void | never>;
+type RequiredParamsCommands = keyof FilterOutFlags<DevtoolsCommandParams, void | never>;
+
+export default interface IDevtoolsSession
+  extends Omit<ITypedEventEmitter<DevtoolsEvents>, 'waitOn'> {
   id: string;
-  send<T extends keyof ProtocolMapping.Commands>(
+  send<T extends RequiredParamsCommands>(
+    method: T,
+    params: DevtoolsCommandParams[T],
+    sendInitiator?: object,
+  ): Promise<ProtocolMapping.Commands[T]['returnType']>;
+  send<T extends OptionalParamsCommands>(
     method: T,
-    params: ProtocolMapping.Commands[T]['paramsType'][0],
+    params?: DevtoolsCommandParams[T],
     sendInitiator?: object,
   ): Promise<ProtocolMapping.Commands[T]['returnType']>;
 

puppet-chrome/lib/DevtoolsSession.ts

@@ -23,6 +23,7 @@ import { TypedEventEmitter } from '@secret-agent/commons/eventUtils';
 import IResolvablePromise from '@secret-agent/interfaces/IResolvablePromise';
 import { createPromise } from '@secret-agent/commons/utils';
 import IDevtoolsSession, {
+  DevtoolsEvents,
   IDevtoolsEventMessage,
   IDevtoolsResponseMessage,
 } from '@secret-agent/interfaces/IDevtoolsSession';
@@ -35,7 +36,7 @@ import RemoteObject = Protocol.Runtime.RemoteObject;
  *
  * https://chromedevtools.github.io/devtools-protocol/
  */
-export class DevtoolsSession extends EventEmitter implements IDevtoolsSession {
+export class DevtoolsSession extends TypedEventEmitter<DevtoolsEvents> implements IDevtoolsSession {
   public connection: Connection;
   public messageEvents = new TypedEventEmitter<IMessageEvents>();
   public get id() {
@@ -88,7 +89,7 @@ export class DevtoolsSession extends EventEmitter implements IDevtoolsSession {
   onMessage(object: IDevtoolsResponseMessage & IDevtoolsEventMessage): void {
     this.messageEvents.emit('receive', { ...object });
     if (!object.id) {
-      this.emit(object.method, object.params);
+      this.emit(object.method as any, object.params);
       return;
     }