@dereekb/util 8.12.1 → 8.12.4

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [8.12.4](https://github.com/dereekb/dbx-components/compare/v8.12.3-dev...v8.12.4) (2022-07-10)
+
+
+
+## [8.12.3](https://github.com/dereekb/dbx-components/compare/v8.12.2-dev...v8.12.3) (2022-07-09)
+
+
+
+## [8.12.2](https://github.com/dereekb/dbx-components/compare/v8.12.1-dev...v8.12.2) (2022-07-08)
+
+
+
 ## [8.12.1](https://github.com/dereekb/dbx-components/compare/v8.12.0-dev...v8.12.1) (2022-07-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util",
-  "version": "8.12.1",
+  "version": "8.12.4",
   "type": "commonjs",
   "exports": {
     ".": {

package/src/lib/sort.d.ts

@@ -1,4 +1,4 @@
-export declare type SortingOrder = 'desc' | 'asc';
+export declare type SortingOrder = 'asc' | 'desc';
 export declare const SORT_VALUE_LESS_THAN: SortComparisonNumber;
 export declare const SORT_VALUE_GREATER_THAN: SortComparisonNumber;
 export declare const SORT_VALUE_EQUAL: SortComparisonNumber;
@@ -9,8 +9,10 @@ export declare const SORT_VALUE_EQUAL: SortComparisonNumber;
  * - smaller than another will return -1 (or less).
  * - equal to another will return 0
  * - greater than another will return 1 (or more).
+ * - Example: a - b
  *
  * In "descending" order, this returns the opposite values as "ascending".
+ * - Example: b - a
  */
 export declare type SortComparisonNumber = number;
 /**
@@ -19,14 +21,10 @@ export declare type SortComparisonNumber = number;
 export declare type SortCompareFunction<T> = (a: T, b: T) => SortComparisonNumber;
 /**
  * Comparison function that sorts in ascending order.
- *
- * This is the logical normal return order, where if an item is less than another, it should return SORT_VALUE_LESS_THAN (-1), etc.
  */
 export declare type AscendingSortCompareFunction<T> = SortCompareFunction<T>;
 /**
  * Comparison function that sorts in descending order.
- *
- * This is the logical normal return order, where if an item is less than another, it should return SORT_VALUE_LESS_THAN (-1), etc.
  */
 export declare type SortDescendingCompareFunction<T> = SortCompareFunction<T>;
 /**

package/src/lib/sort.js.map

@@ -1 +1 @@
-{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../../../../packages/util/src/lib/sort.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAyB,CAAC,CAAC,CAAC;AAChD,QAAA,uBAAuB,GAAyB,CAAC,CAAC;AAClD,QAAA,gBAAgB,GAAyB,CAAC,CAAC;AAsCxD,SAAgB,gBAAgB,CAAI,SAAiC;IACnE,OAAO,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAC9C,CAAC;AAFD,4CAEC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAI,kBAAmD,EAAE,QAAsB,KAAK;IAChH,OAAO,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;AACrF,CAAC;AAFD,wCAEC"}
+{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../../../../packages/util/src/lib/sort.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAyB,CAAC,CAAC,CAAC;AAChD,QAAA,uBAAuB,GAAyB,CAAC,CAAC;AAClD,QAAA,gBAAgB,GAAyB,CAAC,CAAC;AAoCxD,SAAgB,gBAAgB,CAAI,SAAiC;IACnE,OAAO,CAAC,CAAI,EAAE,CAAI,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AAC9C,CAAC;AAFD,4CAEC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAI,kBAAmD,EAAE,QAAsB,KAAK;IAChH,OAAO,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;AACrF,CAAC;AAFD,wCAEC"}

package/src/lib/string/string.d.ts

@@ -28,3 +28,10 @@ export declare function addPlusPrefixToNumber(value?: Maybe<number>, prefix?: st
  * @returns
  */
 export declare function capitalizeFirstLetter(value: string): string;
+/**
+ * Lowercases the first letter of the input.
+ *
+ * @param value
+ * @returns
+ */
+export declare function lowercaseFirstLetter(value: string): string;

package/src/lib/string/string.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capitalizeFirstLetter = exports.addPlusPrefixToNumber = exports.splitCommaSeparatedStringToSet = exports.splitCommaSeparatedString = exports.caseInsensitiveString = void 0;
+exports.lowercaseFirstLetter = exports.capitalizeFirstLetter = exports.addPlusPrefixToNumber = exports.splitCommaSeparatedStringToSet = exports.splitCommaSeparatedString = exports.caseInsensitiveString = void 0;
 function caseInsensitiveString(input) {
     return input === null || input === void 0 ? void 0 : input.toLocaleLowerCase();
 }
@@ -38,4 +38,14 @@ function capitalizeFirstLetter(value) {
     return value.charAt(0).toUpperCase() + value.slice(1);
 }
 exports.capitalizeFirstLetter = capitalizeFirstLetter;
+/**
+ * Lowercases the first letter of the input.
+ *
+ * @param value
+ * @returns
+ */
+function lowercaseFirstLetter(value) {
+    return value.charAt(0).toLowerCase() + value.slice(1);
+}
+exports.lowercaseFirstLetter = lowercaseFirstLetter;
 //# sourceMappingURL=string.js.map

package/src/lib/string/string.js.map

@@ -1 +1 @@
-{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/string/string.ts"],"names":[],"mappings":";;;AAkBA,SAAgB,qBAAqB,CAAC,KAAoB;IACxD,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,EAAE,CAAC;AACpC,CAAC;AAFD,sDAEC;AAID,SAAgB,yBAAyB,CAAc,KAA8B,EAAE,QAA8B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAiB;IAC3I,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC5C,CAAC;AAHD,8DAGC;AAED,SAAgB,8BAA8B,CAAC,KAAkC;IAC/E,OAAO,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACxE,CAAC;AAFD,wEAEC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,KAAqB,EAAE,MAAM,GAAG,GAAG;IACvE,IAAI,KAAK,IAAI,IAAI,EAAE;QACjB,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;KACrD;SAAM;QACL,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAND,sDAMC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,KAAa;IACjD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAFD,sDAEC"}
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/string/string.ts"],"names":[],"mappings":";;;AAkBA,SAAgB,qBAAqB,CAAC,KAAoB;IACxD,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,EAAE,CAAC;AACpC,CAAC;AAFD,sDAEC;AAID,SAAgB,yBAAyB,CAAc,KAA8B,EAAE,QAA8B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAiB;IAC3I,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC5C,CAAC;AAHD,8DAGC;AAED,SAAgB,8BAA8B,CAAC,KAAkC;IAC/E,OAAO,IAAI,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACxE,CAAC;AAFD,wEAEC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,KAAqB,EAAE,MAAM,GAAG,GAAG;IACvE,IAAI,KAAK,IAAI,IAAI,EAAE;QACjB,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;KACrD;SAAM;QACL,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAND,sDAMC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,KAAa;IACjD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAFD,sDAEC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,KAAa;IAChD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACxD,CAAC;AAFD,oDAEC"}

package/src/lib/type.d.ts

@@ -69,17 +69,25 @@ export declare type StringKeyPropertyKeys<T> = keyof StringKeyProperties<T>;
  * Makes a readonly type able to be configured. Useful for configurating readonly types before they are used.
  */
 export declare type Configurable<T> = Writable<T>;
+/**
+ * StringOrder of all keys of an object.
+ */
+export declare type CommaSeparatedKeyOrderOfObject<T extends object> = CommaSeparatedKeyOrder<`${KeyCanBeString<keyof T>}`>;
+export declare type CommaSeparatedKeyOrder<T extends string> = StringOrder<T, ','>;
+/**
+ * StringCombinations of all keys of an object.
+ */
+export declare type CommaSeparatedKeyCombinationsOfObject<T extends object> = CommaSeparatedKeyCombinations<`${KeyCanBeString<keyof T>}`>;
+export declare type CommaSeparatedKeyCombinations<T extends string> = StringCombination<T, ','>;
 /**
  * StringConcatination of all keys of an object.
  */
 export declare type CommaSeparatedKeysOfObject<T extends object> = CommaSeparatedKeys<`${KeyCanBeString<keyof T>}`>;
 export declare type CommaSeparatedKeys<T extends string> = StringConcatination<T, ','>;
-export declare type CommaSeparatedKeyCombinationsOfObject<T extends object> = CommaSeparatedKeyCombinations<`${KeyCanBeString<keyof T>}`>;
-export declare type CommaSeparatedKeyCombinations<T extends string> = StringCombinations<T, ','>;
 export declare type UnionToOvlds<U> = UnionToIntersection<U extends any ? (f: U) => void : never>;
 export declare type PopUnion<U> = UnionToOvlds<U> extends (a: infer A) => void ? A : never;
 /**
- * A type that merges all combinations of strings together using a separator.
+ * A type that merges all combinations of strings together using a separator, but restricts a certain order.
  *
  * Example:
  * 'a' | 'b' | 'c' w/ ',' -> 'a' | 'b' | 'c' | 'a,b' | 'a,c' | 'a,b,c' | etc...
@@ -88,7 +96,14 @@ export declare type PopUnion<U> = UnionToOvlds<U> extends (a: infer A) => void ?
  *
  * https://stackoverflow.com/a/65157132
  */
-export declare type StringCombinations<S extends string, SEPARATOR extends string> = PopUnion<S> extends infer SELF ? SELF extends string ? Exclude<S, SELF> extends never ? SELF : `${StringCombinations<Exclude<S, SELF>, SEPARATOR>}${SEPARATOR}${SELF}` | StringCombinations<Exclude<S, SELF>, SEPARATOR> | SELF : never : never;
+export declare type StringOrder<S extends string, SEPARATOR extends string> = PopUnion<S> extends infer SELF ? SELF extends string ? Exclude<S, SELF> extends never ? SELF : `${StringOrder<Exclude<S, SELF>, SEPARATOR>}${SEPARATOR}${SELF}` | StringOrder<Exclude<S, SELF>, SEPARATOR> | SELF : never : never;
+/**
+ * A type that merges all combinations of strings together using a separator.
+ *
+ * Example:
+ * 'a' | 'b' | 'c' w/ ',' -> 'a' | 'b' | 'c' | 'a,b' | 'b,a' | 'c,a,b' | etc...
+ */
+export declare type StringCombination<S extends string, SEPARATOR extends string> = PopUnion<S> extends infer SELF ? SELF extends string ? Exclude<S, SELF> extends never ? SELF : `${StringCombination<Exclude<S, SELF>, SEPARATOR>}${SEPARATOR}${SELF}` | `${SELF}${SEPARATOR}${StringCombination<Exclude<S, SELF>, SEPARATOR>}` | StringCombination<Exclude<S, SELF>, SEPARATOR> | SELF : never : never;
 /**
  * A type that merges all the input strings together using a separator.
  *
@@ -96,3 +111,7 @@ export declare type StringCombinations<S extends string, SEPARATOR extends strin
  * 'a' | 'b' | 'c' w/ ',' -> 'a,b,c' | 'a,c,b'
  */
 export declare type StringConcatination<S extends string, SEPARATOR extends string> = PopUnion<S> extends infer SELF ? SELF extends string ? Exclude<S, SELF> extends never ? SELF : `${StringConcatination<Exclude<S, SELF>, SEPARATOR>}${SEPARATOR}${SELF}` | `${SELF}${SEPARATOR}${StringConcatination<Exclude<S, SELF>, SEPARATOR>}` : never : never;
+/**
+ * @deprecated use StringCombination
+ */
+export declare type StringCombinations<S extends string, SEPARATOR extends string> = StringCombination<S, SEPARATOR>;

package/src/lib/value/indexed.d.ts

@@ -1,3 +1,4 @@
+import { SortCompareFunction } from '../sort';
 /**
  * A number that denotes which index an item is at.
  */
@@ -11,10 +12,24 @@ export interface IndexRef {
      */
     i: IndexNumber;
 }
+/**
+ * Creates a SortCompareFunction<T> that sorts by index on IndexRef values.
+ *
+ * @param input
+ * @returns
+ */
+export declare function sortAscendingIndexNumberRefFunction<T extends IndexRef>(): SortCompareFunction<T>;
 /**
  * Returns an item's IndexNumber.
  */
 export declare type ReadIndexFunction<T> = (value: T) => IndexNumber;
+/**
+ * Creates a SortCompareFunction<T> that sorts by the read index.
+ *
+ * @param input
+ * @returns
+ */
+export declare function sortByIndexAscendingCompareFunction<T>(readIndex: ReadIndexFunction<T>): SortCompareFunction<T>;
 /**
  * A min and max value that denote the maximum edges of a range of index values.
  */

package/src/lib/value/indexed.js

@@ -1,6 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.indexRangeCheckFunction = exports.indexRangeCheckReaderFunction = void 0;
+exports.indexRangeCheckFunction = exports.indexRangeCheckReaderFunction = exports.sortByIndexAscendingCompareFunction = exports.sortAscendingIndexNumberRefFunction = void 0;
+/**
+ * Creates a SortCompareFunction<T> that sorts by index on IndexRef values.
+ *
+ * @param input
+ * @returns
+ */
+function sortAscendingIndexNumberRefFunction() {
+    return (a, b) => a.i - b.i;
+}
+exports.sortAscendingIndexNumberRefFunction = sortAscendingIndexNumberRefFunction;
+/**
+ * Creates a SortCompareFunction<T> that sorts by the read index.
+ *
+ * @param input
+ * @returns
+ */
+function sortByIndexAscendingCompareFunction(readIndex) {
+    return (a, b) => readIndex(a) - readIndex(b);
+}
+exports.sortByIndexAscendingCompareFunction = sortByIndexAscendingCompareFunction;
 function indexRangeCheckReaderFunction(range, read = (x) => x.i) {
     const rangeCheck = indexRangeCheckFunction(range);
     return (value) => rangeCheck(read(value));

package/src/lib/value/indexed.js.map

@@ -1 +1 @@
-{"version":3,"file":"indexed.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/indexed.ts"],"names":[],"mappings":";;;AA+CA,SAAgB,6BAA6B,CAAI,KAAiB,EAAE,OAA6B,CAAC,CAAI,EAAE,EAAE,CAAE,CAAyB,CAAC,CAAC;IACrI,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAClD,OAAO,CAAC,KAAQ,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;AAC/C,CAAC;AAHD,sEAGC;AAOD;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,KAAiB;IACvD,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IACrC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,QAAQ,IAAI,CAAC,GAAG,QAAQ,CAAC;AAC9C,CAAC;AAHD,0DAGC"}
+{"version":3,"file":"indexed.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/value/indexed.ts"],"names":[],"mappings":";;;AAiBA;;;;;GAKG;AACH,SAAgB,mCAAmC;IACjD,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AAFD,kFAEC;AAOD;;;;;GAKG;AACH,SAAgB,mCAAmC,CAAI,SAA+B;IACpF,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAC/C,CAAC;AAFD,kFAEC;AA6BD,SAAgB,6BAA6B,CAAI,KAAiB,EAAE,OAA6B,CAAC,CAAI,EAAE,EAAE,CAAE,CAAyB,CAAC,CAAC;IACrI,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAClD,OAAO,CAAC,KAAQ,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;AAC/C,CAAC;AAHD,sEAGC;AAOD;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,KAAiB;IACvD,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IACrC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,QAAQ,IAAI,CAAC,GAAG,QAAQ,CAAC;AAC9C,CAAC;AAHD,0DAGC"}

package/test/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [8.12.4](https://github.com/dereekb/dbx-components/compare/v8.12.3-dev...v8.12.4) (2022-07-10)
+
+
+
+## [8.12.3](https://github.com/dereekb/dbx-components/compare/v8.12.2-dev...v8.12.3) (2022-07-09)
+
+
+
+## [8.12.2](https://github.com/dereekb/dbx-components/compare/v8.12.1-dev...v8.12.2) (2022-07-08)
+
+
+
 ## [8.12.1](https://github.com/dereekb/dbx-components/compare/v8.12.0-dev...v8.12.1) (2022-07-08)
 
 

package/test/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@dereekb/util/test",
-  "version": "8.12.1",
+  "version": "8.12.4",
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
   "dependencies": {},
   "peerDependencies": {
-    "@dereekb/util": "8.12.1",
+    "@dereekb/util": "8.12.4",
     "make-error": "^1.3.0",
     "ts-essentials": "^9.1.2",
     "extra-set": "^2.2.11",