@dereekb/util 12.6.21 → 13.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util",
-  "version": "12.6.21",
+  "version": "13.0.0",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
@@ -16,8 +16,15 @@
     },
     "./test": {
       "types": "./test/src/index.d.ts",
-      "main": "./test/src/index.js",
-      "require": "./test/src/index.js"
+      "module": "./test/index.esm.js",
+      "main": "./test/index.cjs.js",
+      "node": {
+        "require": "./test/index.cjs.js"
+      },
+      "browser": {
+        "require": "./test/index.cjs.js",
+        "import": "./test/index.esm.js"
+      }
     },
     "./fetch": {
       "types": "./fetch/src/index.d.ts",
@@ -34,11 +41,15 @@
   },
   "peerDependencies": {
     "make-error": "^1.3.0",
-    "ts-essentials": "^9.1.2",
-    "extra-set": "^3.0.0"
+    "ts-essentials": "^10.0.0",
+    "extra-set": "^3.0.0",
+    "fast-content-type-parse": "^3.0.0",
+    "core-js": "^3.0.0"
+  },
+  "devDependencies": {
+    "date-fns": "*"
   },
-  "dependencies": {},
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

package/src/lib/array/array.boolean.d.ts

@@ -84,14 +84,3 @@ export declare const BooleanStringKeyArrayUtility: {
     remove: (array: BooleanKeyArray<string>, value: string) => BooleanKeyArray<string>;
     removeByKey: (array: BooleanKeyArray<string>, key: string) => BooleanKeyArray<string>;
 };
-/**
- * @Deprecated use BooleanStringKeyArrayUtility instead
- */
-export declare const BooleanStringKeyArrayUtilityInstance: {
-    isFalse: (value: BooleanKeyArray) => boolean;
-    isTrue: (value: BooleanKeyArray) => boolean;
-    set: (array: BooleanKeyArray<string>, value: string, enable?: boolean) => BooleanKeyArray<string>;
-    insert: (array: BooleanKeyArray<string>, value: string) => BooleanKeyArray<string>;
-    remove: (array: BooleanKeyArray<string>, value: string) => BooleanKeyArray<string>;
-    removeByKey: (array: BooleanKeyArray<string>, key: string) => BooleanKeyArray<string>;
-};

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

@@ -33,21 +33,3 @@ export declare function allValuesAreMaybeNot<T>(values: Maybe<T>[]): values is M
  * @returns
  */
 export declare function allValuesAreNotMaybe<T>(values: Maybe<T>[]): values is T[];
-/**
- * Filters all maybe values from the input array. If a maybe value is input, returns an empty array.
- *
- * @param values
- * @returns
- *
- * @deprecated use filterMaybeArrayValues instead.
- */
-export declare const filterMaybeValues: UniversalFilterMaybeArrayFunction;
-/**
- * Filters all empty and maybe values from the input array. If a maybe value is input, returns an empty array.
- *
- * @param values
- * @returns
- *
- * @deprecated use filterEmptyArrayValues instead.
- */
-export declare const filterEmptyValues: UniversalFilterMaybeArrayFunction;

package/src/lib/boolean.d.ts

@@ -103,7 +103,7 @@ export declare function randomBoolean(chance?: BooleanTrueChance): boolean;
  * @param defaultValue - The default value to return if the string cannot be converted to a boolean (default: undefined).
  * @returns The boolean value corresponding to the string, or the default value if the string cannot be converted.
  */
-export declare function stringToBoolean(value: Maybe<string>): Maybe<boolean>;
+export declare function stringToBoolean(value: Maybe<string | boolean>): Maybe<boolean>;
 export declare function stringToBoolean(value: Maybe<string>, defaultValue: boolean): boolean;
 export declare function stringToBoolean(value: Maybe<string>, defaultValue?: Maybe<boolean>): Maybe<boolean>;
 /**

package/src/lib/date/date.d.ts

@@ -386,11 +386,3 @@ export declare function isPast(input: Date): boolean;
 export declare function addMilliseconds(input: Date, ms: Maybe<Milliseconds>): Date;
 export declare function addMilliseconds(input: MaybeNot, ms: Maybe<Milliseconds>): MaybeNot;
 export declare function addMilliseconds(input: Maybe<Date>, ms: Maybe<Milliseconds>): Maybe<Date>;
-/**
- * @deprecated use UnixDateTimeMillisecondsNumber instead.
- */
-export type UnixDateTimeNumber = UnixDateTimeMillisecondsNumber;
-/**
- * @deprecated use DateOrUnixDateTimeMillisecondsNumber instead.
- */
-export type DateOrUnixDateTimeNumber = DateOrUnixDateTimeMillisecondsNumber;

package/src/lib/date/date.unix.d.ts

@@ -1,10 +1,14 @@
 import { type Maybe, type MaybeNot } from '../value/maybe.type';
 /**
- * Not to be confused with UnixDateTimeNumber, this value is in seconds instead of milliseconds.
+ * This value is in seconds since the Epoch.
+ *
+ * Use UnixDateTimeMillisecondsNumber instead if you need milliseconds.
  */
 export type UnixDateTimeSecondsNumber = number;
 /**
- * Not to be confused with DateOrUnixDateTimeNumber, this value is in seconds instead of milliseconds.
+ * This value is in seconds since the Epoch.
+ *
+ * Use DateOrUnixDateTimeMillisecondsNumber instead if you need milliseconds.
  */
 export type DateOrUnixDateTimeSecondsNumber = Date | UnixDateTimeSecondsNumber;
 /**
@@ -44,31 +48,3 @@ export declare function dateFromDateOrTimeSecondsNumber(input: Maybe<DateOrUnixD
  * @returns Date object if timestamp is valid, null/undefined if timestamp is null/undefined
  */
 export declare function unixDateTimeSecondsNumberToDate(dateTimeNumber: Maybe<UnixDateTimeSecondsNumber>): Maybe<Date>;
-/**
- * @deprecated use UnixDateTimeSecondsNumber instead
- */
-export type UnixTimeNumber = UnixDateTimeSecondsNumber;
-/**
- * @deprecated use DateOrUnixDateTimeSecondsNumber instead
- */
-export type DateOrUnixTimeNumber = Date | UnixTimeNumber;
-/**
- * @deprecated use unixDateTimeSecondsNumberFromDateOrTimeNumber instead
- */
-export declare const unixTimeNumberFromDateOrTimeNumber: typeof unixDateTimeSecondsNumberFromDateOrTimeNumber;
-/**
- * @deprecated use unixDateTimeSecondsNumberForNow instead
- */
-export declare const unixTimeNumberForNow: typeof unixDateTimeSecondsNumberForNow;
-/**
- * @deprecated use unixDateTimeSecondsNumberFromDate instead
- */
-export declare const unixTimeNumberFromDate: typeof unixDateTimeSecondsNumberFromDate;
-/**
- * @deprecated use dateFromDateOrTimeSecondsNumber instead
- */
-export declare const dateFromDateOrTimeNumber: typeof dateFromDateOrTimeSecondsNumber;
-/**
- * @deprecated use unixDateTimeSecondsNumberToDate instead
- */
-export declare const unixTimeNumberToDate: typeof unixDateTimeSecondsNumberToDate;

package/src/lib/date/expires.d.ts

@@ -1,5 +1,5 @@
 import { type Maybe } from '../value/maybe.type';
-import { type DateOrUnixDateTimeNumber, type Milliseconds } from './date';
+import { type DateOrUnixDateTimeMillisecondsNumber, type Milliseconds } from './date';
 /**
  * An object that can expire.
  */
@@ -35,7 +35,7 @@ export interface ExpirationDetailsInput<T extends Expires = Expires> extends Exp
      *
      * If not defined, the expiresFromDate is considered to have never been run/set.
      */
-    expiresFromDate?: Maybe<DateOrUnixDateTimeNumber>;
+    expiresFromDate?: Maybe<DateOrUnixDateTimeMillisecondsNumber>;
     /**
      * If true, the "expiresFromDate" will default to the calculated now time when calculating the expiration.
      *
@@ -98,7 +98,7 @@ export declare function calculateExpirationDate(input: ExpirationDetailsInput<an
  * @param now Optional override for the current time. Defaults to the current time.
  * @returns True if the threshold has not passed since the next run time, compared to now.
  */
-export declare function isUnderThreshold(threshold: Milliseconds, nextRunAt: Maybe<DateOrUnixDateTimeNumber>, now?: Maybe<Date>): boolean;
+export declare function isUnderThreshold(threshold: Milliseconds, nextRunAt: Maybe<DateOrUnixDateTimeMillisecondsNumber>, now?: Maybe<Date>): boolean;
 /**
  * Convenience function for quickly calculating throttling given a throttle time and last run time.
  *
@@ -110,7 +110,7 @@ export declare function isUnderThreshold(threshold: Milliseconds, nextRunAt: May
  * @param now - Optional override for the current time (defaults to the current time)
  * @returns True if the operation should be throttled (not enough time has passed), false otherwise
  */
-export declare function isThrottled(throttleTime: Maybe<Milliseconds>, lastRunAt: Maybe<DateOrUnixDateTimeNumber>, now?: Maybe<Date>): boolean;
+export declare function isThrottled(throttleTime: Maybe<Milliseconds>, lastRunAt: Maybe<DateOrUnixDateTimeMillisecondsNumber>, now?: Maybe<Date>): boolean;
 /**
  * Returns true if at least one of the input ExpirationDetails has not expired.
  * Useful for checking if any items in a collection are still valid.

package/src/lib/date/hour.d.ts

@@ -13,7 +13,7 @@ import { type Hours, type Minutes } from './date';
  * - 15 minutes : 0.25
  */
 export type FractionalHour = number;
-export declare const FRACTIONAL_HOURS_PRECISION_FUNCTION: import("../number/round").CutValueToPrecisionFunction;
+export declare const FRACTIONAL_HOURS_PRECISION_FUNCTION: import("..").CutValueToPrecisionFunction;
 /**
  * Converts the number of minnutes to a fractional hour.
  *

package/src/lib/date/time.d.ts

@@ -111,7 +111,3 @@ export declare function toggleTimerRunning(timer: Timer, toggleRun?: boolean): v
  * Returns the approximate end date of the given timer. If a timer is already complete, it returns the time for now.
  */
 export declare function approximateTimerEndDate(timer: Timer): Maybe<Date>;
-/**
- * @deprecated use makeTimer instead of timer.
- */
-export declare const timer: typeof makeTimer;

package/src/lib/key.d.ts

@@ -17,6 +17,10 @@ export type ReadKeyFunction<T, K extends PrimativeKey = PrimativeKey> = MapFunct
  * Reads a key value from the input object that is required to exist.
  */
 export type ReadRequiredKeyFunction<T, K extends PrimativeKey = PrimativeKey> = MapFunction<T, K>;
+/**
+ * Reads all keys from the input object. Can return null/undefined.
+ */
+export type ReadAllKeysFunction<T, K extends PrimativeKey = PrimativeKey> = MapFunction<T, Maybe<ArrayOrValue<K>>>;
 /**
  * Reads one or more keys from the input object.
  */

package/src/lib/object/object.map.d.ts

