@pipsend/charts 2.0.0 → 2.1.0

package/dist/typings.d.ts

@@ -1902,6 +1902,28 @@ export declare function applyDonchianChannels(series: ISeriesApi<SeriesType>, ch
 export declare function applyEMA(series: ISeriesApi<SeriesType>, chart: IChartApi, options?: EMAOptions): IndicatorRuntime<EMAOptions> & {
 	series: ISeriesApi<"Line">;
 };
+/**
+ * Draw a source series as Heikin Ashi candles.
+ *
+ * The source series is left in place holding its real prices — it is only
+ * hidden — so indicators bound to it keep computing on the true OHLC, and
+ * `remove()` puts the chart back exactly as it was. That makes this usable as a
+ * chart-type toggle:
+ *
+ * ```js
+ * const ha = applyHeikinAshi(candleSeries, chart);
+ * // …back to regular candles:
+ * ha.remove();
+ * ```
+ *
+ * @param series - Source OHLC series (a candlestick or bar series).
+ * @param chart - Chart instance.
+ * @param options - Heikin Ashi configuration options.
+ * @returns The Heikin Ashi candlestick series, plus live control over its options.
+ */
+export declare function applyHeikinAshi(series: ISeriesApi<SeriesType>, chart: IChartApi, options?: HeikinAshiOptions): IndicatorRuntime<HeikinAshiOptions> & {
+	series: ISeriesApi<"Candlestick">;
+};
 /**
  * Ichimoku Kinko Hyo.
  *
@@ -2106,6 +2128,32 @@ export declare function applyWMA(series: ISeriesApi<SeriesType>, chart: IChartAp
 export declare function applyWilliamsR(series: ISeriesApi<SeriesType>, chart: IChartApi, options?: WilliamsROptions): IndicatorRuntime<WilliamsROptions> & {
 	series: ISeriesApi<"Line">;
 };
+/**
+ * Turns raw OHLC bars into Heikin Ashi ones.
+ *
+ * Heikin Ashi is a price transform, not an overlay: each candle averages itself
+ * with the one before it, which drops most of the single-bar noise and leaves
+ * runs of same-coloured bodies while a trend holds.
+ *
+ * ```
+ * close = (O + H + L + C) / 4
+ * open  = (previous open + previous close) / 2      // first bar: (O + C) / 2
+ * high  = max(H, open, close)
+ * low   = min(L, open, close)
+ * ```
+ *
+ * Because every bar folds in the one before it, the result depends on where the
+ * data starts: the same bar computed from a longer history differs slightly.
+ * The difference decays over a few bars, so pass the whole series rather than a
+ * recent window when you can.
+ *
+ * Whitespace items are passed through untouched, and do not advance the
+ * running open/close — a gap in the data is not a bar.
+ *
+ * @param bars - Source bars, ordered oldest to newest.
+ * @returns The transformed bars, one per input item.
+ */
+export declare function calculateHeikinAshi<HorzScaleItem = Time>(bars: readonly HeikinAshiInput<HorzScaleItem>[]): HeikinAshiPoint<HorzScaleItem>[];
 /**
  * Automatically calculate pip configuration based on price
  * This is completely generic and works for any instrument
@@ -3612,6 +3660,33 @@ export interface HandleScrollOptions {
 	 */
 	vertTouchDrag: boolean;
 }
+export interface HeikinAshiOptions {
+	/** Pane the candles are drawn in. Fixed at creation. */
+	paneIndex?: number;
+	/** Color of rising Heikin Ashi candles. */
+	upColor?: string;
+	/** Color of falling Heikin Ashi candles. */
+	downColor?: string;
+	/** Enable candle borders. */
+	borderVisible?: boolean;
+	/** Border color of rising candles. */
+	borderUpColor?: string;
+	/** Border color of falling candles. */
+	borderDownColor?: string;
+	/** Enable high and low price candle wicks. */
+	wickVisible?: boolean;
+	/** Wick color of rising candles. */
+	wickUpColor?: string;
+	/** Wick color of falling candles. */
+	wickDownColor?: string;
+	/**
+	 * Hide the source series while the Heikin Ashi candles are shown, so the two
+	 * do not overlap. The original visibility is restored by `remove()`.
+	 *
+	 * @defaultValue `true`
+	 */
+	hideSource?: boolean;
+}
 /**
  * Structure describing a single item of data for histogram series
  */
@@ -7478,6 +7553,10 @@ export type DrawingToolType = "ruler" | "fibonacci" | "position" | "trendline" |
  * The valid values are integers in range [0, 255]
  */
 export type GreenComponent = Nominal<number, "GreenComponent">;
+/** A bar the Heikin Ashi transform can read: a real OHLC bar, or a gap. */
+export type HeikinAshiInput<HorzScaleItem = Time> = OhlcData<HorzScaleItem> | WhitespaceData<HorzScaleItem>;
+/** What it produces: a smoothed candle per input bar, gaps passed through. */
+export type HeikinAshiPoint<HorzScaleItem = Time> = CandlestickData<HorzScaleItem> | WhitespaceData<HorzScaleItem>;
 /**
  * Represents histogram series options.
  */

package/package.json

@@ -1,6 +1,5 @@
 {
-  "private": false,
-  "version": "2.0.0",
+  "version": "2.1.0",
   "name": "@pipsend/charts",
   "author": "Pipsend",
   "license": "SEE LICENSE IN LICENSE",
@@ -54,88 +53,7 @@
     "bollinger-bands",
     "financial-analysis"
   ],
