deverything 0.48.1 → 0.50.0

package/README.md

@@ -15,8 +15,8 @@ Contributions always welcome!
 
 ### Validators
 
-- `isArray()` 
-- `isBoolean()` 
+- `isArray()`
+- `isBoolean()`
 - `isBrowser()` to detect if you are on the browser
 - `isBuffer()` if it's a buffer
 - `isClient()` same as isBrowser
@@ -26,20 +26,20 @@ Contributions always welcome!
   - `isEmptyArray()` checks if the array has no items
   - `isEmptyObject()` checks if the object has no keys
 - `isFile()` if it's a file
-- `isFunction()` 
+- `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()` if it's an integer
-  - `isEven()` 
-  - `isOdd()` 
-  - `isPositiveInt()` 
-  - `isNegativeInt()` 
+  - `isEven()`
+  - `isOdd()`
+  - `isPositiveInt()`
+  - `isNegativeInt()`
 - `isNumeric()` if string is representing a number
 - ⭐ `isObject()` if it's a js plain Object
 - `isPromise()` if it's a promise
@@ -49,12 +49,24 @@ Contributions always welcome!
 - ⭐ `isSame()` Compare if dates, functions, arrays, objects or anything else are the same
 - `isServer()` if you are on the server
 - `isString()`
-- `isURL()` 
+- `isURL()`
 - `isUUID()` if it's a valid UUID
 
+### Dates
+
+- `isOver18()`
+- `startOfNextMonth()`
+- `startOfNextWeek()`
+- `startOfThisWeek()`
+- `startOfToday()`
+- `startOfTomorrow()`
+
 ### Math
 
 - `average()`
+- `isBetween()`
+- `isOutside()`
+- `isStrictlyBetween()`
 - `max()`
 - `min()`
 - `multiply()`
@@ -112,7 +124,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()`

package/dist/index.d.ts

@@ -38,6 +38,84 @@ type Config = {
  */
 declare const checkEnvVars: (envVarsMap: Record<string, SimpleValidationRule | EnvValidation | WithEnvValidation>, config?: Config) => void;
 
+type Coords = {
+    lat: number;
+    lng: number;
+};
+
+type DateLike = Date | string | number;
+type Datey = Date | string;
+type ISODate = string;
+type DateRange = {
+    startDate: DateLike;
+    endDate: DateLike;
+};
+
+type Dimensions = {
+    width: number;
+    height: number;
+};
+
+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];
+type ObjectValues<T> = ObjectValue<T>[];
+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;
+};
+
+type HashMap<T = any> = 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[][];
+
+type Maybe<T> = T | null | undefined;
+type MaybePromise<T> = Maybe<Promise<T>>;
+type MaybePromiseOrValue<T> = MaybePromise<T> | T;
+type MaybePromiseOrValueArray<T> = MaybePromiseOrValue<T>[];
+
+type NonUndefined<T> = T extends undefined ? never : T;
+
+type Point = {
+    x: number;
+    y: number;
+};
+
+type PrismaSelect<T> = Record<keyof T, true>;
+
+type Serialized<T> = T extends Date ? string : T extends Array<infer R> ? Array<Serialized<R>> : T extends object ? {
+    [K in keyof T]: Serialized<T[K]>;
+} : T;
+
+type WithDatey<T> = T extends Date ? Datey : T extends Array<infer R> ? Array<WithDatey<R>> : T extends object ? {
+    [K in keyof T]: WithDatey<T[K]>;
+} : T;
+
+declare const isOver18: (birthDate: DateLike) => boolean;
+
+declare const startOfNextMonth: () => Date;
+
+declare const startOfNextWeek: () => Date;
+
+declare const startOfThisWeek: () => Date;
+
+declare const startOfToday: () => Date;
+
+declare const startOfTomorrow: () => Date;
+
 declare const formatCamelCase: (str: string) => string;
 
 /**
@@ -116,77 +194,12 @@ 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];
-type ObjectValues<T> = ObjectValue<T>[];
-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>;
 
 declare const enumValues: <T extends object>(enumObject: T) => ObjectValues<T>;
 
 declare const first: <T>(arr?: T[] | undefined) => T | undefined;
 
-type Coords = {
-    lat: number;
-    lng: number;
-};
-
-type DateLike = Date | string | number;
-type Datey = Date | string;
-type DateRange = {
-    startDate: DateLike;
-    endDate: DateLike;
-};
-
-type Dimensions = {
-    width: number;
-    height: number;
-};
-
-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[][];
-
-type Maybe<T> = T | null | undefined;
-type MaybePromise<T> = Maybe<Promise<T>>;
-type MaybePromiseOrValue<T> = MaybePromise<T> | T;
-type MaybePromiseOrValueArray<T> = MaybePromiseOrValue<T>[];
-
-type NonUndefined<T> = T extends undefined ? never : T;
-
-type Point = {
-    x: number;
-    y: number;
-};
-
-type PrismaSelect<T> = Record<keyof T, true>;
-
-type Serialized<T> = T extends Date ? string : T extends Array<infer R> ? Array<Serialized<R>> : T extends object ? {
-    [K in keyof T]: Serialized<T[K]>;
-} : T;
-
-type WithDatey<T> = T extends Date ? Datey : T extends Array<infer R> ? Array<WithDatey<R>> : T extends object ? {
-    [K in keyof T]: WithDatey<T[K]>;
-} : T;
-
 declare const firstKey: <T extends PlainObject<any>>(arg: T) => keyof T;
 
 declare const firstValue: <T extends PlainObject<any>>(arg: T) => ObjectValue<T>;
@@ -317,14 +330,16 @@ declare const average: (numbers: number[]) => number;
 
 declare const isBetween: (value: number, min: number, max: number) => boolean;
 
+declare const isOutside: (value: number, min: number, max: number) => boolean;
+
+declare const isStrictlyBetween: (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;
@@ -616,4 +631,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, 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 };
+export { BoolMap, Coords, DateLike, DateRange, Datey, Dimensions, HashMap, ISODate, 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, isOver18, isPWA, isPastDate, isPositive, isPositiveInt, isPromise, isReactElement, isRegExp, isSame, isServer, isSpacedString, isStrictlyBetween, 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, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, stringToCSSUnicode, stringToUnicode, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };