@orangecharts/wrun-chart-host 0.7.1 → 0.8.0

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.
Files changed (124) hide show
  1. package/README.md +25 -3
  2. package/dist/constants/feature-flags.constants.d.ts +1 -0
  3. package/dist/constants/feature-flags.constants.js +5 -0
  4. package/dist/constants/option-venues.constants.d.ts +18 -0
  5. package/dist/constants/option-venues.constants.js +14 -0
  6. package/dist/constants/venue-presets.constants.d.ts +17 -3
  7. package/dist/constants/venue-presets.constants.js +17 -3
  8. package/dist/host-env.d.ts +24 -0
  9. package/dist/host-env.js +21 -0
  10. package/dist/host-ports.types.d.ts +12 -0
  11. package/dist/index.d.ts +16 -0
  12. package/dist/index.js +16 -0
  13. package/dist/indicators/controls/tpo-session.util.d.ts +40 -11
  14. package/dist/indicators/controls/tpo-session.util.js +138 -14
  15. package/dist/interfaces/option-instrument.interface.d.ts +6 -0
  16. package/dist/kscript-data/controls/live-trades-merge.util.d.ts +4 -0
  17. package/dist/kscript-data/controls/live-trades-merge.util.js +4 -0
  18. package/dist/settings-templates/footprint-rows.d.ts +25 -0
  19. package/dist/settings-templates/footprint-rows.js +127 -0
  20. package/dist/settings-templates/form-rows.d.ts +56 -0
  21. package/dist/settings-templates/form-rows.js +19 -0
  22. package/dist/settings-templates/frvp-fields.js +14 -0
  23. package/dist/settings-templates/index.d.ts +10 -1
  24. package/dist/settings-templates/index.js +11 -2
  25. package/dist/settings-templates/indicator-fields.js +78 -0
  26. package/dist/settings-templates/tool-rules.d.ts +35 -9
  27. package/dist/settings-templates/tool-rules.js +42 -8
  28. package/dist/settings-templates/tool-tables.generated.js +13 -2
  29. package/dist/utility/chart/candle-volume-unit.leaf.d.ts +16 -0
  30. package/dist/utility/chart/candle-volume-unit.leaf.js +61 -0
  31. package/dist/utility/chart/footprint-columns.util.d.ts +74 -0
  32. package/dist/utility/chart/footprint-columns.util.js +106 -0
  33. package/dist/utility/chart/footprint-display-mode.util.d.ts +40 -0
  34. package/dist/utility/chart/footprint-display-mode.util.js +62 -0
  35. package/dist/utility/chart/footprint-sierra-look.util.d.ts +2 -0
  36. package/dist/utility/chart/footprint-sierra-look.util.js +37 -0
  37. package/dist/utility/chart/kscript-venue-policy.util.js +4 -2
  38. package/dist/utility/chart/om-panel.util.d.ts +11 -0
  39. package/dist/utility/chart/om-panel.util.js +59 -0
  40. package/dist/utility/chart/window-geometry.leaf.d.ts +23 -1
  41. package/dist/utility/chart/window-geometry.leaf.js +78 -6
  42. package/dist/utility/chart/window-owner.leaf.d.ts +13 -0
  43. package/dist/utility/chart/window-owner.leaf.js +5 -0
  44. package/dist/utility/options/cme-options-root.util.d.ts +25 -0
  45. package/dist/utility/options/cme-options-root.util.js +40 -0
  46. package/dist/utility/options/option-book.util.d.ts +27 -0
  47. package/dist/utility/options/option-book.util.js +76 -0
  48. package/dist/utility/options/option-trade-date.util.d.ts +50 -0
  49. package/dist/utility/options/option-trade-date.util.js +120 -0
  50. package/dist/utility/wrun/sources/host-grid-landing.d.ts +4 -2
  51. package/dist/utility/wrun/sources/host-grid-landing.js +8 -0
  52. package/dist/utility/wrun/sources/lanes/options_flow.d.ts +40 -4
  53. package/dist/utility/wrun/sources/lanes/options_flow.js +115 -18
  54. package/dist/utility/wrun/sources/opra-option-lanes.util.d.ts +12 -9
  55. package/dist/utility/wrun/sources/opra-option-lanes.util.js +10 -7
  56. package/dist/utility/wrun/sources/row-lane-registry.js +9 -5
  57. package/dist/utility/wrun/sources/row-lanes/index.js +2 -0
  58. package/dist/utility/wrun/sources/row-lanes/option_contract_flow.d.ts +3 -2
  59. package/dist/utility/wrun/sources/row-lanes/option_contract_flow.js +30 -5
  60. package/dist/utility/wrun/sources/row-lanes/option_prints.d.ts +14 -1
  61. package/dist/utility/wrun/sources/row-lanes/option_prints.js +100 -23
  62. package/dist/utility/wrun/sources/row-lanes/option_strike_flow.d.ts +4 -0
  63. package/dist/utility/wrun/sources/row-lanes/option_strike_flow.js +65 -0
  64. package/dist/utility/wrun/sources/row-lanes/option_strikes.d.ts +47 -1
  65. package/dist/utility/wrun/sources/row-lanes/option_strikes.js +71 -2
  66. package/dist/utility/wrun/sources/row-lanes/option_surface.d.ts +14 -1
  67. package/dist/utility/wrun/sources/row-lanes/option_surface.js +30 -2
  68. package/dist/utility/wrun/sources/wrun-poll-lane.types.d.ts +7 -1
  69. package/dist/utility/wrun/sources/wrun-poll-lanes.util.d.ts +45 -5
  70. package/dist/utility/wrun/sources/wrun-poll-lanes.util.js +115 -3
  71. package/dist/utility/wrun/sources/wrun-row-lane-first-paint.util.d.ts +10 -0
  72. package/dist/utility/wrun/sources/wrun-row-lane-first-paint.util.js +57 -0
  73. package/dist/utility/wrun/sources/wrun-row-lanes.util.d.ts +60 -6
  74. package/dist/utility/wrun/sources/wrun-row-lanes.util.js +160 -23
  75. package/dist/utility/wrun/wrun-cloud-record.leaf.d.ts +27 -0
  76. package/dist/utility/wrun/wrun-cloud-record.leaf.js +71 -0
  77. package/dist/utility/wrun/wrun-cloud-record.util.d.ts +4 -21
  78. package/dist/utility/wrun/wrun-cloud-record.util.js +5 -65
  79. package/dist/utility/wrun/wrun-color-settings.util.d.ts +7 -5
  80. package/dist/utility/wrun/wrun-color-settings.util.js +26 -11
  81. package/dist/utility/wrun/wrun-draft-overlay.util.d.ts +4 -2
  82. package/dist/utility/wrun/wrun-draft-overlay.util.js +40 -3
  83. package/dist/utility/wrun/wrun-hosted-wire-caps.d.ts +1 -1
  84. package/dist/utility/wrun/wrun-hosted-wire-caps.js +4 -0
  85. package/dist/utility/wrun/wrun-lane-refusal.leaf.d.ts +29 -3
  86. package/dist/utility/wrun/wrun-lane-refusal.leaf.js +33 -3
  87. package/dist/utility/wrun/wrun-live-tick.util.d.ts +4 -1
  88. package/dist/utility/wrun/wrun-live-tick.util.js +39 -6
  89. package/dist/utility/wrun/wrun-market-size-defaults.leaf.d.ts +106 -0
  90. package/dist/utility/wrun/wrun-market-size-defaults.leaf.js +159 -0
  91. package/dist/utility/wrun/wrun-market-size-defaults.util.d.ts +44 -0
  92. package/dist/utility/wrun/wrun-market-size-defaults.util.js +213 -0
  93. package/dist/utility/wrun/wrun-opra-flow.leaf.d.ts +43 -8
  94. package/dist/utility/wrun/wrun-opra-flow.leaf.js +37 -6
  95. package/dist/utility/wrun/wrun-option-contract-flow.util.d.ts +51 -10
  96. package/dist/utility/wrun/wrun-option-contract-flow.util.js +85 -33
  97. package/dist/utility/wrun/wrun-option-prints.util.d.ts +133 -3
  98. package/dist/utility/wrun/wrun-option-prints.util.js +318 -8
  99. package/dist/utility/wrun/wrun-option-strike-flow-lane.util.d.ts +96 -0
  100. package/dist/utility/wrun/wrun-option-strike-flow-lane.util.js +215 -0
  101. package/dist/utility/wrun/wrun-option-strike-flow.util.d.ts +342 -0
  102. package/dist/utility/wrun/wrun-option-strike-flow.util.js +742 -0
  103. package/dist/utility/wrun/wrun-option-views.util.d.ts +183 -3
  104. package/dist/utility/wrun/wrun-option-views.util.js +504 -7
  105. package/dist/utility/wrun/wrun-options-chain.util.d.ts +6 -4
  106. package/dist/utility/wrun/wrun-options-chain.util.js +8 -5
  107. package/dist/utility/wrun/wrun-overlay-recovery.util.d.ts +2 -1
  108. package/dist/utility/wrun/wrun-overlay-recovery.util.js +7 -2
  109. package/dist/utility/wrun/wrun-overlay-run.util.js +120 -18
  110. package/dist/utility/wrun/wrun-pack-widths.leaf.d.ts +15 -0
  111. package/dist/utility/wrun/wrun-pack-widths.leaf.js +22 -0
  112. package/dist/utility/wrun/wrun-pack.util.d.ts +9 -8
  113. package/dist/utility/wrun/wrun-pack.util.js +21 -15
  114. package/dist/utility/wrun/wrun-panel-mount.util.d.ts +4 -0
  115. package/dist/utility/wrun/wrun-panel-mount.util.js +62 -22
  116. package/dist/utility/wrun/wrun-panel-style.util.d.ts +17 -2
  117. package/dist/utility/wrun/wrun-panel-style.util.js +47 -9
  118. package/dist/utility/wrun/wrun-pin-spelling.util.js +19 -10
  119. package/dist/utility/wrun/wrun-refusal.util.js +7 -1
  120. package/dist/utility/wrun/wrun-script-inputs.util.d.ts +13 -0
  121. package/dist/utility/wrun/wrun-script-inputs.util.js +43 -0
  122. package/dist/utility/wrun/wrun-tape-source.util.d.ts +9 -0
  123. package/dist/utility/wrun/wrun-tape-source.util.js +18 -0
  124. package/package.json +3 -3
