oakscriptjs 0.1.6 → 0.1.7

package/README.md

@@ -1,271 +1,61 @@
-# OakScriptJS
+<p align="center">
+  <img src="./logo.png" alt="OakScriptJS Logo" width="150">
+</p>
 
-**PineScript v6 compatible technical analysis library for JavaScript/TypeScript**
+<h1 align="center">OakScriptJS</h1>
 
-OakScriptJS provides the computational core of PineScript's API. It focuses on **calculations and data transformations** with a clean Series-based approach.
+OakScriptJS is a TypeScript/JavaScript library that provides PineScript v6 compatible technical analysis functions. Build trading indicators, run backtests, or integrate TA calculations into any JavaScript environment.
 
-## Core Features
-
-- **Series Class**: Lazy evaluation with operator chaining
-- **BarData**: Versioned wrapper for automatic cache invalidation
-- **Core Functions**: Pure array-based calculations (`taCore.*`)
-- **TA-Series Wrappers**: Series-based technical analysis functions (`ta.*`)
-- **Type Safety**: Full TypeScript support with type definitions
-
-## Scope
-
-**This library includes:**
-- Technical Analysis (`ta.*`, `taCore.*`) - All indicators and calculations
-- Mathematics (`math.*`) - All mathematical operations
-- Arrays (`array.*`) - Array manipulation and operations
-- Matrices (`matrix.*`) - Matrix operations
-- Strings (`str.*`) - String manipulation
-- Time (`time.*`) - Time calculations and conversions
-- Color (`color.*`) - Color data structures and manipulation
-- Drawing Objects (`line.*`, `box.*`, `label.*`, `linefill.*`) - Computational features only
-- Series Class - Lazy evaluation with operator chaining
-
-**This library does NOT include:**
-- UI/Input functions (`input.*`) - Application responsibility
-- Strategy execution (`strategy.*`) - Strategy engine responsibility
-- Data fetching (`request.*`) - Data provider responsibility
-- Alert systems (`alert.*`, `alertcondition.*`) - Application responsibility
+## Quick Start
 
-## Installation
+### Install
 
 ```bash
 npm install oakscriptjs
 ```
 
-## Quick Start
-
-### Array-based Calculations
-
-```typescript
-import { taCore } from 'oakscriptjs';
-
-const prices = [100, 102, 101, 103, 105];
-const sma = taCore.sma(prices, 3);
-const rsi = taCore.rsi(prices, 14);
-```
-
-### Series-based Calculations
+### Calculate an indicator
 
 ```typescript
 import { Series, ta } from 'oakscriptjs';
 
-const bars = [
-  { time: '2024-01-01', open: 100, high: 105, low: 99, close: 103 },
-  { time: '2024-01-02', open: 103, high: 107, low: 102, close: 106 }
-];
-
-const close = new Series(bars, (bar) => bar.close);
-const rsi = ta.rsi(close, 14);
+const prices = [44, 44.5, 45, 45.5, 46, 46.5, 47, 47.5, 48, 48.5];
+const close = new Series(prices);
+const sma = ta.sma(close, 5);
 
-console.log(rsi.toArray());
+console.log(sma.toArray());
 ```
 
-### BarData for Automatic Cache Invalidation
-
-```typescript
-import { BarData, Series, ta } from 'oakscriptjs';
-
-// Create BarData wrapper
-const barData = new BarData(bars);
-const close = Series.fromBars(barData, 'close');
-const sma = ta.sma(close, 20);
-
-const values1 = sma.toArray(); // Computes and caches
-
-// Add new bar - version increments
-barData.push({ time: '2024-01-03', open: 106, high: 108, low: 105, close: 107 });
-
-const values2 = sma.toArray(); // Detects change, recomputes
-```
-
-### Memory-Efficient Closure Breaking
-
-```typescript
-import { Series } from 'oakscriptjs';
-
-// Complex expression creates closure chain
-const complex = a.add(b).mul(c).div(d).sub(e);
-
-// Break closure chain to free memory
-const materialized = complex.materialize();
-```
-
-## Supported Namespaces
-
-### Technical Analysis (`ta` and `taCore`)
-
-Complete implementation of PineScript's technical analysis functions:
-
-```typescript
-// Core (array-based)
-import { taCore } from 'oakscriptjs';
-taCore.sma(prices, 20)
-taCore.ema(prices, 20)
-taCore.rsi(prices, 14)
-
-// Series (Series-based)
-import { ta } from 'oakscriptjs';
-ta.sma(closeSeries, 20)
-ta.ema(closeSeries, 20)
-ta.rsi(closeSeries, 14)
-```
-
-- **Moving Averages**: `sma()`, `ema()`, `wma()`, `vwma()`, `swma()`, etc.
-- **Oscillators**: `rsi()`, `stoch()`, `cci()`, `macd()`, `mfi()`, etc.
-- **Volatility**: `bb()`, `atr()`, `stdev()`, `variance()`, etc.
-- **Momentum**: `mom()`, `roc()`, `percentrank()`, etc.
-- **Regression**: `linreg()`, `correlation()`, etc.
-- **Crossovers**: `crossover()`, `crossunder()`, `cross()`
-
-### Math (`math`)
-
-```typescript
-math.abs(x), math.ceil(x), math.floor(x), math.round(x)
-math.min(...values), math.max(...values), math.avg(...values)
-math.sqrt(x), math.pow(x, y), math.exp(x), math.log(x)
-math.sin(x), math.cos(x), math.tan(x)
-```
-
-### Array (`array`)
-
-```typescript
-array.new_float(size, initial)
-array.push(arr, value)
-array.get(arr, index)
-array.sum(arr), array.avg(arr), array.sort(arr)
-```
-
-### Series Class
-
-```typescript
-class Series {
-  // Constructor
-  constructor(data: Bar[] | BarData, extractor: SeriesExtractor)
-
-  // Properties
-  get bars(): Bar[]
-  get barData(): BarData
-
-  // Arithmetic
-  add(other: Series | number): Series
-  sub(other: Series | number): Series
-  mul(other: Series | number): Series
-  div(other: Series | number): Series
-
-  // Comparison
-  gt(other: Series | number): Series
-  lt(other: Series | number): Series
-
-  // Logical
-  and(other: Series | number): Series
-  or(other: Series | number): Series
-
-  // Access
-  toArray(): number[]
-  last(): number
-  offset(n: number): Series  // Like close[1]
-
-  // Memory management
-  materialize(): Series  // Break closure chains
-}
-```
-
-### BarData Class
-
-```typescript
-class BarData {
-  constructor(bars: Bar[])
-  
-  get version(): number
-  get bars(): Bar[]
-  get length(): number
-  
-  push(bar: Bar): void
-  pop(): Bar | undefined
-  set(index: number, bar: Bar): void
-  updateLast(bar: Bar): void
-  setAll(bars: Bar[]): void
-  invalidate(): void
-}
-```
-
-### Drawing Objects
-
-- **Line (`line`)**: `new()`, `get_price()`, getters/setters
-- **Box (`box`)**: `new()`, getters/setters for gap detection
-- **Label (`label`)**: `new()`, getters/setters
-- **Linefill (`linefill`)**: `new()`, `set_color()`
-
-## Examples
-
-```typescript
-// Example 1: Simple Moving Average
-import {Series, ta, type IndicatorResult} from 'oakscriptjs';
-
-export function smaIndicator(bars: any[]): IndicatorResult {
-  const close = new Series(bars, (bar) => bar.close);
-  const sma20 = ta.sma(close, 20);
+## Documentation
 
-  return {
-    metadata: { title: "SMA 20", overlay: true },
-    plots: [{
-      data: sma20.toArray().map((v, i) => ({ time: bars[i].time, value: v })),
-      options: { color: '#2196F3', linewidth: 2 }
-    }]
-  };
-}
+- [Guide](./docs/guide.md) — Getting started and core concepts
+- [Function Inventory](./docs/inventory.md) — All available TA functions
 
-// Example 2: RSI
-export function rsiIndicator(bars: any[]): IndicatorResult {
-  const close = new Series(bars, (bar) => bar.close);
-  const rsi = ta.rsi(close, 14);
+## Development
 
-  return {
-    metadata: { title: "RSI", overlay: false },
-    plots: [{
-      data: rsi.toArray().map((v, i) => ({ time: bars[i].time, value: v })),
-      options: { color: '#FF5722', linewidth: 2 }
-    }],
-    hlines: [
-      { value: 70, options: { color: '#FF0000' } },
-      { value: 30, options: { color: '#00FF00' } }
-    ]
-  };
-}
-```
+### Prerequisites
 
-## Development
+- Node.js >= 18.0.0
 
 ### Setup
 
 ```bash
-npm install
+npm install     # Install dependencies
+npm run build   # Build
+npm test        # Run tests
+npm run typecheck  # Type check
 ```
 
-### Build
+## Project Structure
 
-```bash
-npm run build
 ```
-
-### Test
-
-```bash
-npm test
-npm run test:watch
-npm run test:coverage
+oakscriptJS/
+├── src/        # Source code
+├── tests/      # Test suite
+├── dist/       # Build output
+└── docs/       # Documentation
 ```
 
-## Documentation
-
-- **[Complete Guide](../../docs/guide.md)** - User guide and examples
-- **[Function Inventory](../../docs/inventory.md)** - Complete function list with status
-
-## Acknowledgments
+---
 
