deverything 0.47.2 → 0.48.1

package/README.md

@@ -15,42 +15,42 @@ Contributions always welcome!
 
 ### Validators
 
-- `isArray()`
-- `isBoolean()`
+- `isArray()` 
+- `isBoolean()` 
 - `isBrowser()` to detect if you are on the browser
-- `isBuffer()`
+- `isBuffer()` if it's a buffer
 - `isClient()` same as isBrowser
 - `isEmail()` this is a relaxed check, use your own validation if you need to be strict
 - ⭐ `isEmpty()` to check for empty object, empty array, empty string, null or undefined
   - `isEmptyString()` trims the string and checks if something is left
-  - `isEmptyArray()`
-  - `isEmptyObject()`
-- `isFile()`
-- `isFunction()`
+  - `isEmptyArray()` checks if the array has no items
+  - `isEmptyObject()` checks if the object has no keys
+- `isFile()` if it's a file
+- `isFunction()` 
 - `isJsDate()` if it's a **valid** javascript's Date
-  - `isFutureDate()`
-  - `isPastDate()`
+  - `isFutureDate()` 
+  - `isPastDate()` 
   - `isStringDate()` also checks if the string passed is a **valid** date
 - `isKey()` is a real key of an object
 - `isLastIndex()` is the index is the last item of array
 - `isNotEmptyString()` must have some text, checks for spaces-only
 - `isNumber()` if the arg is number, and also usable (no infinity)
-  - `isInt()`
-  - `isEven()`
-  - `isOdd()`
-  - `isPositiveInt()`
-  - `isNegativeInt()`
+  - `isInt()` if it's an integer
+  - `isEven()` 
+  - `isOdd()` 
+  - `isPositiveInt()` 
+  - `isNegativeInt()` 
 - `isNumeric()` if string is representing a number
 - ⭐ `isObject()` if it's a js plain Object
-- `isPromise()`
-- `isPWA()`
-- `isReactElement()`
-- `isRegExp()`
+- `isPromise()` if it's a promise
+- `isPWA()` to detect if you are on a PWA
+- `isReactElement()` if it's a valid React Element
+- `isRegExp()` if it's a valid RegExp
 - ⭐ `isSame()` Compare if dates, functions, arrays, objects or anything else are the same
 - `isServer()` if you are on the server
 - `isString()`
-- `isURL()`
-- `isUUID()`
+- `isURL()` 
+- `isUUID()` if it's a valid UUID
 
 ### Math
 
@@ -64,20 +64,20 @@ Contributions always welcome!
 ### Helpers
 
 - `array()` create an arbitrary array based on a function
-  - `arrayDiff()`
-  - `arrayIntersection()`
+  - `arrayDiff()` get the difference of two arrays
+  - `arrayIntersection()` get the intersection of two arrays
 - `capitalize()` word => Word
 - `cleanSpaces()` trims and turns double spaces into single space
 - `clamp()` clamp number in a range
 - `enumKeys()` enum FRUIT { APPLE, PEAR } => ["APPLE", "PEAR"]
 - `enumValues()` enum FRUIT { APPLE = 1, PEAR = 3 } => [1, 3]
 - `first()` get the first element of an array
-- `firstKey()`
-- `firstValue()`
-- `getUrlSearchParam()`
-- `getUrlSearchParams()`
+- `firstKey()` get the first key of an object
+- `firstValue()` get the first value of an object
+- `getUrlSearchParam()` get URL search param
+- `getUrlSearchParams()` get URL search params
 - `incrementalId()` autoincremental SQL-like, process-unique numeric id
-- `keysLength()`
+- `keysLength()` get the length of keys in an object
 - `last()` get the last element of an array
 - `lastIndex()` get the last index of an array
 - ⭐ `merge()` deep merge objects
@@ -85,13 +85,14 @@ Contributions always welcome!
 - `moveToIndex()` move array element to desired index
 - `moveToLast()` move array element to last
 - `normalizeNumber()` normalizes between 0 and 1
-- `objectDiff()`
+- `objectDiff()` get the difference between two objects
 - ⭐ `parseDate()` pass anything Date-Like, and get a JS Date back
 - `pretty()` stringify anything, without breaking on circular dependencies
 - `promiseWithTimeout()` takes a promise, a timeoutMs, and an option error as arguments. Returns a new Promise that either resolves with the value of the input promise or rejects with the provided error or a default error message if the input promise does not resolve or reject within the specified timeoutMs.
 - `scrambleText()` replace alpha chars with random chars
 - `seriesAll()` executes promises in series, and returns all results
-- `setUrlSearchParams()`
+- `setObjectPath()` set a value in an object by path
+- `setUrlSearchParams()` set URL search params
 - `shuffle()` shuffles elements in an array
 - `sleep()` promise-based sleep
 - `toggleArrayValue()` remove/add value in array
