pinets 0.9.19 → 0.9.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -36,6 +36,10 @@ export declare class Context {
36
36
  }[];
37
37
  /** Alert mode: 'realtime' = only fire on live bars (TV behavior), 'all' = fire on every bar (backtest). */
38
38
  _alertMode: 'realtime' | 'all';
39
+ /** Name-keyed map of declaration-prop overrides from `Indicator.prop`. Layered on top of
40
+ * the source's `indicator()`/`strategy()` call args inside the per-bar handlers
41
+ * (see Core.indicator and initializeStrategy). Empty object when no overrides are set. */
42
+ _propOverrides: Record<string, unknown>;
39
43
  /** Monotonically increasing counter, incremented each time a bar starts executing.
40
44
  * Used by alertcondition/AlertHelper to detect re-execution of the same bar. */
41
45
  _execTick: number;
@@ -0,0 +1,100 @@
1
+ import type { IPineInput, IPineProp, PreparedScript } from './types';
2
+ /**
3
+ * The single owner of every per-script artifact. Holds the source, lazily
4
+ * transpiles + scans inputs on first `prepare()`, and caches the result so
5
+ * the same Indicator instance can be passed to multiple `pine.run()` calls
6
+ * without re-transpiling.
7
+ *
8
+ * Roles:
9
+ * - `source` — the original Pine string or JS callback.
10
+ * - `input` — live, title-keyed view of input values. Read or
11
+ * mutate per key; the container itself is frozen.
12
+ * - `inputs` — LEGACY title-keyed override map (constructor
13
+ * arg). Kept for back-compat; merged into the
14
+ * prepared inputs by `prepare()`.
15
+ * - `prepare(opts?)` — idempotent: transpiles, scans inputs, runs
16
+ * visible-range static analysis. Caches result.
17
+ * - `usesVisibleRange()`— derived from the cached prepare() result.
18
+ *
19
+ * For JS-function source the AST scan returns `[]`, so `input` is empty and
20
+ * per-key writes throw "unknown title". The legacy `inputs` field still
21
+ * works for that path.
22
+ */
23
+ export declare class Indicator {
24
+ readonly source: Function | string;
25
+ inputs: Record<string, unknown>;
26
+ readonly input: Record<string, unknown>;
27
+ readonly prop: Record<string, unknown>;
28
+ private _prepared;
29
+ private _inputMeta;
30
+ private _inputValues;
31
+ private _explicitOverrides;
32
+ private _inputProxy;
33
+ private _propMeta;
34
+ private _propValues;
35
+ private _propProxy;
36
+ private _declarationType;
37
+ private _sourcePropArgs;
38
+ private _explicitPropOverrides;
39
+ constructor(source: Function | string, inputs?: Record<string, unknown>);
40
+ /**
41
+ * Normalize ANY accepted run() argument into an Indicator. Raw functions
42
+ * and strings get wrapped in a throwaway Indicator; existing Indicators
43
+ * pass through. This is the single entry point used by PineTS's run /
44
+ * stream / update so the rest of the engine only deals with Indicators.
45
+ */
46
+ static from(arg: Indicator | Function | string): Indicator;
47
+ /**
48
+ * Idempotent transpile + scan + viewport detection. The result is cached
49
+ * on the instance, so passing the same Indicator to multiple `pine.run()`
50
+ * calls produces a single transpilation pass.
51
+ *
52
+ * NB: cache is keyed by *instance identity*, not by options. If you need
53
+ * different debug settings, create a new Indicator.
54
+ */
55
+ prepare(opts?: {
56
+ debug?: boolean;
57
+ ln?: boolean;
58
+ }): PreparedScript;
59
+ /** True iff the script references any built-in in `VIEWPORT_DEPENDENT_BUILTINS`. */
60
+ usesVisibleRange(): boolean;
61
+ /**
62
+ * Title-keyed input map used by the runtime (read by
63
+ * `input.utils.resolveInput`). Composed at call time so live mutations
64
+ * to `.input` between `pine.run()` calls are picked up automatically.
65
+ *
66
+ * Precedence:
67
+ * 1. Legacy constructor `inputs` (back-compat)
68
+ * 2. Explicit writes to `.input[...]` (new API; takes priority)
69
+ *
70
+ * Defaults are NOT included — the runtime falls back to `defval` when a
71
+ * title is absent.
72
+ */
73
+ getRuntimeInputs(): Record<string, unknown>;
74
+ /**
75
+ * AST-parsed input metadata. Lazy. Empty array for JS-function source.
76
+ */
77
+ getInputsMeta(): IPineInput[];
78
+ /**
79
+ * Schema metadata for declaration props applicable to this script's type.
80
+ * Includes non-mutable entries (`title`, `shorttitle`) for completeness —
81
+ * UI builders can render them; writes to those keys via `.prop` still throw.
82
+ */
83
+ getPropsMeta(): IPineProp[];
84
+ /**
85
+ * Name-keyed map of user-overridden props for the runtime to merge on top
86
+ * of the source-code's indicator()/strategy() call args. Only explicit
87
+ * writes via `.prop` are included — source-code values flow through the
88
+ * normal Pine call path.
89
+ */
90
+ getRuntimePropOverrides(): Record<string, unknown>;
91
+ /**
92
+ * Detected declaration type, or null if the source code has neither call.
93
+ * `.prop` falls back to the indicator schema in the null case.
94
+ */
95
+ getDeclarationType(): 'indicator' | 'strategy' | null;
96
+ private _ensureInputsScanned;
97
+ private _getInputProxy;
98
+ private _ensurePropsScanned;
99
+ private _getPropProxy;
100
+ }
@@ -0,0 +1,14 @@
1
+ import type { IPineInput } from './types';
2
+ /**
3
+ * Build the live `.input` view exposed on an `Indicator` instance.
4
+ * Title-keyed; entries without an explicit `title=` on the Pine source are
5
+ * excluded (Pine's runtime keys overrides by title, so a title-less input is
6
+ * not overridable).
7
+ *
8
+ * Backing machinery lives in `keyedProxy.ts` and is shared with `.prop`.
9
+ */
10
+ export declare function buildInputProxy(metas: IPineInput[], onSet?: (title: string) => void): {
11
+ proxy: Record<string, unknown>;
12
+ values: Record<string, unknown>;
13
+ metaByTitle: Map<string, IPineInput>;
14
+ };
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Generic title/name-keyed Proxy with per-key validation. Shared backend for
3
+ * both `Indicator.input` (keyed by input title) and `Indicator.prop` (keyed
4
+ * by declaration arg name).
5
+ *
6
+ * Contract:
7
+ * - Read: returns current value (default OR user-overridden) at the key.
8
+ * - Write: validates against the entry's meta — type, options, minval,
9
+ * maxval — and stores the override. Invalid writes THROW with
10
+ * a tailored message.
11
+ * - Delete: throws.
12
+ * - Unknown key write: throws, listing the known keys.
13
+ * - Object.keys() / spread / console.log show real keys with current values.
14
+ */
15
+ export type KeyedType = 'int' | 'float' | 'bool' | 'string' | 'source' | 'color' | 'enum' | 'price' | 'time' | 'session' | 'symbol' | 'timeframe' | 'text_area';
16
+ export interface KeyedSchemaEntry {
17
+ key: string;
18
+ type: KeyedType;
19
+ defval: unknown;
20
+ options?: unknown[];
21
+ minval?: number;
22
+ maxval?: number;
23
+ }
24
+ export interface BuildKeyedProxyResult {
25
+ proxy: Record<string, unknown>;
26
+ values: Record<string, unknown>;
27
+ entryByKey: Map<string, KeyedSchemaEntry>;
28
+ }
29
+ /**
30
+ * Build a keyed proxy view.
31
+ *
32
+ * @param entries schema entries — defaults seeded into `values`
33
+ * @param label display label for error messages, e.g. 'Indicator.input' or 'Indicator.prop'
34
+ * @param onSet optional callback fired after a successful write (for explicit-override tracking)
35
+ * @param seedValues optional initial values overriding entry defvals (used by .prop to seed
36
+ * source-code defaults on top of spec defaults)
37
+ * @param keyNoun noun for the unknown-key message, defaults to 'key'. Inputs use 'input title'.
38
+ */
39
+ export declare function buildKeyedProxy(entries: KeyedSchemaEntry[], label: string, onSet?: (key: string) => void, seedValues?: Record<string, unknown>, keyNoun?: string): BuildKeyedProxyResult;
40
+ /**
41
+ * Per-entry write validation. Throws on any rule violation.
42
+ */
43
+ export declare function validate(entry: KeyedSchemaEntry, value: unknown, label: string): void;
@@ -0,0 +1,16 @@
1
+ import type { IPineProp } from './types';
2
+ /**
3
+ * Build the live `.prop` view exposed on an `Indicator` instance.
4
+ * Name-keyed; non-mutable entries (`title`, `shorttitle`) are excluded.
5
+ *
6
+ * `sourceArgs` seeds source-code defaults on top of spec defaults so the
7
+ * read view matches what TradingView's runtime would see before any user
8
+ * override. Layer order: spec.defval ← sourceArgs ← user `.prop` writes.
9
+ *
10
+ * Backing machinery lives in `keyedProxy.ts` and is shared with `.input`.
11
+ */
12
+ export declare function buildPropProxy(props: IPineProp[], sourceArgs: Record<string, unknown>, onSet?: (name: string) => void): {
13
+ proxy: Record<string, unknown>;
14
+ values: Record<string, unknown>;
15
+ propByName: Map<string, IPineProp>;
16
+ };
@@ -0,0 +1,8 @@
1
+ import type { IPineProp } from './types';
2
+ export declare const INDICATOR_PROPS: IPineProp[];
3
+ export declare const STRATEGY_PROPS: IPineProp[];
4
+ /**
5
+ * Pick the right schema for a detected declaration type. Returns the
6
+ * indicator schema when type is unknown (sensible fallback per spec).
7
+ */
8
+ export declare function propsForDeclaration(type: 'indicator' | 'strategy' | null): IPineProp[];
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Detect whether a script is a `strategy()` or `indicator()`, and extract
3
+ * the actual values passed to that call from source so they can seed
4
+ * `.prop` defaults.
5
+ *
6
+ * Both source kinds are handled:
7
+ * - Pine string → pineToJS() AST → walk for the top-level CallExpression
8
+ * - JS function → acorn.parse(fn.toString()) → walk for CallExpression with
9
+ * callee Identifier matching 'indicator' / 'strategy'
10
+ *
11
+ * Enum-typed args are resolved by the "rightmost-identifier rule": for any
12
+ * `MemberExpression` the rightmost `Identifier` name is the runtime string.
13
+ * Holds for every Pine-namespace constant accepted by indicator()/strategy()
14
+ * (format.percent → "percent", currency.USD → "USD",
15
+ * strategy.percent_of_equity → "percent_of_equity",
16
+ * strategy.commission.percent → "percent").
17
+ *
18
+ * Returns `{ type, args }`:
19
+ * - type = 'indicator' | 'strategy' | null
20
+ * - args = name → resolved value extracted from the source call
21
+ *
22
+ * If the declaration call isn't found, returns `{ type: null, args: {} }`.
23
+ * The Indicator class falls back to the indicator schema in that case.
24
+ */
25
+ export interface ScannedDeclaration {
26
+ type: 'indicator' | 'strategy' | null;
27
+ args: Record<string, unknown>;
28
+ }
29
+ export declare function scanDeclaration(source: unknown): ScannedDeclaration;
@@ -0,0 +1,5 @@
1
+ import type { IPineInput } from './types';
2
+ /**
3
+ * Public entry point. Returns `[]` for invalid Pine or for non-string source.
4
+ */
5
+ export declare function scanInputs(source: unknown): IPineInput[];
@@ -0,0 +1,90 @@
1
+ /**
2
+ * Pine Script `input.*` typing classification. Mirrors TradingView's input
3
+ * widget types 1:1. The bare `input()` wrapper auto-detects from `defval`
4
+ * and dispatches to one of these — there is no `'auto'` member.
5
+ *
6
+ * v6 adds `'enum'`. Everything else exists in both v5 and v6.
7
+ */
8
+ export type PineInputType = 'int' | 'float' | 'bool' | 'string' | 'source' | 'color' | 'enum' | 'price' | 'time' | 'session' | 'symbol' | 'timeframe' | 'text_area';
9
+ /**
10
+ * Value of an input's `display=` argument. Stored as the suffix (without the
11
+ * `display.` prefix), matching what the existing runtime parses into
12
+ * `InputOptions.display` at the call site.
13
+ */
14
+ export type PineInputDisplay = 'none' | 'data_window' | 'status_line' | 'all';
15
+ /**
16
+ * Parsed metadata for a single `input.*` declaration in a Pine script.
17
+ *
18
+ * Field presence matches the Pine reference (v6 superset):
19
+ * - title, tooltip, group, display, active — universal (all 14 fns)
20
+ * - inline — universal except text_area
21
+ * - confirm — universal except bare input()
22
+ * - options — enum, float, int, session, string, timeframe
23
+ * - minval / maxval / step — float, int only
24
+ *
25
+ * `defval` is fully resolved at scan time — for enum inputs we resolve
26
+ * `tz.utc` → "UTC" (the field title) so JS callers see what TradingView's
27
+ * `str.tostring()` would print, never the AST path.
28
+ */
29
+ export interface IPineInput {
30
+ type: PineInputType;
31
+ defval: unknown;
32
+ title?: string;
33
+ tooltip?: string;
34
+ group?: string;
35
+ display?: PineInputDisplay;
36
+ active?: boolean;
37
+ confirm?: boolean;
38
+ inline?: string;
39
+ options?: unknown[];
40
+ minval?: number;
41
+ maxval?: number;
42
+ step?: number;
43
+ }
44
+ /**
45
+ * Pine Script declaration-arg typing classification (used by `IPineProp`).
46
+ *
47
+ * `enum` covers every Pine-namespace constant used as a declaration arg
48
+ * (e.g. `format.percent`, `currency.USD`, `strategy.percent_of_equity`).
49
+ * The scanner resolves these to bare strings via the rightmost-identifier
50
+ * rule, matching what the runtime sees.
51
+ */
52
+ export type PinePropType = 'string' | 'int' | 'float' | 'bool' | 'enum';
53
+ /**
54
+ * Schema entry for a single `indicator()` / `strategy()` declaration argument.
55
+ *
56
+ * The full set of entries is curated from the Pine v6 reference:
57
+ * - https://www.tradingview.com/pine-script-reference/v6/#fun_indicator
58
+ * - https://www.tradingview.com/pine-script-reference/v6/#fun_strategy
59
+ *
60
+ * `title` and `shorttitle` are present in the schema with `mutable: false`
61
+ * so UI consumers can render them, but are filtered out of `.prop` writes.
62
+ *
63
+ * For enum-typed entries, `options` enumerates the accepted runtime strings.
64
+ * The schema source file points to the corresponding exported Pine enum
65
+ * (e.g. `enum format` in Types.ts) so JS callers can import the same source.
66
+ */
67
+ export interface IPineProp {
68
+ name: string;
69
+ type: PinePropType;
70
+ defval: unknown;
71
+ options?: unknown[];
72
+ minval?: number;
73
+ maxval?: number;
74
+ mutable: boolean;
75
+ appliesTo: 'indicator' | 'strategy' | 'both';
76
+ version?: 5 | 6;
77
+ }
78
+ /**
79
+ * Result of `Indicator.prepare()`. The single artifact handed to the engine.
80
+ *
81
+ * `inputs` is the title-keyed map the runtime already expects — built by
82
+ * merging each `IPineInput`'s current value (post-user-override) into a
83
+ * flat `{ [title]: value }` object that `input.utils.resolveInput()` reads.
84
+ */
85
+ export interface PreparedScript {
86
+ fn: Function;
87
+ inputs: Record<string, unknown>;
88
+ usesVisibleRange: boolean;
89
+ ltfSlices?: any[];
90
+ }
@@ -1,5 +1,3 @@
1
- export declare class Indicator {
2
- source: Function | String;
3
- inputs: Record<string, any>;
4
- constructor(source: Function | String, inputs?: Record<string, any>);
5
- }
1
+ export { Indicator } from './Indicator/Indicator.class';
2
+ export { INDICATOR_PROPS, STRATEGY_PROPS, propsForDeclaration } from './Indicator/propsSchema';
3
+ export type { IPineInput, IPineProp, PineInputType, PineInputDisplay, PinePropType, PreparedScript, } from './Indicator/types';
@@ -28,6 +28,7 @@ export declare class PineTS {
28
28
  private _debugSettings;
29
29
  private _transpiledCode;
30
30
  get transpiledCode(): Function | String;
31
+ private _currentIndicator;
31
32
  private _isSecondaryContext;
32
33
  markAsSecondary(): void;
33
34
  private _syminfo;
@@ -254,26 +255,6 @@ export declare class PineTS {
254
255
  * @private
255
256
  */
256
257
  private _initializeContext;
257
- /**
258
- * Transpile the Pine Script code
259
- * @private
260
- */
261
- private _transpileCode;
262
- /**
263
- * Static analysis on the transpiled function body to detect references to
264
- * host-bound built-ins (currently visible-range; extensible via
265
- * VIEWPORT_DEPENDENT_BUILTINS). Comments are stripped during pine2js, so
266
- * scanning the post-transpile output is comment-safe.
267
- *
268
- * Why post-transpile (not regex on Pine source): a `chart.left_visible_bar_time`
269
- * literal inside a // comment would be a false positive at the source level.
270
- * After pine2js, only live code remains.
271
- *
272
- * Why regex (not AST visitor): `chart` is a reserved namespace in
273
- * KNOWN_NAMESPACES — Pine scripts cannot shadow it with a local identifier,
274
- * so a whole-word match on `chart.<prop>` is unambiguous.
275
- */
276
- private _detectViewportUsage;
277
258
  /**
278
259
  * Execute iterations from startIdx to endIdx, updating the context
279
260
  * @private
@@ -12,3 +12,5 @@ export type { Kline, PeriodType } from './marketData/types';
12
12
  export { computeNextPeriodStart, localTimeToUTC, computeSessionClose, TIMEFRAME_SECONDS, TIMEFRAME_PERIOD_INFO } from './marketData/types';
13
13
  export { aggregateCandles, selectSubTimeframe, getAggregationRatio } from './marketData/aggregation';
14
14
  export { PineTS, Context, Provider, Indicator, PineRuntimeError };
15
+ export type { IPineInput, IPineProp, PineInputType, PineInputDisplay, PinePropType, PreparedScript } from './Indicator';
16
+ export { INDICATOR_PROPS, STRATEGY_PROPS, propsForDeclaration } from './Indicator';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pinets",
3
- "version": "0.9.19",
3
+ "version": "0.9.20",
4
4
  "description": "Run Pine Script anywhere. PineTS is an open-source transpiler and runtime that brings Pine Script logic to Node.js and the browser with 1:1 syntax compatibility. Reliably write, port, and run indicators or strategies on your own infrastructure.",
5
5
  "keywords": [
6
6
  "Pine Script",