@stacksjs/arrays 0.58.48 → 0.58.49

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/arrays",
   "type": "module",
-  "version": "0.58.48",
+  "version": "0.58.49",
   "description": "The Stacks array utilities.",
   "author": "Chris Breuer",
   "license": "MIT",
@@ -40,7 +40,8 @@
   ],
   "files": [
     "README.md",
-    "dist"
+    "dist",
+    "src"
   ],
   "scripts": {
     "build": "bun --bun build.ts",

package/src/arr.ts

@@ -0,0 +1,3 @@
+export * from './helpers'
+export * from './math'
+export * from './contains'

package/src/contains.ts

@@ -0,0 +1,87 @@
+/**
+ * Returns true if the needle is contained in the haystack.
+ *
+ * @param needle
+ * @param haystack
+ * @example
+ * ```ts
+ * contains('foo', ['foo', 'bar']) // true
+ * contains('foo', ['bar']) // false
+ * ```
+ */
+export function contains(needle: string, haystack: string[]) {
+  return haystack.some(hay => needle.includes(hay))
+}
+
+/**
+ * Returns true if all needles are contained in the haystack.
+ * @param needles
+ * @param haystack
+ * @example
+ * ```ts
+ * containsAll(['foo', 'bar'], ['foo', 'bar', 'baz']) // true
+ * containsAll(['foo', 'bar'], ['foo', 'baz']) // false
+ * ```
+ */
+export function containsAll(needles: string[], haystack: string[]) {
+  return needles.every(needle => contains(needle, haystack))
+}
+
+/**
+ * Returns true if any needle is contained in the haystack.
+ * @param needles
+ * @param haystack
+ * @example
+ * ```ts
+ * containsAny(['foo', 'bar'], ['foo', 'bar', 'baz']) // true
+ * containsAny(['foo', 'bar'], ['foo', 'baz']) // true
+ * containsAny(['foo', 'bar'], ['baz']) // false
+ * ```
+ */
+export function containsAny(needles: string[], haystack: string[]) {
+  return needles.some(needle => contains(needle, haystack))
+}
+
+/**
+ * Returns true if none of the needles are contained in the haystack.
+ * @param needles
+ * @param haystack
+ * @example
+ * ```ts
+ * containsNone(['foo', 'bar'], ['foo', 'bar', 'baz']) // false
+ * containsNone(['foo', 'bar'], ['foo', 'baz']) // false
+ * containsNone(['foo', 'bar'], ['baz']) // true
+ * ```
+ */
+export function containsNone(needles: string[], haystack: string[]) {
+  return !containsAny(needles, haystack)
+}
+
+/**
+ * Returns true if all needles are contained in the haystack.
+ * @param needles
+ * @param haystack
+ * @example
+ * ```ts
+ * containsOnly(['foo', 'bar'], ['foo', 'bar', 'baz']) // false
+ * containsOnly(['foo', 'bar'], ['foo', 'baz']) // false
+ * containsOnly(['foo', 'bar'], ['foo', 'bar']) // true
+ * ```
+ */
+export function containsOnly(needles: string[], haystack: string[]) {
+  return containsAll(haystack, needles)
+}
+
+/**
+ * Returns true if the needle is not contained in the haystack.
+ * @param needle
+ * @param haystack
+ * @example
+ * ```ts
+ * doesNotContain('foo', ['foo', 'bar']) // false
+ * doesNotContain('foo', ['bar']) // true
+ * ```
+ */
+export function doesNotContain(needle: string, haystack: string[]) {
+  return !contains(needle, haystack)
+}

package/src/helpers.ts

@@ -0,0 +1,272 @@
+import type { Arrayable, Nullable } from '@stacksjs/types'
+import { clamp } from '@stacksjs/utils'
+
+/**
+ * Convert `Arrayable<T>` to `Array<T>`
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * toArray('foo') // ['foo']
+ * toArray(['foo']) // ['foo']
+ * toArray(null) // []
+ * toArray(undefined) // []
+ * toArray(1) // [1]
+ * toArray([1]) // [1]
+ * toArray({ foo: 'bar' }) // [{ foo: 'bar' }]
+ * toArray([{ foo: 'bar' }]) // [{ foo: 'bar' }]
+ * ```
+ */
+export function toArray<T>(array?: Nullable<Arrayable<T>>): Array<T> {
+  array = array ?? []
+  return Array.isArray(array) ? array : [array]
+}
+
+/**
+ * Flatten `Arrayable<T>` to `Array<T>`
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * flatten([1, [2, [3, [4, [5]]]]]) // [1, 2, 3, 4, 5]
+ * ```
+ */
+export function flatten<T>(array?: Nullable<Arrayable<T | Array<T>>>): Array<T> {
+  return toArray(array).flat(1) as Array<T>
+}
+
+/**
+ * Use rest arguments to merge arrays
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * mergeArrayable([1, 2], [3, 4], [5, 6]) // [1, 2, 3, 4, 5, 6]
+ * ```
+ */
+export function mergeArrayable<T>(...args: Nullable<Arrayable<T>>[]): Array<T> {
+  return args.flatMap(i => toArray(i))
+}
+
+export type PartitionFilter<T> = (i: T, idx: number, arr: readonly T[]) => any
+
+/**
+ * Divide an array into two parts by a filter function
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * const [odd, even] = partition([1, 2, 3, 4], i => i % 2 != 0)
+ * console.log(odd) // [1, 3]
+ * console.log(even) // [2, 4]
+ * ```
+ */
+export function partition<T>(array: readonly T[], f1: PartitionFilter<T>): [T[], T[]]
+export function partition<T>(array: readonly T[], f1: PartitionFilter<T>, f2: PartitionFilter<T>): [T[], T[], T[]]
+export function partition<T>(array: readonly T[], f1: PartitionFilter<T>, f2: PartitionFilter<T>, f3: PartitionFilter<T>): [T[], T[], T[], T[]]
+export function partition<T>(array: readonly T[], f1: PartitionFilter<T>, f2: PartitionFilter<T>, f3: PartitionFilter<T>, f4: PartitionFilter<T>): [T[], T[], T[], T[], T[]]
+export function partition<T>(array: readonly T[], f1: PartitionFilter<T>, f2: PartitionFilter<T>, f3: PartitionFilter<T>, f4: PartitionFilter<T>, f5: PartitionFilter<T>): [T[], T[], T[], T[], T[], T[]]
+export function partition<T>(array: readonly T[], f1: PartitionFilter<T>, f2: PartitionFilter<T>, f3: PartitionFilter<T>, f4: PartitionFilter<T>, f5: PartitionFilter<T>, f6: PartitionFilter<T>): [T[], T[], T[], T[], T[], T[], T[]]
+export function partition<T>(array: readonly T[], ...filters: PartitionFilter<T>[]): any {
+  const result: T[][] = Array.from({ length: filters.length + 1 }).fill(null).map(() => [])
+
+  array.forEach((e, idx, arr) => {
+    let i = 0
+    for (const filter of filters) {
+      if (filter(e, idx, arr)) {
+        result[i].push(e)
+        return
+      }
+      i += 1
+    }
+    result[i].push(e)
+  })
+  return result
+}
+
+/**
+ * Unique an Array
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * uniq([1, 2, 3, 3, 2, 1]) // [1, 2, 3]
+ * ```
+ */
+export function uniq<T>(array: readonly T[]): T[] {
+  return Array.from(new Set(array))
+}
+
+/**
+ * Unique an Array
+ *
+ * @param array
+ * @example
+ * ```ts
+ * unique([1, 2, 3, 3, 2, 1]) // [1, 2, 3]
+ * ```
+ */
+export function unique<T>(array: readonly T[]): T[] {
+  return uniq(array)
+}
+
+/**
+ * Unique an Array by a custom equality function
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * uniqueBy([1, 2, 3, 3, 2, 1], (a, b) => a === b) // [1, 2, 3]
+ * ```
+ */
+export function uniqueBy<T>(array: readonly T[], equalFn: (a: any, b: any) => boolean): T[] {
+  return array.reduce((acc: T[], cur: any) => {
+    const index = acc.findIndex((item: any) => equalFn(cur, item))
+    if (index === -1)
+      acc.push(cur)
+    return acc
+  }, [])
+}
+
+/**
+ * Get last item
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * last([1, 2, 3]) // 3
+ * ```
+ */
+export function last(array: readonly []): undefined
+export function last<T>(array: readonly T[]): T
+export function last<T>(array: readonly T[]): T | undefined {
+  return at(array, -1)
+}
+
+/**
+ * Remove an item from Array
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * const arr = [1, 2, 3]
+ * remove(arr, 2) // true
+ * Arr.remove(arr, 4) // false
+ * console.log(arr) // [1, 3]
+ */
+export function remove<T>(array: T[], value: T) {
+  if (!array)
+    return false
+
+  const index = array.indexOf(value)
+  if (index >= 0) {
+    array.splice(index, 1)
+    return true
+  }
+
+  return false
+}
+
+/**
+ * Get nth item of Array. Negative for backward
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * at([1, 2, 3], 1) // 2
+ * at([1, 2, 3], -1) // 3
+ * at([1, 2, 3], 3) // undefined
+ * at([1, 2, 3], -4) // undefined
+ * ```
+ */
+export function at(array: readonly [], index: number): undefined
+export function at<T>(array: readonly T[], index: number): T
+export function at<T>(array: readonly T[] | [], index: number): T | undefined {
+  const len = array.length
+  if (!len)
+    return undefined
+
+  if (index < 0)
+    index += len
+
+  return array[index]
+}
+
+/**
+ * Move an item from one index to another
+ * @param array
+ * @param from
+ * @param to
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * move([1, 2, 3, 4], 0, 2) // [2, 3, 1, 4]
+ * move([1, 2, 3, 4], 0, -1) // [2, 3, 4, 1]
+ * move([1, 2, 3, 4], -1, 0) // [4, 1, 2, 3]
+ * move([1, 2, 3, 4], -1, -2) // [1, 4, 2, 3]
+ * move([1, 2, 3, 4], 1, 1) // [1, 2, 3, 4]
+ * ```
+ */
+export function move<T>(array: T[], from: number, to: number): T[] {
+  const len = array.length
+  if (!len)
+    return []
+
+  if (from < 0)
+    from += len
+
+  if (to < 0)
+    to += len
+
+  const item = array.splice(from, 1)[0]
+  array.splice(to, 0, item)
+  return array
+}
+
+/**
+ * Clamp a number to the index range of an array.
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * clampArrayRange([1, 2, 3], 0) // 0
+ * clampArrayRange([1, 2, 3], 1) // 1
+ * clampArrayRange([1, 2, 3], 2) // 2
+ * clampArrayRange([1, 2, 3], 3) // 2
+ * clampArrayRange([1, 2, 3], 4) // 2
+ * clampArrayRange([1, 2, 3], -1) // 0
+ */
+export function clampArrayRange(arr: readonly unknown[], n: number) {
+  return clamp(n, 0, arr.length - 1)
+}
+
+/**
+ * Get random items from an array
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * sample([1, 2, 3, 4], 2) // [2, 3]
+ * ```
+ */
+export function sample<T>(arr: T[], count: number) {
+  return Array.from({ length: count }, _ => arr[Math.round(Math.random() * (arr.length - 1))])
+}
+
+/**
+ * Shuffle an array. This function mutates the array.
+ *
+ * @category Array
+ * @example
+ * ```ts
+ * shuffle([1, 2, 3, 4]) // [2, 4, 1, 3]
+ * ```
+ */
+export function shuffle<T>(array: T[]): T[] {
+  for (let i = array.length - 1; i > 0; i--) {
+    const j = Math.floor(Math.random() * (i + 1));
+    [array[i], array[j]] = [array[j], array[i]]
+  }
+  return array
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './arr'
+export * as arr from './arr'
+export * from './macro'

package/src/macro.ts

@@ -0,0 +1,131 @@
+import type { Arrayable, Nullable } from '@stacksjs/types'
+import type { PartitionFilter } from './helpers'
+import { at, clampArrayRange, flatten, last, mergeArrayable, move, partition, remove, sample, shuffle, toArray, uniq, uniqueBy } from './helpers'
+import { average, median, mode, range, sum } from './math'
+import { contains, containsAll, containsAny, containsNone, containsOnly, doesNotContain } from './contains'
+
+export const Arr = {
+  contains(needle: string, haystack: string[]) {
+    return contains(needle, haystack)
+  },
+
+  containsAll(needles: string[], haystack: string[]) {
+    return containsAll(needles, haystack)
+  },
+
+  containsAny(needles: string[], haystack: string[]) {
+    return containsAny(needles, haystack)
+  },
+
+  containsNone(needles: string[], haystack: string[]) {
+    return containsNone(needles, haystack)
+  },
+
+  containsOnly(needles: string[], haystack: string[]) {
+    return containsOnly(needles, haystack)
+  },
+
+  doesNotContain(needle: string, haystack: string[]) {
+    return doesNotContain(needle, haystack)
+  },
+
+  toArray<T>(array?: Nullable<Arrayable<T>>): Array<T> {
+    return toArray(array)
+  },
+
+  flatten<T>(array?: Nullable<Arrayable<T | Array<T>>>): Array<T> {
+    return flatten(array)
+  },
+
+  mergeArrayable<T>(...args: Nullable<Arrayable<T>>[]): Array<T> {
+    return mergeArrayable(...args)
+  },
+
+  partition<T>(array: readonly T[], filter: PartitionFilter<T>): [T[], T[]] {
+    return partition(array, filter)
+  },
+
+  /**
+   * Returns a random item/s from the array
+   */
+  random<T>(arr: T[], count = 1): T[] {
+    return sample(arr, count)
+  },
+
+  /**
+   * Returns random item/s from the array
+   */
+  sample<T>(arr: T[], count = 1): T[] {
+    return sample(arr, count)
+  },
+
+  unique<T>(arr: T[]): T[] {
+    return uniq(arr)
+  },
+
+  uniqueBy<T>(arr: readonly T[], equalFn: (a: any, b: any) => boolean): T[] {
+    return uniqueBy(arr, equalFn)
+  },
+
+  last<T>(arr: T[]): T | undefined {
+    return last(arr)
+  },
+
+  remove<T>(arr: T[], value: T) {
+    return remove(arr, value)
+  },
+
+  at(arr: any[], index: number): any {
+    return at(arr, index)
+  },
+
+  range(arr: readonly number[]): number {
+    return range(arr)
+  },
+
+  move<T>(arr: T[], from: number, to: number): T[] {
+    return move(arr, from, to)
+  },
+
+  clampArrayRange(arr: readonly unknown[], n: number) {
+    return clampArrayRange(arr, n)
+  },
+
+  shuffle<T>(arr: T[]): T[] {
+    return shuffle(arr)
+  },
+
+  /**
+   * Returns the sum of all items in the array
+   */
+  sum(arr: number[]): number {
+    return sum(arr)
+  },
+
+  /**
+   * Returns the average of all items in the array
+   */
+  average(arr: number[]): number {
+    return average(arr)
+  },
+
+  avg(arr: number[]): number {
+    return average(arr)
+  },
+
+  /**
+   * Returns the median of all items in the array
+   */
+  median(arr: number[]): number {
+    return median(arr)
+  },
+
+  /**
+   * Returns the mode of all items in the array
+   */
+  mode(arr: number[]): number {
+    return mode(arr)
+  },
+}
+
+export const arr = Arr

package/src/math.ts

@@ -0,0 +1,220 @@
+/**
+ * Returns the average of an array of numbers
+ * @param arr
+ * @category Array
+ * @example
+ * ```ts
+ * average([1, 2, 3, 4]) // 2.5
+ * ```
+ */
+export function average(arr: number[]): number {
+  return sum(arr) / arr.length
+}
+
+/**
+ * Returns the average of an array of numbers
+ * @param arr
+ * @category Array
+ * @example
+ * ```ts
+ * avg([1, 2, 3, 4]) // 2.5
+ * ```
+ */
+export function avg(arr: number[]): number {
+  return average(arr)
+}
+
+/**
+ * Returns the median of an array of numbers
+ * @param arr
+ * @category Array
+ * @example
+ * ```ts
+ * median([1, 2, 3, 4]) // 2.5
+ * ```
+ */
+export function median(arr: number[]): number {
+  return arr[Math.floor(arr.length / 2)]
+}
+
+/**
+ * Returns the mode of an array of numbers
+ * @param arr
+ * @category Array
+ * @example
+ * ```ts
+ * mode([1, 2, 3, 4]) // 1
+ * mode([1, 2, 2, 3, 4]) // 2
+ * mode([1, 2, 2, 3, 3, 4]) // 2
+ * mode([1, 2, 2, 3, 3, 4, 4]) // 2
+ * mode([1, 2, 2, 3, 3, 4, 4, 4]) // 4
+ * ```
+ */
+export function mode(arr: number[]): number {
+  return arr.sort((a, b) => arr.filter(v => v === a).length - arr.filter(v => v === b).length).pop()!
+}
+
+/**
+ * Returns the sum of an array of numbers
+ * @param array
+ * @category Array
+ * @example
+ * ```ts
+ * sum([1, 2, 3, 4]) // 10
+ * ```
+ */
+export function sum(array: readonly number[]): number {
+  return array.reduce((acc, cur) => acc + cur, 0)
+}
+
+/**
+ * Returns the product of an array of numbers
+ * @param array
+ * @category Array
+ * @example
+ * ```ts
+ * product([1, 2, 3, 4]) // 24
+ * ```
+ */
+export function product(array: readonly number[]): number {
+  return array.reduce((acc, cur) => acc * cur, 1)
+}
+
+/**
+ * Returns the minimum value of an array of numbers
+ * @param array
+ * @category Array
+ * @example
+ * ```ts
+ * min([1, 2, 3, 4]) // 1
+ * min([1, 2, 3, 4, -1]) // -1
+ * ```
+ */
+export function min(array: readonly number[]): number {
+  return Math.min(...array)
+}
+
+/**
+ * Returns the maximum value of an array of numbers
+ * @param array
+ * @category Array
+ * @example
+ * ```ts
+ * max([1, 2, 3, 4]) // 4
+ * max([1, 2, 3, 4, -1]) // 4
+ * ```
+ */
+export function max(array: readonly number[]): number {
+  return Math.max(...array)
+}
+
+/**
+ * Returns the range of an array of numbers
+ * @param array
+ * @category Array
+ * @example
+ * ```ts
+ * range([1, 2, 3, 4]) // 3
+ * range([1, 2, 3, 4, -1]) // 5
+ * range([1, 2, 3, 4, -1, 10]) // 11
+ * ```
+ */
+export function range(array: readonly number[]): number {
+  return max(array) - min(array)
+}
+
+/**
+ * Returns the variance of an array of numbers
+ * @param array
+ * @category Array
+ * @example
+ * ```ts
+ * variance([1, 2, 3, 4]) // 1.25
+ * ```
+ * @see https://en.wikipedia.org/wiki/Variance
+ */
+export function variance(array: number[]): number {
+  const mean = average(array)
+  return average(array.map(num => (num - mean) ** 2))
+}
+
+/**
+ * Returns the standard deviation of an array of numbers
+ * @param array
+ * @category Array
+ * @example
+ * ```ts
+ * standardDeviation([1, 2, 3, 4]) // 1.118033988749895
+ * ```
+ * @see https://en.wikipedia.org/wiki/Standard_deviation
+ * @see https://stackoverflow.com/questions/7343890/standard-deviation-javascript
+ */
+export function standardDeviation(array: number[]): number {
+  return Math.sqrt(variance(array))
+}
+
+/**
+ * Returns the z-score of a number in an array of numbers
+ * @param array
+ * @param num
+ * @category Array
+ * @example
+ * ```ts
+ * zScore([1, 2, 3, 4], 2) // 0
+ * zScore([1, 2, 3, 4], 3) // 0.7071067811865475
+ * ```
+ * @see https://en.wikipedia.org/wiki/Standard_score
+ */
+export function zScore(array: number[], num: number): number {
+  return (num - average(array)) / standardDeviation(array)
+}
+
+/**
+ * Returns the percentile of a number in an array of numbers
+ * @param array
+ * @param num
+ * @category Array
+ * @example
+ * ```ts
+ * percentile([1, 2, 3, 4], 2) // 0.25
+ * percentile([1, 2, 3, 4], 3) // 0.75
+ * ```
+ * @see https://en.wikipedia.org/wiki/Percentile
+ */
+export function percentile(array: number[], num: number): number {
+  return array.filter(n => n < num).length / array.length
+}
+
+/**
+ * Returns the interquartile range of an array of numbers
+ * @param array
+ * @category Array
+ * @example
+ * ```ts
+ * interquartileRange([1, 2, 3, 4]) // 1.5
+ * ```
+ * @see https://en.wikipedia.org/wiki/Interquartile_range
+ * @see https://stackoverflow.com/questions/48719873/how-to-calculate-interquartile-range-in-javascript
+ */
+export function interquartileRange(array: number[]): number {
+  const q1 = median(array.slice(0, Math.floor(array.length / 2)))
+  const q3 = median(array.slice(Math.ceil(array.length / 2)))
+  return q3 - q1
+}
+
+/**
+ * Returns the covariance of two arrays of numbers
+ * @param array1
+ * @param array2
+ * @category Array
+ * @example
+ * ```ts
+ * covariance([1, 2, 3, 4], [1, 2, 3, 4]) // 1.25
+ * covariance([1, 2, 3, 4], [4, 3, 2, 1]) // -1.25
+ * ```
+ */
+export function covariance(array1: number[], array2: number[]): number {
+  const mean1 = average(array1)
+  const mean2 = average(array2)
+  return average(array1.map((num1, i) => (num1 - mean1) * (array2[i] - mean2)))
+}