@takumi-rs/helpers 0.23.0 → 0.24.0

package/dist/types-C93nbSJX.d.cts

@@ -0,0 +1,586 @@
+/**
+ * Defines how flex items are aligned along the cross axis.
+ *
+ * This enum determines how items are aligned within the flex container
+ * along the cross axis (perpendicular to the main axis).
+ */
+type AlignItems = "start" | "end" | "flex-start" | "flex-end" | "center" | "baseline" | "stretch";
+
+/**
+ * Represents a color with 8-bit RGBA components.
+ */
+type Color = [number, number, number] | [number, number, number, number] | number | string;
+
+/**
+ * Represents a value that can be a specific length, percentage, or automatic.
+ *
+ * This corresponds to CSS values that can be specified as pixels, percentages,
+ * or the 'auto' keyword for automatic sizing.
+ */
+type LengthUnit = "auto" | "min-content" | "max-content" | {
+    "percentage": number;
+} | {
+    "rem": number;
+} | {
+    "em": number;
+} | {
+    "vh": number;
+} | {
+    "vw": number;
+} | number | string;
+
+/**
+ * Represents a box shadow with all its properties.
+ *
+ * Box shadows can be either outset (default) or inset, and consist of:
+ * - Horizontal and vertical offsets
+ * - Blur radius (optional, defaults to 0)
+ * - Spread radius (optional, defaults to 0)
+ * - Color (optional, defaults to transparent)
+ */
+type BoxShadow = {
+    /**
+     * Whether the shadow is inset (inside the element) or outset (outside the element).
+     */
+    inset: boolean;
+    /**
+     * Horizontal offset of the shadow.
+     */
+    offsetX: LengthUnit;
+    /**
+     * Vertical offset of the shadow.
+     */
+    offsetY: LengthUnit;
+    /**
+     * Blur radius of the shadow. Higher values create a more blurred shadow.
+     */
+    blurRadius: LengthUnit;
+    /**
+     * Spread radius of the shadow. Positive values expand the shadow, negative values shrink it.
+     */
+    spreadRadius: LengthUnit;
+    /**
+     * Color of the shadow.
+     */
+    color: Color;
+} | string;
+
+/**
+ * Represents a collection of box shadows, have custom `FromCss` implementation for comma-separated values.
+ */
+type BoxShadows = Array<BoxShadow>;
+
+/**
+ * This enum determines the layout algorithm used for the children of a node.
+ */
+type Display = "flex" | "grid";
+
+/**
+ * Defines the direction of flex items within a flex container.
+ *
+ * This enum determines how flex items are laid out along the main axis.
+ */
+type FlexDirection = "row" | "column" | "row-reverse" | "column-reverse";
+
+/**
+ * Defines how flex items should wrap.
+ *
+ * This enum determines how flex items should wrap within the flex container.
+ */
+type FlexWrap = "nowrap" | "wrap" | "wrap-reverse";
+
+/**
+ * Represents a font family for text rendering.
+ * Use only the family name (no style suffixes like "Bold", "Italic", "Regular").
+ * Multi-word names are allowed (e.g., "Noto Sans") and should be provided as-is without quotes.
+ */
+type FontFamily = "sans-serif" | "serif" | "monospace" | "cursive" | "fantasy" | string;
+
+/**
+ * Represents font weight as a numeric value.
+ *
+ * This wraps a u16 value that corresponds to CSS font-weight values.
+ * Common values include 100 (thin), 200 (extra light), 300 (light),
+ * 400 (normal), 500 (medium), 600 (semi bold), 700 (bold),
+ * 800 (extra bold), 900 (black).
+ */
+type FontWeight = number;
+
+/**
+ * Represents spacing between flex items.
+ *
+ * Can be either a single value applied to both axes, or separate values
+ * for horizontal and vertical spacing.
+ */
+type Gap = LengthUnit | [LengthUnit, LengthUnit] | string;
+
+/**
+ * Represents the grid auto flow with serde support
+ */
+type GridAutoFlow = "row" | "column" | "row dense" | "column dense";
+
+/**
+ * Represents a grid placement with serde support
+ */
+type GridPlacement = "auto" | {
+    "span": number;
+} | number | string;
+
+/**
+ * Represents a grid line placement with serde support
+ */
+type GridLine = {
+    /**
+     * The start line placement
+     */
+    start: GridPlacement | null;
+    /**
+     * The end line placement
+     */
+    end: GridPlacement | null;
+};
+
+/**
+ * Represents a grid track sizing function with serde support
+ */
+type GridLengthUnit = {
+    "fr": number;
+} | LengthUnit | string;
+
+/**
+ * Represents a grid minmax()
+ */
+type GridMinMaxSize = {
+    /**
+     * The minimum size of the grid item
+     */
+    min: GridLengthUnit;
+    /**
+     * The maximum size of the grid item
+     */
+    max: GridLengthUnit;
+};
+
+/**
+ * Represents a grid track size
+ */
+type GridTrackSize = GridMinMaxSize | GridLengthUnit;
+
+/**
+ * Represents a grid repeat track
+ */
+type GridRepeatTrack = {
+    /**
+     * The size of the grid track
+     */
+    size: GridTrackSize;
+    /**
+     * The names of the grid lines
+     */
+    names: Array<string>;
+};
+
+/**
+ * Represents a grid track repetition pattern
+ */
+type GridRepetitionCount = "auto-fill" | "auto-fit" | number;
+
+/**
+ * Represents a track sizing function
+ */
+type GridTemplateComponent = {
+    "single": GridTrackSize;
+} | {
+    "repeat": [GridRepetitionCount, Array<GridRepeatTrack>];
+};
+
+/**
+ * Defines how images should be scaled when rendered.
+ */
+type ImageScalingAlgorithm = "auto" | "smooth" | "pixelated";
+
+/**
+ * Defines how flex items are aligned along the main axis.
+ *
+ * This enum determines how space is distributed between and around flex items
+ * along the main axis of the flex container.
+ */
+type JustifyContent = "start" | "end" | "flex-start" | "flex-end" | "center" | "stretch" | "space-between" | "space-evenly" | "space-around";
+
+/**
+ * Represents an angle value in degrees.
+ */
+type Angle = number;
+
+/**
+ * Represents a gradient stop.
+ */
+type GradientStop = {
+    /**
+     * The color of the gradient stop.
+     */
+    color: Color;
+    /**
+     * The position of the gradient stop (0% to 100%).
+     */
+    hint: number | null;
+} | number;
+
+/**
+ * Represents a linear gradient.
+ */
+type LinearGradient = {
+    /**
+     * The angle of the gradient.
+     */
+    angle: Angle;
+    /**
+     * The steps of the gradient.
+     */
+    stops: Array<GradientStop>;
+} | string;
+
+/**
+ * Represents either a linear gradient or a solid color.
+ */
+type LinearGradientOrColor = LinearGradient | Color;
+
+/**
+ * A collection of linear gradients.
+ */
+type LinearGradients = Array<LinearGradient> | string;
+
+/**
+ * Defines how an image should be resized to fit its container.
+ *
+ * Similar to CSS object-fit property.
+ */
+type ObjectFit = "fill" | "contain" | "cover" | "scale-down" | "none";
+
+/**
+ * Defines the positioning method for an element.
+ *
+ * This enum determines how an element is positioned within its containing element.
+ */
+type Position = "relative" | "absolute";
+
+/**
+ * Represents the values for the four sides of a box (top, right, bottom, left).
+ */
+type Sides<T> = T | [T, T] | [T, T, T, T] | string;
+
+/**
+ * Text alignment options for text rendering.
+ *
+ * Corresponds to CSS text-align property values.
+ */
+type TextAlign = "left" | "right" | "center" | "justify" | "start" | "end";
+
+/**
+ * Defines how text should be overflowed.
+ *
+ * This enum determines how text should be handled when it exceeds the container width.
+ */
+type TextOverflow = "ellipsis" | "clip";
+
+/**
+ * Main styling structure that contains all layout and visual properties.
+ */
+type Style = {
+    /**
+     * Display algorithm to use for the element.
+     */
+    display: Display;
+    /**
+     * Width of the element.
+     */
+    width: LengthUnit;
+    /**
+     * Height of the element.
+     */
+    height: LengthUnit;
+    /**
+     * Max width of the element.
+     */
+    maxWidth: LengthUnit;
+    /**
+     * Max height of the element.
+     */
+    maxHeight: LengthUnit;
+    /**
+     * Min width of the element.
+     */
+    minWidth: LengthUnit;
+    /**
+     * Min height of the element.
+     */
+    minHeight: LengthUnit;
+    /**
+     * Aspect ratio of the element (width/height).
+     */
+    aspectRatio?: number;
+    /**
+     * Internal spacing around the element's content (top, right, bottom, left).
+     */
+    padding: Sides<LengthUnit>;
+    /**
+     * Longhand: top padding. Overrides `padding` top value.
+     */
+    paddingTop?: LengthUnit;
+    /**
+     * Longhand: right padding. Overrides `padding` right value.
+     */
+    paddingRight?: LengthUnit;
+    /**
+     * Longhand: bottom padding. Overrides `padding` bottom value.
+     */
+    paddingBottom?: LengthUnit;
+    /**
+     * Longhand: left padding. Overrides `padding` left value.
+     */
+    paddingLeft?: LengthUnit;
+    /**
+     * External spacing around the element (top, right, bottom, left).
+     */
+    margin: Sides<LengthUnit>;
+    /**
+     * Longhand: top margin. Overrides `margin` top value.
+     */
+    marginTop?: LengthUnit;
+    /**
+     * Longhand: right margin. Overrides `margin` right value.
+     */
+    marginRight?: LengthUnit;
+    /**
+     * Longhand: bottom margin. Overrides `margin` bottom value.
+     */
+    marginBottom?: LengthUnit;
+    /**
+     * Longhand: left margin. Overrides `margin` left value.
+     */
+    marginLeft?: LengthUnit;
+    /**
+     * Positioning offsets (top, right, bottom, left) from the element's normal position.
+     */
+    inset: Sides<LengthUnit>;
+    /**
+     * Longhand: top offset. Overrides `inset` top value.
+     */
+    top?: LengthUnit;
+    /**
+     * Longhand: right offset. Overrides `inset` right value.
+     */
+    right?: LengthUnit;
+    /**
+     * Longhand: bottom offset. Overrides `inset` bottom value.
+     */
+    bottom?: LengthUnit;
+    /**
+     * Longhand: left offset. Overrides `inset` left value.
+     */
+    left?: LengthUnit;
+    /**
+     * Direction of flex layout (row or column).
+     */
+    flexDirection: FlexDirection;
+    /**
+     * How a single grid item is aligned along the inline (row) axis, overriding the container's justify-items value.
+     */
+    justifySelf?: AlignItems;
+    /**
+     * How items are aligned along the main axis.
+     */
+    justifyContent?: JustifyContent;
+    /**
+     * How lines are aligned within the flex container when there's extra space in the cross axis.
+     */
+    alignContent?: JustifyContent;
+    /**
+     * How grid items are aligned along the inline (row) axis within their grid areas.
+     */
+    justifyItems?: AlignItems;
+    /**
+     * How items are aligned along the cross axis.
+     */
+    alignItems?: AlignItems;
+    /**
+     * How a single item is aligned along the cross axis, overriding the container's align-items value.
+     */
+    alignSelf?: AlignItems;
+    /**
+     * How flex items should wrap.
+     */
+    flexWrap: FlexWrap;
+    /**
+     * The initial main size of the flex item before growing or shrinking.
+     */
+    flexBasis: LengthUnit;
+    /**
+     * Positioning method (relative, absolute, etc.).
+     */
+    position: Position;
+    /**
+     * Spacing between rows and columns in flex or grid layouts.
+     */
+    gap: Gap;
+    /**
+     * How much the flex item should grow relative to other flex items when positive free space is distributed.
+     */
+    flexGrow: number;
+    /**
+     * How much the flex item should shrink relative to other flex items when negative free space is distributed.
+     */
+    flexShrink: number;
+    /**
+     * Width of the element's border on each side (top, right, bottom, left).
+     */
+    borderWidth: Sides<LengthUnit>;
+    /**
+     * Longhand: top border width. Overrides `border_width` top value.
+     */
+    borderWidthTop?: LengthUnit;
+    /**
+     * Longhand: right border width. Overrides `border_width` right value.
+     */
+    borderWidthRight?: LengthUnit;
+    /**
+     * Longhand: bottom border width. Overrides `border_width` bottom value.
+     */
+    borderWidthBottom?: LengthUnit;
+    /**
+     * Longhand: left border width. Overrides `border_width` left value.
+     */
+    borderWidthLeft?: LengthUnit;
+    /**
+     * How images should be fitted within their container.
+     */
+    objectFit: ObjectFit;
+    /**
+     * Background gradient(s).
+     */
+    backgroundImage?: LinearGradients;
+    /**
+     * Background color for the element.
+     */
+    backgroundColor?: Color;
+    /**
+     * Box shadow effect for the element.
+     */
+    boxShadow?: BoxShadows;
+    /**
+     * Controls the size of implicitly-created grid columns.
+     */
+    gridAutoColumns?: Array<GridTrackSize>;
+    /**
+     * Controls the size of implicitly-created grid rows.
+     */
+    gridAutoRows?: Array<GridTrackSize>;
+    /**
+     * Controls how auto-placed items are inserted in the grid.
+     */
+    gridAutoFlow?: GridAutoFlow;
+    /**
+     * Specifies a grid item's size and location within the grid column.
+     */
+    gridColumn?: GridLine;
+    /**
+     * Specifies a grid item's size and location within the grid row.
+     */
+    gridRow?: GridLine;
+    /**
+     * Defines the line names and track sizing functions of the grid columns.
+     */
+    gridTemplateColumns?: Array<GridTemplateComponent>;
+    /**
+     * Defines the line names and track sizing functions of the grid rows.
+     */
+    gridTemplateRows?: Array<GridTemplateComponent>;
+    /**
+     * How text should be overflowed.
+     */
+    textOverflow?: TextOverflow;
+    /**
+     * Color of the element's border.
+     */
+    borderColor?: Color;
+    /**
+     * Text color for child text elements.
+     */
+    color?: LinearGradientOrColor;
+    /**
+     * Font size for text rendering.
+     */
+    fontSize?: LengthUnit;
+    /**
+     * Font family name for text rendering.
+     */
+    fontFamily?: FontFamily;
+    /**
+     * Line height for text spacing.
+     */
+    lineHeight?: LengthUnit;
+    /**
+     * Font weight for text rendering.
+     */
+    fontWeight?: FontWeight;
+    /**
+     * Maximum number of lines for text before truncation.
+     */
+    lineClamp?: number;
+    /**
+     * Shorthand border radius (top, right, bottom, left).
+     */
+    borderRadius?: Sides<LengthUnit>;
+    /**
+     * Longhand: top border radius. Overrides `border_radius` top value.
+     */
+    borderRadiusTop?: LengthUnit;
+    /**
+     * Longhand: right border radius. Overrides `border_radius` right value.
+     */
+    borderRadiusRight?: LengthUnit;
+    /**
+     * Longhand: bottom border radius. Overrides `border_radius` bottom value.
+     */
+    borderRadiusBottom?: LengthUnit;
+    /**
+     * Longhand: left border radius. Overrides `border_radius` left value.
+     */
+    borderRadiusLeft?: LengthUnit;
+    /**
+     * Text alignment within the element.
+     */
+    textAlign?: TextAlign;
+    /**
+     * Additional spacing between characters in text.
+     */
+    letterSpacing?: LengthUnit;
+    /**
+     * Controls how images are scaled when rendered.
+     */
+    imageRendering?: ImageScalingAlgorithm;
+};
+
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+type AnyNode = {
+    type: string;
+    [key: string]: JsonValue;
+};
+type PartialStyle = Partial<Style>;
+type Node = ContainerNode | TextNode | ImageNode | AnyNode;
+type ContainerNode = PartialStyle & {
+    type: "container";
+    children?: Node[];
+};
+type TextNode = PartialStyle & {
+    type: "text";
+    text: string;
+};
+type ImageNode = PartialStyle & {
+    type: "image";
+    src: string;
+};
+
+export type { ContainerNode as C, ImageNode as I, Node as N, PartialStyle as P, Style as S, TextNode as T, Color as a };