@vpmedia/phaser 1.122.0 → 1.124.0

package/src/phaser/core/array_set.ts

@@ -1,12 +1,14 @@
-export class ArraySet {
+import type { AppliedCallback } from './callback.js';
+
+export class ArraySet<T> {
   public position = 0;
-  public list: any[];
+  public list: T[];
 
   /**
    * TBD.
    * @param {object[]} list - TBD.
    */
-  public constructor(list: any[] = []) {
+  public constructor(list: T[] = []) {
     this.list = list;
   }
 
@@ -15,7 +17,7 @@ export class ArraySet {
    * @param {object} item - TBD.
    * @returns {object} TBD.
    */
-  public add(item: any) {
+  public add(item: T): T {
     if (!this.exists(item)) {
       this.list.push(item);
     }
@@ -27,7 +29,7 @@ export class ArraySet {
    * @param {object} item - TBD.
    * @returns {number} TBD.
    */
-  public getIndex(item: any): number {
+  public getIndex(item: T): number {
     return this.list.indexOf(item);
   }
 
@@ -37,12 +39,11 @@ export class ArraySet {
    * @param {object} value - TBD.
    * @returns {object} TBD.
    */
-  public getByKey(property: string, value: any) {
-    let i = this.list.length;
-    while (i) {
-      i -= 1;
-      if (this.list[i][property] === value) {
-        return this.list[i];
+  public getByKey(property: string, value: unknown): T | null {
+    for (let i = this.list.length - 1; i >= 0; i -= 1) {
+      const item = this.list[i] as Record<string, unknown> | undefined;
+      if (item?.[property] === value) {
+        return this.list[i]!;
       }
     }
     return null;
@@ -53,7 +54,7 @@ export class ArraySet {
    * @param {object} item - TBD.
    * @returns {boolean} TBD.
    */
-  public exists(item: any): boolean {
+  public exists(item: T): boolean {
     return this.list.includes(item);
   }
 
@@ -69,7 +70,7 @@ export class ArraySet {
    * @param {object} item - TBD.
    * @returns {object} TBD.
    */
-  public remove(item: any) {
+  public remove(item: T): T | null {
     const idx = this.list.indexOf(item);
     if (idx !== -1) {
       this.list.splice(idx, 1);
@@ -83,10 +84,10 @@ export class ArraySet {
    * @param {string} key - TBD.
    * @param {object} value - TBD.
    */
-  public setAll(key: string, value: any): void {
+  public setAll(key: string, value: unknown): void {
     for (const item of this.list) {
       if (item) {
-        item[key] = value;
+        (item as Record<string, unknown>)[key] = value;
       }
     }
   }
@@ -99,8 +100,8 @@ export class ArraySet {
   public callAll(key: string, ...args: unknown[]): void {
     // walked backwards so a callback that removes its own entry does not skip the next one
     for (let i = this.list.length - 1; i >= 0; i -= 1) {
-      const item = this.list[i];
-      if (item && item[key]) {
+      const item = this.list[i] as Record<string, AppliedCallback> | undefined;
+      if (item?.[key]) {
         item[key](...args);
       }
     }
@@ -111,13 +112,12 @@ export class ArraySet {
    * @param {boolean} destroy - TBD.
    */
   public removeAll(destroy = false): void {
-    let i = this.list.length;
-    while (i) {
-      i -= 1;
-      if (this.list[i]) {
-        const item = this.remove(this.list[i]);
+    for (let i = this.list.length - 1; i >= 0; i -= 1) {
+      const entry = this.list[i];
+      if (entry) {
+        const item = this.remove(entry) as { destroy?: () => void } | null;
         if (destroy) {
-          item.destroy();
+          item?.destroy?.();
         }
       }
     }
@@ -137,10 +137,10 @@ export class ArraySet {
    * TBD.
    * @returns {object} TBD.
    */
-  public get first() {
+  public get first(): T | null {
     this.position = 0;
     if (this.list.length > 0) {
-      return this.list[0];
+      return this.list[0]!;
     }
     return null;
   }
@@ -149,10 +149,10 @@ export class ArraySet {
    * TBD.
    * @returns {object} TBD.
    */
-  public get next() {
+  public get next(): T | null {
     if (this.position < this.list.length) {
       this.position += 1;
-      return this.list[this.position];
+      return this.list[this.position] ?? null;
     }
     return null;
   }

package/src/phaser/core/cache.test.ts

@@ -27,36 +27,36 @@ const FONT_XML = `<?xml version="1.0"?>
   </chars>
 </font>`;
 
-describe('Cache', () => {
+describe('Cache', (): void => {
   let cache: Cache;
 
-  beforeEach(() => {
+  beforeEach((): void => {
     getRegistry().TEXTURE_SCALE_MODE = SCALE_LINEAR;
     cache = new Cache(createGame());
   });
 
-  describe('images', () => {
-    it('seeds the default and missing images', () => {
+  describe('images', (): void => {
+    it('seeds the default and missing images', (): void => {
       expect(cache.checkImageKey('__default')).toBe(true);
       expect(cache.checkImageKey('__missing')).toBe(true);
     });
 
-    it('keeps the default image out of the reported keys', () => {
+    it('keeps the default image out of the reported keys', (): void => {
       expect(cache.getKeys(IMAGE)).toStrictEqual([]);
     });
 
-    it('returns the source bitmap by default and the whole entry when asked', () => {
+    it('returns the source bitmap by default and the whole entry when asked', (): void => {
       const source = createImage();
       cache.addImage('logo', 'logo.png', source);
       expect(cache.getImage('logo')).toBe(source);
       expect(cache.getImage('logo', true).key).toBe('logo');
     });
 
-    it('falls back to the missing image for an unknown key', () => {
+    it('falls back to the missing image for an unknown key', (): void => {
       expect(cache.getImage('nope', true).key).toBe('__missing');
     });
 
-    it('gives an image one frame covering the whole bitmap', () => {
+    it('gives an image one frame covering the whole bitmap', (): void => {
       cache.addImage('logo', 'logo.png', createImage(64, 32));
       const frame = cache.getFrameByIndex('logo', 0);
       expect(frame?.width).toBe(64);
@@ -64,26 +64,26 @@ describe('Cache', () => {
       expect(cache.getFrameCount('logo')).toBe(1);
     });
 
-    it('reports no frames for a key it does not hold', () => {
+    it('reports no frames for a key it does not hold', (): void => {
       expect(cache.getFrameData('nope')).toBeNull();
       expect(cache.getFrameCount('nope')).toBe(0);
       expect(cache.hasFrameData('nope')).toBe(false);
     });
 
-    it('drops an image when it is removed', () => {
+    it('drops an image when it is removed', (): void => {
       cache.addImage('logo', 'logo.png', createImage());
       cache.removeImage('logo');
       expect(cache.checkImageKey('logo')).toBe(false);
     });
 
-    it('replaces an image registered twice under the same key', () => {
+    it('replaces an image registered twice under the same key', (): void => {
       cache.addImage('logo', 'a.png', createImage(4, 4));
       const second = createImage(8, 8);
       cache.addImage('logo', 'b.png', second);
       expect(cache.getImage('logo')).toBe(second);
     });
 
-    it('clears the GL textures of every cached image', () => {
+    it('clears the GL textures of every cached image', (): void => {
       cache.addImage('logo', 'logo.png', createImage());
       const entry = cache.getImage('logo', true);
       entry.base._glTextures = [null];
@@ -92,25 +92,25 @@ describe('Cache', () => {
     });
   });
 
-  describe('sounds', () => {
-    it('stores a sound as undecoded', () => {
+  describe('sounds', (): void => {
+    it('stores a sound as undecoded', (): void => {
       cache.addSound('shot', 'shot.ogg', new ArrayBuffer(8));
       expect(cache.isSoundDecoded('shot')).toBe(false);
       expect(cache.isSoundReady('shot')).toBe(false);
     });
 
-    it('reports an unknown sound as neither decoded nor ready', () => {
+    it('reports an unknown sound as neither decoded nor ready', (): void => {
       expect(cache.isSoundDecoded('nope')).toBeNull();
       expect(cache.isSoundReady('nope')).toBe(false);
     });
 
-    it('updates a single property of a cached sound', () => {
+    it('updates a single property of a cached sound', (): void => {
       cache.addSound('shot', 'shot.ogg', new ArrayBuffer(8));
       cache.updateSound('shot', 'isDecoding', true);
       expect(cache.getSound('shot')?.isDecoding).toBe(true);
     });
 
-    it('swaps in the decoded buffer and marks the sound ready', () => {
+    it('swaps in the decoded buffer and marks the sound ready', (): void => {
       cache.addSound('shot', 'shot.ogg', new ArrayBuffer(8));
       const buffer = { duration: 1.5 } as AudioBuffer;
       cache.decodedSound('shot', buffer);
@@ -119,33 +119,33 @@ describe('Cache', () => {
       expect(cache.isSoundReady('shot')).toBe(true);
     });
 
-    it('ignores a decode result for a sound it never held', () => {
-      expect(() => {
+    it('ignores a decode result for a sound it never held', (): void => {
+      expect((): void => {
         cache.decodedSound('nope', {} as AudioBuffer);
       }).not.toThrow();
     });
 
-    it('drops a sound when it is removed', () => {
+    it('drops a sound when it is removed', (): void => {
       cache.addSound('shot', 'shot.ogg', new ArrayBuffer(8));
       cache.removeSound('shot');
       expect(cache.getSound('shot')).toBeNull();
     });
   });
 
-  describe('data', () => {
-    it('round-trips text', () => {
+  describe('data', (): void => {
+    it('round-trips text', (): void => {
       cache.addText('note', 'note.txt', 'hello');
       expect(cache.getText('note')).toBe('hello');
       cache.removeText('note');
       expect(cache.getText('note')).toBeNull();
     });
 
-    it('round-trips JSON', () => {
+    it('round-trips JSON', (): void => {
       cache.addJSON('config', 'config.json', { a: 1 });
       expect(cache.getJSON('config')).toStrictEqual({ a: 1 });
     });
 
-    it('hands back a detached copy when a clone is asked for', () => {
+    it('hands back a detached copy when a clone is asked for', (): void => {
       const data = { a: 1 };
       cache.addJSON('config', 'config.json', data);
       const clone = cache.getJSON<{ a: number }>('config', true);
@@ -153,15 +153,15 @@ describe('Cache', () => {
       expect(clone).not.toBe(data);
     });
 
-    it('round-trips XML', () => {
+    it('round-trips XML', (): void => {
       const xml = new DOMParser().parseFromString('<root/>', 'text/xml');
       cache.addXML('doc', 'doc.xml', xml);
       expect(cache.getXML('doc')).toBe(xml);
     });
   });
 
-  describe('bitmap fonts', () => {
-    it('parses the descriptor and keeps it beside the atlas', () => {
+  describe('bitmap fonts', (): void => {
+    it('parses the descriptor and keeps it beside the atlas', (): void => {
       const xml = new DOMParser().parseFromString(FONT_XML, 'text/xml');
       cache.addBitmapFont('arial', 'arial.png', createImage(256, 256), xml, 'xml');
       const entry = cache.getBitmapFont('arial');
@@ -170,26 +170,26 @@ describe('Cache', () => {
       expect(entry?.base).toBeDefined();
     });
 
-    it('reports a font it does not hold as absent', () => {
+    it('reports a font it does not hold as absent', (): void => {
       expect(cache.checkBitmapFontKey('nope')).toBe(false);
       expect(cache.getBitmapFont('nope')).toBeNull();
     });
   });
 
-  describe('getItem', () => {
-    it('returns the whole entry when no property is named', () => {
+  describe('getItem', (): void => {
+    it('returns the whole entry when no property is named', (): void => {
       cache.addText('note', 'note.txt', 'hello');
       expect(cache.getItem('note', 4, 'test')).toStrictEqual({ url: 'note.txt', data: 'hello' });
     });
 
-    it('returns null for a key the bucket does not hold', () => {
+    it('returns null for a key the bucket does not hold', (): void => {
       expect(cache.getItem('nope', SOUND, 'test')).toBeNull();
       expect(cache.getItem('nope', BITMAPFONT, 'test', 'font')).toBeNull();
     });
   });
 
-  describe('destroy', () => {
-    it('empties every bucket but the built-in images', () => {
+  describe('destroy', (): void => {
+    it('empties every bucket but the built-in images', (): void => {
       cache.addText('note', 'note.txt', 'hello');
       cache.addSound('shot', 'shot.ogg', new ArrayBuffer(8));
       cache.destroy();

package/src/phaser/core/cache.ts

@@ -6,7 +6,7 @@ import { Frame } from './frame.js';
 import { FrameData } from './frame_data.js';
 import { jsonBitmapFont, xmlBitmapFont } from './loader_parser.js';
 import { Signal } from './signal.js';
-import type { BitmapFontData } from './loader_parser.js';
+import type { BitmapFontData, JsonBitmapFontDescriptor } from './loader_parser.js';
 import type { Game } from './game.js';
 
 export const CANVAS = 0;
@@ -272,7 +272,7 @@ export class Cache {
     const base = new BaseTexture(data);
     const font =
       atlasType === 'json'
-        ? jsonBitmapFont(atlasData, base, xSpacing, ySpacing)
+        ? jsonBitmapFont(atlasData as JsonBitmapFontDescriptor, base, xSpacing, ySpacing)
         : xmlBitmapFont(atlasData as XMLDocument, base, xSpacing, ySpacing);
     const obj: BitmapFontCacheEntry = { url, data, font, base };
     this._cache.bitmapFont[key] = obj;
@@ -703,7 +703,7 @@ export class Cache {
    * @param {string} url - The original URL to resolve.
    * @returns {string} The resolved URL or null if not found.
    */
-  public getURL(url: string) {
+  public getURL(url: string): object | null {
     const resolvedURL = this._resolveURL(url);
     if (resolvedURL) {
       return this._urlMap?.[resolvedURL] ?? null;

package/src/phaser/core/callback.ts

@@ -31,4 +31,5 @@ export type InterpolationFunction = (v: number[], k: number) => number;
  * and consumers narrow it by declaring their own display-object subtype — which only holds while
  * the property stays assignable in both directions, so this one bag has no shape.
  */
+// eslint-disable-next-line typescript/no-explicit-any -- the whole point of this bag is that it has no shape
 export type UserData = any;

package/src/phaser/core/callback_context.test.ts

@@ -15,9 +15,9 @@ class Consumer {
   }
 }
 
-describe('callback contexts', () => {
-  describe('Signal', () => {
-    it('accepts an arbitrary receiver on add', () => {
+describe('callback contexts', (): void => {
+  describe('Signal', (): void => {
+    it('accepts an arbitrary receiver on add', (): void => {
       const signal = new Signal();
       const consumer = new Consumer();
       signal.add(consumer.handler, consumer);
@@ -25,7 +25,7 @@ describe('callback contexts', () => {
       expect(consumer.seen).toBe('payload');
     });
 
-    it('accepts an arbitrary receiver on addOnce', () => {
+    it('accepts an arbitrary receiver on addOnce', (): void => {
       const signal = new Signal();
       const consumer = new Consumer();
       signal.addOnce(consumer.handler, consumer);
@@ -33,7 +33,7 @@ describe('callback contexts', () => {
       expect(consumer.seen).toBe('once');
     });
 
-    it('matches the receiver on remove', () => {
+    it('matches the receiver on remove', (): void => {
       const signal = new Signal();
       const consumer = new Consumer();
       signal.add(consumer.handler, consumer);
@@ -41,7 +41,7 @@ describe('callback contexts', () => {
       expect(signal.getNumListeners()).toBe(0);
     });
 
-    it('matches the receiver on removeAll', () => {
+    it('matches the receiver on removeAll', (): void => {
       const signal = new Signal();
       const consumer = new Consumer();
       signal.add(consumer.handler, consumer);
@@ -50,7 +50,7 @@ describe('callback contexts', () => {
       expect(signal.getNumListeners()).toBe(1);
     });
 
-    it('reports whether a listener is bound to a receiver', () => {
+    it('reports whether a listener is bound to a receiver', (): void => {
       const signal = new Signal();
       const consumer = new Consumer();
       signal.add(consumer.handler, consumer);
@@ -58,7 +58,7 @@ describe('callback contexts', () => {
       expect(signal.has(consumer.handler, new Consumer())).toBe(false);
     });
 
-    it('keeps separate bindings per receiver', () => {
+    it('keeps separate bindings per receiver', (): void => {
       const signal = new Signal();
       const first = new Consumer();
       const second = new Consumer();

package/src/phaser/core/dom.ts

@@ -1,4 +1,14 @@
 import { Point } from '../geom/point.js';
+
+/** An element rectangle after the cushion has been applied to every edge. */
+export type CalibratedBounds = {
+  width: number;
+  height: number;
+  left: number;
+  right: number;
+  top: number;
+  bottom: number;
+};
 import type { Device } from './device.js';
 
 class VisualBoundsDesktopRectangle {
@@ -170,9 +180,9 @@ class DocumentBoundsRectangle {
 
 export class DOM {
   public treatAsDesktop: boolean;
-  public visualBounds: any;
-  public layoutBounds: any;
-  public documentBounds: any;
+  public visualBounds: VisualBoundsDesktopRectangle | VisualBoundsRectangle;
+  public layoutBounds: LayoutBoundsDesktopRectangle | LayoutBoundsRectangle;
+  public documentBounds: DocumentBoundsRectangle;
   public scrollXProvider: () => number;
   public scrollYProvider: () => number;
 
@@ -222,7 +232,7 @@ export class DOM {
    * @param {number} cushion - Optional padding to add around the element.
    * @returns {boolean} True if bounds were successfully retrieved, false otherwise.
    */
-  public getBounds(element: HTMLCanvasElement, cushion = 0) {
+  public getBounds(element: HTMLCanvasElement, cushion = 0): CalibratedBounds | false {
     element = element && !element.nodeType ? (element as unknown as HTMLCanvasElement[])[0]! : element;
     if (!element || element.nodeType !== 1) {
       return false;
@@ -236,7 +246,7 @@ export class DOM {
    * @param {number} cushion - Optional padding to add around the rectangle.
    * @returns {{width: number, height: number, left: number, right: number, top: number, bottom: number}} The calibrated rectangle.
    */
-  public calibrate(coords: DOMRect, cushion = 0) {
+  public calibrate(coords: DOMRect, cushion = 0): CalibratedBounds {
     const output = {
       width: 0,
       height: 0,

package/src/phaser/core/factory.ts

@@ -6,6 +6,7 @@ import { Image } from '../display/image.js';
 import { Text } from '../display/text.js';
 import type { Game } from './game.js';
 import type { SignalListener } from './signal.js';
+import type { TextStyle } from '../display/text.js';
 
 export class GameObjectFactory {
   public game!: Game;
@@ -26,7 +27,13 @@ export class GameObjectFactory {
    * @param {Group} group - The parent group for the image.
    * @returns {Image} The created Image object.
    */
-  public image(x: number, y: number, key: string, frame: any, group: Group | null = null): Image {
+  public image(
+    x: number,
+    y: number,
+    key: string,
+    frame: string | number | null = null,
+    group: Group | null = null
+  ): Image {
     const target = group ?? this.game.world;
     return target.add(new Image(this.game, x, y, key, frame));
   }
@@ -51,7 +58,7 @@ export class GameObjectFactory {
    * @param {Group | null} group - The parent group for the text.
    * @returns {Text} The created Text object.
    */
-  public text(x: number, y: number, text: any, style: any, group: Group | null = null): Text {
+  public text(x: number, y: number, text: string | number, style: TextStyle, group: Group | null = null): Text {
     const parent = group ?? this.game.world;
     return parent.add(new Text(this.game, x, y, text, style));
   }

package/src/phaser/core/frame_data.test.ts

@@ -10,89 +10,89 @@ const seed = (names: string[]): FrameData => {
   return data;
 };
 
-describe('FrameData', () => {
-  describe('addFrame', () => {
-    it('assigns a sequential index and registers the name', () => {
+describe('FrameData', (): void => {
+  describe('addFrame', (): void => {
+    it('assigns a sequential index and registers the name', (): void => {
       const data = seed(['a', 'b']);
-      expect(data._frames.map((frame) => frame.index)).toStrictEqual([0, 1]);
+      expect(data._frames.map((frame): number => frame.index)).toStrictEqual([0, 1]);
       expect(data._frameNames).toStrictEqual({ a: 0, b: 1 });
     });
 
-    it('does not register an empty name', () => {
+    it('does not register an empty name', (): void => {
       const data = new FrameData();
       data.addFrame(new Frame(0, 0, 0, 10, 10, ''));
       expect(data._frameNames).toStrictEqual({});
     });
   });
 
-  describe('getFrame', () => {
-    it('returns the frame at the index', () => {
+  describe('getFrame', (): void => {
+    it('returns the frame at the index', (): void => {
       const data = seed(['a', 'b', 'c']);
       expect(data.getFrame(1).name).toBe('b');
     });
 
-    it('falls back to the first frame when the index is out of range', () => {
+    it('falls back to the first frame when the index is out of range', (): void => {
       const data = seed(['a', 'b']);
       expect(data.getFrame(9).name).toBe('a');
     });
   });
 
-  describe('getFrameByName', () => {
-    it('finds a registered frame', () => {
+  describe('getFrameByName', (): void => {
+    it('finds a registered frame', (): void => {
       const data = seed(['a', 'b']);
       expect(data.getFrameByName('b')?.index).toBe(1);
     });
 
-    it('returns null for an unknown name', () => {
+    it('returns null for an unknown name', (): void => {
       const data = seed(['a']);
       expect(data.getFrameByName('missing')).toBeNull();
     });
 
-    it('returns null when the name maps to a frame that is gone', () => {
+    it('returns null when the name maps to a frame that is gone', (): void => {
       const data = seed(['a']);
       data._frames.length = 0;
       expect(data.getFrameByName('a')).toBeNull();
     });
   });
 
-  describe('checkFrameName', () => {
-    it('distinguishes known from unknown names', () => {
+  describe('checkFrameName', (): void => {
+    it('distinguishes known from unknown names', (): void => {
       const data = seed(['a']);
       expect(data.checkFrameName('a')).toBe(true);
       expect(data.checkFrameName('b')).toBe(false);
     });
   });
 
-  describe('getFrameRange', () => {
-    it('collects the inclusive range', () => {
+  describe('getFrameRange', (): void => {
+    it('collects the inclusive range', (): void => {
       const data = seed(['a', 'b', 'c', 'd']);
-      expect(data.getFrameRange(1, 2).map((frame) => frame.name)).toStrictEqual(['b', 'c']);
+      expect(data.getFrameRange(1, 2).map((frame): string => frame.name)).toStrictEqual(['b', 'c']);
     });
 
-    it('appends into a supplied output array', () => {
+    it('appends into a supplied output array', (): void => {
       const data = seed(['a', 'b']);
       const output = [data.getFrame(0)];
       expect(data.getFrameRange(1, 1, output)).toHaveLength(2);
     });
   });
 
-  describe('getFrameIndexes', () => {
-    it('maps numeric indexes through', () => {
+  describe('getFrameIndexes', (): void => {
+    it('maps numeric indexes through', (): void => {
       const data = seed(['a', 'b', 'c']);
       expect(data.getFrameIndexes([0, 2])).toStrictEqual([0, 2]);
     });
 
-    it('maps names when numeric indexing is off', () => {
+    it('maps names when numeric indexing is off', (): void => {
       const data = seed(['a', 'b', 'c']);
       expect(data.getFrameIndexes(['c', 'a'], false)).toStrictEqual([2, 0]);
     });
 
-    it('skips names that do not resolve', () => {
+    it('skips names that do not resolve', (): void => {
       const data = seed(['a']);
       expect(data.getFrameIndexes(['a', 'missing'], false)).toStrictEqual([0]);
     });
 
-    it('returns every index when given no frames', () => {
+    it('returns every index when given no frames', (): void => {
       const data = seed(['a', 'b', 'c']);
       expect(data.getFrameIndexes([])).toStrictEqual([0, 1, 2]);
     });