deverything 0.42.2 → 0.44.0

package/README.md

@@ -18,12 +18,14 @@ Contributions always welcome!
 - `isArray()`
 - `isBoolean()`
 - `isBrowser()` to detect if you are on the browser
+- `isBuffer()`
 - `isClient()` to detect if you are ont the browser/client
 - `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()`
 - `isJsDate()` if it's a **valid** javascript's Date
   - `isFutureDate()`
@@ -98,6 +100,7 @@ Contributions always welcome!
 
 ### Formatters
 
+- `formatCamelCase()`
 - `formatNumber()` 1000 => "1,000" or "1K" or 0.112 => "11.2%"
 - `stringToUnicode()` "hello" => "\u0068\u0065\u006c\u006c\u006f"
 - `stringToCSSUnicode()` "hello" => "\000068\000065\00006c\00006c\00006f" use this for CSS
@@ -127,6 +130,7 @@ These functions are optimized for low entropy random data generation useful for
 - `randomEnumValue()` enum FRUIT { APPLE = 1, PEAR = 3 } => 3
 - `randomFile()`
 - `randomFloat()`
+- `randomObject()`
 - `randomHandle()` useful for social identifiers, or slugs
 - `randomHexColor()`
 - `randomHexValue()`
@@ -149,6 +153,7 @@ These functions are optimized for low entropy random data generation useful for
 - `randomPhoneNumber()`
 - `randomString()`
 - `randomUUID()` lightweight uuid generation, passing UUID validation
+- `randomValue()`
 - `randomWord()`
 
 ### Checks
@@ -167,20 +172,21 @@ Checks are functions that throw an error, if the validation fails
   - `MaybePromiseOrValue<>`
   - `MaybePromiseOrValueArray<>`
 - `NonUndefined`
+- `Key`
 - `ObjectKey<>`
 - `ObjectKeys<>`
 - `ObjectValue<>`
 - `ObjectValues<>`
+- `ObjectEntry<>`
 - `ObjectEntries<>`
 - ⭐ `PlainObject` use this instead of `Record<,>` or `extends object`, also makes sure it's not an array
 - `Point`
-- `PrismaSelect<>`
 - `HashMap<>`
-- `HashMapKey`
-- `NumberMap`
-- `StringMap`
-- `BoolMap`
-- `TrueMap`
+  - `BoolMap`
+  - `NumberMap`
+  - `StringMap`
+  - `TrueMap`
+- `VoidFn`
 
 ## Development
 

package/dist/index.d.ts

@@ -38,6 +38,25 @@ type Config = {
  */
 declare const checkEnvVars: (envVarsMap: Record<string, SimpleValidationRule | EnvValidation | WithEnvValidation>, config?: Config) => void;
 
+declare const formatCamelCase: (str: string) => string;
+
+/**
+ *
+ * @example formatNumber(1000, { compact: true }) // 1K
+ * @example formatNumber(1111, { maxDigits: 2 }) // 1,100
+ * @example formatNumber(111111.123123123) // 111,111.123
+ * @example formatNumber(0.12345, { percentage: true, maxDigits: 2 }) // '12.35%' (rounding)
+ */
+declare const formatNumber: (value: number, { compact, maxDigits, percentage, }?: {
+    compact?: boolean | undefined;
+    maxDigits?: number | undefined;
+    percentage?: boolean | undefined;
+}) => string;
+
+declare const stringToCSSUnicode: (text: string) => string;
+
+declare const stringToUnicode: (text: string) => string;
+
 declare const array: <U extends (...args: any) => any>(length: number, mapFn?: U) => ReturnType<U>[];
 
 declare const arrayDiff: (arr1: any[], arr2: any[]) => any[];
@@ -54,18 +73,25 @@ declare const clamp: ({ number, min, max, }: {
 
 declare const cleanSpaces: (str: string) => string;
 
+/**
+ * @returns element from array at index, if index is greater than array length, it will loop back to the start of the array
+ */
+declare const cyclicalItem: <T>(array: T[], index: number) => T;
+
 /**
  * Print or log helper that does not break on circular references, and expands nested objects.
  */
 declare const dir: (arg: any, depth?: number) => void;
 
+type Key = string | number | symbol;
 type ObjectKey<T> = keyof T;
 type ObjectKeys<T> = ObjectKey<T>[];
 type ObjectValue<T> = T[keyof T];
 type ObjectValues<T> = ObjectValue<T>[];
-type ObjectEntries<T> = {
+type ObjectEntry<T> = {
     [K in keyof T]: [K, T[K]];
-}[keyof T][];
+}[keyof T];
+type ObjectEntries<T> = ObjectEntry<T>[];
 
 declare const enumKeys: <T extends object>(arg: T) => ObjectKeys<T>;
 
@@ -90,12 +116,11 @@ type Dimensions = {
     height: number;
 };
 
-type HashMapKey = string | number | symbol;
-type HashMap<T> = Record<HashMapKey, T>;
-type NumberMap = Record<HashMapKey, number>;
-type StringMap = Record<HashMapKey, string>;
-type BoolMap = Record<HashMapKey, boolean>;
-type TrueMap = Record<HashMapKey, true>;
+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 Matrix<T> = T[][];
 
@@ -106,7 +131,11 @@ type MaybePromiseOrValueArray<T> = MaybePromiseOrValue<T>[];
 
 type NonUndefined<T> = T extends undefined ? never : T;
 
-type PlainObject = Record<string | symbol, any> & {
+/**
+ * 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;
 };
 
@@ -117,12 +146,16 @@ type Point = {
 
 type PrismaSelect<T> = Record<keyof T, true>;
 
-declare const firstKey: (arg: PlainObject) => string;
+declare const firstKey: <T extends PlainObject<any>>(arg: T) => keyof T;
 
-declare const firstValue: (arg: PlainObject) => any;
+declare const firstValue: <T extends PlainObject<any>>(arg: T) => ObjectValue<T>;
 
-declare const getKeys: (arg: object) => string[];
-declare const getEnumerableOwnPropertySymbols: (arg: object) => any[];
+/**
+ * TODO: rename to allKeys
+ * @deprecated use Object.keys instead unless you need to include symbols, but the function will be renamed to allKeys
+ */
+declare const getKeys: <T extends PlainObject<any>>(obj: T) => (string | symbol)[];
+declare const getEnumerableOwnPropertySymbols: (obj: object) => symbol[];
 
 declare const getUrlSearchParam: (urlString: Maybe<string>, param: string) => string | undefined;
 
@@ -130,7 +163,7 @@ declare const getUrlSearchParams: (urlString: Maybe<string>) => Record<string, s
 
 declare const incrementalId: () => number;
 
-declare const keysLength: <T extends PlainObject>(obj: T) => number;
+declare const keysLength: <T extends PlainObject<any>>(obj: T) => number;
 
 declare const last: <T>(arr: T[]) => T;
 
@@ -140,7 +173,13 @@ declare const lastIndex: (array: any[]) => number;
  * @description Simple merge function that merges two objects, arrays get overwritten, no options
  *
  */
-declare const merge: (target: PlainObject, source: PlainObject) => PlainObject;
+declare const merge: (target: PlainObject, source: PlainObject) => PlainObject<any>;
+
+/**
+ * @description Merge two arrays, unique values, no options
+ * @example mergeArrays([1,2,3], [2,3,4]) => [1,2,3,4]
+ */
+declare const mergeArrays: (arrayA: any[], arrayB: any[]) => any[];
 
 declare const moveToFirst: <T>(items: T[], condition: (item: T, i: number, items: T[]) => boolean) => T[];
 
@@ -152,15 +191,15 @@ declare const normalizeNumber: ({ value, max, min, }: {
     min: number;
 }) => number;
 
-declare const objectDiff: (leftObject: PlainObject, rightObject: PlainObject) => PlainObject;
+declare const objectDiff: (leftObject: PlainObject, rightObject: PlainObject) => PlainObject<any>;
 
-declare const omit: <T extends PlainObject>(obj: T, keys: (keyof T)[]) => Partial<T>;
+declare const omit: <T extends PlainObject<any>>(obj: T, keys: (keyof T)[]) => Partial<T>;
 
 declare const parseDate: (arg?: Maybe<DateLike>) => Date | undefined;
 
-declare const pickObjectKeys: <T extends PlainObject>(obj: T, keys: ObjectKeys<T>) => Partial<T>;
+declare const pickObjectKeys: <T extends PlainObject<any>>(obj: T, keys: ObjectKeys<T>) => Partial<T>;
 
-declare const pickObjectValues: <T extends PlainObject>(obj: T, values: ObjectValues<T>) => Partial<T>;
+declare const pickObjectValues: <T extends PlainObject<any>>(obj: T, values: ObjectValues<T>) => Partial<T>;
 
 declare const pretty: (arg?: any) => string;
 
@@ -169,13 +208,13 @@ declare const promiseWithTimeout: <T>(promise: () => Promise<T>, timeoutMs: numb
 declare const scrambleText: (str: string) => string;
 
 /**
- * Serialize plain object to a deterministic string,
+ * Serialize shallow object to a deterministic string,
  * for nested objects use [json-stable-stringify](https://www.npmjs.com/package/json-stable-stringify)
  *
  * @example
  * serialize({ b: 1, a: 2 }) // '{"a":1,"b":2}'
  */
-declare const serialize: <T extends PlainObject>(obj: T) => string;
+declare const serialize: <T extends PlainObject<any>>(obj: T) => string;
 
 /**
  *
@@ -223,8 +262,18 @@ declare const min: (values: number[]) => number;
 
 declare const multiply: (numbers: number[]) => number;
 
+declare const percentageChange: ({ previous, current, }: {
+    previous: number;
+    current: number;
+}) => number;
+
 declare const sum: (numbers: number[]) => number;
 
+declare const prismaDateRange: ({ startDate, endDate }: DateRange) => {
+    gte: Date;
+    lt: Date;
+};
+
 type RandomAddress = {
     city: string;
     country: string;
@@ -415,6 +464,8 @@ declare const randomWord: () => string;
 declare const randomNoun: () => string;
 declare const randomVerb: () => string;
 
+declare const formatTrpcInputQueryString: (input: PlainObject) => URLSearchParams;
+
 declare const isArray: <T>(arg?: any) => arg is T[];
 
 declare const isArrayIncluded: <T>(arr1: T[], arr2: T[]) => boolean;
@@ -423,6 +474,8 @@ declare const isBoolean: (arg: any) => arg is boolean;
 
 declare const isBrowser: () => boolean;
 
+declare const isBuffer: (val?: any) => boolean;
+
 declare const isClient: () => boolean;
 
 declare const isEmail: (arg: string) => boolean;
@@ -432,13 +485,15 @@ declare const isEmptyString: (arg: string) => boolean;
 declare const isEmptyArray: (arg: any[]) => boolean;
 declare const isEmptyObject: (arg: PlainObject) => boolean;
 
+declare const isFile: (arg?: any) => arg is File;
+
 declare const isFunction: (arg: any) => arg is Function;
 
 declare const isFutureDate: (arg: DateLike) => boolean;
 
 declare const isJsDate: (arg: Date) => arg is Date;
 
-declare const isKey: <T extends object>(key: string | number | symbol, obj: T) => key is keyof T;
+declare const isKey: <T extends object>(key: Key, obj: T) => key is keyof T;
 
 declare const isLastIndex: (index: number, array: any[]) => boolean;
 
@@ -463,7 +518,7 @@ declare const isNumeric: (arg: number | string) => boolean;
 
 declare const isNumericId: (id: string) => boolean;
 
-declare const isObject: <T>(arg?: any) => arg is Record<string, T>;
+declare const isObject: <T>(arg?: any) => arg is PlainObject<T>;
 
 declare const isPastDate: (arg: DateLike) => boolean;
 
@@ -491,21 +546,4 @@ declare const isUUID: (arg: string) => boolean;
 
 declare const isValue: (arg?: Maybe<any>) => boolean;
 
-/**
- *
- * @example formatNumber(1000, { compact: true }) // 1K
- * @example formatNumber(1111, { maxDigits: 2 }) // 1,100
- * @example formatNumber(111111.123123123) // 111,111.123
- * @example formatNumber(0.12345, { percentage: true, maxDigits: 2 }) // '12.35%' (rounding)
- */
-declare const formatNumber: (value: number, { compact, maxDigits, percentage, }?: {
-    compact?: boolean | undefined;
-    maxDigits?: number | undefined;
-    percentage?: boolean | undefined;
-}) => string;
-
-declare const stringToUnicode: (text: string) => string;
-
-declare const stringToCSSUnicode: (text: string) => string;
-
-export { BoolMap, Coords, DateLike, DateRange, Datey, Dimensions, HashMap, HashMapKey, JS_MAX_DIGITS, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PlainObject, Point, PrismaSelect, StringMap, TrueMap, array, arrayDiff, arrayIntersection, average, capitalize, checkEnvVars, clamp, cleanSpaces, dir, enumKeys, enumValues, first, firstKey, firstValue, formatNumber, getEnumerableOwnPropertySymbols, getKeys, getUrlSearchParam, getUrlSearchParams, incrementalId, isArray, isArrayIncluded, isBoolean, isBrowser, isClient, isEmail, isEmpty, isEmptyArray, isEmptyObject, isEmptyString, isEven, 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, min, moveToFirst, moveToLast, multiply, normalizeNumber, objectDiff, omit, parseDate, pickObjectKeys, pickObjectValues, pretty, 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, PlainObject, Point, PrismaSelect, StringMap, TrueMap, array, arrayDiff, arrayIntersection, average, capitalize, checkEnvVars, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, first, firstKey, firstValue, formatCamelCase, formatNumber, formatTrpcInputQueryString, 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 };