@inglorious/engine 0.1.0 → 0.2.0

package/src/utils/data-structures/objects.js

@@ -1,48 +1,66 @@
-import { isObject } from "./object.js"
-
-/**
- * Extends a destination object by merging it with one or more source objects.
- * Performs a deep merge for nested objects and arrays.
- *
- * @param {Object} dest - The destination object to extend.
- * @param {...Object} sources - The source objects to merge into the destination object.
- * @returns {Object} - The extended destination object.
- */
-export function extend(dest, ...sources) {
-  return merge({}, dest, ...sources)
-}
-
-/**
- * Merges multiple source objects into a destination object.
- * Performs a deep merge for nested objects and arrays.
- *
- * @param {Object} dest - The destination object to merge into.
- * @param {...Object} sources - The source objects to merge from.
- * @returns {Object} - The merged destination object.
- */
-export function merge(dest, ...sources) {
-  return sources
-    .filter((source) => source != null)
-    .reduce((acc, source) => deepMerge(acc, source), dest)
-}
-
-/**
- * Recursively merges the properties of the source object into the destination object.
- *
- * @param {Object} dest - The destination object to merge into.
- * @param {Object} source - The source object to merge from.
- * @returns {Object} - The merged destination object.
- */
-function deepMerge(dest, source) {
-  for (const [key, value] of Object.entries(source)) {
-    if (Array.isArray(value) || isObject(value)) {
-      if (dest[key] === undefined) {
-        dest[key] = new value.__proto__.constructor()
-      }
-      dest[key] = deepMerge(dest[key], value)
-    } else {
-      dest[key] = value
-    }
-  }
-  return dest
-}
+import { isObject } from "./object.js"
+
+/**
+ * Extends a target object by merging it with one or more source objects.
+ * Performs a deep merge for nested objects and arrays.
+ *
+ * @param {Object} target - The target object to extend.
+ * @param {...Object} sources - The source objects to merge into the target object.
+ * @returns {Object} - The extended target object.
+ */
+export function extend(target, ...sources) {
+  return merge({}, target, ...sources)
+}
+
+/**
+ * Merges multiple source objects into a target object.
+ * Performs a deep merge for nested objects and arrays.
+ *
+ * @param {Object} target - The target object to merge into.
+ * @param {...Object} sources - The source objects to merge from.
+ * @returns {Object} - The merged target object.
+ */
+export function merge(target, ...sources) {
+  return sources
+    .filter((source) => source != null)
+    .reduce((acc, source) => deepMerge(acc, source), target)
+}
+
+/**
+ * Recursively merges the properties of the source object into the target object.
+ *
+ * @param {Object} target - The target object to merge into.
+ * @param {Object} source - The source object to merge from.
+ * @returns {Object} - The merged target object.
+ */
+function deepMerge(target, source) {
+  for (const [key, value] of Object.entries(source)) {
+    if (Array.isArray(value) || isObject(value)) {
+      if (target[key] === undefined) {
+        target[key] = new value.__proto__.constructor()
+      }
+      target[key] = deepMerge(target[key], value)
+    } else {
+      target[key] = value
+    }
+  }
+  return target
+}
+
+/**
+ * Assigns default properties to a target object from a source object.
+ * For each key in `defaultProps`, if `target[key]` is `null` or `undefined`,
+ * it is set to `defaultProps[key]`.
+ *
+ * This function modifies the target object in place.
+ *
+ * @param {Object} target The object to apply defaults to.
+ * @param {Object} defaultProps The object containing the default properties.
+ * @returns {Object} The modified target object.
+ */
+export function defaults(target, defaultProps) {
+  for (const key in defaultProps) {
+    target[key] ??= defaultProps[key]
+  }
+  return target
+}

package/src/utils/data-structures/objects.test.js

