tickup 1.0.0

package/dist/types/Drawings.d.ts

@@ -0,0 +1,54 @@
+import { ShapeBaseArgs } from "../components/Drawing/types";
+import { StrokeLineStyle } from "./overlay";
+export interface DrawingPoint {
+    time: number;
+    price: number;
+}
+export interface CanvasPoint {
+    x: number;
+    y: number;
+}
+export interface DrawingStyleOptions {
+    lineColor: string;
+    lineWidth: number;
+    lineStyle: StrokeLineStyle;
+    fillColor: string;
+    selected: {
+        lineColor: string;
+        lineWidthAdd?: number;
+        lineStyle?: StrokeLineStyle;
+        fillColor?: string;
+    };
+}
+export type FinalDrawingStyle = {
+    lineColor: string;
+    lineWidth: number;
+    lineStyle: StrokeLineStyle;
+    fillColor: string | 'transparent';
+};
+export interface AngleShapeArgs extends ShapeBaseArgs {
+    points: DrawingPoint[];
+}
+export interface PolylineShapeArgs extends ShapeBaseArgs {
+    points: DrawingPoint[];
+}
+export interface LineShapeArgs extends ShapeBaseArgs {
+    points: DrawingPoint[];
+}
+export interface RectangleShapeArgs extends ShapeBaseArgs {
+    points: DrawingPoint[];
+}
+export interface CircleShapeArgs extends ShapeBaseArgs {
+    points: DrawingPoint[];
+}
+export interface TriangleShapeArgs extends ShapeBaseArgs {
+    points: DrawingPoint[];
+}
+export interface ArrowShapeArgs extends ShapeBaseArgs {
+    points: DrawingPoint[];
+}
+export interface CustomSymbolShapeArgs extends ShapeBaseArgs {
+    points: DrawingPoint[];
+    symbol: string;
+    size: number;
+}

package/dist/types/Graph.d.ts

@@ -0,0 +1,45 @@
+export interface TimeRange {
+    start: number;
+    end: number;
+}
+export interface Tick {
+    position: number;
+    label: string;
+}
+export interface PriceRange {
+    min: number;
+    max: number;
+    range: number;
+}
+/**
+ * Visible time window (unix **seconds**) with bar index span, plus the price band used for Y scaling.
+ * Use `ref.getVisibleRanges()` on the stage or product host (same numbers as `getViewInfo()` / `getChartContext().data`).
+ */
+export type VisibleViewRanges = {
+    time: TimeRange & {
+        startIndex: number;
+        endIndex: number;
+    };
+    price: PriceRange;
+};
+export interface DrawTicksOptions {
+    tickHeight: number;
+    tickColor: string;
+    labelColor: string;
+    labelFont: string;
+    labelOffset: number;
+    axisY: number;
+}
+export type IndexRangePair = {
+    startIndex: number;
+    endIndex: number;
+};
+export type ChartDimensionsData = {
+    cssWidth: number;
+    cssHeight: number;
+    dpr: number;
+    width: number;
+    height: number;
+    clientWidth: number;
+    clientHeight: number;
+};

package/dist/types/Interval.d.ts

@@ -0,0 +1,11 @@
+export interface Interval {
+    t: number;
+    o: number;
+    c: number;
+    l: number;
+    h: number;
+    v?: number;
+}
+export interface CandleWithIndex extends Interval {
+    index: number;
+}

package/dist/types/buttons.d.ts

@@ -0,0 +1,30 @@
+import type { ReactNode } from 'react';
+import { Mode } from "../contexts/ModeContext";
+export interface ModeButtonProps {
+    mode: Mode;
+    currentMode: Mode;
+    onClickHandler: any;
+    children?: ReactNode;
+    className?: string;
+}
+export interface ButtonProps {
+    onClickHandler: any;
+    children?: ReactNode;
+    className?: string;
+}
+export declare enum Placement {
+    top = 0,
+    right = 1,
+    bottom = 2,
+    left = 3,
+    auto = 4
+}
+export declare enum TooltipAlign {
+    start = 0,
+    center = 1,
+    end = 2
+}
+export declare enum TooltipAxis {
+    horizontal = 0,
+    vertical = 1
+}

package/dist/types/chartContext.d.ts

