common-fp 0.1.0

package/dist/index.mjs

@@ -0,0 +1,158 @@
+export { default as add } from './add.mjs'
+export { default as all } from './all.mjs'
+export { default as alter } from './alter.mjs'
+export { default as any } from './any.mjs'
+export { default as append } from './append.mjs'
+export { default as appendAll } from './append-all.mjs'
+export { default as appendOne } from './append-one.mjs'
+export { default as assignDefaults } from './assign-defaults.mjs'
+export { default as assignOverrides } from './assign-overrides.mjs'
+export { default as compareByPath } from './compare-by-path.mjs'
+export { default as compareByProp } from './compare-by-prop.mjs'
+export { default as compose } from './compose.mjs'
+export { default as containedIn } from './contained-in.mjs'
+export { default as contains } from './contains.mjs'
+export { default as dateIsBetween } from './date-is-between.mjs'
+export { default as defaultFalseyValTo } from './default-falsey-val-to.mjs'
+export { default as defaultNullishValTo } from './default-nullish-val-to.mjs'
+export { default as discard } from './discard.mjs'
+export { default as discardFirst } from './discard-first.mjs'
+export { default as discardFirstWhile } from './discard-first-while.mjs'
+export { default as discardLast } from './discard-last.mjs'
+export { default as discardLastWhile } from './discard-last-while.mjs'
+export { default as discardRange } from './discard-range.mjs'
+export { default as discardWhen } from './discard-when.mjs'
+export { default as divideBy } from './divide-by.mjs'
+export { default as endsWith } from './ends-with.mjs'
+export { default as expand } from './expand.mjs'
+export { default as expandEnd } from './expand-end.mjs'
+export { default as expandStart } from './expand-start.mjs'
+export { default as fillRangeWith } from './fill-range-with.mjs'
+export { default as fillWith } from './fill-with.mjs'
+export { default as find } from './find.mjs'
+export { default as findKey } from './find-key.mjs'
+export { default as findKeyWithVal } from './find-key-with-val.mjs'
+export { default as findLast } from './find-last.mjs'
+export { default as findLastKey } from './find-last-key.mjs'
+export { default as findLastKeyWithVal } from './find-last-key-with-val.mjs'
+export { default as first } from './first.mjs'
+export { default as flattenFully } from './flatten-fully.mjs'
+export { default as flattenOnce } from './flatten-once.mjs'
+export { default as flattenToDepth } from './flatten-to-depth.mjs'
+export { default as forEach } from './for-each.mjs'
+export { default as get } from './get.mjs'
+export { default as getAtPath } from './get-at-path.mjs'
+export { default as getAverageValue } from './get-average-value.mjs'
+export { default as getCommonValues } from './get-common-values.mjs'
+export { default as getExclusiveValues } from './get-exclusive-values.mjs'
+export { default as getKeys } from './get-keys.mjs'
+export { default as getMaxValue } from './get-max-value.mjs'
+export { default as getMinValue } from './get-min-value.mjs'
+export { default as getRandomValue } from './get-random-value.mjs'
+export { default as getSize } from './get-size.mjs'
+export { default as getValueAtMapKey } from './get-value-at-map-key.mjs'
+export { default as getValues } from './get-values.mjs'
+export { default as greaterThan } from './greater-than.mjs'
+export { default as greaterThanOrEqualTo } from './greater-than-or-equal-to.mjs'
+export { default as groupBy } from './group-by.mjs'
+export { default as invert } from './invert.mjs'
+export { default as invokeWith } from './invoke-with.mjs'
+export { default as isAfter } from './is-after.mjs'
+export { default as isAtOrAfter } from './is-at-or-after.mjs'
+export { default as isAtOrBefore } from './is-at-or-before.mjs'
+export { default as isBefore } from './is-before.mjs'
+export { default as isEmpty } from './is-empty.mjs'
+export { default as isFalsey } from './is-falsey.mjs'
+export { default as isLaden } from './is-laden.mjs'
+export { default as isTruthy } from './is-truthy.mjs'
+export { default as joinValues } from './join-values.mjs'
+export { default as keep } from './keep.mjs'
+export { default as keepFirst } from './keep-first.mjs'
+export { default as keepFirstWhile } from './keep-first-while.mjs'
+export { default as keepLast } from './keep-last.mjs'
+export { default as keepLastWhile } from './keep-last-while.mjs'
+export { default as keepRange } from './keep-range.mjs'
+export { default as keepWhen } from './keep-when.mjs'
+export { default as last } from './last.mjs'
+export { default as lessThan } from './less-than.mjs'
+export { default as lessThanOrEqualTo } from './less-than-or-equal-to.mjs'
+export { default as mapKeys } from './map-keys.mjs'
+export { default as mAppendAll } from './m-append-all.mjs'
+export { default as mAppendOne } from './m-append-one.mjs'
+export { default as mapValues } from './map-values.mjs'
+export { default as mAssignDefaults } from './m-assign-defaults.mjs'
+export { default as mAssignOverrides } from './m-assign-overrides.mjs'
+export { default as mDiscardFirst } from './m-discard-first.mjs'
+export { default as mDiscardFirstWhile } from './m-discard-first-while.mjs'
+export { default as mDiscardLast } from './m-discard-last.mjs'
+export { default as mDiscardLastWhile } from './m-discard-last-while.mjs'
+export { default as mDiscardRange } from './m-discard-range.mjs'
+export { default as mFillRangeWith } from './m-fill-range-with.mjs'
+export { default as mFillWith } from './m-fill-with.mjs'
+export { default as mKeepFirst } from './m-keep-first.mjs'
+export { default as mKeepFirstWhile } from './m-keep-first-while.mjs'
+export { default as mKeepLast } from './m-keep-last.mjs'
+export { default as mKeepLastWhile } from './m-keep-last-while.mjs'
+export { default as mKeepRange } from './m-keep-range.mjs'
+export { default as mMapValues } from './m-map-values.mjs'
+export { default as mOmit } from './m-omit.mjs'
+export { default as mOrder } from './m-order.mjs'
+export { default as mPick } from './m-pick.mjs'
+export { default as mPrependAll } from './m-prepend-all.mjs'
+export { default as mPrependOne } from './m-prepend-one.mjs'
+export { default as mReverse } from './m-reverse.mjs'
+export { default as mSet } from './m-set.mjs'
+export { default as mSetAtPath } from './m-set-at-path.mjs'
+export { default as mShuffle } from './m-shuffle.mjs'
+export { default as multiplyBy } from './multiply-by.mjs'
+export { default as mUpdate } from './m-update.mjs'
+export { default as negate } from './negate.mjs'
+export { default as numberIsBetween } from './number-is-between.mjs'
+export { default as omit } from './omit.mjs'
+export { default as order } from './order.mjs'
+export { default as pAll } from './p-all.mjs'
+export { default as pAny } from './p-any.mjs'
+export { default as passThrough } from './pass-through.mjs'
+export { default as pCompose } from './p-compose.mjs'
+export { default as pDiscardWhen } from './p-discard-when.mjs'
+export { default as peek } from './peek.mjs'
+export { default as pFind } from './p-find.mjs'
+export { default as pForEach } from './p-for-each.mjs'
+export { default as pick } from './pick.mjs'
+export { default as pKeepWhen } from './p-keep-when.mjs'
+export { default as pMapValues } from './p-map-values.mjs'
+export { default as pPassThrough } from './p-pass-through.mjs'
+export { default as prepend } from './prepend.mjs'
+export { default as prependAll } from './prepend-all.mjs'
+export { default as prependOne } from './prepend-one.mjs'
+export { default as pResolveValues } from './p-resolve-values.mjs'
+export { default as prune } from './prune.mjs'
+export { default as pruneEnd } from './prune-end.mjs'
+export { default as pruneStart } from './prune-start.mjs'
+export { default as pWaitMs } from './p-wait-ms.mjs'
+export { default as randomlyKeep } from './randomly-keep.mjs'
+export { default as replaceAllMatches } from './replace-all-matches.mjs'
+export { default as replaceFirstMatch } from './replace-first-match.mjs'
+export { default as returnFirstArg } from './return-first-arg.mjs'
+export { default as returnUndefined } from './return-undefined.mjs'
+export { default as reverse } from './reverse.mjs'
+export { default as roundToNearest } from './round-to-nearest.mjs'
+export { default as set } from './set.mjs'
+export { default as shuffle } from './shuffle.mjs'
+export { default as split } from './split.mjs'
+export { default as splitEvery } from './split-every.mjs'
+export { default as startsWith } from './starts-with.mjs'
+export { default as strictEquals } from './strict-equals.mjs'
+export { default as subtract } from './subtract.mjs'
+export { default as sumValues } from './sum-values.mjs'
+export { default as swapFirstTwoArgs } from './swap-first-two-args.mjs'
+export { default as transpose } from './transpose.mjs'
+export { default as truncateToNChars } from './truncate-to-n-chars.mjs'
+export { default as truncateToNLines } from './truncate-to-n-lines.mjs'
+export { default as update } from './update.mjs'
+export { default as withDatesAscending } from './with-dates-ascending.mjs'
+export { default as withDatesDescending } from './with-dates-descending.mjs'
+export { default as withNumbersAscending } from './with-numbers-ascending.mjs'
+export { default as withNumbersDescending } from './with-numbers-descending.mjs'
+export { default as withStringsAscending } from './with-strings-ascending.mjs'
+export { default as withStringsDescending } from './with-strings-descending.mjs'