@@ -1,99 +1,99 @@
-import { expect, test } from "vitest"
-
-import { extend, merge } from "./objects.js"
-
-test("it should extend an object with another, producing a new object as a result", () => {
-  const obj1 = {
-    primitiveKept: 1,
-    primitiveMerged: 2,
-    primitiveArrayKept: [1, 2],
-    primitiveArrayMerged: [3, 4],
-    primitiveObjectKept: { a: 1 },
-    primitiveObjectMerged: { b: 2, c: 3 },
-    nestedArrayKept: [{ a: 1 }],
-    nestedArrayMerged: [{ b: 2, c: 3 }],
-    nestedObjectKept: { a: { b: 2 } },
-    nestedObjectMerged: { c: { d: 4 } },
-  }
-  const obj2 = {
-    primitiveMerged: 3,
-    primitiveAdded: 4,
-    primitiveArrayMerged: [5],
-    primitiveArrayAdded: [6, 7],
-    primitiveObjectMerged: { c: 4 },
-    primitiveObjectAdded: { d: 4 },
-    nestedArrayMerged: [{ d: 4 }],
-    nestedArrayAdded: [{ e: 5 }],
-    nestedObjectMerged: { c: { e: 5 } },
-    nestedObjectAdded: { f: { g: 7 } },
-  }
-  const expectedResult = {
-    primitiveKept: 1,
-    primitiveMerged: 3,
-    primitiveAdded: 4,
-    primitiveArrayKept: [1, 2],
-    primitiveArrayMerged: [5, 4],
-    primitiveArrayAdded: [6, 7],
-    primitiveObjectKept: { a: 1 },
-    primitiveObjectMerged: { b: 2, c: 4 },
-    primitiveObjectAdded: { d: 4 },
-    nestedArrayKept: [{ a: 1 }],
-    nestedArrayMerged: [{ b: 2, c: 3, d: 4 }],
-    nestedArrayAdded: [{ e: 5 }],
-    nestedObjectKept: { a: { b: 2 } },
-    nestedObjectMerged: { c: { d: 4, e: 5 } },
-    nestedObjectAdded: { f: { g: 7 } },
-  }
-
-  const result = extend(obj1, obj2)
-  expect(result).toStrictEqual(expectedResult)
-  expect(result).not.toBe(obj1)
-})
-
-test("it should deep merge an two objects, changing the first object in place", () => {
-  const obj1 = {
-    primitiveKept: 1,
-    primitiveMerged: 2,
-    primitiveArrayKept: [1, 2],
-    primitiveArrayMerged: [3, 4],
-    primitiveObjectKept: { a: 1 },
-    primitiveObjectMerged: { b: 2, c: 3 },
-    nestedArrayKept: [{ a: 1 }],
-    nestedArrayMerged: [{ b: 2, c: 3 }],
-    nestedObjectKept: { a: { b: 2 } },
-    nestedObjectMerged: { c: { d: 4 } },
-  }
-  const obj2 = {
-    primitiveMerged: 3,
-    primitiveAdded: 4,
-    primitiveArrayMerged: [5],
-    primitiveArrayAdded: [6, 7],
-    primitiveObjectMerged: { c: 4 },
-    primitiveObjectAdded: { d: 4 },
-    nestedArrayMerged: [{ d: 4 }],
-    nestedArrayAdded: [{ e: 5 }],
-    nestedObjectMerged: { c: { e: 5 } },
-    nestedObjectAdded: { f: { g: 7 } },
-  }
-  const expectedResult = {
-    primitiveKept: 1,
-    primitiveMerged: 3,
-    primitiveAdded: 4,
-    primitiveArrayKept: [1, 2],
-    primitiveArrayMerged: [5, 4],
-    primitiveArrayAdded: [6, 7],
-    primitiveObjectKept: { a: 1 },
-    primitiveObjectMerged: { b: 2, c: 4 },
-    primitiveObjectAdded: { d: 4 },
-    nestedArrayKept: [{ a: 1 }],
-    nestedArrayMerged: [{ b: 2, c: 3, d: 4 }],
-    nestedArrayAdded: [{ e: 5 }],
-    nestedObjectKept: { a: { b: 2 } },
-    nestedObjectMerged: { c: { d: 4, e: 5 } },
-    nestedObjectAdded: { f: { g: 7 } },
-  }
-
-  const result = merge(obj1, obj2)
-  expect(result).toStrictEqual(expectedResult)
-  expect(result).toBe(obj1)
-})
+import { expect, test } from "vitest"
+
+import { extend, merge } from "./objects.js"
+
+test("it should extend an object with another, producing a new object as a result", () => {
+  const obj1 = {
+    primitiveKept: 1,
+    primitiveMerged: 2,
+    primitiveArrayKept: [1, 2],
+    primitiveArrayMerged: [3, 4],
+    primitiveObjectKept: { a: 1 },
+    primitiveObjectMerged: { b: 2, c: 3 },
+    nestedArrayKept: [{ a: 1 }],
+    nestedArrayMerged: [{ b: 2, c: 3 }],
+    nestedObjectKept: { a: { b: 2 } },
+    nestedObjectMerged: { c: { d: 4 } },
+  }
+  const obj2 = {
+    primitiveMerged: 3,
+    primitiveAdded: 4,
+    primitiveArrayMerged: [5],
+    primitiveArrayAdded: [6, 7],
+    primitiveObjectMerged: { c: 4 },
+    primitiveObjectAdded: { d: 4 },
+    nestedArrayMerged: [{ d: 4 }],
+    nestedArrayAdded: [{ e: 5 }],
+    nestedObjectMerged: { c: { e: 5 } },
+    nestedObjectAdded: { f: { g: 7 } },
+  }
+  const expectedResult = {
+    primitiveKept: 1,
+    primitiveMerged: 3,
+    primitiveAdded: 4,
+    primitiveArrayKept: [1, 2],
+    primitiveArrayMerged: [5, 4],
+    primitiveArrayAdded: [6, 7],
+    primitiveObjectKept: { a: 1 },
+    primitiveObjectMerged: { b: 2, c: 4 },
+    primitiveObjectAdded: { d: 4 },
+    nestedArrayKept: [{ a: 1 }],
+    nestedArrayMerged: [{ b: 2, c: 3, d: 4 }],
+    nestedArrayAdded: [{ e: 5 }],
+    nestedObjectKept: { a: { b: 2 } },
+    nestedObjectMerged: { c: { d: 4, e: 5 } },
+    nestedObjectAdded: { f: { g: 7 } },
+  }
+
+  const result = extend(obj1, obj2)
+  expect(result).toStrictEqual(expectedResult)
+  expect(result).not.toBe(obj1)
+})
+
+test("it should deep merge an two objects, changing the first object in place", () => {
+  const obj1 = {
+    primitiveKept: 1,
+    primitiveMerged: 2,
+    primitiveArrayKept: [1, 2],
+    primitiveArrayMerged: [3, 4],
+    primitiveObjectKept: { a: 1 },
+    primitiveObjectMerged: { b: 2, c: 3 },
+    nestedArrayKept: [{ a: 1 }],
+    nestedArrayMerged: [{ b: 2, c: 3 }],
+    nestedObjectKept: { a: { b: 2 } },
+    nestedObjectMerged: { c: { d: 4 } },
+  }
+  const obj2 = {
+    primitiveMerged: 3,
+    primitiveAdded: 4,
+    primitiveArrayMerged: [5],
+    primitiveArrayAdded: [6, 7],
+    primitiveObjectMerged: { c: 4 },
+    primitiveObjectAdded: { d: 4 },
+    nestedArrayMerged: [{ d: 4 }],
+    nestedArrayAdded: [{ e: 5 }],
+    nestedObjectMerged: { c: { e: 5 } },
+    nestedObjectAdded: { f: { g: 7 } },
+  }
+  const expectedResult = {
+    primitiveKept: 1,
+    primitiveMerged: 3,
+    primitiveAdded: 4,
+    primitiveArrayKept: [1, 2],
+    primitiveArrayMerged: [5, 4],
+    primitiveArrayAdded: [6, 7],
+    primitiveObjectKept: { a: 1 },
+    primitiveObjectMerged: { b: 2, c: 4 },
+    primitiveObjectAdded: { d: 4 },
+    nestedArrayKept: [{ a: 1 }],
+    nestedArrayMerged: [{ b: 2, c: 3, d: 4 }],
+    nestedArrayAdded: [{ e: 5 }],
+    nestedObjectKept: { a: { b: 2 } },
+    nestedObjectMerged: { c: { d: 4, e: 5 } },
+    nestedObjectAdded: { f: { g: 7 } },
+  }
+
+  const result = merge(obj1, obj2)
+  expect(result).toStrictEqual(expectedResult)
+  expect(result).toBe(obj1)
+})

