🤖 Merge PR DefinitelyTyped#73373 update(types/matter-js):Update to the latest version 0.20.0 by @fanefanes

Co-authored-by: Steven Snoeijen <2750503+stevensnoeijen@users.noreply.github.com>

Author: fantc

types/matter-js/index.d.ts

@@ -107,7 +107,7 @@ declare namespace Matter {
          * @param {number} y
          * @param {number} width
          * @param {number} height
-         * @param {number} slope
+         * @param {number} slope Must be a number < 1.
          * @param {any} [options]
          * @returns {Body} A new trapezoid body
          */
@@ -421,6 +421,17 @@ declare namespace Matter {
          * are both true.
          */
         collisionFilter?: ICollisionFilter | undefined;
+        /**
+         * Temporarily may hold parameters to be passed to `Vertices.chamfer` where supported by external functions.
+         *
+         * See `Vertices.chamfer` for possible parameters this object may hold.
+         *
+         * Currently only functions inside `Matter.Bodies` provide a utility using this property as a vertices pre-processing option.
+         *
+         * Alternatively consider using `Vertices.chamfer` directly on vertices before passing them to a body creation function.
+         *
+         */
+        chamfer?: IChamfer | null | undefined;
     }
 
     export interface IBodyRenderOptions {
@@ -1626,6 +1637,14 @@ declare namespace Matter {
          */
         static pointBWorld(constraint: Constraint): Vector;
 
+        /**
+         * Returns the current length of the constraint. This is the distance between both of the constraint's end points. See constraint.length for the target rest length.
+         * @method currentLength
+         * @param {constraint} constraint
+         * @returns {number} the current length
+         */
+        static currentLength(constraint: Constraint): number;
+
         /**
          * The first possible `Body` that this constraint is attached to.
          *
@@ -1853,7 +1872,7 @@ declare namespace Matter {
          * Therefore the value is always `1` (no correction) when `delta` constant (or when no correction is desired, which is the default).
          * See the paper on <a href="http://lonesock.net/article/verlet.html">Time Corrected Verlet</a> for more information.
          *
-         * Triggers `beforeUpdate` and `afterUpdate` events.
+         * Triggers `beforeUpdate`, `beforeSolve` and `afterUpdate` events.
          * Triggers `collisionStart`, `collisionActive` and `collisionEnd` events.
          * @method update
          * @param {engine} engine
@@ -1964,7 +1983,7 @@ declare namespace Matter {
         world: World;
     }
 
-    export interface IGridDefinition {}
+    export interface IGridDefinition { }
 
     /**
      * This module has now been replaced by `Matter.Detector`.
@@ -2354,12 +2373,22 @@ declare namespace Matter {
         background?: string | undefined;
 
         /**
-         * Sets wireframe background if `render.options.wireframes` is enabled
+         * A CSS color string to use for background when `render.options.wireframes` is enabled.
+         * This may be also set to `'transparent'` or equivalent.
          *
          * default undefined
          */
         wireframeBackground?: string | undefined;
 
+
+        /**
+         * A CSS color string to use for stroke when `render.options.wireframes` is enabled.
+         * This may be also set to `'transparent'` or equivalent.
+         *
+         * default '#bbb'
+         */
+        wireframeStrokeStyle?: string | undefined;
+
         /**
          * Sets opacity of sleeping body if `render.options.showSleeping` is enabled
          *
@@ -2408,6 +2437,7 @@ declare namespace Matter {
          * From left to right, the values shown are:
          * - average render frequency (e.g. 60 fps)
          * - exact engine delta time used for last update (e.g. 16.66ms)
+         * - average updates per frame (e.g. 1)
          * - average engine execution duration (e.g. 5.00ms)
          * - average render execution duration (e.g. 0.40ms)
          * - average effective play speed (e.g. '1.00x' is 'real-time')
@@ -2491,27 +2521,27 @@ declare namespace Matter {
     interface IRenderLookAtObject {
         bounds?: Bounds | undefined;
         position?:
-            | {
-                x: number;
-                y: number;
-            }
-            | undefined;
+        | {
+            x: number;
+            y: number;
+        }
+        | undefined;
         min?:
-            | {
-                x: number;
-                y: number;
-            }
-            | undefined;
+        | {
+            x: number;
+            y: number;
+        }
+        | undefined;
         max?:
-            | {
-                x: number;
-                y: number;
-            }
-            | undefined;
+        | {
+            x: number;
+            y: number;
+        }
+        | undefined;
     }
 
     /**
-     * The `Matter.Render` module is a simple HTML5 canvas based renderer for visualising instances of `Matter.Engine`.
+     * The `Matter.Render` module is a lightweight, optional utility which provides a simple canvas based renderer for visualising instances of `Matter.Engine`.
      * It is intended for development and debugging purposes, but may also be suitable for simple games.
      * It includes a number of drawing options including wireframe, vector with support for sprites and viewports.
      */
@@ -2545,6 +2575,23 @@ declare namespace Matter {
          * @param {number} pixelRatio
          */
         static setPixelRatio(render: Render, pixelRatio: number): void;
+        /**
+         * Sets the render `width` and `height`.
+         *
+         * Updates the canvas accounting for `render.options.pixelRatio`.
+         *
+         * Updates the bottom right render bound `render.bounds.max` relative to the provided `width` and `height`.
+         * The top left render bound `render.bounds.min` isn't changed.
+         *
+         * Follow this call with `Render.lookAt` if you need to change the render bounds.
+         *
+         * See also `Render.setPixelRatio`.
+         * @method setSize
+         * @param {render} render
+         * @param {number} width The width (in CSS pixels)
+         * @param {number} height The height (in CSS pixels)
+         */
+        static setSize(render: Render, width: number, height: number): void;
         /**
          * Renders the given `engine`'s `Matter.World` object.
          * This is the entry point for all rendering and should be called every time the scene changes.
@@ -3670,6 +3717,7 @@ declare namespace Matter {
          * @event afterUpdate
          * @param {} event An event object
          * @param {number} event.timestamp The engine.timing.timestamp of the event
+         * @param {number} event.delta The delta time in milliseconds value used in the update
          * @param {} event.source The source object of the event
          * @param {} event.name The name of the event
          */
@@ -3707,13 +3755,26 @@ declare namespace Matter {
          */
         static on<C extends IEngineCallback>(obj: Engine, name: "beforeUpdate", callback: C): C;
 
+        /**
+         * Fired after bodies updated based on their velocity and forces, but before any collision detection, constraints and resolving etc.
+         *
+         * @event beforeSolve
+         * @param {} event An event object
+         * @param {number} event.timestamp The engine.timing.timestamp of the event
+         * @param {number} event.delta The delta time in milliseconds value used in the update
+         * @param {} event.source The source object of the event
+         * @param {} event.name The name of the event
+         */
+        static on<C extends IEngineCallback>(obj: Engine, name: "beforeSolve", callback: C): C;
+
         /**
          * Fired after engine update, provides a list of all pairs that are colliding in the current tick (if any)
          *
          * @event collisionActive
          * @param {} event An event object
          * @param {} event.pairs List of affected pairs
          * @param {number} event.timestamp The engine.timing.timestamp of the event
+         * @param {number} event.delta The delta time in milliseconds value used in the update
          * @param {} event.source The source object of the event
          * @param {} event.name The name of the event
          */
@@ -3726,6 +3787,7 @@ declare namespace Matter {
          * @param {} event An event object
          * @param {} event.pairs List of affected pairs
          * @param {number} event.timestamp The engine.timing.timestamp of the event
+         * @param {number} event.delta The delta time in milliseconds value used in the update
          * @param {} event.source The source object of the event
          * @param {} event.name The name of the event
          */
@@ -3738,6 +3800,7 @@ declare namespace Matter {
          * @param {} event An event object
          * @param {} event.pairs List of affected pairs
          * @param {number} event.timestamp The engine.timing.timestamp of the event
+         * @param {number} event.delta The delta time in milliseconds value used in the update
          * @param {} event.source The source object of the event
          * @param {} event.name The name of the event
          */
@@ -3897,7 +3960,7 @@ declare namespace Matter {
          * @param {} module The module.
          * @returns {boolean} `true` if `plugin.for` is applicable to `module`, otherwise `false`.
          */
-        static isFor(plugin: Plugin, module: { name?: string | undefined; [_: string]: any }): boolean;
+        static isFor(plugin: Plugin, module: { name?: string | undefined;[_: string]: any }): boolean;
 
         /**
          * Installs the plugins by calling `plugin.install` on each plugin specified in `plugins` if passed, otherwise `module.uses`.
@@ -3916,7 +3979,7 @@ declare namespace Matter {
          * @param [plugins=module.uses] {} The plugins to install on module (optional, defaults to `module.uses`).
          */
         static use(
-            module: { uses?: Array<Plugin | string> | undefined; [_: string]: any },
+            module: { uses?: Array<Plugin | string> | undefined;[_: string]: any },
             plugins: Array<Plugin | string>,
         ): void;
 

types/matter-js/matter-js-tests.ts

@@ -137,6 +137,9 @@ var constraint1 = Constraint.create({
 
 World.addConstraint(engine.world, constraint1);
 
+// $ExpectType number
+Constraint.currentLength(constraint1)
+
 // $ExpectType Body | null
 var bodyA = constraint1.bodyA;
 // $ExpectType Body | null
@@ -235,6 +238,8 @@ Events.on(composite1, "afterRemove", (e) => {});
 // $ExpectType (e: IEventTimestamped<Engine>) => void
 Events.on(engine, "beforeUpdate", (e) => {});
 // $ExpectType (e: IEventTimestamped<Engine>) => void
+Events.on(engine, "beforeSolve", (e) => {});
+// $ExpectType (e: IEventTimestamped<Engine>) => void
 Events.on(engine, "afterUpdate", (e) => {});
 // $ExpectType (e: IEventCollision<Engine>) => void
 Events.on(engine, "collisionStart", (e) => {});

types/matter-js/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/matter-js",
-    "version": "0.19.9999",
+    "version": "0.20.9999",
     "projects": [
         "https://github.com/liabru/matter-js"
     ],