@@ -0,0 +1,52 @@
+import type { ChartType, TimeDetailLevel } from './chartOptions';
+import type { AxesPosition, ChartTheme } from './types';
+/**
+ * Serializable snapshot of chart layout, data window, and interaction state for host-side analysis
+ * (sizing, visible ranges, symbol, selection). Obtain via {@link TickUpHostHandle.getChartContext}
+ * or {@link TickUpStageHandle.getChartContext}. The **`data`** fields for visible time/price match
+ * {@link TickUpHostHandle.getVisibleRanges} / {@link TickUpStageHandle.getVisibleRanges} (`time` ↔ `visibleTime*`, `price` ↔ `visiblePrice*`).
+ */
+export type ChartContextInfo = {
+    /** Toolbar symbol if controlled/initial value is known */
+    symbol: string | null;
+    chartType: ChartType;
+    themeVariant: ChartTheme;
+    layout: {
+        /** Measured CSS size of the canvas container (the main plot host element). */
+        canvasContainer: {
+            width: number;
+            height: number;
+        };
+        yAxisWidthPx: number;
+        xAxisHeightPx: number;
+        yAxisPosition: AxesPosition;
+    };
+    /** Backing canvas pixel dimensions and device pixel ratio (from the chart canvas handle). */
+    canvas: {
+        width: number;
+        height: number;
+        dpr: number;
+    };
+    data: {
+        intervalCount: number;
+        firstBarTime: number | null;
+        lastBarTime: number | null;
+        visibleTimeStart: number;
+        visibleTimeEnd: number;
+        visibleTimeStartIndex: number;
+        visibleTimeEndIndex: number;
+        visiblePriceMin: number;
+        visiblePriceMax: number;
+        visiblePriceRange: number;
+    };
+    drawings: {
+        count: number;
+    };
+    interaction: {
+        /** Drawing index in the internal stack, or null if none selected */
+        selectedShapeIndex: number | null;
+    };
+    timeDetailLevel: TimeDetailLevel;
+    timeFormat12h: boolean;
+    numberOfYTicks: number;
+};

package/dist/types/chartOptions.d.ts

@@ -0,0 +1,161 @@
+import { AxesOptions, AxesPosition, ChartTheme } from "./types";
+import type { Interval } from "./Interval";
+import type { TimeRange } from "./Graph";
+import { OverlayCalcSpec, OverlayKind, OverlayOptions, OverlayWithCalc } from "./overlay";
+import { DrawingStyleOptions } from "./Drawings";
+export declare enum TimeDetailLevel {
+    Auto = "auto",
+    Low = "low",
+    Medium = "medium",
+    High = "high"
+}
+export interface TradingSession {
+    dayOfWeek: number;
+    start: string;
+    end: string;
+}
+export declare enum ChartType {
+    Candlestick = "Candlestick",
+    Line = "Line",
+    Area = "Area",
+    Bar = "Bar"
+}
+export declare enum TickUpRenderEngine {
+    standard = "standard",
+    prime = "prime"
+}
+export declare enum NumberNotation {
+    standard = "standard",
+    scientific = "scientific",
+    /** Compact form (short scale) */
+    compact = "compact"
+}
+export declare enum CurrencyDisplay {
+    symbol = "symbol",
+    narrowSymbol = "narrowSymbol",
+    code = "code",
+    name = "name"
+}
+export declare enum AxesUnitPlacement {
+    prefix = "prefix",
+    suffix = "suffix"
+}
+/** Axis / tooltip price display mode (basis points, P&L, yields, vol). */
+export declare enum PriceMetricKind {
+    basisPoints = "basisPoints",
+    pnl = "pnl",
+    /** Yield as a rate (value matches API string `yield`). */
+    Yield = "yield",
+    volatility = "volatility"
+}
+export interface ChartRenderContext {
+    allIntervals: Interval[];
+    visibleStartIndex: number;
+    visibleEndIndex: number;
+    visibleRange: TimeRange;
+    intervalSeconds: number;
+    canvasWidth: number;
+    canvasHeight: number;
+}
+export interface CandleStyleOptions {
+    bullColor: string;
+    bearColor: string;
+    upColor: string;
+    downColor: string;
+    borderColor: string;
+    borderWidth: number;
+    bodyWidthFactor: number;
+    spacingFactor: number;
+}
+export interface LineStyleOptions {
+    color: string;
+    lineWidth: number;
+}
+export interface AreaStyleOptions {
+    fillColor: string;
+    strokeColor: string;
+    lineWidth: number;
+}
+export interface HistogramStyleOptions {
+    bullColor: string;
+    bearColor: string;
+    opacity: number;
+    heightRatio: number;
+}
+export interface BarStyleOptions {
+    bullColor: string;
+    bearColor: string;
+    opacity: number;
+}
+export interface GridStyleOptions {
+    color: string;
+    lineWidth: number;
+    gridSpacing: number;
+    lineColor: string;
+    lineDash: number[];
+}
+export interface AxesStyleOptions {
+    axisPosition: AxesPosition;
+    textColor: string;
+    font: string;
+    lineColor: string;
+    lineWidth: number;
+    locale: string;
+    language: string;
+    numberFractionDigits: number;
+    decimalSeparator: string;
+    thousandsSeparator: string;
+    dateFormat: string;
+    numberNotation?: NumberNotation;
+    currency?: string;
+    useCurrency?: boolean;
+    currencyDisplay?: CurrencyDisplay;
+    minimumFractionDigits?: number;
+    maximumFractionDigits?: number;
+    maximumSignificantDigits?: number;
+    tickSize?: number;
+    autoPrecision?: boolean;
+    unit?: string;
+    unitPlacement?: AxesUnitPlacement;
+    timezone?: string;
+    exchange?: string;
+    tradingSessions?: TradingSession[];
+    holidays?: string[];
+    displayCurrency?: string;
+    conversionRate?: number;
+}
+export type StyleOptions = {
+    candles: CandleStyleOptions;
+    line: LineStyleOptions;
+    area: AreaStyleOptions;
+    histogram: HistogramStyleOptions;
+    bar: BarStyleOptions;
+    grid: GridStyleOptions;
+    overlay: OverlayOptions;
+    axes: AxesStyleOptions;
+    drawings: DrawingStyleOptions;
+    showGrid: boolean;
+    backgroundColor: string;
+};
+interface BaseChartOptions {
+    chartType?: ChartType;
+    /** Visual / render profile. `prime` enables neon styling, glass toolbars, and Prime crosshair. */
+    engine?: TickUpRenderEngine;
+    theme: ChartTheme;
+    showOverlayLine: boolean;
+    showHistogram: boolean;
+    /** Hover crosshair lines (vertical + horizontal) in navigation modes */
+    showCrosshair?: boolean;
+    /** Formatted time (along X) and price (along Y) drawn on the crosshair */
+    showCrosshairValues?: boolean;
+    /** OHLC / change panel while hovering a candle */
+    showCandleTooltip?: boolean;
+    style: StyleOptions;
+    overlays?: OverlayWithCalc[];
+    overlayKinds?: (OverlayKind | OverlayCalcSpec)[];
+}
+export type ChartOptions = {
+    base: BaseChartOptions;
+    axes: AxesOptions;
+};
+export {};

