@lacspace/patterns 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,51 @@
+Lacspace Free Licence
+Version 1.0, August 2026
+
+Copyright (c) 2026 Lacspace
+
+PREAMBLE
+
+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.
+
+---
+
+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

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# @lacspace/patterns
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Rule-based chart-pattern detection on OHLCV bars, with no AI. Every detector works from **ATR-sized swings**, so the same settings suit a 5-minute chart and a weekly one. Results come back drawing-ready (`paths`, `zones`, `profiles`, using bar indices and prices) and as plain data (`hits`, `found`).
+
+The patterns describe geometry already on the chart; they are not forecasts or advice. An Elliott count in particular is subjective: this shows one count that obeys the rules.
+
+```ts
+import { swings, chartPatterns, harmonics, elliott, tpoProfiles } from "@lacspace/patterns";
+
+// bars: { time (unix seconds), open, high, low, close, volume }[]
+swings(bars, 2);                // { piv: [{ i, p, hi }], tail, atr }: zigzag confirmed at k × ATR(14)
+chartPatterns(bars).found;      // ["Double bottom", "Double bottom", "Range (rectangle)"]
+harmonics(bars).hits;           // [{ name: "Gartley", bull, pts: [X,A,B,C,D], forming }]
+elliott(bars).paths;            // labelled impulse (0)…(5), then (a)(b)(c); wave-5 target zone
+tpoProfiles(bars, 24, 5);       // market profile per session: rows with letters, POC, 70% value area, initial balance
+```
+
+| Function | Finds |
+|---|---|
+| `swings(bars, k = 2)` | Alternating swing highs and lows, confirmed once price moves `k × ATR(14)`. The still-forming extreme is returned as `tail`. |
+| `harmonics(bars, k, tolPct = 6, show = 3)` | Gartley, Bat, Alt Bat, Butterfly, Crab, Deep Crab, Cypher and AB=CD. A pattern still waiting for D gets a potential-reversal **D zone**. |
+| `elliott(bars, k)` | The latest five-wave impulse obeying the three hard rules (wave 2 doesn't retrace past wave 1's start, wave 3 isn't the shortest, wave 4 doesn't overlap wave 1), then a-b-c. A wave-5 target zone is added when waves 1–4 are in place. |
+| `chartPatterns(bars, k = 1.5, look = 200, …, show = 2)` | Double tops and bottoms, head & shoulders (and inverse) with necklines, confirmation and measured moves. Also the latest structure: ascending, descending or symmetrical triangle, rising or falling wedge, range, rising or falling channel, or broadening formation. |
+| `tpoProfiles(bars, rows, sessions)` | TPO market profile per session: 30-minute letters (hourly letters on hourly bars), POC, value area, initial balance. |
+| `sessionVolumeProfiles(bars, rows, sessions)` | Volume-by-price per session, with up and down volume, POC and value area. |
+| `kagi(bars, rev)`, `pointFigure(bars, box, rev = 3)` | Time-independent chart transforms. They return ordinary bars plus the shape data. |
+
+Sessions are split by UTC calendar day. That fits exchanges whose trading day doesn't cross UTC midnight; NEPSE's 11:00–15:00 NPT is 05:15–09:15 UTC. Colours are optional trailing parameters.
+
+Watch out for unadjusted corporate-action gaps (bonus or rights issues) in the input. The detectors treat them as real price moves, so adjust your candles first (for example with `@lacspace/market`).
+
+Contributed by the ShareRocketPro team from their production chart. The tests pin its behaviour on a real NABIL 15-minute snapshot.
+
+## Licence
+[Lacspace Free Licence v1.0](https://developer.lacspace.com/licenses/lacspace-free-1.0): free for personal and commercial use.