@common-fp/shared-internals 0.1.0

package/dist/contains-type.cjs

@@ -0,0 +1,9 @@
+/**
+ * a simple function taking either an array or set of expected types and
+ * returning whether it contains a specific type
+ */
+const containsType = (expected, type) => {
+  return expected.includes ? expected.includes(type) : expected.has(type)
+}
+
+module.exports = containsType

package/dist/contains-type.d.cts

@@ -0,0 +1,2 @@
+import { default as containsType } from '@common-fp/shared-internals-types/contains-type'
+export = containsType

package/dist/contains-type.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/shared-internals-types/contains-type'

package/dist/contains-type.mjs

@@ -0,0 +1,9 @@
+/**
+ * a simple function taking either an array or set of expected types and
+ * returning whether it contains a specific type
+ */
+const containsType = (expected, type) => {
+  return expected.includes ? expected.includes(type) : expected.has(type)
+}
+
+export default containsType

package/dist/deps/type-detect.cjs

@@ -0,0 +1,153 @@
+/**
+ * from github.com/chaijs/type-detect#4415ced2c49007f097627515806553e7f649c293Z
+ * no version indicated in package.json
+ * license from this commit is referenced in license.txt
+ */
+
+const promiseExists = typeof Promise === 'function'
+const globalObject = (Obj => {
+  if (typeof globalThis === 'object') {
+    return globalThis
+  }
+  Object.defineProperty(Obj, 'typeDetectGlobalObject', {
+    get() {
+      return this
+    },
+    configurable: true,
+  })
+  // eslint-disable-next-line no-undef
+  const global = typeDetectGlobalObject
+  delete Obj.typeDetectGlobalObject
+  return global
+})(Object.prototype)
+const symbolExists = typeof Symbol !== 'undefined'
+const mapExists = typeof Map !== 'undefined'
+const setExists = typeof Set !== 'undefined'
+const weakMapExists = typeof WeakMap !== 'undefined'
+const weakSetExists = typeof WeakSet !== 'undefined'
+const dataViewExists = typeof DataView !== 'undefined'
+const symbolIteratorExists =
+  symbolExists && typeof Symbol.iterator !== 'undefined'
+const symbolToStringTagExists =
+  symbolExists && typeof Symbol.toStringTag !== 'undefined'
+const setEntriesExists =
+  setExists && typeof Set.prototype.entries === 'function'
+const mapEntriesExists =
+  mapExists && typeof Map.prototype.entries === 'function'
+const setIteratorPrototype =
+  setEntriesExists && Object.getPrototypeOf(new Set().entries())
+const mapIteratorPrototype =
+  mapEntriesExists && Object.getPrototypeOf(new Map().entries())
+const arrayIteratorExists =
+  symbolIteratorExists && typeof Array.prototype[Symbol.iterator] === 'function'
+const arrayIteratorPrototype =
+  arrayIteratorExists && Object.getPrototypeOf([][Symbol.iterator]())
+const stringIteratorExists =
+  symbolIteratorExists &&
+  typeof String.prototype[Symbol.iterator] === 'function'
+const stringIteratorPrototype =
+  stringIteratorExists && Object.getPrototypeOf(''[Symbol.iterator]())
+const toStringLeftSliceLength = 8
+const toStringRightSliceLength = -1
+module.exports = function typeDetect(obj) {
+  const typeofObj = typeof obj
+  if (typeofObj !== 'object') {
+    return typeofObj
+  }
+  if (obj === null) {
+    return 'null'
+  }
+  if (obj === globalObject) {
+    return 'global'
+  }
+  if (
+    Array.isArray(obj) &&
+    (symbolToStringTagExists === false || !(Symbol.toStringTag in obj))
+  ) {
+    return 'Array'
+  }
+  if (typeof window === 'object' && window !== null) {
+    if (typeof window.location === 'object' && obj === window.location) {
+      return 'Location'
+    }
+    if (typeof window.document === 'object' && obj === window.document) {
+      return 'Document'
+    }
+    if (typeof window.navigator === 'object') {
+      if (
+        typeof window.navigator.mimeTypes === 'object' &&
+        obj === window.navigator.mimeTypes
+      ) {
+        return 'MimeTypeArray'
+      }
+      if (
+        typeof window.navigator.plugins === 'object' &&
+        obj === window.navigator.plugins
+      ) {
+        return 'PluginArray'
+      }
+    }
+    if (
+      (typeof window.HTMLElement === 'function' ||
+        typeof window.HTMLElement === 'object') &&
+      obj instanceof window.HTMLElement
+    ) {
+      if (obj.tagName === 'BLOCKQUOTE') {
+        return 'HTMLQuoteElement'
+      }
+      if (obj.tagName === 'TD') {
+        return 'HTMLTableDataCellElement'
+      }
+      if (obj.tagName === 'TH') {
+        return 'HTMLTableHeaderCellElement'
+      }
+    }
+  }
+  const stringTag = symbolToStringTagExists && obj[Symbol.toStringTag]
+  if (typeof stringTag === 'string') {
+    return stringTag
+  }
+  const objPrototype = Object.getPrototypeOf(obj)
+  if (objPrototype === RegExp.prototype) {
+    return 'RegExp'
+  }
+  if (objPrototype === Date.prototype) {
+    return 'Date'
+  }
+  if (promiseExists && objPrototype === Promise.prototype) {
+    return 'Promise'
+  }
+  if (setExists && objPrototype === Set.prototype) {
+    return 'Set'
+  }
+  if (mapExists && objPrototype === Map.prototype) {
+    return 'Map'
+  }
+  if (weakSetExists && objPrototype === WeakSet.prototype) {
+    return 'WeakSet'
+  }
+  if (weakMapExists && objPrototype === WeakMap.prototype) {
+    return 'WeakMap'
+  }
+  if (dataViewExists && objPrototype === DataView.prototype) {
+    return 'DataView'
+  }
+  if (mapExists && objPrototype === mapIteratorPrototype) {
+    return 'Map Iterator'
+  }
+  if (setExists && objPrototype === setIteratorPrototype) {
+    return 'Set Iterator'
+  }
+  if (arrayIteratorExists && objPrototype === arrayIteratorPrototype) {
+    return 'Array Iterator'
+  }
+  if (stringIteratorExists && objPrototype === stringIteratorPrototype) {
+    return 'String Iterator'
+  }
+  if (objPrototype === null) {
+    return 'Object'
+  }
+  return Object.prototype.toString
+    .call(obj)
+    .slice(toStringLeftSliceLength, toStringRightSliceLength)
+}

