deverything 0.51.1 → 1.1.0

package/README.md

@@ -70,6 +70,8 @@ Contributions always welcome!
 - `max()`
 - `min()`
 - `multiply()`
+- `normaliseArray()`
+- `normaliseNumber()`
 - `percentageChange()`
 - `sum()`
 
@@ -79,10 +81,11 @@ Contributions always welcome!
   - `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
+- `cleanSpaces()` trims and turns double spaces into single space
 - `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
@@ -114,6 +117,7 @@ Contributions always welcome!
 ### Formatters
 
 - `formatCamelCase()`
+- `formatCookies()` { cookie1: "1", cookie2: "2" } => "cookie1=1; cookie2=2"
 - `formatNumber()` 1000 => "1,000" or "1K" or 0.112 => "11.2%"
 - `formatPercentage()` 0.11 => "11%"
 - `formatProgress()` => "[2/10]"
@@ -171,12 +175,6 @@ These functions are optimized for low entropy random data generation useful for
 - `randomValue()`
 - `randomWord()`
 
-### Checks
-
-Checks are functions that throw an error, if the validation fails
-
-- ⭐ `checkEnvVars()` Make sure env vars are set per-environment
-
 ### TypeScript Helpers & Generics
 
 - `Coords`

package/dist/index.d.ts

@@ -1,43 +1,3 @@
-type Keyword = "should" | "shouldNot" | "always" | "never";
-type SimpleValidationRule = Keyword | boolean;
-type EnvValidation = string[];
-type AdvancedValidation = {
-    oneOf?: string[];
-    endsWith?: string;
-    startsWith?: string;
-};
-type WithEnvValidation = AdvancedValidation | {
-    [env: string]: AdvancedValidation | SimpleValidationRule;
-};
-type Config = {
-    processEnvKey?: string;
-};
-/**
- * @param envVarsMap
- * @param config
- * @example
- * checkEnvVars({
- *  NEW_API_KEY: true,
- *  OLD_API: false,
- *  ONLY_NON_PROD: ["test", "dev"],
- *  ONLY_PROD: {
- *   prod: true,
- *  },
- *  APP_ENV: {
- *   oneOf: ["test", "dev", "prod"],
- *  },
- *  STRIPE_KEY: {
- *   prod: {
- *    startsWith: "live_key_",
- *    endsWith: "_end",
- *   },
- *  },
- * }, {
- *  processEnvKey: "APP_ENV" // default is "NODE_ENV"
- * })
- */
-declare const checkEnvVars: (envVarsMap: Record<string, SimpleValidationRule | EnvValidation | WithEnvValidation>, config?: Config) => void;
-
 type Coords = {
     lat: number;
     lng: number;
@@ -45,7 +5,18 @@ type Coords = {
 
 type DateLike = Date | string | number;
 type Datey = Date | string;
+/**
+ * @example "2021-01-01T00:00:00.000Z"
+ */
 type ISODate = string;
+/**
+ * @example "2021-01-01"
+ */
+type ISODay = string;
+/**
+ * @example "America/New_York"
+ */
+type Timezone = string;
 type DateRange = {
     startDate: DateLike;
     endDate: DateLike;
@@ -120,6 +91,13 @@ declare const startOfTomorrow: () => Date;
 
 declare const formatCamelCase: (str: string) => string;
 
+/**
+ *
+ * @example formatCookies({}) => ""
+ * @example formatCookies({ session: "123", _ga: 123 }) => "session=123; _ga=123"
+ */
+declare const formatCookies: (object: PlainObject) => string;
+
 /**
  *
  * @example formatNumber(1000, { compact: true }) // 1K
@@ -200,6 +178,12 @@ declare const enumKeys: <T extends object>(arg: T) => ObjectKeys<T>;
 
 declare const enumValues: <T extends object>(enumObject: T) => ObjectValues<T>;
 
+/**
+ * @returns a string with only alphanumeric characters
+ * @example filterAlphanumeric("!abc()") // returns "abc"
+ */
+declare const filterAlphanumeric: (string: string) => string;
+
 declare const first: <T>(arr?: T[] | undefined) => T | undefined;
 
 declare const firstKey: <T extends PlainObject<any>>(arg: T) => keyof T;
@@ -284,12 +268,13 @@ declare const serialize: <T extends PlainObject<any>>(obj: T) => string;
  * @description Run a series of (async) functions in order and return the results
  * @example
  * const results = await seriesAll([
- *  () => Promise.resolve(1),
- *  () => sleep(100).then(() => 2),
+ *  Promise.resolve(1),
+ *  sleep(100).then(() => 2),
  *  () => Promise.resolve(3),
- * ]); => [1, 2, 3]
+ *  async () => 4,
+ * ]); => [1, 2, 3, 4]
  */
-declare const seriesAll: <T>(series: Function[]) => Promise<T[]>;
+declare const seriesAll: <T>(series: (Promise<T> | (() => Promise<T>))[]) => Promise<T[]>;
 
 /**
  * Sets a value in an object using a dot-separated path.
@@ -342,10 +327,25 @@ declare const min: (values: number[]) => number;
 
 declare const multiply: (numbers: number[]) => number;
 
-declare const percentageChange: ({ previous, current, }: {
-    previous: number;
-    current: number;
-}) => number;
+/**
+ * Normalises an array of numbers
+ * @example normaliseArray([1, 2, 3]) => [0, 0.5, 1]
+ */
+declare const normaliseArray: (values: number[]) => number[];
+
+/**
+ *
+ * @example normaliseNumber(50, 0, 100) => 0.5
+ */
+declare const normaliseNumber: (value: number, minValue: number, maxValue: number) => number;
+
+/**
+ *
+ * @param previous Positive percentage i.e. 0.1 for 10%
+ * @param current Positive percentage i.e. 0.2 for 20%
+ * @returns
+ */
+declare const percentageChange: (previous: number, current: number) => number;
 
 declare const sum: (numbers: number[]) => number;
 
@@ -418,8 +418,8 @@ declare const randomCoords: () => Coords;
 declare const randomLat: () => number;
 declare const randomLng: () => number;
 
-declare const randomDate: (startDate?: DateLike, endDate?: DateLike) => Date;
-declare const randomMaxDate: (start?: Date, end?: Date) => Date;
+declare const randomDate: ({ startDate, endDate }?: Partial<DateRange>) => Date;
+declare const randomMaxDate: ({ startDate, endDate }: Partial<DateRange>) => Date;
 declare const randomFutureDate: ({ startDate, endDate, }?: Partial<DateRange>) => Date;
 declare const randomPastDate: ({ startDate, endDate, }?: Partial<DateRange>) => Date;
 declare const randomDateRange: () => {
@@ -463,19 +463,20 @@ declare const randomHtmlColorName: () => string;
 
 declare const randomIBAN: () => string;
 
-declare const randomInt: (min?: number, max?: number) => number;
-declare const randomPositiveInt: (max?: number) => number;
-declare const randomNegativeInt: (min?: number) => number;
-declare const randomMaxSafeInt: () => number;
-declare const randomMaxInt: () => number;
-declare const randomPercentage: ({ min, max, }?: {
+declare const randomInt: ({ min, max, }?: {
+    min?: number | undefined;
+    max?: number | undefined;
+}) => number;
+declare const randomPositiveInt: ({ min, max, }?: {
     min?: number | undefined;
     max?: number | undefined;
 }) => number;
-declare const randomPositivePercentage: ({ min, max, }?: {
+declare const randomNegativeInt: ({ min, max, }?: {
     min?: number | undefined;
     max?: number | undefined;
 }) => number;
+declare const randomMaxSafeInt: () => number;
+declare const randomMaxInt: () => number;
 declare const randomFormattedPercentage: () => string;
 
 declare const randomIP: () => string;
@@ -567,6 +568,9 @@ declare const isEmptyObject: (arg: PlainObject) => boolean;
 
 declare const isFile: (arg?: any) => arg is File;
 
+/**
+ * @returns true if the argument can be called like a function -> fn() or await fn()
+ */
 declare const isFunction: (arg: any) => arg is Function;
 
 declare const isFutureDate: (arg: DateLike) => boolean;
@@ -633,4 +637,4 @@ declare const isUUID: (arg: string) => boolean;
 
 declare const isValue: (arg?: Maybe<any>) => boolean;
 
-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, startOfDay, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, stringToCSSUnicode, stringToUnicode, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };
+export { BoolMap, Coords, DateLike, DateRange, Datey, Dimensions, HashMap, ISODate, ISODay, JS_MAX_DIGITS, Key, Matrix, Maybe, MaybePromise, MaybePromiseOrValue, MaybePromiseOrValueArray, NonUndefined, NumberMap, ObjectEntries, ObjectEntry, ObjectKey, ObjectKeys, ObjectValue, ObjectValues, PlainKey, PlainObject, Point, PrismaSelect, Serialized, StringMap, Timezone, TrueMap, WithDatey, array, arrayDiff, arrayIntersection, average, capitalize, chunkArray, chunkedAll, chunkedAsync, clamp, cleanSpaces, cyclicalItem, dir, enumKeys, enumValues, filterAlphanumeric, first, firstKey, firstValue, formatCamelCase, formatCookies, 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, normaliseArray, normaliseNumber, 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, randomPhoneNumber, randomPositiveInt, randomString, randomUUID, randomVerb, randomWord, scrambleText, serialize, seriesAll, setObjectPath, setUrlSearchParams, shuffle, sleep, startOfDay, startOfNextMonth, startOfNextWeek, startOfThisWeek, startOfToday, startOfTomorrow, stringToCSSUnicode, stringToUnicode, sum, toggleArray, toggleArrayValue, truncate, uniqueValues };