@react-hive/honey-layout 4.0.0 → 4.2.0

package/dist/providers/HoneyLayoutProvider.d.ts

@@ -1,9 +1,9 @@
 import { DefaultTheme } from 'styled-components';
 import { PropsWithChildren } from 'react';
 import { UseHoneyMediaQueryOptions } from '../hooks';
-type HoneyLayoutProviderContentProps = {
+interface HoneyLayoutProviderContentProps {
     mediaQueryOptions?: UseHoneyMediaQueryOptions;
-};
+}
 type HoneyLayoutProviderProps = HoneyLayoutProviderContentProps & {
     theme: DefaultTheme;
 };

package/dist/providers/HoneyLayoutThemeOverride.d.ts

@@ -1,13 +1,13 @@
 import { PropsWithChildren } from 'react';
 import { DefaultTheme } from 'styled-components';
-type HoneyLayoutThemeOverrideProps = {
+interface HoneyLayoutThemeOverrideProps {
     theme: DefaultTheme;
-};
+}
 /**
  * Provides a theme override context to its children.
  * Merges the provided theme with the existing theme from the `ThemeContext`.
  *
- * @param {PropsWithChildren<HoneyLayoutThemeOverrideProps>} props - The props for `HoneyLayoutThemeOverride`.
+ * @param props - The props for `HoneyLayoutThemeOverride`.
  *
  * @returns The ThemeProvider with the merged theme applied to its children.
  */

package/dist/types/css.types.d.ts

