common-fp 0.1.0

package/dist/get-min-value.d.ts

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

package/dist/get-min-value.mjs

@@ -0,0 +1,16 @@
+import assertArgHasValuesOfType from '@common-fp/shared-internals/assert-arg-has-values-of-type'
+import assertArgTypeIsOneOf from '@common-fp/shared-internals/assert-arg-type-is-one-of'
+import * as ct from '@common-fp/shared-internals/common-types'
+import getIterator from '@common-fp/shared-internals/get-iterator'
+import getType from '@common-fp/shared-internals/get-type'
+
+const getMinValue = collection => {
+  const collType = getType(collection)
+  assertArgTypeIsOneOf(collType, 'collection', ct.collection, 'getMinValue')
+  assertArgHasValuesOfType(collection, 'collection', 'number', 'getMinValue')
+
+  const values = Array.from(getIterator('values', collection, collType))
+  return values.length ? Math.min(...values) : undefined
+}
+
+export default getMinValue

package/dist/get-random-value.cjs

@@ -0,0 +1,18 @@
+const assertArgTypeIsOneOf = require('@common-fp/shared-internals/assert-arg-type-is-one-of')
+const ct = require('@common-fp/shared-internals/common-types')
+const getIterator = require('@common-fp/shared-internals/get-iterator')
+const getRandomInt = require('@common-fp/shared-internals/get-random-int')
+const getType = require('@common-fp/shared-internals/get-type')
+
+const getRandomValue = collection => {
+  const collType = getType(collection)
+  assertArgTypeIsOneOf(collType, 'collection', ct.collection, 'getRandomValue')
+  const values = Array.from(getIterator('values', collection, collType))
+
+  if (!values.length) return
+
+  const randIdx = getRandomInt(0, values.length - 1)
+  return values[randIdx]
+}
+
+module.exports = getRandomValue

package/dist/get-random-value.d.cts

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

package/dist/get-random-value.d.ts

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

package/dist/get-random-value.mjs

@@ -0,0 +1,18 @@
+import assertArgTypeIsOneOf from '@common-fp/shared-internals/assert-arg-type-is-one-of'
+import * as ct from '@common-fp/shared-internals/common-types'
+import getIterator from '@common-fp/shared-internals/get-iterator'
+import getRandomInt from '@common-fp/shared-internals/get-random-int'
+import getType from '@common-fp/shared-internals/get-type'
+
+const getRandomValue = collection => {
+  const collType = getType(collection)
+  assertArgTypeIsOneOf(collType, 'collection', ct.collection, 'getRandomValue')
+  const values = Array.from(getIterator('values', collection, collType))
+
+  if (!values.length) return
+
+  const randIdx = getRandomInt(0, values.length - 1)
+  return values[randIdx]
+}
+
+export default getRandomValue

package/dist/get-size.cjs

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

package/dist/get-size.d.cts

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

package/dist/get-size.d.ts

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

package/dist/get-size.mjs

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

package/dist/get-value-at-map-key.cjs

@@ -0,0 +1,8 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+
+const getValueAtMapKey = key => aMap => {
+  assertArgIsType(aMap, 'aMap', 'map', 'getValueAtMapKey')
+  return aMap.get(key)
+}
+
+module.exports = getValueAtMapKey

package/dist/get-value-at-map-key.d.cts

@@ -0,0 +1,2 @@
+import { default as getValueAtMapKey } from '@common-fp/common-fp-types/get-value-at-map-key'
+export = getValueAtMapKey

package/dist/get-value-at-map-key.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/get-value-at-map-key'

package/dist/get-value-at-map-key.mjs

@@ -0,0 +1,8 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+
+const getValueAtMapKey = key => aMap => {
+  assertArgIsType(aMap, 'aMap', 'map', 'getValueAtMapKey')
+  return aMap.get(key)
+}
+
+export default getValueAtMapKey

package/dist/get-values.cjs

@@ -0,0 +1,22 @@
+const getFn = require('@common-fp/shared-internals/get-fn')
+
+const getValues = collection => {
+  const fn = getFn(typeToFn, collection, 'collection', 'getValues')
+
+  return fn(collection)
+}
+
+const typeToFn = {
+  map: getValues_map,
+  object: getValues_object,
+}
+
+function getValues_map(aMap) {
+  return Array.from(aMap.values())
+}
+
+function getValues_object(obj) {
+  return Object.values(obj)
+}
+
+module.exports = getValues

package/dist/get-values.d.cts

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

package/dist/get-values.d.ts

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

package/dist/get-values.mjs

@@ -0,0 +1,22 @@
+import getFn from '@common-fp/shared-internals/get-fn'
+
+const getValues = collection => {
+  const fn = getFn(typeToFn, collection, 'collection', 'getValues')
+
+  return fn(collection)
+}
+
+const typeToFn = {
+  map: getValues_map,
+  object: getValues_object,
+}
+
+function getValues_map(aMap) {
+  return Array.from(aMap.values())
+}
+
+function getValues_object(obj) {
+  return Object.values(obj)
+}
+
+export default getValues

package/dist/get.cjs

