@inglorious/utils 3.7.0 → 3.7.2

package/README.md

@@ -1,86 +1,86 @@
-# Inglorious Utils
-
-[![NPM version](https://img.shields.io/npm/v/@inglorious/utils.svg)](https://www.npmjs.com/package/@inglorious/utils)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-A set of general-purpose utility functions designed with functional programming principles in mind. This package is part of the [Inglorious Engine](https://github.com/IngloriousCoderz/inglorious-engine) monorepo.
-
----
-
-## Overview
-
-This package provides a collection of pure, composable helper functions to streamline development in any JavaScript or TypeScript project. It embraces a data-oriented and functional approach, operating on plain data structures like objects and arrays.
-
----
-
-## Installation
-
-```bash
-npm install @inglorious/utils
-```
-
----
-
-## Usage
-
-Here are a few examples of how you can use the utilities in this package.
-
-### `pipe`
-
-Compose functions together in a readable, left-to-right sequence.
-
-```javascript
-import { pipe } from "@inglorious/utils/functions/functions"
-
-const add = (a) => (b) => a + b
-const multiply = (a) => (b) => a * b
-
-const calculate = pipe(
-  add(5), // 10 + 5 = 15
-  multiply(2), // 15 * 2 = 30
-  add(10), // 30 + 10 = 40
-)
-
-const result = calculate(10) // 40
-```
-
-### Vector Math
-
-Perform vector operations on plain objects.
-
-```javascript
-import { add } from "@inglorious/utils/math/vector.js"
-
-const position = [10, 20]
-const velocity = [2, -1]
-
-const newPosition = add(position, velocity)
-// => [12, 19]
-```
-
----
-
-## API
-
-This package is designed to be used with subpath imports, which helps with tree-shaking.
-
-- **`@inglorious/utils/algorithms`**: Utilities for AI algorithms, like decision trees and A\*.
-- **`@inglorious/utils/functions`**: Utilities for function composition.
-- **`@inglorious/utils/math`**: Utilities for math operations.
-- **`@inglorious/utils/physics`**: Utilities for calculations on friction, acceleration, and gravity.
-
----
-
-## License
-
-**MIT License - Free and open source**
-
-Created by [Matteo Antony Mistretta](https://github.com/IngloriousCoderz)
-
-You're free to use, modify, and distribute this software. See [LICENSE](./LICENSE) for details.
-
----
-
-## Contributing
-
-We welcome contributions! Please see the root `CONTRIBUTING.md` file for more details.
+# Inglorious Utils
+
+[![NPM version](https://img.shields.io/npm/v/@inglorious/utils.svg)](https://www.npmjs.com/package/@inglorious/utils)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A set of general-purpose utility functions designed with functional programming principles in mind. This package is part of the [Inglorious Forge](https://github.com/IngloriousCoderz/inglorious-forge) monorepo.
+
+---
+
+## Overview
+
+This package provides a collection of pure, composable helper functions to streamline development in any JavaScript or TypeScript project. It embraces a data-oriented and functional approach, operating on plain data structures like objects and arrays.
+
+---
+
+## Installation
+
+```bash
+npm install @inglorious/utils
+```
+
+---
+
+## Usage
+
+Here are a few examples of how you can use the utilities in this package.
+
+### `pipe`
+
+Compose functions together in a readable, left-to-right sequence.
+
+```javascript
+import { pipe } from "@inglorious/utils/functions/functions"
+
+const add = (a) => (b) => a + b
+const multiply = (a) => (b) => a * b
+
+const calculate = pipe(
+  add(5), // 10 + 5 = 15
+  multiply(2), // 15 * 2 = 30
+  add(10), // 30 + 10 = 40
+)
+
+const result = calculate(10) // 40
+```
+
+### Vector Math
+
+Perform vector operations on plain objects.
+
+```javascript
+import { add } from "@inglorious/utils/math/vector.js"
+
+const position = [10, 20]
+const velocity = [2, -1]
+
+const newPosition = add(position, velocity)
+// => [12, 19]
+```
+
+---
+
+## API
+
+This package is designed to be used with subpath imports, which helps with tree-shaking.
+
+- **`@inglorious/utils/algorithms`**: Utilities for AI algorithms, like decision trees and A\*.
+- **`@inglorious/utils/functions`**: Utilities for function composition.
+- **`@inglorious/utils/math`**: Utilities for math operations.
+- **`@inglorious/utils/physics`**: Utilities for calculations on friction, acceleration, and gravity.
+
+---
+
+## License
+
+**MIT License - Free and open source**
+
+Created by [Matteo Antony Mistretta](https://github.com/IngloriousCoderz)
+
+You're free to use, modify, and distribute this software. See [LICENSE](./LICENSE) for details.
+
+---
+
+## Contributing
+
+We welcome contributions! Please see the root `CONTRIBUTING.md` file for more details.

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@inglorious/utils",
-  "version": "3.7.0",
+  "version": "3.7.2",
   "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",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/IngloriousCoderz/inglorious-engine.git",
+    "url": "git+https://github.com/IngloriousCoderz/inglorious-forge.git",
     "directory": "packages/utils"
   },
   "homepage": "https://inglorious-engine.vercel.app/",
   "bugs": {
-    "url": "https://github.com/IngloriousCoderz/inglorious-engine/issues"
+    "url": "https://github.com/IngloriousCoderz/inglorious-forge/issues"
   },
   "keywords": [
     "functional-programming",
@@ -33,7 +33,8 @@
   },
   "files": [
     "src",
-    "types"
+    "types",
+    "!src/**/*.test.js"
   ],
   "publishConfig": {
     "access": "public"
@@ -42,14 +43,14 @@
     "prettier": "^3.6.2",
     "vite": "^7.1.3",
     "vitest": "^1.6.1",
-    "@inglorious/eslint-config": "1.0.1"
+    "@inglorious/eslint-config": "1.1.1"
   },
   "engines": {
     "node": ">= 22"
   },
   "scripts": {
-    "format": "prettier --write '**/*.{js,jsx}'",
-    "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
+    "format": "prettier --write .",
+    "lint": "eslint .",
     "test:watch": "vitest",
     "test": "vitest run"
   }

package/src/data-structures/object.js

@@ -24,7 +24,7 @@ const NEXT_LEVEL = 2
  * @returns {T} A deep clone of the input value.
  */
 export function clone(obj) {
-  return structuredClone(obj)
+  return deserialize(serialize(obj))
 }
 
 /**

package/src/algorithms/decision-tree.test.js

@@ -1,154 +0,0 @@
-import { expect, test } from "vitest"
-
-import { length } from "../math/vector.js"
-import { subtract } from "../math/vectors.js"
-import { v } from "../v.js"
-import { decide } from "./decision-tree.js"
-
-test("it should make a decision based on a binary decision tree", () => {
-  const entity = { state: "sleeping", position: v(0, 0, 0) }
-  const target = { position: v(10, 0, 0) }
-  const tree = {
-    test({ entity }) {
-      return entity.state === "idle"
-    },
-    true() {
-      return {
-        test({ entity, target }) {
-          const distance = length(subtract(target.position, entity.position))
-          return distance < 250
-        },
-        true() {
-          return "aware"
-        },
-      }
-    },
-    false() {
-      return {
-        test({ entity }) {
-          return entity.state === "chasing"
-        },
-        true() {
-          return {
-            test({ entity, target }) {
-              const distance = length(
-                subtract(target.position, entity.position),
-              )
-              return distance >= 250
-            },
-            true() {
-              return "idle"
-            },
-            false() {
-              return {
-                test({ entity, target }) {
-                  const distance = length(
-                    subtract(target.position, entity.position),
-                  )
-                  return distance < 10
-                },
-                true() {
-                  return "sleepy"
-                },
-              }
-            },
-          }
-        },
-        false() {
-          return {
-            test({ entity }) {
-              return ["sleepy", "sleeping"].includes(entity.state)
-            },
-            true() {
-              return {
-                test({ entity, target }) {
-                  const distance = length(
-                    subtract(target.position, entity.position),
-                  )
-                  return distance >= 10
-                },
-                true() {
-                  return "aware"
-                },
-              }
-            },
-          }
-        },
-      }
-    },
-  }
-
-  const state = decide(tree, { entity, target })
-
-  expect(state).toBe("aware")
-})
-
-test("it should make a decision on a multi-child tree", () => {
-  const entity = { state: "sleeping", position: v(0, 0, 0) }
-  const target = { position: v(10, 0, 0) }
-  const wakeUp = () => ({
-    test({ entity, target }) {
-      const distance = length(subtract(target.position, entity.position))
-      return distance >= 10
-    },
-    true() {
-      return "aware"
-    },
-    false({ entity }) {
-      return entity.state
-    },
-  })
-
-  const tree = {
-    test({ entity }) {
-      return entity.state
-    },
-    idle() {
-      return {
-        test({ entity, target }) {
-          const distance = length(subtract(target.position, entity.position))
-          return distance < 250
-        },
-        true() {
-          return "aware"
-        },
-        false({ entity }) {
-          return entity.state
-        },
-      }
-    },
-    chasing() {
-      return {
-        test({ entity, target }) {
-          const distance = length(subtract(target.position, entity.position))
-          return distance >= 250
-        },
-        true() {
-          return "idle"
-        },
-        false() {
-          return {
-            test({ entity, target }) {
-              const distance = length(
-                subtract(target.position, entity.position),
-              )
-              return distance < 10
-            },
-            true() {
-              return "sleepy"
-            },
-            false({ entity }) {
-              return entity.state
-            },
-          }
-        },
-      }
-    },
-    sleepy: wakeUp,
-    sleeping: wakeUp,
-  }
-
-  const state = decide(tree, { entity, target })
-
-  expect(state).toBe("aware")
-})

package/src/algorithms/path-finding.test.js

@@ -1,151 +0,0 @@
-import { expect, test } from "vitest"
-
-import {
-  createBoard,
-  down,
-  downRight,
-  right,
-} from "../data-structures/board.js"
-import { findPath } from "./path-finding.js"
-
-test("it should find the shortest path in a trivial example", () => {
-  const graph = {
-    nodes: {
-      A: [0, 0],
-      B: [2, 0],
-    },
-    arcs: [{ from: "A", to: "B", cost: 2 }],
-  }
-  const start = "A"
-  const end = "B"
-  const expectedResult = ["A", "B"]
-
-  expect(findPath(graph, start, end)).toStrictEqual(expectedResult)
-})
-
-test("it should find the shortest path between two nodes with default heuristic", () => {
-  const graph = {
-    nodes: {
-      A: [0, 0],
-      B: [2, 0],
-      C: [3, 2],
-      D: [4, 4],
-      E: [1, 1],
-      F: [2, 3],
-      G: [0, 4],
-    },
-    arcs: [
-      { from: "A", to: "B" },
-      { from: "B", to: "C" },
-      { from: "C", to: "D" },
-      { from: "A", to: "E" },
-      { from: "E", to: "F" },
-      { from: "F", to: "G" },
-      { from: "G", to: "D" },
-    ],
-  }
-  const start = "A"
-  const end = "D"
-  const expectedResult = ["A", "B", "C", "D"]
-
-  expect(findPath(graph, start, end)).toStrictEqual(expectedResult)
-})
-
-test("it should find the shortest path between two nodes with node costs", () => {
-  const graph = {
-    nodes: [
-      { id: "A", position: [0, 0], cost: 0 },
-      { id: "B", position: [2, 0], cost: 7 },
-      { id: "C", position: [3, 2], cost: 3 },
-      { id: "D", position: [4, 4], cost: 2 },
-      { id: "E", position: [1, 1], cost: 1.5 },
-      { id: "F", position: [2, 3], cost: 2 },
-      { id: "G", position: [0, 4], cost: 3 },
-    ],
-    arcs: [
-      { from: "A", to: "B" },
-      { from: "B", to: "C" },
-      { from: "C", to: "D" },
-      { from: "A", to: "E" },
-      { from: "E", to: "F" },
-      { from: "F", to: "G" },
-      { from: "G", to: "D" },
-    ],
-  }
-  const start = "A"
-  const end = "D"
-  const expectedResult = ["A", "E", "F", "G", "D"]
-
-  expect(findPath(graph, start, end)).toStrictEqual(expectedResult)
-})
-
-test("it should find the shortest path between two nodes with arc costs", () => {
-  const graph = {
-    nodes: {
-      A: [0, 0],
-      B: [2, 0],
-      C: [3, 2],
-      D: [4, 4],
-      E: [1, 1],
-      F: [2, 3],
-      G: [0, 4],
-    },
-    arcs: [
-      { from: "A", to: "B", cost: 7 },
-      { from: "B", to: "C", cost: 3 },
-      { from: "C", to: "D", cost: 2 },
-      { from: "A", to: "E", cost: 1.5 },
-      { from: "E", to: "F", cost: 2 },
-      { from: "F", to: "G", cost: 3 },
-      { from: "G", to: "D", cost: 4 },
-    ],
-  }
-  const start = "A"
-  const end = "D"
-  const expectedResult = ["A", "E", "F", "G", "D"]
-
-  expect(findPath(graph, start, end)).toStrictEqual(expectedResult)
-})
-
-test("it should find the best path in a board graph", () => {
-  const rows = 5
-  const columns = 5
-  const size = [rows, columns]
-  const filler = (i, j) => ({ id: `${i}${j}`, position: [i, j] })
-  const board = createBoard(size, filler)
-
-  const graph = {
-    nodes: board,
-    arcs: [],
-  }
-
-  for (let i = 0; i < rows; i++) {
-    for (let j = 0; j < columns; j++) {
-      const current = `${i}${j}`
-      if (i + 1 < rows) {
-        graph.arcs.push({
-          from: current,
-          to: down([i, j], size).join(""),
-        })
-      }
-      if (j + 1 < columns) {
-        graph.arcs.push({
-          from: current,
-          to: right([i, j], size).join(""),
-        })
-      }
-      if (i + 1 < rows && j + 1 < columns) {
-        graph.arcs.push({
-          from: current,
-          to: downRight([i, j], size).join(""),
-        })
-      }
-    }
-  }
-
-  const start = "00"
-  const end = "44"
-  const expectedResult = ["00", "11", "22", "33", "44"]
-
-  expect(findPath(graph, start, end)).toStrictEqual(expectedResult)
-})