package/dist/deps/type-detect.mjs

@@ -0,0 +1,153 @@
+/**
+ * from github.com/chaijs/type-detect#4415ced2c49007f097627515806553e7f649c293Z
+ * no version indicated in package.json
+ * license from this commit is referenced in license.txt
+ */
+
+const promiseExists = typeof Promise === 'function'
+const globalObject = (Obj => {
+  if (typeof globalThis === 'object') {
+    return globalThis
+  }
+  Object.defineProperty(Obj, 'typeDetectGlobalObject', {
+    get() {
+      return this
+    },
+    configurable: true,
+  })
+  // eslint-disable-next-line no-undef
+  const global = typeDetectGlobalObject
+  delete Obj.typeDetectGlobalObject
+  return global
+})(Object.prototype)
+const symbolExists = typeof Symbol !== 'undefined'
+const mapExists = typeof Map !== 'undefined'
+const setExists = typeof Set !== 'undefined'
+const weakMapExists = typeof WeakMap !== 'undefined'
+const weakSetExists = typeof WeakSet !== 'undefined'
+const dataViewExists = typeof DataView !== 'undefined'
+const symbolIteratorExists =
+  symbolExists && typeof Symbol.iterator !== 'undefined'
+const symbolToStringTagExists =
+  symbolExists && typeof Symbol.toStringTag !== 'undefined'
+const setEntriesExists =
+  setExists && typeof Set.prototype.entries === 'function'
+const mapEntriesExists =
+  mapExists && typeof Map.prototype.entries === 'function'
+const setIteratorPrototype =
+  setEntriesExists && Object.getPrototypeOf(new Set().entries())
+const mapIteratorPrototype =
+  mapEntriesExists && Object.getPrototypeOf(new Map().entries())
+const arrayIteratorExists =
+  symbolIteratorExists && typeof Array.prototype[Symbol.iterator] === 'function'
+const arrayIteratorPrototype =
+  arrayIteratorExists && Object.getPrototypeOf([][Symbol.iterator]())
+const stringIteratorExists =
+  symbolIteratorExists &&
+  typeof String.prototype[Symbol.iterator] === 'function'
+const stringIteratorPrototype =
+  stringIteratorExists && Object.getPrototypeOf(''[Symbol.iterator]())
+const toStringLeftSliceLength = 8
+const toStringRightSliceLength = -1
+export default function typeDetect(obj) {
+  const typeofObj = typeof obj
+  if (typeofObj !== 'object') {
+    return typeofObj
+  }
+  if (obj === null) {
+    return 'null'
+  }
+  if (obj === globalObject) {
+    return 'global'
+  }
+  if (
+    Array.isArray(obj) &&
+    (symbolToStringTagExists === false || !(Symbol.toStringTag in obj))
+  ) {
+    return 'Array'
+  }
+  if (typeof window === 'object' && window !== null) {
+    if (typeof window.location === 'object' && obj === window.location) {
+      return 'Location'
+    }
+    if (typeof window.document === 'object' && obj === window.document) {
+      return 'Document'
+    }
+    if (typeof window.navigator === 'object') {
+      if (
+        typeof window.navigator.mimeTypes === 'object' &&
+        obj === window.navigator.mimeTypes
+      ) {
+        return 'MimeTypeArray'
+      }
+      if (
+        typeof window.navigator.plugins === 'object' &&
+        obj === window.navigator.plugins
+      ) {
+        return 'PluginArray'
+      }
+    }
+    if (
+      (typeof window.HTMLElement === 'function' ||
+        typeof window.HTMLElement === 'object') &&
+      obj instanceof window.HTMLElement
+    ) {
+      if (obj.tagName === 'BLOCKQUOTE') {
+        return 'HTMLQuoteElement'
+      }
+      if (obj.tagName === 'TD') {
+        return 'HTMLTableDataCellElement'
+      }
+      if (obj.tagName === 'TH') {
+        return 'HTMLTableHeaderCellElement'
+      }
+    }
+  }
+  const stringTag = symbolToStringTagExists && obj[Symbol.toStringTag]
+  if (typeof stringTag === 'string') {
+    return stringTag
+  }
+  const objPrototype = Object.getPrototypeOf(obj)
+  if (objPrototype === RegExp.prototype) {
+    return 'RegExp'
+  }
+  if (objPrototype === Date.prototype) {
+    return 'Date'
+  }
+  if (promiseExists && objPrototype === Promise.prototype) {
+    return 'Promise'
+  }
+  if (setExists && objPrototype === Set.prototype) {
+    return 'Set'
+  }
+  if (mapExists && objPrototype === Map.prototype) {
+    return 'Map'
+  }
+  if (weakSetExists && objPrototype === WeakSet.prototype) {
+    return 'WeakSet'
+  }
+  if (weakMapExists && objPrototype === WeakMap.prototype) {
+    return 'WeakMap'
+  }
+  if (dataViewExists && objPrototype === DataView.prototype) {
+    return 'DataView'
+  }
+  if (mapExists && objPrototype === mapIteratorPrototype) {
+    return 'Map Iterator'
+  }
+  if (setExists && objPrototype === setIteratorPrototype) {
+    return 'Set Iterator'
+  }
+  if (arrayIteratorExists && objPrototype === arrayIteratorPrototype) {
+    return 'Array Iterator'
+  }
+  if (stringIteratorExists && objPrototype === stringIteratorPrototype) {
+    return 'String Iterator'
+  }
+  if (objPrototype === null) {
+    return 'Object'
+  }
+  return Object.prototype.toString
+    .call(obj)
+    .slice(toStringLeftSliceLength, toStringRightSliceLength)
+}