package/dist/types/liveData.d.ts

@@ -0,0 +1,14 @@
+import type { Interval } from './Interval';
+/** How incoming bars are combined with the series already on the chart. */
+export declare enum LiveDataPlacement {
+    replace = "replace",
+    append = "append",
+    prepend = "prepend",
+    mergeByTime = "mergeByTime"
+}
+export interface LiveDataApplyResult {
+    ok: boolean;
+    intervals: Interval[];
+    errors: string[];
+    warnings: string[];
+}

package/dist/types/overlay.d.ts

@@ -0,0 +1,64 @@
+/** Stroke pattern for overlay / drawing lines (canvas). */
+export declare enum StrokeLineStyle {
+    solid = "solid",
+    dashed = "dashed",
+    dotted = "dotted"
+}
+export interface OverlayOptions {
+    lineColor: string;
+    lineWidth: number;
+    lineStyle: StrokeLineStyle;
+}
+export interface OverlayWithCalc extends OverlayOptions {
+    calc: OverlayCalcSpec;
+    connectNulls?: boolean;
+    useCenterX?: boolean;
+}
+/**
+ * Represents a fully computed overlay series, ready to be drawn on the canvas.
+ */
+export interface OverlaySeries {
+    id?: string;
+    source: (number | null)[];
+    options: OverlayOptions;
+    connectNulls: boolean;
+    useCenterX: boolean;
+}
+export declare enum OverlayPriceKey {
+    close = "close",
+    open = "open",
+    high = "high",
+    low = "low"
+}
+export declare enum OverlayKind {
+    sma = "sma",
+    ema = "ema",
+    wma = "wma",
+    vwap = "vwap",
+    bbands_mid = "bbands_mid",
+    bbands_upper = "bbands_upper",
+    bbands_lower = "bbands_lower"
+}
+export type OverlayCalcSpec = {
+    kind: OverlayPriceKey;
+} | {
+    kind: OverlayKind.sma | OverlayKind.ema | OverlayKind.wma;
+    period: number;
+    price?: OverlayPriceKey;
+} | {
+    kind: OverlayKind.vwap;
+} | {
+    kind: OverlayKind.bbands_mid;
+    period: number;
+    price?: OverlayPriceKey;
+} | {
+    kind: OverlayKind.bbands_upper;
+    period: number;
+    stddev?: number;
+    price?: OverlayPriceKey;
+} | {
+    kind: OverlayKind.bbands_lower;
+    period: number;
+    stddev?: number;
+    price?: OverlayPriceKey;
+};

