@react-hive/honey-style 1.8.1 → 1.11.0

package/dist/types/types.d.ts

@@ -1,7 +1,7 @@
 import * as CSS from 'csstype';
 import type { ElementType } from 'react';
 import { HONEY_STYLED_COMPONENT_ID_PROP } from '../constants';
-import type { HoneyCSSColor, HoneyCSSDimensionUnit, HoneyCSSDimensionValue } from './css.types';
+import type { HoneyCSSColor, HoneyCSSDimensionUnit } from './css.types';
 /**
  * Creates a new type by omitting the specified keys `U` from the object type `T`.
  *
@@ -99,7 +99,7 @@ export interface HoneyFont {
  *
  * @example
  * ```ts
- * declare module '@react-hive/honey-layout' {
+ * declare module '@react-hive/honey-style' {
  *  export interface HoneyFonts {
  *    body: HoneyFont;
  *    caption: HoneyFont;
@@ -163,7 +163,7 @@ interface BaseHoneyColors {
  *
  * @example
  * ```ts
- * declare module '@react-hive/honey-layout' {
+ * declare module '@react-hive/honey-style' {
  *  export interface HoneyColors {
  *    neutral: Record<'charcoalDark' | 'charcoalGray' | 'crimsonRed', HoneyCSSColor>;
  *  }
@@ -203,11 +203,12 @@ export interface HoneyContainer {
      */
     maxWidth: `${number}${HoneyCSSDimensionUnit}`;
 }
+export type HoneyDimensionValue = `${number}${HoneyCSSDimensionUnit}`;
 /**
  * Represents a map of dimension names to CSS distance values.
  */
 export interface HoneyDimensions {
-    [key: string]: HoneyCSSDimensionValue;
+    [key: string]: HoneyDimensionValue;
 }
 export type HoneyDimensionName = keyof HoneyDimensions;
 /**

package/dist/types/utility.types.d.ts

@@ -0,0 +1 @@
+export type Nullable<T> = T | null;

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import type { HoneyColor, HoneyColorKey, HoneyCSSClassName, HoneyCSSColor, HoneyCSSDimensionValue, HoneyDimensionName, HoneyFontName, HoneyHEXColor, HoneyStyledComponent, HoneyStyledContext } from './types';
+import type { Nullable, HoneyColor, HoneyColorKey, HoneyCSSClassName, HoneyCSSColor, HoneyCSSDimensionUnit, HoneyCSSDimensionValue, HoneyCSSShorthandDimensionOutput, HoneyCSSShorthandTuple, HoneyCSSSpacingValue, HoneyDimensionName, HoneyFontName, HoneyHEXColor, HoneySpacings, HoneyStyledComponent, HoneyStyledContext } from './types';
 export declare function assert(condition: any, message: string): asserts condition;
 export declare const generateId: (prefix: string) => string;
 export declare const toKebabCase: (str: string) => string;
@@ -72,6 +72,46 @@ export declare const pxToRem: (px: number, base?: number) => string;
  * @returns True if the string value is a theme color value, false otherwise.
  */
 export declare const checkIsThemeColorValue: (propertyValue: string) => propertyValue is HoneyColorKey;
+/**
+ * Determines the resolved type for spacing values when processed by `resolveSpacing`.
+ *
+ * The return type adapts based on the shape of the `Value` and presence of a CSS `Unit`:
+ *
+ * - If `Value` is a `string` (e.g., raw `'10px'` or `'auto'`), it is returned as-is.
+ * - If `Unit` is `null`, the original value is returned (either number or shorthand array).
+ * - If `Unit` is provided and `Value` is a shorthand array (e.g., `[1, 2, 3, 4]`),
+ *   it is resolved to a space-separated dimension string (e.g., `'8px 16px 24px 32px'`).
+ * - If `Unit` is provided and `Value` is a number, it is resolved to a single dimension string (e.g., `'16px'`).
+ *
+ * This type helps enforce correct resolution behavior depending on user input and configuration.
+ *
+ * @template Value - The input spacing value (number, shorthand array, or raw string).
+ * @template Unit - A CSS length unit (e.g., 'px', 'em'), or `null` to skip unit formatting.
+ */
+export type HoneyResolveSpacingResult<Value extends HoneyCSSSpacingValue, Unit extends Nullable<HoneyCSSDimensionUnit>> = Value extends HoneyCSSDimensionValue ? Value : Unit extends null ? Value : Value extends HoneyCSSShorthandTuple<number | HoneyCSSDimensionValue> ? HoneyCSSShorthandDimensionOutput<Value, NonNullable<Unit>> : HoneyCSSDimensionValue<NonNullable<Unit>>;
+/**
+ * Resolves a spacing value or shorthand spacing array using the theme and optional unit.
+ *
+ * This function takes spacing multipliers and converts them into pixel or unit-based values
+ * using a theme spacing scale (e.g., `theme.spacings.base`). Useful for applying consistent
+ * layout spacing with theming and token support.
+ *
+ * @template Value - The spacing value(s) to resolve. Can be:
+ *                   - A number (e.g., `1`) representing a multiplier.
+ *                   - An array of numbers (e.g., `[1, 2, 3, 4]`) for shorthand spacing.
+ *                   - A dimension string (e.g., `'10px'`) will be returned as `never`.
+ * @template Unit - Optional CSS unit (`'px'`, `'em'`, etc.), or `null` to skip units.
+ *
+ * @param value - Spacing multiplier(s) to apply.
+ * @param [unit='px'] - The CSS unit to append. If `null`, values remain numeric.
+ * @param [type='base'] - The spacing type to use from the theme (e.g., `'base'`, `'small'`).
+ *
+ * @returns A function that takes a theme context and returns:
+ *          - A single resolved value (e.g., `'16px'`) if `value` is a number.
+ *          - A space-separated string (e.g., `'8px 12px'`) if `value` is an array.
+ *          - `never` if the input is a raw string (unsupported).
+ */
+export declare const resolveSpacing: <Value extends HoneyCSSSpacingValue, Unit extends Nullable<HoneyCSSDimensionUnit> = "px">(value: Value, unit?: Unit, type?: keyof HoneySpacings) => ((context: HoneyStyledContext<object>) => HoneyResolveSpacingResult<Value, Unit>);
 /**
  * Resolves the font styles based on the provided font name from the theme.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-hive/honey-style",
-  "version": "1.8.1",
+  "version": "1.11.0",
   "description": "",
   "keywords": [
     "react",