package/src/utils/data-structures/tree.js

@@ -1,36 +1,36 @@
-/** @typedef {import('./types').Tree} Tree */
-
-/**
- * Performs a breadth-first search (BFS) traversal on a tree structure.
- * @param {Tree} tree - The root node of the tree.
- * @returns {Array} An array of values in BFS order.
- */
-export function bfs(tree) {
-  const result = []
-  const queue = [tree]
-
-  while (queue.length) {
-    const node = queue.shift()
-    result.push(node.value)
-    if (node.children) {
-      queue.push(...node.children)
-    }
-  }
-
-  return result
-}
-
-/**
- * Performs a depth-first search (DFS) traversal on a tree structure.
- * @param {Tree} tree - The root node of the tree.
- * @returns {Array} An array of values in DFS order.
- */
-export function dfs(tree) {
-  const result = [tree.value]
-
-  if (tree.children) {
-    result.push(...tree.children.flatMap(dfs))
-  }
-
-  return result
-}
+/** @typedef {import('./types').Tree} Tree */
+
+/**
+ * Performs a breadth-first search (BFS) traversal on a tree structure.
+ * @param {Tree} tree - The root node of the tree.
+ * @returns {Array} An array of values in BFS order.
+ */
+export function bfs(tree) {
+  const result = []
+  const queue = [tree]
+
+  while (queue.length) {
+    const node = queue.shift()
+    result.push(node.value)
+    if (node.children) {
+      queue.push(...node.children)
+    }
+  }
+
+  return result
+}
+
+/**
+ * Performs a depth-first search (DFS) traversal on a tree structure.
+ * @param {Tree} tree - The root node of the tree.
+ * @returns {Array} An array of values in DFS order.
+ */
+export function dfs(tree) {
+  const result = [tree.value]
+
+  if (tree.children) {
+    result.push(...tree.children.flatMap(dfs))
+  }
+
+  return result
+}

package/src/utils/data-structures/tree.test.js

@@ -1,33 +1,33 @@
-import { expect, test } from "vitest"
-
-import { bfs, dfs } from "./tree.js"
-
-test("it should perform Breadth-First Search on a tree", () => {
-  const tree = {
-    value: 1,
-    children: [
-      { value: 2, children: [{ value: 4 }, { value: 5 }] },
-      { value: 3, children: [{ value: 6 }, { value: 7 }] },
-    ],
-  }
-  const expectedResult = [1, 2, 3, 4, 5, 6, 7]
-
-  const result = bfs(tree)
-
-  expect(result).toStrictEqual(expectedResult)
-})
-
-test("it should perform Depth-First Search on a tree", () => {
-  const tree = {
-    value: 1,
-    children: [
-      { value: 2, children: [{ value: 3 }, { value: 4 }] },
-      { value: 5, children: [{ value: 6 }, { value: 7 }] },
-    ],
-  }
-  const expectedResult = [1, 2, 3, 4, 5, 6, 7]
-
-  const result = dfs(tree)
-
-  expect(result).toStrictEqual(expectedResult)
-})
+import { expect, test } from "vitest"
+
+import { bfs, dfs } from "./tree.js"
+
+test("it should perform Breadth-First Search on a tree", () => {
+  const tree = {
+    value: 1,
+    children: [
+      { value: 2, children: [{ value: 4 }, { value: 5 }] },
+      { value: 3, children: [{ value: 6 }, { value: 7 }] },
+    ],
+  }
+  const expectedResult = [1, 2, 3, 4, 5, 6, 7]
+
+  const result = bfs(tree)
+
+  expect(result).toStrictEqual(expectedResult)
+})
+
+test("it should perform Depth-First Search on a tree", () => {
+  const tree = {
+    value: 1,
+    children: [
+      { value: 2, children: [{ value: 3 }, { value: 4 }] },
+      { value: 5, children: [{ value: 6 }, { value: 7 }] },
+    ],
+  }
+  const expectedResult = [1, 2, 3, 4, 5, 6, 7]
+
+  const result = dfs(tree)
+
+  expect(result).toStrictEqual(expectedResult)
+})