package/dist/internal/contains-type-to-fn.cjs

@@ -0,0 +1,33 @@
+const containsTypeToFn = {
+  array: contains_includes,
+  map: contains_map,
+  object: contains_object,
+  set: contains_set,
+  string: contains_string,
+}
+
+function contains_includes(arr, val) {
+  return arr.includes(val)
+}
+
+function contains_map(aMap, val) {
+  for (const v of aMap.values()) {
+    if (v === val) return true
+  }
+
+  return false
+}
+
+function contains_object(obj, val) {
+  return Object.values(obj).includes(val)
+}
+
+function contains_set(aSet, val) {
+  return aSet.has(val)
+}
+
+function contains_string(str, val) {
+  return str.includes(val)
+}
+
+module.exports = containsTypeToFn

package/dist/internal/contains-type-to-fn.mjs

@@ -0,0 +1,33 @@
+const containsTypeToFn = {
+  array: contains_includes,
+  map: contains_map,
+  object: contains_object,
+  set: contains_set,
+  string: contains_string,
+}
+
+function contains_includes(arr, val) {
+  return arr.includes(val)
+}
+
+function contains_map(aMap, val) {
+  for (const v of aMap.values()) {
+    if (v === val) return true
+  }
+
+  return false
+}
+
+function contains_object(obj, val) {
+  return Object.values(obj).includes(val)
+}
+
+function contains_set(aSet, val) {
+  return aSet.has(val)
+}
+
+function contains_string(str, val) {
+  return str.includes(val)
+}
+
+export default containsTypeToFn

