@vpmedia/phaser 1.94.0 → 1.95.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.95.0] - 2025-12-16
+
+### 💼 Other
+
+- *(deps)* Bump dependency versions
+- *(deps)* Bump dependency versions
+
+### ⚙️ Miscellaneous Tasks
+
+- Release
+- Improve type checking
+- *(release)* V1.95.0
 ## [1.94.0] - 2025-12-11
 
 ### ⚙️ Miscellaneous Tasks

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/phaser",
-  "version": "1.94.0",
+  "version": "1.95.0",
   "description": "@vpmedia/phaser is the modern ECMAScript port of the popular Phaser game engine v2.6.2",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",
@@ -29,17 +29,17 @@
   "devDependencies": {
     "@commitlint/cli": "^20.2.0",
     "@commitlint/config-conventional": "^20.2.0",
-    "@eslint/js": "^9.39.1",
-    "@types/node": "^24.10.1",
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^25.0.2",
     "@vitest/coverage-v8": "^4.0.15",
-    "eslint": "^9.39.1",
+    "eslint": "^9.39.2",
     "eslint-plugin-jsdoc": "^61.5.0",
     "eslint-plugin-oxlint": "^1.32.0",
     "eslint-plugin-unicorn": "^62.0.0",
     "globals": "^16.5.0",
     "jsdom": "^27.3.0",
     "oxlint": "^1.32.0",
-    "oxlint-tsgolint": "^0.8.4",
+    "oxlint-tsgolint": "^0.8.6",
     "prettier": "^3.7.4",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.49.0",

package/pnpm-workspace.yaml

@@ -1,4 +1,4 @@
 onlyBuiltDependencies:
   - esbuild
 trustPolicy: no-downgrade
-minimumReleaseAge: 4320
+minimumReleaseAge: 2880

package/src/phaser/core/animation.js

@@ -12,27 +12,45 @@ export class Animation {
    * @param {boolean} loop - TBD.
    */
   constructor(game, parent, name, frameData, frames, frameRate, loop = false) {
+    /** @type {import('./game.js').Game} */
     this.game = game;
     this._parent = parent;
+    /** @type {import('./frame_data.js').FrameData} */
     this._frameData = frameData;
+    /** @type {string} */
     this.name = name;
     this._frames = [];
     this._frames = this._frames.concat(frames);
+    /** @type {number} */
     this.delay = 1000 / frameRate;
+    /** @type {boolean} */
     this.loop = loop;
+    /** @type {number} */
     this.loopCount = 0;
+    /** @type {boolean} */
     this.isFinished = false;
+    /** @type {boolean} */
     this.isPlaying = false;
+    /** @type {boolean} */
     this.isPaused = false;
+    /** @type {number} */
     this._pauseStartTime = 0;
+    /** @type {number} */
     this._frameIndex = 0;
+    /** @type {number} */
     this._frameDiff = 0;
+    /** @type {number} */
     this._frameSkip = 1;
     this.currentFrame = this._frameData.getFrame(this._frames[this._frameIndex]);
+    /** @type {Signal} */
     this.onStart = new Signal();
+    /** @type {Signal} */
     this.onUpdate = null;
+    /** @type {Signal} */
     this.onComplete = new Signal();
+    /** @type {Signal} */
     this.onLoop = new Signal();
+    /** @type {boolean} */
     this.isReversed = false;
     //  Set-up some event listeners
     this.game.onPause.add(this.onPause, this);

package/src/phaser/core/animation_parser.js

@@ -10,7 +10,7 @@ import { FrameData } from './frame_data.js';
  * @param {number} frameMax - TBD.
  * @param {number} margin - TBD.
  * @param {number} spacing - TBD.
- * @returns {object} TBD.
+ * @returns {FrameData} TBD.
  */
 export const spriteSheet = (game, key, frameWidth, frameHeight, frameMax, margin, spacing) => {
   let img = key;
@@ -60,7 +60,7 @@ export const spriteSheet = (game, key, frameWidth, frameHeight, frameMax, margin
  * TBD.
  * @param {import('./game.js').Game} game - TBD.
  * @param {object} json - TBD.
- * @returns {object} TBD.
+ * @returns {FrameData} TBD.
  */
 export const JSONDataHash = (game, json) => {
   if (!json.frames) {

package/src/phaser/core/dom.js

@@ -234,7 +234,7 @@ export class DOM {
    * TBD.
    * @param {DOMRect} coords - TBD.
    * @param {number} cushion - TBD.
-   * @returns {object} TBD.
+   * @returns {{width: number, height: number, left: number, right: number, top: number, bottom: number}} TBD.
    */
   calibrate(coords, cushion = 0) {
     const output = {

package/src/phaser/core/game.js

@@ -53,7 +53,7 @@ export class Game {
     this.logger = null;
     /** @type {HTMLCanvasElement} */
     this.canvas = null;
-    /** @type {RenderingContext} */
+    /** @type {CanvasRenderingContext2D | ImageBitmapRenderingContext | WebGLRenderingContext | WebGL2RenderingContext} */
     this.context = null;
     this.onPause = new Signal();
     this.onResume = new Signal();

package/src/phaser/core/input_pointer.js

@@ -19,8 +19,10 @@ export class Pointer {
   constructor(game, id, pointerMode) {
     this.game = game;
     this.id = id;
+    /** @type {number} */
     this.type = POINTER;
     this.exists = true;
+    /** @type {number} */
     this.identifier = 0;
     this.pointerId = null;
     this.pointerMode = pointerMode || POINTER_CURSOR | POINTER_CONTACT;
@@ -28,27 +30,43 @@ export class Pointer {
     this.button = null;
     this._holdSent = false;
     this._history = [];
+    /** @type {number} */
     this._nextDrop = 0;
     this._stateReset = false;
     this.withinGame = false;
     this.clientX = -1;
+    /** @type {number} */
     this.clientY = -1;
+    /** @type {number} */
     this.pageX = -1;
+    /** @type {number} */
     this.pageY = -1;
+    /** @type {number} */
     this.screenX = -1;
+    /** @type {number} */
     this.screenY = -1;
+    /** @type {number} */
     this.rawMovementX = 0;
+    /** @type {number} */
     this.rawMovementY = 0;
+    /** @type {number} */
     this.movementX = 0;
+    /** @type {number} */
     this.movementY = 0;
+    /** @type {number} */
     this.x = -1;
+    /** @type {number} */
     this.y = -1;
     this.isMouse = id === 0;
     this.isDown = false;
     this.isUp = true;
+    /** @type {number} */
     this.timeDown = 0;
+    /** @type {number} */
     this.timeUp = 0;
+    /** @type {number} */
     this.previousTapTime = 0;
+    /** @type {number} */
     this.totalTouches = 0;
     this.msSinceLastClick = Number.MAX_VALUE;
     this.targetObject = null;

package/src/phaser/core/loader.js

@@ -114,7 +114,7 @@ export class Loader {
    * TBD.
    * @param {string} type - TBD.
    * @param {string} key - TBD.
-   * @returns {object} TBD.
+   * @returns {{index: number, file: object} | null} TBD.
    */
   getAsset(type, key) {
     const fileIndex = this.getAssetIndex(type, key);
@@ -623,7 +623,7 @@ export class Loader {
    * TBD.
    * @param {boolean} abnormal - TBD.
    */
-  finishedLoading(abnormal) {
+  finishedLoading(abnormal = false) {
     if (this.hasLoaded) {
       return;
     }

package/src/phaser/core/scale_manager.js

@@ -49,6 +49,7 @@ export class ScaleManager {
     this.bounds = new Rectangle();
     this.aspectRatio = 0;
     this.sourceAspectRatio = 0;
+    /** @type {Event | null | undefined} */
     this.event = null;
     this.windowConstraints = {
       right: 'layout',
@@ -840,7 +841,7 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @param {Event} event - TBD.
+   * @param {Event} [event] - TBD.
    */
   fullScreenError(event) {
     this.event = event;
@@ -870,7 +871,7 @@ export class ScaleManager {
 
   /**
    * TBD.
-   * @returns {object} TBD.
+   * @returns {ParentNode | null} TBD.
    */
   get boundingParent() {
     if (this.parentIsWindow || (this.isFullScreen && this.hasPhaserSetFullScreen && !this._createdFullScreenTarget)) {

package/src/phaser/core/time.js

@@ -7,30 +7,54 @@ export class Time {
    */
   constructor(game) {
     this.game = game;
+    /** @type {number} */
     this.time = 0;
+    /** @type {number} */
     this.prevTime = 0;
+    /** @type {number} */
     this.now = 0;
+    /** @type {number} */
     this.elapsed = 0;
+    /** @type {number} */
     this.elapsedMS = 0;
+    /** @type {number} */
     this.desiredFpsMult = 1 / 60;
+    /** @type {number} */
     this._desiredFps = 60;
+    /** @type {number} */
     this.suggestedFps = this.desiredFps;
+    /** @type {boolean} */
     this.advancedTiming = false;
+    /** @type {number} */
     this.frames = 0;
+    /** @type {number} */
     this.fps = 0;
+    /** @type {number} */
     this.fpsMin = 1000;
+    /** @type {number} */
     this.fpsMax = 0;
+    /** @type {number} */
     this.msMin = 1000;
+    /** @type {number} */
     this.msMax = 0;
+    /** @type {number} */
     this.pauseDuration = 0;
+    /** @type {number} */
     this.timeToCall = 0;
+    /** @type {number} */
     this.timeExpected = 0;
+    /** @type {Timer} */
     this.events = new Timer(this.game, false);
+    /** @type {number} */
     this._frameCount = 0;
+    /** @type {number} */
     this._elapsedAccumulator = 0;
     this._started = 0;
+    /** @type {number} */
     this._timeLastSecond = 0;
+    /** @type {number} */
     this._pauseStarted = 0;
+    /** @type {boolean} */
     this._justResumed = false;
     /** @type {Timer[]} */
     this._timers = [];

package/src/phaser/core/timer.js

@@ -9,25 +9,43 @@ export class Timer {
    */
   constructor(game, autoDestroy = false) {
     this.game = game;
+    /** @type {boolean} */
     this.running = false;
+    /** @type {boolean} */
     this.autoDestroy = autoDestroy;
+    /** @type {boolean} */
     this.expired = false;
+    /** @type {number} */
     this.elapsed = 0;
     /** @type {TimerEvent[]} */
     this.events = [];
+    /** @type {Signal} */
     this.onComplete = new Signal();
+    /** @type {number} */
     this.nextTick = 0;
+    /** @type {number} */
     this.timeCap = 1000;
+    /** @type {boolean} */
     this.paused = false;
+    /** @type {boolean} */
     this._codePaused = false;
+    /** @type {number} */
     this._started = 0;
+    /** @type {number} */
     this._pauseStarted = 0;
+    /** @type {number} */
     this._pauseTotal = 0;
+    /** @type {number} */
     this._now = Date.now();
+    /** @type {number} */
     this._len = 0;
+    /** @type {number} */
     this._marked = 0;
+    /** @type {number} */
     this._i = 0;
+    /** @type {number} */
     this._diff = 0;
+    /** @type {number} */
     this._newTick = 0;
   }
 

package/src/phaser/core/tween.js

@@ -13,27 +13,43 @@ export class Tween {
   constructor(target, game, manager) {
     this.game = game;
     this.target = target;
+    /** @type {import('./tween_manager.js').TweenManager} */
     this.manager = manager;
     /** @type {TweenData[]} */
     this.timeline = [];
+    /** @type {boolean} */
     this.reverse = false;
+    /** @type {number} */
     this.timeScale = 1;
+    /** @type {number} */
     this.repeatCounter = 0;
+    /** @type {boolean} */
     this.pendingDelete = false;
+    /** @type {Signal} */
     this.onStart = new Signal();
+    /** @type {Signal} */
     this.onLoop = new Signal();
+    /** @type {Signal} */
     this.onRepeat = new Signal();
+    /** @type {Signal} */
     this.onChildComplete = new Signal();
+    /** @type {Signal} */
     this.onComplete = new Signal();
+    /** @type {boolean} */
     this.isRunning = false;
+    /** @type {number} */
     this.current = 0;
     this.properties = {};
     this.chainedTween = null;
+    /** @type {boolean} */
     this.isPaused = false;
     this._onUpdateCallback = null;
     this._onUpdateCallbackContext = null;
+    /** @type {number} */
     this._pausedTime = 0;
+    /** @type {boolean} */
     this._codePaused = false;
+    /** @type {boolean} */
     this._hasStarted = false;
   }
 

package/src/phaser/core/tween_manager.js

@@ -41,8 +41,11 @@ export class TweenManager {
    */
   constructor(game) {
     this.game = game;
+    /** @type {Tween[]} */
     this._tweens = [];
+    /** @type {Tween[]} */
     this._add = [];
+    /** @type {{[key: string]: (k: number) => number}} */
     this.easeMap = {
       Linear: LinearNone,
       Quad: QuadraticOut,

package/src/phaser/display/bitmap_text.js

@@ -16,20 +16,31 @@ export class BitmapText extends DisplayObject {
    */
   constructor(game, x = 0, y = 0, font = '', text = '', size = 32, align = 'left') {
     super(game);
+    /** @type {number} */
     this.type = BITMAP_TEXT;
     this.position.setTo(x, y);
+    /** @type {number} */
     this.textWidth = 0;
+    /** @type {number} */
     this.textHeight = 0;
+    /** @type {Point} */
     this._prevAnchor = new Point();
     this._glyphs = [];
+    /** @type {number} */
     this._maxWidth = 0;
+    /** @type {string} */
     this._text = text.toString() || '';
     this._data = game.cache.getBitmapFont(font);
+    /** @type {string} */
     this._font = font;
+    /** @type {number} */
     this._fontSize = size;
+    /** @type {string} */
     this._align = align;
+    /** @type {number} */
     this._tint = 0xffffff;
     this.updateText();
+    /** @type {boolean} */
     this.dirty = false;
   }
 
@@ -79,7 +90,7 @@ export class BitmapText extends DisplayObject {
    * @param {object} data - TBD.
    * @param {number} scale - TBD.
    * @param {string} text - TBD.
-   * @returns {object} TBD.
+   * @returns {{width: number, text: string, end: boolean, chars: number[]}} TBD.
    */
   scanLine(data, scale, text) {
     let x = 0;

package/src/phaser/display/canvas/graphics.js

@@ -2,7 +2,7 @@ import { GEOM_CIRCLE, GEOM_ELLIPSE, GEOM_POLYGON, GEOM_RECTANGLE, GEOM_ROUNDED_R
 
 /**
  * TBD.
- * @param {object} graphics - TBD.
+ * @param {import('../graphics.js').Graphics} graphics - TBD.
  */
 export const updateGraphicsTint = (graphics) => {
   if (graphics.tint === 0xffffff) {
@@ -28,7 +28,7 @@ export const updateGraphicsTint = (graphics) => {
 
 /**
  * TBD.
- * @param {object} graphics - TBD.
+ * @param {import('../graphics.js').Graphics} graphics - TBD.
  * @param {object} context - TBD.
  */
 export const renderGraphics = (graphics, context) => {
@@ -157,7 +157,7 @@ export const renderGraphics = (graphics, context) => {
 
 /**
  * TBD.
- * @param {object} graphics - TBD.
+ * @param {import('../graphics.js').Graphics} graphics - TBD.
  * @param {object} context - TBD.
  */
 export const renderGraphicsMask = (graphics, context) => {

package/src/phaser/display/canvas/pool.js

@@ -1,6 +1,6 @@
 /**
  * TBD.
- * @returns {object[]} TBD.
+ * @returns {{canvas: HTMLCanvasElement, parent: object}[]} TBD.
  */
 export const getPool = () => {
   if (!window.PhaserRegistry) {
@@ -14,7 +14,7 @@ export const getPool = () => {
 
 /**
  * TBD.
- * @returns {object} TBD.
+ * @returns {number} TBD.
  */
 export const getFirst = () => {
   const pool = getPool();
@@ -89,8 +89,8 @@ export const getFree = () => {
 /**
  * TBD.
  * @param {object} parent - TBD.
- * @param {number} width - TBD.
- * @param {number} height - TBD.
+ * @param {number} [width] - TBD.
+ * @param {number} [height] - TBD.
  * @param {boolean} skipPool - TBD.
  * @returns {HTMLCanvasElement} TBD.
  */

package/src/phaser/display/canvas/renderer.js

@@ -32,6 +32,7 @@ export class CanvasRenderer {
    */
   constructor(game) {
     detectCapabilities(game);
+    /** @type {number} */
     this.type = RENDER_CANVAS;
     this.resolution = game.config.resolution;
     this.clearBeforeRender = game.config.clearBeforeRender;

package/src/phaser/display/canvas/util.js

@@ -26,7 +26,7 @@ export const create = (parent, width, height, id, skipPool) => {
  * TBD.
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {string} color - TBD.
- * @returns {object} TBD.
+ * @returns {HTMLCanvasElement} TBD.
  */
 export const setBackgroundColor = (canvas, color) => {
   color = color || 'rgb(0,0,0)';
@@ -38,7 +38,7 @@ export const setBackgroundColor = (canvas, color) => {
  * TBD.
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {string} value - TBD.
- * @returns {object} TBD.
+ * @returns {HTMLCanvasElement} TBD.
  */
 export const setTouchAction = (canvas, value = 'none') => {
   value = value || 'none';
@@ -53,7 +53,7 @@ export const setTouchAction = (canvas, value = 'none') => {
  * TBD.
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {string} value - TBD.
- * @returns {object} TBD.
+ * @returns {HTMLCanvasElement} TBD.
  */
 export const setUserSelect = (canvas, value = 'none') => {
   value = value || 'none';
@@ -72,7 +72,7 @@ export const setUserSelect = (canvas, value = 'none') => {
  * @param {HTMLCanvasElement} canvas - TBD.
  * @param {object} parent - TBD.
  * @param {boolean} overflowHidden - TBD.
- * @returns {object} TBD.
+ * @returns {HTMLCanvasElement} TBD.
  */
 export const addToDOM = (canvas, parent, overflowHidden = true) => {
   let target;
@@ -108,14 +108,14 @@ export const removeFromDOM = (canvas) => {
 
 /**
  * TBD.
- * @param {object} context - TBD.
+ * @param {CanvasRenderingContext2D} context - TBD.
  * @param {number} translateX - TBD.
  * @param {number} translateY - TBD.
  * @param {number} scaleX - TBD.
  * @param {number} scaleY - TBD.
  * @param {number} skewX - TBD.
  * @param {number} skewY - TBD.
- * @returns {object} TBD.
+ * @returns {CanvasRenderingContext2D} TBD.
  */
 export const setTransform = (context, translateX, translateY, scaleX, scaleY, skewX, skewY) => {
   context.setTransform(scaleX, skewX, skewY, scaleY, translateX, translateY);
@@ -124,8 +124,8 @@ export const setTransform = (context, translateX, translateY, scaleX, scaleY, sk
 
 /**
  * TBD.
- * @param {object} context - TBD.
- * @returns {object} TBD.
+ * @param {CanvasRenderingContext2D} context - TBD.
+ * @returns {string | null} TBD.
  */
 export const getSmoothingPrefix = (context) => {
   const VENDORS = ['i', 'webkitI', 'msI', 'mozI', 'oI'];

package/src/phaser/display/graphics.js

@@ -33,24 +33,41 @@ export class Graphics extends DisplayObject {
    */
   constructor(game, x = 0, y = 0) {
     super(game);
+    /** @type {number} */
     this.type = GRAPHICS;
     this.position.setTo(x, y);
+    /** @type {boolean} */
     this.renderable = true;
+    /** @type {number} */
     this.fillAlpha = 1;
+    /** @type {number} */
     this.lineWidth = 0;
+    /** @type {number} */
     this.lineColor = 0;
     this.graphicsData = [];
+    /** @type {number} */
     this.tint = 0xffffff;
+    /** @type {number} */
     this.blendMode = BLEND_NORMAL;
+    /** @type {GraphicsData} */
     this.currentPath = null;
+    /** @type {object[]} */
     this._webGL = [];
+    /** @type {boolean} */
     this.isMask = false;
+    /** @type {number} */
     this.boundsPadding = 0;
+    /** @type {Rectangle} */
     this._localBounds = new Rectangle(0, 0, 1, 1);
+    /** @type {boolean} */
     this.dirty = true;
+    /** @type {boolean} */
     this._boundsDirty = false;
+    /** @type {boolean} */
     this._cacheAsBitmap = false;
+    /** @type {boolean} */
     this.webGLDirty = false;
+    /** @type {boolean} */
     this.cachedSpriteDirty = false;
   }
 

package/src/phaser/display/group.js

@@ -16,11 +16,14 @@ export class Group extends DisplayObject {
    */
   constructor(game, parent = null, name = null, addToStage = false) {
     super(game);
+    /** @type {number} */
     this.type = GROUP;
     if (!parent) {
       parent = game.world;
     }
+    /** @type {string} */
     this.name = name || 'group';
+    /** @type {number} */
     this.z = 0;
     if (addToStage) {
       this.game.stage.addChild(this);
@@ -29,17 +32,27 @@ export class Group extends DisplayObject {
       parent.addChild(this);
       this.z = parent.children.length;
     }
+    /** @type {boolean} */
     this.ignoreDestroy = false;
+    /** @type {boolean} */
     this.pendingDestroy = false;
     this.classType = Image;
     this.cursor = null;
+    /** @type {boolean} */
     this.inputEnableChildren = false;
+    /** @type {Signal} */
     this.onChildInputDown = new Signal();
+    /** @type {Signal} */
     this.onChildInputUp = new Signal();
+    /** @type {Signal} */
     this.onChildInputOver = new Signal();
+    /** @type {Signal} */
     this.onChildInputOut = new Signal();
+    /** @type {Signal} */
     this.onDestroy = new Signal();
+    /** @type {number} */
     this.cursorIndex = 0;
+    /** @type {string} */
     this._sortProperty = 'z';
   }