@common-fp/shared-internals 0.1.0

package/dist/index.mjs

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

package/dist/negate.cjs

@@ -0,0 +1,6 @@
+const negate =
+  fn =>
+  (...args) =>
+    !fn(...args)
+
+module.exports = negate

package/dist/negate.d.cts

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

package/dist/negate.d.ts

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

package/dist/negate.mjs

@@ -0,0 +1,6 @@
+const negate =
+  fn =>
+  (...args) =>
+    !fn(...args)
+
+export default negate

package/dist/to-english-list.cjs

@@ -0,0 +1,12 @@
+const toEnglishList = (andOr, arrOrSet) => {
+  const arr = Array.isArray(arrOrSet) ? arrOrSet : [...arrOrSet]
+
+  if (!arr.length) return ''
+  if (arr.length === 1) return arr[0]
+
+  const start = arr.slice(0, arr.length - 1).join(', ')
+  const end = ` ${andOr} ${arr[arr.length - 1]}`
+  return start + end
+}
+
+module.exports = toEnglishList

package/dist/to-english-list.d.cts

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

package/dist/to-english-list.d.ts

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

package/dist/to-english-list.mjs

@@ -0,0 +1,12 @@
+const toEnglishList = (andOr, arrOrSet) => {
+  const arr = Array.isArray(arrOrSet) ? arrOrSet : [...arrOrSet]
+
+  if (!arr.length) return ''
+  if (arr.length === 1) return arr[0]
+
+  const start = arr.slice(0, arr.length - 1).join(', ')
+  const end = ` ${andOr} ${arr[arr.length - 1]}`
+  return start + end
+}
+
+export default toEnglishList

package/dist/truncate-to-n-chars.cjs

@@ -0,0 +1,18 @@
+/**
+ * this utility expects a valid value for numChars
+ */
+
+const truncateToNChars = (numChars, anything) => {
+  const str = '' + anything
+  const chars = str.slice(0, numChars)
+  const moreCharsExist = str.length > chars.length
+
+  return moreCharsExist ? omitLastThree(chars) : chars
+}
+
+// accounts for strings less than 3 characters
+function omitLastThree(str) {
+  return str.replace(/.{0,3}$/, matched => matched.replace(/./g, '.'))
+}
+
+module.exports = truncateToNChars

package/dist/truncate-to-n-chars.d.cts

@@ -0,0 +1,2 @@
+import { default as truncateToNChars } from '@common-fp/shared-internals-types/truncate-to-n-chars'
+export = truncateToNChars

package/dist/truncate-to-n-chars.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/shared-internals-types/truncate-to-n-chars'

package/dist/truncate-to-n-chars.mjs

@@ -0,0 +1,18 @@
+/**
+ * this utility expects a valid value for numChars
+ */
+
+const truncateToNChars = (numChars, anything) => {
+  const str = '' + anything
+  const chars = str.slice(0, numChars)
+  const moreCharsExist = str.length > chars.length
+
+  return moreCharsExist ? omitLastThree(chars) : chars
+}
+
+// accounts for strings less than 3 characters
+function omitLastThree(str) {
+  return str.replace(/.{0,3}$/, matched => matched.replace(/./g, '.'))
+}
+
+export default truncateToNChars

package/dist/validate-array-keys.cjs

@@ -0,0 +1,19 @@
+const truncateToNChars = require('./truncate-to-n-chars.cjs')
+
+const validateArrayKeys = (keys, utilName) => {
+  const multiDigitRe = /^[1-9]\d+$/
+  const singleDigitRe = /^\d$/
+
+  for (const k of keys) {
+    const isValidKey =
+      (typeof k === 'number' && Number.isInteger(k) && k >= 0) ||
+      (typeof k === 'string' && (multiDigitRe.test(k) || singleDigitRe.test(k)))
+    if (!isValidKey) {
+      let msg = `when calling ${utilName} with an array, 'keys' must all be integers zero or above`
+      msg += `\n  invalid key found: ${truncateToNChars(20, k)}`
+      throw new Error(msg)
+    }
+  }
+}
+
+module.exports = validateArrayKeys

