oakscriptjs 0.8.1 → 0.9.0

package/dist/esm/linefill/index.js

@@ -0,0 +1,144 @@
+/**
+ * Linefill namespace
+ * Functions for creating and manipulating linefill drawing objects.
+ *
+ * @remarks
+ * Linefill objects fill the area between two lines with a color.
+ * They have minimal computational value but automatically follow line movements
+ * and provide a way to retrieve the underlying line references.
+ *
+ * @version 6
+ */
+import { all as allDrawings, isDeleted, register, remove } from '../drawing/registry.js';
+/**
+ * Creates a new linefill object that fills the area between two lines.
+ *
+ * @param line1 - First line object
+ * @param line2 - Second line object
+ * @param fillColor - Fill color (optional)
+ * @returns New linefill object
+ *
+ * @remarks
+ * - Automatically follows line movements (if lines are updated, fill updates too)
+ * - Automatically deleted if either line is deleted
+ * - If both lines extend in same direction, fill extends too
+ * - Purely visual in PineScript, but getters allow retrieving line references
+ *
+ * @example
+ * ```typescript
+ * import { line, linefill } from 'oakscriptjs';
+ *
+ * // Create channel lines
+ * const upperLine = line.new(0, 160, 50, 170, 'bar_index', 'right');
+ * const lowerLine = line.new(0, 140, 50, 150, 'bar_index', 'right');
+ *
+ * // Fill channel with color
+ * const channelFill = linefill.new(upperLine, lowerLine, '#0000FF20'); // Transparent blue
+ * ```
+ */
+export function new_linefill(line1, line2, fillColor) {
+    return register('linefill', {
+        line1,
+        line2,
+        color: fillColor
+    });
+}
+/**
+ * Returns the first line reference.
+ *
+ * @param id - Linefill object
+ * @returns First line object
+ *
+ * @remarks
+ * Can be used to retrieve and manipulate the first line.
+ *
+ * @example
+ * ```typescript
+ * const channelFill = linefill.new(upperLine, lowerLine);
+ *
+ * // Later, retrieve and update the first line
+ * const line1 = linefill.get_line1(channelFill);
+ * line.set_y2(line1, 175); // Update upper line's second point
+ * ```
+ */
+export function get_line1(id) {
+    return id.line1;
+}
+/**
+ * Returns the second line reference.
+ *
+ * @param id - Linefill object
+ * @returns Second line object
+ *
+ * @remarks
+ * Can be used to retrieve and manipulate the second line.
+ *
+ * @example
+ * ```typescript
+ * const channelFill = linefill.new(upperLine, lowerLine);
+ *
+ * // Later, retrieve and update the second line
+ * const line2 = linefill.get_line2(channelFill);
+ * line.set_y2(line2, 145); // Update lower line's second point
+ * ```
+ */
+export function get_line2(id) {
+    return id.line2;
+}
+/**
+ * Sets the fill color.
+ *
+ * @param id - Linefill object to modify
+ * @param fillColor - New fill color
+ * @returns Modified linefill object
+ *
+ * @remarks
+ * Useful for dynamically changing channel colors based on conditions.
+ *
+ * @example
+ * ```typescript
+ * const channelFill = linefill.new(upperLine, lowerLine, '#0000FF20');
+ *
+ * // Change color based on trend
+ * if (bullish) {
+ *   linefill.set_color(channelFill, '#00FF0020'); // Green
+ * } else {
+ *   linefill.set_color(channelFill, '#FF000020'); // Red
+ * }
+ * ```
+ */
+export function set_color(id, fillColor) {
+    if (isDeleted(id))
+        return id;
+    id.color = fillColor;
+    return id;
+}
+/**
+ * Deletes the linefill object.
+ *
+ * @param id - Linefill object to delete
+ *
+ * @remarks
+ * Removes the linefill from `linefill.all()`. As in PineScript, the deleted linefill is `na`: its getters
+ * return NaN and its setters do nothing. Deleting it twice has no effect.
+ *
+ * @example
+ * ```typescript
+ * const channelFill = linefill.new(upperLine, lowerLine);
+ * linefill.delete(channelFill);
+ * // linefill.all() no longer contains it
+ * ```
+ */
+export function delete_linefill(id) {
+    remove('linefill', id);
+}
+/**
+ * All live linefills, in creation order (PineScript `linefill.all`). A new array.
+ */
+export function all() {
+    return allDrawings('linefill');
+}
+// Alias to match PineScript API
+export { new_linefill as new };
+export { delete_linefill as delete };
+//# sourceMappingURL=index.js.map

