tickup 1.0.33 → 1.0.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,43 +6,44 @@
6
6
  [![License](https://img.shields.io/badge/license-MIT-yellow.svg)](https://github.com/BARDAMRI/tickup-charts/blob/main/LICENSE)
7
7
  [![Bundle Size](https://img.shields.io/bundlephobia/minzip/tickup)](https://bundlephobia.com/package/tickup)
8
8
 
9
- High-performance, canvas-based financial charting engine for React.
9
+ ## Standard Edition vs TickUp Prime (Pro)
10
10
 
11
- ![TickUp Interaction Demo](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/interaction-demo.gif)
11
+ | | **TickUp Core (Standard Edition)** | **TickUp Prime (Pro)** |
12
+ | :--- | :--- | :--- |
13
+ | **Rendering** | HTML5 Canvas 2D | WebGL 2.0 |
14
+ | **Live updates** | 1 Hz (1 second) throttling | ~60 FPS pipeline |
15
+ | **History depth** | Up to **2,000** candles | Unlimited (product-dependent) |
16
+ | **Indicators** | Up to **3** overlays | Unlimited |
17
+ | **Advanced UX** | — | Magnetic snapping, VWAP Pro, premium visuals |
18
+ | **License** | MIT (this repo) | Commercial |
12
19
 
13
- ## Feature Highlights
20
+ TickUp **Core** is the MIT **Standard Edition**: a production-quality charting stack for **dashboards**, **internal tools**, and **simple market UIs**. It is intentionally capped so performance stays predictable on typical hardware.
14
21
 
15
- - Canvas 2D rendering optimized for smooth pan/zoom and large data streams.
16
- - Built-in indicators and overlays for practical market analysis workflows.
17
- - RTL-ready chart interfaces for multilingual financial products.
18
- - TypeScript-first API with imperative controls for advanced integrations.
22
+ **Power users** and **trading-grade products** should evaluate **[TickUp Prime](https://github.com/BARDAMRI/tickup-prime)** for WebGL throughput, deep history, and professional interaction tooling. Try it live in the **[Prime Showcase](https://bardamri.github.io/tickup-charts/)**.
19
23
 
20
- ## TickUp Lite (Core) vs TickUp Prime
24
+ ![TickUp Interaction Demo](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/interaction-demo.gif)
21
25
 
22
- | Feature | Standard (MIT) | Prime (Pro) |
23
- | :--- | :--- | :--- |
24
- | Engine | ✅ High-Speed Canvas 2D | 🚀 Ultra-Low Latency Rendering |
25
- | Visuals | ✅ Standard Financial Styles | 💎 Neon Rendering Engine |
26
- | Indicators | ✅ Core Indicator Set | 💎 Advanced Indicators (Fibonacci, Elliott) |
27
- | Localization | ✅ LTR Support | 🚀 Full RTL + Professional i18n Workflows |
28
- | License | ✅ MIT Open Source | 💎 Commercial License |
26
+ ## What you get in Standard Edition
29
27
 
30
- ## Prime Evaluation State
28
+ - Canvas 2D OHLCV charts (candlestick, line, area, bar) with pan, zoom, crosshair, and drawings.
29
+ - TypeScript-first APIs and an imperative ref for live data and snapshots.
30
+ - **Standard Tier guardrails** built into the library: **2,000-bar** series cap, **1 Hz** live-update throttling (unless you use the licensed Prime shell path), and **three** simultaneous overlay indicators—with clear in-app messaging when a limit applies.
31
+ - “**Powered by TickUp**” attribution enforced in Standard layouts (visibility guarded in the host).
31
32
 
32
- When you run the Prime tier without an active license key, TickUp stays fully interactive for evaluation but clearly marks the session:
33
+ ## Why upgrade to Prime?
33
34
 
34
- - An **Evaluation** badge appears in the Prime shell.
35
- - The Prime view keeps a visible evaluation/watermark treatment until a valid key is applied.
35
+ - You need **more than 2,000** bars, **faster** than 1 Hz updates, or **more than three** studies without caps.
36
+ - You want **WebGL**-class density and Prime-only interaction and analysis features.
36
37
 
37
- This makes demos easy while keeping production licensing explicit.
38
+ ## How to upgrade
38
39
 
39
- ## How to Upgrade
40
+ 1. Read the **[TickUp Prime documentation](https://github.com/BARDAMRI/tickup-prime)**.
41
+ 2. Explore the **[Prime Showcase](https://bardamri.github.io/tickup-charts/)**.
42
+ 3. Use the **[Prime repository](https://github.com/BARDAMRI/tickup-prime)** for licensing and integration.
40
43
 
41
- Ready for the Pro/Luxury Prime tier?
44
+ ## Prime evaluation (separate product)
42
45
 
43
- 1. Explore the Prime offering: [TickUp Prime Repository](https://github.com/BARDAMRI/tickup-prime)
44
- 2. Try the live experience: [Prime Showcase](https://bardamri.github.io/tickup-charts/)
45
- 3. Request a commercial license key for production use.
46
+ The **`TickUpPrimeTier`** shell in this package is for **evaluating** the Prime product shape: evaluation chrome when no license key is set. **Standard Tier guardrails** in this open-source core still apply to data throughput and indicator counts unless you run against a fully licensed Prime deployment.
46
47
 
47
48
  ## Pricing & Licensing
48
49
 
@@ -68,11 +69,11 @@ export function App() {
68
69
 
69
70
  ## Documentation
70
71
 
71
- - [Documentation Hub](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/README.md)
72
- - [Quick Start Guide](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/03-quick-start.md)
73
- - [Imperative API Reference](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/06-imperative-api.md)
74
- - [Live Data & Updates](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/07-data-and-live-updates.md)
72
+ - [Documentation hub](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/README.md)
73
+ - [Quick start](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/03-quick-start.md)
74
+ - [Imperative API](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/06-imperative-api.md)
75
+ - [Data & live updates](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/07-data-and-live-updates.md)
75
76
 
76
- ## Prime CTA
77
+ ## TickUp Prime
77
78
 
78
- Interested in TickUp Prime? Visit the live [Showcase](https://bardamri.github.io/tickup-charts/) to test it now, or review the [Prime repository](https://github.com/BARDAMRI/tickup-prime) for integration details.
79
+ Interested in **TickUp Prime**? Start with the **[Prime documentation](https://github.com/BARDAMRI/tickup-prime)** and try the **[Showcase](https://bardamri.github.io/tickup-charts/)**.
@@ -44,6 +44,8 @@ export interface TickUpStageProps {
44
44
  /** Sync with app chart theme for fullscreen modals */
45
45
  themeVariant?: ChartTheme;
46
46
  showBrandWatermark?: boolean;
47
+ /** When true (licensed Prime shell), live interval updates are not 1 Hz–throttled; bar count is still capped in Core. */
48
+ isPrimeLicensed?: boolean;
47
49
  /** Search/validation flow for interval changes (e.g. swap data feed). */
48
50
  onIntervalSearch?: (tf: string) => void | boolean | Promise<void | boolean>;
49
51
  }
@@ -5,11 +5,19 @@ type VisibleRangeInput = TimeRange & Partial<{
5
5
  startIndex: number;
6
6
  endIndex: number;
7
7
  }>;
8
+ export declare const MAX_CORE_CANDLES = 2000;
9
+ export declare const CORE_TICK_THROTTLE_MS = 1000;
10
+ /**
11
+ * Standard Tier guardrail: never keep more than MAX_CORE_CANDLES for render or downstream math.
12
+ * Call sites should use this for every ingest path (props, live merge, history refresh).
13
+ */
14
+ export declare function clampIntervalsToStandardTier(intervals: Interval[]): Interval[];
8
15
  export declare function useChartData(intervalsArray: Interval[], visibleRange: VisibleRangeInput, currentPoint: {
9
16
  x: number;
10
17
  y: number;
11
18
  } | null, canvasWidth: number, canvasHeight: number): {
12
19
  renderContext: ChartRenderContext | null;
13
20
  intervalSeconds: number;
21
+ effectiveIntervals: Interval[];
14
22
  };
15
23
  export {};