-This library is inspired by TradingView's PineScript language. It is not affiliated with or endorsed by TradingView.
+Maintained by [DeepEntropy](https://github.com/deepentropy)

package/dist/index.d.ts

@@ -22,13 +22,15 @@ export type { PlotOptions, HLineOptions, FillOptions, InputMetadata, PlotMetadat
 export { sma, ema, rsi, macd, bb, stdev, crossover, crossunder, change, tr, atr, cum, vwap } from './ta-series';
 export { abs, ceil, floor, round, max, min, avg, sum, sqrt, pow, exp, log, sin, cos, tan } from './math';
 export { rgb, from_hex as color_from_hex, new_color } from './color';
-export { ohlcFromBars, getClose, getHigh, getLow, getOpen } from './utils';
+export { ohlcFromBars, getClose, getHigh, getLow, getOpen, getSourceSeries } from './utils';
+export * from './lib';
+export { isNA as na, nz } from './utils';
 export { indicator, type IndicatorMetadataConfig, type InputDefinition, type IndicatorContext, type IndicatorInstance, type IndicatorConstructor, } from './indicator';
 export { input, type InputValue, type IntInputOptions, type FloatInputOptions, type SourceInputOptions, type BoolInputOptions, type StringInputOptions, type SourceType, } from './input';
 export { plot as plotHelper, createPlot, type Time, type TimeValuePair, type PlotOptions as PlotHelperOptions, type PlotResult, } from './plot';
 export { setContext, clearContext, getContext, registerCalculate, recalculate, plot, hline, clearPlots, } from './runtime/runtime';
 export { input_int, input_float, input_bool, input_string, input_source, } from './runtime/inputs';
-export type { OakScriptContext, ChartAdapter, InputAdapter, SeriesHandle, SeriesOptions, InputConfig, InputOptions, OhlcvData, } from './runtime/types';
+export type { OakScriptContext, ChartAdapter, InputAdapter, SeriesHandle, SeriesOptions, InputConfig, InputOptions, OhlcvData, PlotConfig, HLineConfig, FillConfig, } from './runtime/types';
 export { LightweightChartsAdapter } from './runtime/adapters/LightweightChartsAdapter';
 export { SimpleInputAdapter } from './runtime/adapters/SimpleInputAdapter';
 export declare const VERSION = "0.3.0";
@@ -51,4 +53,5 @@ export declare const info: {
         indicator: string[];
     };
 };
+export declare function alertcondition(_condition: unknown, _title?: string, _message?: string): void;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgBA,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AAGjC,OAAO,KAAK,MAAM,MAAM,MAAM,CAAC;AAC/B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;AAG3G,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACnD,YAAY,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGxD,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,EAAE,EAAE,CAAC;AAGd,YAAY,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,WAAW,EACX,SAAS,EACV,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAChH,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AACzG,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,cAAc,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAGrE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAG3E,OAAO,EACL,SAAS,EACT,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,KAAK,EACL,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,UAAU,GAChB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,IAAI,IAAI,UAAU,EAClB,UAAU,EACV,KAAK,IAAI,EACT,KAAK,aAAa,EAClB,KAAK,WAAW,IAAI,iBAAiB,EACrC,KAAK,UAAU,GAChB,MAAM,QAAQ,CAAC;AAGhB,OAAO,EACL,UAAU,EACV,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,IAAI,EACJ,KAAK,EACL,UAAU,GACX,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,SAAS,EACT,WAAW,EACX,UAAU,EACV,YAAY,EACZ,YAAY,GACb,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,WAAW,EACX,YAAY,EACZ,SAAS,GACV,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,wBAAwB,EAAE,MAAM,6CAA6C,CAAC;AACvF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAG3E,eAAO,MAAM,OAAO,UAAU,CAAC;AAK/B,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;CAkBhB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgBA,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AAGjC,OAAO,KAAK,MAAM,MAAM,MAAM,CAAC;AAC/B,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;AAG3G,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACnD,YAAY,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGxD,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,EAAE,EAAE,CAAC;AAGd,YAAY,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACT,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,WAAW,EACX,SAAS,EACV,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAChH,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AACzG,OAAO,EAAE,GAAG,EAAE,QAAQ,IAAI,cAAc,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAGrE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG5F,cAAc,OAAO,CAAC;AAGtB,OAAO,EAAC,IAAI,IAAI,EAAE,EAAE,EAAE,EAAC,MAAM,SAAS,CAAC;AAGvC,OAAO,EACL,SAAS,EACT,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,GAC1B,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,KAAK,EACL,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,UAAU,GAChB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,IAAI,IAAI,UAAU,EAClB,UAAU,EACV,KAAK,IAAI,EACT,KAAK,aAAa,EAClB,KAAK,WAAW,IAAI,iBAAiB,EACrC,KAAK,UAAU,GAChB,MAAM,QAAQ,CAAC;AAGhB,OAAO,EACL,UAAU,EACV,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,WAAW,EACX,IAAI,EACJ,KAAK,EACL,UAAU,GACX,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EACL,SAAS,EACT,WAAW,EACX,UAAU,EACV,YAAY,EACZ,YAAY,GACb,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,WAAW,EACX,YAAY,EACZ,SAAS,EACT,UAAU,EACV,WAAW,EACX,UAAU,GACX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,wBAAwB,EAAE,MAAM,6CAA6C,CAAC;AACvF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAG3E,eAAO,MAAM,OAAO,UAAU,CAAC;AAK/B,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;CAkBhB,CAAC;AAWF,wBAAgB,cAAc,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAE5F"}