@@ -0,0 +1,10 @@
+const assertArgIsOneOfType = require('@common-fp/shared-internals/assert-arg-is-one-of-type')
+const ct = require('@common-fp/shared-internals/common-types')
+
+const get = key => {
+  assertArgIsOneOfType(key, 'key', ct.propertyKey, 'get')
+
+  return anything => anything?.[key]
+}
+
+module.exports = get

package/dist/get.d.cts

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

package/dist/get.d.ts

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

package/dist/get.mjs

@@ -0,0 +1,10 @@
+import assertArgIsOneOfType from '@common-fp/shared-internals/assert-arg-is-one-of-type'
+import * as ct from '@common-fp/shared-internals/common-types'
+
+const get = key => {
+  assertArgIsOneOfType(key, 'key', ct.propertyKey, 'get')
+
+  return anything => anything?.[key]
+}
+
+export default get

package/dist/greater-than-or-equal-to.cjs

@@ -0,0 +1,13 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+
+const greaterThanOrEqualTo = right => {
+  assertArgIsType(right, 'right', 'number', 'greaterThanOrEqualTo')
+
+  return left => {
+    assertArgIsType(left, 'left', 'number', 'greaterThanOrEqualTo')
+
+    return left >= right
+  }
+}
+
+module.exports = greaterThanOrEqualTo

package/dist/greater-than-or-equal-to.d.cts

@@ -0,0 +1,2 @@
+import { default as greaterThanOrEqualTo } from '@common-fp/common-fp-types/greater-than-or-equal-to'
+export = greaterThanOrEqualTo

package/dist/greater-than-or-equal-to.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/common-fp-types/greater-than-or-equal-to'

package/dist/greater-than-or-equal-to.mjs

@@ -0,0 +1,13 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+
+const greaterThanOrEqualTo = right => {
+  assertArgIsType(right, 'right', 'number', 'greaterThanOrEqualTo')
+
+  return left => {
+    assertArgIsType(left, 'left', 'number', 'greaterThanOrEqualTo')
+
+    return left >= right
+  }
+}
+
+export default greaterThanOrEqualTo

package/dist/greater-than.cjs

@@ -0,0 +1,13 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+
+const greaterThan = right => {
+  assertArgIsType(right, 'right', 'number', 'greaterThan')
+
+  return left => {
+    assertArgIsType(left, 'left', 'number', 'greaterThan')
+
+    return left > right
+  }
+}
+
+module.exports = greaterThan

package/dist/greater-than.d.cts

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

package/dist/greater-than.d.ts

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

package/dist/greater-than.mjs

@@ -0,0 +1,13 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+
+const greaterThan = right => {
+  assertArgIsType(right, 'right', 'number', 'greaterThan')
+
+  return left => {
+    assertArgIsType(left, 'left', 'number', 'greaterThan')
+
+    return left > right
+  }
+}
+
+export default greaterThan

package/dist/group-by.cjs

@@ -0,0 +1,28 @@
+const assertArgIsType = require('@common-fp/shared-internals/assert-arg-is-type')
+const assertArgTypeIsOneOf = require('@common-fp/shared-internals/assert-arg-type-is-one-of')
+const ct = require('@common-fp/shared-internals/common-types')
+const getIterator = require('@common-fp/shared-internals/get-iterator')
+const getType = require('@common-fp/shared-internals/get-type')
+
+const groupBy = toGroup => {
+  assertArgIsType(toGroup, 'toGroup', 'function', 'groupBy')
+
+  return collection => {
+    const coll = collection
+    const collType = getType(coll)
+    assertArgTypeIsOneOf(collType, 'collection', ct.collection, 'groupBy')
+    const entries = getIterator('entries', coll, collType)
+
+    const result = {}
+    for (const [key, val] of entries) {
+      const group = toGroup(val, key, coll)
+
+      if (!result[group]) result[group] = [val]
+      else result[group].push(val)
+    }
+
+    return result
+  }
+}
+
+module.exports = groupBy

package/dist/group-by.d.cts

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

package/dist/group-by.d.ts

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

package/dist/group-by.mjs

@@ -0,0 +1,28 @@
+import assertArgIsType from '@common-fp/shared-internals/assert-arg-is-type'
+import assertArgTypeIsOneOf from '@common-fp/shared-internals/assert-arg-type-is-one-of'
+import * as ct from '@common-fp/shared-internals/common-types'
+import getIterator from '@common-fp/shared-internals/get-iterator'
+import getType from '@common-fp/shared-internals/get-type'
+
+const groupBy = toGroup => {
+  assertArgIsType(toGroup, 'toGroup', 'function', 'groupBy')
+
+  return collection => {
+    const coll = collection
+    const collType = getType(coll)
+    assertArgTypeIsOneOf(collType, 'collection', ct.collection, 'groupBy')
+    const entries = getIterator('entries', coll, collType)
+
+    const result = {}
+    for (const [key, val] of entries) {
+      const group = toGroup(val, key, coll)
+
+      if (!result[group]) result[group] = [val]
+      else result[group].push(val)
+    }
+
+    return result
+  }
+}
+
+export default groupBy

package/dist/index.cjs

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

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+import * as commonFp from '@common-fp/common-fp-types'
+export = commonFp

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from '@common-fp/common-fp-types'