@lacspace/indicators 1.0.0 → 1.0.2

package/LICENSE

@@ -1,21 +1,51 @@
-MIT License
+Lacspace Free Licence
+Version 1.0, August 2026
 
 Copyright (c) 2026 Lacspace
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+PREAMBLE
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+This software is published by Lacspace under the Lacspace Free Licence — a free,
+permissive licence that lets you use this software for any purpose, including in
+commercial products and services, at no cost. It grants the same freedoms as
+common permissive open-source licences; the only condition is that this notice
+travels with the software. The canonical, always-current text of this licence is
+maintained at https://lacspace.com/licenses/lacspace-free-1.0
+
+GRANT OF RIGHTS
+
+Permission is hereby granted, free of charge, to any person or organisation
+obtaining a copy of this software and its associated documentation and data files
+(the "Software"), to deal in the Software without restriction, including without
+limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the conditions below. These rights are
+granted for any purpose, personal or commercial, and are perpetual, worldwide,
+non-exclusive, and royalty-free.
+
+CONDITIONS
+
+The above copyright notice, this permission notice, and the name of this licence
+("Lacspace Free Licence") shall be included in all copies or substantial portions
+of the Software.
+
+TRADEMARKS
+
+This licence does not grant permission to use the trade names, trademarks, service
+marks, logos, or product names of Lacspace, except as required to reproduce the
+notice above or to describe the origin of the Software in a truthful manner.
+
+DISCLAIMER OF WARRANTY AND LIMITATION OF LIABILITY
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN
+AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+The Lacspace Free Licence is a source-available, permissive licence and is not (as
+of this version) an OSI-approved licence. In substance it grants the same freedoms
+as the MIT Licence. Learn more at https://lacspace.com/licenses

package/README.md

@@ -0,0 +1,106 @@
+<div align="center">
+
+# @lacspace/indicators
+
+**Streaming technical indicators for live price feeds — push one tick, get the new value in O(1).**
+
+[![npm version](https://img.shields.io/npm/v/@lacspace/indicators?color=%2316a34a&label=npm)](https://www.npmjs.com/package/@lacspace/indicators)
+[![install size](https://packagephobia.com/badge?p=@lacspace/indicators)](https://packagephobia.com/result?p=@lacspace/indicators)
+[![minzipped](https://img.shields.io/bundlephobia/minzip/@lacspace/indicators?label=minzip)](https://bundlephobia.com/package/@lacspace/indicators)
+[![types](https://img.shields.io/badge/types-included-blue)](https://www.npmjs.com/package/@lacspace/indicators)
+[![license](https://img.shields.io/npm/l/@lacspace/indicators?color=green)](https://github.com/lacspace/npm-packages/blob/main/LICENSE)
+
+</div>
+
+> Most JS indicator libs recompute the entire array on every new candle. This one updates **incrementally** — feed a single live LTP tick and the indicator advances in O(1). Built for real-time charts, screeners and algo bots.
+
+- 📈 **RSI, MACD, SMA, EMA, WMA, Bollinger, ATR, VWAP, Stochastic, Supertrend, ADX**
+- ⚡ Incremental `next(tick)` API — perfect for websocket / LTP streams
+- 🧮 Batch helpers too — run over a historical array in one call
+- ✂️ `crossedAbove` / `crossedBelow` for signal logic
+- 🌍 Isomorphic (browser + Node) · 📦 ESM + CJS · 🧩 zero dependencies · fully typed
+
+## Install
+
+```bash
+npm install @lacspace/indicators      # or pnpm add / yarn add / bun add
+```
+
+## Streaming — the whole point
+
+```ts
+import { RSI, MACD } from "@lacspace/indicators";
+
+const rsi = new RSI(14);
+const macd = new MACD(12, 26, 9);
+
+// wire straight into your tick feed
+socket.on("ltp", (price) => {
+  const r = rsi.next(price);       // O(1) — no array recompute
+  const m = macd.next(price);
+  if (r !== null && r > 70) console.log("overbought", r.toFixed(1));
+  if (m) console.log("histogram", m.histogram.toFixed(2));
+});
+```
+
+Every indicator returns `null` during its warm-up window, then a number (or a struct), and also exposes `.value`.
+
+## Batch over history
+
+```ts
+import { rsi, ema, bollinger, supertrend } from "@lacspace/indicators";
+
+const closes = candles.map((c) => c.close);
+
+rsi(closes, 14);          // (number | null)[]
+ema(closes, 20);          // (number | null)[]
+bollinger(closes, 20, 2); // ({ middle, upper, lower, bandwidth } | null)[]
+
+// range-based indicators take OHLC bars
+supertrend(candles, 10, 3); // ({ value, direction: 1 | -1 } | null)[]
+```
+
+## Signals with crossovers
+
+```ts
+import { ema, crossedAbove } from "@lacspace/indicators";
+
+const fast = ema(closes, 9);
+const slow = ema(closes, 21);
+
+for (let i = 1; i < closes.length; i++) {
+  if (fast[i - 1] == null || slow[i - 1] == null) continue;
+  const golden = crossedAbove(
+    { a: fast[i - 1]!, b: slow[i - 1]! },
+    { a: fast[i]!, b: slow[i]! },
+  );
+  if (golden) console.log("EMA golden cross at bar", i);
+}
+```
+
+## Indicators
+
+| Class / fn | Input | Output |
+| --- | --- | --- |
+| `SMA` `EMA` `WMA` | price | number |
+| `RSI` | price | 0–100 |
+| `MACD` | price | `{ macd, signal, histogram }` |
+| `BollingerBands` | price | `{ middle, upper, lower, bandwidth }` |
+| `ATR` | HLC bar | number |
+| `VWAP` | H/L/C/volume bar | number |
+| `Stochastic` | HLC bar | `{ k, d }` |
+| `Supertrend` | HLC bar | `{ value, direction }` |
+| `ADX` | HLC bar | `{ adx, plusDI, minusDI }` |
+
+Batch equivalents: `sma` `ema` `wma` `rsi` `macd` `bollinger` `atr` `supertrend` `adx`.
+
+## The Lacspace StockKit
+
+| Package | For |
+| --- | --- |
+| **`@lacspace/indicators`** | Technical indicators (this package) |
+| [`@lacspace/market`](https://www.npmjs.com/package/@lacspace/market) | P&L, XIRR, brokerage & charges |
+| [`@lacspace/market-clock`](https://www.npmjs.com/package/@lacspace/market-clock) | Is the market open? holidays |
+| [`@lacspace/paper-trade`](https://www.npmjs.com/package/@lacspace/paper-trade) | Headless paper-trading engine |
+
+<div align="center"><sub>Built with care by <a href="https://lacspace.com">Lacspace</a> · powers <a href="https://stockyatra.com">StockYatra</a> · Lacspace Free Licence · <a href="https://github.com/lacspace/npm-packages">source</a></sub></div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lacspace/indicators",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Streaming technical indicators (RSI, MACD, EMA, Bollinger, ATR, Supertrend, ADX, VWAP) with O(1) incremental updates for live price feeds. Zero-dependency.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -42,7 +42,7 @@
     "typescript"
   ],
   "author": "Lacspace <contact@lacspace.com>",
-  "license": "MIT",
+  "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://lacspace.com/packages",
   "repository": {
     "type": "git",