package/dist/esm/linefill/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/linefill/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,GAAG,IAAI,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGzF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,YAAY,CAAC,KAAW,EAAE,KAAW,EAAE,SAAiB;IACtE,OAAO,QAAQ,CAAC,UAAU,EAAE;QAC1B,KAAK;QACL,KAAK;QACL,KAAK,EAAE,SAAS;KACjB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,SAAS,CAAC,EAAY;IACpC,OAAO,EAAE,CAAC,KAAK,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,SAAS,CAAC,EAAY;IACpC,OAAO,EAAE,CAAC,KAAK,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,SAAS,CAAC,EAAY,EAAE,SAAgB;IACtD,IAAI,SAAS,CAAC,EAAE,CAAC;QAAE,OAAO,EAAE,CAAC;IAC7B,EAAE,CAAC,KAAK,GAAG,SAAS,CAAC;IACrB,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,eAAe,CAAC,EAAY;IAC1C,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC;AAGD;;GAEG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO,WAAW,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAED,gCAAgC;AAChC,OAAO,EAAE,YAAY,IAAI,GAAG,EAAE,CAAC;AAC/B,OAAO,EAAE,eAAe,IAAI,MAAM,EAAE,CAAC"}

package/dist/esm/map/index.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Map namespace
+ * Mirrors PineScript's map.* functions.
+ *
+ * A PineScript map is a JS `Map`. PineScript rules:
+ * - `keys()` and `values()` follow insertion order; putting an existing key keeps its position,
+ *   removing a key and putting it again moves it to the end
+ * - keys are equal only when they are exactly equal (no float tolerance)
+ * - `put()` and `remove()` return the previous value, or `na` (`undefined`) when there was none
+ * - a map holds at most 50,000 key-value pairs
+ */
+import type { PineArray, PineMap, PineMapKey, bool, int } from '../types/index.js';
+/** Maximum number of key-value pairs in a PineScript map. */
+export declare const MAX_SIZE = 50000;
+/**
+ * Creates an empty map (PineScript `map.new<keyType, valueType>()`).
+ *
+ * @example
+ * ```typescript
+ * const levels = map.new_map<string, number>();
+ * map.put(levels, 'high', 105.2);
+ * ```
+ */
+export declare function new_map<K extends PineMapKey, V>(): PineMap<K, V>;
+/**
+ * Puts a key-value pair in the map. An existing key keeps its position.
+ * @returns The previous value of the key, or `undefined` (`na`) when the key was new
+ * @throws RangeError when the map would hold more than 50,000 pairs
+ */
+export declare function put<K extends PineMapKey, V>(id: PineMap<K, V>, key: K, value: V): V | undefined;
+/**
+ * Puts all pairs of `id2` in `id` (existing keys are overwritten and keep their position).
+ * @throws RangeError when `id` would hold more than 50,000 pairs
+ */
+export declare function put_all<K extends PineMapKey, V>(id: PineMap<K, V>, id2: PineMap<K, V>): void;
+/**
+ * Returns the value of `key`, or `undefined` (`na`) when the map does not contain it.
+ */
+export declare function get<K extends PineMapKey, V>(id: PineMap<K, V>, key: K): V | undefined;
+/**
+ * Returns true when the map contains `key` (also when its value is `na`).
+ */
+export declare function contains<K extends PineMapKey, V>(id: PineMap<K, V>, key: K): bool;
+/**
+ * Removes `key` from the map.
+ * @returns The removed value, or `undefined` (`na`) when the map did not contain the key
+ */
+export declare function remove<K extends PineMapKey, V>(id: PineMap<K, V>, key: K): V | undefined;
+/**
+ * Returns the number of key-value pairs.
+ */
+export declare function size<K extends PineMapKey, V>(id: PineMap<K, V>): int;
+/**
+ * Removes all pairs.
+ */
+export declare function clear<K extends PineMapKey, V>(id: PineMap<K, V>): void;
+/**
+ * Returns a new array of the keys, in insertion order.
+ */
+export declare function keys<K extends PineMapKey, V>(id: PineMap<K, V>): PineArray<K>;
+/**
+ * Returns a new array of the values, in insertion order of their keys.
+ */
+export declare function values<K extends PineMapKey, V>(id: PineMap<K, V>): PineArray<V>;
+/**
+ * Returns a shallow copy of the map (same order; object values are shared).
+ */
+export declare function copy<K extends PineMapKey, V>(id: PineMap<K, V>): PineMap<K, V>;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/map/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/map/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAEnF,6DAA6D;AAC7D,eAAO,MAAM,QAAQ,QAAS,CAAC;AAM/B;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAK/F;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAK5F;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAErF;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,CAEjF;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAIxF;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,CAEpE;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAEtE;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAE7E;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAE/E;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAE9E"}

package/dist/esm/map/index.js

