@vpmedia/phaser 1.123.0 → 1.124.0

package/src/phaser/core/loader.ts

@@ -83,6 +83,15 @@ export type LoaderFile = {
   ySpacing?: number;
 };
 
+/** The sprite the loader crops as a progress bar, with the rectangle it crops to. */
+export type PreloadSprite = {
+  sprite: Image;
+  direction: number;
+  width: number;
+  height: number;
+  rect: Rectangle;
+};
+
 export class Loader {
   public game!: Game;
   public cache!: Cache;
@@ -91,7 +100,7 @@ export class Loader {
   public isUseRetry!: boolean;
   public maxRetry!: number;
   public hasLoaded!: boolean;
-  public preloadSprite!: any;
+  public preloadSprite!: PreloadSprite | null;
   public crossOrigin!: boolean | string;
   public baseURL!: string;
   public path!: string;
@@ -162,10 +171,8 @@ export class Loader {
       direction,
       width: sprite.width,
       height: sprite.height,
-      rect: null,
+      rect: direction === 0 ? new Rectangle(0, 0, 1, sprite.height) : new Rectangle(0, 0, sprite.width, 1),
     };
-    this.preloadSprite.rect =
-      direction === 0 ? new Rectangle(0, 0, 1, sprite.height) : new Rectangle(0, 0, sprite.width, 1);
     sprite.crop(this.preloadSprite.rect);
     sprite.visible = true;
   }
@@ -217,7 +224,7 @@ export class Loader {
    * @param {string} key - The key of the file to get.
    * @returns {{index: number, file: object} | null} The file and its index, or null if not found.
    */
-  public getAsset(type: string, key: string) {
+  public getAsset(type: string, key: string): { index: number; file: LoaderFile } | null {
     const fileIndex = this.getAssetIndex(type, key);
     if (fileIndex > -1) {
       return { index: fileIndex, file: this._fileList[fileIndex]! };
@@ -525,10 +532,10 @@ export class Loader {
       this.addToFileList('bitmapfont', key, textureURL, { atlasURL, xSpacing, ySpacing });
     } else if (typeof atlasData === 'string') {
       //  A stringified xml/json atlas has been given
-      let json = null;
-      let xml = null;
+      let json: unknown = null;
+      let xml: XMLDocument | null = null;
       try {
-        json = JSON.parse(atlasData);
+        json = JSON.parse(atlasData) as unknown;
       } catch {
         xml = this.parseXml(atlasData);
       }
@@ -1115,7 +1122,7 @@ export class Loader {
     switch (file.type) {
       case 'packfile': {
         // Pack data must never be false-ish after it is fetched without error
-        file.data = JSON.parse(response.responseText) ?? {};
+        file.data = (JSON.parse(response.responseText) ?? {}) as LoaderFileData;
         break;
       }
       case 'image': {
@@ -1167,10 +1174,10 @@ export class Loader {
             this.transformUrl(file.atlasURL, file),
             'text',
             (bitmapFontFile: LoaderFile, bitmapFontXhr: XMLHttpRequest): void => {
-              let json;
+              let json: unknown;
               try {
                 // Try to parse as JSON, if it fails, then it's hopefully XML
-                json = JSON.parse(bitmapFontXhr.responseText);
+                json = JSON.parse(bitmapFontXhr.responseText) as unknown;
               } catch {
                 // pass
               }
@@ -1217,7 +1224,7 @@ export class Loader {
    * @param {XMLHttpRequest} xhr - The XMLHttpRequest object containing the file data.
    */
   public jsonLoadComplete(file: LoaderFile, xhr: XMLHttpRequest): void {
-    const data = JSON.parse(xhr.responseText);
+    const data = JSON.parse(xhr.responseText) as unknown;
     const url = typeof file.url === 'string' ? file.url : '';
     if (file.type === 'bitmapfont') {
       this.cache.addBitmapFont(
@@ -1254,7 +1261,8 @@ export class Loader {
     const data = xhr.responseText;
     const xml = this.parseXml(data);
     if (!xml) {
-      const responseType = xhr.responseType || (xhr as any).contentType; // contentType for MS-XDomainRequest
+      // contentType is the MS-XDomainRequest name for the same thing
+      const responseType = xhr.responseType || (xhr as unknown as { contentType?: string }).contentType;
       this.game.logger.warn(`${file.key}: invalid XML (${responseType})`);
       this.asyncComplete(file, 'invalid XML');
       return;
@@ -1283,22 +1291,14 @@ export class Loader {
    * @param {object} data - The XML string data to parse.
    * @returns {Document} The parsed DOM Document, or null if parsing failed.
    */
-  public parseXml(data: string) {
-    let xml = null;
+  public parseXml(data: string): XMLDocument | null {
+    let xml: XMLDocument | null = null;
     try {
-      if (globalThis.DOMParser) {
-        const domparser = new DOMParser();
-        xml = domparser.parseFromString(data, 'text/xml');
-      } else {
-        xml = new globalThis.ActiveXObject('Microsoft.XMLDOM');
-        // Why is this 'false'?
-        xml.async = 'false';
-        xml.loadXML(data);
-      }
+      xml = new DOMParser().parseFromString(data, 'text/xml');
     } catch {
       xml = null;
     }
-    if (!xml || !xml.documentElement || xml.querySelectorAll('parsererror').length > 0) {
+    if (!xml?.documentElement || xml.querySelectorAll('parsererror').length > 0) {
       return null;
     }
     return xml;

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

@@ -33,64 +33,64 @@ const FONT_JSON = {
   },
 };
 
-describe('bitmap font parsing', () => {
-  describe('xmlBitmapFont', () => {
-    it('reads the font metrics', () => {
+describe('bitmap font parsing', (): void => {
+  describe('xmlBitmapFont', (): void => {
+    it('reads the font metrics', (): void => {
       const data = xmlBitmapFont(parseXml(FONT_XML), baseTexture, 0, 0);
       expect(data.font).toBe('Arial');
       expect(data.size).toBe(32);
       expect(data.lineHeight).toBe(40);
     });
 
-    it('reads every glyph, keyed by character code', () => {
+    it('reads every glyph, keyed by character code', (): void => {
       const data = xmlBitmapFont(parseXml(FONT_XML), baseTexture, 0, 0);
       expect(Object.keys(data.chars)).toStrictEqual(['65', '66']);
       expect(data.chars[65]).toMatchObject({ x: 0, y: 0, width: 20, height: 30, xOffset: 1, yOffset: 2 });
     });
 
-    it('adds the spacing arguments to advance and line height', () => {
+    it('adds the spacing arguments to advance and line height', (): void => {
       const data = xmlBitmapFont(parseXml(FONT_XML), baseTexture, 5, 7);
       expect(data.chars[65]?.xAdvance).toBe(26);
       expect(data.lineHeight).toBe(47);
     });
 
-    it('records kerning against the second character of the pair', () => {
+    it('records kerning against the second character of the pair', (): void => {
       const data = xmlBitmapFont(parseXml(FONT_XML), baseTexture, 0, 0);
       expect(data.chars[66]?.kerning[65]).toBe(-3);
     });
 
-    it('attaches a texture to every glyph', () => {
+    it('attaches a texture to every glyph', (): void => {
       const data = xmlBitmapFont(parseXml(FONT_XML), baseTexture, 0, 0);
       expect(data.chars[65]?.texture).toBeDefined();
       expect(data.chars[66]?.texture).toBeDefined();
     });
 
-    it('survives a font with no kerning table', () => {
+    it('survives a font with no kerning table', (): void => {
       const markup = FONT_XML.replace(/<kernings>[\s\S]*<\/kernings>/, '');
       expect(() => xmlBitmapFont(parseXml(markup), baseTexture, 0, 0)).not.toThrow();
     });
 
-    it('ignores kerning that names a character the font does not have', () => {
+    it('ignores kerning that names a character the font does not have', (): void => {
       const markup = FONT_XML.replace('second="66"', 'second="999"');
       const data = xmlBitmapFont(parseXml(markup), baseTexture, 0, 0);
       expect(data.chars[66]?.kerning).toStrictEqual({});
     });
 
-    it('falls back to an empty face when the info element is missing', () => {
+    it('falls back to an empty face when the info element is missing', (): void => {
       const markup = FONT_XML.replace(/<info[^>]*\/>/, '');
       expect(xmlBitmapFont(parseXml(markup), baseTexture, 0, 0).font).toBe('');
     });
   });
 
-  describe('jsonBitmapFont', () => {
-    it('reads the same metrics as the xml form', () => {
+  describe('jsonBitmapFont', (): void => {
+    it('reads the same metrics as the xml form', (): void => {
       const data = jsonBitmapFont(FONT_JSON, baseTexture, 0, 0);
       expect(data.font).toBe('Arial');
       expect(data.size).toBe(32);
       expect(data.lineHeight).toBe(40);
     });
 
-    it('produces the same glyphs as the xml form', () => {
+    it('produces the same glyphs as the xml form', (): void => {
       const fromJson = jsonBitmapFont(FONT_JSON, baseTexture, 0, 0);
       const fromXml = xmlBitmapFont(parseXml(FONT_XML), baseTexture, 0, 0);
       for (const code of [65, 66]) {
@@ -102,13 +102,13 @@ describe('bitmap font parsing', () => {
       }
     });
 
-    it('records the same kerning as the xml form', () => {
+    it('records the same kerning as the xml form', (): void => {
       expect(jsonBitmapFont(FONT_JSON, baseTexture, 0, 0).chars[66]?.kerning[65]).toBe(-3);
     });
   });
 
-  describe('bitmapFont', () => {
-    it('parses the xml form', () => {
+  describe('bitmapFont', (): void => {
+    it('parses the xml form', (): void => {
       expect(bitmapFont(parseXml(FONT_XML), baseTexture, 0, 0).font).toBe('Arial');
     });
   });

package/src/phaser/core/loader_parser.ts

@@ -16,6 +16,16 @@ export type BitmapFontChar = {
 };
 
 /** A parsed bitmap font: its metrics and the glyphs it can draw. */
+/** A bitmap font descriptor in the JSON form the packers emit, with attributes prefixed by `_`. */
+export type JsonBitmapFontDescriptor = {
+  font: {
+    info: Record<string, string>;
+    common: Record<string, string>;
+    chars: { char: Record<string, string>[] };
+    kernings?: { kerning?: Record<string, string>[] };
+  };
+};
+
 export type BitmapFontData = {
   font: string;
   size: number;
@@ -104,18 +114,18 @@ export const bitmapFont = (
  * @returns {object} The parsed bitmap font data.
  */
 export const jsonBitmapFont = (
-  json: any,
+  json: JsonBitmapFontDescriptor,
   baseTexture: BaseTexture,
   xSpacing: number,
   ySpacing: number
 ): BitmapFontData => {
   const data: BitmapFontData = {
-    font: json.font.info._face,
-    size: Math.trunc(Number(json.font.info._size)),
-    lineHeight: Math.trunc(Number(json.font.common._lineHeight)) + ySpacing,
+    font: json.font.info['_face'] ?? '',
+    size: Math.trunc(Number(json.font.info['_size'])),
+    lineHeight: Math.trunc(Number(json.font.common['_lineHeight'])) + ySpacing,
     chars: {},
   };
-  for (const letter of json.font.chars.char as Record<string, string>[]) {
+  for (const letter of json.font.chars.char) {
     const charCode = Math.trunc(Number(letter['_id']));
     data.chars[charCode] = {
       x: Math.trunc(Number(letter['_x'])),
@@ -129,7 +139,7 @@ export const jsonBitmapFont = (
     };
   }
   if (json.font.kernings && json.font.kernings.kerning) {
-    for (const kerning of json.font.kernings.kerning as Record<string, string>[]) {
+    for (const kerning of json.font.kernings.kerning) {
       const char = data.chars[Math.trunc(Number(kerning['_second']))];
       if (char) {
         char.kerning[Math.trunc(Number(kerning['_first']))] = Math.trunc(Number(kerning['_amount']));

package/src/phaser/core/raf.ts

@@ -1,6 +1,6 @@
 import type { Game } from './game.js';
 export class RequestAnimationFrame {
-  public game: any;
+  public game: Game;
   public rafId: number;
 
   /**

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

@@ -1,28 +1,28 @@
 import { beforeEach, describe, expect, it } from 'vitest';
 import { getRegistry } from './registry.js';
 
-describe('getRegistry', () => {
-  beforeEach(() => {
+describe('getRegistry', (): void => {
+  beforeEach((): void => {
     // @ts-expect-error the registry is created on demand, so tests may clear it
     delete globalThis.PhaserRegistry;
   });
 
-  it('creates the registry on first access', () => {
+  it('creates the registry on first access', (): void => {
     expect(globalThis.PhaserRegistry).toBeUndefined();
     expect(getRegistry()).toBeDefined();
     expect(globalThis.PhaserRegistry).toBeDefined();
   });
 
-  it('returns the same object on repeat access', () => {
+  it('returns the same object on repeat access', (): void => {
     expect(getRegistry()).toBe(getRegistry());
   });
 
-  it('preserves members written by subsystems', () => {
+  it('preserves members written by subsystems', (): void => {
     getRegistry().GL_CONTEXT_ID = 7;
     expect(getRegistry().GL_CONTEXT_ID).toBe(7);
   });
 
-  it('does not clobber a registry that already exists', () => {
+  it('does not clobber a registry that already exists', (): void => {
     const existing = getRegistry();
     existing.stencilBufferLimit = 3;
     expect(getRegistry()).toBe(existing);

package/src/phaser/core/scale_manager.ts

@@ -968,7 +968,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public set scaleMode(value) {
+  public set scaleMode(value: number) {
     if (value !== this._scaleMode) {
       if (!this.isFullScreen) {
         this.updateDimensions(this._gameSize.width, this._gameSize.height, true);
@@ -990,7 +990,7 @@ export class ScaleManager {
   /**
    * TBD.
    */
-  public set fullScreenScaleMode(value) {
+  public set fullScreenScaleMode(value: number) {
     if (value !== this._fullScreenScaleMode) {
       // If in fullscreen then need a wee bit more work
       if (this.isFullScreen) {

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

@@ -20,74 +20,74 @@ const createGame = (isBooted = true): Game =>
 const createManager = (pendingState: ConstructorParameters<typeof SceneManager>[1] = null): SceneManager =>
   new SceneManager(createGame(), pendingState);
 
-describe('SceneManager', () => {
-  describe('add', () => {
-    it('takes a plain hook object and links the game onto it', () => {
+describe('SceneManager', (): void => {
+  describe('add', (): void => {
+    it('takes a plain hook object and links the game onto it', (): void => {
       const manager = createManager();
       const state: SceneState = { create: vi.fn<() => void>() };
       expect(manager.add('menu', state)).toBe(state);
       expect(state.game).toBeDefined();
     });
 
-    it('builds a state from a constructor', () => {
+    it('builds a state from a constructor', (): void => {
       const manager = createManager();
       class Menu extends Scene {}
       expect(manager.add('menu', Menu)).toBeInstanceOf(Menu);
     });
 
-    it('takes a scene instance as-is', () => {
+    it('takes a scene instance as-is', (): void => {
       const manager = createManager();
       const scene = new Scene();
       expect(manager.add('menu', scene)).toBe(scene);
     });
 
-    it('queues the state when the game has not booted', () => {
+    it('queues the state when the game has not booted', (): void => {
       const manager = new SceneManager(createGame(false), null);
       manager.add('menu', { create: vi.fn<() => void>() }, true);
       expect(manager._pendingState).toBe('menu');
     });
 
-    it('starts the state right away once the game has booted', () => {
+    it('starts the state right away once the game has booted', (): void => {
       const manager = createManager();
       manager.add('menu', { create: vi.fn<() => void>() }, true);
       expect(manager._pendingState).toBe('menu');
     });
   });
 
-  describe('boot', () => {
-    it('registers a state given as an object under the default key', () => {
+  describe('boot', (): void => {
+    it('registers a state given as an object under the default key', (): void => {
       const manager = createManager({ create: vi.fn<() => void>() });
       manager.boot();
       expect(manager.states['default']).toBeDefined();
     });
 
-    it('leaves a state given by key alone', () => {
+    it('leaves a state given by key alone', (): void => {
       const manager = createManager('menu');
       manager.boot();
       expect(manager.states['default']).toBeUndefined();
     });
   });
 
-  describe('checkState', () => {
-    it('accepts a state carrying any of the lifecycle hooks', () => {
+  describe('checkState', (): void => {
+    it('accepts a state carrying any of the lifecycle hooks', (): void => {
       const manager = createManager();
       manager.add('menu', { update: vi.fn<() => void>() });
       expect(manager.checkState('menu')).toBe(true);
     });
 
-    it('rejects a state with no hooks at all', () => {
+    it('rejects a state with no hooks at all', (): void => {
       const manager = createManager();
       manager.add('menu', {});
       expect(manager.checkState('menu')).toBe(false);
     });
 
-    it('rejects a key it does not hold', () => {
+    it('rejects a key it does not hold', (): void => {
       expect(createManager().checkState('nope')).toBe(false);
     });
   });
 
-  describe('setCurrentState', () => {
-    it('binds the hooks the state provides and leaves the rest null', () => {
+  describe('setCurrentState', (): void => {
+    it('binds the hooks the state provides and leaves the rest null', (): void => {
       const manager = createManager();
       const create = vi.fn<() => void>();
       manager.add('menu', { create });
@@ -98,7 +98,7 @@ describe('SceneManager', () => {
       expect(manager.onPreloadCallback).toBeNull();
     });
 
-    it('falls back to a no-op for init and shutdown', () => {
+    it('falls back to a no-op for init and shutdown', (): void => {
       const manager = createManager();
       manager.add('menu', {});
       manager.setCurrentState('menu');
@@ -106,7 +106,7 @@ describe('SceneManager', () => {
       expect(manager.onShutDownCallback).toBe(manager.dummy);
     });
 
-    it('calls init with the arguments start was given', () => {
+    it('calls init with the arguments start was given', (): void => {
       const manager = createManager();
       const init = vi.fn<() => void>();
       manager.add('menu', { init, update: vi.fn<() => void>() });
@@ -115,7 +115,7 @@ describe('SceneManager', () => {
       expect(init).toHaveBeenCalledWith('a', 1);
     });
 
-    it('stamps the key onto the state', () => {
+    it('stamps the key onto the state', (): void => {
       const manager = createManager();
       const state: SceneState = { create: vi.fn<() => void>() };
       manager.add('menu', state);
@@ -124,8 +124,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('start', () => {
-    it('ignores a key with no lifecycle hooks', () => {
+  describe('start', (): void => {
+    it('ignores a key with no lifecycle hooks', (): void => {
       const manager = createManager();
       manager.add('menu', {});
       manager.start('menu');
@@ -133,8 +133,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('update', () => {
-    it('runs the update hook only once the scene has been created', () => {
+  describe('update', (): void => {
+    it('runs the update hook only once the scene has been created', (): void => {
       const manager = createManager();
       const update = vi.fn<() => void>();
       manager.add('menu', { update });
@@ -146,7 +146,7 @@ describe('SceneManager', () => {
       expect(update).toHaveBeenCalledTimes(1);
     });
 
-    it('runs the create hook exactly once', () => {
+    it('runs the create hook exactly once', (): void => {
       const manager = createManager();
       const create = vi.fn<() => void>();
       manager.add('menu', { create });
@@ -157,8 +157,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('resize', () => {
-    it('passes the new size to the scene', () => {
+  describe('resize', (): void => {
+    it('passes the new size to the scene', (): void => {
       const manager = createManager();
       const resize = vi.fn<(width: number, height: number) => void>();
       manager.add('menu', { resize });
@@ -168,8 +168,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('remove', () => {
-    it('drops the state and unbinds its hooks when it is current', () => {
+  describe('remove', (): void => {
+    it('drops the state and unbinds its hooks when it is current', (): void => {
       const manager = createManager();
       manager.add('menu', { create: vi.fn<() => void>() });
       manager.setCurrentState('menu');
@@ -179,8 +179,8 @@ describe('SceneManager', () => {
     });
   });
 
-  describe('destroy', () => {
-    it('empties the manager', () => {
+  describe('destroy', (): void => {
+    it('empties the manager', (): void => {
       const manager = createManager();
       manager.add('menu', { create: vi.fn<() => void>(), shutdown: vi.fn<() => void>() });
       manager.setCurrentState('menu');

package/src/phaser/core/scene_manager.ts

@@ -359,7 +359,7 @@ export class SceneManager {
    * Get whether the scene has been created.
    * @returns {boolean} True if the scene has been created, false otherwise.
    */
-  public get created() {
+  public get created(): boolean {
     return this._created;
   }
 }

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

@@ -1,14 +1,14 @@
 import { expect, describe, it } from 'vitest';
 import { Signal } from './signal.js';
 
-describe('Signal', () => {
-  describe('core', () => {
-    it('adds, dispatches to and removes listeners', () => {
+describe('Signal', (): void => {
+  describe('core', (): void => {
+    it('adds, dispatches to and removes listeners', (): void => {
       const signal = new Signal();
-      const listener = (arg: number) => {
+      const listener = (arg: number): void => {
         expect(arg).toBe(1);
       };
-      const listenerOnce = (arg: number) => {
+      const listenerOnce = (arg: number): void => {
         expect(arg).toBe(1);
       };
       signal.add(listener);
@@ -20,14 +20,14 @@ describe('Signal', () => {
       signal.remove(listener);
       expect(signal.has(listener)).toBe(false);
       expect(signal.getNumListeners()).toBe(0);
-      expect(signal.has(() => null)).toBe(false);
+      expect(signal.has((): null => null)).toBe(false);
     });
 
-    it('async', async () => {
+    it('async', async (): Promise<void> => {
       const signal = new Signal();
       const promise = signal.toPromise();
       expect(signal.getNumListeners()).toBe(1);
-      setTimeout(() => {
+      setTimeout((): void => {
         signal.dispatch(1);
       }, 10);
       const result = await promise;

package/src/phaser/core/signal.ts

@@ -275,7 +275,7 @@ export class Signal {
    * Get a bound version of the dispatch function.
    * @returns {Function} A function that will dispatch the signal with the correct context.
    */
-  public get boundDispatch() {
+  public get boundDispatch(): (...args: unknown[]) => void {
     this._boundDispatch ??= (...rest: unknown[]): void => {
       this.dispatch(...rest);
     };