@impulse-ui-native/charts 2.1.0 → 2.1.1

package/dist/index.d.mts

@@ -1,321 +1,36 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as _shopify_react_native_skia from '@shopify/react-native-skia';
-import { FontWeight, SkTypefaceFontProvider, SkTextFontFeatures, SkPath, TextAlign, SkParagraphStyle } from '@shopify/react-native-skia';
-import * as _impulse_ui_native_theme from '@impulse-ui-native/theme';
-import { AppTheme } from '@impulse-ui-native/theme';
-import * as react from 'react';
-
-type ChartStrokeCap = "butt" | "round" | "square";
-type ChartStrokeJoin = "bevel" | "miter" | "round";
-interface ChartStrokeStyle {
-    color?: string;
-    width?: number;
-    opacity?: number;
-    dash?: readonly number[];
-}
-interface ChartLabelStyle {
-    color?: string;
-    fontSize?: number;
-    fontFamily?: string;
-    fontWeight?: FontWeight;
-    maxLines?: number;
-}
-
-type ChartScaleType = "linear" | "point" | "time";
-type ChartNumericDomain = readonly [minimum: number, maximum: number];
-interface ChartInsets {
-    top: number;
-    right: number;
-    bottom: number;
-    left: number;
-}
-interface ChartSize {
-    width: number;
-    height: number;
-}
-interface ChartPoint {
-    x: number;
-    y: number;
-}
-interface ChartRect extends ChartSize {
-    x: number;
-    y: number;
-}
-interface ChartLayout {
-    size: ChartSize;
-    insets: ChartInsets;
-    plot: ChartRect;
-    xAxis: ChartRect;
-    yAxis: ChartRect;
-}
-interface ChartAxisOptions<Value> {
-    visible?: boolean;
-    tickCount?: number;
-    format?: (value: Value) => string;
-    line?: ChartAxisLineOptions;
-    tick?: ChartAxisTickOptions;
-    label?: ChartAxisLabelOptions;
-}
-interface ChartAxisLineOptions extends ChartStrokeStyle {
-    visible?: boolean;
-}
-interface ChartAxisTickOptions extends ChartStrokeStyle {
-    visible?: boolean;
-    length?: number;
-}
-interface ChartAxisLabelOptions extends ChartLabelStyle {
-    visible?: boolean;
-    gap?: number;
-    rotation?: number;
-}
-interface ChartXAxisOptions<X> extends ChartAxisOptions<X> {
-}
-interface ChartYAxisOptions extends ChartAxisOptions<number> {
-    domain?: ChartNumericDomain;
-}
-
-interface ChartGridLineOptions extends ChartStrokeStyle {
-    visible?: boolean;
-}
-interface ChartGridOptions {
-    x?: boolean | ChartGridLineOptions;
-    y?: boolean | ChartGridLineOptions;
-}
-interface ResolvedGridLineOptions {
-    visible: boolean;
-    color: string;
-    width: number;
-    opacity: number;
-    dash?: readonly number[];
-}
-interface GridProps<X extends ChartXValue = number> {
-    options?: ChartGridOptions;
-    plot: ChartRect;
-    theme: AppTheme;
-    xTicks: readonly X[];
-    xScale: LineChartScale<X>;
-    yTicks: readonly number[];
-    yScale: LineChartScale<number>;
-}
-
-type ChartXValue = number | string | Date;
-type LineChartCurve = "linear" | "monotone";
-type LineChartScale<Value> = (value: Value) => number | undefined;
-interface LineChartPoint<X extends ChartXValue = number> {
-    x: X;
-    y: number | null;
-}
-interface LineChartCoordinate<X extends ChartXValue = number> {
-    datum: LineChartPoint<X>;
-    index: number;
-    x: number | null;
-    y: number | null;
-}
-interface LineChartLineOptions extends ChartStrokeStyle {
-    visible?: boolean;
-    curve?: LineChartCurve;
-    cap?: ChartStrokeCap;
-    join?: ChartStrokeJoin;
-}
-interface LineChartCommonProps<X extends ChartXValue = number> {
-    fontManager?: SkTypefaceFontProvider;
-    grid?: ChartGridOptions;
-    xScaleType?: ChartScaleType;
-    xAxis?: ChartXAxisOptions<X>;
-    yAxis?: ChartYAxisOptions;
-    insets?: Partial<ChartInsets>;
-}
-interface LineChartProps<X extends ChartXValue = number> extends LineChartCommonProps<X> {
-    data: readonly LineChartPoint<X>[];
-    line?: LineChartLineOptions;
-}
-
-interface AxisTick<Value> {
-    value: Value;
-    position: number;
-}
-interface AxisLineLayout {
-    start: ChartPoint;
-    end: ChartPoint;
-}
-interface AxisTickLayout<Value> extends AxisTick<Value>, AxisLineLayout {
-    labelRect: ChartRect;
-}
-interface AxisLayout<Value> {
-    line: AxisLineLayout;
-    ticks: readonly AxisTickLayout<Value>[];
-}
-interface CreateAxisLayoutProps<Value> {
-    values: readonly Value[];
-    scale: LineChartScale<Value>;
-    plot: ChartRect;
-    region: ChartRect;
-    tickLength: number;
-    labelGap: number;
-}
-interface CreateYAxisLayoutProps extends CreateAxisLayoutProps<number> {
-    fontSize: number;
-}
-interface AxisProps<Value> {
-    ticks: readonly Value[];
-    scale: LineChartScale<Value>;
-    plot: ChartRect;
-    region: ChartRect;
-    theme: AppTheme;
-    options?: ChartAxisOptions<Value>;
-    fontManager?: SkTypefaceFontProvider;
-    lineVisible?: boolean;
-    tickVisible?: boolean;
-}
-interface XAxisProps<X extends ChartXValue = number> extends AxisProps<X> {
-}
-interface YAxisProps extends AxisProps<number> {
-}
-
-type LabelHorizontalAlignment = "left" | "center" | "right";
-type LabelVerticalAlignment = "top" | "center" | "bottom";
-interface LabelProps {
-    text: string;
-    rect: ChartRect;
-    theme: AppTheme;
-    horizontalAlign?: LabelHorizontalAlignment;
-    verticalAlign?: LabelVerticalAlignment;
-    color?: string;
-    fontSize?: number;
-    fontFamily?: string;
-    fontWeight?: FontWeight;
-    fontManager?: SkTypefaceFontProvider;
-    maxLines?: number;
-    rotation?: number;
-    tnum?: boolean;
-}
-
-interface LineProps<X extends ChartXValue = number> extends LineChartLineOptions {
-    coordinates: readonly LineChartCoordinate<X>[];
-}
-
-interface MultiLineChartSeries<X extends ChartXValue = number> {
-    id: string;
-    data: readonly LineChartPoint<X>[];
-    line?: LineChartLineOptions;
-}
-interface MultiLineChartSeriesModel<X extends ChartXValue = number> extends MultiLineChartSeries<X> {
-    coordinates: readonly LineChartCoordinate<X>[];
-}
-interface MultiLineChartProps<X extends ChartXValue = number> extends LineChartCommonProps<X> {
-    series: readonly MultiLineChartSeries<X>[];
-}
-interface MultiLineChartBodyProps<X extends ChartXValue = number> extends MultiLineChartProps<X> {
-    size: ChartSize;
-    theme: AppTheme;
-}
-
-interface UseLineChartProps<X extends ChartXValue = number> {
-    data: readonly LineChartPoint<X>[];
-    plot: ChartRect;
-    xScaleType?: ChartScaleType;
-    xAxis?: ChartXAxisOptions<X>;
-    yAxis?: ChartYAxisOptions;
-}
-interface UseLineChartResult<X extends ChartXValue = number> {
-    xDomain: readonly X[];
-    yDomain: ChartNumericDomain;
-    xTicks: readonly X[];
-    yTicks: readonly number[];
-    coordinates: readonly LineChartCoordinate<X>[];
-    xScale: LineChartScale<X>;
-    yScale: LineChartScale<number>;
-}
-interface LineChartXScaleModel<X extends ChartXValue> {
-    domain: readonly X[];
-    ticks: readonly X[];
-    scale: LineChartScale<X>;
-}
-
-interface UseMultiLineChartProps<X extends ChartXValue = number> extends Pick<MultiLineChartProps<X>, "series" | "xAxis" | "xScaleType" | "yAxis"> {
-    plot: ChartRect;
-}
-interface UseMultiLineChartResult<X extends ChartXValue = number> extends Omit<UseLineChartResult<X>, "coordinates"> {
-    series: readonly MultiLineChartSeriesModel<X>[];
-}
-
-declare const Grid: <X extends ChartXValue = number>(props: GridProps<X>) => react_jsx_runtime.JSX.Element;
-
-declare const Label: (props: LabelProps) => react_jsx_runtime.JSX.Element | null;
-
-declare const Line: <X extends ChartXValue = number>(props: LineProps<X>) => react_jsx_runtime.JSX.Element | null;
-
-declare const XAxis: <X extends ChartXValue = number>(props: XAxisProps<X>) => react_jsx_runtime.JSX.Element;
-
-declare const YAxis: (props: YAxisProps) => react_jsx_runtime.JSX.Element;
-
-declare const LineChart: <X extends ChartXValue = number>(props: LineChartProps<X>) => react_jsx_runtime.JSX.Element;
-
-declare const MultiLineChart: <X extends ChartXValue = number>(props: MultiLineChartProps<X>) => react_jsx_runtime.JSX.Element;
-
-declare const AxisDefaultWidth = 1;
-declare const AxisDefaultOpacity = 1;
-declare const AxisDefaultTickLength = 4;
-declare const AxisDefaultLabelGap = 4;
-
-declare const GridDefaultWidth = 1;
-declare const GridDefaultOpacity = 1;
-declare const GridDefaultXVisible = true;
-declare const GridDefaultYVisible = true;
-
-declare const TabularNumsFeature: SkTextFontFeatures;
-declare const LabelDefaultHorizontalAlignment: LabelHorizontalAlignment;
-declare const LabelDefaultVerticalAlignment: LabelVerticalAlignment;
-
-declare const LineDefaultColor: string;
-declare const LineDefaultColors: _impulse_ui_native_theme.ChartColorPalette;
-declare const LineDefaultWidth = 2;
-declare const LineDefaultOpacity = 1;
-declare const LineDefaultCurve: LineChartCurve;
-declare const LineDefaultCap: ChartStrokeCap;
-declare const LineDefaultJoin: ChartStrokeJoin;
-
-declare const LineChartDefaultTickCount = 5;
-declare const LineChartDefaultNumericDomain: ChartNumericDomain;
-
-declare function useChartCanvas(): {
-    ref: react.RefObject<_shopify_react_native_skia.CanvasRef | null>;
-    size: _shopify_react_native_skia.SkSize;
-};
-
-declare function useLineChart<X extends ChartXValue = number>(props: UseLineChartProps<X>): UseLineChartResult<X>;
-
-declare function useMultiLineChart<X extends ChartXValue = number>(props: UseMultiLineChartProps<X>): UseMultiLineChartResult<X>;
-
-declare function createAxisTicks<Value>(values: readonly Value[], scale: LineChartScale<Value>): AxisTick<Value>[];
-declare function createXAxisLayout<Value>(props: CreateAxisLayoutProps<Value>): AxisLayout<Value>;
-declare function createYAxisLayout(props: CreateYAxisLayoutProps): AxisLayout<number>;
-declare function createXAxisLabelRect(ticks: readonly AxisTick<unknown>[], index: number, region: ChartRect, offset: number): ChartRect;
-declare function createYAxisLabelRect(position: number, region: ChartRect, width: number, fontSize: number): ChartRect;
-declare function formatAxisTick<Value>(value: Value, format?: (value: Value) => string): string;
-
-declare function createChartLayout(size: ChartSize, insets?: Partial<ChartInsets>): ChartLayout;
-declare function createInsetRect(rect: ChartRect, amount: number): ChartRect;
-
-declare function createVerticalGridPath<Value>(values: readonly Value[], scale: LineChartScale<Value>, plot: ChartRect): SkPath | null;
-declare function createHorizontalGridPath<Value>(values: readonly Value[], scale: LineChartScale<Value>, plot: ChartRect): SkPath | null;
-declare function resolveGridLineOptions(options: boolean | ChartGridLineOptions | undefined, defaultVisible: boolean, defaultColor: string): ResolvedGridLineOptions;
-
-declare function getLabelTextAlign(alignment: LabelHorizontalAlignment): TextAlign;
-declare function getLabelY(rect: ChartRect, paragraphHeight: number, alignment: LabelVerticalAlignment): number;
-
-declare function createLinePath<X extends ChartXValue>(coordinates: readonly LineChartCoordinate<X>[], curve: LineChartCurve): SkPath | null;
-declare function fitLineCoordinatesToRect<X extends ChartXValue>(coordinates: readonly LineChartCoordinate<X>[], source: ChartRect, target: ChartRect): LineChartCoordinate<X>[];
-
-declare function createLineChartModel<X extends ChartXValue>(props: UseLineChartProps<X>): UseLineChartResult<X>;
-declare function createLineChartCoordinates<X extends ChartXValue>(data: readonly LineChartPoint<X>[], xScale: LineChartScale<X>, yScale: LineChartScale<number>): LineChartCoordinate<X>[];
-
-declare function createDrawableMultiLineChartSeries<X extends ChartXValue>(series: MultiLineChartSeriesModel<X>, index: number, plot: ChartRect): MultiLineChartSeriesModel<X>;
-
-interface CreateParagraphBuilderProps {
-    paragraphStyle?: SkParagraphStyle;
-    typefaceProvider?: SkTypefaceFontProvider;
-}
-declare function createParagraphBuilder(props: CreateParagraphBuilderProps): _shopify_react_native_skia.SkParagraphBuilder;
-
-export { AxisDefaultLabelGap, AxisDefaultOpacity, AxisDefaultTickLength, AxisDefaultWidth, type AxisLayout, type AxisLineLayout, type AxisProps, type AxisTick, type AxisTickLayout, type ChartAxisLabelOptions, type ChartAxisLineOptions, type ChartAxisOptions, type ChartAxisTickOptions, type ChartGridLineOptions, type ChartGridOptions, type ChartInsets, type ChartLabelStyle, type ChartLayout, type ChartNumericDomain, type ChartPoint, type ChartRect, type ChartScaleType, type ChartSize, type ChartStrokeCap, type ChartStrokeJoin, type ChartStrokeStyle, type ChartXAxisOptions, type ChartXValue, type ChartYAxisOptions, type CreateAxisLayoutProps, type CreateYAxisLayoutProps, Grid, GridDefaultOpacity, GridDefaultWidth, GridDefaultXVisible, GridDefaultYVisible, type GridProps, Label, LabelDefaultHorizontalAlignment, LabelDefaultVerticalAlignment, type LabelHorizontalAlignment, type LabelProps, type LabelVerticalAlignment, Line, LineChart, type LineChartCommonProps, type LineChartCoordinate, type LineChartCurve, LineChartDefaultNumericDomain, LineChartDefaultTickCount, type LineChartLineOptions, type LineChartPoint, type LineChartProps, type LineChartScale, type LineChartXScaleModel, LineDefaultCap, LineDefaultColor, LineDefaultColors, LineDefaultCurve, LineDefaultJoin, LineDefaultOpacity, LineDefaultWidth, type LineProps, MultiLineChart, type MultiLineChartBodyProps, type MultiLineChartProps, type MultiLineChartSeries, type MultiLineChartSeriesModel, type ResolvedGridLineOptions, TabularNumsFeature, type UseLineChartProps, type UseLineChartResult, type UseMultiLineChartProps, type UseMultiLineChartResult, XAxis, type XAxisProps, YAxis, type YAxisProps, createAxisTicks, createChartLayout, createDrawableMultiLineChartSeries, createHorizontalGridPath, createInsetRect, createLineChartCoordinates, createLineChartModel, createLinePath, createParagraphBuilder, createVerticalGridPath, createXAxisLabelRect, createXAxisLayout, createYAxisLabelRect, createYAxisLayout, fitLineCoordinatesToRect, formatAxisTick, getLabelTextAlign, getLabelY, resolveGridLineOptions, useChartCanvas, useLineChart, useMultiLineChart };
+export { Grid } from './components/primitives/grid.mjs';
+export { Label } from './components/primitives/label.mjs';
+export { Line } from './components/primitives/line.mjs';
+export { XAxis } from './components/primitives/x-axis.mjs';
+export { YAxis } from './components/primitives/y-axis.mjs';
+export { LineChart } from './components/line-chart.mjs';
+export { MultiLineChart } from './components/multi-line-chart.mjs';
+export { AxisDefaultLabelGap, AxisDefaultOpacity, AxisDefaultTickLength, AxisDefaultWidth } from './constants/axis.constants.mjs';
+export { GridDefaultOpacity, GridDefaultWidth, GridDefaultXVisible, GridDefaultYVisible } from './constants/grid.constants.mjs';
+export { LabelDefaultHorizontalAlignment, LabelDefaultVerticalAlignment, TabularNumsFeature } from './constants/label.constants.mjs';
+export { LineDefaultCap, LineDefaultColor, LineDefaultColors, LineDefaultCurve, LineDefaultJoin, LineDefaultOpacity, LineDefaultWidth } from './constants/line.constants.mjs';
+export { LineChartDefaultNumericDomain, LineChartDefaultTickCount } from './constants/line-chart.constants.mjs';
+export { useChartCanvas } from './hooks/use-chart-canvas.hook.mjs';
+export { useLineChart } from './hooks/use-line-chart.hook.mjs';
+export { useMultiLineChart } from './hooks/use-multi-line-chart.hook.mjs';
+export { AxisLayout, AxisLineLayout, AxisProps, AxisTick, AxisTickLayout, CreateAxisLayoutProps, CreateYAxisLayoutProps, XAxisProps, YAxisProps } from './types/axis.types.mjs';
+export { ChartAxisLabelOptions, ChartAxisLineOptions, ChartAxisOptions, ChartAxisTickOptions, ChartInsets, ChartLayout, ChartNumericDomain, ChartPoint, ChartRect, ChartScaleType, ChartSize, ChartXAxisOptions, ChartYAxisOptions } from './types/common.types.mjs';
+export { C as ChartGridLineOptions, a as ChartGridOptions, b as ChartXValue, G as GridProps, L as LineChartCommonProps, c as LineChartCoordinate, d as LineChartCurve, e as LineChartLineOptions, f as LineChartPoint, g as LineChartProps, h as LineChartScale, R as ResolvedGridLineOptions } from './line-chart.types-yxru5uWc.mjs';
+export { LabelHorizontalAlignment, LabelProps, LabelVerticalAlignment } from './types/label.types.mjs';
+export { LineProps } from './types/line.types.mjs';
+export { MultiLineChartBodyProps, MultiLineChartProps, MultiLineChartSeries, MultiLineChartSeriesModel } from './types/multi-line-chart.types.mjs';
+export { ChartLabelStyle, ChartStrokeCap, ChartStrokeJoin, ChartStrokeStyle } from './types/style.types.mjs';
+export { LineChartXScaleModel, UseLineChartProps, UseLineChartResult } from './types/use-line-chart.types.mjs';
+export { UseMultiLineChartProps, UseMultiLineChartResult } from './types/use-multi-line-chart.types.mjs';
+export { createAxisTicks, createXAxisLabelRect, createXAxisLayout, createYAxisLabelRect, createYAxisLayout, formatAxisTick } from './utils/axis.util.mjs';
+export { createChartLayout, createInsetRect } from './utils/chart-layout.util.mjs';
+export { createHorizontalGridPath, createVerticalGridPath, resolveGridLineOptions } from './utils/grid.util.mjs';
+export { getLabelTextAlign, getLabelY } from './utils/label.util.mjs';
+export { createLinePath, fitLineCoordinatesToRect } from './utils/line.util.mjs';
+export { createLineChartCoordinates, createLineChartModel } from './utils/line-chart.util.mjs';
+export { createDrawableMultiLineChartSeries } from './utils/multi-line-chart.util.mjs';
+export { createParagraphBuilder } from './utils/paragraph-builder.util.mjs';
+import 'react/jsx-runtime';
+import '@shopify/react-native-skia';
+import '@impulse-ui-native/theme';
+import 'react';