@inglorious/utils 2.1.0 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inglorious/utils",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A set of general-purpose utility functions designed with functional programming principles in mind.",
   "author": "IceOnFire <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
   "license": "MIT",

package/src/data-structures/array.js

@@ -25,21 +25,21 @@ export function contains(arr, item) {
 /**
  * Ensures that the given value is an array. If it's not an array, it wraps it in one.
  *
- * @param {*} arr - The value to check.
+ * @param {*} value - The value to check.
  * @returns {Array} - The original array or the value wrapped in a new array.
  */
-export function ensureArray(arr) {
-  return isArray(arr) ? arr : [arr]
+export function ensureArray(value) {
+  return isArray(value) ? value : [value]
 }
 
 /**
  * Checks if a value is an array.
- * @param {*} arr - The value to check.
  *
+ * @param {*} value - The value to check.
  * @returns {boolean} True if the value is an array, false otherwise.
  */
-export function isArray(arr) {
-  return Array.isArray(arr)
+export function isArray(value) {
+  return Array.isArray(value)
 }
 
 /**

package/src/data-structures/object.js

@@ -44,11 +44,11 @@ export function find(obj, callback) {
 /**
  * Checks if a value is a plain object.
  *
- * @param {*} obj - The value to check.
+ * @param {*} value - The value to check.
  * @returns {boolean} True if the value is a plain object, false otherwise.
  */
-export function isObject(obj) {
-  return obj != null && obj.constructor === Object
+export function isObject(value) {
+  return value != null && value.constructor === Object
 }
 
 /**

package/src/math/geometry/point.js

@@ -8,6 +8,7 @@
 const SQUARED = 2
 const HALF = 2
 
+import { isVector } from "../linear-algebra/vector.js"
 import { distanceFromPoint } from "./line.js"
 
 /**
@@ -27,8 +28,8 @@ export function getDistanceFromLine(point, line) {
  * @returns {boolean} True if the points intersect, false otherwise.
  */
 export function intersectsPoint(point1, point2) {
-  const [x1, y1, z1] = point1
-  const [x2, y2, z2] = point2
+  const [x1, y1, z1] = ensurePoint(point1)
+  const [x2, y2, z2] = ensurePoint(point2)
   return x1 === x2 && y1 === y2 && z1 === z2
 }
 
@@ -39,7 +40,7 @@ export function intersectsPoint(point1, point2) {
  * @returns {boolean} True if the point intersects the circle, false otherwise.
  */
 export function intersectsCircle(point, circle) {
-  const [x, y, z] = point
+  const [x, y, z] = ensurePoint(point)
   const [cx, cy, cz] = circle.position
   const radius = circle.radius
 
@@ -56,7 +57,7 @@ export function intersectsCircle(point, circle) {
  * @returns {boolean} True if the point intersects the rectangle, false otherwise.
  */
 export function intersectsRectangle(point, rectangle) {
-  const [x, y, z] = point
+  const [x, y, z] = ensurePoint(point)
   const [rectX, rectY, rectZ] = rectangle.position
   const [width, height, depth] = rectangle.size
 
@@ -76,3 +77,11 @@ export function intersectsRectangle(point, rectangle) {
     z <= front
   )
 }
+
+function ensurePoint(value) {
+  if (!isVector(value)) {
+    return value.position
+  }
+
+  return value
+}

package/src/math/geometry/point.test.js

@@ -79,3 +79,15 @@ test("it should prove that a point outside of a rectangle does not intersect wit
 
   expect(intersectsRectangle(point, rectangle)).toBe(false)
 })
+
+test("it should work even if the point is an object with a position", () => {
+  const point = {
+    position: [1.5, 1.5, 0],
+  }
+  const rectangle = {
+    position: [1, 1, 0],
+    size: [2, 2, 0],
+  }
+
+  expect(intersectsRectangle(point, rectangle)).toBe(true)
+})

package/src/math/linear-algebra/vector.js

@@ -3,6 +3,7 @@
  * @typedef {import('./types').Vector3} Vector3
  */
 
+import { isArray } from "../../data-structures/array.js"
 import { hypothenuse } from "../geometry/triangle.js"
 import {
   abs as nAbs,
@@ -112,6 +113,19 @@ export function fromAngle(angle) {
 
 export const length = magnitude
 
+/**
+ * Checks if a value is a vector.
+ *
+ * @param {*} value - The value to check.
+ * @returns {boolean} True if the value is a vector, false otherwise.
+ */
+export function isVector(value) {
+  return (
+    isArray(value) &&
+    value.every((coordinate) => typeof coordinate === "number")
+  )
+}
+
 /**
  * Calculates the magnitude of the vector.
  * @param {Vector3} vector - The input vector.