package/dist/internal/get-at-path.cjs

@@ -0,0 +1,12 @@
+module.exports = (path, anObject) => {
+  if (!path.length) return anObject
+
+  let result = anObject
+  for (const key of path) {
+    result = result?.[key]
+
+    if (result === undefined) return
+  }
+
+  return result
+}

package/dist/internal/get-at-path.mjs

@@ -0,0 +1,12 @@
+export default (path, anObject) => {
+  if (!path.length) return anObject
+
+  let result = anObject
+  for (const key of path) {
+    result = result?.[key]
+
+    if (result === undefined) return
+  }
+
+  return result
+}

package/dist/internal/validate-prune-arg.cjs

@@ -0,0 +1,43 @@
+const assertArgIsOneOfType = require('@common-fp/shared-internals/assert-arg-is-one-of-type')
+const ct = require('@common-fp/shared-internals/common-types')
+const getType = require('@common-fp/shared-internals/get-type')
+
+const validatePruneArg = pruneArg => {
+  assertArgIsOneOfType(pruneArg, 'pruneArg', ct.sequence, 'prune')
+
+  if (typeof pruneArg === 'string') {
+    if (pruneArg.length !== 1) {
+      let msg = 'when passing a string to prune it must be a single character'
+      msg +=
+        pruneArg.length ?
+          '\nif you want to prune all characters in the string, pass an array of chars instead'
+        : '\nan empty string was passed instead'
+      throw new Error(msg)
+    }
+  } else {
+    // pruneArg is array
+    let nonStringType
+    let nonCharLength
+    for (const el of pruneArg) {
+      if (typeof el !== 'string') {
+        nonStringType = getType(el)
+        break
+      }
+      if (el.length !== 1) {
+        nonCharLength = el.length
+        break
+      }
+    }
+    if (nonStringType || nonCharLength) {
+      let msg =
+        'when passing an array to prune it must contain all strings of a single character'
+      msg +=
+        nonStringType ?
+          `\n  element found with type ${nonStringType}`
+        : `\n  string found with length ${nonCharLength}`
+      throw new Error(msg)
+    }
+  }
+}
+
+module.exports = validatePruneArg