@@ -0,0 +1,213 @@
1
+ /**
2
+ * The run head's market-scaled size defaults (the rule and the table: wrun-market-size-defaults.leaf). A package that
3
+ * scales a param (Big Trades' Min size and Whale size) has its record moved to the chart market's defaults at the head
4
+ * of every full run, before the tape is resolved, so the run, the settings panel's value, the reset icon and its
5
+ * target, and the alert arm all read the one record:
6
+ *
7
+ * - The market's defaults are resolved once per mount and market (a page session's switch back to a market reads what
8
+ * it read there the first time), so a value never flaps inside a session: the chart's own candles give the daily
9
+ * base volume on a coin market whose candles are in base coins (the directory row places the coin, so a cold page
10
+ * waits for it once); a market whose facts never yield one (contracts, shares, candles in another unit, a formula
11
+ * chart, keyed apart from its market) reads the package's declared defaults, so the record never keeps the last
12
+ * coin market's; a size unit not known yet or too few candles resolves nothing (the record stays, the next run asks
13
+ * again).
14
+ * - A row moves while the user never changed it (the value reads as the row's default, the settings panel's reset
15
+ * test, `wrunRowValuesEqual` over `wrunRowValue`): its value and its `defaultValue` together. A changed value keeps
16
+ * both, so it reads as changed on every market after it; its reset goes to the default of the market where it was
17
+ * changed, and the run head of the save the reset is moves the now unchanged value to this market's.
18
+ * - The engine copy takes the patch (titan merges it at once, so the run reads it) and the workspace row its own, with
19
+ * one reconcile persist (no gesture, no undo entry), the delivered sheet's reconcile's pattern
20
+ * (wrun-overlay-run.util `reconcileWrunSourceRecord`, which keeps the moved defaults when it rebuilds the rows).
21
+ *
22
+ * Advisory: it never fails the run.
23
+ */
24
+ import { wrunChartHostEnv } from '../../host-env.js';
25
+ import { candleVolumeIsBaseCoins } from '../chart/candle-volume-unit.leaf.js';
26
+ import { normalizeTransformations, selfTransformationToken } from '../common/transformations.util.js';
27
+ import { wrunChartIntervalMsOf } from './wrun-chart-context.util.js';
28
+ import { warmWrunMarketFacts, wrunChartSizeUnit } from './wrun-chart-market-facts.util.js';
29
+ import { isWrunMarketScaledRow, wrunMarketDefaultWithinRow, wrunMarketScaledParamsOf, wrunMarketSizeVerdict, } from './wrun-market-size-defaults.leaf.js';
30
+ import { wrunChartMarketIdentity } from './wrun-overlay-drivers.util.js';
31
+ import { wrunRegistryRefOf } from './wrun-overlay-identity.util.js';
32
+ import { wrunRowValue, wrunRowValuesEqual, wrunValuesEqual, } from './wrun-script-inputs.util.js';
33
+ import { wrunChartCandleRows } from './wrun-source-rows.util.js';
34
+ function isRecord(value) {
35
+ return value !== null && typeof value === 'object' && !Array.isArray(value);
36
+ }
37
+ /**
38
+ * The patch that moves a record (`settings`: its `scriptInputs` rows and each value flat under its row's name) to a
39
+ * market's `defaults`: every scaled row whose value reads as its default (never changed) takes the market's default
40
+ * (held to the row's bounds), value and `defaultValue` together. A changed value keeps both: the changed mark is the
41
+ * value against its own row's default, so a default moved under a kept value would read the value as never changed on
42
+ * the first market whose default equals it, and the next market would move it (SOL 200, then ETH whose default is
43
+ * 200, then SOL reset it to 1000). Its reset goes to the default of the market where the user changed it, a save
44
+ * whose run head then moves the unchanged value on. Undefined when the record already reads the defaults. Pure.
45
+ */
46
+ export function wrunMarketSizeSettingsPatch(settings, defaults) {
47
+ const record = isRecord(settings) ? settings : {};
48
+ if (!Array.isArray(record.scriptInputs))
49
+ return undefined;
50
+ const patch = {};
51
+ let rowsMoved = false;
52
+ const scriptInputs = record.scriptInputs.map((held) => {
53
+ if (!isRecord(held) || typeof held.name !== 'string' || !Object.hasOwn(defaults, held.name))
54
+ return held;
55
+ const row = held;
56
+ if (!isWrunMarketScaledRow(row))
57
+ return held;
58
+ const target = wrunMarketDefaultWithinRow(row, defaults[row.name]);
59
+ if (target === undefined)
60
+ return held;
61
+ if (!wrunRowValuesEqual(row, wrunRowValue(record, row), row.defaultValue))
62
+ return held;
63
+ if (!wrunValuesEqual(record[row.name], target))
64
+ patch[row.name] = target;
65
+ if (wrunValuesEqual(row.defaultValue, target))
66
+ return held;
67
+ rowsMoved = true;
68
+ return { ...row, defaultValue: target };
69
+ });
70
+ if (rowsMoved)
71
+ patch.scriptInputs = scriptInputs;
72
+ return Object.keys(patch).length > 0 ? patch : undefined;
73
+ }
74
+ /** Each mount's resolved defaults, by market (`exchange|symbol`, and a formula chart's formula after it: its candles
75
+ * are no market's, so it reads the package's defaults where its market reads its own): the engine meta is the mount. */
76
+ const wrunMarketSizeDefaultsByMount = new WeakMap();
77
+ /** The scaled params' defaults a sheet declares (the package's own: a `package` verdict's). */
78
+ function wrunDeclaredDefaults(sheet, names) {
79
+ const wanted = new Set(names);
80
+ const defaults = {};
81
+ for (const param of sheet.params ?? []) {
82
+ if (wanted.has(param.name) && typeof param.default === 'number' && Number.isFinite(param.default)) {
83
+ defaults[param.name] = param.default;
84
+ }
85
+ }
86
+ return defaults;
87
+ }
88
+ const WRUN_MARKET_SIZE_UNPROVEN = Object.freeze({ kind: 'skip', reason: 'unproven' });
89
+ /**
90
+ * Move an overlay's record to its chart market's scaled defaults (above), at the head of a full run, before the
91
+ * lanes read the settings. Resolves once the engine copy reads the defaults (the persist is the routing's own); a
92
+ * package that scales nothing returns at once, and nothing here ever throws over the run.
93
+ *
94
+ * Every fact is proven the keyed market's before it is kept or written: `market` is the market the run computes for
95
+ * (C4: the chart's market identity at the run head, `wrunChartMarketIdentity`, and the reader of the chart's metadata
96
+ * now), and `isCurrent` says the run is still the overlay's own (its chart and mount stand). After each await, in the
97
+ * task that keeps and writes, the chart still names that market (a switch during the directory's answer moves it, and
98
+ * neither the mount nor the refusal attempt sees a switch), and the verdict that reads the candles reads them only
99
+ * while they were loaded for it (`loadedMainIdentityOf`: the symbol pipeline stamps the new market's metadata before
100
+ * its rows replace the old market's). A fact it cannot prove reads as a transient skip: no memo, no write.
101
+ */
102
+ export async function reconcileWrunMarketSizeDefaults(args) {
103
+ const { chartIndex, indicatorId, tc, meta, sheet, market, isCurrent } = args;
104
+ const rules = wrunMarketScaledParamsOf(wrunRegistryRefOf(meta.settings)?.package);
105
+ if (rules === undefined)
106
+ return;
107
+ const keyed = () => isCurrent() && wrunChartMarketIdentity(market.read()) === market.identity;
108
+ try {
109
+ if (!keyed())
110
+ return;
111
+ const chartMetadata = market.read() ?? undefined;
112
+ const exchange = typeof chartMetadata?.exchange === 'string' ? chartMetadata.exchange : '';
113
+ const symbol = typeof chartMetadata?.symbol === 'string' ? chartMetadata.symbol : '';
114
+ if (exchange === '' || symbol === '')
115
+ return;
116
+ const transformations = typeof chartMetadata?.transformations === 'string' ? chartMetadata.transformations : '';
117
+ const formula = wrunChartFormulaOf(exchange, symbol, transformations);
118
+ const key = formula === undefined ? `${exchange}|${symbol}` : `${exchange}|${symbol}|${formula}`;
119
+ let resolved = wrunMarketSizeDefaultsByMount.get(meta);
120
+ let defaults = resolved?.get(key);
121
+ if (defaults === undefined) {
122
+ // A crypto market's coin unit is the directory row's (its asset class): asked once per market for the session,
123
+ // never rejects; a contracts market answers from its own facts and waits on nothing. The data loading module
124
+ // says whose candles the chart holds; a host that cannot load it proves nothing.
125
+ const [, dataFetching] = await Promise.all([
126
+ warmWrunMarketFacts(chartMetadata),
127
+ Promise.resolve()
128
+ .then(() => wrunChartHostEnv().chart.loadDataFetching())
129
+ .catch(() => undefined),
130
+ ]);
131
+ const verdict = keyed()
132
+ ? wrunMarketSizeVerdictNow(rules, {
133
+ tc,
134
+ chartMetadata: market.read() ?? undefined,
135
+ identity: market.identity,
136
+ loaded: dataFetching?.loadedMainIdentityOf(chartIndex) ?? null,
137
+ ownCandles: formula === undefined,
138
+ exchange,
139
+ symbol,
140
+ })
141
+ : WRUN_MARKET_SIZE_UNPROVEN;
142
+ if (wrunChartHostEnv().diagnostics.debugEnabled()) {
143
+ wrunChartHostEnv().diagnostics.debug('wrun-market-size-defaults', {
144
+ chartIndex,
145
+ indicatorId,
146
+ market: key,
147
+ verdict: verdict.kind,
148
+ ...(verdict.kind !== 'market' ? { reason: verdict.reason } : {}),
149
+ ...(verdict.kind === 'market' ? { defaults: verdict.defaults } : {}),
150
+ });
151
+ }
152
+ // A fact that can still change (a unit not known yet, too few candles) or that could not be proven the keyed
153
+ // market's: nothing kept, nothing moves, the next run asks again.
154
+ if (verdict.kind === 'skip')
155
+ return;
156
+ defaults = verdict.kind === 'market' ? verdict.defaults : wrunDeclaredDefaults(sheet, Object.keys(rules));
157
+ if (resolved === undefined) {
158
+ resolved = new Map();
159
+ wrunMarketSizeDefaultsByMount.set(meta, resolved);
160
+ }
161
+ resolved.set(key, defaults);
162
+ }
163
+ if (!keyed())
164
+ return;
165
+ const enginePatch = wrunMarketSizeSettingsPatch(meta.settings, defaults);
166
+ if (enginePatch === undefined)
167
+ return;
168
+ const chart = tc;
169
+ if (typeof chart?.updateSettings === 'function')
170
+ chart.updateSettings(indicatorId, enginePatch);
171
+ else
172
+ meta.settings = { ...(isRecord(meta.settings) ? meta.settings : {}), ...enginePatch };
173
+ const { persistChart, resolveChart } = await wrunChartHostEnv().chart.loadChartRouting();
174
+ if (!keyed())
175
+ return;
176
+ const document = resolveChart(chartIndex);
177
+ const row = [...(document?.onchart ?? []), ...(document?.offchart ?? [])].find((candidate) => candidate?.id === indicatorId);
178
+ const rowPatch = row === undefined ? undefined : wrunMarketSizeSettingsPatch(row.settings, defaults);
179
+ if (row === undefined || rowPatch === undefined)
180
+ return;
181
+ row.settings = { ...(row.settings ?? {}), ...rowPatch };
182
+ persistChart(chartIndex, 'reconcile');
183
+ }
184
+ catch (error) {
185
+ console.warn(`[wrun] the market size defaults of '${indicatorId}' were not applied:`, error);
186
+ }
187
+ }
188
+ /** The formula a chart's candles are computed from (normalized), or undefined for a chart of the market's own candles
189
+ * (no transformations, or the market's own token). */
190
+ function wrunChartFormulaOf(exchange, symbol, transformations) {
191
+ const formula = normalizeTransformations(transformations);
192
+ return formula === '' || formula === normalizeTransformations(selfTransformationToken(exchange, symbol))
193
+ ? undefined
194
+ : formula;
195
+ }
196
+ /**
197
+ * The verdict of the keyed market's facts, read in the caller's task once the chart is proven on that market: the
198
+ * size unit once the directory placed it, the venue's candle volume unit (`ownCandles`: a formula chart's candles are
199
+ * no market's), and the chart's own candles while they were loaded for the keyed market (`loaded`, the loaded-main
200
+ * identity, names its `identity`). Candles loaded for another market are never read: the verdict that would read them
201
+ * reads `unproven` (the candles not yet the market's own, never its own too few).
202
+ */
203
+ function wrunMarketSizeVerdictNow(rules, facts) {
204
+ const rowsOwn = facts.loaded !== null && wrunChartMarketIdentity(facts.loaded) === facts.identity;
205
+ const verdict = wrunMarketSizeVerdict(rules, {
206
+ sizeUnit: wrunChartSizeUnit(facts.chartMetadata),
207
+ candleVolumeInCoins: facts.ownCandles && candleVolumeIsBaseCoins(facts.exchange, facts.symbol),
208
+ rows: rowsOwn ? wrunChartCandleRows(facts.tc) : [],
209
+ intervalMs: wrunChartIntervalMsOf(facts.chartMetadata?.interval),
210
+ });
211
+ // Only the verdict that reads the candles meets the rows held back, and no rows read as too few candles.
212
+ return !rowsOwn && verdict.kind === 'skip' && verdict.reason === 'cover' ? WRUN_MARKET_SIZE_UNPROVEN : verdict;
213
+ }
@@ -15,19 +15,36 @@
15
15
  * - a COIN or MARKET row is keyed by option type, `dte_bucket` (1 the print's trade date, 2 one to seven days, 3 eight
16
16
  * to thirty-five, 4 later; 0 a print past its expiry) and `moneyness` (+1 out of the money, -1 in the money, unset
17
17
  * without an underlying price); a VENUE row by option type and issue type. Side is never a dimension: every row