@@ -111,7 +112,7 @@ Contributions always welcome!
 
 These functions are optimized for low entropy random data generation useful for Unit Testing, Storybook, Pass real validations, Reverse hacking, Penetration testing...
 
-- `randomAddress()`
+- `randomAddress()` 
 - `randomAlphaNumericCode()`
 - ⭐ `randomArrayItem()` now supporting non-uniform distribution
 - `randomBankAccount()`
@@ -182,6 +183,7 @@ Checks are functions that throw an error, if the validation fails
 - `ObjectEntry<>`
 - `ObjectEntries<>`
 - ⭐ `PlainObject` use this instead of `Record<,>` or `extends object`, also makes sure it's not an array
+- `PlainKey`
 - `Point`
 - `HashMap<>`
   - `BoolMap`

package/dist/index.d.ts

@@ -117,6 +117,7 @@ declare const cyclicalItem: <T>(array: T[], index: number) => T;
 declare const dir: (arg: any, depth?: number) => void;
 
 type Key = string | number | symbol;
+type PlainKey = string | number;
 type ObjectKey<T> = keyof T;
 type ObjectKeys<T> = ObjectKey<T>[];
 type ObjectValue<T> = T[keyof T];
@@ -125,6 +126,13 @@ type ObjectEntry<T> = {
     [K in keyof T]: [K, T[K]];
 }[keyof T];
 type ObjectEntries<T> = ObjectEntry<T>[];
+/**
+ * A plain object is an object that is not an array, does not have a length property, and is not a function.
+ * Would have been nice to call it just Object, but that's already taken by the built-in type.
+ */
+type PlainObject<T = any> = Record<PlainKey, T> & {
+    length?: never;
+};
 
 declare const enumKeys: <T extends object>(arg: T) => ObjectKeys<T>;
 
@@ -149,11 +157,11 @@ type Dimensions = {
     height: number;
 };
 
-type HashMap<T> = Record<Key, T>;
-type NumberMap = Record<Key, number>;
-type StringMap = Record<Key, string>;
-type BoolMap = Record<Key, boolean>;
-type TrueMap = Record<Key, true>;
+type HashMap<T> = Record<PlainKey, T>;
+type NumberMap = Record<PlainKey, number>;
+type StringMap = Record<PlainKey, string>;
+type BoolMap = Record<PlainKey, boolean>;
+type TrueMap = Record<PlainKey, true>;
 
 type Matrix<T> = T[][];
 
@@ -164,14 +172,6 @@ type MaybePromiseOrValueArray<T> = MaybePromiseOrValue<T>[];
 
 type NonUndefined<T> = T extends undefined ? never : T;
 
