tickup 1.0.34 → 1.0.37

package/README.md

@@ -6,43 +6,44 @@
 [![License](https://img.shields.io/badge/license-MIT-yellow.svg)](https://github.com/BARDAMRI/tickup-charts/blob/main/LICENSE)
 [![Bundle Size](https://img.shields.io/bundlephobia/minzip/tickup)](https://bundlephobia.com/package/tickup)
 
-High-performance, canvas-based financial charting engine for React.
+## Standard Edition vs TickUp Prime (Pro)
 
-![TickUp Interaction Demo](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/interaction-demo.gif)
+| | **TickUp Core (Standard Edition)** | **TickUp Prime (Pro)** |
+| :--- | :--- | :--- |
+| **Rendering** | HTML5 Canvas 2D | WebGL 2.0 |
+| **Live updates** | 1 Hz (1 second) throttling | ~60 FPS pipeline |
+| **History depth** | Up to **5,000** candles (generous Standard cap) | Unlimited (product-dependent) |
+| **Indicators** | Up to **3** overlays | Unlimited |
+| **Advanced UX** | — | Magnetic snapping, VWAP Pro, premium visuals |
+| **License** | MIT (this repo) | Commercial |
 
-## Feature Highlights
+TickUp **Core** is the MIT **Standard Edition**: a production-quality charting stack for **dashboards**, **internal tools**, and **simple market UIs**. It uses a **generous but limited** history window (currently **5,000** candles) so performance stays predictable while Prime remains the path for boundless scale.
 
-- Canvas 2D rendering optimized for smooth pan/zoom and large data streams.
-- Built-in indicators and overlays for practical market analysis workflows.
-- RTL-ready chart interfaces for multilingual financial products.
-- TypeScript-first API with imperative controls for advanced integrations.
+**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/)**.
 
-## TickUp Lite (Core) vs TickUp Prime
+![TickUp Interaction Demo](https://raw.githubusercontent.com/BARDAMRI/tickup-charts/main/assets/showcase/interaction-demo.gif)
 
-| Feature | Standard (MIT) | Prime (Pro) |
-| :--- | :--- | :--- |
-| Engine | ✅ High-Speed Canvas 2D | 🚀 Ultra-Low Latency Rendering |
-| Visuals | ✅ Standard Financial Styles | 💎 Neon Rendering Engine |
-| Indicators | ✅ Core Indicator Set | 💎 Advanced Indicators (Fibonacci, Elliott) |
-| Localization | ✅ LTR Support | 🚀 Full RTL + Professional i18n Workflows |
-| License | ✅ MIT Open Source | 💎 Commercial License |
+## What you get in Standard Edition
 
-## Prime Evaluation State
+- Canvas 2D OHLCV charts (candlestick, line, area, bar) with pan, zoom, crosshair, and drawings.
+- TypeScript-first APIs and an imperative ref for live data and snapshots.
+- **Standard Tier guardrails** built into the library: **5,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.
+- “**Powered by TickUp**” attribution enforced in Standard layouts (visibility guarded in the host).
 
-When you run the Prime tier without an active license key, TickUp stays fully interactive for evaluation but clearly marks the session:
+## Why upgrade to Prime?
 
-- An **Evaluation** badge appears in the Prime shell.
-- The Prime view keeps a visible evaluation/watermark treatment until a valid key is applied.
+- You need **more than 5,000** bars, **faster** than 1 Hz updates, or **more than three** studies without caps.
+- You want **WebGL**-class density and Prime-only interaction and analysis features.
 
-This makes demos easy while keeping production licensing explicit.
+## How to upgrade
 
-## How to Upgrade
+1. Read the **[TickUp Prime documentation](https://github.com/BARDAMRI/tickup-prime)**.
+2. Explore the **[Prime Showcase](https://bardamri.github.io/tickup-charts/)**.
+3. Use the **[Prime repository](https://github.com/BARDAMRI/tickup-prime)** for licensing and integration.
 
-Ready for the Pro/Luxury Prime tier?
+## Prime evaluation (separate product)
 
-1. Explore the Prime offering: [TickUp Prime Repository](https://github.com/BARDAMRI/tickup-prime)
-2. Try the live experience: [Prime Showcase](https://bardamri.github.io/tickup-charts/)
-3. Request a commercial license key for production use.
+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 (including the **5,000**-candle cap) still apply to data throughput and indicator counts unless you run against a fully licensed Prime deployment.
 
 ## Pricing & Licensing
 
@@ -68,11 +69,31 @@ export function App() {
 
 ## Documentation
 
-- [Documentation Hub](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/README.md)
-- [Quick Start Guide](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/03-quick-start.md)
-- [Imperative API Reference](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/06-imperative-api.md)
-- [Live Data & Updates](https://github.com/BARDAMRI/tickup-charts/blob/main/documentation/07-data-and-live-updates.md)
+- **[Getting started — Grand Tour](./documentation/00-getting-started.md)** — Install from scratch + copy-paste Hello World (no prior charting experience assumed).
+- **[Documentation hub](./documentation/README.md)** — Full index (guides 00–18).
+- **[API reference](./documentation/16-api-reference.md)** — `TickUpHost` props, `TickUpRenderEngine`, and `chartOptions` tables.
+- **[OHLC schema & debugging](./documentation/17-interval-schema-and-debugging.md)** — Data format and common “chart not showing” fixes.
+- **[Comparison showcase](./documentation/18-comparison-showcase.md)** — **`#/compare`** to audit Core vs Prime before choosing a tier.
+- [Quick start](./documentation/03-quick-start.md) · [Imperative API](./documentation/06-imperative-api.md) · [Data & live updates](./documentation/07-data-and-live-updates.md)
+
+## TickUp Prime
+
+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/)**.
+
+## Legacy support
+
+**npm versions below `1.0.36` are deprecated and unsupported.** That line predates the current **Generous Standard** architecture (clean **TickUp Core** vs **Prime** separation, documented Standard Tier guardrails, and security fixes). Do not build new integrations on older tarballs.
 
-## Prime CTA
+**Standard Tier stability:** From **1.0.36** onward, the **5,000-bar** history cap and the **~1 Hz** live-update throttle on Standard shells are **mandatory** parts of the supported Standard Tier model—they keep dashboards predictable and are not optional “suggestions” for production use.
 
-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.
+**Deprecate older releases on npm** (run while logged in as a maintainer; repeats are safe):
+
+```bash
+npm deprecate tickup@"< 1.0.36" "Legacy architecture. Please upgrade to v1.0.36+ for stable Core/Prime separation and security patches."
+```
+
+Optional: confirm what npm will match:
+
+```bash
+npm view tickup versions --json
+```

package/dist/components/Canvas/ChartCanvas.d.ts

@@ -22,8 +22,6 @@ interface ChartCanvasProps {
     windowSpread: WindowSpreadOptions;
     /** Draw bundled TickUp marks inside plot / histogram (no DOM footer). */
     showBrandWatermark?: boolean;
-    /** Prime-licensed sessions bypass source-level history limits. */
-    isPrimeLicensed?: boolean;
     /** Matches chart `base.theme` for choosing light / dark / grey mark artwork. */
     brandTheme?: ChartTheme;
 }

package/dist/components/Canvas/TickUpStage.d.ts

@@ -44,7 +44,7 @@ export interface TickUpStageProps {
     /** Sync with app chart theme for fullscreen modals */
     themeVariant?: ChartTheme;
     showBrandWatermark?: boolean;
-    /** Prime-licensed sessions bypass core throttles/limits. */
+    /** When true (licensed Prime shell), live interval updates are not 1 Hz–throttled; bar count is still capped in Core. */
     isPrimeLicensed?: boolean;
     /** Search/validation flow for interval changes (e.g. swap data feed). */
     onIntervalSearch?: (tf: string) => void | boolean | Promise<void | boolean>;

package/dist/hooks/useChartData.d.ts

@@ -5,13 +5,19 @@ type VisibleRangeInput = TimeRange & Partial<{
     startIndex: number;
     endIndex: number;
 }>;
-export declare const MAX_CORE_CANDLES = 2000;
+export declare const MAX_CORE_CANDLES = 5000;
 export declare const CORE_TICK_THROTTLE_MS = 1000;
-export declare function useChartData(intervalsArray: Interval[], isPrimeLicensed: boolean, visibleRange: VisibleRangeInput, currentPoint: {
+/**
+ * Standard Tier guardrail: never keep more than MAX_CORE_CANDLES for render or downstream math.
+ * Call sites should use this for every ingest path (props, live merge, history refresh).
+ */
+export declare function clampIntervalsToStandardTier(intervals: Interval[]): Interval[];
+export declare function useChartData(intervalsArray: Interval[], visibleRange: VisibleRangeInput, currentPoint: {
     x: number;
     y: number;
 } | null, canvasWidth: number, canvasHeight: number): {
     renderContext: ChartRenderContext | null;
     intervalSeconds: number;
+    effectiveIntervals: Interval[];
 };
 export {};