Fix type checking

Author: K8Sewell

scripts/testBaseUrl.js

@@ -8,23 +8,19 @@ let BASE_URL = "http://localhost:4444";
 
 // environment variable
 if (process.env.BASE_URL) {
-  BASE_URL = process.env.BASE_URL
+  BASE_URL = process.env.BASE_URL;
 }
 
 // local config file
 if (fs.existsSync(localConfigPath)) {
   try {
-    const localConfig = JSON.parse(
-      fs.readFileSync(localConfigPath, "utf8")
-    );
+    const localConfig = JSON.parse(fs.readFileSync(localConfigPath, "utf8"));
 
     if (localConfig && localConfig.BASE_URL) {
       BASE_URL = localConfig.BASE_URL;
-    } 
+    }
   } catch (err) {
-    console.warn(
-      "Invalid testBaseUrl.local.json, using default BASE_URL"
-    );
+    console.warn("Invalid testBaseUrl.local.json, using default BASE_URL");
   }
 }
-module.exports = { BASE_URL };
+module.exports = { BASE_URL };

src/content-handlers/iiif/JQueryPlugins.ts

@@ -553,70 +553,6 @@ export default function jqueryPlugins($) {
   };
 }
 
-interface JQuery {
-  attr: any;
-  css: any;
-  append: any;
-  text: any;
-  toggle: any;
-  html: any;
-  empty: any;
-  one: any;
-  remove: any;
-  height: any;
-  contents: any;
-  outerWidth: any;
-  outerHeight: any;
-  offset: any;
-  mousemove: any;
-  find: any;
-  data: any;
-  addClass: any;
-  removeClass: any;
-  width: any;
-  removeAttr: any;
-  prop: any;
-  is: any;
-  checkboxButton(onClicked: (checked: boolean) => void): void;
-  disable(): void;
-  ellipsis(chars: number): string;
-  ellipsisFill(text?: string): any;
-  ellipsisFixed(chars: number, buttonText: string): any;
-  ellipsisHtmlFixed(chars: number, callback: () => void): any;
-  enable(): void;
-  equaliseHeight(reset?: boolean, average?: boolean): any;
-  getVisibleElementWithGreatestTabIndex(): any;
-  horizontalMargins(): number;
-  horizontalPadding(): number;
-  ismouseover(): boolean;
-  leftMargin(): number;
-  leftPadding(): number;
-  on(
-    events: string,
-    handler: (eventObject: JQueryEventObject, ...args: any[]) => any,
-    wait: Number
-  ): JQuery;
-  onEnter(callback: () => void): any;
-  onPressed(callback: (e: any) => void): any;
-  removeLastWord(chars?: number, depth?: number): any;
-  rightMargin(): number;
-  rightPadding(): number;
-  switchClass(class1: string, class2: string): any;
-  targetBlank(): void;
-  toggleExpandText(
-    chars: number,
-    lessText: string,
-    moreText: string,
-    cb: () => void
-  ): any;
-  toggleExpandTextByLines(
-    lines: number,
-    lessText: string,
-    moreText: string,
-    cb: () => void
-  ): any;
-  toggleText(text1: string, text2: string): any;
-  updateAttr(attrName: string, oldVal: string, newVal: string): void;
-  verticalMargins(): number;
-  verticalPadding(): number;
-}
+// NOTE: the JQuery interface augmentation for these plugins lives in
+// src/globals.d.ts — an interface declared inside this module would be
+// module-local and invisible to the rest of the app.

src/globals.d.ts

@@ -15,6 +15,85 @@ interface HTMLElement {
   ontouchstart: any;
 }
 
+// jQuery plugin methods added in src/content-handlers/iiif/JQueryPlugins.ts,
+// plus loosened core-method types this codebase relies on. Previously this
+// interface lived inside JQueryPlugins.ts where, being module-scoped, it never
+// applied globally — the app instead type-checked against the loose jQuery 2
+// typings that @iiif/iiif-av-component (since vendored) pulled in transitively.
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+interface JQuery<TElement = HTMLElement> {
+  attr(...args: any[]): any;
+  css(...args: any[]): any;
+  append(...args: any[]): any;
+  text(...args: any[]): any;
+  toggle(...args: any[]): any;
+  html(...args: any[]): any;
+  empty(...args: any[]): any;
+  one(...args: any[]): any;
+  remove(...args: any[]): any;
+  height(...args: any[]): any;
+  contents(...args: any[]): any;
+  outerWidth(...args: any[]): any;
+  outerHeight(...args: any[]): any;
+  offset(...args: any[]): any;
+  mousemove(...args: any[]): any;
+  find(...args: any[]): any;
+  data(...args: any[]): any;
+  addClass(...args: any[]): any;
+  removeClass(...args: any[]): any;
+  width(...args: any[]): any;
+  removeAttr(...args: any[]): any;
+  prop(...args: any[]): any;
+  is(...args: any[]): any;
+  val(...args: any[]): any;
+  on(...args: any[]): any;
+  delegate(...args: any[]): any;
+  scrollTop(...args: any[]): any;
+  link(...args: any[]): any; // jsviews
+  checkboxButton(onClicked: (checked: boolean) => void): void;
+  disable(): void;
+  ellipsis(chars: number): string;
+  ellipsisFill(text?: string): any;
+  ellipsisFixed(chars: number, buttonText: string): any;
+  ellipsisHtmlFixed(chars: number, callback: () => void): any;
+  enable(): void;
+  equaliseHeight(reset?: boolean, average?: boolean): any;
+  getVisibleElementWithGreatestTabIndex(): any;
+  horizontalMargins(): number;
+  horizontalPadding(): number;
+  ismouseover(): boolean;
+  leftMargin(): number;
+  leftPadding(): number;
+  on(
+    events: string,
+    handler: (eventObject: JQueryEventObject, ...args: any[]) => any,
+    wait: Number
+  ): JQuery;
+  onEnter(callback: () => void): any;
+  onPressed(callback: (e: any) => void): any;
+  removeLastWord(chars?: number, depth?: number): any;
+  rightMargin(): number;
+  rightPadding(): number;
+  switchClass(class1: string, class2: string): any;
+  targetBlank(): void;
+  toggleExpandText(
+    chars: number,
+    lessText: string,
+    moreText: string,
+    cb: () => void
+  ): any;
+  toggleExpandTextByLines(
+    lines: number,
+    lessText: string,
+    moreText: string,
+    cb: () => void
+  ): any;
+  toggleText(text1: string, text2: string): any;
+  updateAttr(attrName: string, oldVal: string, newVal: string): void;
+  verticalMargins(): number;
+  verticalPadding(): number;
+}
+
 interface JQueryStatic {
   // pubsub
   publish(event: string, eventObj?: any[]): void;