@inglorious/utils 2.3.0 → 3.1.0

package/src/physics/gravity.test.js

@@ -1,5 +1,6 @@
 import { expect, test } from "vitest"
 
+import { v } from "../v.js"
 import { applyGravity } from "./gravity.js"
 
 test("it should apply gravity based on input parameters", () => {
@@ -8,13 +9,13 @@ test("it should apply gravity based on input parameters", () => {
     maxLeap: 10,
     maxSpeed: 10,
     vy: 10,
-    position: [0, 10, 0],
+    position: v(0, 10, 0),
   }
 
   expect(applyGravity(params)).toStrictEqual({
     ay: -20,
     vy: -10,
-    position: [0, -10, 0],
+    position: v(0, -10, 0),
   })
 })
 
@@ -23,13 +24,13 @@ test("it should compute no gravity when max jump height is not set", () => {
     maxLeap: 10,
     maxSpeed: 10,
     vy: 10,
-    position: [0, 10, 0],
+    position: v(0, 10, 0),
   }
 
   expect(applyGravity(params)).toStrictEqual({
     ay: -0,
     vy: 10,
-    position: [0, 20, 0],
+    position: v(0, 20, 0),
   })
 })
 
@@ -38,13 +39,13 @@ test("it should compute no gravity when max movement speed is not set", () => {
     maxJump: 10,
     maxLeap: 10,
     vy: 10,
-    position: [0, 10, 0],
+    position: v(0, 10, 0),
   }
 
   expect(applyGravity(params)).toStrictEqual({
     ay: -0,
     vy: 10,
-    position: [0, 20, 0],
+    position: v(0, 20, 0),
   })
 })
 
@@ -54,14 +55,14 @@ test("it should apply no gravity when no time has passed", () => {
     maxLeap: 10,
     maxSpeed: 10,
     vy: 10,
-    position: [0, 10, 0],
+    position: v(0, 10, 0),
   }
   const dt = 0
 
   expect(applyGravity(params, dt)).toStrictEqual({
     ay: -20,
     vy: 10,
-    position: [0, 10, 0],
+    position: v(0, 10, 0),
   })
 })
 
@@ -70,7 +71,7 @@ test("it should throw an error when max leap distance is not set", () => {
     maxJump: 10,
     maxSpeed: 10,
     vy: 10,
-    position: [0, 10, 0],
+    position: v(0, 10, 0),
   }
 
   expect(() => applyGravity(params)).toThrow()

package/src/physics/index.js

@@ -0,0 +1,7 @@
+import * as acceleration from "./acceleration.js"
+import * as friction from "./friction.js"
+import * as gravity from "./gravity.js"
+import * as jump from "./jump.js"
+import * as velocity from "./velocity.js"
+
+export { acceleration, friction, gravity, jump, velocity }

package/src/physics/jump.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('../math/linear-algebra/types').Vector3} Vector3
+ * @typedef {import('../math/types').Vector3} Vector3
  */
 
 /* eslint-disable no-magic-numbers */
@@ -11,7 +11,6 @@ const DEFAULT_MAX_SPEED = 0 // Default maximum speed.
 /**
  * Calculates the vertical velocity (vy) of a jump
  * based on the provided parameters.
- *
  * @param {Object} params - Parameters for the jump calculation.
  * @param {number} params.maxJump - Maximum jump height. Defaults to 0.
  * @param {number} params.maxLeap - Maximum leap distance. Defaults to 0.

package/src/physics/velocity.js

@@ -1,16 +1,15 @@
 /**
- * @typedef {import('../math/linear-algebra/types').Vector3} Vector3
+ * @typedef {import('../math/types.js').Vector3} Vector3
  */
 
-import { clamp, multiply, zero } from "../math/linear-algebra/vector.js"
-import { sum } from "../math/linear-algebra/vectors.js"
+import { clamp, multiply, zero } from "../math/vector.js"
+import { sum } from "../math/vectors.js"
 
 const DEFAULT_DT = 1 // Default time delta for the applyVelocity function.
 const DEFAULT_MAX_SPEED = 0 // Default maximum speed for velocity clamping.
 
 /**
  * Applies velocity to a position based on the given parameters and options.
- *
  * @param {Object} params - The parameters for velocity application.
  * @param {number} [params.maxSpeed] - The maximum speed for clamping the velocity. Defaults to 0.
  * @param {Vector3} [params.velocity] - The current velocity vector. Defaults to a zero vector.

package/src/v.js

@@ -0,0 +1,17 @@
+/**
+ * A utility function to create a vector from a list of coordinates.
+ * This is a shorthand for `[x, y, z, ...]`.
+ * It also tags the array with a non-enumerable `__isVector__` property for
+ * efficient type checking.
+ * @param {...number} coords - The coordinates of the vector.
+ * @returns {Vector} The created vector.
+ */
+export function v(...coords) {
+  Object.defineProperty(coords, "__isVector__", {
+    value: true,
+    enumerable: false,
+    configurable: false,
+    writable: false,
+  })
+  return coords
+}

package/src/v.test.js

@@ -0,0 +1,13 @@
+import { expect, test } from "vitest"
+
+import { v } from "./v"
+
+test("a vector created with the v() function is just a number array", () => {
+  const vector = v(1, 2, 3)
+  expect(vector).toStrictEqual([1, 2, 3])
+})
+
+test("a vector created with the v() function has a __isVector__ property", () => {
+  const vector = v(1, 2, 3)
+  expect(vector.__isVector__).toBe(true)
+})

package/src/math/linear-algebra/types.d.ts

@@ -1,5 +0,0 @@
-export type Vector = number[]
-export type Vector2 = [number, number]
-export type Vector3 = [number, number, number]
-export type Quaternion = [number, number, number, number]
-export type Vector7 = [number, number, number, number, number, number, number]