@react-hive/honey-utils 4.3.0 → 5.0.0

package/dist/intersection/get-dom-rect-intersection-ratio.d.ts

@@ -7,6 +7,13 @@
  * @param sourceRect - The rectangle used to measure overlap against the target.
  * @param targetRect - The rectangle whose covered area is measured.
  *
- * @returns A number between `0` and `1` representing the intersection ratio.
+ * @returns A number between `0` and `1` representing the intersection ratio - `0` for a target
+ *          with no area, which nothing can cover.
+ *
+ * @example
+ * ```ts
+ * getDOMRectIntersectionRatio(new DOMRect(0, 0, 100, 100), new DOMRect(50, 0, 100, 100));
+ * // 0.5
+ * ```
  */
 export declare const getDOMRectIntersectionRatio: (sourceRect: DOMRect, targetRect: DOMRect) => number;

package/dist/intersection/resolve-axis-delta.d.ts

@@ -54,5 +54,12 @@ export interface ResolveAxisDeltaOptions {
  * @param options - Resolution behavior configuration.
  *
  * @returns A normalized, axis-aligned delta suitable for further scroll or movement processing.
+ *
+ * @example
+ * ```ts
+ * // A vertical wheel scrolling a horizontal list
+ * resolveAxisDelta({ deltaX: 0, deltaY: 40 }, 'x');
+ * // { deltaX: -40, deltaY: 0 }
+ * ```
  */
 export declare const resolveAxisDelta: (delta: AxisDelta, axis: Axis, { allowFallback, invert }?: ResolveAxisDeltaOptions) => AxisDelta;

package/dist/json/parse-json.d.ts

@@ -1,2 +1,23 @@
-import type { Nullable } from '~/types';
+import type { Nullable } from '../types';
+/**
+ * Parses a JSON string without throwing.
+ *
+ * The result is only cast to `Value`, not checked against it - check its shape before relying on
+ * it where the string comes from outside the program.
+ *
+ * @template Value - The type the JSON is expected to have.
+ *
+ * @param value - The JSON string to parse.
+ *
+ * @returns The parsed value, or `null` when the string is not valid JSON.
+ *
+ * @example
+ * ```ts
+ * parseJson<{ name: string }>('{"name":"Mike"}');
+ * // ➜ { name: 'Mike' }
+ *
+ * parseJson('{name:"Mike"}');
+ * // ➜ null
+ * ```
+ */
 export declare const parseJson: <Value>(value: string) => Nullable<Value>;

package/dist/math/hash-string.d.ts

@@ -19,7 +19,7 @@
  * @example
  * ```ts
  * const className = hashString('background-color: red;');
- * // → 'e4k1z0x'
+ * // → '1s0s409'
  * ```
  */
 export declare const hashString: (input: string) => string;

package/dist/math/math.d.ts

@@ -7,6 +7,11 @@
  * @param endY - The Y coordinate of the ending point.
  *
  * @returns The Euclidean distance between the two points.
+ *
+ * @example
+ * ```ts
+ * calculateEuclideanDistance(0, 0, 3, 4); // 5
+ * ```
  */
 export declare const calculateEuclideanDistance: (startX: number, startY: number, endX: number, endY: number) => number;
 /**
@@ -15,7 +20,13 @@ export declare const calculateEuclideanDistance: (startX: number, startY: number
  * @param distance - The distance.
  * @param elapsedTime - The time taken to move the distance.
  *
- * @returns The calculated speed, which is the absolute value of delta divided by elapsed time.
+ * @returns The calculated speed, which is the absolute value of delta divided by elapsed time -
+ *          `Infinity` for a distance covered in no time, and `NaN` for none covered in none.
+ *
+ * @example
+ * ```ts
+ * calculateMovingSpeed(-120, 60); // 2
+ * ```
  */
 export declare const calculateMovingSpeed: (distance: number, elapsedTime: number) => number;
 /**
@@ -25,5 +36,10 @@ export declare const calculateMovingSpeed: (distance: number, elapsedTime: numbe
  * @param percentage - The percentage to calculate.
  *
  * @returns The calculated percentage of the value.
+ *
+ * @example
+ * ```ts
+ * calculatePercentage(200, 15); // 30
+ * ```
  */
 export declare const calculatePercentage: (value: number, percentage: number) => number;

package/dist/object.d.ts

@@ -1,5 +1,11 @@
+/**
+ * `T` without the keys `definedProps` drops: a key that can only be `undefined` is gone, and one
+ * that may be `undefined` becomes optional, as it is left out wherever its value is.
+ */
 export type DefinedProps<T extends object> = {
-    [K in keyof T as T[K] extends undefined ? never : K]: Exclude<T[K], undefined>;
+    [K in keyof T as T[K] extends undefined ? never : undefined extends T[K] ? never : K]: T[K];
+} & {
+    [K in keyof T as T[K] extends undefined ? never : undefined extends T[K] ? K : never]?: Exclude<T[K], undefined>;
 };
 /**
  * Create a new object by removing properties whose values are `undefined`.

package/dist/string/for-each-char.d.ts

@@ -1,4 +1,4 @@
-import type { Nullable } from '~/types';
+import type { Nullable } from '../types';
 /**
  * Context information for the currently processed character during string iteration.
  *

package/dist/string/is-nil-or-empty-string.d.ts

@@ -10,4 +10,4 @@
  *
  * @returns `true` if the value is empty; otherwise, `false`.
  */
-export declare const isNilOrEmptyString: (value: unknown) => value is null | undefined;
+export declare const isNilOrEmptyString: (value: unknown) => value is null | undefined | "";

package/dist/string/parse-file-name.d.ts

@@ -13,4 +13,4 @@
  *  - index 0 is the base name
  *  - index 1 is the file extension (lowercased), or an empty string if none exists
  */
-export declare const parseFileName: (fileName: string) => string[];
+export declare const parseFileName: (fileName: string) => [string, string];

package/dist/tree/flatten-tree.d.ts

@@ -1,5 +1,5 @@
-import type { KeysWithArrayValues, KeysWithNonArrayValues } from '~/types';
-import type { HoneyTreeFlatNode } from '~/tree';
+import type { KeysWithArrayValues, KeysWithNonArrayValues } from '../types';
+import type { HoneyTreeFlatNode } from './tree.types';
 /**
  * Flattens a hierarchical tree into a single preorder array.
  *

package/dist/tree/get-tree-children.d.ts

@@ -1,5 +1,5 @@
-import type { KeysWithNonArrayValues } from '~/types';
-import type { HoneyTreeFlatNode } from '~/tree';
+import type { KeysWithNonArrayValues } from '../types';
+import type { HoneyTreeFlatNode } from './tree.types';
 /**
  * Returns the direct children of a given parent node from a flattened tree.
  *

package/dist/tree/search-tree.d.ts

@@ -1,5 +1,5 @@
-import type { KeysWithNonArrayValues, KeysWithStringValues } from '~/types';
-import type { HoneyTreeFlatNode } from '~/tree';
+import type { KeysWithNonArrayValues, KeysWithStringValues } from '../types';
+import type { HoneyTreeFlatNode } from './tree.types';
 /**
  * Performs a context-aware search over a flattened tree.
  *

package/dist/tree/tree.types.d.ts

@@ -1,4 +1,4 @@
-import type { KeysWithNonArrayValues } from '~/types';
+import type { KeysWithNonArrayValues } from '../types';
 /**
  * A flattened representation of a node from a hierarchical tree structure.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-hive/honey-utils",
-  "version": "4.3.0",
+  "version": "5.0.0",
   "description": "A lightweight TypeScript utility library providing a collection of helper functions for common programming tasks",
   "keywords": [
     "utils",
@@ -42,15 +42,16 @@
   "devDependencies": {
     "@eslint/js": "10.0.1",
     "@mdx-js/loader": "3.1.1",
-    "@types/node": "24.19.0",
+    "@types/node": "26.6.5",
     "copy-webpack-plugin": "14.0.0",
-    "eslint": "10.11.0",
-    "prettier": "3.9.9",
+    "eslint": "10.13.0",
+    "jsdom": "30.1.3",
+    "prettier": "3.9.10",
     "ts-loader": "9.6.2",
     "typescript": "6.0.3",
-    "typescript-eslint": "8.71.0",
-    "vitest": "5.0.3",
-    "webpack": "5.111.1",
+    "typescript-eslint": "8.71.2",
+    "vitest": "5.0.5",
+    "webpack": "5.112.0",
     "webpack-cli": "7.2.3"
   },
   "scripts": {

package/dist/geometry/apply-inertia-step.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/geometry/resolve-bounded-delta.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/id/generate-ephemeral-id.spec.d.ts

@@ -1 +0,0 @@
-export {};