@@ -74,12 +74,3 @@ export type MappedKeysToLowercaseObjectMap<M extends object> = {
  * @param mapFn
  */
 export declare const mapObjectKeysToLowercase: <M extends object>(object: M) => MappedKeysToLowercaseObjectMap<M>;
-/**
- * Converts an ObjectMap into tuples.
- *
- * @deprecated use Object.entries instead.
- *
- * @param object
- * @returns
- */
-export declare const objectToTuples: <T>(object: ObjectMap<T>) => [string, T][];

package/src/lib/page/index.d.ts

@@ -1,3 +1,2 @@
 export * from './page';
-export * from './page.calculator';
 export * from './page.filter';

package/src/lib/promise/promise.d.ts

@@ -1,6 +1,6 @@
 import { type ArrayOrValue } from '../array/array';
 import { type Milliseconds } from '../date/date';
-import { type PrimativeKey, type ReadOneOrMoreKeysFunction } from '../key';
+import { type ReadAllKeysFunction, type PrimativeKey } from '../key';
 import { type StringFactory } from '../string/factory';
 import { type IndexNumber } from '../value';
 import { type Maybe } from '../value/maybe.type';
@@ -95,7 +95,7 @@ export interface PerformTasksFromFactoryInParallelFunctionConfig<I, K extends Pr
      *
      * When in use the order is not guranteed.
      */
-    readonly nonConcurrentTaskKeyFactory?: ReadOneOrMoreKeysFunction<I, K>;
+    readonly nonConcurrentTaskKeyFactory?: Maybe<ReadAllKeysFunction<I, K>>;
     /**
      * Whether or not tasks are performed sequentially or if tasks are all done in "parellel".
      *
@@ -136,4 +136,3 @@ export declare function performTasksFromFactoryInParallelFunction<I, K extends P
  * @returns A string factory that generates unique keys for non-concurrent tasks.
  */
 export declare function makeDefaultNonConcurrentTaskKeyFactory(): StringFactory<any>;
-export type PromiseAsyncTaskFn<T, K = unknown> = PerformAsyncTaskFn<T, K>;

package/src/lib/set/set.hashset.d.ts

@@ -14,7 +14,7 @@ export declare class HashSet<K extends PrimativeKey, T> implements Set<T> {
     constructor(config: HashSetConfig<K, T>, values?: T[]);
     get config(): HashSetConfig<K, T>;
     get size(): number;
-    [Symbol.iterator](): IterableIterator<T>;
+    [Symbol.iterator](): MapIterator<T>;
     addAll(values: Maybe<T[]>): this;
     add(value: T): this;
     clear(): void;
@@ -25,9 +25,9 @@ export declare class HashSet<K extends PrimativeKey, T> implements Set<T> {
     valueKeyEntriesForKeys(keys: Maybe<K>[]): [Maybe<K>, Maybe<T>][];
     valuesForKeys(keys: Maybe<K>[]): T[];
     forEach(callbackfn: (value: T, value2: T, set: Set<T>) => void, thisArg?: unknown): void;
-    entries(): IterableIterator<[T, T]>;
-    keys(): IterableIterator<T>;
-    values(): IterableIterator<T>;
+    entries(): SetIterator<[T, T]>;
+    keys(): SetIterator<T>;
+    values(): SetIterator<T>;
     valuesArray(): T[];
     get [Symbol.toStringTag](): string;
 }

package/src/lib/storage/storage.d.ts

@@ -1,4 +1,4 @@
-import { type UnixDateTimeNumber } from '../date/date';
+import { type UnixDateTimeMillisecondsNumber } from '../date/date';
 /**
  * String representation of data that is stored.
  */
@@ -15,7 +15,7 @@ export interface StoredData {
      * The Unix timestamp (in milliseconds) when the data was stored.
      * Undefined if the storage time is not known or not applicable.
      */
-    readonly storedAt: UnixDateTimeNumber | undefined;
+    readonly storedAt: UnixDateTimeMillisecondsNumber | undefined;
     /**
      * The actual data stored, as a string.
      */

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

@@ -110,11 +110,3 @@ export declare function fileExtensionForMimeType(mimeType: Maybe<MimeTypeWithout
  * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Disposition
  */
 export type ContentDispositionString = 'inline' | 'attachment' | string;
-/**
- * @deprecated Use ImageFileExtension instead.
- */
-export type MimeTypeForImageTypeInputType = ImageFileExtension;
-/**
- * @deprecated Use mimeTypeForImageFileExtension instead.
- */
-export declare const mimetypeForImageType: typeof mimeTypeForImageFileExtension;

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

@@ -75,7 +75,17 @@ export declare function findAllCharacterOccurences(set: Set<string>, input: stri
  * @returns
  */
 export declare function findFirstCharacterOccurence(set: Set<string>, input: string): Maybe<number>;
-export type SplitStringAtFirstCharacterOccurenceFunction = (input: string) => [string, string | undefined];
+/**
+ * The result of splitting a string at the first character occurence.
+ *
+ * The first element is the string before the split character(s).
+ * The second element is the string after the split character(s), or is undefined if no split occured.
+ */
+export type SplitStringAtFirstCharacterOccurenceResult = [string, string | undefined];
+/**
+ * Splits the input string at the configured split character(s).
+ */
+export type SplitStringAtFirstCharacterOccurenceFunction = (input: string) => SplitStringAtFirstCharacterOccurenceResult;
 /**
  * Splits the string into two parts at the first occurence of a string or any string in the set.
  *

package/src/lib/tree/tree.flatten.d.ts

@@ -79,13 +79,3 @@ export declare function flattenTreeToArrayFunction<N extends TreeNode<unknown, N
  * @returns A FlattenTreeFunction that collects values of type V.
  */
 export declare function flattenTreeToArrayFunction<N extends TreeNode<unknown, N>, V>(mapNodeFn?: (node: N) => V, defaultAddNodeFn?: Maybe<FlattenTreeAddNodeDecisionFunction<N, V>>): FlattenTreeFunction<N, V>;
-/**
- * Convenience function for flattening multiple trees with a single configured flatten function.
- *
- * @deprecated FlattenTreeFunction now supports an array of trees.
- *
- * @param trees
- * @param flattenFn
- * @returns
- */
-export declare function flattenTrees<N extends TreeNode<unknown, N>, V>(trees: ArrayOrValue<N>, flattenFn: FlattenTreeFunction<N, V>, addNodeFn?: Maybe<FlattenTreeAddNodeDecisionFunction<N, V>>): V[];

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

@@ -356,4 +356,4 @@ export declare function stepsFromIndexFunction(config: StepsFromIndexFunctionCon
  * For instance, an index of 5 on a range of 0 to 3 will return the index 1.
  */
 export declare function stepsFromIndex(range: IndexRange, startIndex: number, step?: number, wrapAround?: boolean): Maybe<number>;
-export declare const isSelectedIndexDecisionFunction: import("../set/set.selection").IsSelectedDecisionFunctionFactory<IndexRef, number>;
+export declare const isSelectedIndexDecisionFunction: import("..").IsSelectedDecisionFunctionFactory<IndexRef, number>;

package/src/lib/value/maybe.type.d.ts

@@ -4,9 +4,9 @@ import { type NonNever } from 'ts-essentials';
  */
 export type MaybeNot = null | undefined;
 /**
- * A non-null/undefined value.
+ * A non-null/undefined/void value.
  */
-export type MaybeSo<T = unknown> = T extends MaybeNot ? never : T;
+export type MaybeSo<T = unknown> = T extends MaybeNot | void ? never : T;
 /**
  * A value that might exist, or be null/undefined instead.
  */
@@ -14,7 +14,7 @@ export type Maybe<T> = T | MaybeNot;
 /**
  * A value that is not null/undefined.
  */
-export type MaybeSoStrict<T> = T extends Maybe<infer A> ? (A extends Maybe<infer B> ? B extends Maybe<infer C> ? C extends Maybe<infer D> ? D extends Maybe<infer E> ? E : D : C : B : A) : T;
+export type MaybeSoStrict<T> = T extends Maybe<infer A> ? (A extends Maybe<infer B> ? (B extends Maybe<infer C> ? (C extends Maybe<infer D> ? (D extends Maybe<infer E> ? E : D) : C) : B) : A) : T;
 /**
  * Turns all key values in an object into a Maybe value.
  */

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

@@ -34,8 +34,8 @@ export declare function isSameLatLngPoint(a: Maybe<LatLngPoint>, b: Maybe<LatLng
 export declare function diffLatLngPoints(a: LatLngPoint, b: LatLngPoint, wrap?: boolean): LatLngPoint;
 export declare function addLatLngPoints(a: LatLngPoint, b: LatLngPoint, wrap?: boolean): LatLngPoint;
 export declare function wrapLatLngPoint(a: LatLngPoint): LatLngPoint;
-export declare const capLatValue: import("../number").BoundNumberFunction<number>;
-export declare const wrapLngValue: import("../number").WrapNumberFunction<number>;
+export declare const capLatValue: import("..").BoundNumberFunction<number>;
+export declare const wrapLngValue: import("..").WrapNumberFunction<number>;
 export declare function isValidLatitude(lat: Latitude): boolean;
 export declare function isValidLongitude(lat: Longitude): boolean;
 export declare function defaultLatLngPoint(): LatLngPoint;

package/test/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hapier Creative LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.