package/dist/deps/universal-eol.cjs

@@ -0,0 +1,18 @@
+// from https://github.com/p2227/universal-eol/blob/25d5629bd5b6e39a1c483e0e1a551513ae80b95c/eol.mjs
+// version 0.0.3
+// modified to work in web-workers
+const runningInWebworker =
+  typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope
+
+let platform
+if (runningInWebworker) {
+  platform = 'webworker'
+} else if (typeof window === 'undefined') {
+  platform = process.platform
+} else {
+  platform = navigator.platform
+}
+
+const EOL = /win/i.test(platform) ? '\r\n' : '\n'
+
+module.exports = EOL

package/dist/deps/universal-eol.mjs

@@ -0,0 +1,18 @@
+// from https://github.com/p2227/universal-eol/blob/25d5629bd5b6e39a1c483e0e1a551513ae80b95c/eol.mjs
+// version 0.0.3
+// modified to work in web-workers
+const runningInWebworker =
+  typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope
+
+let platform
+if (runningInWebworker) {
+  platform = 'webworker'
+} else if (typeof window === 'undefined') {
+  platform = process.platform
+} else {
+  platform = navigator.platform
+}
+
+const EOL = /win/i.test(platform) ? '\r\n' : '\n'
+
+export default EOL

package/dist/ensure-number.cjs