-  "engines": {
-    "node": ">=22.3"
-  },
   "dependencies": {
     "fancy-canvas": "2.1.0"
-  },
-  "devDependencies": {
-    "@juggle/resize-observer": "3.4.0",
-    "@rollup/plugin-node-resolve": "16.0.1",
-    "@rollup/plugin-replace": "6.0.2",
-    "@rollup/plugin-terser": "0.4.4",
-    "@size-limit/file": "11.2.0",
-    "@size-limit/webpack": "11.2.0",
-    "@types/chai": "5.2.1",
-    "@types/express": "5.0.1",
-    "@types/glob": "8.1.0",
-    "@types/node": "22",
-    "@types/pixelmatch": "5.2.6",
-    "@types/pngjs": "6.0.5",
-    "@typescript-eslint/eslint-plugin": "7.18.0",
-    "@typescript-eslint/eslint-plugin-tslint": "7.0.2",
-    "@typescript-eslint/parser": "7.18.0",
-    "ajv": "7.2.4",
-    "bytes": "3.1.2",
-    "chai": "5.2.0",
-    "chai-exclude": "3.0.1",
-    "cross-env": "7.0.3",
-    "dts-bundle-generator": "9.5.1",
-    "eslint": "8",
-    "eslint-formatter-unix": "8.40.0",
-    "eslint-plugin-deprecation": "3.0.0",
-    "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-unicorn": "56.0.1",
-    "esno": "4.8.0",
-    "glob": "11.0.1",
-    "markdown-it": "14.1.0",
-    "markdown-it-anchor": "9.2.0",
-    "markdownlint-cli": "0.44.0",
-    "npm-run-all": "4.1.5",
-    "rimraf": "6.0.1",
-    "rollup": "4.40.0",
-    "size-limit": "11.2.0",
-    "ts-node": "10.9.2",
-    "ts-patch": "3.3.0",
-    "ts-transformer-properties-rename": "0.17.0",
-    "ts-transformer-strip-const-enums": "2.0.0",
-    "tslib": "2.8.1",
-    "tslint": "6.1.3",
-    "tslint-eslint-rules": "5.4.0",
-    "tslint-microsoft-contrib": "6.2.0",
-    "tsx": "4.19.3",
-    "typescript": "5.5.4",
-    "yargs": "17.7.2"
-  },
-  "scripts": {
-    "prepare": "node scripts/githooks/install.js || true",
-    "clean": "rimraf lib/ dist/",
-    "bundle-dts": "dts-bundle-generator --config dts-config.json",
-    "tsc": "tspc -p tsconfig.prod.json",
-    "tsc-watch": "npm run tsc -- --watch --preserveWatchOutput",
-    "tsc-verify": "node -e \"const fs=require('fs');const p='website/scripts/generate-versions-dts.js'; if(fs.existsSync(p)){require('child_process').execSync('node '+p,{stdio:'inherit'});} else {console.warn('[tsc-verify] skip: '+p+' not found');}\" && tsc -b tsconfig.composite.json",
-    "lint": "npm-run-all -p lint:**",
-    "lint:eslint": "eslint --format=unix ./",
-    "lint:md": "markdownlint -i \"**/node_modules/**\" -i \"**/website/docs/api/**\" -i \"**/website/versioned_docs/**/api/**\" -i \"**/*.mdx\" \"**/*.md\"",
-    "check-dts-docs": "npm-run-all -p check-dts-docs-duplicates check-dts-docs-eslint",
-    "check-dts-docs-duplicates": "node ./scripts/check-typings-for-duplicates.js ./dist/typings.d.ts",
-    "check-dts-docs-eslint": "eslint --format=unix ./dist/typings.d.ts --no-ignore",
-    "check-markdown-links": "node scripts/check-markdown-links.js",
-    "rollup": "rollup -c rollup.config.js",
-    "rollup-watch": "npm run rollup -- --watch",
-    "build": "npm-run-all tsc rollup bundle-dts",
-    "build:watch": "npm-run-all tsc -p tsc-watch rollup-watch",
-    "build:prod": "cross-env NODE_ENV=production npm run build",
-    "build:release": "cross-env BUILD_TAG=release npm run build:prod",
-    "prepare-release": "npm-run-all clean build:release && npm run prepare-package-json-for-release",
-    "prepare-package-json-for-release": "node ./scripts/clean-package-json.js",
-    "size-limit": "size-limit",
-    "verify": "npm-run-all clean -p build:prod check-markdown-links -p lint check-dts-docs tsc-verify test size-limit -p type-tests",
-    "test": "esno --import ./tests/unittests/setup.units.mjs --test './tests/unittests/**/*.spec.ts'",
-    "type-tests": "tsc -b ./src/tsconfig.composite.json && tsc -p ./tests/type-checks/tsconfig.composite.json --noEmit",
-    "e2e:coverage": "esno ./tests/e2e/coverage/runner.ts ./dist/pipsend-charts.standalone.development.js",
-    "e2e:interactions": "esno ./tests/e2e/interactions/runner.ts ./dist/pipsend-charts.standalone.development.js",
-    "e2e:memleaks": "esno ./tests/e2e/memleaks/runner.ts ./dist/pipsend-charts.standalone.development.js"
   }
 }