package/dist/internal/validate-prune-arg.mjs

@@ -0,0 +1,43 @@
+import assertArgIsOneOfType from '@common-fp/shared-internals/assert-arg-is-one-of-type'
+import * as ct from '@common-fp/shared-internals/common-types'
+import getType from '@common-fp/shared-internals/get-type'
+
+const validatePruneArg = pruneArg => {
+  assertArgIsOneOfType(pruneArg, 'pruneArg', ct.sequence, 'prune')
+
+  if (typeof pruneArg === 'string') {
+    if (pruneArg.length !== 1) {
+      let msg = 'when passing a string to prune it must be a single character'
+      msg +=
+        pruneArg.length ?
+          '\nif you want to prune all characters in the string, pass an array of chars instead'
+        : '\nan empty string was passed instead'
+      throw new Error(msg)
+    }
+  } else {
+    // pruneArg is array
+    let nonStringType
+    let nonCharLength
+    for (const el of pruneArg) {
+      if (typeof el !== 'string') {
+        nonStringType = getType(el)
+        break
+      }
+      if (el.length !== 1) {
+        nonCharLength = el.length
+        break
+      }
+    }
+    if (nonStringType || nonCharLength) {
+      let msg =
+        'when passing an array to prune it must contain all strings of a single character'
+      msg +=
+        nonStringType ?
+          `\n  element found with type ${nonStringType}`
+        : `\n  string found with length ${nonCharLength}`
+      throw new Error(msg)
+    }
+  }
+}
+
+export default validatePruneArg

package/dist/invert.cjs

@@ -0,0 +1,29 @@
+const getFn = require('@common-fp/shared-internals/get-fn')
+
+const invert = collection => {
+  const fn = getFn(typeToFn, collection, 'collection', 'invert')
+  return fn(collection)
+}
+
+const typeToFn = {
+  map: invert_map,
+  object: invert_obj,
+}
+
+function invert_map(coll) {
+  const res = new Map()
+  for (const [k, v] of coll.entries()) {
+    res.set(v, k)
+  }
+  return res
+}
+
+function invert_obj(coll) {
+  const res = {}
+
+  for (const [k, v] of Object.entries(coll)) res[v] = k
+
+  return res
+}
+
+module.exports = invert

package/dist/invert.d.cts

@@ -0,0 +1,2 @@
+import { default as invert } from '@common-fp/common-fp-types/invert'
+export = invert

package/dist/invert.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/invert'

package/dist/invert.mjs

@@ -0,0 +1,29 @@
+import getFn from '@common-fp/shared-internals/get-fn'
+
+const invert = collection => {
+  const fn = getFn(typeToFn, collection, 'collection', 'invert')
+  return fn(collection)
+}
+
+const typeToFn = {
+  map: invert_map,
+  object: invert_obj,
+}
+
+function invert_map(coll) {
+  const res = new Map()
+  for (const [k, v] of coll.entries()) {
+    res.set(v, k)
+  }
+  return res
+}
+
+function invert_obj(coll) {
+  const res = {}
+
+  for (const [k, v] of Object.entries(coll)) res[v] = k
+
+  return res
+}
+
+export default invert

package/dist/invoke-with.cjs

@@ -0,0 +1,11 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+
+const invokeWith =
+  (...args) =>
+  fn => {
+    assertArgIsType(fn, 'fn', 'function', 'invoke')
+
+    return fn(...args)
+  }
+
+module.exports = invokeWith

package/dist/invoke-with.d.cts

@@ -0,0 +1,2 @@
+import { default as invokeWith } from '@common-fp/common-fp-types/invoke-with'
+export = invokeWith

package/dist/invoke-with.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/invoke-with'

package/dist/invoke-with.mjs

@@ -0,0 +1,11 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+
+const invokeWith =
+  (...args) =>
+  fn => {
+    assertArgIsType(fn, 'fn', 'function', 'invoke')
+
+    return fn(...args)
+  }
+
+export default invokeWith

package/dist/is-after.cjs

@@ -0,0 +1,13 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+
+const isAfter = date1 => {
+  assertArgIsType(date1, 'date1', 'date', 'isAfter')
+
+  return date2 => {
+    assertArgIsType(date2, 'date2', 'date', 'isAfter')
+
+    return date2 > date1
+  }
+}
+
+module.exports = isAfter

package/dist/is-after.d.cts

@@ -0,0 +1,2 @@
+import { default as isAfter } from '@common-fp/common-fp-types/is-after'
+export = isAfter

package/dist/is-after.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/is-after'

package/dist/is-after.mjs

@@ -0,0 +1,13 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+
+const isAfter = date1 => {
+  assertArgIsType(date1, 'date1', 'date', 'isAfter')
+
+  return date2 => {
+    assertArgIsType(date2, 'date2', 'date', 'isAfter')
+
+    return date2 > date1
+  }
+}
+
+export default isAfter

package/dist/is-at-or-after.cjs

@@ -0,0 +1,13 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+
+const isAtOrAfter = date1 => {
+  assertArgIsType(date1, 'date1', 'date', 'isAtOrAfter')
+
+  return date2 => {
+    assertArgIsType(date2, 'date2', 'date', 'isAtOrAfter')
+
+    return date2 >= date1
+  }
+}
+
+module.exports = isAtOrAfter

package/dist/is-at-or-after.d.cts

@@ -0,0 +1,2 @@
+import { default as isAtOrAfter } from '@common-fp/common-fp-types/is-at-or-after'
+export = isAtOrAfter

package/dist/is-at-or-after.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/is-at-or-after'

package/dist/is-at-or-after.mjs

@@ -0,0 +1,13 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+
+const isAtOrAfter = date1 => {
+  assertArgIsType(date1, 'date1', 'date', 'isAtOrAfter')
+
+  return date2 => {
+    assertArgIsType(date2, 'date2', 'date', 'isAtOrAfter')
+
+    return date2 >= date1
+  }
+}
+
+export default isAtOrAfter

package/dist/is-at-or-before.cjs

@@ -0,0 +1,13 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+
+const isAtOrBefore = date1 => {
+  assertArgIsType(date1, 'date1', 'date', 'isAtOrBefore')
+
+  return date2 => {
+    assertArgIsType(date2, 'date2', 'date', 'isAtOrBefore')
+
+    return date2 <= date1
+  }
+}
+
+module.exports = isAtOrBefore

package/dist/is-at-or-before.d.cts

@@ -0,0 +1,2 @@
+import { default as isAtOrBefore } from '@common-fp/common-fp-types/is-at-or-before'
+export = isAtOrBefore

package/dist/is-at-or-before.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/is-at-or-before'

package/dist/is-at-or-before.mjs

@@ -0,0 +1,13 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+
+const isAtOrBefore = date1 => {
+  assertArgIsType(date1, 'date1', 'date', 'isAtOrBefore')
+
+  return date2 => {
+    assertArgIsType(date2, 'date2', 'date', 'isAtOrBefore')
+
+    return date2 <= date1
+  }
+}
+
+export default isAtOrBefore

package/dist/is-before.cjs

@@ -0,0 +1,13 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+
+const isBefore = date1 => {
+  assertArgIsType(date1, 'date1', 'date', 'isBefore')
+
+  return date2 => {
+    assertArgIsType(date2, 'date2', 'date', 'isBefore')
+
+    return date2 < date1
+  }
+}
+
+module.exports = isBefore

package/dist/is-before.d.cts

@@ -0,0 +1,2 @@
+import { default as isBefore } from '@common-fp/common-fp-types/is-before'
+export = isBefore

package/dist/is-before.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/is-before'

package/dist/is-before.mjs

@@ -0,0 +1,13 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+
+const isBefore = date1 => {
+  assertArgIsType(date1, 'date1', 'date', 'isBefore')
+
+  return date2 => {
+    assertArgIsType(date2, 'date2', 'date', 'isBefore')
+
+    return date2 < date1
+  }
+}
+
+export default isBefore

package/dist/is-empty.cjs

@@ -0,0 +1,28 @@
+const getFn = require('@common-fp/shared-internals/get-fn')
+
+const isEmpty = collection => {
+  const fn = getFn(typeToFn, collection, 'collection', 'isEmpty')
+  return fn(collection)
+}
+
+const typeToFn = {
+  array: isEmpty_hasLength,
+  map: isEmpty_hasSize,
+  object: isEmpty_object,
+  set: isEmpty_hasSize,
+  string: isEmpty_hasLength,
+}
+
+function isEmpty_hasSize(coll) {
+  return coll.size === 0
+}
+
+function isEmpty_hasLength(coll) {
+  return coll.length === 0
+}
+
+function isEmpty_object(coll) {
+  return Object.keys(coll).length === 0
+}
+
+module.exports = isEmpty

package/dist/is-empty.d.cts

@@ -0,0 +1,2 @@
+import { default as isEmpty } from '@common-fp/common-fp-types/is-empty'
+export = isEmpty

package/dist/is-empty.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/is-empty'

package/dist/is-empty.mjs

@@ -0,0 +1,28 @@
+import getFn from '@common-fp/shared-internals/get-fn'
+
+const isEmpty = collection => {
+  const fn = getFn(typeToFn, collection, 'collection', 'isEmpty')
+  return fn(collection)
+}
+
+const typeToFn = {
+  array: isEmpty_hasLength,
+  map: isEmpty_hasSize,
+  object: isEmpty_object,
+  set: isEmpty_hasSize,
+  string: isEmpty_hasLength,
+}
+
+function isEmpty_hasSize(coll) {
+  return coll.size === 0
+}
+
+function isEmpty_hasLength(coll) {
+  return coll.length === 0
+}
+
+function isEmpty_object(coll) {
+  return Object.keys(coll).length === 0
+}
+
+export default isEmpty

package/dist/is-falsey.cjs

@@ -0,0 +1,3 @@
+const isFalsey = value => !value
+
+module.exports = isFalsey