package/dist/validate-array-keys.d.cts

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

package/dist/validate-array-keys.d.ts

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

package/dist/validate-array-keys.mjs

@@ -0,0 +1,19 @@
+import truncateToNChars from './truncate-to-n-chars.mjs'
+
+const validateArrayKeys = (keys, utilName) => {
+  const multiDigitRe = /^[1-9]\d+$/
+  const singleDigitRe = /^\d$/
+
+  for (const k of keys) {
+    const isValidKey =
+      (typeof k === 'number' && Number.isInteger(k) && k >= 0) ||
+      (typeof k === 'string' && (multiDigitRe.test(k) || singleDigitRe.test(k)))
+    if (!isValidKey) {
+      let msg = `when calling ${utilName} with an array, 'keys' must all be integers zero or above`
+      msg += `\n  invalid key found: ${truncateToNChars(20, k)}`
+      throw new Error(msg)
+    }
+  }
+}
+
+export default validateArrayKeys

package/dist/validate-is-between-input.cjs

@@ -0,0 +1,20 @@
+const assertArgIsType = require('./assert-arg-is-type.cjs')
+
+const validateIsBetweenInput = (
+  val1,
+  val1Name,
+  val2,
+  val2Name,
+  type,
+  utilName,
+  { exclusiveMin, exclusiveMax } = {}
+) => {
+  assertArgIsType(val1, val1Name, type, utilName)
+  assertArgIsType(val2, val2Name, type, utilName)
+  if (exclusiveMin !== undefined)
+    assertArgIsType(exclusiveMin, 'exclusiveMin', 'boolean', utilName)
+  if (exclusiveMax !== undefined)
+    assertArgIsType(exclusiveMax, 'exclusiveMax', 'boolean', utilName)
+}
+
+module.exports = validateIsBetweenInput

package/dist/validate-is-between-input.d.cts

@@ -0,0 +1,2 @@
+import { default as validateIsBetweenInput } from '@common-fp/shared-internals-types/validate-is-between-input'
+export = validateIsBetweenInput

package/dist/validate-is-between-input.d.ts

@@ -0,0 +1 @@
+export { default } from '@common-fp/shared-internals-types/validate-is-between-input'

package/dist/validate-is-between-input.mjs

@@ -0,0 +1,20 @@
+import assertArgIsType from './assert-arg-is-type.mjs'
+
+const validateIsBetweenInput = (
+  val1,
+  val1Name,
+  val2,
+  val2Name,
+  type,
+  utilName,
+  { exclusiveMin, exclusiveMax } = {}
+) => {
+  assertArgIsType(val1, val1Name, type, utilName)
+  assertArgIsType(val2, val2Name, type, utilName)
+  if (exclusiveMin !== undefined)
+    assertArgIsType(exclusiveMin, 'exclusiveMin', 'boolean', utilName)
+  if (exclusiveMax !== undefined)
+    assertArgIsType(exclusiveMax, 'exclusiveMax', 'boolean', utilName)
+}
+
+export default validateIsBetweenInput

package/dist/validate-object-keys.cjs

@@ -0,0 +1,13 @@
+const ct = require('./common-types.cjs')
+
+const validateObjectKeys = (keys, utilName) => {
+  for (const k of keys) {
+    if (!ct.objectKey.has(typeof k)) {
+      let msg = `when calling ${utilName} with an object, 'keys' must all be typeof string or number`
+      msg += `\n  invalid key type found: ${typeof k}`
+      throw new Error(msg)
+    }
+  }
+}
+
+module.exports = validateObjectKeys

package/dist/validate-object-keys.d.cts

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

package/dist/validate-object-keys.d.ts

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

package/dist/validate-object-keys.mjs

@@ -0,0 +1,13 @@
+import * as ct from './common-types.mjs'
+
+const validateObjectKeys = (keys, utilName) => {
+  for (const k of keys) {
+    if (!ct.objectKey.has(typeof k)) {
+      let msg = `when calling ${utilName} with an object, 'keys' must all be typeof string or number`
+      msg += `\n  invalid key type found: ${typeof k}`
+      throw new Error(msg)
+    }
+  }
+}
+
+export default validateObjectKeys