@@ -0,0 +1,10 @@
+/**
+ * this utility expects strOrNum to have already been asserted to be a string
+ * or number
+ */
+
+const ensureNumber = strOrNum => {
+  return typeof strOrNum === 'number' ? strOrNum : Number(strOrNum)
+}
+
+module.exports = ensureNumber

package/dist/ensure-number.d.cts

@@ -0,0 +1,2 @@
+import { default as ensureNumber } from '@common-fp/shared-internals-types/ensure-number'
+export = ensureNumber

package/dist/ensure-number.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/shared-internals-types/ensure-number'

package/dist/ensure-number.mjs

@@ -0,0 +1,10 @@
+/**
+ * this utility expects strOrNum to have already been asserted to be a string
+ * or number
+ */
+
+const ensureNumber = strOrNum => {
+  return typeof strOrNum === 'number' ? strOrNum : Number(strOrNum)
+}
+
+export default ensureNumber

package/dist/ensure-set.cjs

@@ -0,0 +1,12 @@
+/**
+ * this utility expects arrOrSet to have already been asserted to be an array
+ * or set
+ */
+
+const getType = require('./get-type.cjs')
+
+const ensureSet = arrOrSet => {
+  return getType(arrOrSet) === 'set' ? arrOrSet : new Set(arrOrSet)
+}
+
+module.exports = ensureSet

package/dist/ensure-set.d.cts

@@ -0,0 +1,2 @@
+import { default as ensureSet } from '@common-fp/shared-internals-types/ensure-set'
+export = ensureSet

package/dist/ensure-set.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/shared-internals-types/ensure-set'

package/dist/ensure-set.mjs

@@ -0,0 +1,12 @@
+/**
+ * this utility expects arrOrSet to have already been asserted to be an array
+ * or set
+ */
+
+import getType from './get-type.mjs'
+
+const ensureSet = arrOrSet => {
+  return getType(arrOrSet) === 'set' ? arrOrSet : new Set(arrOrSet)
+}
+
+export default ensureSet