@@ -119,7 +119,7 @@ export type HoneyPrefixedCSSProperties = {
 /**
  * Options for CSS @media at-rule.
  */
-export type HoneyCSSMediaRule = {
+export interface HoneyCSSMediaRule {
     operator?: 'not' | 'only';
     mediaType?: 'all' | 'print' | 'screen' | 'speech';
     width?: HoneyCSSDimensionValue;
@@ -133,5 +133,5 @@ export type HoneyCSSMediaRule = {
     minResolution?: HoneyCSSResolutionValue;
     maxResolution?: HoneyCSSResolutionValue;
     update?: 'none' | 'slow' | 'fast';
-};
+}
 export {};

package/dist/types/data.types.d.ts

@@ -5,7 +5,7 @@ import { HoneyKeyboardEventCode } from './dom.types';
 export type HoneyEffectResultFn<Props extends object> = StyleFunction<Props>;
 export type HoneyEffect<Config = unknown, Props extends object = object> = (config: Config) => HoneyEffectResultFn<Props>;
 export type HoneyOverlayId = string;
-export type HoneyOverlayEventListenerType = 'keyup';
+export type HoneyOverlayEventType = 'keyup';
 /**
  * Handler function for an overlay event listener.
  *
@@ -17,19 +17,16 @@ export type HoneyOverlayEventListenerHandler = (keyCode: HoneyKeyboardEventCode,
 /**
  * A tuple representing an event listener, including the event type and the handler function.
  */
-export type HoneyOverlayEventListener = [
-    HoneyOverlayEventListenerType,
-    HoneyOverlayEventListenerHandler
-];
+export type HoneyOverlayEventListener = [HoneyOverlayEventType, HoneyOverlayEventListenerHandler];
 /**
  * Configuration object for an overlay, used to specify the overlay's behavior and event handling.
  */
-export type HoneyOverlayConfig = {
+export interface HoneyOverlayConfig {
     /**
      * Custom overlay ID.
      * Automatically generated if not passed.
      *
-     * @default generates
+     * @default It generates automatically
      */
     id?: HoneyOverlayId;
     /**
@@ -44,11 +41,11 @@ export type HoneyOverlayConfig = {
      * If `listenKeys` is provided, this will only be triggered for those keys.
      */
     onKeyUp: HoneyOverlayEventListenerHandler;
-};
+}
 /**
  * Represents an overlay in the layout, allowing the registration of event listeners and notifying them when events occur.
  */
-export type HoneyActiveOverlay = {
+export interface HoneyActiveOverlay {
     /**
      * Unique identifier for the overlay.
      */
@@ -69,23 +66,23 @@ export type HoneyActiveOverlay = {
      * @param type - The type of event to listen for.
      * @param handler - The handler function to execute when the event is triggered.
      */
-    addListener: (type: HoneyOverlayEventListenerType, handler: HoneyOverlayEventListenerHandler) => void;
+    addListener: (type: HoneyOverlayEventType, handler: HoneyOverlayEventListenerHandler) => void;
     /**
      * Removes a specific event listener from the overlay.
      *
      * @param type - The type of event for the listener.
      * @param handler - The handler function to remove.
      */
-    removeListener: (type: HoneyOverlayEventListenerType, handler: HoneyOverlayEventListenerHandler) => void;
+    removeListener: (type: HoneyOverlayEventType, handler: HoneyOverlayEventListenerHandler) => void;
     /**
      * Notifies all listeners of a specific event type.
      *
-     * @param type - The type of event that occurred.
+     * @param targetEventType - The type of event that occurred.
      * @param keyCode - The code of the key that triggered the event.
      * @param e - The original keyboard event.
      */
-    notifyListeners: (type: HoneyOverlayEventListenerType, keyCode: HoneyKeyboardEventCode, e: KeyboardEvent) => void;
-};
+    notifyListeners: (targetEventType: HoneyOverlayEventType, keyCode: HoneyKeyboardEventCode, e: KeyboardEvent) => void;
+}
 /**
  * Represents an item that has been flattened from a hierarchical data structure, with additional
  * properties to support tracking its position and relationships within the hierarchy.

package/dist/types/state.types.d.ts

@@ -4,7 +4,7 @@
 /**
  * Represents the state of the screen layout.
  */
-export type HoneyScreenState = {
+export interface HoneyScreenState {
     /** Indicates if the screen size is extra-small (xs). */
     isXs: boolean;
     /** Indicates if the screen size is small (sm). */
@@ -19,4 +19,4 @@ export type HoneyScreenState = {
     isPortrait: boolean;
     /** Indicates if the screen orientation is landscape. */
     isLandscape: boolean;
-};
+}

package/dist/types/types.d.ts

@@ -9,20 +9,20 @@ import { HoneyCSSColor, HoneyCSSDimensionValue } from './css.types';
  * - `lg`: Large devices
  * - `xl`: Extra large devices
  */
-export type HoneyBreakpoints = {
+export interface HoneyBreakpoints {
     xs: number;
     sm: number;
     md: number;
     lg: number;
     xl: number;
-};
+}
 export type HoneyBreakpointName = keyof HoneyBreakpoints;
-export type HoneyContainer = {
+export interface HoneyContainer {
     /**
      * Max container width in any CSS distance value.
      */
     maxWidth: HoneyCSSDimensionValue;
-};
+}
 /**
  * Represents the theme configuration.
  */
@@ -61,7 +61,7 @@ declare module 'styled-components' {
 /**
  * Defines different spacing sizes available in the theme.
  */
-export type HoneySpacings = {
+export interface HoneySpacings {
     /**
      * The base spacing value in pixels.
      */
@@ -69,7 +69,7 @@ export type HoneySpacings = {
     small?: number;
     medium?: number;
     large?: number;
-};
+}
 /**
  * Defines the color palette used in the theme.
  */
@@ -155,13 +155,13 @@ export interface HoneyColors extends BaseHoneyColors {
 export type HoneyColorKey = {
     [ColorType in keyof HoneyColors]: `${ColorType}.${keyof HoneyColors[ColorType] & string}`;
 }[keyof HoneyColors];
-export type HoneyFont = {
+export interface HoneyFont {
     size: number;
     family?: string;
     weight?: number;
     lineHeight?: number;
     letterSpacing?: number;
-};
+}
 /**
  * Example of augmenting the fonts interface.
  *

package/dist/utils.d.ts

@@ -3,9 +3,9 @@ export declare const camelToDashCase: (inputString: string) => string;
 /**
  * Splits a string into an array of filtered from redundant spaces words.
  *
- * @param {string} inputString - The input string to be split.
+ * @param inputString - The input string to be split.
  *
- * @returns {string[]} An array of words from the input string.
+ * @returns An array of words from the input string.
  */
 export declare const splitStringIntoWords: (inputString: string) => string[];
 /**
@@ -20,30 +20,30 @@ export declare const pxToRem: (px: number, base?: number) => string;
 /**
  * Calculates the Euclidean distance between two points in 2D space.
  *
- * @param {number} startX - The X coordinate of the starting point.
- * @param {number} startY - The Y coordinate of the starting point.
- * @param {number} endX - The X coordinate of the ending point.
- * @param {number} endY - The Y coordinate of the ending point.
+ * @param startX - The X coordinate of the starting point.
+ * @param startY - The Y coordinate of the starting point.
+ * @param endX - The X coordinate of the ending point.
+ * @param endY - The Y coordinate of the ending point.
  *
- * @returns {number} - The Euclidean distance between the two points.
+ * @returns The Euclidean distance between the two points.
  */
 export declare const calculateEuclideanDistance: (startX: number, startY: number, endX: number, endY: number) => number;
 /**
  * Calculates the moving speed.
  *
- * @param {number} delta - The change in position (distance).
- * @param {number} elapsedTime - The time taken to move the distance.
+ * @param delta - The change in position (distance).
+ * @param elapsedTime - The time taken to move the distance.
  *
- * @returns {number} - 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.
  */
 export declare const calculateMovingSpeed: (delta: number, elapsedTime: number) => number;
 /**
  * Calculates the specified percentage of a given value.
  *
- * @param {number} value - The value to calculate the percentage of.
- * @param {number} percentage - The percentage to calculate.
+ * @param value - The value to calculate the percentage of.
+ * @param percentage - The percentage to calculate.
  *
- * @returns {number} - The calculated percentage of the value.
+ * @returns The calculated percentage of the value.
  */
 export declare const calculatePercentage: (value: number, percentage: number) => number;
 /**
@@ -54,27 +54,27 @@ export declare const calculatePercentage: (value: number, percentage: number) =>
  *
  * @throws {Error} If alpha value is not between 0 and 1, or if the hex code is invalid.
  *
- * @returns {HoneyHEXColor} - The 8-character HEX with alpha (RRGGBBAA) format color code, or null if input is invalid.
+ * @returns The 8-character HEX with alpha (RRGGBBAA) format color code, or null if input is invalid.
  */
 export declare const convertHexToHexWithAlpha: (hex: string, alpha: number) => HoneyHEXColor;
 /**
  * Builds a media query string based on the provided options.
  *
- * @param {HoneyCSSMediaRule[]} rules - Conditions for the media query.
+ * @param rules - Conditions for the media query.
  *
- * @returns {string} The generated media query string.
+ * @returns The generated media query string.
  */
 export declare const media: (rules: HoneyCSSMediaRule[]) => string;
-type HTMLElementTransformationValues = {
+interface HTMLElementTransformationValues {
     translateX: number;
     translateY: number;
-};
+}
 /**
  * Get various transformation values from the transformation matrix of an element.
  *
- * @param {HTMLElement} element - The element with a transformation applied.
+ * @param element - The element with a transformation applied.
  *
- * @returns {HTMLElementTransformationValues} An object containing transformation values.
+ * @returns An object containing transformation values.
  */
 export declare const getTransformationValues: (element: HTMLElement) => HTMLElementTransformationValues;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-hive/honey-layout",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "description": "",
   "keywords": [
     "react",
@@ -45,7 +45,7 @@
     "lodash.merge": "4.6.2"
   },
   "devDependencies": {
-    "@eslint/js": "9.20.0",
+    "@eslint/js": "9.22.0",
     "@mdx-js/rollup": "3.1.0",
     "@testing-library/react": "16.2.0",
     "@types/jest": "29.5.14",
@@ -55,17 +55,17 @@
     "@types/react": "^18.3.18",
     "@types/react-dom": "^18.3.5",
     "@vitejs/plugin-react": "4.3.4",
-    "eslint": "9.20.1",
+    "eslint": "9.22.0",
     "eslint-plugin-react": "7.37.4",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
-    "prettier": "3.5.1",
-    "ts-jest": "29.2.5",
-    "typescript": "5.7.3",
-    "typescript-eslint": "8.24.0",
-    "vite": "6.1.0",
-    "vite-plugin-checker": "0.8.0",
-    "vite-plugin-dts": "4.5.0"
+    "prettier": "3.5.3",
+    "ts-jest": "29.2.6",
+    "typescript": "5.8.2",
+    "typescript-eslint": "8.26.1",
+    "vite": "6.2.2",
+    "vite-plugin-checker": "0.9.1",
+    "vite-plugin-dts": "4.5.3"
   },
   "jest": {
     "preset": "ts-jest",