package/dist/validate-range.cjs

@@ -0,0 +1,14 @@
+/**
+ * validateRange assumes we're validating the range of array indices.  Use
+ * 'validateIsBetweenInput' if you're trying to validate more general types e.g.
+ * a date range or decimals
+ */
+
+const assertArgIsInt = require('./assert-arg-is-int.cjs')
+
+const validateRange = (startIdx, endIdx, utilName) => {
+  assertArgIsInt(startIdx, 'startIdx', utilName, { nonNegative: true })
+  assertArgIsInt(endIdx, 'endIdx', utilName, { nonNegative: true })
+}
+
+module.exports = validateRange

package/dist/validate-range.d.cts

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

package/dist/validate-range.d.ts

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

package/dist/validate-range.mjs

@@ -0,0 +1,14 @@
+/**
+ * validateRange assumes we're validating the range of array indices.  Use
+ * 'validateIsBetweenInput' if you're trying to validate more general types e.g.
+ * a date range or decimals
+ */
+
+import assertArgIsInt from './assert-arg-is-int.mjs'
+
+const validateRange = (startIdx, endIdx, utilName) => {
+  assertArgIsInt(startIdx, 'startIdx', utilName, { nonNegative: true })
+  assertArgIsInt(endIdx, 'endIdx', utilName, { nonNegative: true })
+}
+
+export default validateRange

package/license.txt

@@ -0,0 +1,106 @@
+There are two sections in this file
+
+1. The license for this package
+2. The licenses for dependencies embedded in this package
+
+#############
+# Section 1 #
+#############
+
+You can choose between either of the two licenses listed below
+
+WTFNMF
+Zero-Clause BSD
+
+This choice is offered since WTFNMF is not OSI approved.
+
+--------------------
+
+DO WHAT THE FUCK YOU WANT TO BUT IT'S NOT MY FAULT PUBLIC LICENSE
+Version 1, October 2013
+
+Copyright Phil Olson <philip.olson@pm.me>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+DO WHAT THE FUCK YOU WANT TO BUT IT'S NOT MY FAULT PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. You just DO WHAT THE FUCK YOU WANT TO.
+
+1. Do not hold the author(s), creator(s), developer(s) or
+   distributor(s) liable for anything that happens or goes wrong
+   with your use of the work.
+
+--------------------
+
+Copyright Phil Olson <philip.olson@pm.me>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
+
+--------------------
+
+#############
+# Section 2 #
+#############
+
+license for type-detect embedded at ./src/deps/type-detect.mjs
+from github.com/chaijs/type-detect#4415ced2c49007f097627515806553e7f649c293Z
+
+Copyright (c) 2013 Jake Luer <jake@alogicalparadox.com> (http://alogicalparadox.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+--------------------
+
+license for universal-eol embedded at ./src/deps/universal-eol.mjs
+from https://github.com/p2227/universal-eol#b3139118238f207a6ff38850b4134ebd4754ff07
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+--------------------

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@common-fp/shared-internals",
+  "description": "Code used to build common-fp utilities",
+  "private": false,
+  "version": "0.1.0",
+  "main": "dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./*": {
+      "import": "./dist/*.mjs",
+      "require": "./dist/*.cjs",
+      "types": "./dist/*.d.ts"
+    },
+    "./deps/*": null,
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "common-fp",
+    "shared-internals"
+  ],
+  "author": "Phil Olson",
+  "license": "SEE LICENSE IN license.txt",
+  "peerDependenciesMeta": {
+    "@common-fp/shared-internals-types": {
+      "optional": true
+    }
+  },
+  "peerDependencies": {
+    "@common-fp/shared-internals-types": "^0.1.0"
+  }
+}

package/readme.md

@@ -0,0 +1,10 @@
+## Common FP - Shared Internals
+
+On npm: `@common-fp/shared-internals`
+
+This holds functions used to build the `common-fp` utilities - things like
+input assertions and determining the input type.
+
+This package exists because originally I imagined sharing the internals for
+other devs to build their own FP utilities. But I've decided to wait on that
+because it would take time to refine the API and write documentation.