@silvermine/toolbox 0.5.1 → 0.7.0

package/dist/esm/utils/sort-keys-replacer.js

@@ -0,0 +1,20 @@
+import { isStringUnknownMap } from '../types/StringUnknownMap';
+import { isFunction } from './is-function';
+/**
+ * JSON replacer that recursively sorts object keys to ensure consistent serialization.
+ *
+ * @example
+ * ```
+ * JSON.stringify(query, sortKeysReplacer);
+ * ```
+ */
+export function sortKeysReplacer(_key, value) {
+    if (isStringUnknownMap(value) && !isFunction(value)) {
+        return Object.keys(value).sort().reduce((memo, k) => {
+            memo[k] = value[k];
+            return memo;
+        }, {});
+    }
+    return value;
+}
+//# sourceMappingURL=sort-keys-replacer.js.map

package/dist/esm/utils/sort-keys-replacer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-keys-replacer.js","sourceRoot":"","sources":["../../../src/utils/sort-keys-replacer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAoB,MAAM,2BAA2B,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,KAAc;IAC1D,IAAI,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACnD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACjD,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACnB,OAAO,IAAI,CAAC;QACf,CAAC,EAAE,EAAsB,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,KAAK,CAAC;AAChB,CAAC"}

package/dist/esm/utils/uniq.js.map

@@ -1 +1 @@
-{"version":3,"file":"uniq.js","sourceRoot":"","sources":["../../../src/utils/uniq.ts"],"names":[],"mappings":"AAAA,MAAM,YAAY,GAAG,CAAO,GAAQ,EAAE,QAA8C,EAAO,EAAE;IAC1F,MAAM,MAAM,GAAQ,EAAE,EAChB,IAAI,GAAQ,EAAE,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE;QACnD,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,EACd,QAAQ,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE;YAChC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACrB;KACH;IACD,OAAO,MAAM,CAAC;AACjB,CAAC,CAAC;AAGF,MAAM,UAAU,GAAG,CAAO,GAAQ,EAAO,EAAE;IACxC,MAAM,MAAM,GAAQ,EAAE,CAAC;IAEvB,IAAI,QAA2B,CAAC;IAEhC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE;QACnD,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAErB,IAAI,CAAC,KAAK,CAAC,IAAI,QAAQ,KAAK,KAAK,EAAE;YAChC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACrB;QACD,QAAQ,GAAG,KAAK,CAAC;KACnB;IACD,OAAO,MAAM,CAAC;AACjB,CAAC,CAAC;AAGF,MAAM,YAAY,GAAG,CAAI,GAAQ,EAAO,EAAE;IACvC,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AACjB,CAAC,CAAC;AAGF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAO,GAAQ,EAAE,QAAkB,EAAE,QAA+C,EAAO,EAAE;IAC9G,IAAI,QAAQ,EAAE;QACX,OAAO,YAAY,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;KACrC;IACD,IAAI,QAAQ,EAAE;QACX,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;KACzB;IACD,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC,CAAC"}
+{"version":3,"file":"uniq.js","sourceRoot":"","sources":["../../../src/utils/uniq.ts"],"names":[],"mappings":"AAAA,MAAM,YAAY,GAAG,CAAO,GAAQ,EAAE,QAA8C,EAAO,EAAE;IAC1F,MAAM,MAAM,GAAQ,EAAE,EAChB,IAAI,GAAQ,EAAE,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpD,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,EACd,QAAQ,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QAEzC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AACjB,CAAC,CAAC;AAGF,MAAM,UAAU,GAAG,CAAO,GAAQ,EAAO,EAAE;IACxC,MAAM,MAAM,GAAQ,EAAE,CAAC;IAEvB,IAAI,QAA2B,CAAC;IAEhC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpD,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAErB,IAAI,CAAC,KAAK,CAAC,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,CAAC;QACD,QAAQ,GAAG,KAAK,CAAC;IACpB,CAAC;IACD,OAAO,MAAM,CAAC;AACjB,CAAC,CAAC;AAGF,MAAM,YAAY,GAAG,CAAI,GAAQ,EAAO,EAAE;IACvC,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AACjB,CAAC,CAAC;AAGF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAO,GAAQ,EAAE,QAAkB,EAAE,QAA+C,EAAO,EAAE;IAC9G,IAAI,QAAQ,EAAE,CAAC;QACZ,OAAO,YAAY,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,QAAQ,EAAE,CAAC;QACZ,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC,CAAC"}

package/dist/types/index.d.ts

@@ -16,6 +16,7 @@ export * from './utils/is-array-of-strings';
 export * from './utils/is-boolean';
 export * from './utils/is-empty';
 export * from './utils/is-enum-value';
+export * from './utils/is-function';
 export * from './utils/is-map-with-values-of-type';
 export * from './utils/is-number';
 export * from './utils/is-object';
@@ -33,7 +34,9 @@ export * from './utils/pick';
 export * from './utils/pluck';
 export * from './utils/delay';
 export * from './utils/get';
+export * from './utils/group-by';
 export * from './utils/escape-html';
 export * from './utils/make-template';
 export * from './utils/uniq';
 export * from './utils/range';
+export * from './utils/sort-keys-replacer';

package/dist/types/types/Omit.d.ts

@@ -5,4 +5,4 @@
  * @deprecated This will be removed once the TS version for this project has been upgraded
  * to TS 3.5 or greater
  */
-export declare type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;

package/dist/types/types/Optional.d.ts

@@ -22,4 +22,4 @@ import { Omit } from './Omit';
  * }
  * ```
  */
-export declare type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/dist/types/types/PropsWithType.d.ts

@@ -15,6 +15,6 @@
  * }
  * ```
  */
-export declare type PropsWithType<O, T> = Exclude<keyof Pick<O, {
+export type PropsWithType<O, T> = Exclude<keyof Pick<O, {
     [K in keyof O]: O[K] extends T ? K : never;
 }[keyof O]>, undefined>;

package/dist/types/types/RequireDefined.d.ts

@@ -18,6 +18,6 @@
  * }
  * ```
  */
-export declare type RequireDefined<T, K extends keyof T> = T & {
+export type RequireDefined<T, K extends keyof T> = T & {
     [P in K]-?: Exclude<T[P], undefined>;
 };

package/dist/types/types/RequireOptional.d.ts

@@ -18,6 +18,6 @@
  * }
  * ```
  */
-export declare type RequireOptional<T, K extends keyof T> = T & {
+export type RequireOptional<T, K extends keyof T> = T & {
     [P in K]-?: T[P];
 };

package/dist/types/types/StrictUnion.d.ts

@@ -1,8 +1,8 @@
 import { UnionKeys } from './UnionKeys';
-declare type InvalidKeys<K extends string | number | symbol> = {
+type InvalidKeys<K extends string | number | symbol> = {
     [P in K]?: never;
 };
-declare type StrictUnionHelper<T, TAll> = T extends unknown ? (T & InvalidKeys<Exclude<UnionKeys<TAll>, keyof T>>) : never;
+type StrictUnionHelper<T, TAll> = T extends unknown ? (T & InvalidKeys<Exclude<UnionKeys<TAll>, keyof T>>) : never;
 /**
  * A basic TypeScript union (e.g. A | B) results in a type containing the available
  * properties from the provided types. When StrictUnion is used (e.g. StrictUnion<A | B>),
@@ -11,5 +11,5 @@ declare type StrictUnionHelper<T, TAll> = T extends unknown ? (T & InvalidKeys<E
  *
  * See: https://github.com/microsoft/TypeScript/issues/20863#issuecomment-520551758
  */
-export declare type StrictUnion<T> = StrictUnionHelper<T, T>;
+export type StrictUnion<T> = StrictUnionHelper<T, T>;
 export {};

package/dist/types/types/UnionKeys.d.ts

@@ -6,4 +6,4 @@
  * type Keys = UnionKeys<Union>; // 'a' | 'b'
  * ```
  */
-export declare type UnionKeys<T> = T extends T ? keyof T : never;
+export type UnionKeys<T> = T extends T ? keyof T : never;

package/dist/types/types/Writable.d.ts

@@ -19,6 +19,6 @@
  * }
  * ```
  */
-export declare type Writable<T> = {
+export type Writable<T> = {
     -readonly [P in keyof T]: T[P];
 };

package/dist/types/utils/compact.d.ts

@@ -1,3 +1,3 @@
-declare type FalsyVals = '' | 0 | false | null | undefined;
+type FalsyVals = '' | 0 | false | null | undefined;
 export declare function compact<T>(arr: (T | FalsyVals)[]): T[];
 export {};

package/dist/types/utils/delay.d.ts

@@ -1 +1,2 @@
-export declare function delay<T = undefined>(ms: number, value?: T): Promise<T>;
+export declare function delay(ms: number): Promise<undefined>;
+export declare function delay<T>(ms: number, value: T): Promise<T>;

package/dist/types/utils/group-by.d.ts

@@ -0,0 +1,7 @@
+import { PropsWithType } from '../types/PropsWithType';
+/**
+ * Given an array of items and a function that returns a key, groups the items by the key.
+ * If the returned key is `undefined`, the item is not included in the result. If a string
+ * is passed as the second argument, the item is grouped by the values of that property.
+ */
+export declare function groupBy<T, U extends string>(items: T[], fn: ((item: T) => string | undefined) | PropsWithType<T, string>): Record<U, T[] | undefined>;

package/dist/types/utils/is-empty.d.ts

@@ -4,7 +4,7 @@ interface IEmptyArguments extends IArguments {
 interface IEmptyObj {
     [s: string]: never;
 }
-declare type IEmptyTypes = (null | undefined | boolean | number | never[] | '' | IEmptyArguments | Set<never> | IEmptyObj);
+type IEmptyTypes = (null | undefined | boolean | number | never[] | '' | IEmptyArguments | Set<never> | IEmptyObj);
 /**
  * Checks if `o` is an empty object. An object is "empty" if it:
  *

package/dist/types/utils/is-enum-value.d.ts

@@ -1,4 +1,4 @@
 /**
  * Type guard to check to see if the given value is a valid value for the enum.
  */
-export declare function isEnumValue<T>(enumType: T, value: unknown): value is T[keyof T];
+export declare function isEnumValue<T extends object>(enumType: T, value: unknown): value is T[keyof T];

package/dist/types/utils/is-function.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Type guard for functions.
+ *
+ * @returns `true` if `o` is a `function`.
+ */
+export declare function isFunction(o: unknown): o is Function;

package/dist/types/utils/sort-keys-replacer.d.ts

@@ -0,0 +1,9 @@
+/**
+ * JSON replacer that recursively sorts object keys to ensure consistent serialization.
+ *
+ * @example
+ * ```
+ * JSON.stringify(query, sortKeysReplacer);
+ * ```
+ */
+export declare function sortKeysReplacer(_key: string, value: unknown): unknown;

package/dist/types/utils/uniq.d.ts

@@ -5,4 +5,4 @@
  * is not a one-to-one function, so providing an iteratee will disable
  * the faster algorithm.
  */
-export declare const uniq: <T, U>(arr: T[], isSorted?: boolean | undefined, iteratee?: ((value: T, i: number, arr: T[]) => U) | undefined) => T[];
+export declare const uniq: <T, U>(arr: T[], isSorted?: boolean, iteratee?: (value: T, i: number, arr: T[]) => U) => T[];

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@silvermine/toolbox",
-   "version": "0.5.1",
+   "version": "0.7.0",
    "description": "A library of common TypeScript types, custom type guards, and utility functions.",
    "main": "./dist/commonjs/index",
    "types": "./dist/types/index.d.ts",
@@ -42,7 +42,7 @@
       "@silvermine/typescript-config": "git+https://github.com/silvermine/typescript-config#23213e33077089e723629dead5342abe6f3b3c8c",
       "@types/chai": "4.3.20",
       "@types/mocha": "5.2.7",
-      "@types/node": "12.20.45",
+      "@types/node": "20.12.2",
       "@types/sinon": "5.0.7",
       "chai": "4.5.0",
       "check-node-version": "4.2.1",
@@ -60,6 +60,6 @@
       "source-map-support": "0.5.21",
       "ts-node": "7.0.1",
       "tslib": "2.6.3",
-      "typescript": "3.9.10"
+      "typescript": "5.7.2"
    }
 }

package/src/index.ts

@@ -17,6 +17,7 @@ export * from './utils/is-array-of-strings';
 export * from './utils/is-boolean';
 export * from './utils/is-empty';
 export * from './utils/is-enum-value';
+export * from './utils/is-function';
 export * from './utils/is-map-with-values-of-type';
 export * from './utils/is-number';
 export * from './utils/is-object';
@@ -35,7 +36,9 @@ export * from './utils/pick';
 export * from './utils/pluck';
 export * from './utils/delay';
 export * from './utils/get';
+export * from './utils/group-by';
 export * from './utils/escape-html';
 export * from './utils/make-template';
 export * from './utils/uniq';
 export * from './utils/range';
+export * from './utils/sort-keys-replacer';

package/src/utils/delay.ts

@@ -1,4 +1,6 @@
-export function delay<T = undefined>(ms: number, value?: T): Promise<T> {
+export function delay(ms: number): Promise<undefined>;
+export function delay<T>(ms: number, value: T): Promise<T>;
+export function delay<T>(ms: number, value?: T): Promise<T | undefined> {
    return new Promise((resolve) => {
       setTimeout(() => { resolve(value); }, ms);
    });

package/src/utils/group-by.ts

@@ -0,0 +1,32 @@
+import { PropsWithType } from '../types/PropsWithType';
+import { hasDefined } from './has-defined';
+import { isString } from './is-string';
+
+/**
+ * Given an array of items and a function that returns a key, groups the items by the key.
+ * If the returned key is `undefined`, the item is not included in the result. If a string
+ * is passed as the second argument, the item is grouped by the values of that property.
+ */
+export function groupBy<T, U extends string>(items: T[], fn: ((item: T) => string | undefined) | PropsWithType<T, string>): Record<U, T[] | undefined> {
+   const keyFn = typeof fn === 'function' ? fn : (item: T) => {
+      const key = item[fn];
+
+      return isString(key) ? key : undefined;
+   };
+
+   return items.reduce((memo, item) => {
+      const key = keyFn(item);
+
+      if (key === undefined) {
+         return memo;
+      }
+
+      if (hasDefined(memo, key)) {
+         memo[key].push(item);
+      } else {
+         memo[key] = [ item ];
+      }
+
+      return memo;
+   }, {} as Record<string, T[] | undefined>);
+}

package/src/utils/is-enum-value.ts

@@ -1,7 +1,7 @@
 /**
  * Type guard to check to see if the given value is a valid value for the enum.
  */
-export function isEnumValue<T>(enumType: T, value: unknown): value is T[keyof T] {
+export function isEnumValue<T extends object>(enumType: T, value: unknown): value is T[keyof T] {
    return (Object.keys(enumType) as Array<keyof T>)
       .map((key) => {
          return enumType[key];

package/src/utils/is-function.ts

@@ -0,0 +1,8 @@
+/**
+ * Type guard for functions.
+ *
+ * @returns `true` if `o` is a `function`.
+ */
+export function isFunction(o: unknown): o is Function { // eslint-disable-line @typescript-eslint/ban-types
+   return typeof o === 'function';
+}

package/src/utils/sort-keys-replacer.ts

@@ -0,0 +1,20 @@
+import { isStringUnknownMap, StringUnknownMap } from '../types/StringUnknownMap';
+import { isFunction } from './is-function';
+
+/**
+ * JSON replacer that recursively sorts object keys to ensure consistent serialization.
+ *
+ * @example
+ * ```
+ * JSON.stringify(query, sortKeysReplacer);
+ * ```
+ */
+export function sortKeysReplacer(_key: string, value: unknown): unknown {
+   if (isStringUnknownMap(value) && !isFunction(value)) {
+      return Object.keys(value).sort().reduce((memo, k) => {
+         memo[k] = value[k];
+         return memo;
+      }, {} as StringUnknownMap);
+   }
+   return value;
+}