fix remaining type & lint issues

Author: emma-sg

src/autoplay.ts

@@ -9,7 +9,7 @@ export class Autoplay extends BackgroundBehavior {
   mediaSet: Set<string>;
   autofetcher: AutoFetcher;
   numPlaying: number;
-  promises: Promise<any>[];
+  promises: Promise<boolean | undefined>[];
   _initDone: Function;
   running = false;
   polling = false;

src/autoscroll.ts

@@ -44,7 +44,9 @@ export class AutoScroll
     this.origPath = document.location.pathname;
   }
 
-  static id = "Autoscroll" as const;
+  static get id() {
+    return "Autoscroll";
+  }
 
   currScrollPos() {
     return Math.round(self.scrollY + self.innerHeight);
@@ -68,7 +70,7 @@ export class AutoScroll
 
   hasScrollEL(obj: HTMLElement | Document | Window) {
     try {
-      return !!self["getEventListeners"](obj).scroll;
+      return !!self["getEventListeners"]!(obj).scroll;
     } catch (_) {
       // unknown, assume has listeners
       this.debug("getEventListeners() not available");

src/index.ts

@@ -60,13 +60,14 @@ type BehaviorClass =
   | typeof AutoScroll
   | typeof Autoplay
   | typeof AutoFetcher
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   | typeof BehaviorRunner<any, any>;
 
 type BehaviorInstance = InstanceType<BehaviorClass>;
 
 export class BehaviorManager {
   autofetch?: AutoFetcher;
-  behaviors: BehaviorInstance[] | null;
+  behaviors: BehaviorInstance[];
   loadedBehaviors: Record<string, BehaviorClass>;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   mainBehavior: BehaviorInstance | BehaviorRunner<any, any> | null;
@@ -139,17 +140,17 @@ export class BehaviorManager {
 
     if (opts.autofetch) {
       void behaviorLog("Using AutoFetcher");
-      this.behaviors!.push(this.autofetch);
+      this.behaviors.push(this.autofetch);
     }
 
     if (opts.autoplay) {
       void behaviorLog("Using Autoplay");
-      this.behaviors!.push(new Autoplay(this.autofetch, !!opts.startEarly));
+      this.behaviors.push(new Autoplay(this.autofetch, !!opts.startEarly));
     }
 
     if (opts.autoclick) {
       void behaviorLog("Using AutoClick");
-      this.behaviors!.push(
+      this.behaviors.push(
         new AutoClick(opts.clickSelector || DEFAULT_CLICK_SELECTOR),
       );
     }
@@ -160,6 +161,7 @@ export class BehaviorManager {
           this.load(behaviorClass);
         } catch (e) {
           void behaviorLog(
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
             `Failed to load custom behavior: ${e} ${behaviorClass}`,
           );
         }
@@ -186,6 +188,7 @@ export class BehaviorManager {
               : {};
           try {
             this.mainBehavior = new BehaviorRunner(
+              // @ts-expect-error TODO figure out types here
               siteBehaviorClass,
               siteSpecificOpts,
             );
@@ -208,7 +211,7 @@ export class BehaviorManager {
     }
 
     if (this.mainBehavior) {
-      this.behaviors!.push(this.mainBehavior);
+      this.behaviors.push(this.mainBehavior);
 
       if (this.mainBehavior instanceof BehaviorRunner) {
         return this.mainBehavior.behaviorProps.id;
@@ -221,6 +224,7 @@ export class BehaviorManager {
   load(behaviorClass: unknown) {
     if (typeof behaviorClass !== "function") {
       void behaviorLog(
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         `Must pass a class object, got ${behaviorClass}`,
         "error",
       );
@@ -279,7 +283,7 @@ export class BehaviorManager {
     if (
       this.mainBehavior &&
       "awaitPageLoad" in this.mainBehavior &&
-      (this.mainBehavior as AbstractBehavior<any, any>).awaitPageLoad
+      (this.mainBehavior as AbstractBehavior<unknown, unknown>).awaitPageLoad
     ) {
       void behaviorLog("Waiting for custom page load via behavior");
       // @ts-expect-error TODO why isn't `log` passed in here? It seems like functions expect it to be
@@ -304,18 +308,21 @@ export class BehaviorManager {
 
     await awaitLoad();
 
-    this.behaviors!.forEach((x) => {
-      const id = x.id || x.constructor.id || "(Unnamed)";
-      behaviorLog("Starting behavior: " + id, "debug");
-      x.start();
+    this.behaviors.forEach((x) => {
+      const id =
+        (x as unknown as typeof AbstractBehavior<unknown>).id ||
+        (x.constructor as unknown as typeof AbstractBehavior<unknown>).id ||
+        "(Unnamed)";
+      void behaviorLog("Starting behavior: " + id, "debug");
+      "start" in x && void x.start();
     });
 
     this.started = true;
 
     await sleep(500);
 
     const allBehaviors = Promise.allSettled(
-      this.behaviors.map((x) => x.done()),
+      this.behaviors.map(async (x) => "done" in x && x.done()),
     );
 
     if (this.timeout) {
@@ -325,44 +332,48 @@ export class BehaviorManager {
       );
       await Promise.race([allBehaviors, sleep(this.timeout)]);
     } else {
-      behaviorLog("Waiting for behaviors to finish", "debug");
+      void behaviorLog("Waiting for behaviors to finish", "debug");
       await allBehaviors;
     }
 
-    behaviorLog("All Behaviors Done for " + self.location.href, "debug");
+    void behaviorLog("All Behaviors Done for " + self.location.href, "debug");
 
-    if (this.mainBehavior && this.mainBehaviorClass.cleanup) {
+    if (this.mainBehavior && "cleanup" in this.mainBehavior) {
       this.mainBehavior.cleanup();
     }
   }
 
-  async runOne(name, behaviorOpts = {}) {
+  async runOne(name: string, behaviorOpts = {}) {
     const siteBehaviorClass = siteBehaviors.find((b) => b.name === name);
     if (typeof siteBehaviorClass === "undefined") {
       console.error(`No behavior of name ${name} found`);
       return;
     }
     //const behavior = new siteBehaviorClass(behaviorOpts);
-    const behavior = new BehaviorRunner(siteBehaviorClass, behaviorOpts);
+    const behavior = new BehaviorRunner(
+      // @ts-expect-error TODO figure out types here
+      siteBehaviorClass,
+      behaviorOpts,
+    );
     behavior.start();
     console.log(`Running behavior: ${name}`);
     await behavior.done();
     console.log(`Behavior ${name} completed`);
   }
 
   pause() {
-    behaviorLog("Pausing Main Behavior" + this.mainBehaviorClass.name);
-    this.behaviors.forEach((x) => x.pause());
+    void behaviorLog("Pausing Main Behavior" + this.mainBehaviorClass.name);
+    this.behaviors.forEach((x) => "pause" in x && x.pause());
   }
 
   unpause() {
     // behaviorLog("Unpausing Main Behavior: " + this.mainBehaviorClass.name);
-    this.behaviors.forEach((x) => x.unpause());
+    this.behaviors.forEach((x) => "pause" in x && x.unpause());
   }
 
-  doAsyncFetch(url) {
-    behaviorLog("Queueing Async Fetch Url: " + url);
-    return this.autofetch.queueUrl(url, true);
+  doAsyncFetch(url: string) {
+    void behaviorLog("Queueing Async Fetch Url: " + url);
+    return this.autofetch!.queueUrl(url, true);
   }
 
   isInTopFrame() {
@@ -391,9 +402,10 @@ export class BehaviorManager {
 
     const urls = new Set<string>();
 
-    document.querySelectorAll(selector).forEach((elem: any) => {
+    document.querySelectorAll(selector).forEach((elem) => {
       // first, try property, unless attrOnly is set
-      let value = !attrOnly ? elem[extractName] : null;
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      let value = !attrOnly ? (elem as any)[extractName] : null;
       if (!value) {
         value = elem.getAttribute(extractName);
       }

src/lib/behavior.ts

@@ -17,11 +17,11 @@ export class BackgroundBehavior {
 }
 
 // ===========================================================================
-export class Behavior extends BackgroundBehavior {
+export class Behavior<State> extends BackgroundBehavior {
   _running: Promise<void> | null;
-  paused: any;
-  _unpause: any;
-  state: any;
+  paused: Promise<void> | null;
+  _unpause: (() => void) | null;
+  state: Partial<State>;
   scrollOpts: {
     behavior: string;
     block: string;
@@ -77,12 +77,15 @@ export class Behavior extends BackgroundBehavior {
     }
   }
 
-  getState(msg: string, incrValue?: string) {
+  getState<IncrKey extends Lib.NumberKeys<State>>(
+    msg: string,
+    incrValue?: IncrKey,
+  ) {
     if (incrValue) {
       if (this.state[incrValue] === undefined) {
-        this.state[incrValue] = 1;
+        (this.state[incrValue] as number) = 1;
       } else {
-        this.state[incrValue]++;
+        (this.state[incrValue] as number)++;
       }
     }
 
@@ -91,7 +94,7 @@ export class Behavior extends BackgroundBehavior {
 
   cleanup() {}
 
-  async awaitPageLoad(_: any) {
+  async awaitPageLoad() {
     // wait for initial page load here
   }
 
@@ -119,13 +122,19 @@ export type Context<State, Opts = EmptyObject> = {
   Lib: typeof Lib;
   state: State;
   opts: Opts;
-  log: (data: any, type?: string) => Promise<void>;
+  log: (data: unknown, type?: string) => Promise<void>;
 };
 
 export abstract class AbstractBehavior<State, Opts = EmptyObject> {
   static readonly id: string;
   static isMatch: () => boolean;
-  static init: () => any;
+  static init: () => {
+    // TODO: type these
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    state?: any;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    opts?: any;
+  };
 
   abstract run: (
     ctx: Context<State, Opts>,
@@ -154,9 +163,9 @@ export class BehaviorRunner<State, Opts>
   inst: AbstractBehavior<State, Opts>;
   behaviorProps: ConcreteBehaviorConstructor<State, Opts>;
   ctx: Context<State, Opts>;
-  _running: any;
-  paused: any;
-  _unpause: any;
+  _running: Promise<void> | null;
+  paused: Promise<void> | (() => Promise<void>) | null;
+  _unpause: ((value: void | PromiseLike<void>) => void) | null;
 
   get id() {
     return (this.inst.constructor as ConcreteBehaviorConstructor<State, Opts>)
@@ -209,7 +218,7 @@ export class BehaviorRunner<State, Opts>
     this._running = this.run();
   }
 
-  done() {
+  async done() {
     return this._running ? this._running : Promise.resolve();
   }
 

src/lib/global.d.ts

@@ -10,7 +10,9 @@ interface BehaviorGlobals {
     idleTime: number;
     concurrency: number;
   }) => Promise<void>;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   __bx_initFlow?: (params: any) => Promise<number>;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   __bx_nextFlowStep?: (id: number) => Promise<any>;
   __bx_contentCheckFailed?: (reason: string) => void;
   __bx_open?: (params: { url: string | URL }) => Promise<void>;
@@ -31,7 +33,7 @@ declare global {
      * Chrome DevTools’s `getEventListeners` API
      * @see https://developer.chrome.com/docs/devtools/console/utilities/#getEventListeners-function
      */
-    getEventListeners: <Obj>(
+    getEventListeners?: <Obj>(
       obj: Obj,
     ) => Record<
       Obj extends Window ? keyof WindowEventMap : string,

src/lib/utils.ts

@@ -1,8 +1,7 @@
 import { type BehaviorManager } from "..";
 import { type Context } from "./behavior";
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-let _logFunc: ((...data: any[]) => void) | null = console.log;
+let _logFunc: ((...data: unknown[]) => void) | null = console.log;
 let _behaviorMgrClass: typeof BehaviorManager | null = null;
 
 const scrollOpts: ScrollIntoViewOptions = {
@@ -173,6 +172,7 @@ export async function waitForNetworkIdle(idleTime = 500, concurrency = 0) {
   }
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export async function initFlow(params: any): Promise<number> {
   if (typeof self["__bx_initFlow"] === "function") {
     return await callBinding(self["__bx_initFlow"], params);
@@ -181,6 +181,7 @@ export async function initFlow(params: any): Promise<number> {
   return -1;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export async function nextFlowStep(id: number): Promise<any> {
   if (typeof self["__bx_nextFlowStep"] === "function") {
     return await callBinding(self["__bx_nextFlowStep"], id);
@@ -228,7 +229,7 @@ export async function openWindow(
 export function _setLogFunc(
   func: ((message: string, level: string) => void) | null,
 ) {
-  _logFunc = func;
+  _logFunc = func as (...data: unknown[]) => void;
 }
 
 export function _setBehaviorManager(cls: typeof BehaviorManager) {

src/site/youtube.ts

@@ -2,7 +2,7 @@ import { AutoScroll } from "../autoscroll";
 import { type Context } from "../lib/behavior";
 
 export class YoutubeBehavior extends AutoScroll {
-  static id = "Youtube" as const;
+  static override id = "Youtube" as const;
   async awaitPageLoad(ctx: Context<{}, {}>) {
     const { sleep, assertContentValid } = ctx.Lib;
     await sleep(10);