package/dist/eol.cjs

@@ -0,0 +1,3 @@
+const EOL = require('./deps/universal-eol.cjs')
+
+module.exports = EOL

package/dist/eol.d.cts

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

package/dist/eol.d.ts

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

package/dist/eol.mjs

@@ -0,0 +1,3 @@
+import EOL from './deps/universal-eol.mjs'
+
+export default EOL

package/dist/get-fn-by-type.cjs

@@ -0,0 +1,9 @@
+const assertArgTypeIsOneOf = require('./assert-arg-type-is-one-of.cjs')
+
+const getFnByType = (typeToFn, argType, argName, utilName) => {
+  const supportedTypes = Object.keys(typeToFn)
+  assertArgTypeIsOneOf(argType, argName, supportedTypes, utilName)
+  return typeToFn[argType]
+}
+
+module.exports = getFnByType

package/dist/get-fn-by-type.d.cts

@@ -0,0 +1,2 @@
+import { default as getFnByType } from '@common-fp/shared-internals-types/get-fn-by-type'
+export = getFnByType

package/dist/get-fn-by-type.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/shared-internals-types/get-fn-by-type'

package/dist/get-fn-by-type.mjs

@@ -0,0 +1,9 @@
+import assertArgTypeIsOneOf from './assert-arg-type-is-one-of.mjs'
+
+const getFnByType = (typeToFn, argType, argName, utilName) => {
+  const supportedTypes = Object.keys(typeToFn)
+  assertArgTypeIsOneOf(argType, argName, supportedTypes, utilName)
+  return typeToFn[argType]
+}
+
+export default getFnByType

package/dist/get-fn.cjs

@@ -0,0 +1,11 @@
+const assertArgTypeIsOneOf = require('./assert-arg-type-is-one-of.cjs')
+const getType = require('./get-type.cjs')
+
+const getFn = (typeToFn, arg, argName, utilName) => {
+  const supportedTypes = Object.keys(typeToFn)
+  const argType = getType(arg)
+  assertArgTypeIsOneOf(argType, argName, supportedTypes, utilName)
+  return typeToFn[argType]
+}
+
+module.exports = getFn

package/dist/get-fn.d.cts

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

package/dist/get-fn.d.ts

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

package/dist/get-fn.mjs

@@ -0,0 +1,11 @@
+import assertArgTypeIsOneOf from './assert-arg-type-is-one-of.mjs'
+import getType from './get-type.mjs'
+
+const getFn = (typeToFn, arg, argName, utilName) => {
+  const supportedTypes = Object.keys(typeToFn)
+  const argType = getType(arg)
+  assertArgTypeIsOneOf(argType, argName, supportedTypes, utilName)
+  return typeToFn[argType]
+}
+
+export default getFn

package/dist/get-iterator.cjs

@@ -0,0 +1,23 @@
+/**
+ * this utility expects the passed collection to have already been asserted
+ * also, the iteratorType error shouldn't ever reach users of Common FP, it's
+ * just here in case custom utility authors mess up.
+ */
+
+const getType = require('./get-type.cjs')
+
+const getIterator = (iteratorType, coll, collType) => {
+  validateIteratorType(iteratorType)
+  const type = collType || getType(coll)
+  return type === 'object' ?
+      Object[iteratorType](coll).values()
+    : coll[iteratorType]()
+}
+
+function validateIteratorType(iteratorType) {
+  if (!['values', 'keys', 'entries'].includes(iteratorType)) {
+    throw new Error("iteratorType must be one of 'values', 'keys' or 'entries'")
+  }
+}
+
+module.exports = getIterator

package/dist/get-iterator.d.cts

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

package/dist/get-iterator.d.ts

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

package/dist/get-iterator.mjs

@@ -0,0 +1,23 @@
+/**
+ * this utility expects the passed collection to have already been asserted
+ * also, the iteratorType error shouldn't ever reach users of Common FP, it's
+ * just here in case custom utility authors mess up.
+ */
+
+import getType from './get-type.mjs'
+
+const getIterator = (iteratorType, coll, collType) => {
+  validateIteratorType(iteratorType)
+  const type = collType || getType(coll)
+  return type === 'object' ?
+      Object[iteratorType](coll).values()
+    : coll[iteratorType]()
+}
+
+function validateIteratorType(iteratorType) {
+  if (!['values', 'keys', 'entries'].includes(iteratorType)) {
+    throw new Error("iteratorType must be one of 'values', 'keys' or 'entries'")
+  }
+}
+
+export default getIterator

package/dist/get-random-int.cjs

@@ -0,0 +1,5 @@
+const getRandomInt = (min, max) => {
+  return Math.floor(Math.random() * (max - min + 1)) + min
+}
+
+module.exports = getRandomInt

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

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

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

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

package/dist/get-random-int.mjs

@@ -0,0 +1,5 @@
+const getRandomInt = (min, max) => {
+  return Math.floor(Math.random() * (max - min + 1)) + min
+}
+
+export default getRandomInt

package/dist/get-type.cjs

@@ -0,0 +1,5 @@
+const typeDetect = require('./deps/type-detect.cjs')
+
+const getType = anything => typeDetect(anything).toLowerCase()
+
+module.exports = getType

package/dist/get-type.d.cts

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

package/dist/get-type.d.ts

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

package/dist/get-type.mjs

@@ -0,0 +1,5 @@
+import typeDetect from './deps/type-detect.mjs'
+
+const getType = anything => typeDetect(anything).toLowerCase()
+
+export default getType

package/dist/index.cjs

@@ -0,0 +1,30 @@
+module.exports = {
+  aOrAn: require('./a-or-an.cjs'),
+  assertArgHasValuesOfType: require('./assert-arg-has-values-of-type.cjs'),
+  assertArgIsArrayOfAcceptedTypes: require('./assert-arg-is-array-of-accepted-types.cjs'),
+  assertArgIsArrayOfSameType: require('./assert-arg-is-array-of-same-type.cjs'),
+  assertArgIsArrayOfType: require('./assert-arg-is-array-of-type.cjs'),
+  assertArgIsChar: require('./assert-arg-is-char.cjs'),
+  assertArgIsInt: require('./assert-arg-is-int.cjs'),
+  assertArgIsOneOfType: require('./assert-arg-is-one-of-type.cjs'),
+  assertArgIsType: require('./assert-arg-is-type.cjs'),
+  assertArgSharesTypeWith: require('./assert-arg-shares-type-with.cjs'),
+  assertArgTypeIsOneOf: require('./assert-arg-type-is-one-of.cjs'),
+  containsType: require('./contains-type.cjs'),
+  ensureNumber: require('./ensure-number.cjs'),
+  ensureSet: require('./ensure-set.cjs'),
+  eol: require('./eol.cjs'),
+  getFn: require('./get-fn.cjs'),
+  getFnByType: require('./get-fn-by-type.cjs'),
+  getIterator: require('./get-iterator.cjs'),
+  getRandomInt: require('./get-random-int.cjs'),
+  getType: require('./get-type.cjs'),
+  negate: require('./negate.cjs'),
+  toEnglishList: require('./to-english-list.cjs'),
+  truncateToNChars: require('./truncate-to-n-chars.cjs'),
+  validateArrayKeys: require('./validate-array-keys.cjs'),
+  validateIsBetweenInput: require('./validate-is-between-input.cjs'),
+  validateObjectKeys: require('./validate-object-keys.cjs'),
+  validateRange: require('./validate-range.cjs'),
+  commonTypes: require('./common-types.cjs'),
+}

package/dist/index.d.cts

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

package/dist/index.d.ts

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