@@ -0,0 +1,106 @@
+/**
+ * Map namespace
+ * Mirrors PineScript's map.* functions.
+ *
+ * A PineScript map is a JS `Map`. PineScript rules:
+ * - `keys()` and `values()` follow insertion order; putting an existing key keeps its position,
+ *   removing a key and putting it again moves it to the end
+ * - keys are equal only when they are exactly equal (no float tolerance)
+ * - `put()` and `remove()` return the previous value, or `na` (`undefined`) when there was none
+ * - a map holds at most 50,000 key-value pairs
+ */
+/** Maximum number of key-value pairs in a PineScript map. */
+export const MAX_SIZE = 50_000;
+function tooLarge(size) {
+    return new RangeError(`A map cannot have more than ${MAX_SIZE} key-value pairs. The current size is ${size}.`);
+}
+/**
+ * Creates an empty map (PineScript `map.new<keyType, valueType>()`).
+ *
+ * @example
+ * ```typescript
+ * const levels = map.new_map<string, number>();
+ * map.put(levels, 'high', 105.2);
+ * ```
+ */
+export function new_map() {
+    return new Map();
+}
+/**
+ * Puts a key-value pair in the map. An existing key keeps its position.
+ * @returns The previous value of the key, or `undefined` (`na`) when the key was new
+ * @throws RangeError when the map would hold more than 50,000 pairs
+ */
+export function put(id, key, value) {
+    const previous = id.get(key);
+    if (!id.has(key) && id.size >= MAX_SIZE)
+        throw tooLarge(id.size + 1);
+    id.set(key, value);
+    return previous;
+}
+/**
+ * Puts all pairs of `id2` in `id` (existing keys are overwritten and keep their position).
+ * @throws RangeError when `id` would hold more than 50,000 pairs
+ */
+export function put_all(id, id2) {
+    let size = id.size;
+    for (const key of id2.keys())
+        if (!id.has(key))
+            size++;
+    if (size > MAX_SIZE)
+        throw tooLarge(size);
+    for (const [key, value] of id2)
+        id.set(key, value);
+}
+/**
+ * Returns the value of `key`, or `undefined` (`na`) when the map does not contain it.
+ */
+export function get(id, key) {
+    return id.get(key);
+}
+/**
+ * Returns true when the map contains `key` (also when its value is `na`).
+ */
+export function contains(id, key) {
+    return id.has(key);
+}
+/**
+ * Removes `key` from the map.
+ * @returns The removed value, or `undefined` (`na`) when the map did not contain the key
+ */
+export function remove(id, key) {
+    const value = id.get(key);
+    id.delete(key);
+    return value;
+}
+/**
+ * Returns the number of key-value pairs.
+ */
+export function size(id) {
+    return id.size;
+}
+/**
+ * Removes all pairs.
+ */
+export function clear(id) {
+    id.clear();
+}
+/**
+ * Returns a new array of the keys, in insertion order.
+ */
+export function keys(id) {
+    return [...id.keys()];
+}
+/**
+ * Returns a new array of the values, in insertion order of their keys.
+ */
+export function values(id) {
+    return [...id.values()];
+}
+/**
+ * Returns a shallow copy of the map (same order; object values are shared).
+ */
+export function copy(id) {
+    return new Map(id);
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/map/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/map/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,6DAA6D;AAC7D,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE/B,SAAS,QAAQ,CAAC,IAAY;IAC5B,OAAO,IAAI,UAAU,CAAC,+BAA+B,QAAQ,yCAAyC,IAAI,GAAG,CAAC,CAAC;AACjH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO;IACrB,OAAO,IAAI,GAAG,EAAQ,CAAC;AACzB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAA0B,EAAiB,EAAE,GAAM,EAAE,KAAQ;IAC9E,MAAM,QAAQ,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,IAAI,IAAI,QAAQ;QAAE,MAAM,QAAQ,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IACrE,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACnB,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO,CAA0B,EAAiB,EAAE,GAAkB;IACpF,IAAI,IAAI,GAAG,EAAE,CAAC,IAAI,CAAC;IACnB,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE;QAAE,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,IAAI,EAAE,CAAC;IACvD,IAAI,IAAI,GAAG,QAAQ;QAAE,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,GAAG;QAAE,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,GAAG,CAA0B,EAAiB,EAAE,GAAM;IACpE,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAA0B,EAAiB,EAAE,GAAM;IACzE,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CAA0B,EAAiB,EAAE,GAAM;IACvE,MAAM,KAAK,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC1B,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACf,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,IAAI,CAA0B,EAAiB;IAC7D,OAAO,EAAE,CAAC,IAAI,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAA0B,EAAiB;IAC9D,EAAE,CAAC,KAAK,EAAE,CAAC;AACb,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,IAAI,CAA0B,EAAiB;IAC7D,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,MAAM,CAA0B,EAAiB;IAC/D,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,IAAI,CAA0B,EAAiB;IAC7D,OAAO,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC;AACrB,CAAC"}