-/**
- * A plain object is an object that is not an array, does not have a length property, and is not a function.
- * Would have been nice to call it just Object, but that's already taken by the built-in type.
- */
-type PlainObject<T = any> = Record<Key, T> & {
-    length?: never;
-};
-
 type Point = {
     x: number;
     y: number;
@@ -276,6 +276,15 @@ declare const serialize: <T extends PlainObject<any>>(obj: T) => string;
  */
 declare const seriesAll: <T>(series: Function[]) => Promise<T[]>;
 
+/**
+ * Sets a value in an object using a dot-separated path.
+ *
+ * @param obj The object to set the value in.
+ * @param path The path to the key to set, separated by dots.
+ * @param value The value to set.
+ */
+declare const setObjectPath: (obj: PlainObject, path: string, value: any) => void;
+
 declare const setUrlSearchParams: (currentURL: string, searchParams?: Record<string, string | number | boolean>) => string;
 
 declare const shuffle: <T>(array: T[]) => T[];
@@ -306,12 +315,16 @@ declare const uniqueValues: (arr: any[]) => any[];
  */
 declare const average: (numbers: number[]) => number;
 
+declare const isBetween: (value: number, min: number, max: number) => boolean;
+
 declare const max: (values: number[]) => number;
 
 declare const min: (values: number[]) => number;
 
 declare const multiply: (numbers: number[]) => number;
 
+declare const isOutside: (value: number, min: number, max: number) => boolean;
+
 declare const percentageChange: ({ previous, current, }: {
     previous: number;
     current: number;
@@ -543,7 +556,7 @@ declare const isFutureDate: (arg: DateLike) => boolean;
 
 declare const isJsDate: (arg: Date) => arg is Date;
 
-declare const isKey: <T extends object>(key: Key, obj: T) => key is keyof T;
+declare const isKey: <T extends PlainObject<any>>(key: Key, obj: T) => key is keyof T;
 
 declare const isLastIndex: (index: number, array: any[]) => boolean;
 
@@ -603,4 +616,4 @@ declare const isUUID: (arg: string) => boolean;
 
 declare const isValue: (arg?: Maybe<any>) => boolean;
 
-export { BoolMap, Coords, DateLike, DateRange, Datey, Dimensions, HashMap, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PlainObject, Point, PrismaSelect, Serialized, StringMap, TrueMap, WithDatey, array, arrayDiff, arrayIntersection, average, capitalize, checkEnvVars, chunkArray, chunkedAll, chunkedAsync, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, first, firstKey, firstValue, formatCamelCase, formatNumber, formatPercentage, formatProgress, formatTrpcInputQueryString, getCookieByName, getEnumerableOwnPropertySymbols, getKeys, getUrlSearchParam, getUrlSearchParams, incrementalId, isArray, isArrayIncluded, isBoolean, isBrowser, isBuffer, isClient, isEmail, isEmpty, isEmptyArray, isEmptyObject, isEmptyString, isEven, isFile, isFunction, isFutureDate, isInt, isJsDate, isKey, isLastIndex, isNegative, isNegativeInt, isNotEmptyString, isNumber, isNumeric, isNumericId, isObject, isOdd, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isServer, isSpacedString, isString, isStringDate, isURL, isUUID, isValue, keysLength, last, lastIndex, max, merge, mergeArrays, min, moveToFirst, moveToLast, multiply, normalizeNumber, objectDiff, omit, parseDate, percentageChange, pickObjectKeys, pickObjectValues, pretty, prismaDateRange, promiseWithTimeout, randomAddress, randomAlphaNumericCode, randomArrayItem, randomBankAccount, randomBool, randomChar, randomCompany, randomCoords, randomDate, randomDateRange, randomEmail, randomEmoji, randomEnumKey, randomEnumValue, randomFile, randomFirstName, randomFloat, randomFormattedPercentage, randomFullName, randomFutureDate, randomHandle, randomHexColor, randomHexValue, randomHtmlColorName, randomIBAN, randomIP, randomInt, randomLastName, randomLat, randomLng, randomMaxDate, randomMaxInt, randomMaxSafeInt, randomName, randomNegativeInt, randomNoun, randomNumericCode, randomNumericId, randomParagraph, randomPassword, randomPastDate, randomPath, randomPercentage, randomPhoneNumber, randomPositiveInt, randomPositivePercentage, randomString, randomUUID, randomVerb, randomWord, scrambleText, serialize, seriesAll, setUrlSearchParams, shuffle, sleep, stringToCSSUnicode, stringToUnicode, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };
+export { BoolMap, Coords, DateLike, DateRange, Datey, Dimensions, HashMap, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PlainKey, PlainObject, Point, PrismaSelect, Serialized, StringMap, TrueMap, WithDatey, array, arrayDiff, arrayIntersection, average, capitalize, checkEnvVars, chunkArray, chunkedAll, chunkedAsync, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, first, firstKey, firstValue, formatCamelCase, formatNumber, formatPercentage, formatProgress, formatTrpcInputQueryString, getCookieByName, getEnumerableOwnPropertySymbols, getKeys, getUrlSearchParam, getUrlSearchParams, incrementalId, isArray, isArrayIncluded, isBetween, isBoolean, isBrowser, isBuffer, isClient, isEmail, isEmpty, isEmptyArray, isEmptyObject, isEmptyString, isEven, isFile, isFunction, isFutureDate, isInt, isJsDate, isKey, isLastIndex, isNegative, isNegativeInt, isNotEmptyString, isNumber, isNumeric, isNumericId, isObject, isOdd, isOutside, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isServer, isSpacedString, isString, isStringDate, isURL, isUUID, isValue, keysLength, last, lastIndex, max, merge, mergeArrays, min, moveToFirst, moveToLast, multiply, normalizeNumber, objectDiff, omit, parseDate, percentageChange, pickObjectKeys, pickObjectValues, pretty, prismaDateRange, promiseWithTimeout, randomAddress, randomAlphaNumericCode, randomArrayItem, randomBankAccount, randomBool, randomChar, randomCompany, randomCoords, randomDate, randomDateRange, randomEmail, randomEmoji, randomEnumKey, randomEnumValue, randomFile, randomFirstName, randomFloat, randomFormattedPercentage, randomFullName, randomFutureDate, randomHandle, randomHexColor, randomHexValue, randomHtmlColorName, randomIBAN, randomIP, randomInt, randomLastName, randomLat, randomLng, randomMaxDate, randomMaxInt, randomMaxSafeInt, randomName, randomNegativeInt, randomNoun, randomNumericCode, randomNumericId, randomParagraph, randomPassword, randomPastDate, randomPath, randomPercentage, randomPhoneNumber, randomPositiveInt, randomPositivePercentage, randomString, randomUUID, randomVerb, randomWord, scrambleText, serialize, seriesAll, setObjectPath, setUrlSearchParams, shuffle, sleep, stringToCSSUnicode, stringToUnicode, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };