deverything 3.1.1 → 3.3.0

package/README.md

@@ -7,6 +7,7 @@ The promise:
 - **✅ 1 package**: say goodbye to lodash, faker, and the other package you don't recall the name of.
 - **⭕ 0 dependencies**: keep it simple and lightweight.
 - **🏆 Pick the best**: the code is minimal and uses the best practices for max performance.
+- **🤖 AI**: Functions are reviewed by AI to make sure all corner cases are covered.
 - **👪🏼 Typescript**: use it, support it and export it.
 - **🌊 Intuitive**: favour always the most intuitive API and common usage, _never_ throw error unless asked to.
 - **🙈 Semantic**: use simple function names that are easy to remember, no complicated options.
@@ -16,6 +17,7 @@ Contributions always welcome!
 ### Validators
 
 - `isArray()`
+- `isArrayIncluded()`
 - `isBoolean()`
 - `isBrowser()` to detect if you are on the browser
 - `isBuffer()` if it's a buffer
@@ -41,6 +43,7 @@ Contributions always welcome!
   - `isPositiveInt()`
   - `isNegativeInt()`
 - `isNumeric()` if string is representing a number
+- `isNumericId()` if it's a valid numeric ID
 - ⭐ `isObject()` if it's a js plain Object
 - `isPromise()` if it's a promise
 - `isPWA()` to detect if you are on a PWA
@@ -49,18 +52,24 @@ Contributions always welcome!
 - ⭐ `isSame()` Compare if dates, functions, arrays, objects or anything else are the same
 - `isSequence()` if the array is a perfect sequence
 - `isServer()` if you are on the server
+- `isSpacedString()` if string contains spaces
 - `isString()`
 - `isURL()`
 - `isUUID()` if it's a valid UUID
+- `isValue()` if it's a defined value (not null, undefined, or empty string)
 
 ### Dates
 
+- `getDateRangeSeries()` generate a series of dates within a range
 - `isOver18()`
+- `startOfDay()` get the start of a specific day
 - `startOfNextMonth()`
 - `startOfNextWeek()`
 - `startOfThisWeek()`
 - `startOfToday()`
 - `startOfTomorrow()`
+- `startOfUTCDay()` get the start of a specific day in UTC
+- `startOfUTCTomorrow()` get the start of tomorrow in UTC
 
 ### Math
 
@@ -82,14 +91,22 @@ Contributions always welcome!
   - `arrayDiff()` get the difference of two arrays
   - `arrayIntersection()` get the intersection of two arrays
 - `capitalize()` word => Word
+- `chunkArray()` split array into chunks
+- `chunkedAll()` process all items in chunks
+- `chunkedAsync()` process async operations in chunks
+- `chunkedDynamic()` process with dynamic chunk sizes
 - `clamp()` clamp number in a range
 - `cleanSpaces()` trims and turns double spaces into single space
+- `cyclicalItem()` get item from array with cyclical indexing
+- `dir()` get directory listing
 - `enumKeys()` enum FRUIT { APPLE, PEAR } => ["APPLE", "PEAR"]
 - `enumValues()` enum FRUIT { APPLE = 1, PEAR = 3 } => [1, 3]
 - `filterAlphanumeric()` remove non-alphanumeric characters
 - `first()` get the first element of an array
 - `firstKey()` get the first key of an object
 - `firstValue()` get the first value of an object
+- `getCookieByName()` get cookie value by name
+- `getKeys()` get all keys from an object
 - `getUrlSearchParam()` get URL search param
 - `getUrlSearchParams()` get URL search params
 - `groupByKey()`
@@ -99,15 +116,21 @@ Contributions always welcome!
 - `lastIndex()` get the last index of an array
 - `mapByKey()`
 - ⭐ `merge()` deep merge objects
+- `mergeArrays()` merge multiple arrays
 - `moveToFirst()` move array element to first
 - `moveToIndex()` move array element to desired index
 - `moveToLast()` move array element to last
 - `normalizeNumber()` normalizes between 0 and 1
 - `objectDiff()` get the difference between two objects
+- `omit()` omit properties from object
 - ⭐ `parseDate()` pass anything Date-Like, and get a JS Date back
+- `pickObjectKeys()` pick specific keys from object
+- `pickObjectValues()` pick specific values from object
 - `pluck()` make array of value from object keys
 - `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.
+- `removeUndefinedValues()` remove undefined values from object
 - `scrambleText()` replace alpha chars with random chars
+- `serialize()` serialize object to string
 - `seriesAsync()` executes promises in series, and returns all results
 - `setObjectPath()` set a value in an object by path
 - `setUrlSearchParams()` set URL search params
@@ -125,6 +148,7 @@ Contributions always welcome!
 - `formatNumber()` 1000 => "1,000" or "1K" or 0.112 => "11.2%"
 - `formatPercentage()` 0.11 => "11%"
 - `formatIndexProgress()` => "[2/10]"
+- `formatProgress()` format progress as percentage
 - `stringToCSSUnicode()` "hello" => "\000068\000065\00006c\00006c\00006f" use this for CSS
 - `stringToUnicode()` "hello" => "\u0068\u0065\u006c\u006c\u006f"
 
@@ -150,6 +174,7 @@ These functions are optimized for low entropy random data generation useful for
   - `randomDateRange()` => { startDate, endDate }
 - `randomEmail()`
 - `randomEmoji()`
+- `randomEmptyValue()` random empty value (null, undefined, empty string)
 - `randomEnumKey()` enum FRUIT { APPLE, PEAR } => APPLE
 - `randomEnumValue()` enum FRUIT { APPLE = 1, PEAR = 3 } => 3
 - `randomFile()`
@@ -189,29 +214,27 @@ These functions are optimized for low entropy random data generation useful for
 - `DateLike`
 - `Defined<T>`
 - `Dimensions`
+- `Function`
 - `HashMap<>`
   - `BoolMap`
   - `NumberMap`
   - `StringMap`
   - `TrueMap`
 - `Key`
+- `Matrix`
 - `Maybe<>`
   - `MaybePromise<>`
   - `MaybePromiseOrValue<>`
   - `MaybePromiseOrValueArray<>`
 - `NonUndefined`
-- `ObjectEntries<>`
-- `ObjectEntry<>`
-- `ObjectKey<>`
-- `ObjectKeys<>`
-- `ObjectValue<>`
-- `ObjectValues<>`
-- ⭐ `PlainObject` use this instead of `Record<,>` or `extends object`, also makes sure it's not an array
+- `Object`
 - `PickDefined<T, K>`
 - `PickRequired<T, K>`
 - `PlainKey`
 - `Point`
-- `VoidFn`
+- `PrismaSelect`
+- `Serialized`
+- `Tuple`
 
 ## Development
 

package/dist/index.d.ts

@@ -25,10 +25,11 @@ type ISOYear = string;
  * @example "America/New_York"
  */
 type Timezone = string;
-type DateRange = {
-    startDate: DateLike;
-    endDate: DateLike;
+type DateRange<T extends DateLike = DateLike> = {
+    startDate: T;
+    endDate: T;
 };
+type DateSeries<T extends DateLike = DateLike> = T[];
 
 /**
  * Makes all keys required and removes undefined and null from the value types.
@@ -144,7 +145,7 @@ type Serialized<T> = T extends Date ? string : T extends Array<infer R> ? Array<
  * @description Generate a series of dates between the start and end dates
  * NOTE: it does NOT include the end date
  */
-declare const getDateRangeSeries: (dateRange: DateRange, unit: "days" | "hours" | "minutes" | "seconds") => ISODate[];
+declare const getDateRangeSeries: (dateRange: DateRange, unit: "day" | "hour" | "minute" | "second" | "calendarMonth") => ISODate[];
 
 /**
  *
@@ -152,8 +153,22 @@ declare const getDateRangeSeries: (dateRange: DateRange, unit: "days" | "hours"
  */
 declare const getDateSeries: (startDate: Date, endDate: Date, unit: "days" | "hours" | "minutes" | "seconds") => ISODate[];
 
+/**
+ * @description Returns the smallest and biggest dates from an array of dates in DateRange format
+ * @param dates - Array of dates to find the range for
+ * @returns DateRange object with startDate (smallest) and endDate (biggest)
+ * @throws Error if the array is empty or contains invalid dates
+ */
+declare const getDateSeriesRange: (dateSeries: DateSeries<DateLike>) => DateRange;
+
 declare const isOver18: (birthDate: DateLike) => boolean;
 
+/**
+ * Note: This function does not use defaults, use startOfToday instead.
+ *
+ * @param day - The date to get the start of the day for.
+ * @returns A new Date object set to the start of the day.
+ */
 declare const startOfDay: (day: Date) => Date;
 
 declare const startOfNextMonth: () => Date;
@@ -168,6 +183,14 @@ declare const startOfTomorrow: () => Date;
 
 declare const startOfUTCDay: (date: Date) => Date;
 
+/**
+ * Returns the start of tomorrow (00:00:00.000) in UTC time.
+ *
+ * @param date - The date to calculate tomorrow from. Defaults to current date if not provided.
+ * @returns A new Date object set to the start of tomorrow in UTC time.
+ */
+declare const startOfUTCTomorrow: () => Date;
+
 declare const formatCamelCase: (str: string) => string;
 
 /**
@@ -848,4 +871,4 @@ declare const isUUID: (arg: string) => boolean;
 
 declare const isValue: <T>(arg?: Maybe<T>) => arg is T;
 
-export { BoolMap, Coords, DateLike, DateRange, Datey, Defined, Dimensions, HashMap, ISODate, ISODay, ISOMonth, ISOYear, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PickDefined, PickRequired, PlainKey, PlainObject, Point, PrismaSelect, Serialized, StringMap, Timezone, TrueMap, VoidFn, array, arrayDiff, arrayIntersection, average, capitalize, chunkArray, chunkedAll, chunkedAsync, chunkedDynamic, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, filterAlphanumeric, first, firstKey, firstValue, formatCamelCase, formatCookies, formatIndexProgress, formatNumber, formatPercentage, formatProgress, formatTrpcInputQueryString, getCookieByName, getDateRangeSeries, getDateSeries, getKeys, getUrlSearchParam, getUrlSearchParams, groupByKey, incrementalId, isArray, isArrayIncluded, isBetween, isBigInt, isBigIntString, 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, isOutsideInt4, isOver18, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isSequence, isServer, isSpacedString, isStrictlyBetween, isString, isStringDate, isURL, isUUID, isValue, keysLength, last, lastIndex, mapByKey, max, merge, mergeArrays, min, moveToFirst, moveToLast, multiply, noop, normaliseArray, normaliseNumber, normalizeNumber, objectDiff, omit, parseDate, percentageChange, pickObjectKeys, pickObjectValues, pluck, prismaDateRange, promiseWithTimeout, randomAddress, randomAlphaNumericCode, randomArray, randomArrayItem, randomBankAccount, randomBigInt, randomBool, randomChar, randomCompany, randomCoords, randomDate, randomDateRange, randomEmail, randomEmoji, randomEmptyValue, 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, randomObject, randomParagraph, randomPassword, randomPastDate, randomPath, randomPhoneNumber, randomPositiveInt, randomString, randomSymbol, randomUUID, randomValue, randomVerb, randomWord, removeUndefinedValues, scrambleText, serialize, seriesAsync, setObjectPath, setUrlSearchParams, shuffle, sleep, startOfDay, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, startOfUTCDay, stringToCSSUnicode, stringToUnicode, stringify, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };
+export { BoolMap, Coords, DateLike, DateRange, DateSeries, Datey, Defined, Dimensions, HashMap, ISODate, ISODay, ISOMonth, ISOYear, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PickDefined, PickRequired, PlainKey, PlainObject, Point, PrismaSelect, Serialized, StringMap, Timezone, TrueMap, VoidFn, array, arrayDiff, arrayIntersection, average, capitalize, chunkArray, chunkedAll, chunkedAsync, chunkedDynamic, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, filterAlphanumeric, first, firstKey, firstValue, formatCamelCase, formatCookies, formatIndexProgress, formatNumber, formatPercentage, formatProgress, formatTrpcInputQueryString, getCookieByName, getDateRangeSeries, getDateSeries, getDateSeriesRange, getKeys, getUrlSearchParam, getUrlSearchParams, groupByKey, incrementalId, isArray, isArrayIncluded, isBetween, isBigInt, isBigIntString, 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, isOutsideInt4, isOver18, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isSequence, isServer, isSpacedString, isStrictlyBetween, isString, isStringDate, isURL, isUUID, isValue, keysLength, last, lastIndex, mapByKey, max, merge, mergeArrays, min, moveToFirst, moveToLast, multiply, noop, normaliseArray, normaliseNumber, normalizeNumber, objectDiff, omit, parseDate, percentageChange, pickObjectKeys, pickObjectValues, pluck, prismaDateRange, promiseWithTimeout, randomAddress, randomAlphaNumericCode, randomArray, randomArrayItem, randomBankAccount, randomBigInt, randomBool, randomChar, randomCompany, randomCoords, randomDate, randomDateRange, randomEmail, randomEmoji, randomEmptyValue, 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, randomObject, randomParagraph, randomPassword, randomPastDate, randomPath, randomPhoneNumber, randomPositiveInt, randomString, randomSymbol, randomUUID, randomValue, randomVerb, randomWord, removeUndefinedValues, scrambleText, serialize, seriesAsync, setObjectPath, setUrlSearchParams, shuffle, sleep, startOfDay, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, startOfUTCDay, startOfUTCTomorrow, stringToCSSUnicode, stringToUnicode, stringify, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };