@vpmedia/phaser 1.123.0 → 1.125.0

package/src/phaser/core/animation_parser.ts

@@ -1,6 +1,18 @@
 import { Frame } from './frame.js';
+
+/** One frame in a texture atlas, in the shape the packers emit. */
+export type AtlasFrame = {
+  frame: { x: number; y: number; w: number; h: number };
+  trimmed?: boolean;
+  sourceSize?: { w: number; h: number };
+  spriteSourceSize?: { x: number; y: number; w: number; h: number };
+};
+
+/** A texture atlas descriptor, keyed by frame name. */
+export type AtlasJson = { frames: Record<string, AtlasFrame> };
 import { FrameData } from './frame_data.js';
 import type { Game } from './game.js';
+import type { TextureSource } from '../display/webgl/base_texture.js';
 
 /**
  * TBD.
@@ -15,38 +27,31 @@ import type { Game } from './game.js';
  */
 export const spriteSheet = (
   game: Game,
-  key: any,
+  key: string | TextureSource,
   frameWidth: number,
   frameHeight: number,
   frameMax: number,
   margin: number,
   spacing: number
 ): FrameData | null => {
-  let img: any = key;
-  if (typeof key === 'string') {
-    img = game.cache.getImage(key);
-  }
+  const img = typeof key === 'string' ? game.cache.getImage(key) : key;
   if (img === null) {
     return null;
   }
   const { width } = img;
   const { height } = img;
-  if (frameWidth <= 0) {
-    frameWidth = Math.floor(-width / Math.min(-1, frameWidth));
-  }
-  if (frameHeight <= 0) {
-    frameHeight = Math.floor(-height / Math.min(-1, frameHeight));
-  }
-  const row = Math.floor((width - margin) / (frameWidth + spacing));
-  const column = Math.floor((height - margin) / (frameHeight + spacing));
+  const cellWidth = frameWidth <= 0 ? Math.floor(-width / Math.min(-1, frameWidth)) : frameWidth;
+  const cellHeight = frameHeight <= 0 ? Math.floor(-height / Math.min(-1, frameHeight)) : frameHeight;
+  const row = Math.floor((width - margin) / (cellWidth + spacing));
+  const column = Math.floor((height - margin) / (cellHeight + spacing));
   let total = row * column;
   if (frameMax !== -1) {
     total = frameMax;
   }
   //  Zero or smaller than frame sizes?
-  if (width === 0 || height === 0 || width < frameWidth || height < frameHeight || total === 0) {
+  if (width === 0 || height === 0 || width < cellWidth || height < cellHeight || total === 0) {
     game.logger.warn(
-      `AnimationParser.spriteSheet: '${key}'s width/height zero or width/height < given frameWidth/frameHeight`
+      `AnimationParser.spriteSheet: '${typeof key === 'string' ? key : 'image'}'s width/height zero or width/height < given cellWidth/cellHeight`
     );
     return null;
   }
@@ -55,11 +60,11 @@ export const spriteSheet = (
   let x = margin;
   let y = margin;
   for (let i = 0; i < total; i += 1) {
-    data.addFrame(new Frame(i, x, y, frameWidth, frameHeight, ''));
-    x += frameWidth + spacing;
-    if (x + frameWidth > width) {
+    data.addFrame(new Frame(i, x, y, cellWidth, cellHeight, ''));
+    x += cellWidth + spacing;
+    if (x + cellWidth > width) {
       x = margin;
-      y += frameHeight + spacing;
+      y += cellHeight + spacing;
     }
   }
   return data;
@@ -71,31 +76,28 @@ export const spriteSheet = (
  * @param {object} json - TBD.
  * @returns {FrameData} TBD.
  */
-export const jsonDataHash = (game: Game, json: any, _key?: any): FrameData | null => {
-  if (!json.frames) {
-    game.logger.warn('jsonDataHash: Invalid Texture Atlas JSON given, missing frames object', json);
+export const jsonDataHash = (game: Game, json: unknown, _key?: string): FrameData | null => {
+  const atlas = json as AtlasJson | null;
+  if (!atlas?.frames) {
+    game.logger.warn('jsonDataHash: Invalid Texture Atlas JSON given, missing frames object');
     return null;
   }
   // Let's create some frames then
   const data = new FrameData();
   // By this stage frames is a fully parsed array
-  const { frames } = json;
-  let newFrame;
+  const { frames } = atlas;
   let i = 0;
-  const keys = Object.keys(frames);
-  for (const key of keys) {
-    newFrame = data.addFrame(
-      new Frame(i, frames[key].frame.x, frames[key].frame.y, frames[key].frame.w, frames[key].frame.h, key)
-    );
-    if (frames[key].trimmed) {
+  for (const [key, entry] of Object.entries(frames)) {
+    const newFrame = data.addFrame(new Frame(i, entry.frame.x, entry.frame.y, entry.frame.w, entry.frame.h, key));
+    if (entry.trimmed === true && entry.sourceSize !== undefined && entry.spriteSourceSize !== undefined) {
       newFrame.setTrim(
-        frames[key].trimmed,
-        frames[key].sourceSize.w,
-        frames[key].sourceSize.h,
-        frames[key].spriteSourceSize.x,
-        frames[key].spriteSourceSize.y,
-        frames[key].spriteSourceSize.w,
-        frames[key].spriteSourceSize.h
+        entry.trimmed,
+        entry.sourceSize.w,
+        entry.sourceSize.h,
+        entry.spriteSourceSize.x,
+        entry.spriteSourceSize.y,
+        entry.spriteSourceSize.w,
+        entry.spriteSourceSize.h
       );
     }
     i += 1;

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;
+      if (item !== undefined) {
+        (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 !== undefined) {
+        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;
@@ -381,7 +381,7 @@ export class Cache {
    */
   public checkURL(url: string): boolean {
     const resolved = this._resolveURL(url);
-    if (resolved && this._urlMap?.[resolved]) {
+    if (resolved !== null && this._urlMap?.[resolved] !== undefined) {
       return true;
     }
     return false;
@@ -481,7 +481,7 @@ export class Cache {
   public getItem(key: string, cache: number, _method: string, property: string | null = null): unknown {
     if (this.checkKey(cache, key)) {
       const entry = this._cacheMap[cache]![key]!;
-      if (!property) {
+      if (property === null) {
         return entry;
       }
       return (entry as Record<string, unknown>)[property];
@@ -703,9 +703,9 @@ 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) {
+    if (resolvedURL !== null) {
       return this._urlMap?.[resolvedURL] ?? null;
     }
     this.game.logger.warn('Cache invalid url', { resolvedURL });
@@ -864,7 +864,7 @@ export class Cache {
    */
   public destroy(): void {
     for (const cache of this._cacheMap) {
-      const keys = cache ? Object.keys(cache) : [];
+      const keys = Object.keys(cache);
       for (const key of keys) {
         if (key !== '__default' && key !== '__missing') {
           (cache[key] as { destroy?: () => void }).destroy?.();

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/device_util.ts

@@ -96,7 +96,7 @@ export const checkFullScreenSupport = (device: Device): void => {
   const element = document.createElement('div');
   const elementApi = element as unknown as Record<string, unknown>;
   for (const name of fs) {
-    if (elementApi[name]) {
+    if (elementApi[name] !== undefined) {
       device.fullscreen = true;
       device.requestFullscreen = name;
       break;
@@ -105,13 +105,13 @@ export const checkFullScreenSupport = (device: Device): void => {
   if (device.fullscreen) {
     const documentApi = document as unknown as Record<string, unknown>;
     for (const name of cfs) {
-      if (documentApi[name]) {
+      if (documentApi[name] !== undefined) {
         device.cancelFullscreen = name;
         break;
       }
     }
     // ALLOW_KEYBOARD_INPUT is a legacy webkit fullscreen flag, absent from lib.dom
-    if (globalThis.Element && (Element as unknown as { ALLOW_KEYBOARD_INPUT?: number }).ALLOW_KEYBOARD_INPUT) {
+    if ((Element as unknown as { ALLOW_KEYBOARD_INPUT?: number }).ALLOW_KEYBOARD_INPUT !== undefined) {
       device.fullscreenKeyboard = true;
     }
   }
@@ -190,7 +190,7 @@ export const checkAudio = (device: Device): void => {
   for (const format of formats) {
     const { type, codecs } = format;
     for (const codec of codecs) {
-      if (!device.supportedAudioFormats[type]) {
+      if (device.supportedAudioFormats[type] !== true) {
         const isSupported = isMediaSourceTypeSupported(codec) || canPlayType(audioElement, codec);
         if (isSupported) {
           device.supportedAudioFormats[type] = isSupported;