oakscriptjs 0.1.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OakScriptJS
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

package/README.md

@@ -0,0 +1,271 @@
+# OakScriptJS
+
+**PineScript v6 compatible technical analysis library for JavaScript/TypeScript**
+
+OakScriptJS provides the computational core of PineScript's API. It focuses on **calculations and data transformations** with a clean Series-based approach.
+
+## 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
+
+## Installation
+
+```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
+
+```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);
+
+console.log(rsi.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);
+
+  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 }
+    }]
+  };
+}
+
+// Example 2: RSI
+export function rsiIndicator(bars: any[]): IndicatorResult {
+  const close = new Series(bars, (bar) => bar.close);
+  const rsi = ta.rsi(close, 14);
+
+  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' } }
+    ]
+  };
+}
+```
+
+## Development
+
+### Setup
+
+```bash
+npm install
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Test
+
+```bash
+npm test
+npm run test:watch
+npm run test:coverage
+```
+
+## 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.

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "oakscriptjs",
+  "version": "0.1.5",
+  "type": "module",
+  "description": "PineScript v6 compatible technical analysis library for JavaScript/TypeScript",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./runtime": {
+      "types": "./dist/runtime/index.d.ts",
+      "import": "./dist/runtime/index.mjs",
+      "require": "./dist/runtime/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "pinescript",
+    "trading",
+    "technical-analysis",
+    "indicators",
+    "charting",
+    "oakscript",
+    "ta",
+    "finance",
+    "stocks",
+    "crypto"
+  ],
+  "author": "Odyssée",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/deepentropy/oakscriptJS.git",
+    "directory": "packages/oakscriptjs"
+  },
+  "bugs": {
+    "url": "https://github.com/deepentropy/oakscriptJS/issues"
+  },
+  "homepage": "https://github.com/deepentropy/oakscriptJS#readme",
+  "peerDependencies": {
+    "lightweight-charts": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.10.6",
+    "@typescript-eslint/eslint-plugin": "^6.16.0",
+    "@typescript-eslint/parser": "^6.16.0",
+    "esbuild": "^0.19.11",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "lightweight-charts": "^5.0.0",
+    "prettier": "^3.1.1",
+    "rimraf": "^6.1.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "scripts": {
+    "build": "npm run clean && npm run build:esm && npm run build:cjs && npm run build:runtime:esm && npm run build:runtime:cjs && npm run build:types",
+    "build:esm": "esbuild src/index.ts --bundle --format=esm --outfile=dist/index.mjs --platform=neutral --external:@types/* --external:lightweight-charts",
+    "build:cjs": "esbuild src/index.ts --bundle --format=cjs --outfile=dist/index.js --platform=neutral --external:@types/* --external:lightweight-charts",
+    "build:runtime:esm": "esbuild src/runtime/index.ts --bundle --format=esm --outfile=dist/runtime/index.mjs --platform=neutral --external:@types/* --external:lightweight-charts",
+    "build:runtime:cjs": "esbuild src/runtime/index.ts --bundle --format=cjs --outfile=dist/runtime/index.js --platform=neutral --external:@types/* --external:lightweight-charts",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
+    "clean": "rimraf dist",
+    "dev": "tsc --watch",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\""
+  }
+}