package/dist/types/tickupProducts.d.ts

@@ -0,0 +1,18 @@
+/**
+ * TickUp product lines (tiered charting shells).
+ *
+ * - **pulse** — minimal embed: plot + axes only (no toolbars). Toolbar chrome is locked; cannot be enabled via props.
+ * - **flow** — analysis: symbol bar & settings, no drawing sidebar. Chrome locked.
+ * - **command** — full trader UI: drawings, modals, live API. Chrome locked to full toolbars.
+ * - **desk** — broker / embedded terminal: same as command + attribution required. Chrome locked.
+ * - **prime** — licensed / eval tier: same chrome as command + optional `licenseKey` banner when unset.
+ *
+ * Product components omit `showSidebar` / `showTopBar` / `showSettingsBar` from their props; use `TickUpHost` without `productId` for a custom layout.
+ */
+export declare enum TickUpProductId {
+    pulse = "pulse",
+    flow = "flow",
+    command = "command",
+    desk = "desk",
+    prime = "prime"
+}

package/dist/types/types.d.ts

@@ -0,0 +1,36 @@
+export declare enum AxesPosition {
+    left = 0,
+    right = 1
+}
+export declare enum AlignOptions {
+    left = "left",
+    center = "center",
+    right = "right"
+}
+export declare enum ChartTheme {
+    light = "light",
+    dark = "dark",
+    grey = "grey"
+}
+export type AxesOptions = {
+    yAxisPosition: AxesPosition;
+    currency: string;
+    numberOfYTicks: number;
+};
+export type CanvasSizes = {
+    width: number;
+    height: number;
+};
+export type DeepPartial<T> = {
+    [K in keyof T]?: T[K] extends (string | number | boolean | symbol | Function | any[]) ? T[K] : T[K] extends object ? DeepPartial<NonNullable<T[K]>> : T[K];
+};
+export type DeepRequired<T> = {
+    [K in keyof T]-?: T[K] extends (string | number | boolean | symbol | Function | any[]) ? NonNullable<T[K]> : T[K] extends object ? DeepRequired<NonNullable<T[K]>> : NonNullable<T[K]>;
+};
+export type WindowSpreadOptions = {
+    TOP_BAR_PX: number;
+    LEFT_BAR_PX: number;
+    INITIAL_X_AXIS_HEIGHT: number;
+    INITIAL_Y_AXIS_WIDTH: number;
+};
+export declare const windowSpread: WindowSpreadOptions;

package/dist/utils/LocaleResolver.d.ts

@@ -0,0 +1,15 @@
+import { AxesStyleOptions } from '../types/chartOptions';
+import { LocaleDefaults } from './i18n';
+export interface ResolvedLocaleSettings extends LocaleDefaults {
+    decimalSeparator: string;
+    thousandsSeparator: string;
+    dateFormat: string;
+    locale: string;
+    language: string;
+    currency: string;
+    useCurrency: boolean;
+}
+/**
+ * Resolves the effective locale settings, considering both locale defaults and user overrides.
+ */
+export declare const resolveLocaleSettings: (options: AxesStyleOptions) => ResolvedLocaleSettings;

