aliencharts 0.1.2 → 0.1.3

package/index.d.ts

@@ -0,0 +1,161 @@
+import type { MouseEvent as ReactMouseEvent, ReactElement } from "react";
+
+export type NumericArray =
+  | number[]
+  | Float32Array
+  | Float64Array
+  | Int8Array
+  | Uint8Array
+  | Uint8ClampedArray
+  | Int16Array
+  | Uint16Array
+  | Int32Array
+  | Uint32Array;
+
+export interface SeriesOptions {
+  id: string;
+  name?: string;
+  color?: string;
+  x?: NumericArray;
+  y?: NumericArray;
+  maxLevels?: number;
+}
+
+export interface VisibleSeriesPoints {
+  x: Float64Array;
+  y: Float32Array;
+  bucketSize: number;
+  pointCount: number;
+}
+
+export class LineSeries {
+  constructor(options: SeriesOptions);
+
+  id: string;
+  name: string;
+  color: string;
+  maxLevels: number;
+  readonly length: number;
+  rawX: Float64Array;
+  rawY: Float32Array;
+
+  append(xValues: NumericArray, yValues: NumericArray): void;
+  getVisiblePoints(
+    xMin: number,
+    xMax: number,
+    pixelWidth: number,
+  ): VisibleSeriesPoints;
+}
+
+export interface Chart {
+  id: string;
+  title: string;
+  series: LineSeries[];
+  pinned?: boolean;
+  yRange?: {
+    min: number;
+    max: number;
+  };
+  [key: string]: unknown;
+}
+
+export interface DataPoint {
+  x: number;
+  y: number;
+}
+
+export type DrawingTool = "trendline" | "hline" | "vline" | "pin";
+
+export interface DrawingStyle {
+  color?: string;
+  lineWidth?: number;
+  dashPattern?: number[];
+  extendLeft?: boolean;
+  extendRight?: boolean;
+  text?: string;
+}
+
+export interface Drawing {
+  id: string;
+  chartId: string;
+  type: DrawingTool;
+  start: DataPoint;
+  end: DataPoint;
+  createdAt?: number;
+  style?: DrawingStyle;
+}
+
+export interface MovingAverage {
+  enabled?: boolean;
+  period?: number;
+  type?: "ema" | "sma";
+  hideBase?: boolean;
+}
+
+export interface TopMarker<T = unknown> {
+  id?: string | number;
+  x?: number;
+  step?: number;
+  color?: string;
+  title?: string;
+  ariaLabel?: string;
+  data?: T;
+  [key: string]: unknown;
+}
+
+export interface ChartContextMenuPayload {
+  chart: Chart;
+  event: ReactMouseEvent<HTMLDivElement>;
+  point: DataPoint;
+}
+
+export interface CreateDrawingIdPayload {
+  chartId: string;
+  type: DrawingTool;
+}
+
+export interface ChartGridProps {
+  charts: Chart[];
+  columns?: number;
+  className?: string;
+  dataRevision?: number;
+  initialVisiblePoints?: number | null;
+  backgroundColor?: string;
+  antialiasLines?: boolean;
+  followLatest?: boolean;
+  followVisibleLatest?: boolean;
+  jumpToLatestRevision?: number;
+  drawings?: Drawing[];
+  onDrawingsChange?: (drawings: Drawing[]) => void;
+  activeDrawingTool?: DrawingTool | null;
+  onActiveDrawingToolChange?: (tool: DrawingTool | null) => void;
+  selectedDrawingId?: string | null;
+  onSelectedDrawingIdChange?: (drawingId: string | null) => void;
+  createDrawingId?: (payload: CreateDrawingIdPayload) => string;
+  onClearDrawingsRequest?: (chartId: string) => void;
+  onChartContextMenu?: (payload: ChartContextMenuPayload) => void;
+  movingAverageByChart?: Record<string, MovingAverage>;
+  onMovingAverageToggle?: (chartId: string) => void;
+  onMovingAverageChange?: (
+    chartId: string,
+    movingAverage: MovingAverage,
+  ) => void;
+  seriesOrderByChart?: Record<string, number[]>;
+  topMarkers?: TopMarker[];
+  onTopMarkerClick?: (marker: TopMarker) => void;
+  xAxisLabel?: string;
+  disableDrawings?: boolean;
+  formatXTick?: (value: number) => string;
+  formatXValue?: (value: number) => string;
+  formatYValue?: (value: number) => string;
+}
+
+export interface MockChartsOptions {
+  chartCount?: number;
+  seriesPerChart?: number;
+  pointCount?: number;
+}
+
+export function ChartGrid(props: ChartGridProps): ReactElement;
+export function createSeries(options: SeriesOptions): LineSeries;
+export function createMockCharts(options?: MockChartsOptions): Chart[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aliencharts",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "WebGL chart renderer for multi-metric dashboards, built for ease of use and high performance.",
   "type": "module",
   "license": "MIT",
@@ -24,15 +24,19 @@
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
+  "types": "./index.d.ts",
   "exports": {
     ".": {
+      "types": "./index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
     "./styles.css": "./dist/aliencharts.css"
   },
   "files": [
-    "dist"
+    "dist",
+    "assets",
+    "index.d.ts"
   ],
   "sideEffects": [
     "**/*.css"