18
- * splits its totals by side in its `_ask`, `_bid`, `_mid` and `_none` columns (off OPRA the taker's side: no mid).
18
+ * splits its totals by side in its `_ask`, `_bid`, `_mid` and `_none` columns (off OPRA the taker's side: no mid);
19
+ * - PRINTS rows of one underlying (`PRINTS`, the coin beside it; OPTLOAD G4): its prints at or above the ask's premium
20
+ * floor and within its `max_dte`, summed per bar and option type in the COIN columns.
21
+ *
22
+ * OPTLOAD (OPTLOAD-READ-CONTRACT sections 5 and 7): the gateway groups the rows to the chart's bar, filters the split
23
+ * and folds the dimensions (`DataRequest.optionRead`), so an answer is one row per (bar, option type) of the asked split;
24
+ * the worker half builds that shape (option-print-agg-scope.worker.util `wrunOptionsFlowReadShape`).
19
25
  *
20
26
  * Import-free: a lane file stays light at module load and the worker twin reads it too.
21
27
  */
22
- /** The fields, in the kit's order (om `WRUN_OPTIONS_FLOW_FIELDS`); field i is lane row column i + 1. */
23
- export declare const WRUN_OPTIONS_FLOW_FIELDS: readonly ["call_prem_ask", "call_prem_bid", "call_prem_mid", "call_prem_none", "put_prem_ask", "put_prem_bid", "put_prem_mid", "put_prem_none", "call_prem_total", "put_prem_total", "call_contracts_ask", "call_contracts_bid", "call_contracts_mid", "call_contracts_none", "put_contracts_ask", "put_contracts_bid", "put_contracts_mid", "put_contracts_none", "call_contracts_total", "put_contracts_total", "net_call_prem", "net_put_prem", "net_call_prem_capped", "net_put_prem_capped", "share_delta_ask", "share_delta_bid", "vega_ask", "vega_bid", "prints", "vol_above_ask", "vol_below_bid", "n_priced"];
28
+ /** The fields, in the kit's order (om `WRUN_OPTIONS_FLOW_FIELDS`, kit 0.89.0); field i is lane row column i + 1. The
29
+ * last four split the contracts printed outside the quote by option type (appended, so every earlier field keeps its
30
+ * column; 0 off OPRA, as `vol_above_ask` is). */
31
+ export declare const WRUN_OPTIONS_FLOW_FIELDS: readonly ["call_prem_ask", "call_prem_bid", "call_prem_mid", "call_prem_none", "put_prem_ask", "put_prem_bid", "put_prem_mid", "put_prem_none", "call_prem_total", "put_prem_total", "call_contracts_ask", "call_contracts_bid", "call_contracts_mid", "call_contracts_none", "put_contracts_ask", "put_contracts_bid", "put_contracts_mid", "put_contracts_none", "call_contracts_total", "put_contracts_total", "net_call_prem", "net_put_prem", "net_call_prem_capped", "net_put_prem_capped", "share_delta_ask", "share_delta_bid", "vega_ask", "vega_bid", "prints", "vol_above_ask", "vol_below_bid", "n_priced", "call_contracts_above_ask", "call_contracts_below_bid", "put_contracts_above_ask", "put_contracts_below_bid"];
24
32
  export type WrunOptionsFlowField = (typeof WRUN_OPTIONS_FLOW_FIELDS)[number];
25
33
  /** The fields scope `venue` serves (om `WRUN_OPTIONS_FLOW_VENUE_FIELDS`): the venue rows carry premium by side,
26
34
  * prints and the contracts' sum, no side, DTE or moneyness split. */
27
35
  export declare const WRUN_OPTIONS_FLOW_VENUE_FIELDS: readonly WrunOptionsFlowField[];
28
- /** `scope` (om `WRUN_OPTIONS_FLOW_SCOPES`); an absent knob reads `ticker`. */
29
- export declare const WRUN_OPTIONS_FLOW_SCOPES: readonly ["ticker", "market", "equity", "etf", "index", "venue"];
36
+ /** `scope` (om `WRUN_OPTIONS_FLOW_SCOPES`, kit 0.89.0); an absent knob reads `ticker`. `prints` (OPTLOAD G4) sums the
37
+ * chart underlying's prints at or above `min_premium` (required there) and within `max_dte`. */
38
+ export declare const WRUN_OPTIONS_FLOW_SCOPES: readonly ["ticker", "market", "equity", "etf", "index", "venue", "prints"];
30
39
  export type WrunOptionsFlowScope = (typeof WRUN_OPTIONS_FLOW_SCOPES)[number];
40
+ /** The raw-symbol word of scope `prints` (the gateway's PRINTS scope, the coin beside it). */
41
+ export declare const WRUN_OPTIONS_FLOW_PRINTS_WORD = "PRINTS";
42
+ /** Scope `prints`' `max_dte`: whole days to expiry, 0 to 3,650 (0, like an absent knob, keeps every expiry; om
43
+ * `WRUN_OPTION_MAX_DTE_DAYS`). */
44
+ export declare const WRUN_OPTIONS_FLOW_MAX_DTE_DAYS = 3650;
45
+ /** The named refusal of a scope `prints` read the gateway does not serve yet (it refused the read's `optionRead` by
46
+ * name): a prints read has no ungrouped ask to fall back to. */
47
+ export declare const WRUN_OPTIONS_FLOW_PRINTS_UNSERVED_CODE = "options-flow-prints-unserved";
31
48
  /** The scopes US listed options alone serve (an issue type of the US market, R7c C7-2): unserved off the OPRA plane. */
32
49
  export declare const WRUN_OPTIONS_FLOW_OPRA_SCOPES: readonly WrunOptionsFlowScope[];
33
50
  /** `dte` (om `WRUN_OPTIONS_FLOW_DTE`); an absent knob reads `all`. */
@@ -67,12 +84,22 @@ export declare const WRUN_OPTIONS_FLOW_EXCHANGE_FIELD = "flowExchange";
67
84
  export declare const WRUN_OPTIONS_FLOW_BOOK_FIELD = "flowBook";
68
85
  export declare const WRUN_OPTIONS_FLOW_VENUES_FIELD = "flowVenues";
69
86
  export declare const WRUN_OPTIONS_FLOW_CONTINUOUS_FIELD = "flowContinuous";
87
+ /** The chart's bar grid as an ask carries it (`liveBucketVenueOf` over the chart's metadata, plain strings): where the
88
+ * host bars a grouped read sums to open and close (a regular-session stock chart's 09:30 New York bars, a CME chart's
89
+ * session lattice, the UTC floor elsewhere). */
90
+ export interface WrunOptionsFlowBarGrid {
91
+ exchange?: string;
92
+ symbol?: string;
93
+ sessionType?: string;
94
+ transformations?: string;
95
+ }
70
96
  /** One acquisition: the payload the lane's plan answers and the K control forwards (plus the tier it is asked at). */
71
97
  export interface WrunOptionsFlowAsk {
72
98
  scope: WrunOptionsFlowScope;
73
99
  /** The exchange the chart's chain lists on (pb-common `Exchange` name): the read's venue unless `venues` names them. */
74
100
  exchange: string;
75
- /** A COIN read's underlying, upper case: every ticker read's, a crypto scope across venues' (the chart's coin). */
101
+ /** A COIN read's underlying, upper case: every ticker read's, a prints read's, a crypto scope across venues' (the
102
+ * chart's coin). */
76
103
  coin?: string;
77
104
  /** A crypto ticker read's ONE book (a series name, upper case), read as `COIN:<book>`; absent: every book. */
78
105
  book?: string;
@@ -80,13 +107,21 @@ export interface WrunOptionsFlowAsk {
80
107
  venues?: readonly string[];
81
108
  /** Scope `venue` on OPRA: the venue's Databento publisher id. */
82
109
  venueId?: number;
110
+ /** Scope `prints`: the premium floor in USD, above 0 (the gateway's `minQuoteAmount`). */
111
+ minPremium?: number;
112
+ /** Scope `prints`: the most days to expiry a summed print has, 1 to 3,650 (absent: every expiry). */
113
+ maxDte?: number;
83
114
  dte: WrunOptionsFlowDte;
84
115
  moneyness: WrunOptionsFlowMoneyness;
85
116
  tier: WrunOptionsFlowTier;
117
+ /** The host chart's bar span in ms (the run's interval): the bar a grouped read sums its rows to. */
118
+ barMs?: number;
119
+ /** The host chart's bar grid (absent: unknown, so the read is not grouped to the bar). */
120
+ barGrid?: WrunOptionsFlowBarGrid;
86
121
  }
87
122
  /** Whether an ask reads VENUE rows (scope `venue` on OPRA, by publisher id: no side, DTE or moneyness split); a crypto
88
123
  * scope `venue` reads its venue's COIN rows. */
89
124
  export declare function wrunOptionsFlowReadsVenueRows(ask: Pick<WrunOptionsFlowAsk, 'scope' | 'coin'>): boolean;
90
- /** The raw symbol an ask's read names: `COIN` for a read of one underlying (`COIN:<book>` when it names its ONE book),
91
- * `VENUE:<publisher id>` for an OPRA venue, else the scope's MARKET word. */
125
+ /** The raw symbol an ask's read names: `PRINTS` for scope `prints`, `COIN` for a read of one underlying (`COIN:<book>`
126
+ * when it names its ONE book), `VENUE:<publisher id>` for an OPRA venue, else the scope's MARKET word. */
92
127
  export declare function wrunOptionsFlowScopeSymbol(ask: Pick<WrunOptionsFlowAsk, 'scope' | 'coin' | 'book' | 'venueId'>): string;
@@ -15,11 +15,19 @@
15
15
  * - a COIN or MARKET row is keyed by option type, `dte_bucket` (1 the print's trade date, 2 one to seven days, 3 eight
16
16
  * to thirty-five, 4 later; 0 a print past its expiry) and `moneyness` (+1 out of the money, -1 in the money, unset
17
17
  * without an underlying price); a VENUE row by option type and issue type. Side is never a dimension: every row
18
- * splits its totals by side in its `_ask`, `_bid`, `_mid` and `_none` columns (off OPRA the taker's side: no mid).
18
+ * splits its totals by side in its `_ask`, `_bid`, `_mid` and `_none` columns (off OPRA the taker's side: no mid);
19
+ * - PRINTS rows of one underlying (`PRINTS`, the coin beside it; OPTLOAD G4): its prints at or above the ask's premium
20
+ * floor and within its `max_dte`, summed per bar and option type in the COIN columns.
21
+ *
22
+ * OPTLOAD (OPTLOAD-READ-CONTRACT sections 5 and 7): the gateway groups the rows to the chart's bar, filters the split
23
+ * and folds the dimensions (`DataRequest.optionRead`), so an answer is one row per (bar, option type) of the asked split;
24
+ * the worker half builds that shape (option-print-agg-scope.worker.util `wrunOptionsFlowReadShape`).
19
25
  *
20
26
  * Import-free: a lane file stays light at module load and the worker twin reads it too.
21
27
  */
22
- /** The fields, in the kit's order (om `WRUN_OPTIONS_FLOW_FIELDS`); field i is lane row column i + 1. */
28
+ /** The fields, in the kit's order (om `WRUN_OPTIONS_FLOW_FIELDS`, kit 0.89.0); field i is lane row column i + 1. The
29
+ * last four split the contracts printed outside the quote by option type (appended, so every earlier field keeps its
30
+ * column; 0 off OPRA, as `vol_above_ask` is). */
23
31
  export const WRUN_OPTIONS_FLOW_FIELDS = Object.freeze([
24
32
  'call_prem_ask',
25
33
  'call_prem_bid',
@@ -53,6 +61,10 @@ export const WRUN_OPTIONS_FLOW_FIELDS = Object.freeze([
53
61
  'vol_above_ask',
54
62
  'vol_below_bid',
55
63
  'n_priced',
64
+ 'call_contracts_above_ask',
65
+ 'call_contracts_below_bid',
66
+ 'put_contracts_above_ask',
67
+ 'put_contracts_below_bid',
56
68
  ]);
57
69
  /** The fields scope `venue` serves (om `WRUN_OPTIONS_FLOW_VENUE_FIELDS`): the venue rows carry premium by side,
58
70
  * prints and the contracts' sum, no side, DTE or moneyness split. */
@@ -63,8 +75,25 @@ export const WRUN_OPTIONS_FLOW_VENUE_FIELDS = Object.freeze([
63
75
  'put_contracts_total',
64
76
  'prints',
65
77
  ]);
66
- /** `scope` (om `WRUN_OPTIONS_FLOW_SCOPES`); an absent knob reads `ticker`. */
67
- export const WRUN_OPTIONS_FLOW_SCOPES = Object.freeze(['ticker', 'market', 'equity', 'etf', 'index', 'venue']);
78
+ /** `scope` (om `WRUN_OPTIONS_FLOW_SCOPES`, kit 0.89.0); an absent knob reads `ticker`. `prints` (OPTLOAD G4) sums the
79
+ * chart underlying's prints at or above `min_premium` (required there) and within `max_dte`. */
80
+ export const WRUN_OPTIONS_FLOW_SCOPES = Object.freeze([
81
+ 'ticker',
82
+ 'market',
83
+ 'equity',
84
+ 'etf',
85
+ 'index',
86
+ 'venue',
87
+ 'prints',
88
+ ]);
89
+ /** The raw-symbol word of scope `prints` (the gateway's PRINTS scope, the coin beside it). */
90
+ export const WRUN_OPTIONS_FLOW_PRINTS_WORD = 'PRINTS';
91
+ /** Scope `prints`' `max_dte`: whole days to expiry, 0 to 3,650 (0, like an absent knob, keeps every expiry; om
92
+ * `WRUN_OPTION_MAX_DTE_DAYS`). */
93
+ export const WRUN_OPTIONS_FLOW_MAX_DTE_DAYS = 3_650;
94
+ /** The named refusal of a scope `prints` read the gateway does not serve yet (it refused the read's `optionRead` by
95
+ * name): a prints read has no ungrouped ask to fall back to. */
96
+ export const WRUN_OPTIONS_FLOW_PRINTS_UNSERVED_CODE = 'options-flow-prints-unserved';
68
97
  /** The scopes US listed options alone serve (an issue type of the US market, R7c C7-2): unserved off the OPRA plane. */
69
98
  export const WRUN_OPTIONS_FLOW_OPRA_SCOPES = Object.freeze(['equity', 'etf', 'index']);
70
99
  /** `dte` (om `WRUN_OPTIONS_FLOW_DTE`); an absent knob reads `all`. */
@@ -110,9 +139,11 @@ export const WRUN_OPTIONS_FLOW_CONTINUOUS_FIELD = 'flowContinuous';
110
139
  export function wrunOptionsFlowReadsVenueRows(ask) {
111
140
  return ask.scope === 'venue' && ask.coin === undefined;
112
141
  }
113
- /** The raw symbol an ask's read names: `COIN` for a read of one underlying (`COIN:<book>` when it names its ONE book),
114
- * `VENUE:<publisher id>` for an OPRA venue, else the scope's MARKET word. */
142
+ /** The raw symbol an ask's read names: `PRINTS` for scope `prints`, `COIN` for a read of one underlying (`COIN:<book>`
143
+ * when it names its ONE book), `VENUE:<publisher id>` for an OPRA venue, else the scope's MARKET word. */
115
144
  export function wrunOptionsFlowScopeSymbol(ask) {
145
+ if (ask.scope === 'prints')
146
+ return WRUN_OPTIONS_FLOW_PRINTS_WORD;
116
147
  if (ask.scope === 'ticker' || ask.coin !== undefined)
117
148
  return ask.book !== undefined ? `COIN:${ask.book}` : 'COIN';
118
149
  if (ask.scope === 'venue')
@@ -123,6 +123,27 @@ export declare function packWrunOptionContractFlowRaws(raws: ReadonlyArray<Reado
123
123
  export declare const WRUN_OPTION_CONTRACT_FLOW_EXCHANGE_FIELD = "flowExchange";
124
124
  export declare const WRUN_OPTION_CONTRACT_FLOW_BOOK_FIELD = "flowBook";
125
125
  export declare const WRUN_OPTION_CONTRACT_FLOW_CONTINUOUS_FIELD = "flowContinuous";
126
+ /**
127
+ * `history` "today"'s field on a flow request (both flow classes, under one name): the first instant of today, the
128
+ * trade date of the chart's newest bar on the chain's venue clock (option-trade-date.util `optionTodayStartMsByClock`),
129
+ * named by the K control off the chart's bars (option-flow-bars.util `optionFlowTodayFields`), never off a clock. The
130
+ * worker twins read it (wrun-option-strike-flow.util `wrunOptionFlowTodayWindow`); a "today" request naming none
131
+ * reads nothing.
132
+ */
133
+ export declare const WRUN_OPTION_FLOW_TODAY_FIELD = "todayFromMs";
134
+ /** Today's first instant a request or an acquisition names (`WRUN_OPTION_FLOW_TODAY_FIELD`), else undefined. */
135
+ export declare function wrunOptionFlowTodayFromOf(record: Readonly<Record<string, unknown>> | null | undefined): number | undefined;
136
+ /**
137
+ * Whether a bar reads nothing under `history` "today", so a row budget projects it at no rows (both flow lanes'
138
+ * `rowBudget.barRows`, and the strike flow fold's plan): it ends at or before today's first instant as the acquisition
139
+ * names it (`WRUN_OPTION_FLOW_TODAY_FIELD`). An acquisition naming no today (the host's plan hands its projection no
140
+ * newest bar to date today by) holds no such bar: today is never dated off a clock, so a bar of the newest trade date
141
+ * the chart holds is never projected at nothing. An older bar is then projected like any other and may be left
142
+ * partial where the budget stops; it reads nothing either way.
143
+ */
144
+ export declare function wrunOptionFlowBarBeforeToday(bar: {
145
+ endMs: number;
146
+ }, acquisition: Readonly<Record<string, unknown>>): boolean;
126
147
  /** The acquisition an `option_contract_flow` instance asks with. */
127
148
  export interface WrunOptionContractFlowAcquisition {
128
149
  /** The chain's underlying, upper case: the key its plane files the rows under (the OPRA ticker, a crypto venue's
@@ -136,6 +157,14 @@ export interface WrunOptionContractFlowAcquisition {
136
157
  expiries?: string;
137
158
  strikeWindowPct?: number;
138
159
  minVolume?: number;
160
+ /** A contract's group premium floor (USD, the four sides' sum), "session" (a row set per trade date) and "today" (the
161
+ * newest trade date only): the worker twin's (OPTLOAD, kit 0.89.0). */
162
+ minPremium?: number;
163
+ span?: 'session';
164
+ history?: 'today';
165
+ /** Today's first instant as the request names it (`WRUN_OPTION_FLOW_TODAY_FIELD`: the K control's, off the chart's
166
+ * newest bar); an instance's own payload names none. */
167
+ todayFromMs?: number;
139
168
  /** The tier key of the ask (a fold reads the ask's own). */
140
169
  tier?: string;
141
170
  }
@@ -166,26 +195,38 @@ export interface WrunOptionContractFlowRow {
166
195
  * and counted.
167
196
  */
168
197
  export declare function wrunOptionContractFlowRowOf(point: Readonly<Record<string, unknown>> | null | undefined, series: Readonly<Record<string, unknown>> | null | undefined): WrunOptionContractFlowRow | WrunOptionContractFlowDrop;
169
- /**
170
- * Whether a contract row is a "0dte" row: its expiry falls on the trade date of its bucket, on the clock of the chain's
171
- * market (`tradeDay`, the trade date an instant falls on in days: the worker hands the chain summary's one rule,
172
- * option-contract-state.worker.util `optionChainTradeDay` over the chain's exchange: OPRA's New York date, a CME Group
173
- * exchange's Globex session date, a crypto venue's UTC date), read at the bucket's middle so a UTC day bucket reads its
174
- * own session's date.
175
- */
176
- export declare function wrunOptionContractFlowRowIsZeroDte(row: WrunOptionContractFlowRow, tierMs: number, tradeDay: (instantMs: number) => number): boolean;
177
198
  /** The raw tuples a bucket row holds (a packed block counts each of its tuples). */
178
199
  export declare function wrunOptionContractFlowRawCount(row: ReadonlyArray<unknown>): number;
200
+ /** One contract's sums over a group, its joined flags, and its newest last price's and IV's buckets. */
201
+ export interface WrunOptionContractFlowContractSum {
202
+ raw: number[];
203
+ flags: number;
204
+ /** The bucket of the last print price kept. */
205
+ lastAt: number;
206
+ ivAt: number;
207
+ }
208
+ /** Each contract's sums over raw tuples taken in bucket order (the backend's rollup): the fold's, and the worker twin's
209
+ * when it groups a read itself. `add` answers the contract's key, `spot` the tuples' contract-weighted underlying,
210
+ * `raws` each contract's summed raw tuple. */
211
+ export interface WrunOptionContractFlowSums {
212
+ add(at: number, source: ArrayLike<number>, offset: number): string;
213
+ spot(): number | undefined;
214
+ raws(): number[][];
215
+ sums(): WrunOptionContractFlowContractSum[];
216
+ }
217
+ /** A new accumulator of per-contract sums (`WrunOptionContractFlowSums`). */
218
+ export declare function wrunOptionContractFlowSums(): WrunOptionContractFlowSums;
179
219
  /**
180
220
  * One host bar's contract tuples from its buckets' raw rows (in bucket order), under the acquisition's knobs:
181
221
  * - every contract's sums over the bar, its last price from its newest bucket and its IV from its newest bucket that
182
- * had one;
222
+ * had one (`wrunOptionContractFlowSums`);
183
223
  * - `expiries: "nearest:N"`: the contracts of the bar's N nearest expiries (among every contract that traded);
184
224
  * - `strike_window_pct`: the strikes within that many percent of the bar's underlying, its contract-weighted price
185
225
  * over the bar's prints that carried one (sum_spot_size / size_priced over every contract row of the bar: the same
186
226
  * from any tier and any row order; a bar no priced print reached keeps every strike, there being nothing to judge
187
227
  * by);
188
228
  * - `min_volume`: a contract whose bar total contracts (`sum_size`) is below it is dropped.
189
- * Sorted by root, expiry, strike, then side.
229
+ * (`min_premium` and a session span are the worker twin's, before any row lands.) Sorted by root, expiry, strike, then
230
+ * side.
190
231
  */
191
232
  export declare function foldWrunOptionContractFlowBar(rows: ReadonlyArray<ReadonlyArray<unknown>>, acquisition: Readonly<Record<string, unknown>>): number[][];