package/dist/utils/captureChartRegion.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Metadata embedded in snapshot images and encoded into suggested download file names.
+ */
+export interface ChartSnapshotMeta {
+    symbol: string;
+    visibleTimeStartSec: number;
+    visibleTimeEndSec: number;
+    intervalSeconds: number;
+    chartType: string;
+    barsInView: number;
+    totalBarsInSeries: number;
+    /** Y-axis visible range at capture time (analysis context). */
+    visiblePriceMin: number;
+    visiblePriceMax: number;
+    capturedAtMs: number;
+}
+export declare function contrastingFooterTextColor(backgroundCss: string, axesTextFallback?: string): string;
+/** Safe single token for file names (ASCII, no path chars). */
+export declare function sanitizeChartSnapshotToken(raw: string, maxLen: number): string;
+/**
+ * File name encodes symbol, unix time range, bar period, chart kind, Y window (min/max × 1000, int), and capture instant.
+ * Example: `AAPL_t1688000000-1688060000_iv300s_y98765-102340_candle_cap2025-03-28T12-34-56-789Z.png`
+ */
+export declare function buildChartSnapshotFileName(meta: ChartSnapshotMeta): string;
+export interface CaptureChartRegionOptions {
+    /** When set, a footer strip with human-readable metadata is drawn under the chart bitmap. */
+    meta?: ChartSnapshotMeta | null;
+    footerTextColor?: string;
+}
+/**
+ * Rasterize all descendant canvases inside `root` into one PNG (axes + stacked chart layers).
+ * Skips the interaction overlay canvas (crosshair / pan), which is not part of the data display.
+ */
+export declare function captureChartRegionToPngDataUrl(root: HTMLElement | null, backgroundColor: string, options?: CaptureChartRegionOptions): string | null;

package/dist/utils/deepEqual.d.ts

@@ -0,0 +1 @@
+export declare function deepEqual(obj1: any, obj2: any): boolean;

package/dist/utils/deepMerge.d.ts

@@ -0,0 +1,2 @@
+import type { DeepPartial, DeepRequired } from "../types/types";
+export declare function deepMerge<T>(base: DeepRequired<T>, patch?: DeepPartial<T>): DeepRequired<T>;

package/dist/utils/i18n.d.ts

@@ -0,0 +1,26 @@
+export interface LocaleDefaults {
+    decimalSeparator: string;
+    thousandsSeparator: string;
+    dateFormat: string;
+    direction: 'ltr' | 'rtl';
+    language: string;
+    label: string;
+    defaultCurrency?: string;
+    isUpSuccess?: boolean;
+}
+export declare const SUPPORTED_LOCALES: Record<string, LocaleDefaults>;
+export declare const SUPPORTED_CURRENCIES: {
+    code: string;
+    label: string;
+}[];
+export declare const getDateFnsLocale: (localeStr: string) => any;
+export declare const SUPPORTED_LANGUAGES: {
+    code: string;
+    label: string;
+}[];
+export declare const getLocaleDefaults: (locale: string) => LocaleDefaults;
+export declare const translate: (key: string, lang: string) => string;
+/**
+ * Perform locale-aware string comparison for sorting.
+ */
+export declare const compareStrings: (a: string, b: string, locale?: string) => number;

package/dist/utils/liveDataMerge.d.ts

@@ -0,0 +1,21 @@
+import type { Interval } from '../types/Interval';
+import { LiveDataPlacement, type LiveDataApplyResult } from '../types/liveData';
+/**
+ * Validates fields, coerces OHLC consistency, drops bad volume.
+ * Returns null if the row cannot be represented as an interval.
+ */
+export declare function normalizeInterval(raw: Partial<Interval>, sourceLabel?: string): {
+    value: Interval | null;
+    notes: string[];
+};
+export declare function normalizeIntervals(items: Array<Partial<Interval>>): {
+    intervals: Interval[];
+    errors: string[];
+    warnings: string[];
+};
+/** Later rows with the same timestamp overwrite earlier ones (typical live tick update). */
+export declare function dedupeByTimePreferLast(chronological: Interval[]): Interval[];
+/**
+ * Applies live / partial updates with explicit placement rules and normalized OHLC.
+ */
+export declare function applyLiveDataMerge(existing: Interval[], incomingRaw: Interval | Interval[], placement: LiveDataPlacement): LiveDataApplyResult;

package/dist/utils/marketData.d.ts

@@ -0,0 +1,8 @@
+import { TradingSession } from "../types/chartOptions";
+export interface ExchangeConfig {
+    name: string;
+    timezone: string;
+    sessions: TradingSession[];
+}
+export declare const EXCHANGES: Record<string, ExchangeConfig>;
+export declare function getExchangeConfig(exchange: string): ExchangeConfig | undefined;

package/dist/utils/timeUtils.d.ts

@@ -0,0 +1,9 @@
+import { TradingSession } from "../types/chartOptions";
+/**
+ * Formats a timestamp into a human-readable date/time string with timezone support.
+ */
+export declare function formatWithTimezone(timestamp: number, formatOptions: Intl.DateTimeFormatOptions, locale?: string, timezone?: string): string;
+/**
+ * Checks if a given timestamp is within any of the provided trading sessions.
+ */
+export declare function isWithinTradingSession(timestamp: number, sessions: TradingSession[], timezone?: string): boolean;

package/dist/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>