tickup 1.0.35 → 1.0.37

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
@@ -12,12 +12,12 @@
12
12
  | :--- | :--- | :--- |
13
13
  | **Rendering** | HTML5 Canvas 2D | WebGL 2.0 |
14
14
  | **Live updates** | 1 Hz (1 second) throttling | ~60 FPS pipeline |
15
- | **History depth** | Up to **2,000** candles | Unlimited (product-dependent) |
15
+ | **History depth** | Up to **5,000** candles (generous Standard cap) | Unlimited (product-dependent) |
16
16
  | **Indicators** | Up to **3** overlays | Unlimited |
17
17
  | **Advanced UX** | — | Magnetic snapping, VWAP Pro, premium visuals |
18
18
  | **License** | MIT (this repo) | Commercial |
19
19
 
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.
20
+ 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.
21
21
 
22
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/)**.
23
23
 
@@ -27,12 +27,12 @@ TickUp **Core** is the MIT **Standard Edition**: a production-quality charting s
27
27
 
28
28
  - Canvas 2D OHLCV charts (candlestick, line, area, bar) with pan, zoom, crosshair, and drawings.
29
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.
30
+ - **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.
31
31
  - “**Powered by TickUp**” attribution enforced in Standard layouts (visibility guarded in the host).
32
32
 
33
33
  ## Why upgrade to Prime?
34
34
 
35
- - You need **more than 2,000** bars, **faster** than 1 Hz updates, or **more than three** studies without caps.
35
+ - You need **more than 5,000** bars, **faster** than 1 Hz updates, or **more than three** studies without caps.
36
36
  - You want **WebGL**-class density and Prime-only interaction and analysis features.
37
37
 
38
38
  ## How to upgrade
@@ -43,7 +43,7 @@ TickUp **Core** is the MIT **Standard Edition**: a production-quality charting s
43
43
 
44
44
  ## Prime evaluation (separate product)
45
45
 
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
+ 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.
47
47
 
48
48
  ## Pricing & Licensing
49
49
 
@@ -69,11 +69,31 @@ export function App() {
69
69
 
70
70
  ## Documentation
71
71
 
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)
72
+ - **[Getting started — Grand Tour](./documentation/00-getting-started.md)** — Install from scratch + copy-paste Hello World (no prior charting experience assumed).
73
+ - **[Documentation hub](./documentation/README.md)** — Full index (guides 00–18).
74
+ - **[API reference](./documentation/16-api-reference.md)** — `TickUpHost` props, `TickUpRenderEngine`, and `chartOptions` tables.
75
+ - **[OHLC schema & debugging](./documentation/17-interval-schema-and-debugging.md)** — Data format and common “chart not showing” fixes.
76
+ - **[Comparison showcase](./documentation/18-comparison-showcase.md)** — **`#/compare`** to audit Core vs Prime before choosing a tier.
77
+ - [Quick start](./documentation/03-quick-start.md) · [Imperative API](./documentation/06-imperative-api.md) · [Data & live updates](./documentation/07-data-and-live-updates.md)
76
78
 
77
79
  ## TickUp Prime
78
80
 
79
81
  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/)**.
82
+
83
+ ## Legacy support
84
+
85
+ **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.
86
+
87
+ **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.
88
+
89
+ **Deprecate older releases on npm** (run while logged in as a maintainer; repeats are safe):
90
+
91
+ ```bash
92
+ npm deprecate tickup@"< 1.0.36" "Legacy architecture. Please upgrade to v1.0.36+ for stable Core/Prime separation and security patches."
93
+ ```
94
+
95
+ Optional: confirm what npm will match:
96
+
97
+ ```bash
98
+ npm view tickup versions --json
99
+ ```
@@ -5,7 +5,7 @@ type VisibleRangeInput = TimeRange & Partial<{
5
5
  startIndex: number;
6
6
  endIndex: number;
7
7
  }>;
8
- export declare const MAX_CORE_CANDLES = 2000;
8
+ export declare const MAX_CORE_CANDLES = 5000;
9
9
  export declare const CORE_TICK_THROTTLE_MS = 1000;
10
10
  /**
11
11
  * Standard Tier guardrail: never keep more than MAX_CORE_CANDLES for render or downstream math.