@vpmedia/phaser 1.113.0 → 1.115.0

package/src/phaser/core/input_touch.ts

@@ -1,8 +1,9 @@
 import type { Game } from './game.js';
+import type { InputEvent } from './input_event.js';
 export class Touch {
-  public game!: any;
+  public game!: Game;
   public enabled!: any;
-  public callbackContext!: any;
+  public callbackContext!: unknown;
   public touchStartCallback!: any;
   public touchMoveCallback!: any;
   public touchEndCallback!: any;
@@ -10,14 +11,14 @@ export class Touch {
   public touchLeaveCallback!: any;
   public touchCancelCallback!: any;
   public preventDefault!: any;
-  public event!: any;
-  public _onTouchStart: ((event: TouchEvent) => void) | null;
-  public _onTouchMove: ((event: TouchEvent) => void) | null;
-  public _onTouchEnd: ((event: TouchEvent) => void) | null;
-  public _onTouchEnter: ((event: TouchEvent) => void) | null;
-  public _onTouchLeave: ((event: TouchEvent) => void) | null;
-  public _onTouchCancel: ((event: TouchEvent) => void) | null;
-  public _documentTouchMove!: (event: TouchEvent) => void;
+  public event!: InputEvent | null;
+  public _onTouchStart: EventListener | null;
+  public _onTouchMove: EventListener | null;
+  public _onTouchEnd: EventListener | null;
+  public _onTouchEnter: EventListener | null;
+  public _onTouchLeave: EventListener | null;
+  public _onTouchCancel: EventListener | null;
+  public _documentTouchMove!: EventListener;
   /**
    * TBD.
    * @param {Game} game - TBD.
@@ -84,12 +85,24 @@ export class Touch {
     if (!this.game.device.touch) {
       return;
     }
-    this.game.canvas.removeEventListener('touchstart', this._onTouchStart);
-    this.game.canvas.removeEventListener('touchmove', this._onTouchMove);
-    this.game.canvas.removeEventListener('touchend', this._onTouchEnd);
-    this.game.canvas.removeEventListener('touchenter', this._onTouchEnter);
-    this.game.canvas.removeEventListener('touchleave', this._onTouchLeave);
-    this.game.canvas.removeEventListener('touchcancel', this._onTouchCancel);
+    if (this._onTouchStart) {
+      this.game.canvas.removeEventListener('touchstart', this._onTouchStart);
+    }
+    if (this._onTouchMove) {
+      this.game.canvas.removeEventListener('touchmove', this._onTouchMove);
+    }
+    if (this._onTouchEnd) {
+      this.game.canvas.removeEventListener('touchend', this._onTouchEnd);
+    }
+    if (this._onTouchEnter) {
+      this.game.canvas.removeEventListener('touchenter', this._onTouchEnter);
+    }
+    if (this._onTouchLeave) {
+      this.game.canvas.removeEventListener('touchleave', this._onTouchLeave);
+    }
+    if (this._onTouchCancel) {
+      this.game.canvas.removeEventListener('touchcancel', this._onTouchCancel);
+    }
   }
 
   /**
@@ -106,7 +119,7 @@ export class Touch {
    * TBD.
    * @param {TouchEvent} event - TBD.
    */
-  public onTouchStart(event: any) {
+  public onTouchStart(event: InputEvent) {
     this.event = event;
     if (!this.game.input.enabled || !this.enabled) {
       return;
@@ -118,8 +131,9 @@ export class Touch {
     // event.targetTouches = list of all touches on the TARGET ELEMENT (i.e. game dom element)
     // event.touches = list of all touches on the ENTIRE DOCUMENT, not just the target element
     // event.changedTouches = the touches that CHANGED in this event, not the total number of them
-    for (let i = 0; i < event.changedTouches.length; i += 1) {
-      this.game.input.startPointer(event.changedTouches[i]);
+    const changed = event.changedTouches ?? [];
+    for (let i = 0; i < changed.length; i += 1) {
+      this.game.input.startPointer(changed[i]!);
     }
   }
 
@@ -127,7 +141,7 @@ export class Touch {
    * TBD.
    * @param {TouchEvent} event - TBD.
    */
-  public onTouchCancel(event: any) {
+  public onTouchCancel(event: InputEvent) {
     this.event = event;
     if (this.touchCancelCallback) {
       this.touchCancelCallback.call(this.callbackContext, event);
@@ -138,8 +152,9 @@ export class Touch {
     this.eventPreventDefault(event);
     // Touch cancel - touches that were disrupted (perhaps by moving into a plugin or browser chrome)
     // http://www.w3.org/TR/touch-events/#dfn-touchcancel
-    for (let i = 0; i < event.changedTouches.length; i += 1) {
-      this.game.input.stopPointer(event.changedTouches[i]);
+    const changed = event.changedTouches ?? [];
+    for (let i = 0; i < changed.length; i += 1) {
+      this.game.input.stopPointer(changed[i]!);
     }
   }
 
@@ -147,7 +162,7 @@ export class Touch {
    * TBD.
    * @param {TouchEvent} event - TBD.
    */
-  public onTouchEnter(event: any) {
+  public onTouchEnter(event: InputEvent) {
     this.event = event;
     if (this.touchEnterCallback) {
       this.touchEnterCallback.call(this.callbackContext, event);
@@ -162,7 +177,7 @@ export class Touch {
    * TBD.
    * @param {TouchEvent} event - TBD.
    */
-  public onTouchLeave(event: any) {
+  public onTouchLeave(event: InputEvent) {
     this.event = event;
     if (this.touchLeaveCallback) {
       this.touchLeaveCallback.call(this.callbackContext, event);
@@ -174,14 +189,15 @@ export class Touch {
    * TBD.
    * @param {TouchEvent} event - TBD.
    */
-  public onTouchMove(event: any) {
+  public onTouchMove(event: InputEvent) {
     this.event = event;
     if (this.touchMoveCallback) {
       this.touchMoveCallback.call(this.callbackContext, event);
     }
     this.eventPreventDefault(event);
-    for (let i = 0; i < event.changedTouches.length; i += 1) {
-      this.game.input.updatePointer(event.changedTouches[i]);
+    const changed = event.changedTouches ?? [];
+    for (let i = 0; i < changed.length; i += 1) {
+      this.game.input.updatePointer(changed[i]!);
     }
   }
 
@@ -189,7 +205,7 @@ export class Touch {
    * TBD.
    * @param {TouchEvent} event - TBD.
    */
-  public onTouchEnd(event: any) {
+  public onTouchEnd(event: InputEvent) {
     this.event = event;
     if (this.touchEndCallback) {
       this.touchEndCallback.call(this.callbackContext, event);
@@ -198,8 +214,9 @@ export class Touch {
     // For touch end its a list of the touch points that have been removed from the surface
     // https://developer.mozilla.org/en-US/docs/DOM/TouchList
     // event.changedTouches = the touches that CHANGED in this event, not the total number of them
-    for (let i = 0; i < event.changedTouches.length; i += 1) {
-      this.game.input.stopPointer(event.changedTouches[i]);
+    const changed = event.changedTouches ?? [];
+    for (let i = 0; i < changed.length; i += 1) {
+      this.game.input.stopPointer(changed[i]!);
     }
   }
 
@@ -207,7 +224,7 @@ export class Touch {
    * TBD.
    * @param {TouchEvent} event - TBD.
    */
-  public eventPreventDefault(event: any) {
+  public eventPreventDefault(event: InputEvent) {
     if (this.preventDefault) {
       if (typeof event.cancelable !== 'boolean' || event.cancelable) {
         event.preventDefault();

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

@@ -0,0 +1,139 @@
+import { describe, expect, it } from 'vitest';
+import type { Game } from './game.js';
+import { Loader } from './loader.js';
+
+const createGame = (formats: Record<string, boolean> = {}, noAudio = false): Game =>
+  ({
+    logger: { warn: () => undefined, info: () => undefined, debug: () => undefined },
+    config: { maxParallelDownloads: 4 },
+    cache: {},
+    sound: { noAudio },
+    device: { noAudioFormat: false, supportedAudioFormats: formats },
+  }) as unknown as Game;
+
+const createLoader = (formats: Record<string, boolean> = {}, noAudio = false): Loader =>
+  new Loader(createGame(formats, noAudio));
+
+describe('Loader', () => {
+  describe('getAudioURL', () => {
+    it('returns null when the device has no audio', () => {
+      expect(createLoader({}, true).getAudioURL(['track.ogg'])).toBeNull();
+    });
+
+    it('picks a plain url whose extension the device can play', () => {
+      expect(createLoader({ ogg: true }).getAudioURL(['track.ogg'])).toBe('track.ogg');
+    });
+
+    it('skips an extension the device cannot play', () => {
+      expect(createLoader({ ogg: false, mp3: true }).getAudioURL(['track.ogg', 'track.mp3'])).toBe('track.mp3');
+    });
+
+    it('returns null when no candidate is playable', () => {
+      expect(createLoader({ ogg: false, mp3: false }).getAudioURL(['track.ogg', 'track.mp3'])).toBeNull();
+    });
+
+    it('accepts a bare string as a single candidate', () => {
+      expect(createLoader({ mp3: true }).getAudioURL('track.mp3')).toBe('track.mp3');
+    });
+
+    it('reads the format from a uri and type pair', () => {
+      expect(createLoader({ ogg: true }).getAudioURL([{ uri: 'track-no-extension', type: 'ogg' }])).toBe(
+        'track-no-extension'
+      );
+    });
+
+    it('skips a pair whose type the device cannot play', () => {
+      const loader = createLoader({ ogg: false, mp3: true });
+      expect(
+        loader.getAudioURL([
+          { uri: 'a', type: 'ogg' },
+          { uri: 'b', type: 'mp3' },
+        ])
+      ).toBe('b');
+    });
+
+    it('takes a blob url without checking the format', () => {
+      expect(createLoader().getAudioURL(['blob:https://example.test/abc'])).toBe('blob:https://example.test/abc');
+    });
+
+    it('takes a data uri without checking the format', () => {
+      expect(createLoader().getAudioURL(['data:audio/mp3;base64,AAAA'])).toBe('data:audio/mp3;base64,AAAA');
+    });
+
+    it('ignores a query string when reading the extension', () => {
+      expect(createLoader({ mp3: true }).getAudioURL(['track.mp3?v=2'])).toBe('track.mp3?v=2');
+    });
+
+    it('returns null for an empty candidate list', () => {
+      expect(createLoader({ mp3: true }).getAudioURL([])).toBeNull();
+    });
+  });
+
+  describe('transformUrl', () => {
+    const file = { path: 'assets/' } as Parameters<Loader['transformUrl']>[1];
+
+    it('returns false for a missing url', () => {
+      expect(createLoader().transformUrl(null, file)).toBe(false);
+    });
+
+    it('returns false for an unresolved candidate list', () => {
+      expect(createLoader().transformUrl(['a.mp3'], file)).toBe(false);
+    });
+
+    it('passes an absolute url through', () => {
+      expect(createLoader().transformUrl('https://example.test/a.png', file)).toBe('https://example.test/a.png');
+    });
+
+    it('passes a protocol relative url through', () => {
+      expect(createLoader().transformUrl('//example.test/a.png', file)).toBe('//example.test/a.png');
+    });
+
+    it('passes a data uri through', () => {
+      expect(createLoader().transformUrl('data:image/png;base64,AAAA', file)).toBe('data:image/png;base64,AAAA');
+    });
+
+    it('prefixes a relative url with the base url and file path', () => {
+      const loader = createLoader();
+      loader.baseURL = 'https://cdn.test/';
+      expect(loader.transformUrl('a.png', file)).toBe('https://cdn.test/assets/a.png');
+    });
+  });
+
+  describe('addToFileList', () => {
+    it('records the core fields for a queued file', () => {
+      const loader = createLoader();
+      loader.image('logo', 'logo.png');
+      const asset = loader.getAsset('image', 'logo');
+      expect(asset?.file).toMatchObject({
+        type: 'image',
+        key: 'logo',
+        url: 'logo.png',
+        loaded: false,
+        loading: false,
+        error: false,
+      });
+    });
+
+    it('folds the per-type extras onto the file', () => {
+      const loader = createLoader();
+      loader.audio('theme', ['theme.mp3']);
+      expect(loader.getAsset('audio', 'theme')?.file).toMatchObject({
+        type: 'audio',
+        autoDecode: true,
+        url: ['theme.mp3'],
+      });
+    });
+
+    it('skips a file with no key', () => {
+      const loader = createLoader();
+      loader.image('', 'logo.png');
+      expect(loader.getAsset('image', '')).toBeNull();
+    });
+
+    it('derives the url from the key and extension when none is given', () => {
+      const loader = createLoader();
+      loader.image('logo');
+      expect(loader.getAsset('image', 'logo')?.file.url).toBe('logo.png');
+    });
+  });
+});