package/src/utils/functions/functions.js

@@ -1,19 +1,19 @@
-/**
- * Composes multiple functions from right to left, as if every function wraps the next one.
- *
- * @param {...Function} fns - Functions to compose.
- * @returns {Function} A function that takes an initial value and applies the composed functions.
- */
-export function compose(...fns) {
-  return (x) => fns.reduceRight((acc, fn) => fn(acc), x)
-}
-
-/**
- * Pipes multiple functions from left to right, as if the functions are applied one by one.
- *
- * @param {...Function} fns - Functions to pipe.
- * @returns {Function} A function that takes an initial value and applies the piped functions.
- */
-export function pipe(...fns) {
-  return (x) => fns.reduce((acc, fn) => fn(acc), x)
-}
+/**
+ * Composes multiple functions from right to left, as if every function wraps the next one.
+ *
+ * @param {...Function} fns - Functions to compose.
+ * @returns {Function} A function that takes an initial value and applies the composed functions.
+ */
+export function compose(...fns) {
+  return (x) => fns.reduceRight((acc, fn) => fn(acc), x)
+}
+
+/**
+ * Pipes multiple functions from left to right, as if the functions are applied one by one.
+ *
+ * @param {...Function} fns - Functions to pipe.
+ * @returns {Function} A function that takes an initial value and applies the piped functions.
+ */
+export function pipe(...fns) {
+  return (x) => fns.reduce((acc, fn) => fn(acc), x)
+}

package/src/utils/functions/functions.test.js

@@ -1,23 +1,23 @@
-import { expect, test } from "vitest"
-
-import { compose, pipe } from "./functions.js"
-
-test("it should compose functions", () => {
-  const shout = (x) => x.toUpperCase()
-  const punctuate = (mark) => (x) => `${x}${mark}`
-  const html = (tag) => (x) => `<${tag}>${x}</${tag}>`
-
-  const fn = compose(html("p"), punctuate("!"), shout)
-
-  expect(fn("Hello world")).toBe("<p>HELLO WORLD!</p>")
-})
-
-test("it should pipe functions", () => {
-  const shout = (x) => x.toUpperCase()
-  const punctuate = (mark) => (x) => `${x}${mark}`
-  const html = (tag) => (x) => `<${tag}>${x}</${tag}>`
-
-  const fn = pipe(shout, punctuate("!"), html("p"))
-
-  expect(fn("Hello world")).toBe("<p>HELLO WORLD!</p>")
-})
+import { expect, test } from "vitest"
+
+import { compose, pipe } from "./functions.js"
+
+test("it should compose functions", () => {
+  const shout = (x) => x.toUpperCase()
+  const punctuate = (mark) => (x) => `${x}${mark}`
+  const html = (tag) => (x) => `<${tag}>${x}</${tag}>`
+
+  const fn = compose(html("p"), punctuate("!"), shout)
+
+  expect(fn("Hello world")).toBe("<p>HELLO WORLD!</p>")
+})
+
+test("it should pipe functions", () => {
+  const shout = (x) => x.toUpperCase()
+  const punctuate = (mark) => (x) => `${x}${mark}`
+  const html = (tag) => (x) => `<${tag}>${x}</${tag}>`
+
+  const fn = pipe(shout, punctuate("!"), html("p"))
+
+  expect(fn("Hello world")).toBe("<p>HELLO WORLD!</p>")
+})